rubocop 0.23.0 → 0.24.0

data/spec/rubocop/runner_spec.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module RuboCop
+  class Runner
+    attr_writer :errors # Needed only for testing.
+  end
+end
+
+describe RuboCop::Runner, :isolated_environment do
+  include FileHelper
+
+  subject(:runner) { described_class.new(options, RuboCop::ConfigStore.new) }
+  let(:options) { { formatters: [['progress', formatter_output_path]] } }
+  let(:formatter_output_path) { 'formatter_output.txt' }
+  let(:formatter_output) { File.read(formatter_output_path) }
+
+  before do
+    create_file('example.rb', source)
+  end
+
+  describe '#run' do
+    context 'if there are no offenses in inspected files' do
+      let(:source) { <<-END.strip_indent }
+        # coding: utf-8
+        def valid_code
+        end
+      END
+
+      it 'returns true' do
+        expect(runner.run([])).to be true
+      end
+    end
+
+    context 'if there is an offense in an inspected file' do
+      let(:source) { <<-END.strip_indent }
+        # coding: utf-8
+        def INVALID_CODE
+        end
+      END
+
+      it 'returns false' do
+        expect(runner.run([])).to be false
+      end
+
+      it 'sends the offense to a formatter' do
+        runner.run([])
+        expect(formatter_output).to eq <<-END.strip_indent
+          Inspecting 1 file
+          C
+
+          Offenses:
+
+          example.rb:2:5: C: Use snake_case for methods.
+          def INVALID_CODE
+              ^^^^^^^^^^^^
+
+          1 file inspected, 1 offense detected
+        END
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -37,6 +37,7 @@ Rainbow.enabled = false
 
 module ExitCodeMatchers
   RSpec::Matchers.define :exit_with_code do |code|
+    supports_block_expectations
     actual = nil
     match do |block|
       begin
@@ -46,11 +47,11 @@ module ExitCodeMatchers
       end
       actual && actual == code
     end
-    failure_message_for_should do
+    failure_message do
       "expected block to call exit(#{code}) but exit" +
         (actual.nil? ? ' not called' : "(#{actual}) was called")
     end
-    failure_message_for_should_not do
+    failure_message_when_negated do
       "expected block not to call exit(#{code})"
     end
     description do
@@ -60,8 +61,6 @@ module ExitCodeMatchers
 end
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-
   # These two settings work together to allow you to limit a spec run
   # to individual examples or groups you care about by tagging them with
   # `:focus` metadata. When nothing is tagged with `:focus`, all examples
@@ -99,15 +98,14 @@ end
 
 def parse_source(source, file = nil)
   source = source.join($RS) if source.is_a?(Array)
-  if file.is_a? String
-    RuboCop::SourceParser.parse(source, file)
-  elsif file
+
+  if file && file.respond_to?(:write)
     file.write(source)
     file.rewind
-    RuboCop::SourceParser.parse(source, file.path)
-  else
-    RuboCop::SourceParser.parse(source)
+    file = file.path
   end
+
+  RuboCop::ProcessedSource.new(source, file)
 end
 
 def autocorrect_source_file(cop, source)

data/spec/support/shared_examples.rb

@@ -31,3 +31,25 @@ shared_examples_for 'mimics MRI 2.1' do |grep_mri_warning|
     end
   end
 end
+
+shared_examples_for 'misaligned' do |prefix, alignment_base, arg, end_kw, name|
+  name ||= alignment_base
+  it "registers an offense for mismatched #{name} ... end" do
+    inspect_source(cop, ["#{prefix}#{alignment_base} #{arg}",
+                         end_kw])
+    expect(cop.offenses.size).to eq(1)
+    regexp = /`end` at 2, \d+ is not aligned with `#{alignment_base}` at 1,/
+    expect(cop.messages.first).to match(regexp)
+    expect(cop.highlights.first).to eq('end')
+    expect(cop.config_to_allow_offenses).to eq('AlignWith' => opposite)
+  end
+end
+
+shared_examples_for 'aligned' do |alignment_base, arg, end_kw, name|
+  name ||= alignment_base
+  it "accepts matching #{name} ... end" do
+    inspect_source(cop, ["#{alignment_base} #{arg}",
+                         end_kw])
+    expect(cop.offenses).to be_empty
+  end
+end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Bozhidar Batsov
+- Jonas Arvidsson
+- Yuji Nakayama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-02 00:00:00.000000000 Z
+date: 2014-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -34,16 +36,22 @@ dependencies:
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0.pre.2
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.1.9
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0.pre.2
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.1.9
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: powerpack
   requirement: !ruby/object:Gem::Requirement
