rubocop 0.85.1 → 0.89.0

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

@@ -21,14 +21,16 @@ module RuboCop
       #   # good
       #   def attribute
       #   end
-      class AccessorMethodName < Cop
+      class AccessorMethodName < Base
         MSG_READER = 'Do not prefix reader method names with `get_`.'
         MSG_WRITER = 'Do not prefix writer method names with `set_`.'
 
         def on_def(node)
           return unless bad_reader_name?(node) || bad_writer_name?(node)
 
-          add_offense(node, location: :name)
+          message = message(node)
+
+          add_offense(node.loc.name, message: message)
         end
         alias on_defs on_def
 

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

@@ -5,7 +5,9 @@
 module RuboCop
   module Cop
     module Naming
-      # This cop checks for non-ascii characters in identifier names.
+      # This cop checks for non-ascii characters in identifier and constant names.
+      # Identifiers are always checked and whether constants are checked
+      # can be controlled using AsciiConstants config.
       #
       # @example
       #   # bad
@@ -36,21 +38,42 @@ module RuboCop
       #   # good
       #   params[:width_gteq]
       #
-      class AsciiIdentifiers < Cop
+      # @example AsciiConstants: true (default)
+      #   # bad
+      #   class Foö
+      #   end
+      #
+      #   FOÖ = "foo"
+      #
+      # @example AsciiConstants: false
+      #   # good
+      #   class Foö
+      #   end
+      #
+      #   FOÖ = "foo"
+      #
+      class AsciiIdentifiers < Base
         include RangeHelp
 
-        MSG = 'Use only ascii symbols in identifiers.'
+        IDENTIFIER_MSG = 'Use only ascii symbols in identifiers.'
+        CONSTANT_MSG   = 'Use only ascii symbols in constants.'
 
-        def investigate(processed_source)
+        def on_new_investigation
           processed_source.each_token do |token|
-            next unless token.type == :tIDENTIFIER && !token.text.ascii_only?
+            next if !should_check?(token) || token.text.ascii_only?
 
-            add_offense(token, location: first_offense_range(token))
+            message = token.type == :tIDENTIFIER ? IDENTIFIER_MSG : CONSTANT_MSG
+            add_offense(first_offense_range(token), message: message)
           end
         end
 
         private
 
+        def should_check?(token)
+          token.type == :tIDENTIFIER ||
+            (token.type == :tCONSTANT && cop_config['AsciiConstants'])
+        end
+
         def first_offense_range(identifier)
           expression    = identifier.pos
           first_offense = first_non_ascii_chars(identifier.text)

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

@@ -13,12 +13,12 @@ module RuboCop
       #
       #   # good
       #   def +(other); end
-      class BinaryOperatorParameterName < Cop
+      class BinaryOperatorParameterName < Base
         MSG = 'When defining the `%<opr>s` operator, ' \
               'name its argument `other`.'
 
         OP_LIKE_METHODS = %i[eql? equal?].freeze
