metanorma/metanorma-gb

View on GitHub

Showing 21 of 21 total issues

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

    class Converter < ISO::Converter
      def doctype(node)
        type = node.attr("mandate") || "mandatory"
        type = "standard" if type == "mandatory"
        type = "recommendation" if type == "recommended"
Severity: Minor
Found in lib/asciidoctor/gb/front.rb - About 2 hrs to fix

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

          def default_fonts(options)
            script = options[:script] || "Hans"
            scope = options[:scope] || "national"
            {
              bodyfont: (script == "Hans" ? '"SimSun",serif' : '"Cambria",serif'),
    Severity: Minor
    Found in lib/isodoc/gb/html_convert.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 default_fonts has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
    Open

          def default_fonts(options)
            script = options[:script] || "Hans"
            scope = options[:scope] || "national"
            {
              bodyfont: (script == "Hans" ? '"SimSun",serif' : '"Cambria",serif'),
    Severity: Minor
    Found in lib/isodoc/gb/word_convert.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 extract_options has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

          def extract_options(file)
            head = file.sub(/\n\n.*$/m, "\n")
            /\n:standard-logo-img: (?<standardlogoimg>[^\n]+)\n/ =~ head
            /\n:standard-class-img: (?<standardclassimg>[^\n]+)\n/ =~ head
            /\n:standard-issuer-img: (?<standardissuerimg>[^\n]+)\n/ =~ head
    Severity: Minor
    Found in lib/metanorma/gb/processor.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 default_fonts(options)
            script = options[:script] || "Hans"
            scope = options[:scope] || "national"
            {
              bodyfont: (script == "Hans" ? '"SimSun",serif' : '"Cambria",serif'),
    Severity: Major
    Found in lib/isodoc/gb/word_convert.rb and 1 other location - About 1 hr to fix
    lib/isodoc/gb/html_convert.rb on lines 19..28

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

    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 default_fonts(options)
            script = options[:script] || "Hans"
            scope = options[:scope] || "national"
            {
              bodyfont: (script == "Hans" ? '"SimSun",serif' : '"Cambria",serif'),
    Severity: Major
    Found in lib/isodoc/gb/html_convert.rb and 1 other location - About 1 hr to fix
    lib/isodoc/gb/word_convert.rb on lines 19..28

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

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

          def check_bilingual(t, element)
            zh = t.at(".//#{element}[@language = 'zh']")
            en = t.at(".//#{element}[@language = 'en']")
            (en.nil? || en.text.empty?) && !(zh.nil? || zh.text.empty?) &&
              @log.add("Style", t, "GB: #{element} term #{zh.text} has no English counterpart")
    Severity: Minor
    Found in lib/asciidoctor/gb/validate.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 get_scope has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

          def get_scope(node)
            node.attr("scope") and return node.attr("scope")
            scope = if %r{^[TQ]/}.match node.attr("prefix")
                      m = node.attr("prefix").split(%{/})
                      mandate = m[0] == "T" ? "social-group" :
    Severity: Minor
    Found in lib/asciidoctor/gb/front.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

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

          def fonts_options
            default_font_options = default_fonts(options)
            {
              bodyfont: options[:bodyfont] || default_font_options[:bodyfont],
              headerfont: options[:headerfont] || default_font_options[:headerfont],
    Severity: Minor
    Found in lib/isodoc/gb/html_convert.rb and 1 other location - About 40 mins to fix
    lib/isodoc/gb/word_convert.rb on lines 31..38

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

    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 fonts_options
            default_font_options = default_fonts(options)
            {
              bodyfont: options[:bodyfont] || default_font_options[:bodyfont],
              headerfont: options[:headerfont] || default_font_options[:headerfont],
    Severity: Minor
    Found in lib/isodoc/gb/word_convert.rb and 1 other location - About 40 mins to fix
    lib/isodoc/gb/html_convert.rb on lines 31..38

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

    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 status_abbrev_cn has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

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

      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/gb/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/gb/processor.rb - About 35 mins to fix

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

                def title_intro_validate(root)
                  title_intro_en = root.at("//title[@type='title-intro' and @language='en']")
                  title_intro_zh = root.at("//title[@type='title-intro' and @language='zh']")
                  if title_intro_en.nil? && !title_intro_zh.nil?
                    @log.add("Style", title_intro_zh, "No English Title Intro!")
          Severity: Minor
          Found in lib/asciidoctor/gb/validate.rb and 2 other locations - About 35 mins to fix
          lib/asciidoctor/gb/validate.rb on lines 99..107
          lib/asciidoctor/gb/validate.rb on lines 110..118

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

          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

                def title_part_validate(root)
                  title_part_en = root.at("//title[@type='title-part' and @language='en']")
                  title_part_zh = root.at("//title[@type='title-part' and @language='zh']")
                  if title_part_en.nil? && !title_part_zh.nil?
                    @log.add("Style", title_part_en,  "No English Title Part!")
          Severity: Minor
          Found in lib/asciidoctor/gb/validate.rb and 2 other locations - About 35 mins to fix
          lib/asciidoctor/gb/validate.rb on lines 88..96
          lib/asciidoctor/gb/validate.rb on lines 99..107

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

          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

                def title_main_validate(root)
                  title_main_en = root.at("//title[@type='title-main' and @language='en']")
                  title_main_zh = root.at("//title[@type='title-main' and @language='zh']")
                  if title_main_en.nil? && !title_main_zh.nil?
                    @log.add("Style", title_main_zh,  "No English Title!")
          Severity: Minor
          Found in lib/asciidoctor/gb/validate.rb and 2 other locations - About 35 mins to fix
          lib/asciidoctor/gb/validate.rb on lines 88..96
          lib/asciidoctor/gb/validate.rb on lines 110..118

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

          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 title_intro(node, lang, t, at)
                  node.attr("title-intro-#{lang}") and
                    t.title **attr_code(at.merge(type: "title-intro")) do |t1|
                    t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(
                      node.attr("title-intro-#{lang}"))
          Severity: Minor
          Found in lib/asciidoctor/gb/front.rb and 1 other location - About 25 mins to fix
          lib/asciidoctor/gb/front.rb on lines 223..229

          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 title_part(node, lang, t, at)
                  node.attr("title-part-#{lang}") and
                    t.title **attr_code(at.merge(type: "title-part")) do |t1|
                    t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(
                      node.attr("title-part-#{lang}"))
          Severity: Minor
          Found in lib/asciidoctor/gb/front.rb and 1 other location - About 25 mins to fix
          lib/asciidoctor/gb/front.rb on lines 208..214

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

                def norm_bibitem_style(root)
                  root.xpath(NORM_BIBITEMS).each do |b|
                    if b.at(Asciidoctor::Standoc::Converter::ISO_PUBLISHER_XPATH).nil?
                      unless /^#{GBCODE}(?![A-Z])/.match(b.at("./docidentifier").text)
                        @log.add("Bibliography", b, "#{NORM_ISO_WARN}: #{b.text}")
          Severity: Minor
          Found in lib/asciidoctor/gb/validate.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 example_table_parse has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

                def example_table_parse(node, out)
                  out.table **attr_code(id: node["id"], class: "example") do |t|
                    t.tr do |tr|
                      tr.td **EXAMPLE_TBL_ATTR do |td|
                        node.at(ns("./name")).children.each { |n| parse(n, td) }
          Severity: Minor
          Found in lib/isodoc/gb/word_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