metanorma/isodoc

View on GitHub

Showing 82 of 82 total issues

Class PresentationXMLConvert has 36 methods (exceeds 20 allowed). Consider refactoring.
Open

  class PresentationXMLConvert < ::IsoDoc::Convert
    def lower2cap(text)
      /^[[:upper:]][[:upper:]]/.match?(text) and return text
      text&.capitalize
    end
Severity: Minor
Found in lib/isodoc/presentation_function/block.rb - About 4 hrs to fix

    Class PresentationXMLConvert has 31 methods (exceeds 20 allowed). Consider refactoring.
    Open

      class PresentationXMLConvert < ::IsoDoc::Convert
        def designation(docxml)
          docxml.xpath(ns("//term")).each { |t| merge_second_preferred(t) }
          docxml.xpath(ns("//preferred | //admitted | //deprecates"))
            .each { |p| designation1(p) }
    Severity: Minor
    Found in lib/isodoc/presentation_function/terms.rb - About 3 hrs to fix

      Method parse has 94 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

            def parse(node, out)
              if node.text? then text_parse(node, out)
              else
                case node.name
                when "em" then em_parse(node, out)
      Severity: Major
      Found in lib/isodoc/function/to_word_html.rb - About 3 hrs to fix

        Class PresentationXMLConvert has 28 methods (exceeds 20 allowed). Consider refactoring.
        Open

          class PresentationXMLConvert < ::IsoDoc::Convert
            def middle_title(docxml)
              s = docxml.at(ns("//sections")) or return
              t = @meta.get[:doctitle]
              t.nil? || t.empty? and return
        Severity: Minor
        Found in lib/isodoc/presentation_function/section.rb - About 3 hrs to fix

          Class PresentationXMLConvert has 27 methods (exceeds 20 allowed). Consider refactoring.
          Open

            class PresentationXMLConvert < ::IsoDoc::Convert
              def non_locality_elems(node)
                node.children.reject do |c|
                  %w{locality localityStack location}.include? c.name
                end
          Severity: Minor
          Found in lib/isodoc/presentation_function/inline.rb - About 3 hrs to fix

            Class PresentationXMLConvert has 27 methods (exceeds 20 allowed). Consider refactoring.
            Open

              class PresentationXMLConvert < ::IsoDoc::Convert
                def references(docxml)
                  bibliography_bibitem_number(docxml)
                  renderings = references_render(docxml)
                  docxml.xpath(ns("//references/bibitem")).each do |x|
            Severity: Minor
            Found in lib/isodoc/presentation_function/refs.rb - About 3 hrs to fix

              Class PresentationXMLConvert has 22 methods (exceeds 20 allowed). Consider refactoring.
              Open

                class PresentationXMLConvert < ::IsoDoc::Convert
                  SVG = { "m" => "http://www.w3.org/2000/svg" }.freeze
              
                  def figure(docxml)
                    docxml.xpath("//m:svg", SVG).each { |f| svg_wrap(f) }
              Severity: Minor
              Found in lib/isodoc/presentation_function/image.rb - About 2 hrs to fix

                Method top_element_render has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
                Open

                      def top_element_render(e, out)
                        case e.name
                        when "abstract" then abstract e, out
                        when "foreword" then foreword e, out
                        when "introduction" then introduction e, out
                Severity: Minor
                Found in lib/isodoc/function/to_word_html.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

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

                      def insert_comment_cont(from, upto, target)
                        # includes_to = from.at(".//*[@id='#{upto}']")
                        while !from.nil? && from["id"] != upto
                          following = from.xpath("./following::*")
                          (from = following.shift) && incl_to = from.at(".//*[@id='#{upto}']")
                Severity: Major
                Found in lib/isodoc/word_function/comments.rb and 1 other location - About 1 hr to fix
                lib/isodoc/html_function/comments.rb on lines 97..106

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

                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

                      def insert_comment_cont(from, upto, target)
                        # includes_to = from.at(".//*[@id='#{upto}']")
                        while !from.nil? && from["id"] != upto
                          following = from.xpath("./following::*")
                          (from = following.shift) && incl_to = from.at(".//*[@id='#{upto}']")
                Severity: Major
                Found in lib/isodoc/html_function/comments.rb and 1 other location - About 1 hr to fix
                lib/isodoc/word_function/comments.rb on lines 105..114

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

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

                      def new_subseq_increment1(node)
                        /^(?<b>.*?)(?<n>\d*)(?<a>[a-zA-Z]*)$/ =~ node["number"]
                        if !n.empty? || !a.empty?
                          @letter_override = @letter = a unless a.empty?
                          @number_override = @num = n.to_i unless n.empty?
                Severity: Minor
                Found in lib/isodoc/xref/xref_counter.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

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

                      def get_comments_from_text(docxml, link_order)
                        comments = []
                        docxml.xpath("//div[@style='mso-element:comment']").each do |c|
                          next unless c["id"] && !link_order[c["id"]].nil?
                
                
                Severity: Major
                Found in lib/isodoc/html_function/comments.rb and 1 other location - About 1 hr to fix
                lib/isodoc/word_function/comments.rb on lines 125..132

                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

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

                      def get_comments_from_text(docxml, link_order)
                        comments = []
                        docxml.xpath("//div[@style='mso-element:comment']").each do |c|
                          next unless c["id"] && !link_order[c["id"]].nil?
                
                
                Severity: Major
                Found in lib/isodoc/word_function/comments.rb and 1 other location - About 1 hr to fix
                lib/isodoc/html_function/comments.rb on lines 117..124

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

                      def norm_ref(node, out)
                        node["hidden"] != "true" or return
                        out.div do |div|
                          clause_name(node, node.at(ns("./title")), div, nil)
                          if node.name == "clause"
                Severity: Minor
                Found in lib/isodoc/function/references.rb - About 55 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 make_tr_attr has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
                Open

                      def make_tr_attr(cell, row, totalrows, header, bordered)
                        style = cell.name == "th" ? "font-weight:bold;" : ""
                        cell["align"] and style += "text-align:#{cell['align']};"
                        cell["valign"] and style += "vertical-align:#{cell['valign']};"
                        rowmax = cell["rowspan"] ? row + cell["rowspan"].to_i - 1 : row
                Severity: Minor
                Found in lib/isodoc/function/table.rb - About 55 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 scss_fontheader has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
                Open

                    def scss_fontheader(is_html_css)
                      b = options[:bodyfont] || "Arial"
                      h = options[:headerfont] || "Arial"
                      m = options[:monospacefont] || "Courier New"
                      ns = options[:normalfontsize] || (is_html_css ? "1.0em" : "12.0pt")
                Severity: Minor
                Found in lib/isodoc/css.rb - About 55 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 comment_attributes(docxml, span)
                        fromlink = docxml.at("//*[@id='#{span['from']}']")
                        return(nil) if fromlink.nil?
                
                        tolink = docxml.at("//*[@id='#{span['to']}']") || fromlink
                Severity: Minor
                Found in lib/isodoc/word_function/comments.rb and 1 other location - About 50 mins to fix
                lib/isodoc/html_function/comments.rb on lines 79..85

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

                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 comment_attributes(docxml, x)
                        fromlink = docxml.at("//*[@id='#{x['from']}']")
                        return(nil) if fromlink.nil?
                
                        tolink = docxml.at("//*[@id='#{x['to']}']") || fromlink
                Severity: Minor
                Found in lib/isodoc/html_function/comments.rb and 1 other location - About 50 mins to fix
                lib/isodoc/word_function/comments.rb on lines 81..87

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

                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 li_parse(node, out)
                        out.li **attr_code(id: node["id"]) do |li|
                          if node["uncheckedcheckbox"] == "true"
                            li << '<span class="zzMoveToFollowing">' \
                                  '<input type="checkbox" checked="checked"/></span>'
                Severity: Minor
                Found in lib/isodoc/function/lists.rb and 1 other location - About 45 mins to fix
                lib/isodoc/word_function/lists.rb on lines 97..104

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

                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 li_parse(node, out)
                        out.li **attr_code(id: node["id"]) do |li|
                          if node["uncheckedcheckbox"] == "true"
                            li << '<span class="zzMoveToFollowing">&#x2610; </span>'
                          elsif node["checkedcheckbox"] == "true"
                Severity: Minor
                Found in lib/isodoc/word_function/lists.rb and 1 other location - About 45 mins to fix
                lib/isodoc/function/lists.rb on lines 65..74

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

                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