HandlerFieldFieldTest.php

<?php

/**
 * @file
 * Contains \Drupal\field\Tests\Views\HandlerFieldFieldTest.
 */
namespace Drupal\field\Tests\Views;

use Drupal\Core\Language\Language;
use Drupal\views\ViewExecutable;

/**
 * Tests the field_field handler.
 * @TODO
 *   Check a entity-type with bundles
 *   Check a entity-type without bundles
 *   Check locale:disabled, locale:enabled and locale:enabled with another language
 *   Check revisions
 */
class HandlerFieldFieldTest extends FieldTestBase {

  /**
   * Views used by this test.
   *
   * @var array
   */
  public static $testViews = array(
    'test_view_fieldapi',
  );
  public $nodes;
  public static function getInfo() {
    return array(
      'name' => 'Field: Field handler',
      'description' => 'Tests the field itself of the Field integration.',
      'group' => 'Views module integration',
    );
  }

  /**
   * @todo.
   */
  protected function setUp() {
    parent::setUp();

    // Setup basic fields.
    $this
      ->setUpFields(3);

    // Setup a field with cardinality > 1.
    $this->fields[3] = $field = field_create_field(array(
      'field_name' => 'field_name_3',
      'type' => 'text',
      'cardinality' => FIELD_CARDINALITY_UNLIMITED,
    ));

    // Setup a field that will have no value.
    $this->fields[4] = $field = field_create_field(array(
      'field_name' => 'field_name_4',
      'type' => 'text',
      'cardinality' => FIELD_CARDINALITY_UNLIMITED,
    ));
    $this
      ->setUpInstances();

    // Create some nodes.
    $this->nodes = array();
    for ($i = 0; $i < 3; $i++) {
      $edit = array(
        'type' => 'page',
      );
      for ($key = 0; $key < 3; $key++) {
        $field = $this->fields[$key];
        $edit[$field['field_name']][0]['value'] = $this
          ->randomName(8);
      }
      for ($j = 0; $j < 5; $j++) {
        $edit[$this->fields[3]['field_name']][$j]['value'] = $this
          ->randomName(8);
      }

      // Set this field to be empty.
      $edit[$this->fields[4]['field_name']] = array(
        array(
          'value' => NULL,
        ),
      );
      $this->nodes[$i] = $this
        ->drupalCreateNode($edit);
    }
    $this->container
      ->get('views.views_data')
      ->clear();
  }

  /**
   * Sets up the testing view with random field data.
   *
   * @param \Drupal\views\ViewExecutable $view
   *   The view to add field data to.
   */
  protected function prepareView(ViewExecutable $view) {
    $view
      ->initDisplay();
    foreach ($this->fields as $key => $field) {
      $view->display_handler->options['fields'][$field['field_name']]['id'] = $field['field_name'];
      $view->display_handler->options['fields'][$field['field_name']]['table'] = 'field_data_' . $field['field_name'];
      $view->display_handler->options['fields'][$field['field_name']]['field'] = $field['field_name'];
    }
  }
  public function testFieldRender() {
    $this
      ->_testSimpleFieldRender();
    $this
      ->_testFormatterSimpleFieldRender();
    $this
      ->_testMultipleFieldRender();
  }
  public function _testSimpleFieldRender() {
    $view = views_get_view('test_view_fieldapi');
    $this
      ->prepareView($view);
    $this
      ->executeView($view);

    // Tests that the rendered fields match the actual value of the fields.
    for ($i = 0; $i < 3; $i++) {
      for ($key = 0; $key < 2; $key++) {
        $field = $this->fields[$key];
        $rendered_field = $view->style_plugin
          ->getField($i, $field['field_name']);
        $expected_field = $this->nodes[$i]->{$field['field_name']}[Language::LANGCODE_NOT_SPECIFIED][0]['value'];
        $this
          ->assertEqual($rendered_field, $expected_field);
      }
    }
  }

