DateRecurRruleUnitTest.php in Recurring Dates Field 3.0.x

Namespace

Drupal\Tests\date_recur\Unit

File

tests/src/Unit/DateRecurRruleUnitTest.php

<?php

namespace Drupal\Tests\date_recur\Unit;

use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\Language\Language;
use Drupal\Core\Language\LanguageManagerInterface;
use Drupal\date_recur\DateRange;
use Drupal\date_recur\DateRecurHelper;
use Drupal\Tests\UnitTestCase;

/**
 * Date recur tests.
 *
 * @coversDefaultClass \Drupal\date_recur\DateRecurHelper
 * @group date_recur
 */
class DateRecurRruleUnitTest extends UnitTestCase {

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

    // DrupalDateTime wants to access the language manager.
    $languageManager = $this
      ->getMockForAbstractClass(LanguageManagerInterface::class);
    $languageManager
      ->expects($this
      ->any())
      ->method('getCurrentLanguage')
      ->will($this
      ->returnValue(new Language([
      'id' => 'en',
    ])));
    $container = new ContainerBuilder();
    $container
      ->set('language_manager', $languageManager);
    $container
      ->set('string_translation', $this
      ->getStringTranslationStub());
    \Drupal::setContainer($container);
  }

  /**
   * Test timezone.
   *
   * @param \DateTimeZone $tz
   *   A timezone for testing.
   *
   * @dataProvider providerTimezone
   */
  public function testTz(\DateTimeZone $tz) {
    $start = new \DateTime('11pm 7 June 2005', $tz);
    $rule = $this
      ->newRule('FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR;INTERVAL=1', $start);

    // Test new method.
    $results = $rule
      ->getOccurrences(NULL, NULL, 1);
    $this
      ->assertInstanceOf(\DateTimeInterface::class, $results[0]
      ->getStart());
    $this
      ->assertTrue($start == $results[0]
      ->getStart());
  }

  /**
   * Data provider for ::testTz.
   */
  public function providerTimezone() {
    $data[] = [
      new \DateTimeZone('America/Los_Angeles'),
    ];
    $data[] = [
      new \DateTimeZone('UTC'),
    ];
    $data[] = [
      new \DateTimeZone('Australia/Sydney'),
    ];
    return $data;
  }

  /**
   * Tests list.
   *
   * @covers ::generateOccurrences
   */
  public function testGenerateOccurrences() {
    $tz = new \DateTimeZone('Africa/Cairo');
    $start = new \DateTime('11pm 7 June 2005', $tz);
    $end = clone $start;
    $end
      ->modify('+2 hours');
    $rule = $this
      ->newRule('FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR', $start, $end);
    $generator = $rule
      ->generateOccurrences();
    $this
      ->assertTrue($generator instanceof \Generator);
    $assertOccurrences = [
      [
        new \DateTime('11pm 7 June 2005', $tz),
        new \DateTime('1am 8 June 2005', $tz),
      ],
      [
        new \DateTime('11pm 8 June 2005', $tz),
        new \DateTime('1am 9 June 2005', $tz),
      ],
      [
        new \DateTime('11pm 9 June 2005', $tz),
        new \DateTime('1am 10 June 2005', $tz),
      ],
      [
        new \DateTime('11pm 10 June 2005', $tz),
        new \DateTime('1am 11 June 2005', $tz),
      ],
      [
        new \DateTime('11pm 13 June 2005', $tz),
        new \DateTime('1am 14 June 2005', $tz),
      ],
      [
        new \DateTime('11pm 14 June 2005', $tz),
        new \DateTime('1am 15 June 2005', $tz),
      ],
      [
        new \DateTime('11pm 15 June 2005', $tz),
        new \DateTime('1am 16 June 2005', $tz),
      ],
    ];

    // Iterate over it a bit, because this is an infinite RRULE it will go
    // forever.
    $iterationCount = 0;
    $maxIterations = count($assertOccurrences);
    foreach ($generator as $occurrence) {
      $this
        ->assertTrue($occurrence instanceof DateRange);
      [
        $assertStart,
        $assertEnd,
      ] = $assertOccurrences[$iterationCount];
      $this
        ->assertTrue($assertStart == $occurrence
        ->getStart());
      $this
        ->assertTrue($assertEnd == $occurrence
        ->getEnd());
      $iterationCount++;
      if ($iterationCount >= $maxIterations) {
        break;
      }
    }
    $this
      ->assertEquals($maxIterations, $iterationCount);
  }

  /**
   * Tests list.
   *
   * @covers ::getExcluded
   */
  public function testGetExcluded() {
    $tz = new \DateTimeZone('Asia/Singapore');
    $dtStart = new \DateTime('9am 4 September 2018', $tz);
    $string = 'RRULE:FREQ=DAILY;BYDAY=MO,TU,WE,TH,FR;COUNT=3
EXDATE:20180906T010000Z';
    $helper = $this
      ->newRule($string, $dtStart);
    $excluded = $helper
      ->getExcluded();
    $this
      ->assertCount(1, $excluded);
    $expectedDate = new \DateTime('9am 6 September 2018', $tz);
    $this
      ->assertEquals($expectedDate, $excluded[0]);
  }

  /**
   * Constructs a new DateRecurHelper object.
   *
   * @param string $rrule
   *   The repeat rule.
   * @param \DateTime $startDate
   *   The initial occurrence start date.
   * @param \DateTime|null $startDateEnd
   *   The initial occurrence end date, or NULL to use start date.
   *
   * @return \Drupal\date_recur\DateRecurHelper
   *   A new DateRecurHelper object.
   */
  protected function newRule($rrule, \DateTime $startDate, \DateTime $startDateEnd = NULL) {
    return DateRecurHelper::create($rrule, $startDate, $startDateEnd);
  }

}

Classes

Name	Description
DateRecurRruleUnitTest	Date recur tests.