noesya/orthotypo

View on GitHub

Showing 4 of 4 total issues

Class Composer has 32 methods (exceeds 20 allowed). Consider refactoring.
Open

  class Composer
    attr_reader :string, :ortho

    SPACE = ' '.freeze
    NBSP = ' '.freeze
Severity: Minor
Found in lib/orthotypo/composer.rb - About 4 hrs to fix

    Method preserve_precious_things has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
    Open

        def preserve_precious_things
          @precious_things = {}
          @nokogiri.traverse do |node|
            if node.text?
              has_leading_space = node.content.start_with? SPACE
    Severity: Minor
    Found in lib/orthotypo/composer.rb - About 2 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

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

        def parse_chars_with_space_before
          chars_with_space_before.each do |char|
            # Espace normal avant -> espace fine insécable avant
            fix(SPACE + char, NNBSP + char)
            # Pas d'espace avant -> espace fine insécable avant
    Severity: Minor
    Found in lib/orthotypo/composer.rb and 1 other location - About 15 mins to fix
    lib/orthotypo/composer.rb on lines 185..190

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

    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 parse_chars_with_space_around
          chars_with_space_around.each do |char|
            # Espace normal avant -> espace fine insécable avant
            fix(SPACE + char, NNBSP + char)
            # Pas d'espace avant -> espace fine insécable avant
    Severity: Minor
    Found in lib/orthotypo/composer.rb and 1 other location - About 15 mins to fix
    lib/orthotypo/composer.rb on lines 160..165

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

    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

    Severity
    Category
    Status
    Source
    Language