Sign upLogin

codeforamerica/ohana-api

View on GitHub
Star
app/validators/array_validator.rb

Summary

Maintainability
A
35 mins
Test Coverage
A
93%

Method validate has a Cognitive Complexity of 8 (exceeds 6 allowed). Consider refactoring.
Open

    def validate(value)
      @validators.each do |validator|
        next if value.nil? && validator.options[:allow_nil]
        next if value.blank? && validator.options[:allow_blank]
Severity: Minor
Found in app/validators/array_validator.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

ArrayValidator::Helper#validate calls 'validator.options' 2 times
Open

        next if value.nil? && validator.options[:allow_nil]
        next if value.blank? && validator.options[:allow_blank]
Severity: Minor
Found in app/validators/array_validator.rb by reek

Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

Reek implements a check for Duplicate Method Call.

Example

Here's a very much simplified and contrived example. The following method will report a warning:

def double_thing()
  @other.thing + @other.thing
end

One quick approach to silence Reek would be to refactor the code thus:

def double_thing()
  thing = @other.thing
  thing + thing
end

A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

class Other
  def double_thing()
    thing + thing
  end
end

The approach you take will depend on balancing other factors in your code.

ArrayValidator#validator_class doesn't depend on instance state (maybe move it to another class?)
Open

  def validator_class(key)
Severity: Minor
Found in app/validators/array_validator.rb by reek

A Utility Function is any instance method that has no dependency on the state of the instance.

ArrayValidator::Helper#validate performs a nil-check
Open

        next if value.nil? && validator.options[:allow_nil]
Severity: Minor
Found in app/validators/array_validator.rb by reek

A NilCheck is a type check. Failures of NilCheck violate the "tell, don't ask" principle.

Additionally, type checks often mask bigger problems in your source code like not using OOP and / or polymorphism when you should.

Example

Given

class Klass
  def nil_checker(argument)
    if argument.nil?
      puts "argument isn't nil!"
    end
  end
end

Reek would emit the following warning:

test.rb -- 1 warning:
  [3]:Klass#nil_checker performs a nil-check. (NilCheck)

There are no issues that match your filters.

Category
Status