Minor changes

* Moved the helper methods at the end of the file and made them `private`
* Minor changes to match the code style of the other tests

Author: javiereguiluz

tests/AppBundle/Form/DataTransformer/TagArrayToStringTransformerTest.php

@@ -24,85 +24,50 @@
 class TagArrayToStringTransformerTest extends \PHPUnit\Framework\TestCase
 {
     /**
-     * Get a mocked instance of the TagArrayToStringTransformer.
-     *
-     * @return TagArrayToStringTransformer
-     */
-    public function getMockedTransformer($findByReturn = [])
-    {
-        $tagRepository = $this->getMockBuilder(EntityRepository::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-        $tagRepository->expects($this->any())
-            ->method('findBy')
-            ->will($this->returnValue($findByReturn));
-
-        $entityManager = $this
-            ->getMockBuilder(ObjectManager::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-        $entityManager->expects($this->any())
-            ->method('getRepository')
-            ->will($this->returnValue($tagRepository));
-
-        return new TagArrayToStringTransformer($entityManager);
-    }
-
-    /**
-     * Creates a new TagEntity instance.
-     *
-     * @param $name
-     *
-     * @return Tag
-     */
-    public function createTag($name)
-    {
-        $tag = new Tag();
-        $tag->setName($name);
-
-        return $tag;
-    }
-
-    /**
-     * Ensures tags are created correctly.
+     * Ensures that tags are created correctly.
      */
     public function testCreateTheRightAmountOfTags()
     {
         $tags = $this->getMockedTransformer()->reverseTransform('Hello, Demo, How');
+
         $this->assertCount(3, $tags);
         $this->assertSame('Hello', $tags[0]->getName());
     }
 
     /**
-     * Too many commas.
+     * Ensures that empty tags and errors in the number of commas are
+     * dealed correctly.
      */
     public function testCreateTheRightAmountOfTagsWithTooManyCommas()
     {
         $transformer = $this->getMockedTransformer();
+
         $this->assertCount(3, $transformer->reverseTransform('Hello, Demo,, How'));
         $this->assertCount(3, $transformer->reverseTransform('Hello, Demo, How,'));
     }
 
     /**
-     * Spaces at the end (and beginning) of a world shouldn't matter.
+     * Ensures that leading/trailing spaces are ignored for tag names.
      */
     public function testTrimNames()
     {
         $tags = $this->getMockedTransformer()->reverseTransform('   Hello   ');
+
         $this->assertSame('Hello', $tags[0]->getName());
     }
 
     /**
-     * Duplicate tags shouldn't create new entities.
+     * Ensures that duplicated tag names are ignored.
      */
     public function testDuplicateNames()
     {
         $tags = $this->getMockedTransformer()->reverseTransform('Hello, Hello, Hello');
+
         $this->assertCount(1, $tags);
     }
 
     /**
-     * This test ensure that the transformer uses tag already persisted in the Database.
+     * Ensures that the transformer uses tags already persisted in the database.
      */
     public function testUsesAlreadyDefinedTags()
     {
@@ -111,13 +76,15 @@ public function testUsesAlreadyDefinedTags()
             $this->createTag('World'),
         ];
         $tags = $this->getMockedTransformer($persistedTags)->reverseTransform('Hello, World, How, Are, You');
+
         $this->assertCount(5, $tags);
         $this->assertSame($persistedTags[0], $tags[0]);
         $this->assertSame($persistedTags[1], $tags[1]);
     }
 
     /**
-     * Tags should be transformed into a string.
+     * Ensures that the transformation from Tag instances to a simple string
+     * works as expected.
      */
     public function testTransform()
     {
@@ -126,6 +93,50 @@ public function testTransform()
             $this->createTag('World'),
         ];
         $transformed = $this->getMockedTransformer()->transform($persistedTags);
+
         $this->assertSame('Hello,World', $transformed);
     }
+
+    /**
+     * This helper method mocks the real TagArrayToStringTransformer class to
+     * simplify the tests. See https://phpunit.de/manual/current/en/test-doubles.html
+     *
+     * @param  array $findByReturnValues The values returned when calling to the findBy() method
+     * 
+     * @return TagArrayToStringTransformer
+     */
+    private function getMockedTransformer($findByReturnValues = [])
+    {
+        $tagRepository = $this->getMockBuilder(EntityRepository::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $tagRepository->expects($this->any())
+            ->method('findBy')
+            ->will($this->returnValue($findByReturnValues));
+
+        $entityManager = $this
+            ->getMockBuilder(ObjectManager::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $entityManager->expects($this->any())
+            ->method('getRepository')
+            ->will($this->returnValue($tagRepository));
+
+        return new TagArrayToStringTransformer($entityManager);
+    }
+
+    /**
+     * This helper method creates a Tag instance for the given tag name.
+     *
+     * @param string $name
+     *
+     * @return Tag
+     */
+    private function createTag($name)
+    {
+        $tag = new Tag();
+        $tag->setName($name);
+
+        return $tag;
+    }
 }