Sign upLogin

friendsoftheweb/woff-rb

View on GitHub
Star
lib/woff/builder.rb

Summary

Maintainability
B
6 hrs
Test Coverage

Method font_with_metadata has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
Open

    def font_with_metadata(licensee: nil, license_id: nil, license_text: nil, description: nil)
      metadata_xml = data.metadata.length > 0 ? compressor.inflate(data.metadata) : default_metadata
      metadata_doc = REXML::Document.new(metadata_xml)

      if licensee
Severity: Minor
Found in lib/woff/builder.rb - About 3 hrs 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 has too many lines. [45/30]
Open

    def font_with_metadata(licensee: nil, license_id: nil, license_text: nil, description: nil)
      metadata_xml = data.metadata.length > 0 ? compressor.inflate(data.metadata) : default_metadata
      metadata_doc = REXML::Document.new(metadata_xml)

      if licensee
Severity: Minor
Found in lib/woff/builder.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Cyclomatic complexity for font_with_metadata is too high. [12/6]
Open

    def font_with_metadata(licensee: nil, license_id: nil, license_text: nil, description: nil)
      metadata_xml = data.metadata.length > 0 ? compressor.inflate(data.metadata) : default_metadata
      metadata_doc = REXML::Document.new(metadata_xml)

      if licensee
Severity: Minor
Found in lib/woff/builder.rb by rubocop

This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.

An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.

Method font_with_metadata has 45 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def font_with_metadata(licensee: nil, license_id: nil, license_text: nil, description: nil)
      metadata_xml = data.metadata.length > 0 ? compressor.inflate(data.metadata) : default_metadata
      metadata_doc = REXML::Document.new(metadata_xml)

      if licensee
Severity: Minor
Found in lib/woff/builder.rb - About 1 hr to fix

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

          if description
        description_el = metadata_doc.root.elements["description"]
        unless description_el
          description_el = metadata_doc.root.add_element "description"
        end
    Severity: Minor
    Found in lib/woff/builder.rb and 1 other location - About 30 mins to fix
    lib/woff/builder.rb on lines 37..48

    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

          if license_text
        license_el = metadata_doc.root.elements["license"]
        unless license_el
          license_el = metadata_doc.root.add_element "license"
        end
    Severity: Minor
    Found in lib/woff/builder.rb and 1 other location - About 30 mins to fix
    lib/woff/builder.rb on lines 51..62

    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