rubocop 0.49.1 → 0.52.0

data/lib/rubocop/path_util.rb

@@ -5,10 +5,14 @@ module RuboCop
   module PathUtil
     module_function
 
-    def relative_path(path, base_dir = Dir.pwd)
+    def relative_path(path, base_dir = PathUtil.pwd)
       # Optimization for the common case where path begins with the base
       # dir. Just cut off the first part.
-      return path[(base_dir.length + 1)..-1] if path.start_with?(base_dir)
+      if path.start_with?(base_dir)
+        base_dir_length = base_dir.length
+        result_length = path.length - base_dir_length - 1
+        return path[base_dir_length + 1, result_length]
+      end
 
       path_name = Pathname.new(File.expand_path(path))
       path_name.relative_path_from(Pathname.new(base_dir)).to_s
@@ -16,7 +20,7 @@ module RuboCop
 
     def smart_path(path)
       # Ideally, we calculate this relative to the project root.
-      base_dir = Dir.pwd
+      base_dir = PathUtil.pwd
 
       if path.start_with? base_dir
         relative_path(path, base_dir)
@@ -43,5 +47,13 @@ module RuboCop
     def absolute?(path)
       path =~ %r{\A([A-Z]:)?/}
     end
+
+    def self.pwd
+      @pwd ||= Dir.pwd
+    end
+
+    def self.reset_pwd
+      @pwd = nil
+    end
   end
 end

data/lib/rubocop/processed_source.rb

@@ -54,7 +54,7 @@ module RuboCop
     def lines
       @lines ||= begin
         all_lines = @buffer.source_lines
-        last_token_line = tokens.any? ? tokens.last.pos.line : all_lines.size
+        last_token_line = tokens.any? ? tokens.last.line : all_lines.size
         result = []
         all_lines.each_with_index do |line, ix|
           break if ix >= last_token_line && line == '__END__'
@@ -107,14 +107,9 @@ module RuboCop
       [ast, comments, tokens]
     end
 
-    def parser_class(ruby_version) # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/MethodLength
+    def parser_class(ruby_version)
       case ruby_version
-      when 1.9
-        require 'parser/ruby19'
-        Parser::Ruby19
-      when 2.0
-        require 'parser/ruby20'
-        Parser::Ruby20
       when 2.1
         require 'parser/ruby21'
         Parser::Ruby21
@@ -127,16 +122,20 @@ module RuboCop
       when 2.4
         require 'parser/ruby24'
         Parser::Ruby24
+      when 2.5
+        require 'parser/ruby25'
+        Parser::Ruby25
       else
         raise ArgumentError, "Unknown Ruby version: #{ruby_version.inspect}"
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     def create_parser(ruby_version)
       builder = RuboCop::AST::Builder.new
 
       parser_class(ruby_version).new(builder).tap do |parser|
-        # On JRuby and Rubinius, there's a risk that we hang in tokenize() if we
+        # On JRuby there's a risk that we hang in tokenize() if we
         # don't set the all errors as fatal flag. The problem is caused by a bug
         # in Racc that is discussed in issue #93 of the whitequark/parser
         # project on GitHub.

data/lib/rubocop/rake_task.rb

@@ -17,25 +17,21 @@ module RuboCop
     attr_accessor :requires
     attr_accessor :options
 
-    def initialize(*args, &task_block)
-      setup_ivars(args)
+    def initialize(name = :rubocop, *args, &task_block)
+      setup_ivars(name)
 
       desc 'Run RuboCop' unless ::Rake.application.last_description
 
       task(name, *args) do |_, task_args|
-        RakeFileUtils.send(:verbose, verbose) do
+        RakeFileUtils.verbose(verbose) do
           yield(*[self, task_args].slice(0, task_block.arity)) if block_given?
-          run_main_task(verbose)
+          run_cli(verbose, full_options)
         end
       end
 
       setup_subtasks(name, *args, &task_block)
     end
 
-    def run_main_task(verbose)
-      run_cli(verbose, full_options)
-    end
-
     private
 
     def run_cli(verbose, options)
@@ -50,19 +46,14 @@ module RuboCop
     end
 
     def full_options
-      [].tap do |result|
-        result.concat(formatters.map { |f| ['--format', f] }.flatten)
-        result.concat(requires.map { |r| ['--require', r] }.flatten)
-        result.concat(options.flatten)
-        result.concat(patterns)
-      end
+      formatters.map { |f| ['--format', f] }.flatten
+                .concat(requires.map { |r| ['--require', r] }.flatten)
+                .concat(options.flatten)
+                .concat(patterns)
     end
 
