Merge pull request #2 from jedkirby/feature/php-cs

PHP Code Styling
jedkirby · Jan 7, 2017 · 657c16c · 657c16c
2 parents dbec93c + 8ab2ed0
commit 657c16c
Show file tree

Hide file tree

Showing 13 changed files with 35 additions and 47 deletions.
diff --git a/.php_cs b/.php_cs
@@ -0,0 +1,15 @@
+<?php
+
+require_once __DIR__ . '/vendor/jedkirby/php-cs/src/Config.php';
+
+use PhpCsFixer\Finder;
+use Jedkirby\PhpCs\Config;
+
+$finder = Finder::create();
+$finder->in(__DIR__ . '/src');
+$finder->in(__DIR__ . '/tests');
+
+$config = new Config();
+$config->setFinder($finder);
+
+return $config;
diff --git a/composer.json b/composer.json
@@ -22,7 +22,8 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^5.7",
-        "satooshi/php-coveralls": "^1.0"
+        "satooshi/php-coveralls": "^1.0",
+        "jedkirby/php-cs": "^1.0"
     },
     "autoload": {
         "psr-4": {

diff --git a/src/Entity/AbstractEntity.php b/src/Entity/AbstractEntity.php
@@ -6,7 +6,6 @@
 
 abstract class AbstractEntity implements EntityInterface
 {
-
     /**
      * @var array
      */
@@ -23,11 +22,9 @@ public function __construct(array $data = [])
 
     /**
      * @throws RequiredPropertyException
-     * @return void
      */
     private function validate()
     {
-
         $requiredProperties = $this->getRequiredProperties();
         $missingProperties = array_diff(
             $requiredProperties,
@@ -41,7 +38,5 @@ private function validate()
                 get_called_class()
             ));
         }
-
     }
-
 }
diff --git a/src/Entity/EntityInterface.php b/src/Entity/EntityInterface.php
@@ -4,7 +4,6 @@
 
 interface EntityInterface
 {
-
     /**
      * Return properties to validate on loading of the entity.
      *
@@ -25,5 +24,4 @@ public function getSearchText();
      * @return string
      */
     public function getHtml();
-
 }
diff --git a/src/Entity/Exception/RequiredPropertyException.php b/src/Entity/Exception/RequiredPropertyException.php
@@ -6,5 +6,4 @@
 
 class RequiredPropertyException extends Exception
 {
-
 }
diff --git a/src/Entity/Hashtag.php b/src/Entity/Hashtag.php
@@ -4,25 +4,24 @@
 
 class Hashtag extends AbstractEntity
 {
-
     /**
-     * {@inhertDoc}
+     * {@inhertDoc}.
      */
     public function getRequiredProperties()
     {
         return ['text'];
     }
 
     /**
-     * {@inhertDoc}
+     * {@inhertDoc}.
      */
     public function getSearchText()
     {
         return $this->data['text'];
     }
 
     /**
-     * {@inhertDoc}
+     * {@inhertDoc}.
      */
     public function getHtml()
     {
@@ -32,5 +31,4 @@ public function getHtml()
             $this->data['text']
         );
     }
-
 }
diff --git a/src/Entity/Url.php b/src/Entity/Url.php
@@ -4,25 +4,24 @@
 
 class Url extends AbstractEntity
 {
-
     /**
-     * {@inhertDoc}
+     * {@inhertDoc}.
      */
     public function getRequiredProperties()
     {
         return ['url', 'display_url'];
     }
 
     /**
-     * {@inhertDoc}
+     * {@inhertDoc}.
      */
     public function getSearchText()
     {
         return $this->data['url'];
     }
 
     /**
-     * {@inhertDoc}
+     * {@inhertDoc}.
      */
     public function getHtml()
     {
@@ -32,5 +31,4 @@ public function getHtml()
             $this->data['display_url']
         );
     }
-
 }
diff --git a/src/Entity/UserMention.php b/src/Entity/UserMention.php
@@ -4,25 +4,24 @@
 
 class UserMention extends AbstractEntity
 {
-
     /**
-     * {@inhertDoc}
+     * {@inhertDoc}.
      */
     public function getRequiredProperties()
     {
         return ['screen_name'];
     }
 
     /**
-     * {@inhertDoc}
+     * {@inhertDoc}.
      */
     public function getSearchText()
     {
         return $this->data['screen_name'];
     }
 
     /**
-     * {@inhertDoc}
+     * {@inhertDoc}.
      */
     public function getHtml()
     {
@@ -32,5 +31,4 @@ public function getHtml()
             $this->data['screen_name']
         );
     }
