metanorma/metanorma

View on GitHub
lib/metanorma/compile.rb

Summary

Maintainability
B
6 hrs
Test Coverage

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

  class Compile
    # @return [Array<String>]
    attr_reader :errors, :processor

    def initialize
Severity: Minor
Found in lib/metanorma/compile.rb - About 2 hrs to fix

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

        def process_ext_simple(ext, isodoc, fnames, options, isodoc_options)
          if ext == :rxl
            relaton_export(isodoc, options.merge(relaton: fnames[:out]))
          elsif options[:passthrough_presentation_xml] && ext == :presentation
            f = File.exist?(fnames[:f]) ? fnames[:f] : fnames[:orig_filename]
    Severity: Minor
    Found in lib/metanorma/compile.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 process_ext has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        def process_ext(ext, file, isodoc, fnames, options)
    Severity: Minor
    Found in lib/metanorma/compile.rb - About 35 mins to fix

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

          def process_exts(filename, extensions, file, isodoc, options)
      Severity: Minor
      Found in lib/metanorma/compile.rb - About 35 mins to fix

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

            def process_exts_run(fnames, file, isodoc, extensions, options)
        Severity: Minor
        Found in lib/metanorma/compile.rb - About 35 mins to fix

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

              def process_exts1(ext, fnames, isodoc, options, isodoc_options)
          Severity: Minor
          Found in lib/metanorma/compile.rb - About 35 mins to fix

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

                def process_ext_simple(ext, isodoc, fnames, options, isodoc_options)
            Severity: Minor
            Found in lib/metanorma/compile.rb - About 35 mins to fix

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

                  def relaton_export(isodoc, options)
                    return unless options[:relaton]
              
                    xml = Nokogiri::XML(isodoc) { |config| config.huge }
                    bibdata = xml.at("//bibdata") || xml.at("//xmlns:bibdata")
              Severity: Minor
              Found in lib/metanorma/compile.rb and 1 other location - About 35 mins to fix
              lib/metanorma/extract.rb on lines 3..10

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

              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