Merge pull request #92 from alexislefebvre/update-phpqa-image

Update phpqa image
alexislefebvre · Jul 11, 2020 · 1929d32 · 1929d32
2 parents a589f86 + 21bed13
commit 1929d32
Show file tree

Hide file tree

Showing 20 changed files with 257 additions and 454 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -35,7 +35,7 @@ jobs:
       before_install:
         - make pull-docker-image
       script:
-        - make php-cs-fixer
+        - make php-cs-fixer-dry-run
     - name: "phpstan"
       before_install:
         - make pull-docker-image

diff --git a/Makefile b/Makefile
@@ -1,6 +1,6 @@
 PHP = php
 
-DOCKER_RUN = docker run --volume $(PWD):/app --workdir /app jakzal/phpqa:1.25-php7.2-alpine
+DOCKER_RUN = docker run --rm --interactive --tty --volume $(PWD):/app --workdir /app jakzal/phpqa:php7.3-alpine
 
 ##
 ## Dependencies
@@ -38,10 +38,13 @@ tests: phpspec phpunit behat ## Run all tests
 ##
 
 php-cs-fixer: ## PHP-CS-Fixer
+	$(DOCKER_RUN) php-cs-fixer fix src/
+
+php-cs-fixer-dry-run: ## PHP-CS-Fixer
 	$(DOCKER_RUN) php-cs-fixer fix src/ --dry-run
 
 phpstan: ## PHPStan
-	$(DOCKER_RUN) phpstan analyse --level 6 src/ --no-progress
+	$(DOCKER_RUN) phpstan analyse --no-progress
 
 qa: php-cs-fixer phpstan ## Run all QA tasks
 

diff --git a/composer.json b/composer.json
@@ -38,7 +38,8 @@
         "phpspec/phpspec": "~4.2||~5.0||^6.2",
         "doctrine/data-fixtures": "^1.3",
         "nelmio/alice": "^3.4",