-    def setup_ivars(args)
-      # More lazy-loading to keep load time down.
-      require 'rubocop/options'
-
-      @name = args.shift || :rubocop
+    def setup_ivars(name)
+      @name = name
       @verbose = true
       @fail_on_error = true
       @patterns = []
@@ -72,13 +63,15 @@ module RuboCop
     end
 
     def setup_subtasks(name, *args, &task_block)
-      namespace name do
+      namespace(name) do
         desc 'Auto-correct RuboCop offenses'
 
         task(:auto_correct, *args) do |_, task_args|
-          yield(*[self, task_args].slice(0, task_block.arity)) if block_given?
-          options = full_options.unshift('--auto-correct')
-          run_cli(verbose, options)
+          RakeFileUtils.verbose(verbose) do
+            yield(*[self, task_args].slice(0, task_block.arity)) if block_given?
+            options = full_options.unshift('--auto-correct')
+            run_cli(verbose, options)
+          end
         end
       end
     end

data/lib/rubocop/remote_config.rb

@@ -6,6 +6,8 @@ require 'time'
 module RuboCop
   # Common methods and behaviors for dealing with remote config files.
   class RemoteConfig
+    attr_reader :uri
+
     CACHE_LIFETIME = 24 * 60 * 60
 
     def initialize(url, base_dir)
@@ -17,6 +19,8 @@ module RuboCop
       return cache_path unless cache_path_expired?
 
       request do |response|
+        next if response.is_a?(Net::HTTPNotModified)
+        next if response.is_a?(SocketError)
         open cache_path, 'w' do |io|
           io.write response.body
         end
@@ -25,6 +29,12 @@ module RuboCop
       cache_path
     end
 
+    def inherit_from_remote(file, path)
+      new_uri = @uri.dup
+      new_uri.path.gsub!(%r{/[^/]*$}, "/#{file}")
+      RemoteConfig.new(new_uri.to_s, File.dirname(path))
+    end
+
     private
 
     def request(uri = @uri, limit = 10, &block)
@@ -39,11 +49,13 @@ module RuboCop
       end
 
       handle_response(http.request(request), limit, &block)
+    rescue SocketError => err
+      handle_response(err, limit, &block)
     end
 
     def handle_response(response, limit, &block)
       case response
-      when Net::HTTPSuccess
+      when Net::HTTPSuccess, Net::HTTPNotModified, SocketError
         yield response
       when Net::HTTPRedirection
         request(URI.parse(response['location']), limit - 1, &block)

data/lib/rubocop/result_cache.rb

@@ -133,6 +133,7 @@ module RuboCop
 
     def file_checksum(file, config_store)
       Digest::MD5.hexdigest(Dir.pwd + file + IO.read(file) +
+                            File.stat(file).mode.to_s +
                             config_store.for(file).to_s)
     rescue Errno::ENOENT
       # Spurious files that come and go should not cause a crash, at least not

data/lib/rubocop/rspec/cop_helper.rb

@@ -10,15 +10,15 @@ module CopHelper
   let(:enabled_rails) { false }
   let(:rails_version) { false }
 
-  def inspect_source_file(cop, source)
-    Tempfile.open('tmp') { |f| inspect_source(cop, source, f) }
+  def inspect_source_file(source)
+    Tempfile.open('tmp') { |f| inspect_source(source, f) }
   end
 
-  def inspect_gemfile(cop, source)
-    inspect_source(cop, source, 'Gemfile')
+  def inspect_gemfile(source)
+    inspect_source(source, 'Gemfile')
   end
 
-  def inspect_source(cop, source, file = nil)
+  def inspect_source(source, file = nil)
     if source.is_a?(Array) && source.size == 1
       raise "Don't use an array for a single line of code: #{source}"
     end
@@ -41,11 +41,11 @@ module CopHelper
     RuboCop::ProcessedSource.new(source, ruby_version, file)
   end
 
-  def autocorrect_source_file(cop, source)
-    Tempfile.open('tmp') { |f| autocorrect_source(cop, source, f) }
+  def autocorrect_source_file(source)
+    Tempfile.open('tmp') { |f| autocorrect_source(source, f) }
   end
 
-  def autocorrect_source(cop, source, file = nil)
+  def autocorrect_source(source, file = nil)
     cop.instance_variable_get(:@options)[:auto_correct] = true
     processed_source = parse_source(source, file)
     _investigate(cop, processed_source)
@@ -55,10 +55,10 @@ module CopHelper
     corrector.rewrite
   end
 
