Formatting changes

* Remove docblocks that are no longer needed As we have types already added to the code then the docblocks don't add anything and actually make it harder to maintain * Add CS formatting rules Make sure all classes are consistent by having a new line after the opening tag. At the minute there's a mixture of the two. Removed unused imports * Add phpunit cache to gitignore
ackintosh · May 23, 2024 · d3ee826 · d3ee826
1 parent 911e2a8
commit d3ee826
Show file tree

Hide file tree

Showing 56 changed files with 100 additions and 523 deletions.
diff --git a/.gitignore b/.gitignore
@@ -14,3 +14,4 @@ GTAGS
 .idea
 /tmp
 .php-cs-fixer.cache
+.phpunit.result.cache
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -10,6 +10,8 @@
 return $config->setRiskyAllowed(true)
     ->setRules([
         '@PSR2' => true,
+        'blank_line_after_opening_tag' => true,
+        'no_unused_imports' => true,
     ])
     ->setFinder($finder)
 ;
diff --git a/examples/common.php b/examples/common.php
@@ -1,4 +1,5 @@
 <?php
+
 use \Ackintosh\Ganesha;
 use \Ackintosh\Ganesha\Builder;
 

diff --git a/examples/server/index.php b/examples/server/index.php
@@ -1,4 +1,5 @@
 <?php
