ShogunPanda/mbrao

View on GitHub

Showing 17 of 17 total issues

Function generateTOC has 57 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 docs/js/app.js - About 2 hrs to fix

    Function searchItem has a Cognitive Complexity of 17 (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 docs/js/full_list.js - About 2 hrs 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

    Class Content has 21 methods (exceeds 20 allowed). Consider refactoring.
    Open

      class Content
        attr_accessor :uid, :locales, :title, :summary, :body, :tags, :more, :author, :created_at, :updated_at, :metadata
    
        include Mbrao::ContentInterface
    
    
    Severity: Minor
    Found in lib/mbrao/content.rb - About 2 hrs to fix

      Function fullListSearch has 46 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 docs/js/full_list.js - About 1 hr to fix

        Function summaryToggle has 31 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 docs/js/app.js - About 1 hr to fix

          Function linkList has 28 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          function linkList() {
            $('#full_list li, #full_list li a:last').click(function(evt) {
              if ($(this).hasClass('toggle')) return true;
              if (this.tagName.toLowerCase() == "li") {
                if ($(this).find('.object_link a').length === 0) {
          Severity: Minor
          Found in docs/js/full_list.js - About 1 hr to fix

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

                function() {
                    $(this).parent().nextAll('.source_code').slideUp(100);
                    $(this).text("View source");
                });
            Severity: Minor
            Found in docs/js/app.js and 1 other location - About 50 mins to fix
            docs/js/app.js on lines 4..7

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

            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

                $('.toggleSource').toggle(function() {
                   $(this).parent().nextAll('.source_code').slideDown(100);
                   $(this).text("Hide source");
                },
            Severity: Minor
            Found in docs/js/app.js and 1 other location - About 50 mins to fix
            docs/js/app.js on lines 8..11

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

            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 parse_metadata has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
            Open

                  def parse_metadata(content, options = {})
                    rv = YAML.load(content)
                    rv ||= {}
                    raise ArgumentError unless rv.is_a?(Hash)
                    rv
            Severity: Minor
            Found in lib/mbrao/parsing_engines/plain_text.rb - About 45 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 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 docs/js/app.js and 1 other location - About 45 mins to fix
            docs/js/app.js on lines 195..199

            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

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

            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

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

                def initialize(name, email = nil, website = nil, image = nil, metadata = nil)
            Severity: Minor
            Found in lib/mbrao/author.rb - About 35 mins to fix

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

                      $(this).parent().prev().height($(this).parent().height());
              Severity: Minor
              Found in docs/js/app.js and 1 other location - About 35 mins to fix
              docs/js/app.js on lines 20..20

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

              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

                      $(this).parent().prev().height($(this).parent().height());
              Severity: Minor
              Found in docs/js/app.js and 1 other location - About 35 mins to fix
              docs/js/app.js on lines 36..36

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

              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 perform_filter_content has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
              Open

                    def perform_filter_content(content, locales)
                      rv = content.map do |part|
                        part_content = part[0]
                        part_locales = parse_locales(part[1])
              
              
              Severity: Minor
              Found in lib/mbrao/parsing_engines/plain_text.rb - About 35 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

              Method extract_datetime has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
              Open

                  def extract_datetime(value)
                    value = parse_datetime(value) if value
                    value ? value.utc : nil
                  rescue ArgumentError
                    raise Mbrao::Exceptions::InvalidDate
              Severity: Minor
              Found in lib/mbrao/content.rb - 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

              Method initialize has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
              Open

                  def initialize(name, email = nil, website = nil, image = nil, metadata = nil)
                    @name = name.ensure_string
                    @email = Mbrao::Parser.email?(email) ? email : nil
                    @website = Mbrao::Parser.url?(website) ? website : nil
                    @image = Mbrao::Parser.url?(image) ? image : nil
              Severity: Minor
              Found in lib/mbrao/author.rb - 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