-  def autocorrect_source_with_loop(cop, source, file = nil)
+  def autocorrect_source_with_loop(source, file = nil)
     loop do
       cop.instance_variable_set(:@corrections, [])
-      new_source = autocorrect_source(cop, source, file)
+      new_source = autocorrect_source(source, file)
       return new_source if new_source == source
       source = new_source
     end

data/lib/rubocop/rspec/expect_offense.rb

@@ -23,7 +23,7 @@ module RuboCop
     #
     # @example Equivalent assertion without `expect_offense`
     #
-    #     inspect_source(cop, <<-RUBY.strip_indent)
+    #     inspect_source(<<-RUBY.strip_indent)
     #       a do
     #         b
     #       end.c
@@ -44,23 +44,21 @@ module RuboCop
     # that there were no offenses. The `expect_offenses` method has
     # to do more work by parsing out lines that contain carets.
     module ExpectOffense
-      DEFAULT_FILENAME = 'example.rb'.freeze
-
-      def expect_offense(source, filename = DEFAULT_FILENAME)
+      def expect_offense(source, file = nil)
         expected_annotations = AnnotatedSource.parse(source)
 
         if expected_annotations.plain_source == source
           raise 'Use expect_no_offenses to assert that no offenses are found'
         end
 
-        inspect_source(cop, expected_annotations.plain_source, filename)
+        inspect_source(expected_annotations.plain_source, file)
         actual_annotations =
           expected_annotations.with_offense_annotations(cop.offenses)
-        expect(expected_annotations.to_s).to eq(actual_annotations.to_s)
+        expect(actual_annotations.to_s).to eq(expected_annotations.to_s)
       end
 
-      def expect_no_offenses(source, filename = DEFAULT_FILENAME)
-        inspect_source(cop, source, filename)
+      def expect_no_offenses(source, file = nil)
+        inspect_source(source, file)
 
         expect(cop.offenses).to be_empty
       end

data/lib/rubocop/rspec/shared_contexts.rb

@@ -57,14 +57,6 @@ shared_context 'config', :config do
   end
 end
 
-shared_context 'ruby 1.9', :ruby19 do
-  let(:ruby_version) { 1.9 }
-end
-
-shared_context 'ruby 2.0', :ruby20 do
-  let(:ruby_version) { 2.0 }
-end
-
 shared_context 'ruby 2.1', :ruby21 do
   let(:ruby_version) { 2.1 }
 end
@@ -81,6 +73,10 @@ shared_context 'ruby 2.4', :ruby24 do
   let(:ruby_version) { 2.4 }
 end
 
+shared_context 'ruby 2.5', :ruby25 do
+  let(:ruby_version) { 2.5 }
+end
+
 shared_context 'with Rails', :enabled_rails do
   let(:enabled_rails) { true }
 end

data/lib/rubocop/rspec/shared_examples.rb

@@ -4,7 +4,7 @@
 
 shared_examples_for 'accepts' do
   it 'accepts' do
-    inspect_source(cop, source)
+    inspect_source(source)
     expect(cop.offenses).to be_empty
   end
 end
@@ -12,7 +12,7 @@ end
 shared_examples_for 'mimics MRI 2.1' do |grep_mri_warning|
   if RUBY_ENGINE == 'ruby' && RUBY_VERSION.start_with?('2.1')
     it "mimics MRI #{RUBY_VERSION} built-in syntax checking" do
-      inspect_source(cop, source)
+      inspect_source(source)
       offenses_by_mri = MRISyntaxChecker.offenses_for_source(
         source, cop.name, grep_mri_warning
       )
@@ -38,7 +38,7 @@ shared_examples_for 'misaligned' do |prefix, alignment_base, arg, end_kw, name|
             end_kw]
 
   it "registers an offense for mismatched #{name} ... end" do
-    inspect_source(cop, source)
+    inspect_source(source)
     expect(cop.offenses.size).to eq(1)
     base_regexp = Regexp.escape(alignment_base)
     regexp = /`end` at 2, \d+ is not aligned with `#{base_regexp}` at 1,/
@@ -58,7 +58,7 @@ shared_examples_for 'misaligned' do |prefix, alignment_base, arg, end_kw, name|
   it "auto-corrects mismatched #{name} ... end" do
     aligned_source = ["#{prefix}#{alignment_base} #{arg}",
                       "#{' ' * prefix.length}#{end_kw.strip}"].join("\n")
-    corrected = autocorrect_source(cop, source)
+    corrected = autocorrect_source(source)
     expect(corrected).to eq(aligned_source)
   end
 end
