rubocop 0.40.0 → 0.41.0

data/{spec/support → lib/rubocop/rspec}/cop_helper.rb

@@ -3,6 +3,7 @@
 
 require 'tempfile'
 
+# This module provides methods that make it easier to test Cops.
 module CopHelper
   extend RSpec::SharedContext
 
@@ -64,6 +65,8 @@ end
 
 module RuboCop
   module Cop
+    # Monkey-patch Cop for tests to provide easy access to messages and
+    # highlights.
     class Cop
       def messages
         offenses.sort.map(&:message)

data/lib/rubocop/rspec/host_environment_simulation_helper.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+# RuboCop can be run in contexts where unexpected other libraries are included,
+# which may interfere with its normal behavior. In order to test those
+# situations, it may be necessary to require another library for the duration
+# of one spec
+module HostEnvironmentSimulatorHelper
+  def in_its_own_process_with(*files)
+    if ::Process.respond_to?(:fork)
+      pid = ::Process.fork do
+        # Need to write coverage result under different name
+        if defined?(SimpleCov)
+          SimpleCov.command_name "rspec_#{Process.pid}"
+          SimpleCov.pid = Process.pid
+        end
+
+        files.each { |file| require file }
+        yield
+      end
+      ::Process.wait(pid)
+
+      # assert that the block did not fail
+      expect($CHILD_STATUS).to be_success
+    else
+      warn 'Process.fork is not available.'
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include HostEnvironmentSimulatorHelper
+end

data/lib/rubocop/rspec/shared_contexts.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'tmpdir'
+require 'fileutils'
+
+shared_context 'isolated environment', :isolated_environment do
+  around do |example|
+    Dir.mktmpdir do |tmpdir|
+      original_home = ENV['HOME']
+
+      # Make sure to expand all symlinks in the path first. Otherwise we may
+      # get mismatched pathnames when loading config files later on.
+      tmpdir = File.realpath(tmpdir)
+
+      # Make upwards search for .rubocop.yml files stop at this directory.
+      RuboCop::ConfigLoader.root_level = tmpdir
+
+      begin
+        virtual_home = File.expand_path(File.join(tmpdir, 'home'))
+        Dir.mkdir(virtual_home)
+        ENV['HOME'] = virtual_home
+
+        working_dir = File.join(tmpdir, 'work')
+        Dir.mkdir(working_dir)
+
+        Dir.chdir(working_dir) do
+          example.run
+        end
+      ensure
+        ENV['HOME'] = original_home
+      end
+    end
+  end
+end
+
+# `cop_config` must be declared with #let.
+shared_context 'config', :config do
+  let(:config) do
+    # Module#<
+    unless described_class < RuboCop::Cop::Cop
+      raise '`config` must be used in `describe SomeCopClass do .. end`'
+    end
+
+    hash = { 'AllCops' => { 'TargetRubyVersion' => ruby_version } }
+    if respond_to?(:cop_config)
+      cop_name = described_class.cop_name
+      hash[cop_name] = RuboCop::ConfigLoader
+                       .default_configuration[cop_name]
+                       .merge(cop_config)
+    end
+
+    RuboCop::Config.new(hash, "#{Dir.pwd}/.rubocop.yml")
+  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
+
+shared_context 'ruby 2.2', :ruby22 do
+  let(:ruby_version) { 2.2 }
+end
+
+shared_context 'ruby 2.3', :ruby23 do
+  let(:ruby_version) { 2.3 }
+end

data/lib/rubocop/rspec/shared_examples.rb

