metanorma/metanorma-iso

View on GitHub
lib/isodoc/iso/metadata.rb

Summary

Maintainability
B
6 hrs
Test Coverage

Class Metadata has 25 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 2 hrs to fix

    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 title has a Cognitive Complexity of 8 (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 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 subtitle has a Cognitive Complexity of 8 (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 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

      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")),
                corr: isoxml.at(ns("#{prefix}/@corrigendum")) }
      Severity: Minor
      Found in lib/isodoc/iso/metadata.rb and 1 other location - About 30 mins to fix
      lib/isodoc/iso/metadata.rb on lines 122..129

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

      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

              { 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 30 mins to fix
      lib/isodoc/iso/metadata.rb on lines 115..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 33.

      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

      There are no issues that match your filters.

      Category
      Status