socketstream/socketstream

View on GitHub
docs/js/docs.js

Summary

Maintainability
F
5 days
Test Coverage

Function DocsController has 230 lines of code (exceeds 25 allowed). Consider refactoring.
Open

docsApp.controller.DocsController = function($scope, $location, $window, sections) {
  var INDEX_PATH = /^(\/|\/index[^\.]*.html)$/,
      GLOBALS = /^angular\.([^\.]+)$/,
      MODULE = /^([^\.]+)$/,
      MODULE_MOCK = /^angular\.mock\.([^\.]+)$/,
Severity: Major
Found in docs/js/docs.js - About 1 day to fix

    Function DocsController has a Cognitive Complexity of 57 (exceeds 5 allowed). Consider refactoring.
    Open

    docsApp.controller.DocsController = function($scope, $location, $window, sections) {
      var INDEX_PATH = /^(\/|\/index[^\.]*.html)$/,
          GLOBALS = /^angular\.([^\.]+)$/,
          MODULE = /^([^\.]+)$/,
          MODULE_MOCK = /^angular\.mock\.([^\.]+)$/,
    Severity: Minor
    Found in docs/js/docs.js - About 1 day 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

    File docs.js has 441 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    var docsApp = {
      controller: {},
      directive: {},
      serviceFactory: {}
    };
    Severity: Minor
    Found in docs/js/docs.js - About 6 hrs to fix

      Function updateSearch has 102 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        function updateSearch() {
          var cache = {},
              pages = sections[$location.path().split('/')[1]],
              modules = $scope.modules = [],
              otherPages = $scope.pages = [],
      Severity: Major
      Found in docs/js/docs.js - About 4 hrs to fix

        Function docsPathWatchAction has 60 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          $scope.$watch(function docsPathWatch() {return $location.path(); }, function docsPathWatchAction(path) {
            var parts = path.split('/'),
              sectionId = parts[1],
              partialId = parts[2],
              page, sectionName = $scope.sections[(NG_DOCS.html5Mode ? '' : '#/') + sectionId];
        Severity: Major
        Found in docs/js/docs.js - About 2 hrs to fix

          Function openPlunkr has 40 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          docsApp.serviceFactory.openPlunkr = function(templateMerge, formPostData, loadedUrls) {
            return function(content) {
              var allFiles = [].concat(content.js, content.css, content.html);
              var indexHtmlContent = '<!doctype html>\n' +
                  '<html ng-app="{{module}}">\n' +
          Severity: Minor
          Found in docs/js/docs.js - About 1 hr to fix

            Function ngHtmlWrapLoaded has 38 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

            docsApp.directive.ngHtmlWrapLoaded = function(reindentCode, templateMerge, loadedUrls) {
              function escape(text) {
                return text.
                  replace(/\&/g, '&amp;').
                  replace(/\</g, '&lt;').
            Severity: Minor
            Found in docs/js/docs.js - About 1 hr to fix

              Function sourceEdit has 27 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

              docsApp.directive.sourceEdit = function(getEmbeddedTemplate) {
                return NG_DOCS.editExample ? {
                  template: '<a class="edit-example pull-right" ng-click="plunkr($event)" href>' +
                    '<i class="icon-edit"></i> Edit in Plunkr</a>',
                  scope: true,
              Severity: Minor
              Found in docs/js/docs.js - About 1 hr to fix

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

                docsApp.serviceFactory.sections = function serviceFactory() {
                  var sections = {
                    getPage: function(sectionId, partialId) {
                      var pages = sections[sectionId];
                
                
                Severity: Minor
                Found in docs/js/docs.js - 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

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

                      } else if (match = partialId.match(MODULE_FILTER)) {
                        match[1] = page.moduleName || match[1];
                        breadcrumb.push({ name: match[1], url: sectionPath + '/' + match[1] });
                        breadcrumb.push({ name: match[2] });
                      } else if (match = partialId.match(MODULE_CONTROLLER)) {
                Severity: Major
                Found in docs/js/docs.js and 2 other locations - About 2 hrs to fix
                docs/js/docs.js on lines 333..354
                docs/js/docs.js on lines 337..354

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

                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 3 locations. Consider refactoring.
                Open

                      } else if (match = partialId.match(MODULE_TYPE)) {
                        match[1] = page.moduleName || match[1];
                        breadcrumb.push({ name: match[1], url: sectionPath + '/' + match[1] });
                        breadcrumb.push({ name: match[2] });
                      }  else if (match = partialId.match(MODULE_SERVICE)) {
                Severity: Major
                Found in docs/js/docs.js and 2 other locations - About 2 hrs to fix
                docs/js/docs.js on lines 319..354
                docs/js/docs.js on lines 333..354

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

                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 3 locations. Consider refactoring.
                Open

                      } else if (match = partialId.match(MODULE_CUSTOM)) {
                        match[1] = page.moduleName || match[1];
                        breadcrumb.push({ name: match[1], url: sectionPath + '/' + match[1] });
                        breadcrumb.push({ name: match[3] });
                      } else if (match = partialId.match(MODULE_TYPE)) {
                Severity: Major
                Found in docs/js/docs.js and 2 other locations - About 2 hrs to fix
                docs/js/docs.js on lines 319..354
                docs/js/docs.js on lines 337..354

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

                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

                      } else if (match = partialId.match(MODULE_CONTROLLER)) {
                        breadcrumb.push({ name: match[1], url: sectionPath + '/' + match[1] });
                        breadcrumb.push({ name: match[2] });
                      } else if (match = partialId.match(MODULE_DIRECTIVE)) {
                        breadcrumb.push({ name: match[1], url: sectionPath + '/' + match[1] });
                Severity: Major
                Found in docs/js/docs.js and 1 other location - About 1 hr to fix
                docs/js/docs.js on lines 326..354

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

                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

                      } else if (match = partialId.match(MODULE_DIRECTIVE)) {
                        breadcrumb.push({ name: match[1], url: sectionPath + '/' + match[1] });
                        breadcrumb.push({ name: match[2] });
                      } else if (match = partialId.match(MODULE_DIRECTIVE_INPUT)) {
                        breadcrumb.push({ name: match[1], url: sectionPath + '/' + match[1] });
                Severity: Major
                Found in docs/js/docs.js and 1 other location - About 1 hr to fix
                docs/js/docs.js on lines 323..354

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

                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

                There are no issues that match your filters.

                Category
                Status