@@ -112,14 +120,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -165,7 +173,7 @@ dependencies:
 description: |2
       Automatic Ruby code style checking tool.
       Aims to enforce the community-driven Ruby Style Guide.
-email: bozhidar@batsov.com
+email: rubocop@googlegroups.com
 executables:
 - rubocop
 extensions: []
@@ -206,6 +214,7 @@ files:
 - lib/rubocop/cop/lint/block_alignment.rb
 - lib/rubocop/cop/lint/condition_position.rb
 - lib/rubocop/cop/lint/debugger.rb
+- lib/rubocop/cop/lint/def_end_alignment.rb
 - lib/rubocop/cop/lint/deprecated_class_methods.rb
 - lib/rubocop/cop/lint/else_layout.rb
 - lib/rubocop/cop/lint/empty_ensure.rb
@@ -236,6 +245,7 @@ files:
 - lib/rubocop/cop/lint/useless_else_without_rescue.rb
 - lib/rubocop/cop/lint/useless_setter_call.rb
 - lib/rubocop/cop/lint/void.rb
+- lib/rubocop/cop/mixin/access_modifier_node.rb
 - lib/rubocop/cop/mixin/annotation_comment.rb
 - lib/rubocop/cop/mixin/array_syntax.rb
 - lib/rubocop/cop/mixin/autocorrect_alignment.rb
@@ -246,6 +256,7 @@ files:
 - lib/rubocop/cop/mixin/configurable_enforced_style.rb
 - lib/rubocop/cop/mixin/configurable_max.rb
 - lib/rubocop/cop/mixin/configurable_naming.rb
+- lib/rubocop/cop/mixin/end_keyword_alignment.rb
 - lib/rubocop/cop/mixin/if_node.rb
 - lib/rubocop/cop/mixin/if_then_else.rb
 - lib/rubocop/cop/mixin/negative_conditional.rb
@@ -253,6 +264,7 @@ files:
 - lib/rubocop/cop/mixin/percent_literal.rb
 - lib/rubocop/cop/mixin/safe_assignment.rb
 - lib/rubocop/cop/mixin/space_after_punctuation.rb
+- lib/rubocop/cop/mixin/space_before_punctuation.rb
 - lib/rubocop/cop/mixin/space_inside.rb
 - lib/rubocop/cop/mixin/statement_modifier.rb
 - lib/rubocop/cop/mixin/string_help.rb
@@ -289,6 +301,7 @@ files:
 - lib/rubocop/cop/style/character_literal.rb
 - lib/rubocop/cop/style/class_and_module_camel_case.rb
 - lib/rubocop/cop/style/class_and_module_children.rb
+- lib/rubocop/cop/style/class_check.rb
 - lib/rubocop/cop/style/class_length.rb
 - lib/rubocop/cop/style/class_methods.rb
 - lib/rubocop/cop/style/class_vars.rb
@@ -379,8 +392,10 @@ files:
 - lib/rubocop/cop/style/space_around_equals_in_parameter_default.rb
 - lib/rubocop/cop/style/space_around_operators.rb
 - lib/rubocop/cop/style/space_before_block_braces.rb
+- lib/rubocop/cop/style/space_before_comma.rb
 - lib/rubocop/cop/style/space_before_comment.rb
 - lib/rubocop/cop/style/space_before_modifier_keyword.rb
+- lib/rubocop/cop/style/space_before_semicolon.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
@@ -395,6 +410,7 @@ files:
 - lib/rubocop/cop/style/trivial_accessors.rb
 - lib/rubocop/cop/style/unless_else.rb
 - lib/rubocop/cop/style/unneeded_capital_w.rb
