Complexer period comparisons about period

[nyamsprod]

@brendt to do what you are requesting it means at least adding a Sequence class to the package which I'm working on right now. the PR for it will hopefully land on separate branch once the code is stable. If you want I can make it public rigth now but the tests are no quite finish.

For now I can tell you that it will have the basic methods from a Sequence object with two additional methods which are Sequence::getGaps and Sequence::getIntersections which should return the gaps and intersections inside a collection of Period objects. Does that sound good for you ?

Do you want me to publish in a separate branch the work in progress on the Sequence class to see if it meets your requirements ? Any input is welcomed 😉

[brendt]

@nyamsprod great to hear! I'll definitely want to take a look!

[nyamsprod]

you can find it here now https://github.com/thephpleague/period/blob/feature/add-sequence/src/Sequence.php ... again the implementation is not done so yes if you want to improve it be my guess 😉

[brendt]

Thanks! There's one thing I'm wondering about: if you sort the intervals by start date to calculate the gaps, is the following scenario covered?

sequence:

0) [==================]
1)     [====]
2)                         [=====]

expected gap:

                      [==]

resulting gap:

             [============]

I haven't run the code yet, but from reading it, I wonder how this would work if you're relying on a sorted set 🤔

[nyamsprod]

@brendt this is a first implementation and tests are missing ... So yeah it is more than possible that your test will not work yet

[nyamsprod]

i've just tested you assumption and I do get the expected result 👍

<?php

use League\Period;
use League\Period\Sequence;

echo "<pre>", PHP_EOL;

$today = Period\day('2018-11-29');
$week = Period\interval_around('2018-11-29', '4 DAYS');
$next = Period\interval_after('2018-11-29 + 7 DAYS', '1 DAY');

$sequence = new Sequence($week, $today, $next);
$gaps = $sequence->getGaps();
var_export([
    'nb sequence' => count($sequence),
    'nb gaps' => count($gaps), 
    'gap' => $gaps->get(0)->format('Y-m-d'),
]);

result

array (
  'nb sequence' => 3,
  'nb gaps' => 1,
  'gap' => '[2018-12-03, 2018-12-06)',
)

[nyamsprod]

but I'll confess that Sequence::getIntersections is still a mess of a implementation 😭

[nyamsprod]

@brendt I've added some of your package tests to the sequence testsuite as well as your example for the getGaps tests and after some fixes seems that my two methods do exactly what you are looking for. Of course more tests are welcomed to complete the testsuite 😉

[brendt]

Oh that's great! Guess I can close this issue now 👍

[nyamsprod]

@brendt the Sequence class has landed on the master branch and you can already see its documentation on the website If all goes as planned 4.1 should be released next week 😉

[brendt]

That's great! I'll do my best to try it out in one of our projects!