rubocop 0.78.0 → 1.13.0

data/lib/rubocop/cop/naming/variable_name.rb

@@ -19,7 +19,8 @@ module RuboCop
       #
       #   # good
       #   fooBar = 1
-      class VariableName < Cop
+      class VariableName < Base
+        include AllowedIdentifiers
         include ConfigurableNaming
 
         MSG = 'Use %<style>s for variable names.'
@@ -27,6 +28,7 @@ module RuboCop
         def on_lvasgn(node)
           name, = *node
           return unless name
+          return if allowed_identifier?(name)
 
           check_name(node, name, node.loc.name)
         end

data/lib/rubocop/cop/naming/variable_number.rb

@@ -7,53 +7,138 @@ module RuboCop
       # configured style, snake_case, normalcase, or non_integer,
       # for their numbering.
       #
+      # Additionally, `CheckMethodNames` and `CheckSymbols` configuration options
+      # can be used to specify whether method names and symbols should be checked.
+      # Both are enabled by default.
+      #
       # @example EnforcedStyle: snake_case
       #   # bad
-      #
+      #   :some_sym1
       #   variable1 = 1
       #
-      #   # good
+      #   def some_method1; end
       #
+      #   def some_method_1(arg1); end
+      #
+      #   # good
+      #   :some_sym_1
       #   variable_1 = 1
       #
+      #   def some_method_1; end
+      #
+      #   def some_method_1(arg_1); end
+      #
       # @example EnforcedStyle: normalcase (default)
       #   # bad
-      #
+      #   :some_sym_1
       #   variable_1 = 1
       #
-      #   # good
+      #   def some_method_1; end
       #
+      #   def some_method1(arg_1); end
+      #
+      #   # good
+      #   :some_sym1
       #   variable1 = 1
       #
+      #   def some_method1; end
+      #
+      #   def some_method1(arg1); end
+      #
       # @example EnforcedStyle: non_integer
       #   # bad
+      #   :some_sym1
+      #   :some_sym_1
       #
       #   variable1 = 1
-      #
       #   variable_1 = 1
       #
+      #   def some_method1; end
+      #
+      #   def some_method_1; end
+      #
+      #   def some_methodone(arg1); end
+      #   def some_methodone(arg_1); end
+      #
       #   # good
+      #   :some_symone
+      #   :some_sym_one
       #
       #   variableone = 1
-      #
       #   variable_one = 1
-      class VariableNumber < Cop
+      #
+      #   def some_methodone; end
+      #
+      #   def some_method_one; end
+      #
+      #   def some_methodone(argone); end
+      #   def some_methodone(arg_one); end
+      #
+      #   # In the following examples, we assume `EnforcedStyle: normalcase` (default).
+      #
+      # @example CheckMethodNames: true (default)
+      #   # bad
+      #   def some_method_1; end
+      #
+      # @example CheckMethodNames: false
+      #   # good
+      #   def some_method_1; end
+      #
+      # @example CheckSymbols: true (default)
+      #   # bad
+      #   :some_sym_1
+      #
+      # @example CheckSymbols: false
+      #   # good
+      #   :some_sym_1
+      #
+      # @example AllowedIdentifiers: [capture3]
+      #   # good
+      #   expect(Open3).to receive(:capture3)
+      #
+      class VariableNumber < Base
+        include AllowedIdentifiers
         include ConfigurableNumbering
 
-        MSG = 'Use %<style>s for variable numbers.'
+        MSG = 'Use %<style>s for %<identifier_type>s numbers.'
 
         def on_arg(node)
+          @node = node
           name, = *node
+          return if allowed_identifier?(name)
+
           check_name(node, name, node.loc.name)
         end
         alias on_lvasgn on_arg
         alias on_ivasgn on_arg
         alias on_cvasgn on_arg
 
+        def on_def(node)
+          @node = node
+          return if allowed_identifier?(node.method_name)
+
+          check_name(node, node.method_name, node.loc.name) if cop_config['CheckMethodNames']
+        end
+        alias on_defs on_def
+
+        def on_sym(node)
+          @node = node
+          return if allowed_identifier?(node.value)
+
+          check_name(node, node.value, node) if cop_config['CheckSymbols']
+        end
+
         private
 
         def message(style)
-          format(MSG, style: style)
+          identifier_type =
+            case @node.type
+            when :def, :defs then 'method name'
+            when :sym        then 'symbol'
+            else                  'variable'
+            end
+
+          format(MSG, style: style, identifier_type: identifier_type)
         end
       end
     end

data/lib/rubocop/cop/offense.rb

@@ -7,8 +7,7 @@ module RuboCop
       include Comparable
 
       # @api private