-        "behatch/contexts": "^3.1"
+        "behatch/contexts": "^3.1",
+        "phpstan/phpstan-doctrine": "^0.12.17"
     },
     "autoload" : {
         "psr-4" : {

diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,11 @@
+parameters:
+  level: 8
+  paths:
+    - src
+#    - tests
+  excludes_analyse:
+    - tests/App/var/
+#    - tests/spec/
+
+includes:
+  - vendor/phpstan/phpstan-doctrine/extension.neon
diff --git a/src/Command/BaseCommand.php b/src/Command/BaseCommand.php
@@ -2,17 +2,21 @@
 
 namespace AlexisLefebvre\Bundle\AsyncTweetsBundle\Command;
 
+use Doctrine\Persistence\ObjectManager;
 use Symfony\Bridge\Doctrine\ManagerRegistry;
 use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 class BaseCommand extends ContainerAwareCommand
 {
+    /** @var ContainerInterface */
     protected $container;
+    /** @var ObjectManager */
     protected $em;
 
-    protected function configure()
+    protected function configure(): void
     {
         parent::configure();
 
@@ -21,7 +25,7 @@ protected function configure()
             ->setDescription('Base command');
     }
 
-    protected function initialize(InputInterface $input, OutputInterface $output)
+    protected function initialize(InputInterface $input, OutputInterface $output): void
     {
         parent::initialize($input, $output); //initialize parent class method
 

diff --git a/src/Command/StatusesHomeTimelineCommand.php b/src/Command/StatusesHomeTimelineCommand.php
@@ -3,6 +3,8 @@
 namespace AlexisLefebvre\Bundle\AsyncTweetsBundle\Command;
 
 use Abraham\TwitterOAuth\TwitterOAuth;
+use AlexisLefebvre\Bundle\AsyncTweetsBundle\Entity\Tweet;
+use AlexisLefebvre\Bundle\AsyncTweetsBundle\Entity\TweetRepository;
 use AlexisLefebvre\Bundle\AsyncTweetsBundle\Utils\PersistTweet;
 use Symfony\Component\Console\Helper\ProgressBar;
 use Symfony\Component\Console\Helper\Table;
@@ -12,17 +14,24 @@
 
 class StatusesHomeTimelineCommand extends BaseCommand
 {
+    /** @var bool */
     private $displayTable;
+    /** @var Table */
     private $table;
+    /** @var ProgressBar */
     private $progress;
 
-    /** @see https://dev.twitter.com/rest/reference/get/statuses/home_timeline */
+    /**
+     * @var array<bool|int>
+     *
+     * @see https://dev.twitter.com/rest/reference/get/statuses/home_timeline
+     */
     private $parameters = [
         'count'           => 200,
         'exclude_replies' => true,
     ];
 
-    protected function configure()
+    protected function configure(): void
     {
         parent::configure();
 
@@ -38,13 +47,7 @@ protected function configure()
             );
     }
 
-    /**
-     * @param InputInterface  $input
-     * @param OutputInterface $output
-     *
-     * @return int|void
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $this->setAndDisplayLastTweet($output);
 
@@ -65,17 +68,18 @@ protected function execute(InputInterface $input, OutputInterface $output)
         }
 
         $this->addAndDisplayTweets($input, $output, $content, $numberOfTweets);
+
+        return 0;
     }
 
-    /**
-     * @param OutputInterface $output
-     */
-    protected function setAndDisplayLastTweet(OutputInterface $output)
+    protected function setAndDisplayLastTweet(OutputInterface $output): void
     {
+        /** @var TweetRepository $tweetRepository */
+        $tweetRepository = $this->em
+            ->getRepository(Tweet::class);
+
         // Get the last tweet
-        $lastTweet = $this->em
-            ->getRepository('AsyncTweetsBundle:Tweet')
-            ->getLastTweet();
+        $lastTweet = $tweetRepository->getLastTweet();
 
         // And use it in the request if it exists
         if ($lastTweet) {
@@ -90,7 +94,7 @@ protected function setAndDisplayLastTweet(OutputInterface $output)
     }
 
     /**
-     * @param InputInterface $input
+     * @return array<\stdClass>|object
      */
     protected function getContent(InputInterface $input)
     {
@@ -108,13 +112,12 @@ protected function getContent(InputInterface $input)
     }
 
     /**
-     * @param OutputInterface $output
-     * @param null|object     $content
+     * @param array<string>|object $content
      */
     protected function displayContentNotArrayError(
         OutputInterface $output,
         $content
-    ) {
+    ): void {
         $formatter = $this->getHelper('formatter');
 
         $errorMessages = ['Error!', 'Something went wrong, $content is not an array.'];
@@ -124,17 +127,14 @@ protected function displayContentNotArrayError(
     }
 
     /**
-     * @param InputInterface  $input
-     * @param OutputInterface $output
-     * @param array           $content
-     * @param int             $numberOfTweets
+     * @param array<\stdClass> $content
      */
     protected function addAndDisplayTweets(
         InputInterface $input,
         OutputInterface $output,
-        $content,
-        $numberOfTweets
-    ) {
+        array $content,
+        int $numberOfTweets
+    ): void {
         $output->writeln('<comment>Number of tweets: '.$numberOfTweets.'</comment>');
 
         // Iterate through $content in order to add the oldest tweet first,
@@ -154,28 +154,20 @@ protected function addAndDisplayTweets(
         }
     }
 
-    /**
-     * @param OutputInterface $output
-     * @param int             $numberOfTweets
-     */
     protected function setProgressBar(
         OutputInterface $output,
-        $numberOfTweets
-    ) {
+        int $numberOfTweets
+    ): void {
         $this->progress = new ProgressBar($output, $numberOfTweets);
         $this->progress->setBarCharacter('<comment>=</comment>');
         $this->progress->start();
     }
 
-    /**
-     * @param InputInterface  $input
-     * @param OutputInterface $output
-     */
     protected function setTable(
         InputInterface $input,
         OutputInterface $output
-    ) {
-        $this->displayTable = $input->getOption('table');
+    ): void {
+        $this->displayTable = (bool) $input->getOption('table');
 
         // Display
         if ($this->displayTable) {
@@ -186,9 +178,9 @@ protected function setTable(
     }
 
     /**
-     * @param array $tweets
+     * @param array<\stdClass> $tweets
      */
-    protected function iterateTweets($tweets)
+    protected function iterateTweets(array $tweets): void
     {
         $persistTweet = new PersistTweet(
             $this->em,

diff --git a/src/Command/StatusesReadCommand.php b/src/Command/StatusesReadCommand.php
@@ -2,16 +2,19 @@
 
 namespace AlexisLefebvre\Bundle\AsyncTweetsBundle\Command;
 
+use AlexisLefebvre\Bundle\AsyncTweetsBundle\Entity\Tweet;
+use AlexisLefebvre\Bundle\AsyncTweetsBundle\Entity\TweetRepository;
 use Symfony\Component\Console\Helper\Table;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
 class StatusesReadCommand extends BaseCommand
 {
+    /** @var Table */
     private $table;
 
-    protected function configure()
+    protected function configure(): void
     {
         parent::configure();
 
@@ -21,15 +24,9 @@ protected function configure()
             ->addArgument('page', InputArgument::OPTIONAL, 'Page');
     }
 
-    /**
-     * @param InputInterface  $input
-     * @param OutputInterface $output
-     *
-     * @return int|void
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        /** @var int|null $page */
+        /** @var int $page */
         $page = $input->getArgument('page');
 
         if ($page < 1) {
@@ -41,10 +38,11 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $page
         ));
 
+        /** @var TweetRepository $tweetRepository */
+        $tweetRepository = $this->em
+            ->getRepository(Tweet::class);
         // Get the tweets
-        $tweets = $this->em
-            ->getRepository('AsyncTweetsBundle:Tweet')
-            ->getWithUsers($page);
+        $tweets = $tweetRepository->getWithUsers($page);
 
         if (!$tweets) {
             $output->writeln('<info>No tweet to display.</info>');
@@ -53,16 +51,17 @@ protected function execute(InputInterface $input, OutputInterface $output)
         }
 
         $this->displayTweets($output, $tweets);
+
+        return 0;
     }
 
     /**
-     * @param OutputInterface $output
-     * @param array           $tweets
+     * @param array<Tweet> $tweets
      */
     protected function displayTweets(
         OutputInterface $output,
-        $tweets
-    ) {
+        array $tweets
+    ): void {
         $this->setTable($output);
 
         foreach ($tweets as $tweet) {
@@ -90,7 +89,7 @@ protected function displayTweets(
         $this->table->render();
     }
 
-    protected function setTable(OutputInterface $output)
+    protected function setTable(OutputInterface $output): void
     {
         $this->table = new Table($output);
         $this->table
@@ -103,14 +102,7 @@ protected function setTable(OutputInterface $output)
             ]);
     }
 
-    /**
-     * @param string $tag
-     * @param string $content
-     * @param int    $length
-     *
-     * @return string
-     */
-    protected function formatCell($tag, $content, $length)
+    protected function formatCell(string $tag, string $content, int $length): string
     {
         return '<'.$tag.'>'.
             // Close and reopen the tag before each new line

diff --git a/src/Command/StatusesShowCommand.php b/src/Command/StatusesShowCommand.php
@@ -9,7 +9,7 @@
 
 class StatusesShowCommand extends BaseCommand
 {
-    protected function configure()
+    protected function configure(): void
     {
         parent::configure();
 
@@ -19,11 +19,7 @@ protected function configure()
             ->addArgument('tweet_id', InputArgument::REQUIRED, 'Tweet ID');
     }
 
-    /**
-     * @param InputInterface  $input
-     * @param OutputInterface $output
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         /** @var int|null $tweet_id */
         $tweet_id = $input->getArgument('tweet_id');
@@ -42,5 +38,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         )));
 
         $output->writeln($json);
+
+        return 0;
     }
 }