andypike/rectify

View on GitHub
lib/rectify/query.rb

Summary

Maintainability
A
0 mins
Test Coverage

Rectify::Query has no descriptive comment
Open

  class Query
Severity: Minor
Found in lib/rectify/query.rb by reek

Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.

Example

Given

class Dummy
  # Do things...
end

Reek would emit the following warning:

test.rb -- 1 warning:
  [1]:Dummy has no descriptive comment (IrresponsibleModule)

Fixing this is simple - just an explaining comment:

# The Dummy class is responsible for ...
class Dummy
  # Do things...
end

Rectify::Query#| calls 'other.cached_query' 2 times
Open

        Rectify::Query.new(cached_query.merge(other.cached_query))
      elsif eager? && other.eager?
        Rectify::Query.new(cached_query | other.cached_query)
Severity: Minor
Found in lib/rectify/query.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.

Rectify::Query#self.merge has the variable name 'a'
Open

      queries.reduce(NullQuery.new) { |a, e| a.merge(e) }
Severity: Minor
Found in lib/rectify/query.rb by reek

An Uncommunicative Variable Name is a variable name that doesn't communicate its intent well enough.

Poor names make it hard for the reader to build a mental picture of what's going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names.

Rectify::Query#self.merge has the variable name 'e'
Open

      queries.reduce(NullQuery.new) { |a, e| a.merge(e) }
Severity: Minor
Found in lib/rectify/query.rb by reek

An Uncommunicative Variable Name is a variable name that doesn't communicate its intent well enough.

Poor names make it hard for the reader to build a mental picture of what's going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names.

There are no issues that match your filters.

Category
Status