@@ -0,0 +1,101 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+# `cop` and `source` must be declared with #let.
+
+shared_examples_for 'accepts' do
+  it 'accepts' do
+    inspect_source(cop, source)
+    expect(cop.offenses).to be_empty
+  end
+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)
+      offenses_by_mri = MRISyntaxChecker.offenses_for_source(
+        source, cop.name, grep_mri_warning
+      )
+
+      # Compare objects before comparing counts for clear failure output.
+      cop.offenses.each_with_index do |offense_by_cop, index|
+        offense_by_mri = offenses_by_mri[index]
+        # Exclude column attribute since MRI does not
+        # output column number.
+        [:severity, :line, :cop_name].each do |a|
+          expect(offense_by_cop.send(a)).to eq(offense_by_mri.send(a))
+        end
+      end
+
+      expect(cop.offenses.count).to eq(offenses_by_mri.count)
+    end
+  end
+end
+
+shared_examples_for 'misaligned' do |prefix, alignment_base, arg, end_kw, name|
+  name ||= alignment_base
+  source = ["#{prefix}#{alignment_base} #{arg}",
+            end_kw]
+
+  it "registers an offense for mismatched #{name} ... end" do
+    inspect_source(cop, 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,/
+    expect(cop.messages.first).to match(regexp)
+    expect(cop.highlights.first).to eq('end')
+
+    other_styles = (cop.supported_styles - [cop.style]).map(&:to_s)
+    # In some cases, the code under test will happen to match an alternative
+    # style. In other cases, it won't match any style at all
+    expect(cop.config_to_allow_offenses).to(
+      eq('Enabled' => false).or(
+        satisfy { |h| other_styles.include?(h['AlignWith']) }
+      )
+    )
+  end
+
+  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)
+    expect(corrected).to eq(aligned_source)
+  end
+end
+
+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])
+    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)
+    src = [src] if src.is_a? String
+    expect(cop.offenses.size).to eq(src.size)
+    expect(cop.messages)
+      .to eq(src.map { |s| "Remove debugger entry point `#{s}`." })
+    expect(cop.highlights).to eq(src)
+  end
+
+  it "can autocorrect a #{name} call" do
+    lines = src.is_a?(String) ? src : src.join("\n")
+    new_source = autocorrect_source(cop, ['def a',
+                                          "  #{lines}",
+                                          'end'].join("\n"))
+    expect(new_source).to eq("def a\nend")
+  end
+end
+
+shared_examples_for 'non-debugger' do |name, src|
+  it "does not report an offense for #{name}" do
+    inspect_source(cop, src)
+    expect(cop.offenses).to be_empty
+  end
+end

data/lib/rubocop/rspec/support.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+# 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'

data/lib/rubocop/runner.rb

@@ -7,7 +7,7 @@ module RuboCop
   class Runner # rubocop:disable Metrics/ClassLength
     # An exception indicating that the inspection loop got stuck correcting
     # offenses back and forth.
-    class InfiniteCorrectionLoop < Exception
+    class InfiniteCorrectionLoop < RuntimeError
       attr_reader :offenses
 
       def initialize(path, offenses)
@@ -273,7 +273,7 @@ module RuboCop
     end
 
     def get_processed_source(file)
-      ruby_version = @config_store.for(file).for_all_cops['TargetRubyVersion']
+      ruby_version = @config_store.for(file).target_ruby_version
 
       if @options[:stdin]
         ProcessedSource.new(@options[:stdin], ruby_version, file)

data/lib/rubocop/string_interpreter.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module RuboCop
+  # Take a string with embedded escapes, and convert the escapes as the Ruby
+  # interpreter would when reading a double-quoted string literal.
+  # For example, "\\n" will be converted to "\n".
+  class StringInterpreter
+    STRING_ESCAPES = {
+      '\a' => "\a", '\b' => "\b", '\e' => "\e", '\f' => "\f", '\n' => "\n",
+      '\r' => "\r", '\s' => ' ',  '\t' => "\t", '\v' => "\v", "\\\n" => ''
+    }.freeze
+    STRING_ESCAPE_REGEX = /\\(?:
+                            [abefnrstv\n]     |   # simple escapes (above)
+                            \d{1,3}           |   # octal byte escape
+                            x[0-9a-fA-F]{1,2} |   # hex byte escape
+                            u[0-9a-fA-F]{4}   |   # unicode char escape
+                            u\{[^}]*\}        |   # extended unicode escape
+                            .                     # any other escaped char
+                          )/x
+    class << self
+      def interpret(string)
+        # We currently don't handle \cx, \C-x, and \M-x
+        string.gsub(STRING_ESCAPE_REGEX) do |escape|
+          STRING_ESCAPES[escape] || interpret_string_escape(escape)
+        end
+      end
+
+      private
+
+      def interpret_string_escape(escape)
+        case escape[1]
+        when 'u'.freeze then interpret_unicode(escape)
+        when 'x'.freeze then interpret_hex(escape)
+        when /\d/       then interpret_octal(escape)
+        else
+          escape[1] # literal escaped char, like \\
+        end
+      end
+
+      def interpret_unicode(escape)
+        if escape[2] == '{'.freeze
+          escape[3..-1].split(/\s+/).map(&:hex).pack('U*'.freeze)
+        else
+          [escape[2..-1].hex].pack('U'.freeze)
+        end
+      end
+
+      def interpret_hex(escape)
+        [escape[2..-1].hex].pack('C'.freeze)
+      end
+
+      def interpret_octal(escape)
+        [escape[1..-1].to_i(8)].pack('C'.freeze)
+      end
+    end
+  end
+end