+- lib/rubocop/cop/style/unneeded_percent_q.rb
 - lib/rubocop/cop/style/unneeded_percent_x.rb
 - lib/rubocop/cop/style/variable_interpolation.rb
 - lib/rubocop/cop/style/variable_name.rb
@@ -411,7 +427,6 @@ files:
 - lib/rubocop/cop/variable_force/scope.rb
 - lib/rubocop/cop/variable_force/variable.rb
 - lib/rubocop/cop/variable_force/variable_table.rb
-- lib/rubocop/file_inspector.rb
 - lib/rubocop/formatter/base_formatter.rb
 - lib/rubocop/formatter/clang_style_formatter.rb
 - lib/rubocop/formatter/colorizable.rb
@@ -429,7 +444,7 @@ files:
 - lib/rubocop/path_util.rb
 - lib/rubocop/processed_source.rb
 - lib/rubocop/rake_task.rb
-- lib/rubocop/source_parser.rb
+- lib/rubocop/runner.rb
 - lib/rubocop/target_finder.rb
 - lib/rubocop/token.rb
 - lib/rubocop/version.rb
@@ -440,6 +455,7 @@ files:
 - relnotes/v0.21.0.md
 - relnotes/v0.22.0.md
 - relnotes/v0.23.0.md
+- relnotes/v0.24.0.md
 - rubocop.gemspec
 - spec/.rubocop.yml
 - spec/isolated_environment_spec.rb
@@ -459,6 +475,7 @@ files:
 - spec/rubocop/cop/lint/block_alignment_spec.rb
 - spec/rubocop/cop/lint/condition_position_spec.rb
 - spec/rubocop/cop/lint/debugger_spec.rb
+- spec/rubocop/cop/lint/def_end_alignment_spec.rb
 - spec/rubocop/cop/lint/deprecated_class_methods_spec.rb
 - spec/rubocop/cop/lint/else_layout_spec.rb
 - spec/rubocop/cop/lint/empty_ensure_spec.rb
@@ -520,6 +537,7 @@ files:
 - spec/rubocop/cop/style/character_literal_spec.rb
 - spec/rubocop/cop/style/class_and_module_camel_case_spec.rb
 - spec/rubocop/cop/style/class_and_module_children_spec.rb
+- spec/rubocop/cop/style/class_check_spec.rb
 - spec/rubocop/cop/style/class_length_spec.rb
 - spec/rubocop/cop/style/class_methods_spec.rb
 - spec/rubocop/cop/style/class_vars_spec.rb
@@ -610,8 +628,10 @@ files:
 - spec/rubocop/cop/style/space_around_equals_in_parameter_default_spec.rb
 - spec/rubocop/cop/style/space_around_operators_spec.rb
 - spec/rubocop/cop/style/space_before_block_braces_spec.rb
+- spec/rubocop/cop/style/space_before_comma_spec.rb
 - spec/rubocop/cop/style/space_before_comment_spec.rb
 - spec/rubocop/cop/style/space_before_modifier_keyword_spec.rb
+- spec/rubocop/cop/style/space_before_semicolon_spec.rb
 - spec/rubocop/cop/style/space_inside_block_braces_spec.rb
 - spec/rubocop/cop/style/space_inside_brackets_spec.rb
 - spec/rubocop/cop/style/space_inside_hash_literal_braces_spec.rb
@@ -626,6 +646,7 @@ files:
 - spec/rubocop/cop/style/trivial_accessors_spec.rb
 - spec/rubocop/cop/style/unless_else_spec.rb
 - spec/rubocop/cop/style/unneeded_capital_w_spec.rb
+- spec/rubocop/cop/style/unneeded_percent_q_spec.rb
 - spec/rubocop/cop/style/unneeded_percent_x_spec.rb
 - spec/rubocop/cop/style/variable_interpolation_spec.rb
 - spec/rubocop/cop/style/variable_name_spec.rb