+
 require_once dirname(__DIR__) . '/common.php';
 
 if (trim(file_get_contents(SERVER_STATE_DATA)) === SERVER_STATE_ABNORMAL) {

diff --git a/examples/server/redirect.php b/examples/server/redirect.php
@@ -1,4 +1,5 @@
 <?php
+
 const DEFAULT_REDIRECTS = 3;
 
 $current = $_GET['current'] ?? 0;

diff --git a/examples/server/timeout.php b/examples/server/timeout.php
@@ -1,2 +1,3 @@
 <?php
+
 sleep(10);
diff --git a/src/Ganesha.php b/src/Ganesha.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Ackintosh;
 
 use Ackintosh\Ganesha\Exception\StorageException;
@@ -48,23 +49,15 @@ class Ganesha
      */
     private static $disabled = false;
 
-    /**
-     * Ganesha constructor.
-     *
-     * @param StrategyInterface $strategy
-     */
-    public function __construct($strategy)
+    public function __construct(StrategyInterface $strategy)
     {
         $this->strategy = $strategy;
     }
 
     /**
-     * records failure
-     *
-     * @param string $service
-     * @return void
+     * Records failure
      */
-    public function failure($service): void
+    public function failure(string $service): void
     {
         try {
             if ($this->strategy->recordFailure($service) === self::STATUS_TRIPPED) {
@@ -76,12 +69,9 @@ public function failure($service): void
     }
 
     /**
-     * records success
-     *
-     * @param string $service
-     * @return void
+     * Records success
      */
-    public function success($service): void
+    public function success(string $service): void
     {
         try {
             if ($this->strategy->recordSuccess($service) === self::STATUS_CALMED_DOWN) {
@@ -92,11 +82,7 @@ public function success($service): void
         }
     }
 
-    /**
-     * @param string $service
-     * @return bool
-     */
-    public function isAvailable($service): bool
+    public function isAvailable(string $service): bool
     {
         if (self::$disabled) {
             return true;
@@ -112,21 +98,13 @@ public function isAvailable($service): bool
     }
 
     /**
-     * @param callable $callable
      * @psalm-param callable(self::EVENT_*, string, string): void $callable
-     * @return void
      */
     public function subscribe(callable $callable): void
     {
         $this->subscribers[] = $callable;
     }
 
-    /**
-     * @param string $event
-     * @param string $service
-     * @param string $message
-     * @return void
-     */
     private function notify(string $event, string $service, string $message): void
     {
         foreach ($this->subscribers as $s) {
@@ -135,29 +113,23 @@ private function notify(string $event, string $service, string $message): void
     }
 
     /**
-     * disable
-     *
-     * @return void
+     * Disable
      */
     public static function disable(): void
     {
         self::$disabled = true;
     }
 
     /**
-     * enable
-     *
-     * @return void
+     * Enable
      */
     public static function enable(): void
     {
         self::$disabled = false;
     }
 
     /**
-     * resets all counts
-     *
-     * @return void
+     * Resets all counts
      */
     public function reset(): void
     {

diff --git a/src/Ganesha/Builder.php b/src/Ganesha/Builder.php
@@ -1,7 +1,6 @@
 <?php
-namespace Ackintosh\Ganesha;
 
-use Ackintosh\Ganesha\Strategy;
+namespace Ackintosh\Ganesha;
 
 /**
  * A front end of the strategy specific builders
@@ -10,17 +9,11 @@
  */
 class Builder
 {
-    /**
-     * @return Strategy\Rate\Builder
-     */
     public static function withRateStrategy(): Strategy\Rate\Builder
     {
         return new Strategy\Rate\Builder();
     }
 
-    /**
-     * @return Strategy\Count\Builder
-     */
     public static function withCountStrategy(): Strategy\Count\Builder
     {
         return new Strategy\Count\Builder();

diff --git a/src/Ganesha/Configuration.php b/src/Ganesha/Configuration.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Ackintosh\Ganesha;
 
 use Ackintosh\Ganesha\Storage\AdapterInterface;
@@ -16,13 +17,9 @@ class Configuration
     const INTERVAL_TO_HALF_OPEN = 'intervalToHalfOpen';
     const STORAGE_KEYS = 'storageKeys';
 
-    /**
-     * @var array
-     */
-    private $params;
+    private array $params;
 
-    /** @param array $params */
-    public function __construct($params)
+    public function __construct(array $params)
     {
         if (!isset($params[self::STORAGE_KEYS])) {
             $params[self::STORAGE_KEYS] = new StorageKeys();
@@ -61,7 +58,6 @@ public function storageKeys(): StorageKeysInterface
     }
 
     /**
-     * @param array $params
      * @throws \InvalidArgumentException
      */
     public static function validate(array $params): void

diff --git a/src/Ganesha/Context.php b/src/Ganesha/Context.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Ackintosh\Ganesha;
 
 use Ackintosh\Ganesha\Storage\Adapter\SlidingTimeWindowInterface;
@@ -34,11 +35,6 @@ class Context
      */
     private $configuration;
 
-    /**
-     * @param string $strategyClass
-     * @param AdapterInterface $adapter
-     * @param Configuration $configuration
-     */
     public function __construct(string $strategyClass, AdapterInterface $adapter, Configuration $configuration)
     {
         $this->strategy = $this->determineStrategyContext($strategyClass, $adapter);

diff --git a/src/Ganesha/Exception/RejectedException.php b/src/Ganesha/Exception/RejectedException.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Ackintosh\Ganesha\Exception;
 
 class RejectedException extends \RuntimeException

diff --git a/src/Ganesha/Exception/StorageException.php b/src/Ganesha/Exception/StorageException.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Ackintosh\Ganesha\Exception;
 
 class StorageException extends \RuntimeException

diff --git a/src/Ganesha/GaneshaHttpClient.php b/src/Ganesha/GaneshaHttpClient.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Ackintosh\Ganesha;
 
 use Ackintosh\Ganesha;

diff --git a/src/Ganesha/GuzzleMiddleware.php b/src/Ganesha/GuzzleMiddleware.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Ackintosh\Ganesha;
 
 use Ackintosh\Ganesha;
@@ -60,10 +61,6 @@ public function __construct(
         }
     }
 
-    /**
-     * @param callable $handler
-     * @return \Closure
-     */
     public function __invoke(callable $handler): \Closure
     {
         return function (RequestInterface $request, array $options) use ($handler) {

diff --git a/src/Ganesha/GuzzleMiddleware/ServiceNameExtractor.php b/src/Ganesha/GuzzleMiddleware/ServiceNameExtractor.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Ackintosh\Ganesha\GuzzleMiddleware;
 
 use Psr\Http\Message\RequestInterface;
@@ -15,12 +16,7 @@ class ServiceNameExtractor implements ServiceNameExtractorInterface
      */
     const HEADER_NAME = 'X-Ganesha-Service-Name';
 
-    /**
-     * @param RequestInterface $request
-     * @param array $requestOptions
-     * @return string
-     */
-    public function extract(RequestInterface $request, array $requestOptions)
+    public function extract(RequestInterface $request, array $requestOptions): string
     {
         if (array_key_exists(self::OPTION_KEY, $requestOptions)) {
             return $requestOptions[self::OPTION_KEY];

diff --git a/src/Ganesha/GuzzleMiddleware/ServiceNameExtractorInterface.php b/src/Ganesha/GuzzleMiddleware/ServiceNameExtractorInterface.php
@@ -1,14 +1,10 @@
 <?php
+
 namespace Ackintosh\Ganesha\GuzzleMiddleware;
 
 use Psr\Http\Message\RequestInterface;
 
 interface ServiceNameExtractorInterface
 {
-    /**
-     * @param RequestInterface $request
-     * @param array $requestOptions
-     * @return string
-     */
-    public function extract(RequestInterface $request, array $requestOptions);
+    public function extract(RequestInterface $request, array $requestOptions): string;
 }
diff --git a/src/Ganesha/HttpClient/FailureDetectorInterface.php b/src/Ganesha/HttpClient/FailureDetectorInterface.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Ackintosh\Ganesha\HttpClient;
 
 use Symfony\Contracts\HttpClient\ResponseInterface;

diff --git a/src/Ganesha/HttpClient/HostTrait.php b/src/Ganesha/HttpClient/HostTrait.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Ackintosh\Ganesha\HttpClient;
 
 use Symfony\Component\HttpClient\Exception\InvalidArgumentException;

diff --git a/src/Ganesha/HttpClient/RestFailureDetector.php b/src/Ganesha/HttpClient/RestFailureDetector.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Ackintosh\Ganesha\HttpClient;
 
 use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface;

diff --git a/src/Ganesha/HttpClient/ServiceNameExtractor.php b/src/Ganesha/HttpClient/ServiceNameExtractor.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Ackintosh\Ganesha\HttpClient;
 
 final class ServiceNameExtractor implements ServiceNameExtractorInterface

diff --git a/src/Ganesha/HttpClient/ServiceNameExtractorInterface.php b/src/Ganesha/HttpClient/ServiceNameExtractorInterface.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Ackintosh\Ganesha\HttpClient;
 
 interface ServiceNameExtractorInterface

diff --git a/src/Ganesha/HttpClient/TransportFailureDetector.php b/src/Ganesha/HttpClient/TransportFailureDetector.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Ackintosh\Ganesha\HttpClient;
 
 use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface;