andypike/rectify

View on GitHub
lib/rectify/build_form_from_model.rb

Summary

Maintainability
A
0 mins
Test Coverage

Rectify::BuildFormFromModel#build calls 'a.name' 2 times
Open

          model_value = model.public_send(a.name)
          form.public_send("#{a.name}=", a.value_from(model_value))
Severity: Minor
Found in lib/rectify/build_form_from_model.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::BuildFormFromModel has no descriptive comment
Open

  class BuildFormFromModel
Severity: Minor
Found in lib/rectify/build_form_from_model.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::BuildFormFromModel#matching_attributes manually dispatches method call
Open

        .select { |a| model.respond_to?(a.name) }
Severity: Minor
Found in lib/rectify/build_form_from_model.rb by reek

Reek reports a Manual Dispatch smell if it finds source code that manually checks whether an object responds to a method before that method is called. Manual dispatch is a type of Simulated Polymorphism which leads to code that is harder to reason about, debug, and refactor.

Example

class MyManualDispatcher
  attr_reader :foo

  def initialize(foo)
    @foo = foo
  end

  def call
    foo.bar if foo.respond_to?(:bar)
  end
end

Reek would emit the following warning:

test.rb -- 1 warning:
  [9]: MyManualDispatcher manually dispatches method call (ManualDispatch)

Rectify::BuildFormFromModel#matching_attributes has the variable name 'a'
Open

        .select { |a| model.respond_to?(a.name) }
        .map    { |a| FormAttribute.new(a) }
Severity: Minor
Found in lib/rectify/build_form_from_model.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::BuildFormFromModel#build has the variable name 'a'
Open

        matching_attributes.each do |a|
Severity: Minor
Found in lib/rectify/build_form_from_model.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