-
 }
diff --git a/src/Tweet.php b/src/Tweet.php
@@ -4,7 +4,6 @@
 
 class Tweet
 {
-
     /**
      * @var string
      */
@@ -30,7 +29,7 @@ class Tweet
      * @param array $urls
      * @param array $mentions
      * @param array $hashtags
-     * 
+     *
      * @return Tweet
      */
     public static function make($text, array $urls = [], array $mentions = [], array $hashtags = [])
@@ -59,7 +58,6 @@ private function __construct($text, array $urls = [], array $mentions = [], arra
      */
     public function linkify()
     {
-
         $entities = [];
 
         foreach ($this->hashtags as $hashtag) {
@@ -84,7 +82,5 @@ public function linkify()
         }
 
         return $text;
-
     }
-
 }
diff --git a/tests/Entity/EntityTest.php b/tests/Entity/EntityTest.php
@@ -8,10 +8,9 @@
 
 class EntityTest extends TestCase
 {
-
     /**
      * @test
-     * @expectedException Jedkirby\TweetEntityLinker\Entity\Exception\RequiredPropertyException
+     * @expectedException \Jedkirby\TweetEntityLinker\Entity\Exception\RequiredPropertyException
      */
     public function itMustHaveRequiredProperties()
     {
@@ -25,5 +24,4 @@ public function itDoesNotNeedToHaveRequiredProperties()
     {
         $entity = new NoRequiredProperties();
     }
-
-}
+}
diff --git a/tests/Entity/Fixtures/InvalidProperties.php b/tests/Entity/Fixtures/InvalidProperties.php
@@ -6,29 +6,27 @@
 
 class InvalidProperties extends AbstractEntity
 {
-
     /**
-     * {@inhertDoc}
+     * {@inhertDoc}.
      */
     public function getRequiredProperties()
     {
         return ['missing', 'required'];
     }
 
     /**
-     * {@inhertDoc}
+     * {@inhertDoc}.
      */
     public function getSearchText()
     {
         return '';
     }
 
     /**
-     * {@inhertDoc}
+     * {@inhertDoc}.
      */
     public function getHtml()
     {
         return '';
     }
-
 }
diff --git a/tests/Entity/Fixtures/NoRequiredProperties.php b/tests/Entity/Fixtures/NoRequiredProperties.php
@@ -6,29 +6,27 @@
 
 class NoRequiredProperties extends AbstractEntity
 {
-
     /**
-     * {@inhertDoc}
+     * {@inhertDoc}.
      */
     public function getRequiredProperties()
     {
         return [];
     }
 
     /**
-     * {@inhertDoc}
+     * {@inhertDoc}.
      */
     public function getSearchText()
     {
         return '';
     }
 
     /**
-     * {@inhertDoc}
+     * {@inhertDoc}.
      */
     public function getHtml()
     {
         return '';
     }
-
 }
diff --git a/tests/TweetTest.php b/tests/TweetTest.php
@@ -7,7 +7,6 @@
 
 class TweetTest extends TestCase
 {
-
     /**
      * @param string $endpoint
      *
@@ -35,7 +34,6 @@ protected function getSampleApiResponse($endpoint)
      */
     protected function getSampleTweet($endpoint)
     {
-
         $response = $this->getSampleApiResponse($endpoint);
 
         return Tweet::make(
@@ -44,7 +42,6 @@ protected function getSampleTweet($endpoint)
             $response['entities']['user_mentions'],
             $response['entities']['hashtags']
         );
-
     }
 
     /**
@@ -90,5 +87,4 @@ public function itParsesAllEntitiesCorrectly()
             'This tweet has it all, it has got the links <a href="https://t.co/qeSnkprYiP" target="_blank">jedkirby.com</a> and <a href="https://t.co/Ed4omjYs" target="_blank">google.co.uk</a>, it has the hashtags #<a href="https://twitter.com/hashtag/Hashtag" target="_blank">Hashtag</a> and #<a href="https://twitter.com/hashtag/Another" target="_blank">Another</a>, and finally the user mentions for @<a href="https://twitter.com/jedkirby" target="_blank">jedkirby</a> and @<a href="https://twitter.com/google" target="_blank">google</a>.'
         );
     }
-
 }