herpaderpaldent/seat-notifications

View on GitHub
src/Http/Controllers/Discord/DiscordServerController.php

Summary

Maintainability
C
7 hrs
Test Coverage

Method callback has 69 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function callback(Request $request)
    {
        // get back pending OAuth credentials validation from session
        $credentials = $request->session()->get('herpaderp.seatnotifications.discord.credentials');

Severity: Major
Found in src/Http/Controllers/Discord/DiscordServerController.php - About 2 hrs to fix

    Avoid too many return statements within this method.
    Open

            return redirect()->route('seatnotifications.configuration')
                ->with('success', 'The bot credentials has been set.');
    Severity: Major
    Found in src/Http/Controllers/Discord/DiscordServerController.php - About 30 mins to fix

      Avoid too many return statements within this method.
      Open

                  return redirect()->route('seatnotifications.configuration')
                      ->with('error', 'An error occurred while trying to create websocket connection with Discord. ' .
                          $e->getMessage());
      Severity: Major
      Found in src/Http/Controllers/Discord/DiscordServerController.php - About 30 mins to fix

        Avoid too many return statements within this method.
        Open

                        return redirect()->route('seatnotifications.configuration')
                            ->with('error', 'An error occurred while trying to create websocket connection with Discord. ' .
                                $identified);
        Severity: Major
        Found in src/Http/Controllers/Discord/DiscordServerController.php - About 30 mins to fix

          Avoid using static access to class '\Illuminate\Support\Arr' in method 'callback'.
          Open

                      $identified = Arr::get(json_decode($response, true), 'op') === 10;

          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 '\Illuminate\Support\Arr' in method 'getGateway'.
          Open

                      $gateway = Arr::get(json_decode($response->getBody(), true), 'url', $gateway);

          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

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

              private function isValidCallback($session_content)
              {
                  $expected_array_keys = ['state', 'client_id', 'client_secret', 'bot_token'];
                  $i = count($expected_array_keys);
          
          
          Severity: Major
          Found in src/Http/Controllers/Discord/DiscordServerController.php and 1 other location - About 2 hrs to fix
          src/Http/Controllers/Slack/SlackServerOAuthController.php on lines 135..154

          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 126.

          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

              public function postConfiguration(ValidateOAuth $request)
              {
                  $state = time();
          
                  // store data into the session until OAuth confirmation
          Severity: Major
          Found in src/Http/Controllers/Discord/DiscordServerController.php and 1 other location - About 1 hr to fix
          src/Http/Controllers/Slack/SlackServerOAuthController.php on lines 43..56

          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 102.

          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

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

                  $i = count($expected_array_keys);

          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

          There are no issues that match your filters.

          Category
          Status