Showing 19 of 19 total issues
Method get_distance
has a Cognitive Complexity of 26 (exceeds 5 allowed). Consider refactoring. Open
def get_distance(s1, s2)
a1 = s1.split(//)
a2 = s2.split(//)
max, min = s1.size > s2.size ? [a1, a2] : [a2, a1]
- 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
Method get_distance
has 50 lines of code (exceeds 25 allowed). Consider refactoring. Open
def get_distance(s1, s2)
a1 = s1.split(//)
a2 = s2.split(//)
max, min = s1.size > s2.size ? [a1, a2] : [a2, a1]
Method similarity_phone
has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring. Open
def similarity_phone p1, p2
return { full: 1.0,
distances: [1.0],
result: true } if p1 == p2 # exact match
- 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
Method similarity_phone
has 29 lines of code (exceeds 25 allowed). Consider refactoring. Open
def similarity_phone p1, p2
return { full: 1.0,
distances: [1.0],
result: true } if p1 == p2 # exact match
Method similarity_email
has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Open
def similarity_email e1, e2
return { full: 1.0,
name: 1.0,
domain: 1.0,
result: true } if e1 == e2
- 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
Use warn
instead of $stderr.puts
to allow such output to be disabled. Open
$stderr.puts 'Run `bundle install` to install missing gems'
- Read upRead up
- Exclude checks
This cop identifies places where $stderr.puts
can be replaced by
warn
. The latter has the advantage of easily being disabled by,
e.g. the -W0 interpreter flag, or setting $VERBOSE to nil.
Example:
# bad
$stderr.puts('hello')
# good
warn('hello')
Favor a normal if-statement over a modifier clause in a multiline statement. Open
return { full: 1.0,
name: 1.0,
domain: 1.0,
result: true } if e1 == e2
- Read upRead up
- Exclude checks
Checks for uses of if/unless modifiers with multiple-lines bodies.
Example:
# bad
{
result: 'this should not happen'
} unless cond
# good
{ result: 'ok' } if cond
Unnecessary utf-8 encoding comment. Open
# coding: utf-8
- Exclude checks
%w
-literals should be delimited by [
and ]
. Open
COMPANY_NAME_STOP_WORDS = %w(ltd gmbh inc).freeze
- Read upRead up
- Exclude checks
This cop enforces the consistent usage of %
-literal delimiters.
Specify the 'default' key to set all preferred delimiters at once. You can continue to specify individual preferred delimiters to override the default.
Example:
# Style/PercentLiteralDelimiters:
# PreferredDelimiters:
# default: '[]'
# '%i': '()'
# good
%w[alpha beta] + %i(gamma delta)
# bad
%W(alpha #{beta})
# bad
%I(alpha beta)
Add an empty line after magic comments. Open
require 'rubygems'
- Read upRead up
- Exclude checks
Checks for a newline after the final magic comment.
Example:
# good
# frozen_string_literal: true
# Some documentation for Person
class Person
# Some code
end
# bad
# frozen_string_literal: true
# Some documentation for Person
class Person
# Some code
end
Use matches.zero?
instead of 0 == matches
. Open
if 0 == matches
- Read upRead up
- Exclude checks
This cop checks for usage of comparison operators (==
,
>
, <
) to test numbers as zero, positive, or negative.
These can be replaced by their respective predicate methods.
The cop can also be configured to do the reverse.
The cop disregards #nonzero?
as it its value is truthy or falsey,
but not true
and false
, and thus not always interchangeable with
!= 0
.
The cop ignores comparisons to global variables, since they are often
populated with objects which can be compared with integers, but are
not themselves Interger
polymorphic.
Example: EnforcedStyle: predicate (default)
# bad
foo == 0
0 > foo
bar.baz > 0
# good
foo.zero?
foo.negative?
bar.baz.positive?
Example: EnforcedStyle: comparison
# bad
foo.zero?
foo.negative?
bar.baz.positive?
# good
foo == 0
0 > foo
bar.baz > 0
Favor a normal if-statement over a modifier clause in a multiline statement. Open
return { full: 1.0,
distances: [1.0],
result: true } if p1 == p2 # exact match
- Read upRead up
- Exclude checks
Checks for uses of if/unless modifiers with multiple-lines bodies.
Example:
# bad
{
result: 'this should not happen'
} unless cond
# good
{ result: 'ok' } if cond
Reverse the order of the operands 0 == matches
. Open
if 0 == matches
- Read upRead up
- Exclude checks
This cop checks for Yoda conditions, i.e. comparison operations where readability is reduced because the operands are not ordered the same way as they would be ordered in spoken English.
Example: EnforcedStyle: allcomparisonoperators (default)
# bad
99 == foo
"bar" != foo
42 >= foo
10 < bar
# good
foo == 99
foo == "bar"
foo <= 42
bar > 10
Example: EnforcedStyle: equalityoperatorsonly
# bad
99 == foo
"bar" != foo
# good
99 >= foo
3 < a && a < 5
Dependencies should be sorted in an alphabetical order within their section of the gemspec. Dependency pry
should appear before rspec
. Open
spec.add_development_dependency 'pry', '~> 0.10'
- Read upRead up
- Exclude checks
Dependencies in the gemspec should be alphabetically sorted.
Example:
# bad
spec.add_dependency 'rubocop'
spec.add_dependency 'rspec'
# good
spec.add_dependency 'rspec'
spec.add_dependency 'rubocop'
# good
spec.add_dependency 'rubocop'
spec.add_dependency 'rspec'
# bad
spec.add_development_dependency 'rubocop'
spec.add_development_dependency 'rspec'
# good
spec.add_development_dependency 'rspec'
spec.add_development_dependency 'rubocop'
# good
spec.add_development_dependency 'rubocop'
spec.add_development_dependency 'rspec'
# bad
spec.add_runtime_dependency 'rubocop'
spec.add_runtime_dependency 'rspec'
# good
spec.add_runtime_dependency 'rspec'
spec.add_runtime_dependency 'rubocop'
# good
spec.add_runtime_dependency 'rubocop'
spec.add_runtime_dependency 'rspec'
# good only if TreatCommentsAsGroupSeparators is true
# For code quality
spec.add_dependency 'rubocop'
# For tests
spec.add_dependency 'rspec'
Unnecessary utf-8 encoding comment. Open
# encoding: UTF-8
- Exclude checks
Add an empty line after magic comments. Open
lib = File.expand_path('../lib', __FILE__)
- Read upRead up
- Exclude checks
Checks for a newline after the final magic comment.
Example:
# good
# frozen_string_literal: true
# Some documentation for Person
class Person
# Some code
end
# bad
# frozen_string_literal: true
# Some documentation for Person
class Person
# Some code
end
Favor a normal if-statement over a modifier clause in a multiline statement. Open
return { full: 1.0,
distances: [1.0] * c1.split(/\s+/).size,
matches: c1.split(/\s+/).size,
result: true } if c1 == c2 # exact match
- Read upRead up
- Exclude checks
Checks for uses of if/unless modifiers with multiple-lines bodies.
Example:
# bad
{
result: 'this should not happen'
} unless cond
# good
{ result: 'ok' } if cond
Use warn
instead of $stderr.puts
to allow such output to be disabled. Open
$stderr.puts e.message
- Read upRead up
- Exclude checks
This cop identifies places where $stderr.puts
can be replaced by
warn
. The latter has the advantage of easily being disabled by,
e.g. the -W0 interpreter flag, or setting $VERBOSE to nil.
Example:
# bad
$stderr.puts('hello')
# good
warn('hello')
TODO found Open
# spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
- Exclude checks