TextSummaryTest.php

<?php

/**
 * @file
 * Definition of Drupal\text\TextSummaryTest.
 */
namespace Drupal\text\Tests;

use Drupal\simpletest\DrupalUnitTestBase;

/**
 * Tests the text field summary.
 */
class TextSummaryTest extends DrupalUnitTestBase {
  public static $modules = array(
    'system',
    'user',
    'filter',
    'text',
  );
  public static function getInfo() {
    return array(
      'name' => 'Text summary',
      'description' => 'Test text_summary() with different strings and lengths.',
      'group' => 'Field types',
    );
  }
  function setUp() {
    parent::setUp();
    $this
      ->installSchema('system', 'url_alias');
    $this
      ->installSchema('user', 'role_permission');
    $this
      ->installConfig(array(
      'text',
    ));
  }

  /**
   * Tests an edge case where the first sentence is a question and
   * subsequent sentences are not. This edge case is documented at
   * http://drupal.org/node/180425.
   */
  function testFirstSentenceQuestion() {
    $text = 'A question? A sentence. Another sentence.';
    $expected = 'A question? A sentence.';
    $this
      ->assertTextSummary($text, $expected, NULL, 30);
  }

  /**
   * Test summary with long example.
   */
  function testLongSentence() {
    $text = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. ' . 'Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. ' . 'Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. ' . 'Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.';

    // 110
    $expected = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. ' . 'Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. ' . 'Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.';

    // First three sentences add up to: 336, so add one for space and then 3 to get half-way into next word.
    $this
      ->assertTextSummary($text, $expected, NULL, 340);
  }

  /**
   * Test various summary length edge cases.
   */
  function testLength() {
    entity_create('filter_format', array(
      'format' => 'autop',
      'filters' => array(
        'filter_autop' => array(
          'status' => 1,
        ),
      ),
    ))
      ->save();
    entity_create('filter_format', array(
      'format' => 'autop_correct',
      'filters' => array(
        'filter_autop' => array(
          'status' => 1,
        ),
        'filter_htmlcorrector' => array(
          'status' => 1,
        ),
      ),
    ))
      ->save();

    // This string tests a number of edge cases.
    $text = "<p>\nHi\n</p>\n<p>\nfolks\n<br />\n!\n</p>";

    // The summaries we expect text_summary() to return when $size is the index
    // of each array item.
    // Using no text format:
    $format = NULL;
    $i = 0;
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>\n<p>\nfolks\n<br />\n!\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<", $format, $i++);
    $this
      ->assertTextSummary($text, "<p", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\n", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nH", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n<", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>\n<p>\nfolks\n<br />\n!\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>\n<p>\nfolks\n<br />\n!\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>\n<p>\nfolks\n<br />\n!\n</p>", $format, $i++);

    // Using a text format with filter_autop enabled.
    $format = 'autop';
    $i = 0;
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>\n<p>\nfolks\n<br />\n!\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<", $format, $i++);
    $this
      ->assertTextSummary($text, "<p", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>\n<p>\nfolks\n<br />\n!\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>\n<p>\nfolks\n<br />\n!\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>\n<p>\nfolks\n<br />\n!\n</p>", $format, $i++);

    // Using a text format with filter_autop and filter_htmlcorrector enabled.
    $format = 'autop_correct';
    $i = 0;
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>\n<p>\nfolks\n<br />\n!\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "", $format, $i++);
    $this
      ->assertTextSummary($text, "<p></p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p></p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p></p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p></p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p></p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>\n<p>\nfolks\n<br />\n!\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>\n<p>\nfolks\n<br />\n!\n</p>", $format, $i++);
    $this
      ->assertTextSummary($text, "<p>\nHi\n</p>\n<p>\nfolks\n<br />\n!\n</p>", $format, $i++);
  }

  /**
   * Calls text_summary() and asserts that the expected teaser is returned.
   */
  function assertTextSummary($text, $expected, $format = NULL, $size = NULL) {
    $summary = text_summary($text, $format, $size);
    $this
      ->assertIdentical($summary, $expected, format_string('<pre style="white-space: pre-wrap">@actual</pre> is identical to <pre style="white-space: pre-wrap">@expected</pre>', array(
      '@actual' => $summary,
      '@expected' => $expected,
    )));
  }

}