maki-tetsu/anodator

View on GitHub
lib/anodator/validator/numeric_validator.rb

Summary

Maintainability
C
1 day
Test Coverage

Method validate has a Cognitive Complexity of 33 (exceeds 5 allowed). Consider refactoring.
Open

      def validate
        if allow_blank?
          return true if target_value.split(//).size.zero?
        end

Severity: Minor
Found in lib/anodator/validator/numeric_validator.rb - About 4 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

Assignment Branch Condition size for validate is too high. [38.54/15]
Open

      def validate
        if allow_blank?
          return true if target_value.split(//).size.zero?
        end

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

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

      def validate
        if allow_blank?
          return true if target_value.split(//).size.zero?
        end

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 validate is too high. [17/6]
Open

      def validate
        if allow_blank?
          return true if target_value.split(//).size.zero?
        end

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.

Perceived complexity for validate is too high. [14/7]
Open

      def validate
        if allow_blank?
          return true if target_value.split(//).size.zero?
        end

This cop tries to produce a complexity score that's a measure of the complexity the reader experiences when looking at a method. For that reason it considers when nodes as something that doesn't add as much complexity as an if or a &&. Except if it's one of those special case/when constructs where there's no expression after case. Then the cop treats it as an if/elsif/elsif... and lets all the when nodes count. In contrast to the CyclomaticComplexity cop, this cop considers else nodes as adding complexity.

Example:

def my_method                   # 1
  if cond                       # 1
    case var                    # 2 (0.8 + 4 * 0.2, rounded)
    when 1 then func_one
    when 2 then func_two
    when 3 then func_three
    when 4..10 then func_other
    end
  else                          # 1
    do_something until a && b   # 2
  end                           # ===
end                             # 7 complexity points

Method validate has 27 lines of code (exceeds 25 allowed). Consider refactoring.
Open

      def validate
        if allow_blank?
          return true if target_value.split(//).size.zero?
        end

Severity: Minor
Found in lib/anodator/validator/numeric_validator.rb - About 1 hr to fix

    Avoid too many return statements within this method.
    Open

                return false unless value < BigDecimal.new(configuration.value.to_s)
    Severity: Major
    Found in lib/anodator/validator/numeric_validator.rb - About 30 mins to fix

      Avoid too many return statements within this method.
      Open

                  return false unless value <= BigDecimal.new(configuration.value.to_s)
      Severity: Major
      Found in lib/anodator/validator/numeric_validator.rb - About 30 mins to fix

        Avoid too many return statements within this method.
        Open

                    return false unless value != BigDecimal.new(configuration.value.to_s)
        Severity: Major
        Found in lib/anodator/validator/numeric_validator.rb - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                      return false unless value == BigDecimal.new(configuration.value.to_s)
          Severity: Major
          Found in lib/anodator/validator/numeric_validator.rb - About 30 mins to fix

            Line is too long. [84/80]
            Open

                  valid_option_keys :less_than, :less_than_or_equal_to, :equal_to, :not_equal_to

            Line is too long. [81/80]
            Open

                        return false unless value == BigDecimal.new(configuration.value.to_s)

            Missing top-level class documentation comment.
            Open

                class NumericValidator < Base

            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

            Line is too long. [81/80]
            Open

                        return false unless value <= BigDecimal.new(configuration.value.to_s)

            Line is too long. [81/80]
            Open

                        return false unless value >= BigDecimal.new(configuration.value.to_s)

            Line is too long. [81/80]
            Open

                        return false unless value != BigDecimal.new(configuration.value.to_s)

            There are no issues that match your filters.

            Category
            Status