Sign upLogin

metanorma/metanorma-iec

View on GitHub
Star

Showing 13 of 13 total issues

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

    class WordConvert < IsoDoc::Iso::WordConvert
      def initialize(options)
        super
        @libdir = File.dirname(__FILE__)
      end
Severity: Minor
Found in lib/isodoc/iec/word_convert.rb - About 3 hrs to fix

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

        class PresentationXMLConvert < IsoDoc::Iso::PresentationXMLConvert
      def termclause1(elem)
        @is_iev or return clause1(elem)
        @suppressheadingnumbers || elem["unnumbered"] and return
        lbl = @xrefs.anchor(elem["id"], :label, true) or return
    Severity: Minor
    Found in lib/isodoc/iec/presentation_terms.rb - About 2 hrs to fix

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

          class Converter < ISO::Converter
      XML_ROOT_TAG = "iec-standard".freeze
      XML_NAMESPACE = "https://www.metanorma.org/ns/iec".freeze

      register_for "iec"
      Severity: Minor
      Found in lib/metanorma/iec/converter.rb - About 2 hrs to fix

        Method docfunction has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

              def docfunction(isoxml)
        b = isoxml&.at(ns("//bibdata/ext/function#{NOLANG}"))&.text || return
        b and set(:function, status_print(b))
        b1 = isoxml&.at(ns("//bibdata/ext/function#{currlang}"))&.text || b
        b1 and set(:function_display, status_print(b1))
        Severity: Minor
        Found in lib/isodoc/iec/metadata.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

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

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

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

                def tr_parse(node, out, ord, totalrows, header)
          Severity: Minor
          Found in lib/isodoc/iec/word_convert.rb - About 35 mins to fix

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

                  def make_tr_attr(cell, row, totalrows, header, bordered)
            Severity: Minor
            Found in lib/isodoc/iec/word_convert.rb - About 35 mins to fix

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

                    def term_defs_boilerplate(div, source, term, preface, isodoc)
              Severity: Minor
              Found in lib/metanorma/iec/converter.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/iec/processor.rb - About 35 mins to fix

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

                        def foreword(sect, out)
        out.div **attr_code(id: sect ? sect["id"] : "") do |s|
          s.h1(class: "ForewordTitle") { |h1| h1 << @i18n.foreword }
          sect&.elements&.each { |e| parse(e, s) unless e.name == "title" }
        end
                  Severity: Minor
                  Found in lib/isodoc/iec/base_convert.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 2 locations. Consider refactoring.
                  Open

                        def make_figure_word_toc(docxml)
        docxml.at(figure_toc_xpath) or return ""
        toc = ""
        docxml.xpath(figure_toc_xpath).each do |h|
          toc += word_toc_entry(1, header_strip(h))
                  Severity: Minor
                  Found in lib/isodoc/iec/word_convert.rb and 1 other location - About 25 mins to fix
                  lib/isodoc/iec/word_convert.rb on lines 58..65

                  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 2 locations. Consider refactoring.
                  Open

                        def make_table_word_toc(docxml)
        docxml.at(table_toc_xpath) or return ""
        toc = ""
        docxml.xpath(table_toc_xpath).each do |h|
          toc += word_toc_entry(1, header_strip(h))
                  Severity: Minor
                  Found in lib/isodoc/iec/word_convert.rb and 1 other location - About 25 mins to fix
                  lib/isodoc/iec/word_convert.rb on lines 68..75

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

                        def insert_foreword(docxml)
        @meta.get[:doctype] == "Amendment" and return
        b = docxml.at(ns("//boilerplate/legal-statement")) or return
        unless f = docxml.at(ns("//preface/foreword"))
          ins = toc_title_insert_pt(docxml)
                  Severity: Minor
                  Found in lib/isodoc/iec/presentation_xml_convert.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