Method props
has 36 lines of code (exceeds 25 allowed). Consider refactoring. Open
def props # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
{
activeDocs: api_docs_services.map do |api_doc| # rubocop:disable Metrics/BlockLength
{
id: api_doc.id,
Provider::Admin::ApiDocsIndexPresenter has at least 5 instance variables Open
class Provider::Admin::ApiDocsIndexPresenter
- Read upRead up
- Exclude checks
Too Many Instance Variables
is a special case of LargeClass
.
Example
Given this configuration
TooManyInstanceVariables:
max_instance_variables: 3
and this code:
class TooManyInstanceVariables
def initialize
@arg_1 = :dummy
@arg_2 = :dummy
@arg_3 = :dummy
@arg_4 = :dummy
end
end
Reek would emit the following warning:
test.rb -- 5 warnings:
[1]:TooManyInstanceVariables has at least 4 instance variables (TooManyInstanceVariables)
Method props
has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring. Open
def props # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
{
activeDocs: api_docs_services.map do |api_doc| # rubocop:disable Metrics/BlockLength
{
id: api_doc.id,
- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
Provider::Admin::ApiDocsIndexPresenter#props calls 'api_doc.published?' 2 times Open
title: api_doc.published? ? 'Hide' : 'Publish',
href: h.toggle_visible_admin_api_docs_service_path(api_doc)
},
edit: {
title: 'Edit',
- 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
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.
Provider::Admin::ApiDocsIndexPresenter#props performs a nil-check Open
isAudience: service.nil?
- Read upRead up
- Exclude checks
A NilCheck
is a type check. Failures of NilCheck
violate the "tell, don't ask" principle.
Additionally, type checks often mask bigger problems in your source code like not using OOP and / or polymorphism when you should.
Example
Given
class Klass
def nil_checker(argument)
if argument.nil?
puts "argument isn't nil!"
end
end
end
Reek would emit the following warning:
test.rb -- 1 warning:
[3]:Klass#nil_checker performs a nil-check. (NilCheck)