splide-1.0.x-dev/tests/src/Kernel/SplideManagerTest.php

<?php

namespace Drupal\Tests\splide\Kernel;

use Drupal\Tests\blazy\Kernel\BlazyKernelTestBase;
use Drupal\Tests\splide\Traits\SplideKernelTrait;
use Drupal\Tests\splide\Traits\SplideUnitTestTrait;
use Drupal\splide\Entity\Splide;
use Drupal\splide\SplideDefault;
use Drupal\splide_ui\Form\SplideForm;

/**
 * Tests the Splide manager methods.
 *
 * @coversDefaultClass \Drupal\splide\SplideManager
 *
 * @group splide
 */
class SplideManagerTest extends BlazyKernelTestBase {

  use SplideUnitTestTrait;
  use SplideKernelTrait;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'system',
    'user',
    'field',
    'file',
    'filter',
    'image',
    'node',
    'text',
    'blazy',
    'splide',
    'splide_ui',
    'splide_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp(): void {
    parent::setUp();

    $this->installConfig([
      'field',
      'image',
      'media',
      'responsive_image',
      'node',
      'views',
      'blazy',
      'splide',
      'splide_ui',
    ]);

    $bundle = $this->bundle;

    $this->messenger = $this->container->get('messenger');
    $this->splideAdmin = $this->container->get('splide.admin');
    $this->blazyAdminFormatter = $this->splideAdmin;
    $this->splideFormatter = $this->container->get('splide.formatter');
    $this->splideManager = $this->container->get('splide.manager');

    $this->splideForm = SplideForm::create($this->container);

    $this->testPluginId  = 'splide_image';
    $this->testFieldName = 'field_splide_image';
    $this->maxItems      = 7;
    $this->maxParagraphs = 2;

    $settings['fields']['field_text_multiple'] = 'text';
    $this->setUpContentTypeTest($bundle, $settings);
    $this->setUpContentWithItems($bundle);
    $this->setUpRealImage();

    $this->display = $this->setUpFormatterDisplay($bundle);
    $this->formatterInstance = $this->getFormatterInstance();
  }

  /**
   * Tests cases for various methods.
   *
   * @covers ::attach
   */
  public function testSplideManagerMethods() {
    $manager = $this->splideManager;
    $settings = [
      'media_switch'     => 'media',
      'lazy'             => '',
      'skin'             => 'classic',
      'down'             => TRUE,
      'thumbnail_effect' => 'hover',
      'module_css'       => TRUE,
    ] + $this->getFormatterSettings() + SplideDefault::extendedSettings();

    $attachments = $manager->attach($settings);
    $this->assertArrayHasKey('splide', $attachments['drupalSettings']);
  }

  /**
   * Tests for Splide build.
   *
   * @param bool $items
   *   Whether to provide items, or not.
   * @param array $settings
   *   The settings being tested.
   * @param array $options
   *   The options being tested.
   * @param mixed|bool|string $expected
   *   The expected output.
   *
   * @covers ::preRenderSplide
   * @covers ::buildGrid
   * @covers ::build
   * @covers ::preRenderSplideWrapper
   * @dataProvider providerTestSplideBuild
   */
  public function testBuild($items, array $settings, array $options, $expected) {
    $manager  = $this->splideManager;
    $defaults = $this->getFormatterSettings() + SplideDefault::htmlSettings();
    $settings = array_merge($defaults, $settings);

    $settings['optionset'] = 'test';

    $build = $this->display->build($this->entity);

    $items = !$items ? [] : $build[$this->testFieldName]['#build']['items'];
    $build = [
      'items'     => $items,
      '#settings'  => $settings,
      '#options'   => $options,
      '#optionset' => Splide::load($settings['optionset']),
    ];

    $splide['#build']['items'] = $items;
    $splide['#build']['#settings'] = $settings;
    $splide['#build']['#options'] = [];

    $element = $manager->preRenderSplide($splide);
    $this->assertEquals($expected, !empty($element));

    if (!empty($settings['optionset_nav'])) {
      $build['nav'] = [
        'items'    => $items,
        '#settings' => $settings,
        '#options'  => $options,
      ];
    }

    $splides = $manager->build($build);
    $this->assertEquals($expected, !empty($splides));

    $splides['#build']['items'] = $items;
    $splides['#build']['#settings'] = $settings;

    if (!empty($settings['optionset_nav'])) {
      $splides['#build']['nav']['items'] = $build['nav']['items'];
      $splides['#build']['nav']['#settings'] = $build['nav']['#settings'];
    }

    $elements = $manager->preRenderSplideWrapper($splides);
    $this->assertEquals($expected, !empty($elements));
  }

  /**
   * Provide test cases for ::testBuild().
   *
   * @return array
   *   An array of tested data.
   */
  public static function providerTestSplideBuild() {
    $data[] = [
      TRUE,
      [
        'grid' => 3,
        'visible_items' => 6,
        'override' => TRUE,
        'overridables' => ['arrows' => FALSE, 'pagination' => TRUE],
        'skin_dots' => 'dots',
        'cache' => -1,
      ],
      ['pagination' => TRUE],
      TRUE,
    ];
    $data[] = [
      TRUE,
      [
        'grid' => 3,
        'visible_items' => 6,
        'unsplide' => TRUE,
      ],
      [],
      TRUE,
    ];
    $data[] = [
      TRUE,
      [
        'skin' => 'test',
        'nav' => TRUE,
        'optionset_nav' => 'test_nav',
        'navpos' => 'top',
        'thumbnail_style' => 'thumbnail',
        'thumbnail_effect' => 'hover',

      ],
      [],
      TRUE,
    ];

    return $data;
  }

  /**
   * Tests for \Drupal\splide_ui\Form\SplideForm.
   *
   * @covers \Drupal\splide_ui\Form\SplideForm::typecastOptionset
   */
  public function testSplideForm() {
    $settings = [];
    $this->splideForm->typecastOptionset($settings);
    $this->assertEmpty($settings);

    $settings['drag'] = 1;
    $settings['edgeFriction'] = 0.27;
    $this->splideForm->typecastOptionset($settings);
    $this->assertEquals(TRUE, $settings['drag']);
  }

}