Showing 11 of 11 total issues
File request_builder_spec.rb
has 265 lines of code (exceeds 250 allowed). Consider refactoring. Open
require 'swagger_helper'
RSpec.describe RSpec::Rails::Swagger::RequestBuilder do
describe '#initialize' do
it 'stores metadata and instance' do
Method response
has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring. Open
def response status_code, attributes = {}, &block
attributes.symbolize_keys!
validate_status_code! status_code
validate_description! attributes[:description]
- 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 response
has 30 lines of code (exceeds 25 allowed). Consider refactoring. Open
def response status_code, attributes = {}, &block
attributes.symbolize_keys!
validate_status_code! status_code
validate_description! attributes[:description]
Method parameter_values
has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring. Open
def parameter_values location
values = parameters(location).
map{ |_, p| p['$ref'] ? document.resolve_ref(p['$ref']) : p }.
select{ |p| p[:required] || instance.respond_to?(p[:name]) }.
map{ |p| [p[:name], instance.send(p[:name])] }
- 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
Useless assignment to variable - response
. Open
response = response_for(operation, metadata[:swagger_response])
- Read upRead up
- Exclude checks
This cop checks for every useless assignment to local variable in every
scope.
The basic idea for this cop was from the warning of ruby -cw
:
assigned but unused variable - foo
Currently this cop has advanced logic that detects unreferenced reassignments and properly handles varied cases such as branch, loop, rescue, ensure, etc.
Example:
# bad
def some_method
some_var = 1
do_something
end
Example:
# good
def some_method
some_var = 1
do_something(some_var)
end
Missing space after #
. Open
#TODO template might be a $ref
- Read upRead up
- Exclude checks
This cop checks whether comments have a leading space after the
#
denoting the start of the comment. The leading space is not
required for some RDoc special syntax, like #++
, #--
,
#:nodoc
, =begin
- and =end
comments, "shebang" directives,
or rackup options.
Example:
# bad
#Some comment
# good
# Some comment
TODO found Open
# TODO: see if we can get the caller to show up in the error
- Exclude checks
TODO found Open
#TODO template might be a $ref
- Exclude checks
FIXME found Open
/media1/{shortcode}: #FIXME: correct path is /media/{shortcode}
- Exclude checks
TODO found Open
# TODO: It's really inefficient to keep recreating this. It'd be nice
- Exclude checks
TODO found Open
# TODO: do we need to do some capitalization to match the rack
- Exclude checks