-      COMPARISON_ATTRIBUTES = %i[line column cop_name
-                                 message severity].freeze
+      COMPARISON_ATTRIBUTES = %i[line column cop_name message severity].freeze
 
       # @api public
       #
@@ -54,14 +53,42 @@ module RuboCop
       # @api private
       attr_reader :status
 
+      # @api public
+      #
+      # @!attribute [r] corrector
+      #
+      # @return [Corrector | nil]
+      #   the autocorrection for this offense, or `nil` when not available
+      attr_reader :corrector
+
+      PseudoSourceRange = Struct.new(:line, :column, :source_line, :begin_pos,
+                                     :end_pos) do
+        alias_method :first_line, :line
+        alias_method :last_line, :line
+        alias_method :last_column, :column
+
+        def column_range
+          column...last_column
+        end
+
+        def size
+          end_pos - begin_pos
+        end
+        alias_method :length, :size
+      end
+      private_constant :PseudoSourceRange
+
+      NO_LOCATION = PseudoSourceRange.new(1, 0, '', 0, 0).freeze
+
       # @api private
-      def initialize(severity, location, message, cop_name,
-                     status = :uncorrected)
+      def initialize(severity, location, message, cop_name, # rubocop:disable Metrics/ParameterLists
+                     status = :uncorrected, corrector = nil)
         @severity = RuboCop::Cop::Severity.new(severity)
         @location = location
         @message = message.freeze
         @cop_name = cop_name.freeze
         @status = status
+        @corrector = corrector
         freeze
       end
 
@@ -113,9 +140,7 @@ module RuboCop
       # @return [Parser::Source::Range]
       #   the range of the code that is highlighted
       def highlighted_area
-        Parser::Source::Range.new(source_line,
-                                  column,
-                                  column + column_length)
+        Parser::Source::Range.new(source_line, column, column + column_length)
       end
 
       # @api private
@@ -185,16 +210,14 @@ module RuboCop
       #   returns `true` if two offenses contain same attributes
       def ==(other)
         COMPARISON_ATTRIBUTES.all? do |attribute|
-          send(attribute) == other.send(attribute)
+          public_send(attribute) == other.public_send(attribute)
         end
       end
 
       alias eql? ==
 
       def hash
-        COMPARISON_ATTRIBUTES.reduce(0) do |hash, attribute|
-          hash ^ send(attribute).hash
-        end
+        COMPARISON_ATTRIBUTES.reduce(0) { |hash, attribute| hash ^ public_send(attribute).hash }
       end
 
       # @api public
@@ -206,7 +229,7 @@ module RuboCop
       #   comparison result
       def <=>(other)
         COMPARISON_ATTRIBUTES.each do |attribute|
-          result = send(attribute) <=> other.send(attribute)
+          result = public_send(attribute) <=> other.public_send(attribute)
           return result unless result.zero?
         end
         0

data/lib/rubocop/cop/registry.rb

@@ -10,51 +10,60 @@ module RuboCop
 
       def initialize(name, origin, badges)
         super(
-          format(
-            MSG,
-            name: name,
-            origin: origin,
-            options: badges.to_a.join(' or ')
-          )
+          format(MSG, name: name, origin: origin, options: badges.to_a.join(' or '))
         )
       end
     end
 
     # Registry that tracks all cops by their badge and department.
     class Registry
-      def initialize(cops = [])
+      include Enumerable
+
+      attr_reader :options
+
+      def initialize(cops = [], options = {})
         @registry = {}
         @departments = {}
         @cops_by_cop_name = Hash.new { |hash, key| hash[key] = [] }
 
-        cops.each { |cop| enlist(cop) }
+        @enrollment_queue = cops
+        @options = options
       end
 
       def enlist(cop)
-        @registry[cop.badge] = cop
-        @departments[cop.department] ||= []
-        @departments[cop.department] << cop
-        @cops_by_cop_name[cop.cop_name] << cop
+        @enrollment_queue << cop
+      end
+
+      def dismiss(cop)
+        raise "Cop #{cop} could not be dismissed" unless @enrollment_queue.delete(cop)
       end
 
       # @return [Array<Symbol>] list of departments for current cops.
       def departments
+        clear_enrollment_queue
         @departments.keys
       end
 
       # @return [Registry] Cops for that specific department.
       def with_department(department)
+        clear_enrollment_queue
         with(@departments.fetch(department, []))
       end
 
       # @return [Registry] Cops not for a specific department.
       def without_department(department)
+        clear_enrollment_queue
         without_department = @departments.dup
         without_department.delete(department)
 
         with(without_department.values.flatten)
       end
 
+      # @return [Boolean] Checks if given name is department
+      def department?(name)
+        departments.include? name.to_sym
+      end
+
       def contains_cop_matching?(names)
         cops.any? { |cop| cop.match?(names) }
       end
