Showing 10 of 10 total issues
Nutrella::TaskBoard#initialize refers to 'configuration' more than self (maybe move it to another class?) Open
trello_client.consumer_key = configuration.fetch(:key)
trello_client.consumer_secret = configuration.fetch(:secret)
trello_client.oauth_token = configuration.fetch(:token)
trello_client.oauth_token_secret = configuration.fetch(:secret)
end- 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.
Nutrella::TaskBoard#initialize calls 'configuration.fetch(:secret)' 2 times Open
trello_client.consumer_secret = configuration.fetch(:secret)
trello_client.oauth_token = configuration.fetch(:token)
trello_client.oauth_token_secret = configuration.fetch(:secret)- 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.
Nutrella::DeveloperKeys#open_authorization_url doesn't depend on instance state (maybe move it to another class?) Open
def open_authorization_url(options = {})- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
Nutrella::DeveloperKeys#open_public_key_url doesn't depend on instance state (maybe move it to another class?) Open
def open_public_key_url- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
Nutrella::TaskBoard#matching_boards doesn't depend on instance state (maybe move it to another class?) Open
def matching_boards(board_name)- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
Nutrella::Command#trello_url doesn't depend on instance state (maybe move it to another class?) Open
def trello_url(http_url)- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
Nutrella::Cache#cached_entries has the variable name 'k' Open
entries = cache_contents.reject { |k, _v| k == key }- Read upRead up
- Exclude checks
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.
Nutrella::Cache#lookup has the variable name 'k' Open
cache_contents.find { |k, _v| k == key }.last- Read upRead up
- Exclude checks
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.
Nutrella::Cache#search has the variable name 'k' Open
cache_contents.find { |k, _v| search_reg_exp.match?(k) }.last- Read upRead up
- Exclude checks
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.
Nutrella::Configuration#load_configuration has the variable name 'e' Open
rescue => e- Read upRead up
- Exclude checks
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.