rubocop 1.5.1 → 1.8.0

data/lib/rubocop/cop/style/string_literals_in_interpolation.rb

@@ -19,12 +19,13 @@ module RuboCop
       #
       #   # good
       #   result = "Tests #{success ? "PASS" : "FAIL"}"
-      class StringLiteralsInInterpolation < Cop
+      class StringLiteralsInInterpolation < Base
         include ConfigurableEnforcedStyle
         include StringLiteralsHelp
+        extend AutoCorrector
 
-        def autocorrect(node)
-          StringLiteralCorrector.correct(node, style)
+        def autocorrect(corrector, node)
+          StringLiteralCorrector.correct(corrector, node, style)
         end
 
         private

data/lib/rubocop/cop/style/symbol_proc.rb

@@ -22,11 +22,12 @@ module RuboCop
         SUPER_TYPES = %i[super zsuper].freeze
 
         def_node_matcher :proc_node?, '(send (const {nil? cbase} :Proc) :new)'
+        def_node_matcher :symbol_proc_receiver?, '{(send ...) (super ...) zsuper}'
         def_node_matcher :symbol_proc?, <<~PATTERN
-          ({block numblock}
-            ${(send ...) (super ...) zsuper}
-            ${(args (arg _)) %Integer}
-            (send (lvar _var) $_))
+          {
+            (block $#symbol_proc_receiver? $(args (arg _var)) (send (lvar _var) $_))
+            (numblock $#symbol_proc_receiver? $1 (send (lvar :_1) $_))
+          }
         PATTERN
 
         def self.autocorrect_incompatible_with

data/lib/rubocop/cop/util.rb

@@ -33,7 +33,9 @@ module RuboCop
       end
 
       def add_parentheses(node, corrector)
-        if node.arguments.empty?
+        if !node.respond_to?(:arguments)
+          corrector.wrap(node, '(', ')')
+        elsif node.arguments.empty?
           corrector.insert_after(node, '()')
         else
           corrector.replace(args_begin(node), '(')

data/lib/rubocop/ext/regexp_node.rb

@@ -15,17 +15,39 @@ module RuboCop
       # see `ext/regexp_parser`.
       attr_reader :parsed_tree
 
-      def assign_properties(*)
-        super
+      if Gem::Version.new(Regexp::Parser::VERSION) >= Gem::Version.new('2.0')
+        def assign_properties(*)
+          super
 
-        str = with_interpolations_blanked
-        @parsed_tree = begin
-          Regexp::Parser.parse(str, options: options)
-        rescue StandardError
-          nil
+          str = with_interpolations_blanked
+          @parsed_tree = begin
+            Regexp::Parser.parse(str, options: options)
+          rescue StandardError
+            nil
+          end
+          origin = loc.begin.end
+          @parsed_tree&.each_expression(true) { |e| e.origin = origin }
+        end
+      # Please remove this `else` branch when support for regexp_parser 1.8 will be dropped.
+      # It's for compatibility with regexp_arser 1.8 and will never be maintained.
+      else
+        def assign_properties(*)
+          super
+
+          str = with_interpolations_blanked
+          begin
+            @parsed_tree = Regexp::Parser.parse(str, options: options)
+          rescue StandardError
+            @parsed_tree = nil
+          else
+            origin = loc.begin.end
+            source = @parsed_tree.to_s
+            @parsed_tree.each_expression(true) do |e|
+              e.origin = origin
+              e.source = source
+            end
+          end
         end
-        origin = loc.begin.end
-        @parsed_tree&.each_expression(true) { |e| e.origin = origin }
       end
 
       def each_capture(named: ANY)

data/lib/rubocop/ext/regexp_parser.rb

@@ -22,9 +22,27 @@ module RuboCop
         module Base
           attr_accessor :origin
 
-          # Shortcut to `loc.expression`
-          def expression
-            @expression ||= origin.adjust(begin_pos: ts, end_pos: ts + full_length)
+          if Gem::Version.new(Regexp::Parser::VERSION) >= Gem::Version.new('2.0')
+            # Shortcut to `loc.expression`
+            def expression
+              @expression ||= origin.adjust(begin_pos: ts, end_pos: ts + full_length)
+            end
+          # Please remove this `else` branch when support for regexp_parser 1.8 will be dropped.
+          # It's for compatibility with regexp_arser 1.8 and will never be maintained.
+          else
+            attr_accessor :source
+
+            def start_index
+              # ts is a byte index; convert it to a character index
+              @start_index ||= source.byteslice(0, ts).length
+            end
+
+            # Shortcut to `loc.expression`
+            def expression
+              @expression ||= begin
+                origin.adjust(begin_pos: start_index, end_pos: start_index + full_length)
+              end
+            end
           end
 
           # @returns a location map like `parser` does, with:

data/lib/rubocop/formatter/emacs_style_formatter.rb

@@ -27,6 +27,8 @@ module RuboCop
             "[Todo] #{offense.message}"
           elsif offense.corrected?
             "[Corrected] #{offense.message}"
+          elsif offense.correctable?
+            "[Correctable] #{offense.message}"
           else
             offense.message
           end

data/lib/rubocop/formatter/simple_text_formatter.rb

@@ -90,6 +90,8 @@ module RuboCop
             green('[Todo] ')
           elsif offense.corrected?
             green('[Corrected] ')
+          elsif offense.correctable?
+            yellow('[Correctable] ')
           else
             ''
           end

data/lib/rubocop/formatter/tap_formatter.rb

@@ -71,6 +71,8 @@ module RuboCop
             '[Todo] '
           elsif offense.corrected?
             '[Corrected] '
+          elsif offense.correctable?
+            '[Correctable] '
           else
             ''
           end

data/lib/rubocop/lockfile.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # Encapsulation of a lockfile for use when checking for gems.
+  # Does not actually resolve gems, just parses the lockfile.
+  # @api private
+  class Lockfile
+    # Gems that the bundle depends on
+    def dependencies
+      return [] unless parser
+
+      parser.dependencies.values
+    end
+
+    # All activated gems, including transitive dependencies
+    def gems
+      return [] unless parser
+
+      # `Bundler::LockfileParser` returns `Bundler::LazySpecification` objects
+      # which are not resolved, so extract the dependencies from them
+      parser.dependencies.values.concat(parser.specs.flat_map(&:dependencies))
+    end
+
+    def includes_gem?(name)
+      gems.any? { |gem| gem.name == name }
+    end
+
+    private
+
+    def parser
+      return unless defined?(Bundler) && Bundler.default_lockfile
+      return @parser if defined?(@parser)
+
+      lockfile = Bundler.read_file(Bundler.default_lockfile)
+      @parser = lockfile ? Bundler::LockfileParser.new(lockfile) : nil
+    rescue Bundler::BundlerError
+      nil
+    end
+  end
+end

data/lib/rubocop/options.rb

@@ -66,7 +66,7 @@ module RuboCop
         add_configuration_options(opts)
         add_formatting_options(opts)
 
-        option(opts, '-r', '--require FILE') { |f| require f }
+        option(opts, '-r', '--require FILE') { |f| require_feature(f) }
 
         add_severity_option(opts)
         add_flags_with_optional_args(opts)
@@ -92,14 +92,7 @@ module RuboCop
           raise OptionArgumentError, message
         end
 
-        @options[:"#{option}"] =
-          if list.empty?
-            ['']
-          else
-            list.split(',').map do |c|
-              Cop::Registry.qualified_cop_name(c, "--#{option} option")
-            end
-          end
+        @options[:"#{option}"] = list.empty? ? [''] : list.split(',')
       end
     end
 
@@ -239,6 +232,13 @@ module RuboCop
       long_opt[2..-1].sub('[no-]', '').sub(/ .*/, '')
                      .tr('-', '_').gsub(/[\[\]]/, '').to_sym
     end
+
+    def require_feature(file)
+      # If any features were added on the CLI from `--require`,
+      # add them to the config.
+      ConfigLoader.add_loaded_features(file)
+      require file
+    end
   end
 
   # Validates option arguments and the options' compatibility with each other.

data/lib/rubocop/rspec/cop_helper.rb

@@ -9,10 +9,6 @@ module CopHelper
   let(:ruby_version) { 2.4 }
   let(:rails_version) { false }
 
-  def inspect_source_file(source)
-    Tempfile.open('tmp') { |f| inspect_source(source, f) }
-  end
-
   def inspect_source(source, file = nil)
     RuboCop::Formatter::DisabledConfigFormatter.config_to_allow_offenses = {}
     RuboCop::Formatter::DisabledConfigFormatter.detected_styles = {}

data/lib/rubocop/rspec/expect_offense.rb

@@ -111,28 +111,9 @@ module RuboCop
         source
       end
 
-      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       def expect_offense(source, file = nil, severity: nil, **replacements)
-        source = format_offense(source, **replacements)
-        RuboCop::Formatter::DisabledConfigFormatter
-          .config_to_allow_offenses = {}
-        RuboCop::Formatter::DisabledConfigFormatter.detected_styles = {}
-        cop.instance_variable_get(:@options)[:auto_correct] = true
-
-        expected_annotations = AnnotatedSource.parse(source)
-
-        if expected_annotations.plain_source == source
-          raise 'Use `expect_no_offenses` to assert that no offenses are found'
-        end
-
-        @processed_source = parse_source(expected_annotations.plain_source,
-                                         file)
-
-        unless @processed_source.valid_syntax?
-          raise 'Error parsing example code: ' \
-            "#{@processed_source.diagnostics.map(&:render).join("\n")}"
-        end
-
+        expected_annotations = parse_annotations(source, **replacements)
+        @processed_source = parse_processed_source(expected_annotations.plain_source, file)
         @offenses = _investigate(cop, @processed_source)
         actual_annotations =
           expected_annotations.with_offense_annotations(@offenses)
@@ -143,7 +124,14 @@ module RuboCop
         @offenses
       end
 
-      def expect_correction(correction, loop: true)
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      def expect_correction(correction, loop: true, source: nil)
+        if source
+          expected_annotations = parse_annotations(source, raise_error: false)
+          @processed_source = parse_processed_source(expected_annotations.plain_source)
+          _investigate(cop, @processed_source)
+        end
+
         raise '`expect_correction` must follow `expect_offense`' unless @processed_source
 
         iteration = 0
@@ -192,6 +180,30 @@ module RuboCop
         expect(actual_annotations.to_s).to eq(source)
       end
 
+      def parse_annotations(source, raise_error: true, **replacements)
+        set_formatter_options
+
+        source = format_offense(source, **replacements)
+        annotations = AnnotatedSource.parse(source)
+        return annotations unless raise_error && annotations.plain_source == source
+
+        raise 'Use `expect_no_offenses` to assert that no offenses are found'
+      end
+
+      def parse_processed_source(source, file = nil)
+        processed_source = parse_source(source, file)
+        return processed_source if processed_source.valid_syntax?
+
+        raise 'Error parsing example code: ' \
+          "#{processed_source.diagnostics.map(&:render).join("\n")}"
+      end
+
+      def set_formatter_options
+        RuboCop::Formatter::DisabledConfigFormatter.config_to_allow_offenses = {}
+        RuboCop::Formatter::DisabledConfigFormatter.detected_styles = {}
+        cop.instance_variable_get(:@options)[:auto_correct] = true
+      end
+
       # Parsed representation of code annotated with the `^^^ Message` style
       class AnnotatedSource
         ANNOTATION_PATTERN = /\A\s*(\^+|\^{}) /.freeze

data/lib/rubocop/runner.rb

@@ -323,11 +323,16 @@ module RuboCop
       Cop::Team.mobilize(mobilized_cop_classes(config), config, @options)
     end
 
-    def mobilized_cop_classes(config)
+    def mobilized_cop_classes(config) # rubocop:disable Metrics/AbcSize
       @mobilized_cop_classes ||= {}.compare_by_identity
       @mobilized_cop_classes[config] ||= begin
         cop_classes = Cop::Registry.all
 
+        # `@options[:only]` and `@options[:except]` are not qualified until
+        # needed so that the Registry can be fully loaded, including any
+        # cops added by `require`s.
+        qualify_option_cop_names
+
         OptionsValidator.new(@options).validate_cop_options
 
         if @options[:only]
@@ -342,6 +347,16 @@ module RuboCop
       end
     end
 
+    def qualify_option_cop_names
+      %i[only except].each do |option|
+        next unless @options[option]
+
+        @options[option].map! do |cop_name|
+          Cop::Registry.qualified_cop_name(cop_name, "--#{option} option")
+        end
+      end
+    end
+
     def filter_cop_classes(cop_classes, config)
       # use only cops that link to a style guide if requested
       return unless style_guide_cops_only?(config)

data/lib/rubocop/target_finder.rb

@@ -58,7 +58,7 @@ module RuboCop
       base_dir = base_dir.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
       all_files = find_files(base_dir, File::FNM_DOTMATCH)
       # use file.include? for performance optimization
-      hidden_files = all_files.select { |file| file.include?(HIDDEN_PATH_SUBSTRING) }
+      hidden_files = all_files.select { |file| file.include?(HIDDEN_PATH_SUBSTRING) }.sort
       base_dir_config = @config_store.for(base_dir)
 
       target_files = all_files.select do |file|
@@ -70,7 +70,9 @@ module RuboCop
 
     def to_inspect?(file, hidden_files, base_dir_config)
       return false if base_dir_config.file_to_exclude?(file)
-      return true if !hidden_files.include?(file) && ruby_file?(file)
+      return true if !hidden_files.bsearch do |hidden_file|
+        file <=> hidden_file
+      end && ruby_file?(file)
 
       base_dir_config.file_to_include?(file)
     end

data/lib/rubocop/target_ruby.rb

@@ -44,33 +44,61 @@ module RuboCop
     # The target ruby version may be found in a .ruby-version file.
     # @api private
     class RubyVersionFile < Source
-      FILENAME = '.ruby-version'
+      RUBY_VERSION_FILENAME = '.ruby-version'
+      RUBY_VERSION_PATTERN = /\A(?:ruby-)?(?<version>\d+\.\d+)/.freeze
 
       def name
-        "`#{FILENAME}`"
+        "`#{RUBY_VERSION_FILENAME}`"
       end
 
       private
 
+      def filename
+        RUBY_VERSION_FILENAME
+      end
+
+      def pattern
+        RUBY_VERSION_PATTERN
+      end
+
       def find_version
-        file = ruby_version_file
+        file = version_file
         return unless file && File.file?(file)
 
-        # rubocop:disable Lint/MixedRegexpCaptureTypes
-        # `(ruby-)` is not a capture type.
-        File.read(file).match(/\A(ruby-)?(?<version>\d+\.\d+)/) do |md|
-          # rubocop:enable Lint/MixedRegexpCaptureTypes
+        File.read(file).match(pattern) do |md|
           md[:version].to_f
         end
       end
 
-      def ruby_version_file
-        @ruby_version_file ||=
-          @config.find_file_upwards(FILENAME,
+      def version_file
+        @version_file ||=
+          @config.find_file_upwards(filename,
                                     @config.base_dir_for_path_parameters)
       end
     end
 
+    # The target ruby version may be found in a .tool-versions file, in a line
+    # starting with `ruby`.
+    # @api private
+    class ToolVersionsFile < RubyVersionFile
+      TOOL_VERSIONS_FILENAME = '.tool-versions'
+      TOOL_VERSIONS_PATTERN = /\Aruby (?:ruby-)?(?<version>\d+\.\d+)/.freeze
+
+      def name
+        "`#{TOOL_VERSIONS_FILENAME}`"
+      end
+
+      private
+
+      def filename
+        TOOL_VERSIONS_FILENAME
+      end
+
+      def pattern
+        TOOL_VERSIONS_PATTERN
+      end
+    end
+
     # The lock file of Bundler may identify the target ruby version.
     # @api private
     class BundlerLockFile < Source
@@ -194,7 +222,15 @@ module RuboCop
       KNOWN_RUBIES
     end
 
-    SOURCES = [RuboCopConfig, RubyVersionFile, BundlerLockFile, GemspecFile, Default].freeze
+    SOURCES = [
+      RuboCopConfig,
+      RubyVersionFile,
+      ToolVersionsFile,
+      BundlerLockFile,
+      GemspecFile,
+      Default
+    ].freeze
+
     private_constant :SOURCES
 
     def initialize(config)