Sign upLogin

metanorma/asciidoctor-rfc

View on GitHub
Star
lib/asciidoctor/rfc/v2/base.rb

Summary

Maintainability
D
2 days
Test Coverage

Method section has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
Open

      def section(node)
        result = []
        if node.attr("style") == "bibliography" ||
            node.parent.context == :section && node.parent.attr("style") == "bibliography"
          $xreftext = {}
Severity: Minor
Found in lib/asciidoctor/rfc/v2/base.rb - About 3 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

Method document has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
Open

      def document(node)
        $seen_back_matter = false
        $smart_quotes = (node.attr("smart-quotes") != "false")
        $inline_definition_lists = (node.attr("inline-definition-lists") == "true")
Severity: Minor
Found in lib/asciidoctor/rfc/v2/base.rb - 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

Method merge_vspace has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
Open

      def merge_vspace(node)
        nodes = []
        newnodes = []
        node.children.each do |element|
          nodes << element
Severity: Minor
Found in lib/asciidoctor/rfc/v2/base.rb - 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

File base.rb has 280 lines of code (exceeds 250 allowed). Consider refactoring.
Open

require "pp"
# coding: utf-8
module Asciidoctor
  module RFC::V2
    module Base
Severity: Minor
Found in lib/asciidoctor/rfc/v2/base.rb - About 2 hrs to fix

    Method document has 50 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

          def document(node)
        $seen_back_matter = false
        $smart_quotes = (node.attr("smart-quotes") != "false")
        $inline_definition_lists = (node.attr("inline-definition-lists") == "true")
    Severity: Minor
    Found in lib/asciidoctor/rfc/v2/base.rb - About 2 hrs to fix

      Method inline_quoted has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
      Open

            def inline_quoted(node)
        noko do |xml|
          case node.type
          when :emphasis
            xml.spanx node.text, style: "emph"
      Severity: Minor
      Found in lib/asciidoctor/rfc/v2/base.rb - 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 section has 46 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

            def section(node)
        result = []
        if node.attr("style") == "bibliography" ||
            node.parent.context == :section && node.parent.attr("style") == "bibliography"
          $xreftext = {}
      Severity: Minor
      Found in lib/asciidoctor/rfc/v2/base.rb - About 1 hr to fix

        Method cleanup has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
        Open

              def cleanup(doc)
        xmldoc = Nokogiri::XML(doc) do |config|
          config.noent
        end
        Severity: Minor
        Found in lib/asciidoctor/rfc/v2/base.rb - 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 merge_vspace has 33 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

              def merge_vspace(node)
        nodes = []
        newnodes = []
        node.children.each do |element|
          nodes << element
        Severity: Minor
        Found in lib/asciidoctor/rfc/v2/base.rb - About 1 hr to fix

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

                def cleanup(doc)
        xmldoc = Nokogiri::XML(doc) do |config|
          config.noent
        end
          Severity: Minor
          Found in lib/asciidoctor/rfc/v2/base.rb - About 1 hr to fix

            Method inline_quoted has 26 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                  def inline_quoted(node)
        noko do |xml|
          case node.type
          when :emphasis
            xml.spanx node.text, style: "emph"
            Severity: Minor
            Found in lib/asciidoctor/rfc/v2/base.rb - About 1 hr to fix

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

                      crefs.each do |cref|
          if cref.parent.name == "section"
            prev = cref.previous_element
            if !prev.nil? && prev.name == "t"
              cref.parent = prev
              Severity: Minor
              Found in lib/asciidoctor/rfc/v2/base.rb and 1 other location - About 45 mins to fix
              lib/asciidoctor/rfc/v3/base.rb on lines 317..326

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

              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

                      result = if result.any? { |e| e =~ /<\/front><middle>/ } && result.any? { |e| e =~ /<\/front><middle1>/ }
                   result.reject { |e| e =~ /<\/front><middle1>/ }
                 else
                   result.map { |e| e =~ /<\/front><middle1>/ ? "</front><middle>" : e }
                 end
              Severity: Minor
              Found in lib/asciidoctor/rfc/v2/base.rb and 1 other location - About 35 mins to fix
              lib/asciidoctor/rfc/v3/base.rb on lines 79..83

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

              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