Merge pull request #30 from DataValues/StringParser

Introduce StringParser and StringNormalizer

Author: JeroenDeDauw

README.md

@@ -52,6 +52,9 @@ DataValues Common has been written by the Wikidata team, as [Wikimedia Germany]
 ### 0.3.0 (2015-08-11)
 
 * Added `DispatchingValueParser`
+* Added `StringNormalizer` interface
+* Added `NullStringNormalizer`
+* Added `StringParser`
 * Dropped deprecated constant `DataValuesCommon_VERSION`, use `DATAVALUES_COMMON_VERSION` instead
 * Dropped `ValueParserTestBase::getParserClass`
 * Dropped `ValueParserTestBase::newParserOptions`

src/ValueParsers/Normalizers/NullStringNormalizer.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace ValueParsers\Normalizers;
+
+use InvalidArgumentException;
+
+/**
+ * Null implementation of StringNormalizer.
+ *
+ * @since 0.3
+ *
+ * @license GPL 2+
+ * @author Daniel Kinzler
+ */
+class NullStringNormalizer implements StringNormalizer {
+
+	/**
+	 * @param string $value
+	 *
+	 * @throws InvalidArgumentException if $value is not a string
+	 * @return string the normalized value
+	 */
+	public function normalize( $value ) {
+		if ( !is_string( $value ) ) {
+			throw new InvalidArgumentException( 'Parameter $value must be a string' );
+		}
+
+		return $value;
+	}
+
+}

src/ValueParsers/Normalizers/StringNormalizer.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace ValueParsers\Normalizers;
+
+use InvalidArgumentException;
+
+/**
+ * Interface for string normalization.
+ *
+ * @since 0.3
+ *
+ * @license GPL 2+
+ * @author Daniel Kinzler
+ */
+interface StringNormalizer {
+
+	/**
+	 * @param string $value
+	 *
+	 * @throws InvalidArgumentException if $value is not a string
+	 * @return string the normalized value
+	 */
+	public function normalize( $value );
+
+}

src/ValueParsers/StringParser.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace ValueParsers;
+
+use DataValues\StringValue;
+use InvalidArgumentException;
+use ValueParsers\Normalizers\NullStringNormalizer;
+use ValueParsers\Normalizers\StringNormalizer;
+
+/**
+ * Implementation of the ValueParser interface for StringValues.
+ *
+ * @since 0.3
+ *
+ * @licence GNU GPL v2+
+ * @author Daniel Kinzler
+ */
+class StringParser implements ValueParser {
+
+	/**
+	 * @var StringNormalizer
+	 */
+	private $normalizer;
+
+	/**
+	 * @param StringNormalizer $normalizer
+	 */
+	public function __construct( StringNormalizer $normalizer = null ) {
+		$this->normalizer = $normalizer ?: new NullStringNormalizer();
+	}
+
+	/**
+	 * @see ValueParser::parse
+	 *
+	 * @param string $value
+	 *
+	 * @throws InvalidArgumentException if $value is not a string
+	 * @return StringValue
+	 */
+	public function parse( $value ) {
+		if ( !is_string( $value ) ) {
+			throw new InvalidArgumentException( 'Parameter $value must be a string' );
+		}
+
+		$value = $this->normalizer->normalize( $value );
+		return new StringValue( $value );
+	}
+
+}

tests/ValueParsers/Normalizers/NullStringNormalizerTest.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace ValueParsers\Normalizers\Test;
+
+use DataValues\DataValue;
+use DataValues\StringValue;
+use PHPUnit_Framework_TestCase;
+use ValueParsers\Normalizers\NullStringNormalizer;
+
+/**
+ * @covers ValueParsers\Normalizers\NullStringNormalizer
+ *
+ * @group ValueParsers
+ * @group DataValueExtensions
+ *
+ * @licence GNU GPL v2+
+ * @author Thiemo Mättig
+ */
+class NullStringNormalizerTest extends PHPUnit_Framework_TestCase {
+
+	/**
+	 * @dataProvider stringProvider
+	 */
+	public function testNormalize( $value ) {
+		$normalizer = new NullStringNormalizer();
+		$this->assertSame( $value, $normalizer->normalize( $value ) );
+	}
+
+	public function stringProvider() {
+		return array(
+			array( '' ),
+			array( 'a' ),
+			array( ' a ' ),
+		);
+	}
+
+	/**
+	 * @dataProvider invalidValueProvider
+	 */
+	public function testNormalizeException( $value ) {
+		$normalizer = new NullStringNormalizer();
+		$this->setExpectedException( 'InvalidArgumentException' );
+		$normalizer->normalize( $value );
+	}
+
+	public function invalidValueProvider() {
+		return array(
+			array( null ),
+			array( true ),
+			array( 1 ),
+			array( new StringValue( '' ) ),
+		);
+	}
+
+}

tests/ValueParsers/StringParserTest.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace ValueParsers\Test;
+
+use DataValues\DataValue;
+use DataValues\StringValue;
+use ValueParsers\Normalizers\StringNormalizer;
+use ValueParsers\StringParser;
+
+/**
+ * @covers ValueParsers\StringParser
+ *
+ * @group ValueParsers
+ * @group DataValueExtensions
+ *
+ * @licence GNU GPL v2+
+ * @author Daniel Kinzler
+ */
+class StringParserTest extends \PHPUnit_Framework_TestCase {
+
+	public function provideParse() {
+		$normalizer = $this->getMock( 'ValueParsers\Normalizers\StringNormalizer' );
+		$normalizer->expects( $this->once() )
+			->method( 'normalize' )
+			->will( $this->returnCallback( function( $value ) {
+				return strtolower( trim( $value ) );
+			} ) );
+
+		return array(
+			'simple' => array( 'hello world', null, new StringValue( 'hello world' ) ),
+			'normalize' => array( '  Hello World  ', $normalizer, new StringValue( 'hello world' ) ),
+		);
+	}
+
+	/**
+	 * @dataProvider provideParse
+	 */
+	public function testParse( $input, StringNormalizer $normalizer = null, DataValue $expected ) {
+		$parser = new StringParser( $normalizer );
+		$value = $parser->parse( $input );
+
+		$this->assertInstanceOf( 'DataValues\StringValue', $value );
+		$this->assertEquals( $expected->toArray(), $value->toArray() );
+	}
+
+	public function nonStringProvider() {
+		return array(
+			'null' => array( null ),
+			'array' => array( array() ),
+			'int' => array( 7 ),
+		);
+	}
+
+	/**
+	 * @dataProvider nonStringProvider
+	 */
+	public function testGivenNonString_parseThrowsException( $input ) {
+		$parser = new StringParser();
+		$this->setExpectedException( 'InvalidArgumentException' );
+		$parser->parse( $input );
+	}
+
+}