Api::V1::StatusController#check_status refers to 'response_hash' more than self (maybe move it to another class?) Open
response_hash[:dependencies] = %w[SendGrid Postgres]
response_hash[:status] = everything_ok? ? 'ok' : 'NOT OK'
response_hash[:updated] = Time.zone.now.to_i
- Read upRead up
- Exclude checks
Feature Envy occurs when a code fragment references another object more often than it references itself, or when several clients do the same series of manipulations on a particular type of object.
Feature Envy reduces the code's ability to communicate intent: code that "belongs" on one class but which is located in another can be hard to find, and may upset the "System of Names" in the host class.
Feature Envy also affects the design's flexibility: A code fragment that is in the wrong class creates couplings that may not be natural within the application's domain, and creates a loss of cohesion in the unwilling host class.
Feature Envy often arises because it must manipulate other objects (usually its arguments) to get them into a useful form, and one force preventing them (the arguments) doing this themselves is that the common knowledge lives outside the arguments, or the arguments are of too basic a type to justify extending that type. Therefore there must be something which 'knows' about the contents or purposes of the arguments. That thing would have to be more than just a basic type, because the basic types are either containers which don't know about their contents, or they are single objects which can't capture their relationship with their fellows of the same type. So, this thing with the extra knowledge should be reified into a class, and the utility method will most likely belong there.
Example
Running Reek on:
class Warehouse
def sale_price(item)
(item.price - item.rebate) * @vat
end
end
would report:
Warehouse#total_price refers to item more than self (FeatureEnvy)
since this:
(item.price - item.rebate)
belongs to the Item class, not the Warehouse.
Api::V1::StatusController#database_okay? doesn't depend on instance state (maybe move it to another class?) Open
def database_okay?
- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
Api::V1::StatusController#search_okay? doesn't depend on instance state (maybe move it to another class?) Open
def search_okay?
- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
Api::V1 has the name 'V1' Open
module V1
- Read upRead up
- Exclude checks
An Uncommunicative Module Name
is a module 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.