data/lib/rubocop/version.rb

@@ -4,7 +4,7 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '0.40.0'.freeze
+    STRING = '0.41.0'.freeze
 
     MSG = '%s (using Parser %s, running on %s %s %s)'.freeze
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 0.40.0
+  version: 0.41.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -38,7 +38,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.1.0
+        version: 2.3.1.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -48,7 +48,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.1.0
+        version: 2.3.1.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -175,6 +175,7 @@ files:
 - lib/rubocop/cop/lint/handle_exceptions.rb
 - lib/rubocop/cop/lint/implicit_string_concatenation.rb
 - lib/rubocop/cop/lint/ineffective_access_modifier.rb
+- lib/rubocop/cop/lint/inherit_exception.rb
 - lib/rubocop/cop/lint/invalid_character_literal.rb
 - lib/rubocop/cop/lint/literal_in_condition.rb
 - lib/rubocop/cop/lint/literal_in_interpolation.rb
@@ -183,9 +184,12 @@ files:
 - lib/rubocop/cop/lint/next_without_accumulator.rb
 - lib/rubocop/cop/lint/non_local_exit_from_iterator.rb
 - lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb
+- lib/rubocop/cop/lint/percent_string_array.rb
+- lib/rubocop/cop/lint/percent_symbol_array.rb
 - lib/rubocop/cop/lint/rand_one.rb
 - lib/rubocop/cop/lint/require_parentheses.rb
 - lib/rubocop/cop/lint/rescue_exception.rb
+- lib/rubocop/cop/lint/shadowed_exception.rb
 - lib/rubocop/cop/lint/shadowing_outer_local_variable.rb
 - lib/rubocop/cop/lint/string_conversion_in_interpolation.rb
 - lib/rubocop/cop/lint/syntax.rb
@@ -227,6 +231,8 @@ files:
 - lib/rubocop/cop/mixin/frozen_string_literal.rb
 - lib/rubocop/cop/mixin/hash_node.rb
 - lib/rubocop/cop/mixin/if_node.rb
+- lib/rubocop/cop/mixin/integer_node.rb
+- lib/rubocop/cop/mixin/match_range.rb
 - lib/rubocop/cop/mixin/method_complexity.rb
 - lib/rubocop/cop/mixin/method_preference.rb
 - lib/rubocop/cop/mixin/min_body_length.rb
@@ -260,6 +266,7 @@ files:
 - lib/rubocop/cop/performance/flat_map.rb
 - lib/rubocop/cop/performance/hash_each.rb
 - lib/rubocop/cop/performance/lstrip_rstrip.rb
+- lib/rubocop/cop/performance/push_splat.rb
 - lib/rubocop/cop/performance/range_include.rb
 - lib/rubocop/cop/performance/redundant_block_call.rb
 - lib/rubocop/cop/performance/redundant_match.rb
@@ -274,12 +281,15 @@ files:
 - lib/rubocop/cop/rails/action_filter.rb
 - lib/rubocop/cop/rails/date.rb
 - lib/rubocop/cop/rails/delegate.rb
+- lib/rubocop/cop/rails/exit.rb
 - lib/rubocop/cop/rails/find_by.rb
 - lib/rubocop/cop/rails/find_each.rb
 - lib/rubocop/cop/rails/has_and_belongs_to_many.rb
 - lib/rubocop/cop/rails/output.rb
+- lib/rubocop/cop/rails/output_safety.rb
 - lib/rubocop/cop/rails/pluralization_grammar.rb
 - lib/rubocop/cop/rails/read_write_attribute.rb
