Assignment Branch Condition size for get_revisions_from_lines is too high. [37.82/15] Open
def get_revisions_from_lines(lines, search = nil, branch = nil, limit = nil)
check_type __callee__, 'lines', lines.is_a?(Array)
lines.each_with_index do |line, index|
check_type __callee__, format('lines[%<index>d]', index: index), line.is_a?(String)
end
- 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. [25/10] Open
def get_revisions_from_lines(lines, search = nil, branch = nil, limit = nil)
check_type __callee__, 'lines', lines.is_a?(Array)
lines.each_with_index do |line, index|
check_type __callee__, format('lines[%<index>d]', index: index), line.is_a?(String)
end
- 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.
Assignment Branch Condition size for add_dates_to_revisions is too high. [17.58/15] Open
def add_dates_to_revisions(revisions, github, git_user = nil, git_repo = nil)
check_type __callee__, 'revisions', revisions.is_a?(Hash)
check_type __callee__, 'github', github.is_a?(Capistrano::Committed::GithubApi)
git_user = check_git_user(git_user)
git_repo = check_git_repo(git_repo)
- 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 get_revisions_from_lines
has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring. Open
def get_revisions_from_lines(lines, search = nil, branch = nil, limit = nil)
check_type __callee__, 'lines', lines.is_a?(Array)
lines.each_with_index do |line, index|
check_type __callee__, format('lines[%<index>d]', index: index), line.is_a?(String)
end
- 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 add_dates_to_revisions
has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring. Open
def add_dates_to_revisions(revisions, github, git_user = nil, git_repo = nil)
check_type __callee__, 'revisions', revisions.is_a?(Hash)
check_type __callee__, 'github', github.is_a?(Capistrano::Committed::GithubApi)
git_user = check_git_user(git_user)
git_repo = check_git_repo(git_repo)
- 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
Missing magic comment # frozen_string_literal: true
. Open
require 'capistrano/committed/version'
- Read upRead up
- Exclude checks
This cop is designed to help upgrade to Ruby 3.0. It will add the
comment # frozen_string_literal: true
to the top of files to
enable frozen string literals. Frozen string literals may be default
in Ruby 3.0. The comment will be added below a shebang and encoding
comment. The frozen string literal comment is only valid in Ruby 2.3+.
Example: EnforcedStyle: when_needed (default)
# The `when_needed` style will add the frozen string literal comment
# to files only when the `TargetRubyVersion` is set to 2.3+.
# bad
module Foo
# ...
end
# good
# frozen_string_literal: true
module Foo
# ...
end
Example: EnforcedStyle: always
# The `always` style will always add the frozen string literal comment
# to a file, regardless of the Ruby version or if `freeze` or `<<` are
# called on a string literal.
# bad
module Bar
# ...
end
# good
# frozen_string_literal: true
module Bar
# ...
end
Example: EnforcedStyle: never
# The `never` will enforce that the frozen string literal comment does
# not exist in a file.
# bad
# frozen_string_literal: true
module Baz
# ...
end
# good
module Baz
# ...
end
Replace class var @@settings with a class instance var. Open
merge.nil? ? @@settings = settings : @@settings.merge!(settings)
- Read upRead up
- Exclude checks
This cop checks for uses of class variables. Offenses are signaled only on assignment to class variables to reduce the number of offenses that would be reported.
Replace class var @@settings with a class instance var. Open
@@settings = {}
- Read upRead up
- Exclude checks
This cop checks for uses of class variables. Offenses are signaled only on assignment to class variables to reduce the number of offenses that would be reported.