-        BLACKLISTED = %i[+@ -@ [] []= << === `].freeze
+        EXCLUDED = %i[+@ -@ [] []= << === `].freeze
 
         def_node_matcher :op_method_candidate?, <<~PATTERN
           (def [#op_method? $_] (args $(arg [!:other !:_other])) _)
@@ -33,9 +33,9 @@ module RuboCop
         private
 
         def op_method?(name)
-          return false if BLACKLISTED.include?(name)
+          return false if EXCLUDED.include?(name)
 
-          name !~ /\A\w/ || OP_LIKE_METHODS.include?(name)
+          !/\A\w/.match?(name) || OP_LIKE_METHODS.include?(name)
         end
       end
     end

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

@@ -35,7 +35,7 @@ module RuboCop
       #   foo { |speed, distance| speed * distance }
       #
       #   baz { |age, height, gender| do_stuff(age, height, gender) }
-      class BlockParameterName < Cop
+      class BlockParameterName < Base
         include UncommunicativeName
 
         def on_block(node)

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

@@ -26,7 +26,7 @@ module RuboCop
       #   end
       #   class module_parent::MyModule
       #   end
-      class ClassAndModuleCamelCase < Cop
+      class ClassAndModuleCamelCase < Base
         MSG = 'Use CamelCase for classes and modules.'
 
         def on_class(node)
@@ -34,7 +34,7 @@ module RuboCop
           name = node.loc.name.source.gsub(allowed, '')
           return unless /_/.match?(name)
 
-          add_offense(node, location: :name)
+          add_offense(node.loc.name)
         end
         alias on_module on_class
       end

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

@@ -17,7 +17,7 @@ module RuboCop
       #
       #   # good
       #   INCH_IN_CM = 2.54
-      class ConstantName < Cop
+      class ConstantName < Base
         MSG = 'Use SCREAMING_SNAKE_CASE for constants.'
         # Use POSIX character classes, so we allow accented characters rather
         # than just standard ASCII characters
@@ -47,7 +47,7 @@ module RuboCop
           return if allowed_assignment?(value)
           return if SNAKE_CASE.match?(const_name)
 
-          add_offense(node, location: :name)
+          add_offense(node.loc.name)
         end
 
         private

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

@@ -24,7 +24,7 @@ module RuboCop
       #   lib/layout_manager.rb
       #
       #   anything/using_snake_case.rake
-      class FileName < Cop
+      class FileName < Base
         include RangeHelp
 
         MSG_SNAKE_CASE = 'The name of this source file (`%<basename>s`) ' \
@@ -35,13 +35,13 @@ module RuboCop
 
         SNAKE_CASE = /^[\da-z_.?!]+$/.freeze
 
-        def investigate(processed_source)
+        def on_new_investigation
           file_path = processed_source.file_path
           return if config.file_to_exclude?(file_path) ||
                     config.allowed_camel_case_file?(file_path)
 
           for_bad_filename(file_path) do |range, msg|
-            add_offense(nil, location: range, message: msg)
+            add_offense(range, message: msg)
           end
         end
 
@@ -123,10 +123,9 @@ module RuboCop
           # special handling for Action Pack Variants file names like
           # some_file.xlsx+mobile.axlsx
           basename = basename.sub('+', '_')
-          basename =~ (regex || SNAKE_CASE)
+          basename.match?(regex || SNAKE_CASE)
         end
 
-        # rubocop:disable Metrics/CyclomaticComplexity
         def find_class_or_module(node, namespace)
           return nil unless node
 
@@ -145,7 +144,6 @@ module RuboCop
 
           nil
         end
-        # rubocop:enable Metrics/CyclomaticComplexity
 
         def match_namespace(node, namespace, expected)
           match_partial = partial_matcher!(expected)

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

@@ -27,7 +27,7 @@ module RuboCop
       #   <<-sql
       #     SELECT * FROM foo
       #   sql
-      class HeredocDelimiterCase < Cop
+      class HeredocDelimiterCase < Base
         include Heredoc
         include ConfigurableEnforcedStyle
 
@@ -36,7 +36,7 @@ module RuboCop
         def on_heredoc(node)
           return if correct_case_delimiters?(node)
 
-          add_offense(node, location: :heredoc_end)
+          add_offense(node.loc.heredoc_end)
         end
 
         private

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

@@ -23,7 +23,7 @@ module RuboCop
       #   <<-EOS
       #     SELECT * FROM foo
       #   EOS
-      class HeredocDelimiterNaming < Cop
+      class HeredocDelimiterNaming < Base
         include Heredoc
 
         MSG = 'Use meaningful heredoc delimiters.'
@@ -31,7 +31,7 @@ module RuboCop
         def on_heredoc(node)
           return if meaningful_delimiters?(node)
 
-          add_offense(node, location: :heredoc_end)
+          add_offense(node.loc.heredoc_end)
         end
 
         private
@@ -42,7 +42,7 @@ module RuboCop
           return false unless /\w/.match?(delimiters)
 
           forbidden_delimiters.none? do |forbidden_delimiter|
-            delimiters =~ Regexp.new(forbidden_delimiter)
+            Regexp.new(forbidden_delimiter).match?(delimiters)
           end
         end
 

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

@@ -84,7 +84,7 @@ module RuboCop
       #   def _foo
       #     @_foo ||= calculate_expensive_thing
       #   end
-      class MemoizedInstanceVariableName < Cop
+      class MemoizedInstanceVariableName < Base
         include ConfigurableEnforcedStyle
 
         MSG = 'Memoized variable `%<var>s` does not match ' \
@@ -115,7 +115,7 @@ module RuboCop
             suggested_var: suggested_var(method_name),
             method: method_name
           )
-          add_offense(node, location: ivar_assign.source_range, message: msg)
+          add_offense(ivar_assign.source_range, message: msg)
         end
         alias on_defs on_def
 

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

@@ -28,7 +28,7 @@ module RuboCop
       #
       #   # good
       #   def fooBar; end
-      class MethodName < Cop
+      class MethodName < Base
         include ConfigurableNaming
         include IgnoredPattern
         include RangeHelp

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

@@ -43,13 +43,13 @@ module RuboCop
       #   def baz(age_a, height_b, gender_c)
       #     do_stuff(age_a, height_b, gender_c)
       #   end
-      class MethodParameterName < Cop
+      class MethodParameterName < Base
         include UncommunicativeName
 
         def on_def(node)
           return unless node.arguments?
 
-          check(node, node.arguments.reject(&:forward_args_type?))
+          check(node, node.arguments)
         end
         alias on_defs on_def
       end

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

@@ -27,7 +27,9 @@ module RuboCop
       #   # good
       #   def value?
       #   end
-      class PredicateName < Cop
+      class PredicateName < Base
+        include AllowedMethods
+
         def_node_matcher :dynamic_method_define, <<~PATTERN
           (send nil? #method_definition_macros
             (sym $_)
@@ -40,8 +42,7 @@ module RuboCop
               next if allowed_method_name?(method_name.to_s, prefix)
 
               add_offense(
-                node,
-                location: node.first_argument.loc.expression,
+                node.first_argument.loc.expression,
                 message: message(method_name,
                                  expected_name(method_name.to_s, prefix))
               )
@@ -56,8 +57,7 @@ module RuboCop
             next if allowed_method_name?(method_name, prefix)
 
             add_offense(
-              node,
-              location: :name,
+              node.loc.name,
               message: message(method_name, expected_name(method_name, prefix))
             )
           end
@@ -70,7 +70,7 @@ module RuboCop
           !method_name.match?(/^#{prefix}[^0-9]/) ||
             method_name == expected_name(method_name, prefix) ||
             method_name.end_with?('=') ||
-            allowed_methods.include?(method_name)
+            allowed_method?(method_name)
         end
 
         def expected_name(method_name, prefix)
@@ -95,10 +95,6 @@ module RuboCop
           cop_config['NamePrefix']
         end
 
-        def allowed_methods
-          cop_config['AllowedMethods']
-        end
-
         def method_definition_macros(macro_name)
           cop_config['MethodDefinitionMacros'].include?(macro_name.to_s)
         end

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

@@ -53,22 +53,23 @@ module RuboCop
       #     # do something
       #   end
       #
-      class RescuedExceptionsVariableName < Cop
+      class RescuedExceptionsVariableName < Base
+        extend AutoCorrector
+
         MSG = 'Use `%<preferred>s` instead of `%<bad>s`.'
 
         def on_resbody(node)
-          name = variable_name(node)
-          return unless name
-          return if preferred_name(name).to_sym == name
+          offending_name = variable_name(node)
+          return unless offending_name
 
-          add_offense(node, location: offense_range(node))
-        end
+          preferred_name = preferred_name(offending_name)
+          return if preferred_name.to_sym == offending_name
+
+          range = offense_range(node)
+          message = message(node)
 
-        def autocorrect(node)
-          lambda do |corrector|
-            offending_name = variable_name(node)
-            preferred_name = preferred_name(offending_name)
-            corrector.replace(offense_range(node), preferred_name)
+          add_offense(range, message: message) do |corrector|
+            corrector.replace(range, preferred_name)
 
             node.body&.each_descendant(:lvar) do |var|
               next unless var.children.first == offending_name

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

@@ -19,7 +19,7 @@ module RuboCop
       #
       #   # good
       #   fooBar = 1
-      class VariableName < Cop
+      class VariableName < Base
         include ConfigurableNaming
 
         MSG = 'Use %<style>s for variable names.'

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

@@ -37,7 +37,7 @@ module RuboCop
       #   variableone = 1
       #
       #   variable_one = 1
-      class VariableNumber < Cop
+      class VariableNumber < Base
         include ConfigurableNumbering
 
         MSG = 'Use %<style>s for variable numbers.'

data/lib/rubocop/cop/offense.rb

@@ -54,14 +54,28 @@ 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)
+
+      NO_LOCATION = PseudoSourceRange.new(1, 0, '', 0, 1).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
 

data/lib/rubocop/cop/registry.rb

@@ -100,9 +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)
-        print_warning(name, path) if shall_warn && department_missing?(badge, name)
+        print_warning(name, path) if warn && department_missing?(badge, name)
         return name if registered?(badge)
 
         potential_badges = qualify_badge(badge)
@@ -149,7 +149,7 @@ module RuboCop
         @registry.size
       end
 
-      def enabled(config, only = [], only_safe = false)
+      def enabled(config, only = [], only_safe: false)
         select do |cop|
           only.include?(cop.cop_name) || enabled?(cop, config, only_safe)
         end

data/lib/rubocop/cop/security/eval.rb

@@ -11,7 +11,7 @@ module RuboCop
       #
       #   eval(something)
       #   binding.eval(something)
-      class Eval < Cop
+      class Eval < Base
         MSG = 'The use of `eval` is a serious security risk.'
 
         def_node_matcher :eval?, <<~PATTERN
@@ -22,7 +22,7 @@ module RuboCop
           eval?(node) do |code|
             return if code.dstr_type? && code.recursive_literal?
 
-            add_offense(node, location: :selector)
+            add_offense(node.loc.selector)
           end
         end
       end