Sign upLogin

plentz/lol_dba

View on GitHub
Star
lib/lol_dba/index_finding/relation_inspector.rb

Summary

Maintainability
A
0 mins
Test Coverage

LolDba::RelationInspector#get_through_foreign_key calls 'reflection.options[:foreign_key]' 2 times
Open

      if reflection.options[:foreign_key]
        reflection.options[:foreign_key]
Severity: Minor
Found in lib/lol_dba/index_finding/relation_inspector.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.

LolDba::RelationInspector has no descriptive comment
Open

  class RelationInspector
Severity: Minor
Found in lib/lol_dba/index_finding/relation_inspector.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

LolDba::RelationInspector#get_through_foreign_key calls 'reflection.options' 2 times
Open

      if reflection.options[:foreign_key]
        reflection.options[:foreign_key]
Severity: Minor
Found in lib/lol_dba/index_finding/relation_inspector.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.

LolDba::RelationInspector#get_through_foreign_key doesn't depend on instance state (maybe move it to another class?)
Open

    def get_through_foreign_key(target_class, reflection_options)
Severity: Minor
Found in lib/lol_dba/index_finding/relation_inspector.rb by reek

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

Missing top-level class documentation comment.
Open

  class RelationInspector
Severity: Minor
Found in lib/lol_dba/index_finding/relation_inspector.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