Cyclomatic complexity for createAttribute is too high. [14/11] Open
def createAttribute(offset, header)
$log.debug "NtfsMftEntry.createAttribute >> type=#{TypeName[header.type]} header=#{header.inspect}" if DEBUG_TRACE_MFT
buf = header.get_value(@buf[offset..-1], @boot_sector)
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
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. Blocks that are calls to builtin iteration methods (e.g. `ary.map{...}) also add one, others are ignored.
def each_child_node(*types) # count begins: 1
unless block_given? # unless: +1
return to_enum(__method__, *types)
children.each do |child| # each{}: +1
next unless child.is_a?(Node) # unless: +1
yield child if types.empty? || # if: +1, ||: +1
types.include?(child.type)
end
self
end # total: 6
Method createAttribute
has a Cognitive Complexity of 15 (exceeds 8 allowed). Consider refactoring. Open
def createAttribute(offset, header)
$log.debug "NtfsMftEntry.createAttribute >> type=#{TypeName[header.type]} header=#{header.inspect}" if DEBUG_TRACE_MFT
buf = header.get_value(@buf[offset..-1], @boot_sector)
- Read upRead up
- Create a ticketCreate a ticket
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 dump
has 27 lines of code (exceeds 25 allowed). Consider refactoring. Open
def dump
ref = NTFS::Utils.MkRef(@mft_entry['base_mft_record'])
out = "\#<#{self.class}:0x#{'%08x' % object_id}>\n"
out << " Signature : #{@mft_entry['signature']}\n"
- Create a ticketCreate a ticket
Method initialize
has 26 lines of code (exceeds 25 allowed). Consider refactoring. Open
def initialize(bs, recordNumber)
log_prefix = "MIQ(NTFS::MftEntry.initialize)"
raise "#{log_prefix} Nil boot sector" if bs.nil?
@attribs = []
- Create a ticketCreate a ticket
Avoid too many return
statements within this method. Open
return IndexRoot.create_from_header(header, buf, @boot_sector) if header.type == AT_INDEX_ROOT
- Create a ticketCreate a ticket
Avoid too many return
statements within this method. Open
return VolumeInformation.new(buf) if header.type == AT_VOLUME_INFORMATION
- Create a ticketCreate a ticket
Avoid too many return
statements within this method. Open
return AttributeList.new(buf, @boot_sector) if header.type == AT_ATTRIBUTE_LIST
- Create a ticketCreate a ticket
Avoid too many return
statements within this method. Open
return Bitmap.create_from_header(header, buf) if header.type == AT_BITMAP
- Create a ticketCreate a ticket
Avoid too many return
statements within this method. Open
return IndexAllocation.create_from_header(header, buf) if header.type == AT_INDEX_ALLOCATION
- Create a ticketCreate a ticket
Avoid too many return
statements within this method. Open
return AttribData.create_from_header(header, buf) if header.type == AT_DATA
- Create a ticketCreate a ticket
Use ==
if you meant to do a comparison or wrap the expression in parentheses to indicate you meant to assign in a condition. Open
while h = AttribHeader.new(@buf[offset..-1])
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
Checks for assignments in the conditions of if/while/until.
AllowSafeAssignment
option for safe assignment.
By safe assignment we mean putting parentheses around
an assignment to indicate "I know I'm using an assignment
as a condition. It's not a mistake."
Safety:
This cop's autocorrection is unsafe because it assumes that the author meant to use an assignment result as a condition.
Example:
# bad
if some_var = true
do_something
end
# good
if some_var == true
do_something
end
Example: AllowSafeAssignment: true (default)
# good
if (some_var = true)
do_something
end
Example: AllowSafeAssignment: false
# bad
if (some_var = true)
do_something
end
Do not suppress exceptions. Open
rescue NoMethodError
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
Checks for rescue
blocks with no body.
Example:
# bad
def some_method
do_something
rescue
end
# bad
begin
do_something
rescue
end
# good
def some_method
do_something
rescue
handle_exception
end
# good
begin
do_something
rescue
handle_exception
end
Example: AllowComments: true (default)
# good
def some_method
do_something
rescue
# do nothing
end
# good
begin
do_something
rescue
# do nothing
end
Example: AllowComments: false
# bad
def some_method
do_something
rescue
# do nothing
end
# bad
begin
do_something
rescue
# do nothing
end
Example: AllowNil: true (default)
# good
def some_method
do_something
rescue
nil
end
# good
begin
do_something
rescue
# do nothing
end
# good
do_something rescue nil
Example: AllowNil: false
# bad
def some_method
do_something
rescue
nil
end
# bad
begin
do_something
rescue
nil
end
# bad
do_something rescue nil