class DateRecurRlHelperUnitTest in Recurring Dates Field 8.2
Same name and namespace in other branches
- 3.x tests/src/Unit/DateRecurRlHelperUnitTest.php \Drupal\Tests\date_recur\Unit\DateRecurRlHelperUnitTest
- 3.0.x tests/src/Unit/DateRecurRlHelperUnitTest.php \Drupal\Tests\date_recur\Unit\DateRecurRlHelperUnitTest
- 3.1.x tests/src/Unit/DateRecurRlHelperUnitTest.php \Drupal\Tests\date_recur\Unit\DateRecurRlHelperUnitTest
Tests Rlanvin implementation of helper.
@coversDefaultClass \Drupal\date_recur\Rl\RlHelper @group date_recur
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
- class \Drupal\Tests\date_recur\Unit\DateRecurRlHelperUnitTest
Expanded class hierarchy of DateRecurRlHelperUnitTest
File
- tests/
src/ Unit/ DateRecurRlHelperUnitTest.php, line 19
Namespace
Drupal\Tests\date_recur\UnitView source
class DateRecurRlHelperUnitTest extends UnitTestCase {
/**
* Test occurrence generation with range limiters.
*
* @covers ::getOccurrences
* @covers ::generateOccurrences
*/
public function testOccurrence() {
$helper = $this
->createHelper('FREQ=DAILY;COUNT=1', new \DateTime('2am 14 April 2014'), new \DateTime('4am 14 April 2014'));
// Test out of range (before).
$occurrences = $helper
->getOccurrences(new \DateTime('1am 14 April 2014'), new \DateTime('1:30am 14 April 2014'));
$this
->assertCount(0, $occurrences);
// Test out of range (after).
$occurrences = $helper
->getOccurrences(new \DateTime('4:30am 14 April 2014'), new \DateTime('5am 14 April 2014'));
$this
->assertCount(0, $occurrences);
// Test in range (intersects occurrence start).
$occurrences = $helper
->getOccurrences(new \DateTime('1am 14 April 2014'), new \DateTime('3am 14 April 2014'));
$this
->assertCount(1, $occurrences);
// Test in range (exact).
$occurrences = $helper
->getOccurrences(new \DateTime('2am 14 April 2014'), new \DateTime('4am 14 April 2014'));
$this
->assertCount(1, $occurrences);
// Test in range (within).
$occurrences = $helper
->getOccurrences(new \DateTime('2:30am 14 April 2014'), new \DateTime('3:30am 14 April 2014'));
$this
->assertCount(1, $occurrences);
// Test in range (intersects occurrence end).
$occurrences = $helper
->getOccurrences(new \DateTime('3am 14 April 2014'), new \DateTime('5am 14 April 2014'));
$this
->assertCount(1, $occurrences);
// Test in range but zero limit.
$occurrences = $helper
->getOccurrences(new \DateTime('1am 14 April 2014'), new \DateTime('3am 14 April 2014'), 0);
$this
->assertCount(0, $occurrences);
}
/**
* Tests invalid argument for limit.
*/
public function testInvalidLimit() {
$helper = $this
->createHelper('FREQ=DAILY;COUNT=10', new \DateTime('2am 14 April 2014'), new \DateTime('4am 14 April 2014'));
$this
->setExpectedException(\InvalidArgumentException::class, 'Invalid count limit.');
$helper
->getOccurrences(new \DateTime('1am 14 April 2014'), new \DateTime('3am 14 April 2014'), -1);
}
/**
* Tests frequency method of rules returned by helper.
*/
public function testFrequency() {
$dtStart = new \DateTime('9am 16 June 2014');
$rrule = 'FREQ=DAILY;COUNT=10';
$instance = $this
->createHelper($rrule, $dtStart);
$rules = $instance
->getRules();
$this
->assertCount(1, $rules);
$rule = $rules[0];
$this
->assertEquals('DAILY', $rule
->getFrequency());
}
/**
* Tests single EXDATE value.
*/
public function testExdate() {
$timeZone = new \DateTimeZone('Asia/Singapore');
// Difference between exdate (UTC) and Singapore is 8 hours.
$dtStart = new \DateTime('10am 16 June 2014', $timeZone);
$rrule = 'RRULE:FREQ=DAILY;COUNT=6
EXDATE:20140617T020000Z';
$instance = $this
->createHelper($rrule, $dtStart);
$occurrences = $instance
->getOccurrences();
$this
->assertCount(5, $occurrences);
// Occurrence time zones are same as start date.
$this
->assertEquals('Mon, 16 Jun 2014 10:00:00 +0800', $occurrences[0]
->getStart()
->format('r'));
$this
->assertEquals('Wed, 18 Jun 2014 10:00:00 +0800', $occurrences[1]
->getStart()
->format('r'));
$this
->assertEquals('Thu, 19 Jun 2014 10:00:00 +0800', $occurrences[2]
->getStart()
->format('r'));
$this
->assertEquals('Fri, 20 Jun 2014 10:00:00 +0800', $occurrences[3]
->getStart()
->format('r'));
$this
->assertEquals('Sat, 21 Jun 2014 10:00:00 +0800', $occurrences[4]
->getStart()
->format('r'));
// Exdate time zones are same as original, not same as start date.
$exDates = $instance
->getRlRuleset()
->getExDates();
$this
->assertCount(1, $exDates);
$this
->assertEquals('Tue, 17 Jun 2014 02:00:00 +0000', $exDates[0]
->format('r'));
}
/**
* Tests multiple EXDATE values.
*/
public function testExdateMultiple() {
$timeZone = new \DateTimeZone('Asia/Singapore');
// Difference between exdate (UTC) and Singapore is 8 hours.
$dtStart = new \DateTime('10am 16 June 2014', $timeZone);
$rrule = 'RRULE:FREQ=DAILY;COUNT=6
EXDATE:20140617T020000Z,20140619T020000Z';
$instance = $this
->createHelper($rrule, $dtStart);
$occurrences = $instance
->getOccurrences();
$this
->assertCount(4, $occurrences);
// Occurrence time zones are same as start date.
$this
->assertEquals('Mon, 16 Jun 2014 10:00:00 +0800', $occurrences[0]
->getStart()
->format('r'));
$this
->assertEquals('Wed, 18 Jun 2014 10:00:00 +0800', $occurrences[1]
->getStart()
->format('r'));
$this
->assertEquals('Fri, 20 Jun 2014 10:00:00 +0800', $occurrences[2]
->getStart()
->format('r'));
$this
->assertEquals('Sat, 21 Jun 2014 10:00:00 +0800', $occurrences[3]
->getStart()
->format('r'));
// Exdate time zones are same as original, not same as start date.
$exDates = $instance
->getRlRuleset()
->getExDates();
$this
->assertCount(2, $exDates);
$this
->assertEquals('Tue, 17 Jun 2014 02:00:00 +0000', $exDates[0]
->format('r'));
$this
->assertEquals('Thu, 19 Jun 2014 02:00:00 +0000', $exDates[1]
->format('r'));
}
/**
* Tests EXDATE is ignored because of time zone differences.
*/
public function testExdateTimezone() {
$timeZone = new \DateTimeZone('Asia/Singapore');
// Difference between exdate (UTC) and Singapore is 8 hours.
// Exdate will be ignored because it never happens at the same time as
// occurrences.
$dtStart = new \DateTime('9am 16 June 2014', $timeZone);
$rrule = 'RRULE:FREQ=DAILY;COUNT=6
EXDATE:20140617T000000Z,20140618T000000Z';
$instance = $this
->createHelper($rrule, $dtStart);
$occurrences = $instance
->getOccurrences();
$this
->assertCount(6, $occurrences);
}
/**
* Tests single RDATE value.
*
* Rdates serve to add extra fixed time occurrences, they are combined with
* any dates computed by RRULEs.
*/
public function testRdate() {
$timeZone = new \DateTimeZone('Asia/Singapore');
$dtStart = new \DateTime('11am 4 Oct 2012', $timeZone);
$rrule = 'RRULE:FREQ=WEEKLY;COUNT=3
RDATE:20121006T120000Z';
$instance = $this
->createHelper($rrule, $dtStart);
// Tests the RDATE is found between all the RRULE occurrences, such that it
// is chronological date order, not simply appended to the RRULE list.
$occurrences = $instance
->getOccurrences();
$this
->assertCount(4, $occurrences);
// Occurrence time zones are same as start date.
$this
->assertEquals('Thu, 04 Oct 2012 11:00:00 +0800', $occurrences[0]
->getStart()
->format('r'));
// The RDATE date/time zone is not normalised to the start-date time zone.
$this
->assertEquals('Sat, 06 Oct 2012 12:00:00 +0000', $occurrences[1]
->getStart()
->format('r'));
$this
->assertEquals('Thu, 11 Oct 2012 11:00:00 +0800', $occurrences[2]
->getStart()
->format('r'));
$this
->assertEquals('Thu, 18 Oct 2012 11:00:00 +0800', $occurrences[3]
->getStart()
->format('r'));
// Rdate time zones are same as original, not same as start date.
$rDates = $instance
->getRlRuleset()
->getDates();
$this
->assertCount(1, $rDates);
$this
->assertEquals('Sat, 06 Oct 2012 12:00:00 +0000', $rDates[0]
->format('r'));
}
/**
* Tests multiple RDATE values.
*/
public function testRdateMultiple() {
$timeZone = new \DateTimeZone('Asia/Singapore');
$dtStart = new \DateTime('11am 4 Oct 2012', $timeZone);
$rrule = 'RRULE:FREQ=WEEKLY;COUNT=3
RDATE:20121006T120000Z,20121013T120000Z';
$instance = $this
->createHelper($rrule, $dtStart);
// Tests the RDATE is found between all the RRULE occurrences, such that it
// is chronological date order, not simply appended to the RRULE list.
$occurrences = $instance
->getOccurrences();
$this
->assertCount(5, $occurrences);
// Occurrence time zones are same as start date.
$this
->assertEquals('Thu, 04 Oct 2012 11:00:00 +0800', $occurrences[0]
->getStart()
->format('r'));
// The RDATE date/time zone is not normalised to the start-date time zone.
$this
->assertEquals('Sat, 06 Oct 2012 12:00:00 +0000', $occurrences[1]
->getStart()
->format('r'));
$this
->assertEquals('Thu, 11 Oct 2012 11:00:00 +0800', $occurrences[2]
->getStart()
->format('r'));
$this
->assertEquals('Sat, 13 Oct 2012 12:00:00 +0000', $occurrences[3]
->getStart()
->format('r'));
$this
->assertEquals('Thu, 18 Oct 2012 11:00:00 +0800', $occurrences[4]
->getStart()
->format('r'));
// Rdate time zones are same as original, not same as start date.
$rDates = $instance
->getRlRuleset()
->getDates();
$this
->assertCount(2, $rDates);
$this
->assertEquals('Sat, 06 Oct 2012 12:00:00 +0000', $rDates[0]
->format('r'));
$this
->assertEquals('Sat, 13 Oct 2012 12:00:00 +0000', $rDates[1]
->format('r'));
}
/**
* Tests parts that were not passed originally, are not returned.
*/
public function testRedundantPartsOmitted() {
$dtStart = new \DateTime('9am 16 June 2014');
$rrule = 'FREQ=DAILY;COUNT=10';
$instance = $this
->createHelper($rrule, $dtStart);
$rules = $instance
->getRules();
$this
->assertCount(1, $rules);
$rule = $rules[0];
$parts = $rule
->getParts();
// Rlanvin/rrule will return parts: 'DTSTART', 'FREQ', 'COUNT', 'INTERVAL',
// 'WKST'. However we just need to test completely unrelated parts such as
// BYMONTHDAY etc arn't returned here.
$this
->assertArrayHasKey('DTSTART', $parts);
$this
->assertArrayHasKey('COUNT', $parts);
$this
->assertArrayNotHasKey('BYMONTHDAY', $parts);
}
/**
* Tests where a multiline rule without is missing the type prefix.
*/
public function testMultilineMissingColon() {
$rrule = 'RRULE:FREQ=DAILY;BYDAY=MO,TU,WE,TH,FR;COUNT=3
EXDATE:19960402T010000Z
foobar';
$this
->setExpectedException(DateRecurHelperArgumentException::class, 'Multiline RRULE must be prefixed with either: RRULE, EXDATE, EXRULE, or RDATE. Missing for line 3');
$this
->createHelper($rrule, new \DateTime());
}
/**
* 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
->createHelper($string, $dtStart);
$excluded = $helper
->getExcluded();
$this
->assertCount(1, $excluded);
$expectedDate = new \DateTime('9am 6 September 2018', $tz);
$this
->assertEquals($expectedDate, $excluded[0]);
}
/**
* Creates a new helper.
*
* @param string|\DateTimeInterface|null|mixed $args
* Uses same arguments as
* \Drupal\date_recur\DateRecurHelperInterface::createInstance.
*
* @return \Drupal\date_recur\DateRecurHelperInterface
* A new date recur helper instance.
*
* @see \Drupal\date_recur\DateRecurHelperInterface::createInstance
*/
protected function createHelper(...$args) {
return RlHelper::createInstance(...func_get_args());
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DateRecurRlHelperUnitTest:: |
protected | function | Creates a new helper. | |
DateRecurRlHelperUnitTest:: |
public | function | Tests single EXDATE value. | |
DateRecurRlHelperUnitTest:: |
public | function | Tests multiple EXDATE values. | |
DateRecurRlHelperUnitTest:: |
public | function | Tests EXDATE is ignored because of time zone differences. | |
DateRecurRlHelperUnitTest:: |
public | function | Tests frequency method of rules returned by helper. | |
DateRecurRlHelperUnitTest:: |
public | function | Tests list. | |
DateRecurRlHelperUnitTest:: |
public | function | Tests invalid argument for limit. | |
DateRecurRlHelperUnitTest:: |
public | function | Tests where a multiline rule without is missing the type prefix. | |
DateRecurRlHelperUnitTest:: |
public | function | Test occurrence generation with range limiters. | |
DateRecurRlHelperUnitTest:: |
public | function | Tests single RDATE value. | |
DateRecurRlHelperUnitTest:: |
public | function | Tests multiple RDATE values. | |
DateRecurRlHelperUnitTest:: |
public | function | Tests parts that were not passed originally, are not returned. | |
PhpunitCompatibilityTrait:: |
public | function | Returns a mock object for the specified class using the available method. | |
PhpunitCompatibilityTrait:: |
public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | |
UnitTestCase:: |
protected | property | The random generator. | |
UnitTestCase:: |
protected | property | The app root. | 1 |
UnitTestCase:: |
protected | function | Asserts if two arrays are equal by sorting them first. | |
UnitTestCase:: |
protected | function | Mocks a block with a block plugin. | 1 |
UnitTestCase:: |
protected | function | Returns a stub class resolver. | |
UnitTestCase:: |
public | function | Returns a stub config factory that behaves according to the passed array. | |
UnitTestCase:: |
public | function | Returns a stub config storage that returns the supplied configuration. | |
UnitTestCase:: |
protected | function | Sets up a container with a cache tags invalidator. | |
UnitTestCase:: |
protected | function | Gets the random generator for the utility methods. | |
UnitTestCase:: |
public | function | Returns a stub translation manager that just returns the passed string. | |
UnitTestCase:: |
public | function | Generates a unique random string containing letters and numbers. | |
UnitTestCase:: |
protected | function | 340 |