TimeFormatterTest::getTimestampFormatter() - Code Metrics - Inspection of "Major rewrite of TimeFormatter" - DataValues/Time - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#49)

by no

created 2017-06-08 16:04 UTC

TimeFormatterTest::getTimestampFormatter() A

↳ Parent: TimeFormatterTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	8
rs	9.4285
cc	1
eloc	6
nc	1
nop	0

<?php

namespace ValueFormatters\Test;

use DataValues\TimeValue;
use ValueFormatters\FormatterOptions;
use ValueFormatters\TimeFormatter;
use ValueFormatters\ValueFormatter;

/**
 * @covers ValueFormatters\TimeFormatter
 *
 * @group ValueFormatters
 * @group DataValueExtensions
 *
 * @license GPL-2.0+
 * @author H. Snater < [email protected] >
 * @author Thiemo Mättig
 */
class TimeFormatterTest extends ValueFormatterTestBase {

	/**
	 * @deprecated since DataValues Interfaces 0.2, just use getInstance.
	 */
	protected function getFormatterClass() {
		throw new \LogicException( 'Should not be called, use getInstance' );
	}

	/**
	 * @see ValueFormatterTestBase::getInstance
	 *
	 * @param FormatterOptions|null $options
	 *
	 * @return TimeFormatter
	 */
	protected function getInstance( FormatterOptions $options = null ) {
		return new TimeFormatter( $options );
	}

	/**
	 * @return ValueFormatter
	 */
	private function getTimestampFormatter() {
		$mock = $this->getMock( 'ValueFormatters\ValueFormatter' );
		$mock->expects( $this->any() )
			->method( 'format' )
			->will( $this->returnValue( '<timestamp>' ) );

		return $mock;
	}

	/**
	 * @see ValueFormatterTestBase::validProvider
	 */
	public function validProvider() {
		$gregorian = 'http://www.wikidata.org/entity/Q1985727';
		$julian = 'http://www.wikidata.org/entity/Q1985786';

		$baseOptions = new FormatterOptions();
		$baseOptions->setOption( TimeFormatter::OPT_CALENDARNAMES, array(
			$gregorian => '<Gregorian>',
			$julian => '<Julian>',
		) );

		$timestampFormatterOptions = new FormatterOptions();
		$timestampFormatterOptions->setOption(
			TimeFormatter::OPT_TIME_ISO_FORMATTER,
			$this->getTimestampFormatter()
		);

		$tests = array(
			'2013-07-16' => array(
				'+2013-07-16T00:00:00Z',
			),

			// Custom timestamp formatter
			'<timestamp>' => array(
				'+2013-07-16T00:00:00Z',
				TimeValue::PRECISION_DAY,
				$gregorian,
				$timestampFormatterOptions,
			),

			// Different calendar models
			'1701-12-14' => array(
				'+1701-12-14T00:00:00Z',
				TimeValue::PRECISION_DAY,
				$julian,
			),
			'1702-12-14' => array(
				'+1702-12-14T00:00:00Z',
				TimeValue::PRECISION_DAY,
				'Stardate',
			),

			// Different years
			"\xE2\x88\x9210000-01-01" => array(
				'-010000-01-01T00:00:00Z',
			),
			"\xE2\x88\x920001-01-01" => array(
				'-1-01-01T00:00:00Z',
			),
			"\xE2\x88\x920100-01-01" => array(
				'-100-01-01T00:00:00Z',
			),
			"\xE2\x88\x920000-01-01" => array(
				'-0-01-01T00:00:00Z',
			),
			'0000-01-01' => array(
				'+0-01-01T00:00:00Z',
			),
			'0001-01-01' => array(
				'+1-01-01T00:00:00Z',
			),
			'0100-01-01' => array(
				'+100-01-01T00:00:00Z',
			),
			'10000-01-01' => array(
				'+010000-01-01T00:00:00Z',
			),

			// Different precisions
			'2000' => array(
				'+2000-01-01T00:00:00Z',
				TimeValue::PRECISION_YEAR1G,
			),
			'2008' => array(
				'+2008-01-08T00:00:00Z',
				TimeValue::PRECISION_YEAR10,
			),
			'2009' => array(
				'+2009-01-09T00:00:00Z',
				TimeValue::PRECISION_YEAR,
			),
			'2010-07' => array(
				'+2010-07-10T00:00:00Z',
				TimeValue::PRECISION_MONTH,
			),
			'2011-07-11' => array(
				'+2011-07-11T00:00:00Z',
				TimeValue::PRECISION_DAY,
			),
			'2012-07-12T00' => array(
				'+2012-07-12T00:00:00Z',
				TimeValue::PRECISION_HOUR,
			),
			'2013-07-13T00:00' => array(
				'+2013-07-13T00:00:00Z',
				TimeValue::PRECISION_MINUTE,
			),
			'2014-07-14T00:00:00' => array(
				'+2014-07-14T00:00:00Z',
				TimeValue::PRECISION_SECOND,
			),
		);

		$argLists = array();

		foreach ( $tests as $expected => $args ) {
			$timestamp = $args[0];
			$precision = isset( $args[1] ) ? $args[1] : TimeValue::PRECISION_DAY;
			$calendarModel = isset( $args[2] ) ? $args[2] : $gregorian;
			$options = isset( $args[3] ) ? $args[3] : $baseOptions;

			$argLists[] = array(
				new TimeValue( $timestamp, 0, 0, 0, $precision, $calendarModel ),
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
				(string)$expected,
				$options
			);
		}

		return $argLists;
	}

}


