iainbeeston/nickel

View on GitHub
lib/nickel/ztime.rb

Summary

Maintainability
D
1 day
Test Coverage

Class ZTime has 47 methods (exceeds 20 allowed). Consider refactoring.
Open

  class ZTime
    include Comparable

    # \@firm will be used to indicate user provided am/pm
    attr_accessor :firm
Severity: Minor
Found in lib/nickel/ztime.rb - About 6 hrs to fix

    File ztime.rb has 266 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    require 'time'
    
    module Nickel
      class ZTime
        include Comparable
    Severity: Minor
    Found in lib/nickel/ztime.rb - About 2 hrs to fix

      Method modify_such_that_is_before has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
      Open

          def modify_such_that_is_before(time2)
            fail 'ZTime#modify_such_that_is_before says: trying to modify time that has @firm set' if @firm
            fail 'ZTime#modify_such_that_is_before says: time2 does not have @firm set' unless time2.firm
            # self cannot have @firm set, so all hours will be between 1 and 12
            # time2 is an end time, self could be its current setting, or off by 12 hours
      Severity: Minor
      Found in lib/nickel/ztime.rb - About 1 hr 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 modify_such_that_is_after has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
      Open

          def modify_such_that_is_after(time1)
            fail 'ZTime#modify_such_that_is_after says: trying to modify time that has @firm set' if @firm
            fail 'ZTime#modify_such_that_is_after says: time1 does not have @firm set' unless time1.firm
            # time1 to self --> time1 to self
            # 8pm   to 835  --> 2000 to 835
      Severity: Minor
      Found in lib/nickel/ztime.rb - About 1 hr 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 am_pm_modifier has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Open

            def am_pm_modifier(*time_array)
              # find firm time indices
              firm_time_indices = []
              time_array.each_with_index { |t, i| firm_time_indices << i if t.firm }
      
      
      Severity: Minor
      Found in lib/nickel/ztime.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 interpret has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

            def interpret(str)
              a_b   = /^(\d{1,4})(am|pm)?$/                     # handles cases (a) and (b)
              c_d_e = /^(\d{1,2}):(\d{1,2})(am|pm)?$/           # handles cases (c), (d), and (e)
              if mdata = str.match(a_b)
                am_pm = mdata[2]
      Severity: Minor
      Found in lib/nickel/ztime.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 adjust_for has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

          def adjust_for(am_pm)
            # how does validation work?  Well, we already know that @time is valid, and once we modify we call time= which will
            # perform validation on the new time.  That won't catch something like this though:  ZTime.new("2215", :am)
            # so we will check for that here.
            # If user is providing :am or :pm, the hour must be between 1 and 12
      Severity: Minor
      Found in lib/nickel/ztime.rb - About 35 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 4 locations. Consider refactoring.
      Open

          def after?(other)
            (hour > other.hour) || (hour == other.hour && (min > other.min || (min == other.min && sec > other.sec)))
          end
      Severity: Minor
      Found in lib/nickel/ztime.rb and 3 other locations - About 15 mins to fix
      lib/nickel/zdate.rb on lines 558..560
      lib/nickel/zdate.rb on lines 562..564
      lib/nickel/ztime.rb on lines 348..350

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

      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 4 locations. Consider refactoring.
      Open

          def before?(other)
            (hour < other.hour) || (hour == other.hour && (min < other.min || (min == other.min && sec < other.sec)))
          end
      Severity: Minor
      Found in lib/nickel/ztime.rb and 3 other locations - About 15 mins to fix
      lib/nickel/zdate.rb on lines 558..560
      lib/nickel/zdate.rb on lines 562..564
      lib/nickel/ztime.rb on lines 352..354

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

      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