Sign upLogin

metanorma/metanorma-iso

View on GitHub
Star

Showing 43 of 43 total issues

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

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

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

        class PresentationXMLConvert < IsoDoc::PresentationXMLConvert
      def convert_i18n_init(docxml)
        super
        update_i18n(docxml)
      end
    Severity: Minor
    Found in lib/isodoc/iso/presentation_xml_convert.rb - About 3 hrs to fix

      Class Metadata has 26 methods (exceeds 20 allowed). Consider refactoring.
      Open

          class Metadata < IsoDoc::Metadata
      def initialize(lang, script, locale, i18n)
        super
        DATETYPES.each { |w| @metadata["#{w.gsub(/-/, '_')}date".to_sym] = nil }
        set(:obsoletes, nil)
      Severity: Minor
      Found in lib/isodoc/iso/metadata.rb - About 3 hrs to fix

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

            class Converter < Standoc::Converter
      def extract_text(node)
        node.nil? and return ""
        node1 = Nokogiri::XML.fragment(node.to_s)
        node1.xpath(".//link | .//locality | .//localityStack | .//stem")
        Severity: Minor
        Found in lib/metanorma/iso/validate_style.rb - About 2 hrs to fix

          Class WordDISConvert has 23 methods (exceeds 20 allowed). Consider refactoring.
          Open

              class WordDISConvert < WordConvert
      STYLESMAP = {
        AltTerms: "AdmittedTerm",
        TableFootnote: "Tablefootnote",
        formula: "Formula",
          Severity: Minor
          Found in lib/isodoc/iso/word_dis_styles.rb - About 2 hrs to fix

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

                class Xref < IsoDoc::Xref
      attr_accessor :anchors_previous, :anchors

      def clause_order_main(docxml)
        if @klass.amd?(docxml)
            Severity: Minor
            Found in lib/isodoc/iso/xref.rb - About 2 hrs to fix

              Method title has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
              Open

                    def title(isoxml, _out)
        lang = case @lang
               when "fr", "ru" then @lang
               else "en"
               end
              Severity: Minor
              Found in lib/isodoc/iso/metadata.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 subtitle has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
              Open

                    def subtitle(isoxml, _out)
        lang = @lang == "en" ? "fr" : "en"
        tp = title_parts(isoxml, lang)
        tn = title_nums(isoxml)
              Severity: Minor
              Found in lib/isodoc/iso/metadata.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 output has 26 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                    def output(isodoc_node, inname, outname, format, options = {})
        options_preprocess(options)
        case format
        when :html
          IsoDoc::Iso::HtmlConvert.new(options)
              Severity: Minor
              Found in lib/metanorma/iso/processor.rb - About 1 hr to fix

                Method see_xrefs_validate has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
                Open

                      def see_xrefs_validate(root)
        @lang == "en" or return
        root.xpath("//xref").each do |t|
          preceding = t.at("./preceding-sibling::text()[last()]")
          next unless !preceding.nil? &&
                Severity: Minor
                Found in lib/metanorma/iso/validate.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 status_abbrev has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
                Open

                      def status_abbrev(stage, _substage, iter, draft, doctype)
        return "" unless stage

        if %w(technical-report technical-specification).include?(doctype)
          stage = "DTS" if stage == "DIS"
                Severity: Minor
                Found in lib/isodoc/iso/metadata.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 see_erefs_validate has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
                Open

                      def see_erefs_validate(root)
        @lang == "en" or return
        root.xpath("//eref").each do |t|
          prec = t.at("./preceding-sibling::text()[last()]")
          !prec.nil? && /\b(see|refer to)\p{Zs}*\Z/mi.match(prec) or next
                Severity: Minor
                Found in lib/metanorma/iso/validate.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

                        { intro: isoxml.at(ns("//bibdata/title[@type='title-intro' and " \
                              "@language='#{lang}']")),
          main: isoxml.at(ns("//bibdata/title[@type='title-main' and " \
                             "@language='#{lang}']")),
          part: isoxml.at(ns("//bibdata/title[@type='title-part' and " \
                Severity: Minor
                Found in lib/isodoc/iso/metadata.rb and 1 other location - About 45 mins to fix
                lib/isodoc/iso/metadata.rb on lines 120..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 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

                        { part: isoxml.at(ns("#{prefix}/@part")),
          subpart: isoxml.at(ns("#{prefix}/@subpart")),
          amd: isoxml.at(ns("#{prefix}/@amendment")),
          add: isoxml.at(ns("#{prefix}/@addendum")),
          corr: isoxml.at(ns("#{prefix}/@corrigendum")) }
                Severity: Minor
                Found in lib/isodoc/iso/metadata.rb and 1 other location - About 45 mins to fix
                lib/isodoc/iso/metadata.rb on lines 128..137

                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

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

                      def default_fonts(options)
        {
          bodyfont: (if options[:script] == "Hans"
                       '"Source Han Sans",serif'
                     else
                Severity: Minor
                Found in lib/isodoc/iso/html_convert.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 onlychild_clause_validate has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
                Open

                      def onlychild_clause_validate(root)
        root.xpath(Standoc::Utils::SUBCLAUSE_XPATH).each do |c|
          next unless c.xpath("../clause").size == 1

          title = c.at("./title")
                Severity: Minor
                Found in lib/metanorma/iso/validate_section.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 status_abbrev has 5 arguments (exceeds 4 allowed). Consider refactoring.
                Open

                      def status_abbrev(stage, _substage, iter, draft, doctype)
                Severity: Minor
                Found in lib/isodoc/iso/metadata.rb - About 35 mins to fix

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

                        def disjunct_error(img, cond1, cond2, msg1, msg2)
                  Severity: Minor
                  Found in lib/metanorma/iso/validate_image.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/iso/processor.rb - About 35 mins to fix

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

                            def term_hash_init(hash, term, term2, term3, label)
                      Severity: Minor
                      Found in lib/isodoc/iso/index.rb - About 35 mins to fix
                        Severity
                        Category
                        Status
                        Source
                        Language