rubocop 0.10.0 → 0.11.0

data/lib/rubocop/formatter/clang_style_formatter.rb

@@ -11,9 +11,14 @@ module Rubocop
           output.printf("%s:%d:%d: %s: %s\n",
                         smart_path(file).color(:cyan), o.line, o.real_column,
                         o.clang_severity, o.message)
-          output.puts(o.location.source_line)
-          output.puts(' ' * o.location.column +
-                      '^' * o.location.column_range.count)
+
+          source_line = o.location.source_line
+
+          unless source_line.strip.empty?
+            output.puts(source_line)
+            output.puts(' ' * o.location.column +
+                        '^' * o.location.column_range.count)
+          end
         end
       end
     end

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+module Rubocop
+  module Formatter
+    # This formatter displays a YAML configuration file where all cops that
+    # detected any offences are disabled.
+    class DisabledConfigFormatter < BaseFormatter
+      HEADING =
+        ['# This configuration was generated by `rubocop --auto-gen-config`.',
+         '# The point is for the user to remove these configuration records',
+         '# one by one as the offences are removed from the code base.']
+        .join("\n")
+
+      def file_finished(file, offences)
+        @cops_with_offences ||= {}
+        offences.each { |o| @cops_with_offences[o.cop_name] = true }
+      end
+
+      def finished(inspected_files)
+        output.puts HEADING
+        @cops_with_offences.keys.sort.each do |cop_name|
+          output.puts
+          output.puts "#{cop_name}:"
+          output.puts '  Enabled: false'
+        end
+        puts "Created #{output.path}."
+        puts "Run rubocop with --config #{output.path}, or"
+        puts "add inherit_from: #{output.path} in a .rubocop.yml file."
+      end
+    end
+  end
+end

data/lib/rubocop/formatter/formatter_set.rb

@@ -27,11 +27,14 @@ module Rubocop
         end
       end
 
-      def add_formatter(formatter_key, output_path = nil)
-        formatter_class = if formatter_key =~ /\A[A-Z]/
-                            custom_formatter_class(formatter_key)
+      def add_formatter(formatter_type, output_path = nil)
+        formatter_class = case formatter_type
+                          when Class
+                            formatter_type
+                          when /\A[A-Z]/
+                            custom_formatter_class(formatter_type)
                           else
-                            builtin_formatter_class(formatter_key)
+                            builtin_formatter_class(formatter_type)
                           end
 
         output = output_path ? File.open(output_path, 'w') : $stdout

data/lib/rubocop/target_finder.rb

@@ -37,7 +37,8 @@ module Rubocop
     # as its first line.
     # It is possible to specify includes and excludes using the config file,
     # so you can include other Ruby files like Rakefiles and gemspecs.
-    # @param root Root directory under which to search for ruby source files
+    # @param base_dir Root directory under which to search for
+    #   ruby source files
     # @return [Array] Array of filenames
     def target_files_in_dir(base_dir = Dir.pwd)
       files = Dir["#{base_dir}/**/*"].select { |path| FileTest.file?(path) }
@@ -58,9 +59,7 @@ module Rubocop
       first_line = File.open(file) { |f| f.readline }
       first_line =~ /#!.*ruby/
     rescue EOFError, ArgumentError => e
-      if @debug
-        warn "Unprocessable file #{file}: #{e.class}, #{e.message}"
-      end
+      warn "Unprocessable file #{file}: #{e.class}, #{e.message}" if @debug
       false
     end
   end

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module Rubocop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '0.10.0'
+    STRING = '0.11.0'
 
     MSG = '%s (using Parser %s, running on %s %s %s)'
 

data/rubocop.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   s.summary = 'Automatic Ruby code style checking tool.'
 
   s.add_runtime_dependency('rainbow', '>= 1.1.4')
-  s.add_runtime_dependency('parser', '2.0.0.pre2')
+  s.add_runtime_dependency('parser', '~> 2.0.0.pre6')
   s.add_runtime_dependency('backports', '~> 3.3.3')
   s.add_runtime_dependency('powerpack', '0.0.1')
   s.add_development_dependency('rake', '~> 10.1')