@@ -641,7 +662,6 @@ files:
 - spec/rubocop/cop/variable_force/variable_spec.rb
 - spec/rubocop/cop/variable_force/variable_table_spec.rb
 - spec/rubocop/cop/variable_force_spec.rb
-- spec/rubocop/file_inspector_spec.rb
 - spec/rubocop/formatter/base_formatter_spec.rb
 - spec/rubocop/formatter/clang_style_formatter_spec.rb
 - spec/rubocop/formatter/colorizable_spec.rb
@@ -658,7 +678,7 @@ files:
 - spec/rubocop/options_spec.rb
 - spec/rubocop/path_util_spec.rb
 - spec/rubocop/processed_source_spec.rb
-- spec/rubocop/source_parser_spec.rb
+- spec/rubocop/runner_spec.rb
 - spec/rubocop/target_finder_spec.rb
 - spec/rubocop/token_spec.rb
 - spec/spec_helper.rb
@@ -713,6 +733,7 @@ test_files:
 - spec/rubocop/cop/lint/block_alignment_spec.rb
 - spec/rubocop/cop/lint/condition_position_spec.rb
 - spec/rubocop/cop/lint/debugger_spec.rb
+- spec/rubocop/cop/lint/def_end_alignment_spec.rb
 - spec/rubocop/cop/lint/deprecated_class_methods_spec.rb
 - spec/rubocop/cop/lint/else_layout_spec.rb
 - spec/rubocop/cop/lint/empty_ensure_spec.rb
@@ -774,6 +795,7 @@ test_files:
 - spec/rubocop/cop/style/character_literal_spec.rb
 - spec/rubocop/cop/style/class_and_module_camel_case_spec.rb
 - spec/rubocop/cop/style/class_and_module_children_spec.rb
+- spec/rubocop/cop/style/class_check_spec.rb
 - spec/rubocop/cop/style/class_length_spec.rb
 - spec/rubocop/cop/style/class_methods_spec.rb
 - spec/rubocop/cop/style/class_vars_spec.rb
@@ -864,8 +886,10 @@ test_files:
 - spec/rubocop/cop/style/space_around_equals_in_parameter_default_spec.rb
 - spec/rubocop/cop/style/space_around_operators_spec.rb
 - spec/rubocop/cop/style/space_before_block_braces_spec.rb
+- spec/rubocop/cop/style/space_before_comma_spec.rb
 - spec/rubocop/cop/style/space_before_comment_spec.rb
 - spec/rubocop/cop/style/space_before_modifier_keyword_spec.rb
+- spec/rubocop/cop/style/space_before_semicolon_spec.rb
 - spec/rubocop/cop/style/space_inside_block_braces_spec.rb
 - spec/rubocop/cop/style/space_inside_brackets_spec.rb
 - spec/rubocop/cop/style/space_inside_hash_literal_braces_spec.rb
@@ -880,6 +904,7 @@ test_files:
 - spec/rubocop/cop/style/trivial_accessors_spec.rb
 - spec/rubocop/cop/style/unless_else_spec.rb
 - spec/rubocop/cop/style/unneeded_capital_w_spec.rb
+- spec/rubocop/cop/style/unneeded_percent_q_spec.rb
 - spec/rubocop/cop/style/unneeded_percent_x_spec.rb
 - spec/rubocop/cop/style/variable_interpolation_spec.rb
 - spec/rubocop/cop/style/variable_name_spec.rb
@@ -895,7 +920,6 @@ test_files:
 - spec/rubocop/cop/variable_force/variable_spec.rb
 - spec/rubocop/cop/variable_force/variable_table_spec.rb
 - spec/rubocop/cop/variable_force_spec.rb
-- spec/rubocop/file_inspector_spec.rb
 - spec/rubocop/formatter/base_formatter_spec.rb
 - spec/rubocop/formatter/clang_style_formatter_spec.rb
 - spec/rubocop/formatter/colorizable_spec.rb
@@ -912,7 +936,7 @@ test_files:
 - spec/rubocop/options_spec.rb
 - spec/rubocop/path_util_spec.rb
 - spec/rubocop/processed_source_spec.rb