+- lib/rubocop/cop/rails/request_referer.rb
 - lib/rubocop/cop/rails/scope_args.rb
 - lib/rubocop/cop/rails/time_zone.rb
 - lib/rubocop/cop/rails/uniq_before_pluck.rb
@@ -321,10 +331,10 @@ files:
 - lib/rubocop/cop/style/constant_name.rb
 - lib/rubocop/cop/style/copyright.rb
 - lib/rubocop/cop/style/def_with_parentheses.rb
-- lib/rubocop/cop/style/deprecated_hash_methods.rb
 - lib/rubocop/cop/style/documentation.rb
 - lib/rubocop/cop/style/dot_position.rb
 - lib/rubocop/cop/style/double_negation.rb
+- lib/rubocop/cop/style/each_for_simple_loop.rb
 - lib/rubocop/cop/style/each_with_object.rb
 - lib/rubocop/cop/style/else_alignment.rb
 - lib/rubocop/cop/style/empty_case_condition.rb
@@ -360,6 +370,7 @@ files:
 - lib/rubocop/cop/style/if_unless_modifier.rb
 - lib/rubocop/cop/style/if_unless_modifier_of_if_unless.rb
 - lib/rubocop/cop/style/if_with_semicolon.rb
+- lib/rubocop/cop/style/implicit_runtime_error.rb
 - lib/rubocop/cop/style/indent_array.rb
 - lib/rubocop/cop/style/indent_assignment.rb
 - lib/rubocop/cop/style/indent_hash.rb
@@ -399,6 +410,7 @@ files:
 - lib/rubocop/cop/style/nil_comparison.rb
 - lib/rubocop/cop/style/non_nil_check.rb
 - lib/rubocop/cop/style/not.rb
+- lib/rubocop/cop/style/numeric_literal_prefix.rb
 - lib/rubocop/cop/style/numeric_literals.rb
 - lib/rubocop/cop/style/one_line_conditional.rb
 - lib/rubocop/cop/style/op_method.rb
@@ -410,6 +422,7 @@ files:
 - lib/rubocop/cop/style/percent_q_literals.rb
 - lib/rubocop/cop/style/perl_backrefs.rb
 - lib/rubocop/cop/style/predicate_name.rb
+- lib/rubocop/cop/style/preferred_hash_methods.rb
 - lib/rubocop/cop/style/proc.rb
 - lib/rubocop/cop/style/raise_args.rb
 - lib/rubocop/cop/style/redundant_begin.rb
@@ -441,10 +454,12 @@ files:
 - lib/rubocop/cop/style/space_before_comment.rb
 - lib/rubocop/cop/style/space_before_first_arg.rb
 - lib/rubocop/cop/style/space_before_semicolon.rb
+- lib/rubocop/cop/style/space_inside_array_percent_literal.rb
 - lib/rubocop/cop/style/space_inside_block_braces.rb
 - lib/rubocop/cop/style/space_inside_brackets.rb
 - lib/rubocop/cop/style/space_inside_hash_literal_braces.rb
 - lib/rubocop/cop/style/space_inside_parens.rb
+- lib/rubocop/cop/style/space_inside_percent_literal_delimiters.rb
 - lib/rubocop/cop/style/space_inside_range_literal.rb
 - lib/rubocop/cop/style/space_inside_string_interpolation.rb
 - lib/rubocop/cop/style/special_global_vars.rb
@@ -508,13 +523,18 @@ files:
 - lib/rubocop/rake_task.rb
 - lib/rubocop/remote_config.rb
 - lib/rubocop/result_cache.rb
+- lib/rubocop/rspec/cop_helper.rb
+- lib/rubocop/rspec/host_environment_simulation_helper.rb
+- lib/rubocop/rspec/shared_contexts.rb
+- lib/rubocop/rspec/shared_examples.rb
+- lib/rubocop/rspec/support.rb
 - lib/rubocop/runner.rb
+- lib/rubocop/string_interpreter.rb
 - lib/rubocop/string_util.rb
 - lib/rubocop/target_finder.rb
 - lib/rubocop/token.rb
 - lib/rubocop/version.rb
 - lib/rubocop/warning.rb
-- spec/support/cop_helper.rb
 homepage: http://github.com/bbatsov/rubocop
 licenses:
 - MIT
@@ -535,7 +555,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Automatic Ruby code style checking tool.