data/spec/rubocop/cli_spec.rb

@@ -13,6 +13,7 @@ module Rubocop
     before(:each) do
       $stdout = StringIO.new
       $stderr = StringIO.new
+      Config.debug = false
     end
 
     after(:each) do
@@ -41,6 +42,8 @@ Usage: rubocop [options] [file1, file2, ...]
     -d, --debug                      Display debug info.
     -c, --config FILE                Specify configuration file.
         --only COP                   Run just one cop.
+        --auto-gen-config            Generate a configuration file acting as a
+                                     TODO list.
     -f, --format FORMATTER           Choose an output formatter. This option
                                      can be specified multiple times to enable
                                      multiple formatters at the same time.
@@ -120,7 +123,7 @@ Usage: rubocop [options] [file1, file2, ...]
       it 'adds a handler for SIGINT' do
         expect(@interrupt_handlers).to be_empty
         cli.trap_interrupt
-        expect(@interrupt_handlers).to have(1).item
+        expect(@interrupt_handlers.size).to eq(1)
       end
 
       context 'with SIGINT once' do
@@ -268,6 +271,76 @@ Usage: rubocop [options] [file1, file2, ...]
                 ''].join("\n"))
     end
 
+    it 'exits with error if asked to re-generate a todo list that is in use' do
+      create_file('example1.rb', ['# encoding: utf-8',
+                                  'x= 0 ',
+                                  '#' * 85,
+                                  'y ',
+                                  'puts x'])
+      todo_contents = ['# This configuration was generated with `rubocop' +
+                       ' --auto-gen-config`',
+                       '',
+                       'LineLength:',
+                       '  Enabled: false']
+      create_file('rubocop-todo.yml', todo_contents)
+      expect(IO.read('rubocop-todo.yml'))
+        .to eq(todo_contents.join("\n") + "\n")
+      create_file('.rubocop.yml', ['inherit_from: rubocop-todo.yml'])
+      expect(cli.run(['--auto-gen-config'])).to eq(1)
+      expect($stderr.string).to eq('Remove rubocop-todo.yml from the current' +
+                                   ' configuration before generating it' +
+                                   " again.\n")
+    end
+
+    it 'exits with error if file arguments are given with --auto-gen-config' do
+      create_file('example1.rb', ['# encoding: utf-8',
+                                  'x= 0 ',
+                                  '#' * 85,
+                                  'y ',
+                                  'puts x'])
+      expect(cli.run(['--auto-gen-config', 'example1.rb'])).to eq(1)
+      expect($stderr.string).to eq('--auto-gen-config can not be combined ' +
+                                   "with any other arguments.\n")
+      expect($stdout.string).to eq('')
+    end
+
+    it 'can generate a todo list' do
+      create_file('example1.rb', ['# encoding: utf-8',
+                                  'x= 0 ',
+                                  '#' * 85,
+                                  'y ',
+                                  'puts x'])
+      create_file('example2.rb', ['# encoding: utf-8',
+                                  "\tx = 0",
+                                  'puts x'])
+      expect(cli.run(['--auto-gen-config'])).to eq(1)
+      expect($stderr.string).to eq('')
+      expect($stdout.string).to include([
+        'Created rubocop-todo.yml.',
+        'Run rubocop with --config rubocop-todo.yml, or',
+        'add inherit_from: rubocop-todo.yml in a .rubocop.yml file.',
+        ''].join("\n"))
+      expect(IO.read('rubocop-todo.yml'))
+        .to eq(['# This configuration was generated by `rubocop' +
+                ' --auto-gen-config`.',
+                '# The point is for the user to remove these configuration' +
+                ' records',
+                '# one by one as the offences are removed from the code base.',
+                '',
+                'LineLength:',
+                '  Enabled: false',
+                '',
+                'SpaceAroundOperators:',
+                '  Enabled: false',
+                '',
+                'Tab:',
+                '  Enabled: false',
+                '',
+                'TrailingWhitespace:',
+                '  Enabled: false',
+                ''].join("\n"))
+    end
+
     it 'runs just one cop if --only is passed' do
       create_file('example.rb', ['if x== 0 ',
                                  "\ty",
@@ -344,6 +417,22 @@ Usage: rubocop [options] [file1, file2, ...]
          ''].join("\n"))
     end
 
