Sapristi::DefinitionParser#validate_work_area refers to 'normalized' more than self (maybe move it to another class?) Open
x_pos = normalized.x
y_pos = normalized.y
x_end = x_pos + normalized.width
y_end = y_pos + normalized.height
- 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.
Sapristi::DefinitionParser#validate_work_area has approx 7 statements Open
def validate_work_area(normalized, monitor_width, monitor_height)
- Read upRead up
- Exclude checks
A method with Too Many Statements
is any method that has a large number of lines.
Too Many Statements
warns about any method that has more than 5 statements. Reek's smell detector for Too Many Statements
counts +1 for every simple statement in a method and +1 for every statement within a control structure (if
, else
, case
, when
, for
, while
, until
, begin
, rescue
) but it doesn't count the control structure itself.
So the following method would score +6 in Reek's statement-counting algorithm:
def parse(arg, argv, &error)
if !(val = arg) and (argv.empty? or /\A-/ =~ (val = argv[0]))
return nil, block, nil # +1
end
opt = (val = parse_arg(val, &error))[1] # +2
val = conv_arg(*val) # +3
if opt and !arg
argv.shift # +4
else
val[0] = nil # +5
end
val # +6
end
(You might argue that the two assigments within the first @if@ should count as statements, and that perhaps the nested assignment should count as +2.)
Use Range#cover?
instead of Range#include?
. Open
unless (0...monitor_width).include? x_pos
- Read upRead up
- Exclude checks
This cop identifies uses of Range#include?
, which iterates over each
item in a Range
to see if a specified item is there. In contrast,
Range#cover?
simply compares the target item with the beginning and
end points of the Range
. In a great majority of cases, this is what
is wanted.
Here is an example of a case where Range#cover?
may not provide the
desired result:
('a'..'z').cover?('yellow') # => true
Use Range#cover?
instead of Range#include?
. Open
return if (0...monitor_height).include? y_pos
- Read upRead up
- Exclude checks
This cop identifies uses of Range#include?
, which iterates over each
item in a Range
to see if a specified item is there. In contrast,
Range#cover?
simply compares the target item with the beginning and
end points of the Range
. In a great majority of cases, this is what
is wanted.
Here is an example of a case where Range#cover?
may not provide the
desired result:
('a'..'z').cover?('yellow') # => true
Line is too long. [112/80] Open
raise Error, "window x dimensions: [#{x_pos}, #{x_end}] exceeds monitor width [0..#{monitor_width - 1}]"
- Exclude checks
Line is too long. [105/80] Open
raise Error, "window y size=#{window_height} less than #{MIN_Y_SIZE}" if window_height < MIN_Y_SIZE
- Exclude checks
Line is too long. [95/80] Open
raise Error, "x=#{x_pos} is outside of monitor width dimension=0..#{monitor_width - 1}"
- Exclude checks
Line is too long. [112/80] Open
raise Error, "window y dimensions: [#{y_pos}, #{y_end}] exceeds monitor height [0..#{monitor_height - 1}]"
- Exclude checks
Line is too long. [95/80] Open
raise Error, "y=#{y_pos} is outside of monitor height dimension=0..#{monitor_height - 1}"
- Exclude checks
Line is too long. [103/80] Open
raise Error, "window x size=#{window_width} less than #{MIN_X_SIZE}" if window_width < MIN_X_SIZE
- Exclude checks