Sha256: 0cdbe63715755f9f27bde1b49dd440fdc466a473fe4050ea48429c92ddef6e41

Contents?: true

Size: 1.78 KB

Versions: 9

Compression:

Stored size: 1.78 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Lint
      # This cop checks for the use of local variable names from an outer scope
      # in block arguments or block-local variables. This mirrors the warning
      # given by `ruby -cw` prior to Ruby 2.6:
      # "shadowing outer local variable - foo".
      #
      # NOTE: Shadowing of variables in block passed to `Ractor.new` is allowed
      # because `Ractor` should not access outer variables.
      # eg. following syle is encouraged:
      #
      #   worker_id, pipe = env
      #   Ractor.new(worker_id, pipe) do |worker_id, pipe|
      #   end
      #
      # @example
      #
      #   # bad
      #
      #   def some_method
      #     foo = 1
      #
      #     2.times do |foo| # shadowing outer `foo`
      #       do_something(foo)
      #     end
      #   end
      #
      # @example
      #
      #   # good
      #
      #   def some_method
      #     foo = 1
      #
      #     2.times do |bar|
      #       do_something(bar)
      #     end
      #   end
      class ShadowingOuterLocalVariable < Base
        MSG = 'Shadowing outer local variable - `%<variable>s`.'

        def_node_matcher :ractor_block?, <<~PATTERN
          (block (send (const nil? :Ractor) :new ...) ...)
        PATTERN

        def self.joining_forces
          VariableForce
        end

        def before_declaring_variable(variable, variable_table)
          return if variable.should_be_unused?
          return if ractor_block?(variable.scope.node)

          outer_local_variable = variable_table.find_variable(variable.name)
          return unless outer_local_variable

          message = format(MSG, variable: variable.name)
          add_offense(variable.declaration_node, message: message)
        end
      end
    end
  end
end

Version data entries

9 entries across 9 versions & 1 rubygems

Version Path
rubocop-1.10.0 lib/rubocop/cop/lint/shadowing_outer_local_variable.rb
rubocop-1.9.1 lib/rubocop/cop/lint/shadowing_outer_local_variable.rb
rubocop-1.9.0 lib/rubocop/cop/lint/shadowing_outer_local_variable.rb
rubocop-1.8.1 lib/rubocop/cop/lint/shadowing_outer_local_variable.rb
rubocop-1.8.0 lib/rubocop/cop/lint/shadowing_outer_local_variable.rb
rubocop-1.7.0 lib/rubocop/cop/lint/shadowing_outer_local_variable.rb
rubocop-1.6.1 lib/rubocop/cop/lint/shadowing_outer_local_variable.rb
rubocop-1.6.0 lib/rubocop/cop/lint/shadowing_outer_local_variable.rb
rubocop-1.5.2 lib/rubocop/cop/lint/shadowing_outer_local_variable.rb