+    it 'shows config files when --debug is passed', ruby: 2.0 do
+      create_file('example1.rb', "\tputs 0")
+      expect(cli.run(['--debug', 'example1.rb'])).to eq(1)
+      home = File.dirname(File.dirname(File.dirname(__FILE__)))
+      expect($stdout.string.lines[2, 7].map(&:chomp).join("\n"))
+        .to eq(["For #{abs('')}:" +
+                " configuration from #{home}/config/default.yml",
+                "Inheriting configuration from #{home}/config/enabled.yml",
+                "Inheriting configuration from #{home}/config/disabled.yml",
+                "AllCops/Excludes configuration from #{home}/.rubocop.yml",
+                "Inheriting configuration from #{home}/config/default.yml",
+                "Inheriting configuration from #{home}/config/enabled.yml",
+                "Inheriting configuration from #{home}/config/disabled.yml"
+               ].join("\n"))
+    end
+
     it 'shows cop names when --debug is passed', ruby: 2.0 do
       create_file('example1.rb', "\tputs 0")
       expect(cli.run(['--format',

data/spec/rubocop/cops/commissioner_spec.rb

@@ -48,7 +48,7 @@ module Rubocop
 
           commissioner.investigate(processed_source)
 
-          expect(commissioner.errors[cop]).to have(1).item
+          expect(commissioner.errors[cop].size).to eq(1)
           expect(commissioner.errors[cop][0]).to be_instance_of(RuntimeError)
         end
 

data/spec/rubocop/cops/lint/assignment_in_condition_spec.rb

@@ -75,6 +75,12 @@ module Rubocop
           expect(cop.offences).to be_empty
         end
 
+        it 'accepts = in a block that is called in a condition' do
+          inspect_source(cop,
+                         ['return 1 if any_errors? { o = inspect(file) }'])
+          expect(cop.offences).to be_empty
+        end
+
         it 'accepts ||= in condition' do
           inspect_source(cop,
                          ['raise StandardError unless foo ||= bar'])

data/spec/rubocop/cops/lint/block_alignment_spec.rb

@@ -98,7 +98,7 @@ module Rubocop
         end
 
         context 'when the method part is a call chain that spans several lines' do
-          it 'accepts end aligned with first character of line where do is' do
+          it 'registers offences for pretty multiline chaining' do
             src = ['def foo(bar)',
                    '  bar.get_stuffs',
                    '      .reject do |stuff| ',
@@ -111,7 +111,10 @@ module Rubocop
                    '      end',
                    'end']
             inspect_source(cop, src)
-            expect(cop.offences.map(&:message)).to eq([])
+            expect(cop.offences.map(&:message))
+              .to eq(['end at 10, 6 is not aligned with bar.get_stuffs at 2, 2',
+                      'end at 7, 6 is not aligned with bar.get_stuffs at 2, 2',
+                      'end at 5, 6 is not aligned with bar.get_stuffs at 2, 2'])
           end
 
           it 'registers offences for misaligned ends' do
@@ -127,7 +130,16 @@ module Rubocop
                    '        end',
                    'end']
             inspect_source(cop, src)
-            expect(cop.offences).to have(3).items
+            expect(cop.offences.size).to eq(3)
+          end
+
+          it 'accepts end indented as the start of the block' do
+            src = ['my_object.chaining_this_very_long_method(with_a_parameter)',
+                   '    .and_one_with_a_block do',
+                   '  do_something',
+                   'end']
+            inspect_source(cop, src)
+            expect(cop.offences).to be_empty
           end
         end
 
@@ -147,7 +159,7 @@ module Rubocop
                    '  i - 5',
                    '    end']
             inspect_source(cop, src)
-            expect(cop.offences).to have(1).item
+            expect(cop.offences.size).to eq(1)
           end
         end
 

data/spec/rubocop/cops/lint/empty_ensure_spec.rb

@@ -14,7 +14,7 @@ module Rubocop
                           '  something',
                           'ensure',
                           'end'])
