Method has too many lines. [38/30] Open
def publish(channel_key, message, opts={})
# How long should we hang on to the resource once is published?
ttl = (opts[:ttl] || TTL).to_i
buffer_size = (opts[:buffer_size] || MessageBuffer::DEFAULT_SIZE).to_i
persist = !!opts[:persist]- 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 publish is too high. [8/6] Open
def publish(channel_key, message, opts={})
# How long should we hang on to the resource once is published?
ttl = (opts[:ttl] || TTL).to_i
buffer_size = (opts[:buffer_size] || MessageBuffer::DEFAULT_SIZE).to_i
persist = !!opts[:persist]- 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 publish has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring. Open
def publish(channel_key, message, opts={})
# How long should we hang on to the resource once is published?
ttl = (opts[:ttl] || TTL).to_i
buffer_size = (opts[:buffer_size] || MessageBuffer::DEFAULT_SIZE).to_i
persist = !!opts[:persist]- 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 publish has 38 lines of code (exceeds 25 allowed). Consider refactoring. Open
def publish(channel_key, message, opts={})
# How long should we hang on to the resource once is published?
ttl = (opts[:ttl] || TTL).to_i
buffer_size = (opts[:buffer_size] || MessageBuffer::DEFAULT_SIZE).to_i
persist = !!opts[:persist]Method eval_publish_script has 6 arguments (exceeds 4 allowed). Consider refactoring. Open
def eval_publish_script(channel_key, message, ttl, buffer_size, persist, deferrable)Avoid parameter lists longer than 5 parameters. [6/5] Open
def eval_publish_script(channel_key, message, ttl, buffer_size, persist, deferrable)- Read upRead up
- Exclude checks
This cop checks for methods with too many parameters. The maximum number of parameters is configurable. Keyword arguments can optionally be excluded from the total count.
TODO found Open
# TODO hi-redis isn't that awesome... we have to setup an errback per even for wrong- Exclude checks
TODO found Open
# TODO: Make this FAR more robust. Ideally we'd whitelist the permitted- Exclude checks