@@ -91,11 +100,9 @@ module RuboCop
       # @note Emits a warning if the provided name has an incorrect namespace
       #
       # @return [String] Qualified cop name
-      def qualified_cop_name(name, path, shall_warn = true)
+      def qualified_cop_name(name, path, warn: true)
         badge = Badge.parse(name)
-        if shall_warn && department_missing?(badge, name)
-          print_warning(name, path)
-        end
+        print_warning(name, path) if warn && department_missing?(badge, name)
         return name if registered?(badge)
 
         potential_badges = qualify_badge(badge)
@@ -120,6 +127,7 @@ module RuboCop
       end
 
       def unqualified_cop_names
+        clear_enrollment_queue
         @unqualified_cop_names ||=
           Set.new(@cops_by_cop_name.keys.map { |qn| File.basename(qn) }) <<
           'RedundantCopDisableDirective'
@@ -127,42 +135,58 @@ module RuboCop
 
       # @return [Hash{String => Array<Class>}]
       def to_h
+        clear_enrollment_queue
         @cops_by_cop_name
       end
 
       def cops
+        clear_enrollment_queue
         @registry.values
       end
 
       def length
+        clear_enrollment_queue
         @registry.size
       end
 
-      def enabled(config, only, only_safe = false)
-        select do |cop|
-          only.include?(cop.cop_name) || enabled?(cop, config, only_safe)
-        end
+      def enabled(config, only = [], only_safe: false)
+        select { |cop| only.include?(cop.cop_name) || enabled?(cop, config, only_safe) }
       end
 
       def enabled?(cop, config, only_safe)
         cfg = config.for_cop(cop)
+
+        cop_enabled = cfg.fetch('Enabled') == true || enabled_pending_cop?(cfg, config)
+
         if only_safe
-          cfg.fetch('Enabled') && cfg.fetch('Safe', true)
+          cop_enabled && cfg.fetch('Safe', true)
         else
-          cfg.fetch('Enabled')
+          cop_enabled
         end
       end
 
+      def enabled_pending_cop?(cop_cfg, config)
+        return false if @options[:disable_pending_cops]
+
+        cop_cfg.fetch('Enabled') == 'pending' &&
+          (@options[:enable_pending_cops] || config.enabled_new_cops?)
+      end
+
       def names
         cops.map(&:cop_name)
       end
 
+      def names_for_department(department)
+        cops.select { |cop| cop.department == department.to_sym }.map(&:cop_name)
+      end
+
       def ==(other)
         cops == other.cops
       end
 
       def sort!
-        @registry = Hash[@registry.sort_by { |badge, _| badge.cop_name }]
+        clear_enrollment_queue
+        @registry = @registry.sort_by { |badge, _| badge.cop_name }.to_h
 
         self
       end
@@ -178,16 +202,67 @@ module RuboCop
       # @param [String] cop_name
       # @return [Class, nil]
       def find_by_cop_name(cop_name)
-        @cops_by_cop_name[cop_name].first
+        to_h[cop_name].first
+      end
+
+      def freeze
+        clear_enrollment_queue
+        unqualified_cop_names # build cache
+        super
+      end
+
+      @global = new
+
+      class << self
+        attr_reader :global
+      end
+
+      def self.all
+        global.without_department(:Test).cops
+      end
+
+      def self.qualified_cop_name(name, origin)
+        global.qualified_cop_name(name, origin)
+      end
+
+      # Changes momentarily the global registry
+      # Intended for testing purposes
+      def self.with_temporary_global(temp_global = global.dup)
+        previous = @global
+        @global = temp_global
+        yield
+      ensure
+        @global = previous
+      end
+
+      def self.reset!
+        @global = new
       end
 
       private
 
+      def initialize_copy(reg)
+        initialize(reg.cops, reg.options)
+      end
+
+      def clear_enrollment_queue
+        return if @enrollment_queue.empty?
+
+        @enrollment_queue.each do |cop|
+          @registry[cop.badge] = cop
+          @departments[cop.department] ||= []
+          @departments[cop.department] << cop
+          @cops_by_cop_name[cop.cop_name] << cop
+        end
+        @enrollment_queue = []
+      end
+
       def with(cops)
         self.class.new(cops)
       end
 
       def qualify_badge(badge)
+        clear_enrollment_queue
         @departments
           .map { |department, _| badge.with_department(department) }
           .select { |potential_badge| registered?(potential_badge) }
@@ -204,6 +279,7 @@ module RuboCop
       end
 
       def registered?(badge)
+        clear_enrollment_queue
         @registry.key?(badge)
       end
     end