  /**
   * Tests that fields with formatters runs as expected.
   */
  public function _testFormatterSimpleFieldRender() {
    $view = views_get_view('test_view_fieldapi');
    $this
      ->prepareView($view);
    $view->displayHandlers
      ->get('default')->options['fields'][$this->fields[0]['field_name']]['type'] = 'text_trimmed';
    $view->displayHandlers
      ->get('default')->options['fields'][$this->fields[0]['field_name']]['settings'] = array(
      'trim_length' => 3,
    );
    $this
      ->executeView($view);

    // Take sure that the formatter works as expected.
    // @TODO: actually there should be a specific formatter.
    for ($i = 0; $i < 2; $i++) {
      $rendered_field = $view->style_plugin
        ->getField($i, $this->fields[0]['field_name']);
      $this
        ->assertEqual(strlen($rendered_field), 3);
    }
  }
  public function _testMultipleFieldRender() {
    $view = views_get_view('test_view_fieldapi');
    $field_name = $this->fields[3]['field_name'];

    // Test delta limit.
    $this
      ->prepareView($view);
    $view->displayHandlers
      ->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
    $view->displayHandlers
      ->get('default')->options['fields'][$field_name]['delta_limit'] = 3;
    $this
      ->executeView($view);
    for ($i = 0; $i < 3; $i++) {
      $rendered_field = $view->style_plugin
        ->getField($i, $field_name);
      $items = array();
      $pure_items = $this->nodes[$i]->{$field_name}[Language::LANGCODE_NOT_SPECIFIED];
      $pure_items = array_splice($pure_items, 0, 3);
      foreach ($pure_items as $j => $item) {
        $items[] = $pure_items[$j]['value'];
      }
      $this
        ->assertEqual($rendered_field, implode(', ', $items), 'Take sure that the amount of items are limited.');
    }

    // Test that an empty field is rendered without error.
    $rendered_field = $view->style_plugin
      ->getField(4, $this->fields[4]['field_name']);
    $view
      ->destroy();

    // Test delta limit + offset
    $this
      ->prepareView($view);
    $view->displayHandlers
      ->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
    $view->displayHandlers
      ->get('default')->options['fields'][$field_name]['delta_limit'] = 3;
    $view->displayHandlers
      ->get('default')->options['fields'][$field_name]['delta_offset'] = 1;
    $this
      ->executeView($view);
    for ($i = 0; $i < 3; $i++) {
      $rendered_field = $view->style_plugin
        ->getField($i, $field_name);
      $items = array();
      $pure_items = $this->nodes[$i]->{$field_name}[Language::LANGCODE_NOT_SPECIFIED];
      $pure_items = array_splice($pure_items, 1, 3);
      foreach ($pure_items as $j => $item) {
        $items[] = $pure_items[$j]['value'];
      }
      $this
        ->assertEqual($rendered_field, implode(', ', $items), 'Take sure that the amount of items are limited.');
    }
    $view
      ->destroy();

    // Test delta limit + reverse.
    $this
      ->prepareView($view);
    $view->displayHandlers
      ->get('default')->options['fields'][$field_name]['delta_offset'] = 0;
    $view->displayHandlers
      ->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
    $view->displayHandlers
      ->get('default')->options['fields'][$field_name]['delta_limit'] = 3;
    $view->displayHandlers
      ->get('default')->options['fields'][$field_name]['delta_reversed'] = TRUE;
    $this
      ->executeView($view);
    for ($i = 0; $i < 3; $i++) {
      $rendered_field = $view->style_plugin
        ->getField($i, $field_name);
      $items = array();
      $pure_items = $this->nodes[$i]->{$field_name}[Language::LANGCODE_NOT_SPECIFIED];
      array_splice($pure_items, 0, -3);
      $pure_items = array_reverse($pure_items);
      foreach ($pure_items as $j => $item) {
        $items[] = $pure_items[$j]['value'];
      }
      $this
        ->assertEqual($rendered_field, implode(', ', $items), 'Take sure that the amount of items are limited.');
    }
    $view
      ->destroy();

    // Test delta first last.
    $this
      ->prepareView($view);
    $view->displayHandlers
      ->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
    $view->displayHandlers
      ->get('default')->options['fields'][$field_name]['delta_limit'] = 0;
    $view->displayHandlers
      ->get('default')->options['fields'][$field_name]['delta_first_last'] = TRUE;
    $view->displayHandlers
      ->get('default')->options['fields'][$field_name]['delta_reversed'] = FALSE;
    $this
      ->executeView($view);
    for ($i = 0; $i < 3; $i++) {
      $rendered_field = $view->style_plugin
        ->getField($i, $field_name);
      $items = array();
      $pure_items = $this->nodes[$i]->{$field_name}[Language::LANGCODE_NOT_SPECIFIED];
      $items[] = $pure_items[0]['value'];
      $items[] = $pure_items[4]['value'];
      $this
        ->assertEqual($rendered_field, implode(', ', $items), 'Take sure that the amount of items are limited.');
    }
    $view
      ->destroy();

    // Test delta limit + custom seperator.
    $this
      ->prepareView($view);
    $view->displayHandlers
      ->get('default')->options['fields'][$field_name]['delta_first_last'] = FALSE;
    $view->displayHandlers
      ->get('default')->options['fields'][$field_name]['delta_limit'] = 3;
    $view->displayHandlers
      ->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
    $view->displayHandlers
      ->get('default')->options['fields'][$field_name]['separator'] = ':';
    $this
      ->executeView($view);
    for ($i = 0; $i < 3; $i++) {
      $rendered_field = $view->style_plugin
        ->getField($i, $field_name);
      $items = array();
      $pure_items = $this->nodes[$i]->{$field_name}[Language::LANGCODE_NOT_SPECIFIED];
      $pure_items = array_splice($pure_items, 0, 3);
      foreach ($pure_items as $j => $item) {
        $items[] = $pure_items[$j]['value'];
      }
      $this
        ->assertEqual($rendered_field, implode(':', $items), 'Take sure that the amount of items are limited.');
    }
  }

}