lsd/guard-phpspec

View on GitHub

Showing 6 of 6 total issues

Function generateTOC has 58 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  function generateTOC() {
    if ($('#filecontents').length === 0) { return; }
    var _toc = $('<ol class="top"></ol>');
    var show = false;
    var toc = _toc;
Severity: Major
Found in doc/js/app.js - About 2 hrs to fix

    Function fullListSearch has 44 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    function fullListSearch() {
      // generate cache
      searchCache = [];
      $('#full_list li').each(function() {
        var link = $(this).find('.object_link a');
    Severity: Minor
    Found in doc/js/full_list.js - About 1 hr to fix

      Function searchItem has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
      Open

      function searchItem() {
        for (var i = 0; i < searchCache.length / 50; i++) {
          var item = searchCache[searchIndex];
          var searchName = (searchString.indexOf('::') != -1 ? item.fullName : item.name);
          var matchString = regexSearchString;
      Severity: Minor
      Found in doc/js/full_list.js - 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 summaryToggle has 32 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        function summaryToggle() {
          $('.summary_toggle').click(function() {
            if (localStorage) {
              localStorage.summaryCollapsed = $(this).text();
            }
      Severity: Minor
      Found in doc/js/app.js - About 1 hr to fix

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

            }, function() {
              $('#toc .top').slideDown('fast');
              $('#toc').toggleClass('hidden');
              $('#toc .title small').toggle();
            });
        Severity: Minor
        Found in doc/js/app.js and 1 other location - About 45 mins to fix
        doc/js/app.js on lines 162..166

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

        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

            $('#toc .hide_toc').toggle(function() {
              $('#toc .top').slideUp('fast');
              $('#toc').toggleClass('hidden');
              $('#toc .title small').toggle();
            }, function() {
        Severity: Minor
        Found in doc/js/app.js and 1 other location - About 45 mins to fix
        doc/js/app.js on lines 166..170

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

        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

        Severity
        Category
        Status
        Source
        Language