Sign upLogin

nbirnel/bread-calculator

View on GitHub
Star

Showing 5 of 5 total issues

File bread_calculator.rb has 259 lines of code (exceeds 250 allowed). Consider refactoring.
Open

def human_round number, base_precision = 0
  #FIXME there is an algorithm for this. What is it?
  precision = base_precision
  if number < 10
    precision = base_precision + 1
Severity: Minor
Found in lib/bread_calculator.rb - About 2 hrs to fix

    Method parse has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

        def parse input

      while line = input.gets
        new_step              && next if line =~ /(^-)|(^\s*$)/
        preprocess_meta(line) && next if @in_prelude
    Severity: Minor
    Found in lib/bread_calculator.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

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

        def to_html
      #FIXME refactor with to_s
      out = ''
      self.metadata.each{|k,v| out << "<p>\n<b>#{k}</b>: #{v}\n</p>\n"}
      out << "--------------------\n"
    Severity: Minor
    Found in lib/bread_calculator.rb and 1 other location - About 25 mins to fix
    lib/bread_calculator.rb on lines 281..286

    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 to_s
      out = ''
      self.metadata.each{|k,v| out << "#{k}: #{v}\n"}
      out << "--------------------\n"
      self.steps.each{|s| out << s.to_s }
    Severity: Minor
    Found in lib/bread_calculator.rb and 1 other location - About 25 mins to fix
    lib/bread_calculator.rb on lines 293..299

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

        def line_to_ingredient match
      h = Hash.new
      liquids   = Regexp.union ['water', 'egg', 'mashed', 'milk']
      additives = Regexp.union ['dry', 'powdered']
    Severity: Minor
    Found in lib/bread_calculator.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