Class: RuboCop::Cop::Metrics::Utils::AbcSizeCalculator
- Inherits:
-
Object
- Object
- RuboCop::Cop::Metrics::Utils::AbcSizeCalculator
- Defined in:
- lib/rubocop/cop/metrics/utils/abc_size_calculator.rb
Overview
> ABC is .. a software size metric .. computed by counting the number > of assignments, branches and conditions for a section of code. > c2.com/cgi/wiki?AbcMetric
We separate the calculator from the cop so that the calculation, the formula itself, is easier to test.
Constant Summary collapse
- BRANCH_NODES =
> Branch – an explicit forward program branch out of scope – a > function call, class method call .. > c2.com/cgi/wiki?AbcMetric
%i[send csend].freeze
- CONDITION_NODES =
> Condition – a logical/Boolean test, == != <= >= < > else case > default try catch ? and unary conditionals. > c2.com/cgi/wiki?AbcMetric
CyclomaticComplexity::COUNTED_NODES.freeze
Class Method Summary collapse
Instance Method Summary collapse
- #calculate ⇒ Object
- #evaluate_branch_nodes(node) ⇒ Object
-
#initialize(node) ⇒ AbcSizeCalculator
constructor
A new instance of AbcSizeCalculator.
- #node_has_else_branch?(node) ⇒ Boolean
Constructor Details
#initialize(node) ⇒ AbcSizeCalculator
Returns a new instance of AbcSizeCalculator.
28 29 30 31 32 33 |
# File 'lib/rubocop/cop/metrics/utils/abc_size_calculator.rb', line 28 def initialize(node) @assignment = 0 @branch = 0 @condition = 0 @node = node end |
Class Method Details
.calculate(node) ⇒ Object
24 25 26 |
# File 'lib/rubocop/cop/metrics/utils/abc_size_calculator.rb', line 24 def self.calculate(node) new(node).calculate end |
Instance Method Details
#calculate ⇒ Object
35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/rubocop/cop/metrics/utils/abc_size_calculator.rb', line 35 def calculate @node.each_node do |child| if child.assignment? @assignment += 1 elsif BRANCH_NODES.include?(child.type) evaluate_branch_nodes(child) elsif CONDITION_NODES.include?(child.type) @condition += 1 if node_has_else_branch?(child) @condition += 1 end end Math.sqrt(@assignment**2 + @branch**2 + @condition**2).round(2) end |
#evaluate_branch_nodes(node) ⇒ Object
50 51 52 53 54 55 56 |
# File 'lib/rubocop/cop/metrics/utils/abc_size_calculator.rb', line 50 def evaluate_branch_nodes(node) if node.comparison_method? @condition += 1 else @branch += 1 end end |
#node_has_else_branch?(node) ⇒ Boolean
58 59 60 61 62 |
# File 'lib/rubocop/cop/metrics/utils/abc_size_calculator.rb', line 58 def node_has_else_branch?(node) %i[case if].include?(node.type) && node.else? && node.loc.else.is?('else') end |