cosmocode/dokuwiki-plugin-issuelinks

View on GitHub

Showing 899 of 899 total issues

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

    protected function getTypeFromLabels(array $labels)
    {
        $bugTypeLabels = ['bug'];
        $improvementTypeLabels = ['enhancement'];
        $storyTypeLabels = ['feature'];
Severity: Major
Found in services/GitLab.service.php and 1 other location - About 1 hr to fix
services/GitHub.service.php on lines 414..433

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

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

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

    protected function estimateTotal($perPage, $default)
    {
        $headers = $this->dokuHTTPClient->resp_headers;

        if (empty($headers['link'])) {
Severity: Major
Found in services/GitHub.service.php and 1 other location - About 1 hr to fix
services/GitLab.service.php on lines 468..484

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

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

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

    protected function estimateTotal($perPage, $default)
    {
        $headers = $this->dokuHTTPClient->resp_headers;

        if (empty($headers['link'])) {
Severity: Major
Found in services/GitLab.service.php and 1 other location - About 1 hr to fix
services/GitHub.service.php on lines 571..587

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

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 createOrgRepoHTML has 44 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function createOrgRepoHTML($serviceId, $org)
    {
        $serviceProvider = ServiceProvider::getInstance();
        $services = $serviceProvider->getServices();
        $service = $services[$serviceId]::getInstance();
Severity: Minor
Found in action/ajax.php - About 1 hr to fix

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

            $improvementTypeLabels = ['enhancement'];
    Severity: Minor
    Found in services/GitHub.service.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 $projectIssueSeperator. Keep variable name length under 20.
    Open

            $projectIssueSeperator = '#';
    Severity: Minor
    Found in services/GitLab.service.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 $improvementTypeLabels. Keep variable name length under 20.
    Open

            $improvementTypeLabels = ['enhancement'];
    Severity: Minor
    Found in services/GitLab.service.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 run has 40 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function run()
        {
            /** @var \helper_plugin_issuelinks_util $util */
            $util = plugin_load('helper', 'issuelinks_util');
            if (!$util) {
    Severity: Minor
    Found in Webhook.php - About 1 hr to fix

      Method appendServicePage has 39 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          protected function appendServicePage($html, $serviceID)
          {
              $serviceProvider = ServiceProvider::getInstance();
              $services = $serviceProvider->getServices();
              $service = $services[$serviceID]::getInstance();
      Severity: Minor
      Found in admin/repoadmin.php - About 1 hr to fix

        Method test_jiralink_moresyntax has 38 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function test_jiralink_moresyntax() {
                // arrange
                global $ID;
                $ID = 'testpage2';
                saveWikiText($ID,'page must exist for m_filetime','test summary');
        Severity: Minor
        Found in _test/handleIssueLinkSyntax.test.php - About 1 hr to fix

          The class Issue has 21 fields. Consider redesigning Issue to keep the number of fields under 15.
          Open

          class Issue extends \DokuWiki_Plugin implements \JsonSerializable
          {
          
              /** @var Issue[] */
              private static $instances = [];
          Severity: Minor
          Found in classes/Issue.php by phpmd

          TooManyFields

          Since: 0.1

          Classes that have too many fields could be redesigned to have fewer fields, possibly through some nested object grouping of some of the information. For example, a class with city/state/zip fields could instead have one Address field.

          Example

          class Person {
             protected $one;
             private $two;
             private $three;
             [... many more fields ...]
          }

          Source https://phpmd.org/rules/codesize.html#toomanyfields

          Method retrieveAllIssues has 37 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public function retrieveAllIssues($projectKey, &$startat = 0)
              {
                  $perPage = 100;
                  $page = ceil(($startat + 1) / $perPage);
                  $endpoint = '/projects/' . urlencode($projectKey) . "/issues?page=$page&per_page=$perPage";
          Severity: Minor
          Found in services/GitLab.service.php - About 1 hr to fix

            Method makeGitHubGETRequest has 36 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                protected function makeGitHubGETRequest($endpoint, $max = null)
                {
                    $results = [];
                    $waittime = 0;
                    /** @var \helper_plugin_issuelinks_util $utils */
            Severity: Minor
            Found in services/GitHub.service.php - About 1 hr to fix

              Function makeGitHubGETRequest has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
              Open

                  protected function makeGitHubGETRequest($endpoint, $max = null)
                  {
                      $results = [];
                      $waittime = 0;
                      /** @var \helper_plugin_issuelinks_util $utils */
              Severity: Minor
              Found in services/GitHub.service.php - About 1 hr 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 importAllIssues has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
              Open

                  public function importAllIssues($serviceName, $projectKey)
                  {
                      $lockfileKey = $this->getImportLockID($serviceName, $projectKey);
                      if ($this->isImportLocked($lockfileKey)) {
                          throw new RuntimeException('Import of Issues is already locked!');
              Severity: Minor
              Found in helper/data.php - About 1 hr 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 handleAjax has 35 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  public function handleAjax(Doku_Event $event, $param)
                  {
                      if ($event->data !== 'plugin_issuelinks') {
                          return;
                      }
              Severity: Minor
              Found in action/ajax.php - About 1 hr to fix

                Method deleteWebhook has 31 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                    public function deleteWebhook($project, $hookid)
                    {
                        // get old webhook id
                        /** @var \helper_plugin_issuelinks_db $db */
                        $db = plugin_load('helper', 'issuelinks_db');
                Severity: Minor
                Found in services/Jira.service.php - About 1 hr to fix

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

                      private function getAdditionalIssueData($pmServiceName, $projectKey, $issueId, $isMergeRequest)
                      {
                          try {
                              $issue = Issue::getInstance($pmServiceName, $projectKey, $issueId, $isMergeRequest);
                              $issue->getFromDB();
                  Severity: Major
                  Found in action/ajax.php and 1 other location - About 1 hr to fix
                  action/ajax.php on lines 294..307

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

                  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

                      private function getIssueTooltipHTML($pmServiceName, $projectKey, $issueId, $isMergeRequest)
                      {
                          try {
                              $issue = Issue::getInstance($pmServiceName, $projectKey, $issueId, $isMergeRequest);
                              $issue->getFromDB();
                  Severity: Major
                  Found in action/ajax.php and 1 other location - About 1 hr to fix
                  action/ajax.php on lines 309..322

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

                  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 createWebhook has 29 lines of code (exceeds 25 allowed). Consider refactoring.
                  Open

                      public function createWebhook($project)
                      {
                          // get old webhook id
                          /** @var \helper_plugin_issuelinks_db $db */
                          $db = plugin_load('helper', 'issuelinks_db');
                  Severity: Minor
                  Found in services/Jira.service.php - About 1 hr to fix
                    Severity
                    Category
                    Status
                    Source
                    Language