-          expect(cop.offences).to have(1).item
+          expect(cop.offences.size).to eq(1)
         end
 
         it 'does not register an offence for non-empty ensure' do

data/spec/rubocop/cops/lint/ensure_return_spec.rb

@@ -16,7 +16,7 @@ module Rubocop
                           '  file.close',
                           '  return',
                           'end'])
-          expect(cop.offences).to have(1).item
+          expect(cop.offences.size).to eq(1)
         end
 
         it 'does not register an offence for return outside ensure' do

data/spec/rubocop/cops/lint/shadowing_outer_local_variable_spec.rb

@@ -23,7 +23,7 @@ module Rubocop
 
           it 'registers an offence' do
             inspect_source(cop, source)
-            expect(cop.offences).to have(1).item
+            expect(cop.offences.size).to eq(1)
             expect(cop.offences.first.message)
               .to include('Shadowing outer local variable - foo')
             expect(cop.offences.first.line).to eq(4)
@@ -47,7 +47,7 @@ module Rubocop
 
           it 'registers an offence' do
             inspect_source(cop, source)
-            expect(cop.offences).to have(1).item
+            expect(cop.offences.size).to eq(1)
             expect(cop.offences.first.message)
               .to include('Shadowing outer local variable - foo')
             expect(cop.offences.first.line).to eq(4)
@@ -73,7 +73,7 @@ module Rubocop
 
           it 'registers an offence' do
             inspect_source(cop, source)
-            expect(cop.offences).to have(1).item
+            expect(cop.offences.size).to eq(1)
             expect(cop.offences.first.message)
               .to include('Shadowing outer local variable - foo')
             expect(cop.offences.first.line).to eq(4)
@@ -98,7 +98,7 @@ module Rubocop
 
           it 'registers an offence' do
             inspect_source(cop, source)
-            expect(cop.offences).to have(1).item
+            expect(cop.offences.size).to eq(1)
             expect(cop.offences.first.message)
               .to include('Shadowing outer local variable - foo')
             expect(cop.offences.first.line).to eq(4)

data/spec/rubocop/cops/lint/unused_local_variable_spec.rb

@@ -25,7 +25,7 @@ module Rubocop
 
           it 'registers an offence' do
             inspect_source(cop, source)
-            expect(cop.offences).to have(1).item
+            expect(cop.offences.size).to eq(1)
             expect(cop.offences.first.message)
               .to include('unused variable - foo')
             expect(cop.offences.first.line).to eq(5)
@@ -52,7 +52,7 @@ module Rubocop
 
           it 'registers an offence' do
             inspect_source(cop, source)
-            expect(cop.offences).to have(1).item
+            expect(cop.offences.size).to eq(1)
             expect(cop.offences.first.message)
               .to include('unused variable - foo')
             expect(cop.offences.first.line).to eq(5)
@@ -80,7 +80,7 @@ module Rubocop
 
           it 'registers an offence' do
             inspect_source(cop, source)
-            expect(cop.offences).to have(1).item
+            expect(cop.offences.size).to eq(1)
             expect(cop.offences.first.message)
               .to include('unused variable - foo')
             expect(cop.offences.first.line).to eq(6)
@@ -106,7 +106,7 @@ module Rubocop
 
           it 'registers an offence' do
             inspect_source(cop, source)
-            expect(cop.offences).to have(1).item
+            expect(cop.offences.size).to eq(1)
             expect(cop.offences.first.message)
               .to include('unused variable - foo')
             expect(cop.offences.first.line).to eq(5)
@@ -134,7 +134,7 @@ module Rubocop
 
           it 'registers an offence' do
             inspect_source(cop, source)
