eugene-matvejev/battleship-game-api

View on GitHub
tests/phpunit/GameBundle/Controller/GameControllerTest.php

Summary

Maintainability
B
4 hrs
Test Coverage

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

    public function successfulInitAction_XML()
    {
        $client = static::$client;
        $client->request(
            Request::METHOD_POST,
Severity: Minor
Found in tests/phpunit/GameBundle/Controller/GameControllerTest.php - About 1 hr to fix

    Method successfulInitAction_JSON has 28 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function successfulInitAction_JSON()
        {
            $client = static::$client;
            $client->request(
                Request::METHOD_POST,
    Severity: Minor
    Found in tests/phpunit/GameBundle/Controller/GameControllerTest.php - About 1 hr to fix

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

          public function successfulTurnAction(array $response)
          {
              foreach ($response as $battlefield) {
                  if ($battlefield->player->flags !== PlayerModel::FLAG_AI_CONTROLLED) {
                      continue;
      Severity: Minor
      Found in tests/phpunit/GameBundle/Controller/GameControllerTest.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

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

          public function successfulInitAction_XML()
          {
              $client = static::$client;
              $client->request(
                  Request::METHOD_POST,
      Severity: Minor
      Found in tests/phpunit/GameBundle/Controller/GameControllerTest.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

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

          public function unsuccessfulTurnActionOnDeadCell(array $response)
          {
              foreach ($response as $battlefield) {
                  if ($battlefield->player->flags === PlayerModel::FLAG_AI_CONTROLLED) {
                      foreach ($battlefield->cells as $cell) {
      Severity: Minor
      Found in tests/phpunit/GameBundle/Controller/GameControllerTest.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

      Avoid using static access to class '\EM\Tests\Environment\Cleaner\CellModelCleaner' in method 'successfulTurnAction'.
      Open

                      CellModelCleaner::resetChangedCells();

      StaticAccess

      Since: 1.4.0

      Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

      Example

      class Foo
      {
          public function bar()
          {
              Bar::baz();
          }
      }

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

      Avoid using static access to class '\EM\Tests\Environment\Cleaner\CellModelCleaner' in method 'unsuccessfulTurnActionOnDeadCell'.
      Open

                          CellModelCleaner::resetChangedCells();

      StaticAccess

      Since: 1.4.0

      Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

      Example

      class Foo
      {
          public function bar()
          {
              Bar::baz();
          }
      }

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

      The method successfulInitAction_XML uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

                      } else {
                          $this->assertContains((string)$cell->flags, [CellModel::FLAG_NONE, CellModel::FLAG_SHIP, CellModel::FLAG_DEAD_SHIP]);
                      }

      ElseExpression

      Since: 1.4.0

      An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

      Example

      class Foo
      {
          public function bar($flag)
          {
              if ($flag) {
                  // one branch
              } else {
                  // another branch
              }
          }
      }

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

      Method name "GameControllerTest::successfulInitAction_XML" is not in camel caps format
      Open

          public function successfulInitAction_XML()

      Method name "GameControllerTest::successfulInitAction_JSON" is not in camel caps format
      Open

          public function successfulInitAction_JSON()

      Line exceeds 120 characters; contains 137 characters
      Open

                          $this->assertContains((string)$cell->flags, [CellModel::FLAG_NONE, CellModel::FLAG_SHIP, CellModel::FLAG_DEAD_SHIP]);

      Line exceeds 120 characters; contains 129 characters
      Open

                      $expected = $battlefield->player->flags == PlayerModel::FLAG_AI_CONTROLLED ? CellModel::FLAG_NONE : $cell->flags;

      The method successfulInitAction_XML is not named in camelCase.
      Open

          public function successfulInitAction_XML()
          {
              $client = static::$client;
              $client->request(
                  Request::METHOD_POST,

      CamelCaseMethodName

      Since: 0.2

      It is considered best practice to use the camelCase notation to name methods.

      Example

      class ClassName {
          public function get_name() {
          }
      }

      Source

      The method successfulInitAction_JSON is not named in camelCase.
      Open

          public function successfulInitAction_JSON()
          {
              $client = static::$client;
              $client->request(
                  Request::METHOD_POST,

      CamelCaseMethodName

      Since: 0.2

      It is considered best practice to use the camelCase notation to name methods.

      Example

      class ClassName {
          public function get_name() {
          }
      }

      Source

      There are no issues that match your filters.

      Category
      Status