Assignment Branch Condition size for shorten_parameters is too high. [25.42/15] Open
def shorten_parameters(params, options = {})
connection.timeout = options[:timeout] if options.key?(:timeout)
connection.open_timeout = options[:open_timeout] if options.key?(:open_timeout)
suffix_option = options[:suffix_option] if options.key?(:suffix_option)
- Read upRead up
- Exclude checks
This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric
Assignment Branch Condition size for shorten_link is too high. [20.54/15] Open
def shorten_link(link, options = {})
connection.timeout = options[:timeout] if options.key?(:timeout)
connection.open_timeout = options[:open_timeout] if options.key?(:open_timeout)
suffix_option = options[:suffix_option] if options.key?(:suffix_option)
- Read upRead up
- Exclude checks
This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric
Method has too many lines. [14/10] Open
def shorten_parameters(params, options = {})
connection.timeout = options[:timeout] if options.key?(:timeout)
connection.open_timeout = options[:open_timeout] if options.key?(:open_timeout)
suffix_option = options[:suffix_option] if options.key?(:suffix_option)
- Read upRead up
- Exclude checks
This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.
Method has too many lines. [11/10] Open
def shorten_link(link, options = {})
connection.timeout = options[:timeout] if options.key?(:timeout)
connection.open_timeout = options[:open_timeout] if options.key?(:open_timeout)
suffix_option = options[:suffix_option] if options.key?(:suffix_option)
- Read upRead up
- Exclude checks
This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.
Cyclomatic complexity for shorten_parameters is too high. [7/6] Open
def shorten_parameters(params, options = {})
connection.timeout = options[:timeout] if options.key?(:timeout)
connection.open_timeout = options[:open_timeout] if options.key?(:open_timeout)
suffix_option = options[:suffix_option] if options.key?(:suffix_option)
- Read upRead up
- Exclude checks
This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.
An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.
Method shorten_parameters
has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring. Open
def shorten_parameters(params, options = {})
connection.timeout = options[:timeout] if options.key?(:timeout)
connection.open_timeout = options[:open_timeout] if options.key?(:open_timeout)
suffix_option = options[:suffix_option] if options.key?(:suffix_option)
- 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
FirebaseDynamicLink::Client#shorten_parameters has approx 10 statements Open
def shorten_parameters(params, options = {})
- 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.)
FirebaseDynamicLink::Client#shorten_link has approx 8 statements Open
def shorten_link(link, options = {})
- 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.)
Method shorten_link
has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring. Open
def shorten_link(link, options = {})
connection.timeout = options[:timeout] if options.key?(:timeout)
connection.open_timeout = options[:open_timeout] if options.key?(:open_timeout)
suffix_option = options[:suffix_option] if options.key?(:suffix_option)
- 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
FirebaseDynamicLink::Client#shorten_parameters has the variable name 'e' Open
rescue Faraday::ConnectionFailed, Faraday::TimeoutError => 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.
FirebaseDynamicLink::Client#shorten_link has the variable name 'e' Open
rescue Faraday::ConnectionFailed, Faraday::TimeoutError => 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.
Line is too long. [89/80] Open
# @see FirebaseDynamicLink::LinkRenderer#render LinkRenderer#render for returned Hash
- Exclude checks
Line is too long. [85/80] Open
connection.open_timeout = options[:open_timeout] if options.key?(:open_timeout)
- Exclude checks
Line is too long. [97/80] Open
'Dynamic link domain is empty')
- Exclude checks
Line is too long. [87/80] Open
params = CaseTransform2.camel_lower(long_dynamic_link: build_link(link, options),
- Exclude checks
Line is too long. [97/80] Open
'Dynamic link domain is empty')
- Exclude checks
Line is too long. [89/80] Open
option: suffix_option || config.suffix_option
- Exclude checks
Line is too long. [85/80] Open
connection.open_timeout = options[:open_timeout] if options.key?(:open_timeout)
- Exclude checks
Line is too long. [93/80] Open
# * :open_timeout [Integer] optional, default is FirebaseDynamicLink.config.open_timout
- Exclude checks
Line is too long. [107/80] Open
# * :dynamic_link_domain [String] optional, default is FirebaseDynamicLink.config.dynamic_link_domain
- Exclude checks
Line is too long. [89/80] Open
option: suffix_option || config.suffix_option
- Exclude checks
Line is too long. [112/80] Open
params = CaseTransform2.camel_lower(dynamic_link_info: params.merge(domainUriPrefix: dynamic_link_domain),
- Exclude checks
Line is too long. [101/80] Open
dynamic_link_domain ||= config.dynamic_link_domain || raise(FirebaseDynamicLink::InvalidConfig,
- Exclude checks
Line is too long. [95/80] Open
# * :suffix_option [String] optional, default is FirebaseDynamicLink.config.suffix_option
- Exclude checks
Line is too long. [89/80] Open
# @see FirebaseDynamicLink::LinkRenderer#render LinkRenderer#render for returned Hash
- Exclude checks
Line is too long. [101/80] Open
dynamic_link_domain ||= config.dynamic_link_domain || raise(FirebaseDynamicLink::InvalidConfig,
- Exclude checks