-- spec/rubocop/source_parser_spec.rb
+- spec/rubocop/runner_spec.rb
 - spec/rubocop/target_finder_spec.rb
 - spec/rubocop/token_spec.rb
 - spec/spec_helper.rb

data/lib/rubocop/source_parser.rb

@@ -1,47 +0,0 @@
-# encoding: utf-8
-
-module RuboCop
-  # SourceParser provides a way to parse Ruby source with Parser gem
-  # and also parses comment directives which disable arbitrary cops.
-  module SourceParser
-    module_function
-
-    def parse_file(path)
-      parse(File.read(path), path)
-    end
-
-    def parse(string, name = '(string)')
-      source_buffer = Parser::Source::Buffer.new(name, 1)
-      source_buffer.source = string
-
-      parser = create_parser
-      diagnostics = []
-      parser.diagnostics.consumer = lambda do |diagnostic|
-        diagnostics << diagnostic
-      end
-
-      begin
-        ast, comments, tokens = parser.tokenize(source_buffer)
-      rescue Parser::SyntaxError # rubocop:disable Lint/HandleExceptions
-        # All errors are in diagnostics. No need to handle exception.
-      end
-
-      tokens = tokens.map { |t| Token.from_parser_token(t) } if tokens
-
-      ProcessedSource.new(source_buffer, ast, comments, tokens, diagnostics)
-    end
-
-    def create_parser
-      parser = Parser::CurrentRuby.new
-
-      # On JRuby and Rubinius, 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.
-      parser.diagnostics.all_errors_are_fatal = RUBY_ENGINE != 'ruby'
-      parser.diagnostics.ignore_warnings      = false
-
-      parser
-    end
-  end
-end

data/spec/rubocop/file_inspector_spec.rb

@@ -1,84 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-module RuboCop
-  class FileInspector
-    attr_writer :errors # Needed only for testing.
-  end
-end
-
-describe RuboCop::FileInspector do
-  subject(:inspector) { described_class.new(options) }
-  let(:options) { {} }
-  let(:offenses) { [] }
-  let(:errors) { [] }
-
-  before(:each) do
-    $stdout = StringIO.new
-    $stderr = StringIO.new
-
-    allow(inspector).to receive(:process_source) do
-      [double('ProcessedSource').as_null_object, []]
-    end
-
-    allow(inspector).to receive(:inspect_file) do
-      inspector.errors = errors
-      [offenses, !:updated_source_file]
-    end
-  end
-
-  after(:each) do
-    $stdout = STDOUT
-    $stderr = STDERR
-  end
-
-  describe '#display_error_summary' do
-    let(:errors) do
-      ['An error occurred while Encoding cop was inspecting file.rb.']
-    end
-
-    it 'displays an error message to stderr when errors are present' do
-      inspector.process_files(['file.rb'], nil) {}
-      inspector.display_error_summary
-      expect($stderr.string.lines.to_a[-6..-5])
-        .to eq(["1 error occurred:\n", "#{errors.first}\n"])
-    end
-  end
-
-  describe '#process_files' do
-    context 'if there are no offenses in inspected files' do
-      it 'returns false' do
-        result = inspector.process_files(['file.rb'], nil) {}
-        expect(result).to eq(false)
-      end
-    end
-
-    context 'if there is an offense in an inspected file' do
-      let(:offenses) do
-        [RuboCop::Cop::Offense.new(:convention,
-                                   Struct.new(:line, :column,
-                                              :source_line).new(1, 0, ''),
-                                   'Use alias_method instead of alias.',
-                                   'Alias')]
-      end
-
-      it 'returns true' do
-        expect(inspector.process_files(['file.rb'], nil) {}).to eq(true)
-      end
-
-      it 'sends the offense to a formatter' do
-        inspector.process_files(['file.rb'], nil) {}
-        expect($stdout.string.split("\n"))
-          .to eq(['Inspecting 1 file',
-                  'C',
-                  '',
-                  'Offenses:',
-                  '',
-                  "file.rb:1:1: C: #{offenses.first.message}",
-                  '',
-                  '1 file inspected, 1 offense detected'])
-      end
-    end
-  end
-end