Method top_clients has 34 lines of code (exceeds 25 allowed). Consider refactoring. Open
def top_clients(options)
# TODO: optimize cinstance lookup
since = extract_since(options) # normalizes since to the beginning of period
range, granularity, metric = extract_range_and_granularity_and_metric(options.merge(since: since))
data = top(:cinstances, options) do |id, value|Stats::Service#top_clients refers to 'cinstance' more than self (maybe move it to another class?) Open
if cinstance && cinstance.user_account
{
:name => cinstance.name,
:id => cinstance.id,
:value => value,- 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
endwould 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.
Stats::Service#top_countries refers to 'country' more than self (maybe move it to another class?) Open
{:country_name => country.name,
:country_code => country.code,- 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
endwould 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.
Stats::Service#top_clients calls 'cinstance.plan' 2 times Open
:id => cinstance.plan.id,
:name => cinstance.plan.name- Read upRead up
- Exclude checks
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
endOne quick approach to silence Reek would be to refactor the code thus:
def double_thing()
thing = @other.thing
thing + thing
endA 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
endThe approach you take will depend on balancing other factors in your code.
Stats::Service#top_clients calls 'cinstance.user_account' 3 times Open
if cinstance && cinstance.user_account
{
:name => cinstance.name,
:id => cinstance.id,
:value => value,- Read upRead up
- Exclude checks
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
endOne quick approach to silence Reek would be to refactor the code thus:
def double_thing()
thing = @other.thing
thing + thing
endA 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
endThe approach you take will depend on balancing other factors in your code.