Sign upLogin

brandon14/fossabot-commander

View on GitHub
Star

Showing 12 of 12 total issues

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

        try {
            $body = $this->sendContextRequest($customApiToken);

            $this->info('Successfully received context response.');
        } catch (Throwable $exception) {
Severity: Major
Found in src/FossabotCommander.php and 1 other location - About 5 hrs to fix
src/FossabotCommander.php on lines 237..264

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

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

        try {
            // Send validate request. Will throw exception if unable to validate.
            $this->sendValidateRequest($customApiToken);

            $this->info('Validated Fossabot request.');
Severity: Major
Found in src/FossabotCommander.php and 1 other location - About 5 hrs to fix
src/FossabotCommander.php on lines 353..379

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

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

File FossabotCommander.php has 271 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

/**
 * This file is part of the brandon14/fossabot-commander package.
 *
Severity: Minor
Found in src/FossabotCommander.php - About 2 hrs to fix

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

            string $id,
        string $login,
        string $displayName,
        string $avatarUrl,
        string $slug,
    Severity: Major
    Found in src/Context/FossabotChannel.php - About 1 hr to fix

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

          private function getExceptionFromBody(array $body, int $statusCode, array $headers): FossabotApiException
    {
        // Get exception details from response body.
        $fossabotCode = $body['code'] ?? 'unknown';
        $errorClass = $body['error'] ?? 'Unknown Error';
      Severity: Minor
      Found in src/FossabotCommander.php - About 1 hr to fix

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

            private function getContext(string $customApiToken): FossabotContextInterface
    {
        $this->info('Sending request to get additional context.');

        try {
        Severity: Minor
        Found in src/FossabotCommander.php - About 1 hr to fix

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

              public function runCommand(
        FossabotCommand $command,
        string $customApiToken,
        bool $getContext = true
    ): string {
          Severity: Minor
          Found in src/FossabotCommander.php - About 1 hr to fix

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

                    string $fossabotCode,
        string $errorClass,
        string $errorMessage,
        int $total,
        int $remaining,
            Severity: Major
            Found in src/Contracts/Exceptions/RateLimitException.php - About 1 hr to fix

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

                      string $fossabotCode,
        string $errorClass,
        string $errorMessage,
        int $statusCode,
        ?array $body = null,
              Severity: Minor
              Found in src/Contracts/Exceptions/FossabotApiException.php - About 45 mins to fix

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

                        string $fossabotCode,
        string $errorClass,
        string $errorMessage,
        ?array $body = null,
        ?Throwable $previous = null
                Severity: Minor
                Found in src/Contracts/Exceptions/InvalidTokenException.php - About 35 mins to fix

                  Function getContext has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                  Open

                      private function getContext(string $customApiToken): FossabotContextInterface
    {
        $this->info('Sending request to get additional context.');

        try {
                  Severity: Minor
                  Found in src/FossabotCommander.php - About 25 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 runCommand has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                  Open

                      public function runCommand(
        FossabotCommand $command,
        string $customApiToken,
        bool $getContext = true
    ): string {
                  Severity: Minor
                  Found in src/FossabotCommander.php - About 25 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

                  Severity
                  Category
                  Status
                  Source
                  Language