class RuboCop::Cop::VariableForce::Scope

A Scope represents a context of local variable visibility. This is a place where local variables belong to. A scope instance holds a scope node and variable entries.

Constants

OUTER_SCOPE_CHILD_INDICES

Attributes

naked_top_level[R]
naked_top_level?[R]
node[R]
variables[R]

Public Class Methods

new(node) click to toggle source
# File lib/rubocop/cop/variable_force/scope.rb, line 20
def initialize(node)
  unless SCOPE_TYPES.include?(node.type)
    # Accept any node type for top level scope
    if node.parent
      raise ArgumentError,
            "Node type must be any of #{SCOPE_TYPES}, " \
            "passed #{node.type}"
    end
    @naked_top_level = true
  end
  @node = node
  @variables = {}
end

Public Instance Methods

==(other) click to toggle source
# File lib/rubocop/cop/variable_force/scope.rb, line 34
def ==(other)
  @node.equal?(other.node)
end
body_node() click to toggle source
# File lib/rubocop/cop/variable_force/scope.rb, line 46
def body_node
  if naked_top_level?
    node
  else
    child_index = case node.type
                  when :module, :sclass     then 1
                  when :def, :class, :block then 2
                  when :defs                then 3
                  end

    node.children[child_index]
  end
end
each_node() { |node| ... } click to toggle source
# File lib/rubocop/cop/variable_force/scope.rb, line 65
def each_node(&block)
  return to_enum(__method__) unless block_given?
  yield node if naked_top_level?
  scan_node(node, &block)
end
include?(target_node) click to toggle source
# File lib/rubocop/cop/variable_force/scope.rb, line 60
def include?(target_node)
  !belong_to_outer_scope?(target_node) &&
    !belong_to_inner_scope?(target_node)
end
name() click to toggle source
# File lib/rubocop/cop/variable_force/scope.rb, line 38
def name
  # TODO: Add an else clause
  case @node.type
  when :def  then @node.children[0]
  when :defs then @node.children[1]
  end
end

Private Instance Methods

ancestor_node?(target_node) click to toggle source
# File lib/rubocop/cop/variable_force/scope.rb, line 98
def ancestor_node?(target_node)
  node.each_ancestor.any? do |ancestor_node|
    ancestor_node.equal?(target_node)
  end
end
belong_to_inner_scope?(target_node) click to toggle source
# File lib/rubocop/cop/variable_force/scope.rb, line 90
def belong_to_inner_scope?(target_node)
  return false if !target_node.parent || target_node.parent.equal?(node)
  return false unless SCOPE_TYPES.include?(target_node.parent.type)
  indices = OUTER_SCOPE_CHILD_INDICES[target_node.parent.type]
  return true unless indices
  !indices.include?(target_node.sibling_index)
end
belong_to_outer_scope?(target_node) click to toggle source
# File lib/rubocop/cop/variable_force/scope.rb, line 81
def belong_to_outer_scope?(target_node)
  return true if !naked_top_level? && target_node.equal?(node)
  return true if ancestor_node?(target_node)
  return false unless target_node.parent.equal?(node)
  indices = OUTER_SCOPE_CHILD_INDICES[target_node.parent.type]
  return false unless indices
  indices.include?(target_node.sibling_index)
end
scan_node(node) { |child_node| ... } click to toggle source
# File lib/rubocop/cop/variable_force/scope.rb, line 73
def scan_node(node, &block)
  node.each_child_node do |child_node|
    next unless include?(child_node)
    yield child_node
    scan_node(child_node, &block)
  end
end