hendrikmaus/spas

View on GitHub

Showing 43 of 43 total issues

Method configure has 91 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function configure()
    {
        $this
            ->setName('run')
            ->setDescription('Run test suite')
Severity: Major
Found in src/Command/RunCommand.php - About 3 hrs to fix

    Function indent has a Cognitive Complexity of 25 (exceeds 5 allowed). Consider refactoring.
    Open

        private function indent($json) : string
        {
            $result = '';
            $pos = 0;
            $strLen = strlen($json);
    Severity: Minor
    Found in src/Formatter/JsonFormatter.php - About 3 hrs to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Function onBeforeEach has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
    Open

        protected function onBeforeEach(BeforeEach $event)
        {
            $request  = $event->getRequest();
            $config   = $request->getRepetitionConfig();
            $name     = strtolower($request->getName());
    Severity: Minor
    Found in src/Hook/Repeat.php - About 2 hrs to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Avoid excessively long variable names like $onlyRunHappyCaseTransactions. Keep variable name length under 20.
    Open

            $onlyRunHappyCaseTransactions = $this->input->getOption('all_transactions') == null;
    Severity: Minor
    Found in src/Request/RequestProcessor.php by phpmd

    LongVariable

    Since: 0.2

    Detects when a field, formal or local variable is declared with a long name.

    Example

    class Something {
        protected $reallyLongIntName = -3; // VIOLATION - Field
        public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
            $otherReallyLongName = -5; // VIOLATION - Local
            for ($interestingIntIndex = 0; // VIOLATION - For
                 $interestingIntIndex < 10;
                 $interestingIntIndex++ ) {
            }
        }
    }

    Source https://phpmd.org/rules/naming.html#longvariable

    Avoid excessively long variable names like $requestProviderClassName. Keep variable name length under 20.
    Open

            $requestProviderClassName = $this->getRequestProvider($input);
    Severity: Minor
    Found in src/Command/RunCommand.php by phpmd

    LongVariable

    Since: 0.2

    Detects when a field, formal or local variable is declared with a long name.

    Example

    class Something {
        protected $reallyLongIntName = -3; // VIOLATION - Field
        public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
            $otherReallyLongName = -5; // VIOLATION - Local
            for ($interestingIntIndex = 0; // VIOLATION - For
                 $interestingIntIndex < 10;
                 $interestingIntIndex++ ) {
            }
        }
    }

    Source https://phpmd.org/rules/naming.html#longvariable

    Method doRequest has 34 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private function doRequest(ParsedRequest $request, $attempt = 0)
        {
            $attempt++;
    
            $pollingThreshhold = $this->input->getOption('polling_count') - 1;
    Severity: Minor
    Found in src/Request/RequestProcessor.php - About 1 hr to fix

      Method indent has 33 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function indent($json) : string
          {
              $result = '';
              $pos = 0;
              $strLen = strlen($json);
      Severity: Minor
      Found in src/Formatter/JsonFormatter.php - About 1 hr to fix

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

        <?php
        
        namespace Hmaus\Spas\Formatter\CompilerPass;
        
        use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
        Severity: Major
        Found in src/Formatter/CompilerPass/FormatterPass.php and 1 other location - About 1 hr to fix
        src/Validation/CompilerPass/AddValidatorsPass.php on lines 1..29

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 106.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

        <?php
        
        namespace Hmaus\Spas\Validation\CompilerPass;
        
        use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
        Severity: Major
        Found in src/Validation/CompilerPass/AddValidatorsPass.php and 1 other location - About 1 hr to fix
        src/Formatter/CompilerPass/FormatterPass.php on lines 1..29

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 106.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Method process has 30 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function process(ParsedRequest $request)
            {
                if ($this->shouldExit($request)) {
                    return;
                }
        Severity: Minor
        Found in src/Request/RequestProcessor.php - About 1 hr to fix

          Method computeGuzzleOptions has 29 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public function computeGuzzleOptions(ParsedRequest $request): array
              {
                  $options                                  = [];
                  $options[RequestOptions::ALLOW_REDIRECTS] = false;
                  $options[RequestOptions::CONNECT_TIMEOUT] = 30;
          Severity: Minor
          Found in src/Request/HttpClient.php - About 1 hr to fix

            Method __construct has 9 arguments (exceeds 4 allowed). Consider refactoring.
            Open

                    InputInterface $input,
                    LoggerInterface $logger,
                    EventDispatcherInterface $dispatcher,
                    ValidatorService $validatorService,
                    HttpClient $http,
            Severity: Major
            Found in src/Request/RequestProcessor.php - About 1 hr to fix

              Method onBeforeEach has 27 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  protected function onBeforeEach(BeforeEach $event)
                  {
                      $request  = $event->getRequest();
                      $config   = $request->getRepetitionConfig();
                      $name     = strtolower($request->getName());
              Severity: Minor
              Found in src/Hook/Repeat.php - About 1 hr to fix

                Function onBeforeEach has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
                Open

                    private function onBeforeEach(BeforeEach $event)
                    {
                        $request = $event->getRequest();
                        $name    = $request->getName();
                
                
                Severity: Minor
                Found in src/Hook/EnableDisable.php - About 55 mins to fix

                Cognitive Complexity

                Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

                A method's cognitive complexity is based on a few simple rules:

                • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
                • Code is considered more complex for each "break in the linear flow of the code"
                • Code is considered more complex when "flow breaking structures are nested"

                Further reading

                Avoid variables with short names like $io. Configured minimum length is 3.
                Open

                        $io = new SymfonyStyle($input, $output);
                Severity: Minor
                Found in src/SpasApplication.php by phpmd

                ShortVariable

                Since: 0.2

                Detects when a field, local, or parameter has a very short name.

                Example

                class Something {
                    private $q = 15; // VIOLATION - Field
                    public static function main( array $as ) { // VIOLATION - Formal
                        $r = 20 + $this->q; // VIOLATION - Local
                        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                            $r += $this->q;
                        }
                    }
                }

                Source https://phpmd.org/rules/naming.html#shortvariable

                Function validate has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
                Open

                    public function validate(ParsedRequest $request, ParsedResponse $response)
                    {
                        $expected = $request->getExpectedResponse()->getHeaders();
                        $actual   = $response->getHeaders();
                
                
                Severity: Minor
                Found in src/Validation/Validator/Header.php - About 45 mins to fix

                Cognitive Complexity

                Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

                A method's cognitive complexity is based on a few simple rules:

                • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
                • Code is considered more complex for each "break in the linear flow of the code"
                • Code is considered more complex when "flow breaking structures are nested"

                Further reading

                Method __construct has 6 arguments (exceeds 4 allowed). Consider refactoring.
                Open

                        InputInterface $input,
                        EventDispatcherInterface $dispatcher,
                        LoggerInterface $logger,
                        Filesystem $filesystem,
                        ParameterBag $parameterBag,
                Severity: Minor
                Found in src/Request/HookHandler.php - About 45 mins to fix

                  The class RequestProcessor has a coupling between objects value of 20. Consider to reduce the number of dependencies under 13.
                  Open

                  class RequestProcessor
                  {
                      /**
                       * Amount of max seconds spas will wait until re-triggering a pollabe resource
                       * @type int
                  Severity: Minor
                  Found in src/Request/RequestProcessor.php by phpmd

                  CouplingBetweenObjects

                  Since: 1.1.0

                  A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

                  Example

                  class Foo {
                      /**
                       * @var \foo\bar\X
                       */
                      private $x = null;
                  
                      /**
                       * @var \foo\bar\Y
                       */
                      private $y = null;
                  
                      /**
                       * @var \foo\bar\Z
                       */
                      private $z = null;
                  
                      public function setFoo(\Foo $foo) {}
                      public function setBar(\Bar $bar) {}
                      public function setBaz(\Baz $baz) {}
                  
                      /**
                       * @return \SplObjectStorage
                       * @throws \OutOfRangeException
                       * @throws \InvalidArgumentException
                       * @throws \ErrorException
                       */
                      public function process(\Iterator $it) {}
                  
                      // ...
                  }

                  Source https://phpmd.org/rules/design.html#couplingbetweenobjects

                  Function includeHooks has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                  Open

                      public function includeHooks()
                      {
                          foreach ($this->getHookFiles() as $hookname) {
                              if (class_exists($hookname)) {
                                  /** @var Hook $hook */
                  Severity: Minor
                  Found in src/Request/HookHandler.php - About 35 mins to fix

                  Cognitive Complexity

                  Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

                  A method's cognitive complexity is based on a few simple rules:

                  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
                  • Code is considered more complex for each "break in the linear flow of the code"
                  • Code is considered more complex when "flow breaking structures are nested"

                  Further reading

                  The method contains has a boolean flag argument $forceLowercase, which is a certain sign of a Single Responsibility Principle violation.
                  Open

                      protected function contains(string $needle, string $haystack, bool $forceLowercase = true) : bool
                  Severity: Minor
                  Found in src/Hook/Hook.php by phpmd

                  BooleanArgumentFlag

                  Since: 1.4.0

                  A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

                  Example

                  class Foo {
                      public function bar($flag = true) {
                      }
                  }

                  Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

                  Severity
                  Category
                  Status
                  Source
                  Language