1			<?php
2
3			namespace ValueFormatters\Test;
4
5			use DataValues\TimeValue;
6			use ValueFormatters\FormatterOptions;
7			use ValueFormatters\TimeFormatter;
8			use ValueFormatters\ValueFormatter;
9
10			/**
11			* @covers ValueFormatters\TimeFormatter
12			*
13			* @group ValueFormatters
14			* @group DataValueExtensions
15			*
16			* @license GPL-2.0+
17			* @author H. Snater < [email protected] >
18			* @author Thiemo Mättig
19			*/
20			class TimeFormatterTest extends ValueFormatterTestBase {
21
22			/**
23			* @deprecated since DataValues Interfaces 0.2, just use getInstance.
24			*/
25			protected function getFormatterClass() {
26			throw new \LogicException( 'Should not be called, use getInstance' );
27			}
28
29			/**
30			* @see ValueFormatterTestBase::getInstance
31			*
32			* @param FormatterOptions\|null $options
33			*
34			* @return TimeFormatter
35			*/
36			protected function getInstance( FormatterOptions $options = null ) {
37			return new TimeFormatter( $options );
38			}
39
40			/**
41			* @return ValueFormatter
42			*/
43			private function getTimestampFormatter() {
44			$mock = $this->getMock( 'ValueFormatters\ValueFormatter' );
45			$mock->expects( $this->any() )
46			->method( 'format' )
47			->will( $this->returnValue( '<timestamp>' ) );
48
49			return $mock;
50			}
51
52			/**
53			* @see ValueFormatterTestBase::validProvider
54			*/
55			public function validProvider() {
56			$gregorian = 'http://www.wikidata.org/entity/Q1985727';
57			$julian = 'http://www.wikidata.org/entity/Q1985786';
58
59			$baseOptions = new FormatterOptions();
60			$baseOptions->setOption( TimeFormatter::OPT_CALENDARNAMES, array(
61			$gregorian => '<Gregorian>',
62			$julian => '<Julian>',
63			) );
64
65			$timestampFormatterOptions = new FormatterOptions();
66			$timestampFormatterOptions->setOption(
67			TimeFormatter::OPT_TIME_ISO_FORMATTER,
68			$this->getTimestampFormatter()
69			);
70
71			$tests = array(
72			'2013-07-16' => array(
73			'+2013-07-16T00:00:00Z',
74			),
75
76			// Custom timestamp formatter
77			'<timestamp>' => array(
78			'+2013-07-16T00:00:00Z',
79			TimeValue::PRECISION_DAY,
80			$gregorian,
81			$timestampFormatterOptions,
82			),
83
84			// Different calendar models
85			'1701-12-14' => array(
86			'+1701-12-14T00:00:00Z',
87			TimeValue::PRECISION_DAY,
88			$julian,
89			),
90			'1702-12-14' => array(
91			'+1702-12-14T00:00:00Z',
92			TimeValue::PRECISION_DAY,
93			'Stardate',
94			),
95
96			// Different years
97			"\xE2\x88\x9210000-01-01" => array(
98			'-010000-01-01T00:00:00Z',
99			),
100			"\xE2\x88\x920001-01-01" => array(
101			'-1-01-01T00:00:00Z',
102			),
103			"\xE2\x88\x920100-01-01" => array(
104			'-100-01-01T00:00:00Z',
105			),
106			"\xE2\x88\x920000-01-01" => array(
107			'-0-01-01T00:00:00Z',
108			),
109			'0000-01-01' => array(
110			'+0-01-01T00:00:00Z',
111			),
112			'0001-01-01' => array(
113			'+1-01-01T00:00:00Z',
114			),
115			'0100-01-01' => array(
116			'+100-01-01T00:00:00Z',
117			),
118			'10000-01-01' => array(
119			'+010000-01-01T00:00:00Z',
120			),
121
122			// Different precisions
123			'2000' => array(
124			'+2000-01-01T00:00:00Z',
125			TimeValue::PRECISION_YEAR1G,
126			),
127			'2008' => array(
128			'+2008-01-08T00:00:00Z',
129			TimeValue::PRECISION_YEAR10,
130			),
131			'2009' => array(
132			'+2009-01-09T00:00:00Z',
133			TimeValue::PRECISION_YEAR,
134			),
135			'2010-07' => array(
136			'+2010-07-10T00:00:00Z',
137			TimeValue::PRECISION_MONTH,
138			),
139			'2011-07-11' => array(
140			'+2011-07-11T00:00:00Z',
141			TimeValue::PRECISION_DAY,
142			),
143			'2012-07-12T00' => array(
144			'+2012-07-12T00:00:00Z',
145			TimeValue::PRECISION_HOUR,
146			),
147			'2013-07-13T00:00' => array(
148			'+2013-07-13T00:00:00Z',
149			TimeValue::PRECISION_MINUTE,
150			),
151			'2014-07-14T00:00:00' => array(
152			'+2014-07-14T00:00:00Z',
153			TimeValue::PRECISION_SECOND,
154			),
155			);
156
157			$argLists = array();
158
159			foreach ( $tests as $expected => $args ) {
160			$timestamp = $args[0];
161			$precision = isset( $args[1] ) ? $args[1] : TimeValue::PRECISION_DAY;
162			$calendarModel = isset( $args[2] ) ? $args[2] : $gregorian;
163			$options = isset( $args[3] ) ? $args[3] : $baseOptions;
164
165			$argLists[] = array(
166			new TimeValue( $timestamp, 0, 0, 0, $precision, $calendarModel ),
			0 ignored issues – show Bug introduced 2016-10-27 12:38 UTC by Report Bug Copy Issue Report It seems like `$timestamp` defined by `$args[0]` on line `160` can also be of type `object<ValueFormatters\FormatterOptions>`; however, `DataValues\TimeValue::__construct()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string / function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history... Bug introduced 2016-10-27 12:38 UTC by Report Bug Copy Issue Report It seems like `$calendarModel` defined by `isset($args[2]) ? $args[2] : $gregorian` on line `162` can also be of type `object<ValueFormatters\FormatterOptions>`; however, `DataValues\TimeValue::__construct()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /* * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
167			(string)$expected,
168			$options
169			);
170			}
171
172			return $argLists;
173			}
174
175			}
176

DataValues / Time

Pull Request — master (#49)

TimeFormatterTest::getTimestampFormatter() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like