metanorma/metanorma-ieee

View on GitHub

Showing 30 of 30 total issues

Consider simplifying this complex logical expression.
Open

        if b = bib.at("./language | ./script | ./abstract | ./status")
          b.previous = note
        else b = bib.at("./contributor") || bib.at("./date") ||
          bib.at("./docnumber") || bib.at("./docidentifier") ||
          bib.at("./title") and b.next = note
Severity: Major
Found in lib/metanorma/ieee/cleanup_ref.rb - About 40 mins to fix

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

          def xref_init(lang, script, _klass, i18n, options)
    Severity: Minor
    Found in lib/isodoc/ieee/init.rb - About 35 mins to fix

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

            def output(isodoc_node, inname, outname, format, options = {})
      Severity: Minor
      Found in lib/metanorma/ieee/processor.rb - About 35 mins to fix

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

              def initialize(lang, script, klass, labels, options)
        Severity: Minor
        Found in lib/isodoc/ieee/xref.rb - About 35 mins to fix

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

                def note_style_cleanup1(multi, div, seq)
                  div.xpath(".//p[@class = 'Note' or not(@class)]")
                    .each_with_index do |p, i|
                    p["class"] =
                      i.zero? && multi ? "IEEEStdsMultipleNotes" : "IEEEStdsSingleNote"
          Severity: Minor
          Found in lib/isodoc/ieee/word_cleanup_blocks.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 title_validate_type has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

                def title_validate_type(xml)
                  title = xml.at("//bibdata/title") or return
                  draft = xml.at("//bibdata//draft")
                  trial = xml.at("//bibdata/ext/trial-use[text() = 'true']")
                  target = draft ? "Draft " : ""
          Severity: Minor
          Found in lib/metanorma/ieee/validate_style.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 td_style has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

                def td_style(cell, idx)
                  if cell.name == "th" && idx.zero? then stylesmap[:table_head]
                  elsif cell.name == "th" then stylesmap[:table_subhead]
                  elsif cell["align"] == "center" ||
                      cell["style"].include?("text-align:center")
          Severity: Minor
          Found in lib/isodoc/ieee/word_cleanup_blocks.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 sequential_formula_names has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

                def sequential_formula_names(clause, container: false)
                  c = Counter.new
                  clause.xpath(ns(".//formula")).noblank.each do |t|
                    @anchors[t["id"]] = anchor_struct(
                      c.increment(t).print, container ? t : nil,
          Severity: Minor
          Found in lib/isodoc/ieee/xref.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

                def feedback_table(docxml)
                  docxml.at("//div[@class = 'boilerplate-copyright']")&.xpath(".//table")
                    &.each do |t|
                    t.xpath(".//tr").each do |tr|
                      feedback_table1(tr)
          Severity: Minor
          Found in lib/isodoc/ieee/word_wp_cleanup.rb and 1 other location - About 15 mins to fix
          lib/isodoc/ieee/word_authority.rb on lines 120..126

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

          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

                def feedback_table(docxml)
                  docxml.at("//div[@class = 'boilerplate-feedback']")&.xpath(".//table")
                    &.each do |t|
                    t.xpath(".//tr").each do |tr|
                      feedback_table1(tr)
          Severity: Minor
          Found in lib/isodoc/ieee/word_authority.rb and 1 other location - About 15 mins to fix
          lib/isodoc/ieee/word_wp_cleanup.rb on lines 111..117

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

          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