-            expect(cop.offences).to have(1).item
+            expect(cop.offences.size).to eq(1)
             expect(cop.offences.first.message)
               .to include('unused variable - foo')
             expect(cop.offences.first.line).to eq(6)
@@ -160,7 +160,7 @@ module Rubocop
 
           it 'registers an offence' do
             inspect_source(cop, source)
-            expect(cop.offences).to have(1).item
+            expect(cop.offences.size).to eq(1)
             expect(cop.offences.first.message)
               .to include('unused variable - foo')
             expect(cop.offences.first.line).to eq(5)
@@ -180,7 +180,7 @@ module Rubocop
 
           it 'registers an offence' do
             inspect_source(cop, source)
-            expect(cop.offences).to have(1).item
+            expect(cop.offences.size).to eq(1)
             expect(cop.offences.first.message)
               .to include('unused variable - foo')
             expect(cop.offences.first.line).to eq(1)
@@ -249,7 +249,7 @@ module Rubocop
 
           it 'registers an offence' do
             inspect_source(cop, source)
-            expect(cop.offences).to have(1).item
+            expect(cop.offences.size).to eq(1)
             expect(cop.offences.first.message)
               .to include('unused variable - foo')
             expect(cop.offences.first.line).to eq(1)
@@ -271,6 +271,42 @@ module Rubocop
           include_examples 'mimics MRI 2.0'
         end
 
+        context 'when a variable is assigned in loop body ' +
+                'and referenced in post while condition' do
+          let(:source) do
+            [
+              'begin',
+              '  if foo',
+              '    foo += 1',
+              '  else',
+              '    foo = 1',
+              '  end',
+              'end while foo < 10'
+            ]
+          end
+
+          include_examples 'accepts'
+          include_examples 'mimics MRI 2.0'
+        end
+
+        context 'when a variable is assigned in loop body ' +
+                'and referenced in post until condition' do
+          let(:source) do
+            [
+              'begin',
+              '  if foo',
+              '    foo += 1',
+              '  else',
+              '    foo = 1',
+              '  end',
+              'end until foo > 10'
+            ]
+          end
+
+          include_examples 'accepts'
+          include_examples 'mimics MRI 2.0'
+        end
+
         context 'when a named capture is unreferenced in top level' do
           let(:source) do
             [
@@ -280,7 +316,7 @@ module Rubocop
 
           it 'registers an offence' do
             inspect_source(cop, source)
-            expect(cop.offences).to have(1).item
+            expect(cop.offences.size).to eq(1)
             expect(cop.offences.first.message)
               .to include('unused variable - foo')
             expect(cop.offences.first.line).to eq(1)
@@ -301,7 +337,7 @@ module Rubocop
 
           it 'registers an offence' do
             inspect_source(cop, source)
-            expect(cop.offences).to have(1).item
+            expect(cop.offences.size).to eq(1)
             expect(cop.offences.first.message)
               .to include('unused variable - foo')
             expect(cop.offences.first.line).to eq(2)
@@ -358,7 +394,7 @@ module Rubocop
 
           it 'registers an offence' do
             inspect_source(cop, source)
-            expect(cop.offences).to have(1).item
+            expect(cop.offences.size).to eq(1)
             expect(cop.offences.first.message)
               .to include('unused variable - foo')
             expect(cop.offences.first.line).to eq(2)
@@ -488,7 +524,7 @@ module Rubocop
 
           it 'registers an offence' do
             inspect_source(cop, source)
-            expect(cop.offences).to have(1).item
+            expect(cop.offences.size).to eq(1)
             expect(cop.offences.first.message)
               .to include('unused variable - foo')
             expect(cop.offences.first.line).to eq(1)
@@ -523,7 +559,7 @@ module Rubocop
 
             it 'registers an offence' do
               inspect_source(cop, source)
-              expect(cop.offences).to have(1).item
+              expect(cop.offences.size).to eq(1)
               expect(cop.offences.first.message)
                 .to include('unused variable - foo')
               expect(cop.offences.first.line).to eq(1)