wycleffsean/haypub

View on GitHub
lib/payhub/attributes.rb

Summary

Maintainability
A
2 hrs
Test Coverage

Method has too many lines. [19/10]
Open

  def coerce(val)
    case val
    when :sun, :sunday
      return 1
    when :mon, :monday
Severity: Minor
Found in lib/payhub/attributes.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 coerce is too high. [9/6]
Open

  def coerce(val)
    case val
    when :sun, :sunday
      return 1
    when :mon, :monday
Severity: Minor
Found in lib/payhub/attributes.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.

Avoid too many return statements within this method.
Open

      return 6
Severity: Major
Found in lib/payhub/attributes.rb - About 30 mins to fix

    Avoid too many return statements within this method.
    Open

          return val
    Severity: Major
    Found in lib/payhub/attributes.rb - About 30 mins to fix

      Avoid too many return statements within this method.
      Open

            return 5
      Severity: Major
      Found in lib/payhub/attributes.rb - About 30 mins to fix

        Avoid too many return statements within this method.
        Open

              return 7
        Severity: Major
        Found in lib/payhub/attributes.rb - About 30 mins to fix

          Provide an exception class and message as arguments to raise.
          Open

              raise ArgumentError.new('unknown day')
          Severity: Minor
          Found in lib/payhub/attributes.rb by rubocop

          This cop checks the args passed to fail and raise. For exploded style (default), it recommends passing the exception class and message to raise, rather than construct an instance of the error. It will still allow passing just a message, or the construction of an error with more than one argument.

          The exploded style works identically, but with the addition that it will also suggest constructing error objects when the exception is passed multiple arguments.

          Example: EnforcedStyle: exploded (default)

          # bad
          raise StandardError.new("message")
          
          # good
          raise StandardError, "message"
          fail "message"
          raise MyCustomError.new(arg1, arg2, arg3)
          raise MyKwArgError.new(key1: val1, key2: val2)

          Example: EnforcedStyle: compact

          # bad
          raise StandardError, "message"
          raise RuntimeError, arg1, arg2, arg3
          
          # good
          raise StandardError.new("message")
          raise MyCustomError.new(arg1, arg2, arg3)
          fail "message"

          Missing top-level class documentation comment.
          Open

          class DayInteger < Virtus::Attribute
          Severity: Minor
          Found in lib/payhub/attributes.rb by rubocop

          This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

          The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

          Example:

          # bad
          class Person
            # ...
          end
          
          # good
          # Description/Explanation of Person class
          class Person
            # ...
          end

          There are no issues that match your filters.

          Category
          Status