[ical] Add DateParser
#534
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| <?php | ||
|
|
||
| namespace SRF\iCalendar; | ||
|
|
||
| use SMWDataValueFactory as DataValueFactory; | ||
| use SMWTimeValue as TimeValue; | ||
|
|
||
| /** | ||
| * @license GNU GPL v2+ | ||
| * @since 3.1 | ||
| */ | ||
| class DateParser { | ||
|
|
||
| /** | ||
| * Extract a date string formatted for iCalendar from a SMWTimeValue object. | ||
| * | ||
| * @since 3.1 | ||
| * | ||
| * @param TimeValue $dataValue | ||
| * @param boolean $isEnd | ||
| * | ||
| * @return string | ||
| */ | ||
| public function parseDate( TimeValue $dataValue, $isEnd = false ) { | ||
| $year = $dataValue->getYear(); | ||
|
|
||
| // ISO range is limited to four digits | ||
| if ( ( $year > 9999 ) || ( $year < -9998 ) ) { | ||
| return ''; | ||
| } | ||
|
|
||
| $year = number_format( $year, 0, '.', '' ); | ||
| $time = str_replace( ':', '', $dataValue->getTimeString( false ) ); | ||
|
|
||
| // increment by one day, compute date to cover leap years etc. | ||
| if ( ( $time == false ) && ( $isEnd ) ) { | ||
| $dataValue = DataValueFactory::getInstance()->newDataValueByType( | ||
| '_dat', | ||
| $dataValue->getWikiValue() . 'T00:00:00-24:00' | ||
| ); | ||
| } | ||
|
|
||
| $month = $dataValue->getMonth(); | ||
|
|
||
| if ( strlen( $month ) == 1 ) { | ||
| $month = '0' . $month; | ||
| } | ||
|
|
||
| $day = $dataValue->getDay(); | ||
|
|
||
| if ( strlen( $day ) == 1 ) { | ||
| $day = '0' . $day; | ||
| } | ||
|
|
||
| $result = $year . $month . $day; | ||
|
|
||
| if ( $time != false ) { | ||
| $result .= "T$time"; | ||
| } | ||
|
|
||
| return $result; | ||
| } | ||
|
|
||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| <?php | ||
|
|
||
| namespace SRF\Tests\iCalendar; | ||
|
|
||
| use SRF\iCalendar\DateParser; | ||
|
|
||
| /** | ||
| * @covers \SRF\iCalendar\DateParser | ||
| * @group semantic-result-formats | ||
| * | ||
| * @license GNU GPL v2+ | ||
| * @since 3.1 | ||
|
There was a problem hiding this comment. This class is not package public so this is clutter IMO There was a problem hiding this comment. I'm not a fan of the "no comment" purist approach, so I do think some minimal style block should be retained. There was a problem hiding this comment. I was talking just about the @SInCE tag |
||
| * | ||
| * @author mwjames | ||
| */ | ||
| class DateParserTest extends \PHPUnit_Framework_TestCase { | ||
|
|
||
| public function testCanConstruct() { | ||
|
|
||
| $this->assertInstanceOf( | ||
| DateParser::class, | ||
| new DateParser() | ||
| ); | ||
| } | ||
|
There was a problem hiding this comment. I think this test is better omitted There was a problem hiding this comment. I do test the constructor for a while now and it served me well, it even found some issues in other tests. |
||
|
|
||
| public function testParseDate_Year() { | ||
|
|
||
| $timeValue = $this->getMockBuilder( '\SMWTimeValue' ) | ||
| ->disableOriginalConstructor() | ||
| ->getMock(); | ||
|
There was a problem hiding this comment. Pretty sure you can use createMock rather than this deprecated form You can also use SMWTimeValue::class There was a problem hiding this comment. I know but the intent is clearer that constructor is disabled, and we don't count lines so it doesn't really matter. There was a problem hiding this comment. Eh... both the authors of PHPUnit and me beg to differ |
||
|
|
||
| $timeValue->expects( $this->any() ) | ||
|
There was a problem hiding this comment. SMWTimeValue is a value object right? Then why are you creating a mock? This adds a bunch of hidden coupling (method names as strings, plus their signatures...) which is best avoided if there is no good reason for it. There was a problem hiding this comment.
Sort of but using an a mock ensures that specific coupling to let's say a Title object, or the Store are not pulled in hereby avoids creating a possible DB connection, especially the Title object is nasty, and by using a mock I'm certain I have an encapsulate object that doesn't create any connection. There was a problem hiding this comment. Alright, sounds like SMWTimeValue is not a value object then. |
||
| ->method( 'getYear' ) | ||
| ->will( $this->returnValue( 2000 ) ); | ||
|
|
||
| $instance = new DateParser(); | ||
|
|
||
| $this->assertSame( | ||
| '20000101', | ||
| $instance->parseDate( $timeValue, true ) | ||
| ); | ||
| } | ||
|
|
||
| public function testParseDate_Year_Month_Day_Time() { | ||
|
|
||
| $timeValue = $this->getMockBuilder( '\SMWTimeValue' ) | ||
| ->disableOriginalConstructor() | ||
| ->getMock(); | ||
|
|
||
| $timeValue->expects( $this->any() ) | ||
| ->method( 'getYear' ) | ||
| ->will( $this->returnValue( 2000 ) ); | ||
|
|
||
| $timeValue->expects( $this->any() ) | ||
| ->method( 'getMonth' ) | ||
| ->will( $this->returnValue( 12 ) ); | ||
|
|
||
| $timeValue->expects( $this->any() ) | ||
| ->method( 'getDay' ) | ||
| ->will( $this->returnValue( 12 ) ); | ||
|
|
||
| $timeValue->expects( $this->any() ) | ||
| ->method( 'getTimeString' ) | ||
| ->will( $this->returnValue( '12:01:01' ) ); | ||
|
|
||
| $instance = new DateParser(); | ||
|
|
||
| $this->assertSame( | ||
| '20001212T120101', | ||
| $instance->parseDate( $timeValue, true ) | ||
| ); | ||
| } | ||
|
|
||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doing strict typing, I know you like it but I have not come to terms on how to approach this without creating a piece here and there. Without a clear map of how to transform an entire "package" (it would refer here to the entire ical format and its depending classes) and not just for one class I'm a bit reluctant to just drop it like a breadcrumb.