metanorma/reverse_adoc

View on GitHub

Showing 18 of 18 total issues

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

  module Converters
    class Audio < Base
      def to_coradoc(node, _state = {})
        src = node["src"]
        id = node["id"]
Severity: Major
Found in lib/reverse_adoc/converters/audio.rb and 1 other location - About 2 hrs to fix
lib/reverse_adoc/converters/video.rb on lines 2..27

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

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

  module Converters
    class Video < Base
      def to_coradoc(node, _state = {})
        src = node["src"]
        id = node["id"]
Severity: Major
Found in lib/reverse_adoc/converters/video.rb and 1 other location - About 2 hrs to fix
lib/reverse_adoc/converters/audio.rb on lines 2..27

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

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

      def to_coradoc(node, state = {})
        content = treat_children_coradoc(node,
                                         state.merge(already_strong: true))

        if Coradoc::Generator.gen_adoc(content).strip.empty?
Severity: Minor
Found in lib/reverse_adoc/converters/strong.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 constrained? has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

      def constrained?(node)
        before = node.at_xpath("preceding::node()[1]").to_s[-1]
        before = if before
                   before&.match?(/\s/) ? true : false
                 else
Severity: Minor
Found in lib/reverse_adoc/converters/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 to_coradoc has 31 lines of code (exceeds 25 allowed). Consider refactoring.
Open

      def to_coradoc(node, state = {})
        content = treat_children_coradoc(node,
                                         state.merge(already_italic: true))

        if Coradoc::Generator.gen_adoc(content).strip.empty?
Severity: Minor
Found in lib/reverse_adoc/converters/em.rb - About 1 hr to fix

    Method to_coradoc has 30 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

          def to_coradoc(node, state = {})
            content = treat_children_coradoc(node, state)
    
            if Coradoc::Generator.gen_adoc(content).strip.empty?
              return ""
    Severity: Minor
    Found in lib/reverse_adoc/converters/code.rb - About 1 hr to fix

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

            def to_coradoc(node, state = {})
              content = treat_children_coradoc(node,
                                               state.merge(already_strong: true))
      
              if Coradoc::Generator.gen_adoc(content).strip.empty?
      Severity: Minor
      Found in lib/reverse_adoc/converters/strong.rb - About 1 hr to fix

        Method to_coradoc has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

              def to_coradoc(node, state = {})
                content = treat_children_coradoc(node,
                                                 state.merge(already_italic: true))
        
                if Coradoc::Generator.gen_adoc(content).strip.empty?
        Severity: Minor
        Found in lib/reverse_adoc/converters/em.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 to_coradoc has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

              def to_coradoc(node, state = {})
                content = treat_children_coradoc(node, state)
        
                if Coradoc::Generator.gen_adoc(content).strip.empty?
                  return ""
        Severity: Minor
        Found in lib/reverse_adoc/converters/code.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 alignstyle has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

              def alignstyle(node)
                align = node["align"]
                valign = node["valign"]
                a = case align
                    when "left" then "<"
        Severity: Minor
        Found in lib/reverse_adoc/converters/td.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 to_coradoc has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

              def to_coradoc(node, state = {})
                # convert(node, state)
                id = node["id"]
                colrowattr = colrow(node["colspan"], node["rowspan"])
                alignattr = alignstyle(node)
        Severity: Minor
        Found in lib/reverse_adoc/converters/td.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

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

          module Converters
            class Sub < Base
              def to_coradoc(node, state = {})
                content = treat_children_coradoc(node, state)
                Coradoc::Element::Inline::Subscript.new(content)
        Severity: Minor
        Found in lib/reverse_adoc/converters/sub.rb and 2 other locations - About 25 mins to fix
        lib/reverse_adoc/converters/q.rb on lines 2..14
        lib/reverse_adoc/converters/sup.rb on lines 2..14

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

        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

          module Converters
            class Q < Base
              def to_coradoc(node, state = {})
                content = treat_children(node, state)
                Coradoc::Element::Inline::Quotation.new(content)
        Severity: Minor
        Found in lib/reverse_adoc/converters/q.rb and 2 other locations - About 25 mins to fix
        lib/reverse_adoc/converters/sub.rb on lines 2..14
        lib/reverse_adoc/converters/sup.rb on lines 2..14

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

        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

          module Converters
            class Sup < Base
              def to_coradoc(node, state = {})
                content = treat_children(node, state)
                Coradoc::Element::Inline::Superscript.new(content)
        Severity: Minor
        Found in lib/reverse_adoc/converters/sup.rb and 2 other locations - About 25 mins to fix
        lib/reverse_adoc/converters/q.rb on lines 2..14
        lib/reverse_adoc/converters/sub.rb on lines 2..14

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

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

              def to_coradoc(node, _state = {})
                id = node["id"]
                alt   = node["alt"]
                src   = node["src"]
                width = node["width"]
        Severity: Minor
        Found in lib/reverse_adoc/converters/img.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 to_coradoc has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

              def to_coradoc(node, state = {})
                name  = treat_children(node, state)
        
                href  = node["href"]
                title = extract_title(node)
        Severity: Minor
        Found in lib/reverse_adoc/converters/a.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

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

          module Converters
            class Br < Base
              def to_coradoc(_node, _state = {})
                Coradoc::Element::Inline::HardLineBreak.new
              end
        Severity: Minor
        Found in lib/reverse_adoc/converters/br.rb and 1 other location - About 15 mins to fix
        lib/reverse_adoc/converters/hr.rb on lines 2..13

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

        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

          module Converters
            class Hr < Base
              def to_coradoc(_node, _state = {})
                Coradoc::Element::Break::ThematicBreak.new
              end
        Severity: Minor
        Found in lib/reverse_adoc/converters/hr.rb and 1 other location - About 15 mins to fix
        lib/reverse_adoc/converters/br.rb on lines 2..13

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

        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