@@ -67,15 +67,15 @@ shared_examples_for 'aligned' do |alignment_base, arg, end_kw, name|
   name ||= alignment_base
   name = name.gsub(/\n/, ' <newline>')
   it "accepts matching #{name} ... end" do
-    inspect_source(cop, ["#{alignment_base} #{arg}",
-                         end_kw])
+    inspect_source(["#{alignment_base} #{arg}",
+                    end_kw])
     expect(cop.offenses).to be_empty
   end
 end
 
 shared_examples_for 'debugger' do |name, src|
   it "reports an offense for a #{name} call" do
-    inspect_source(cop, src)
+    inspect_source(src)
     src = [src] if src.is_a? String
     expect(cop.offenses.size).to eq(src.size)
     expect(cop.messages)
@@ -86,7 +86,7 @@ end
 
 shared_examples_for 'non-debugger' do |name, src|
   it "does not report an offense for #{name}" do
-    inspect_source(cop, src)
+    inspect_source(src)
     expect(cop.offenses).to be_empty
   end
 end

data/lib/rubocop/rspec/support.rb

@@ -2,8 +2,8 @@
 
 # Require this file to load code that supports testing using RSpec.
 
-require 'rubocop/rspec/cop_helper'
-require 'rubocop/rspec/host_environment_simulation_helper'
-require 'rubocop/rspec/shared_contexts'
-require 'rubocop/rspec/shared_examples'
-require 'rubocop/rspec/expect_offense'
+require_relative 'cop_helper'
+require_relative 'host_environment_simulation_helper'
+require_relative 'shared_contexts'
+require_relative 'shared_examples'
+require_relative 'expect_offense'

data/lib/rubocop/runner.rb

@@ -47,7 +47,7 @@ module RuboCop
     private
 
     # Warms up the RuboCop cache by forking a suitable number of rubocop
-    # instances that each inspects its alotted group of files.
+    # instances that each inspects its allotted group of files.
     def warm_cache(target_files)
       puts 'Running parallel inspection' if @options[:debug]
       Parallel.each(target_files, &method(:file_offenses))

data/lib/rubocop/string_util.rb

@@ -46,6 +46,7 @@ module RuboCop
         compute_non_zero_distance(matched_count.to_f, transposition_count)
       end
 
+      # rubocop:disable Metrics/AbcSize
       def find_common_characters
         common_chars_of_shorter = Array.new(shorter.size)
         common_chars_of_longer = Array.new(longer.size)
@@ -68,6 +69,7 @@ module RuboCop
 
         [common_chars_of_shorter, common_chars_of_longer].map(&:compact)
       end
+      # rubocop:enable Metrics/AbcSize
 
       def count_transpositions(common_chars_a, common_chars_b)
         common_chars_a.size.times.count do |index|

data/lib/rubocop/token.rb

@@ -18,8 +18,82 @@ module RuboCop
       @text = text.to_s
     end
 
+    def line
+      pos.line
+    end
+
+    def column
+      pos.column
+    end
+
+    def begin_pos
+      pos.begin_pos
+    end
+
+    def end_pos
+      pos.end_pos
+    end
+
+    def comment?
+      type == :tCOMMENT
+    end
+
+    def semicolon?
+      type == :tSEMI
+    end
+
+    def left_array_bracket?
+      type == :tLBRACK
+    end
+
+    def left_ref_bracket?
+      type == :tLBRACK2
+    end
+
+    def right_bracket?
+      type == :tRBRACK
+    end
+
+    def left_brace?
+      type == :tLBRACE
+    end
+
+    def left_curly_brace?
+      type == :tLCURLY
+    end
+
+    def right_curly_brace?
+      type == :tRCURLY
+    end
+
+    def left_parens?
+      %i[tLPAREN tLPAREN2].include?(type)
+    end
+
+    def right_parens?
+      type == :tRPAREN
+    end
+
+    def comma?
+      type == :tCOMMA
+    end
+
+    def equal_sign?
+      %i[tEQL tOP_ASGN].include?(type)
+    end
+
     def to_s
       "[[#{@pos.line}, #{@pos.column}], #{@type}, #{@text.inspect}]"
     end
+
+    # Checks if there is whitespace after token
+    def space_after?
+      pos.source_buffer.source.match(/\G\s/, end_pos)
+    end
+
+    # Checks if there is whitespace before token
+    def space_before?
+      pos.source_buffer.source.match(/\G\s/, begin_pos - 1)
+    end
   end
 end