Merge pull request #34 from kabooodle/jaketoolson-patch

Added __toString() to all classes implementing Generator interface

Author: nubs

src/AbstractGenerator.php

@@ -0,0 +1,19 @@
+<?php
+namespace Nubs\RandomNameGenerator;
+
+abstract class AbstractGenerator implements Generator
+{
+    /**
+     * Alias for getName so that the generator can be directly stringified.
+     *
+     * Note that this will return a different name everytime it is cast to a
+     * string.
+     *
+     * @api
+     * @return string A random name.
+     */
+    public function __toString()
+    {
+        return $this->getName();
+    }
+}

src/All.php

@@ -6,7 +6,7 @@
 /**
  * A generator that uses all of the other generators randomly.
  */
-class All implements Generator
+class All extends AbstractGenerator implements Generator
 {
     /** @type array The other generators to use. */
     protected $_generators;

src/Alliteration.php

@@ -6,7 +6,7 @@
 /**
  * Defines an alliterative name generator.
  */
-class Alliteration implements Generator
+class Alliteration extends AbstractGenerator implements Generator
 {
     /** @type array The definition of the potential adjectives. */
     protected $_adjectives;

src/Vgng.php

@@ -8,7 +8,7 @@
  * https://github.com/nullpuppy/vgng which in turn is based off of
  * http://videogamena.me/vgng.js.
  */
-class Vgng implements Generator
+class Vgng extends AbstractGenerator implements Generator
 {
     /** @type array The definition of the potential names. */
     protected $_definitionSets;

tests/AllTest.php

@@ -49,4 +49,24 @@ public function getNameForced()
         $generator = new All([new Alliteration($randomizer)]);
         $this->assertSame('Black Bear', $generator->getName());
     }
+
+    /**
+     * Verify basic behavior of __toString().
+     *
+     * @test
+     * @covers ::__construct
+     * @covers ::create
+     * @covers ::__toString
+     * @covers ::getName
+     * @uses \Nubs\RandomNameGenerator\Alliteration
+     * @uses \Nubs\RandomNameGenerator\Vgng
+     *
+     * @return void
+     */
+    public function toStringBasic()
+    {
+        $generator = All::create();
+        $name = (string)$generator;
+        $this->assertRegexp('/.+/', $name);
+    }
 }

tests/AlliterationTest.php

@@ -45,4 +45,22 @@ public function getNameForced()
         $generator = new Alliteration($randomizer);
         $this->assertSame('Black Bear', $generator->getName());
     }
+
+    /**
+     * Verify basic behavior of __toString().
+     *
+     * @test
+     * @covers ::__construct
+     * @covers ::__toString
+     * @covers ::getName
+     *
+     * @return void
+     */
+    public function toStringBasic()
+    {
+        $generator = new Alliteration();
+        $parts = explode(' ', (string)$generator);
+        $this->assertSame(2, count($parts));
+        $this->assertSame($parts[0][0], $parts[1][0]);
+    }
 }

tests/VgngTest.php

@@ -45,4 +45,23 @@ public function getNameSimilarName()
 
         $this->assertSame('3D Aerobics Academy', $vgng->getName());
     }
+
+    /**
+     * Verify that toString returns the expected name.
+     *
+     * @test
+     * @covers ::__construct
+     * @covers ::__toString
+     * @covers ::getName
+     */
+    public function toStringBasic()
+    {
+        $numberGenerator = $this->createMock('\Cinam\Randomizer\NumberGenerator');
+        $numberGenerator->expects($this->exactly(3))->method('getInt')->will($this->returnValue(1));
+        $randomizer = new Randomizer($numberGenerator);
+
+        $vgng = new Vgng($randomizer);
+
+        $this->assertSame('8-Bit Acid - 3rd Strike', (string)$vgng);
+    }
 }