Class: RuboCop::Cop::VariableForce::Variable
- Inherits:
-
Object
- Object
- RuboCop::Cop::VariableForce::Variable
- Defined in:
- lib/rubocop/cop/variable_force/variable.rb
Overview
A Variable represents existence of a local variable. This holds a variable declaration node and some states of the variable.
Constant Summary collapse
- VARIABLE_DECLARATION_TYPES =
(VARIABLE_ASSIGNMENT_TYPES + ARGUMENT_DECLARATION_TYPES).freeze
Instance Attribute Summary collapse
-
#assignments ⇒ Object
readonly
Returns the value of attribute assignments.
-
#captured_by_block ⇒ Object
(also: #captured_by_block?)
readonly
Returns the value of attribute captured_by_block.
-
#declaration_node ⇒ Object
readonly
Returns the value of attribute declaration_node.
-
#name ⇒ Object
readonly
Returns the value of attribute name.
-
#references ⇒ Object
readonly
Returns the value of attribute references.
-
#scope ⇒ Object
readonly
Returns the value of attribute scope.
Instance Method Summary collapse
- #argument? ⇒ Boolean
- #assign(node) ⇒ Object
- #block_argument? ⇒ Boolean
- #capture_with_block! ⇒ Object
- #explicit_block_local_variable? ⇒ Boolean
-
#in_modifier_if?(assignment) ⇒ Boolean
rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity.
-
#initialize(name, declaration_node, scope) ⇒ Variable
constructor
A new instance of Variable.
- #keyword_argument? ⇒ Boolean
- #method_argument? ⇒ Boolean
-
#reference!(node) ⇒ Object
rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity.
- #referenced? ⇒ Boolean
- #should_be_unused? ⇒ Boolean
-
#used? ⇒ Boolean
This is a convenient way to check whether the variable is used in its entire variable lifetime.
Constructor Details
#initialize(name, declaration_node, scope) ⇒ Variable
Returns a new instance of Variable.
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 17 def initialize(name, declaration_node, scope) unless VARIABLE_DECLARATION_TYPES.include?(declaration_node.type) raise ArgumentError, "Node type must be any of #{VARIABLE_DECLARATION_TYPES}, " \ "passed #{declaration_node.type}" end @name = name.to_sym @declaration_node = declaration_node @scope = scope @assignments = [] @references = [] @captured_by_block = false end |
Instance Attribute Details
#assignments ⇒ Object (readonly)
Returns the value of attribute assignments.
12 13 14 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 12 def assignments @assignments end |
#captured_by_block ⇒ Object (readonly) Also known as: captured_by_block?
Returns the value of attribute captured_by_block.
12 13 14 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 12 def captured_by_block @captured_by_block end |
#declaration_node ⇒ Object (readonly)
Returns the value of attribute declaration_node.
12 13 14 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 12 def declaration_node @declaration_node end |
#name ⇒ Object (readonly)
Returns the value of attribute name.
12 13 14 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 12 def name @name end |
#references ⇒ Object (readonly)
Returns the value of attribute references.
12 13 14 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 12 def references @references end |
#scope ⇒ Object (readonly)
Returns the value of attribute scope.
12 13 14 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 12 def scope @scope end |
Instance Method Details
#argument? ⇒ Boolean
96 97 98 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 96 def argument? ARGUMENT_DECLARATION_TYPES.include?(@declaration_node.type) end |
#assign(node) ⇒ Object
33 34 35 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 33 def assign(node) @assignments << Assignment.new(node, self) end |
#block_argument? ⇒ Boolean
104 105 106 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 104 def block_argument? argument? && @scope.node.block_type? end |
#capture_with_block! ⇒ Object
76 77 78 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 76 def capture_with_block! @captured_by_block = true end |
#explicit_block_local_variable? ⇒ Boolean
112 113 114 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 112 def explicit_block_local_variable? @declaration_node.shadowarg_type? end |
#in_modifier_if?(assignment) ⇒ Boolean
rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
70 71 72 73 74 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 70 def in_modifier_if?(assignment) parent = assignment.node.parent parent = parent.parent if parent&.begin_type? parent&.if_type? && parent&.modifier_form? end |
#keyword_argument? ⇒ Boolean
108 109 110 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 108 def keyword_argument? %i[kwarg kwoptarg].include?(@declaration_node.type) end |
#method_argument? ⇒ Boolean
100 101 102 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 100 def method_argument? argument? && %i[def defs].include?(@scope.node.type) end |
#reference!(node) ⇒ Object
rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 42 def reference!(node) reference = Reference.new(node, @scope) @references << reference consumed_branches = Set.new @assignments.reverse_each do |assignment| next if consumed_branches.include?(assignment.branch) unless assignment.run_exclusively_with?(reference) assignment.reference!(node) end # Modifier if/unless conditions are special. Assignments made in # them do not put the assigned variable in scope to the left of the # if/unless keyword. A preceding assignment is needed to put the # variable in scope. For this reason we skip to the next assignment # here. next if in_modifier_if?(assignment) break if !assignment.branch || assignment.branch == reference.branch unless assignment.branch.may_run_incompletely? consumed_branches << assignment.branch end end end |
#referenced? ⇒ Boolean
37 38 39 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 37 def referenced? !@references.empty? end |
#should_be_unused? ⇒ Boolean
92 93 94 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 92 def should_be_unused? name.to_s.start_with?('_') end |
#used? ⇒ Boolean
This is a convenient way to check whether the variable is used in its entire variable lifetime. For more precise usage check, refer Assignment#used?.
Once the variable is captured by a block, we have no idea when, where, and how many times the block would be invoked. This means we cannot track the usage of the variable. So we consider it’s used to suppress false positive offenses.
88 89 90 |
# File 'lib/rubocop/cop/variable_force/variable.rb', line 88 def used? @captured_by_block || referenced? end |