rubocop 0.8.3 → 0.9.0

data/spec/rubocop/config_spec.rb

@@ -84,6 +84,67 @@ describe Rubocop::Config do
       end
     end
 
+    context 'when multiple config files exist in ancestor directories' do
+      let(:file_path) { 'dir/.rubocop.yml' }
+
+      before do
+        create_file('.rubocop.yml',
+                    ['AllCops:',
+                     '  Excludes:',
+                     '    - vendor/**',
+                    ])
+
+        create_file(file_path,
+                    ['AllCops:',
+                     '  Excludes: []',
+                    ])
+      end
+
+      it 'gets AllCops/Exclude from the highest directory level' do
+        excludes = configuration_from_file['AllCops']['Excludes']
+        expect(excludes).to eq(['../vendor/**'])
+      end
+    end
+
+    context 'when a file inherits from a parent file' do
+      let(:file_path) { 'dir/.rubocop.yml' }
+
+      before do
+        create_file('.rubocop.yml',
+                    ['AllCops:',
+                     '  Excludes:',
+                     '    - vendor/**',
+                     '    - !ruby/regexp /[A-Z]/',
+                    ])
+
+        create_file(file_path, ['inherit_from: ../.rubocop.yml'])
+      end
+
+      it 'gets AllCops/Exclude relative to its own directory' do
+        excludes = configuration_from_file['AllCops']['Excludes']
+        expect(excludes).to eq(['../vendor/**', /[A-Z]/])
+      end
+    end
+
+    context 'when a file inherits from a sibling file' do
+      let(:file_path) { 'dir/.rubocop.yml' }
+
+      before do
+        create_file('src/.rubocop.yml',
+                    ['AllCops:',
+                     '  Excludes:',
+                     '    - vendor/**',
+                    ])
+
+        create_file(file_path, ['inherit_from: ../src/.rubocop.yml'])
+      end
+
+      it 'gets AllCops/Exclude relative to its own directory' do
+        excludes = configuration_from_file['AllCops']['Excludes']
+        expect(excludes).to eq(['../src/vendor/**'])
+      end
+    end
+
     context 'when a file inherits from a parent and grandparent file' do
       let(:file_path) { 'dir/subdir/.rubocop.yml' }
 

data/spec/rubocop/config_store_spec.rb

@@ -47,8 +47,8 @@ module Rubocop
           Config.should_receive(:configuration_file_for).once.with('dir/' +
                                                                    'subdir')
           # The stub returns the same config path for dir and dir/subdir.
-          Config.should_receive(:configuration_from_file).once.
-            with('dir/.rubocop.yml')
+          Config.should_receive(:configuration_from_file).once
+            .with('dir/.rubocop.yml')
 
           ConfigStore.for('dir/file2')
           ConfigStore.for('dir/file2')

data/spec/rubocop/cops/cop_spec.rb

@@ -6,25 +6,32 @@ module Rubocop
   module Cop
     describe Cop do
       let(:cop) { Cop.new }
+      let(:location) do
+        source_buffer = Parser::Source::Buffer.new('test', 1)
+        source_buffer.source = "a\n"
+        Parser::Source::Range.new(source_buffer, 0, 1)
+      end
 
       it 'initially has 0 offences' do
         expect(cop.offences).to be_empty
       end
 
-      it 'initially has nothing to report' do
-        expect(cop.has_report?).to be_false
-      end
-
       it 'keeps track of offences' do
-        cop.add_offence(:convention, 1, 'message')
+        cop.add_offence(:convention, location, 'message')
 
         expect(cop.offences.size).to eq(1)
       end
 
       it 'will report registered offences' do
-        cop.add_offence(:convention, 1, 'message')
+        cop.add_offence(:convention, location, 'message')
+
+        expect(cop.offences).not_to be_empty
+      end
 
-        expect(cop.has_report?).to be_true
+      it 'registers offence with its name' do
+        cop = Style::AvoidFor.new
+        cop.add_offence(:convention, location, 'message')
+        expect(cop.offences.first.cop_name).to eq('AvoidFor')
       end
     end
   end

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

@@ -0,0 +1,111 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    module Lint
+      describe AssignmentInCondition do
+        let(:cop) { AssignmentInCondition.new }
+        before do
+          AssignmentInCondition.config = { 'AllowSafeAssignment' => true }
+        end
+
+        it 'registers an offence for lvar assignment in condition' do
+          inspect_source(cop,
+                         ['if test = 10',
+                          'end'
+                         ])
+          expect(cop.offences.size).to eq(1)
+        end
+
+        it 'registers an offence for lvar assignment in while condition' do
+          inspect_source(cop,
+                         ['while test = 10',
+                          'end'
+                         ])
+          expect(cop.offences.size).to eq(1)
+        end
+
+        it 'registers an offence for lvar assignment in until condition' do
+          inspect_source(cop,
+                         ['until test = 10',
+                          'end'
+                         ])
+          expect(cop.offences.size).to eq(1)
+        end
+
+        it 'registers an offence for ivar assignment in condition' do
+          inspect_source(cop,
+                         ['if @test = 10',
+                          'end'
+                         ])
+          expect(cop.offences.size).to eq(1)
+        end
+
+        it 'registers an offence for clvar assignment in condition' do
+          inspect_source(cop,
+                         ['if @@test = 10',
+                          'end'
+                         ])
+          expect(cop.offences.size).to eq(1)
+        end
+
+        it 'registers an offence for gvar assignment in condition' do
+          inspect_source(cop,
+                         ['if $test = 10',
+                          'end'
+                         ])
+          expect(cop.offences.size).to eq(1)
+        end
+
+        it 'registers an offence for constant assignment in condition' do
+          inspect_source(cop,
+                         ['if TEST = 10',
+                          'end'
+                         ])
+          expect(cop.offences.size).to eq(1)
+        end
+
+        it 'accepts == in condition' do
+          inspect_source(cop,
+                         ['if test == 10',
+                          'end'
+                         ])
+          expect(cop.offences).to be_empty
+        end
+
+        it 'accepts ||= in condition' do
+          inspect_source(cop,
+                         ['raise StandardError unless foo ||= bar'])
+          expect(cop.offences).to be_empty
+        end
+
+        context 'safe assignment is allowed' do
+          it 'accepts = in condition surrounded with braces' do
+            inspect_source(cop,
+                           ['if (test = 10)',
+                            'end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+        end
+
+        context 'safe assignment is not allowed' do
+          before do
+            AssignmentInCondition.config['AllowSafeAssignment'] = false
+          end
+
+          it 'does not accepts = in condition surrounded with braces' do
+            inspect_source(cop,
+                           ['if (test == 10)',
+                           'end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,426 @@
+# encoding: utf-8
+# rubocop:disable LineLength
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    module Lint
+      describe EndAlignment do
+        let(:cop) { EndAlignment.new }
+        before do
+          # TODO: Initialize the config to a default {} value. Currently it's nil.
+          EndAlignment.config = {}
+        end
+
+        it 'registers an offence for mismatched class end' do
+          inspect_source(cop,
+                         ['class Test',
+                          '  end'
+                         ])
+          expect(cop.offences.size).to eq(1)
+        end
+
+        it 'registers an offence for mismatched module end' do
+          inspect_source(cop,
+                         ['module Test',
+                          '  end'
+                         ])
+          expect(cop.offences.size).to eq(1)
+        end
+
+        it 'registers an offence for mismatched def end' do
+          inspect_source(cop,
+                         ['def test',
+                          '  end'
+                         ])
+          expect(cop.offences.size).to eq(1)
+        end
+
+        it 'registers an offence for mismatched defs end' do
+          inspect_source(cop,
+                         ['def Test.test',
+                          '  end'
+                         ])
+          expect(cop.offences.size).to eq(1)
+        end
+
+        it 'registers an offence for mismatched if end' do
+          inspect_source(cop,
+                         ['if test',
+                          '  end'
+                         ])
+          expect(cop.offences.size).to eq(1)
+        end
+
+        it 'registers an offence for mismatched while end' do
+          inspect_source(cop,
+                         ['while test',
+                          '  end'
+                         ])
+          expect(cop.offences.size).to eq(1)
+        end
+
+        it 'registers an offence for mismatched until end' do
+          inspect_source(cop,
+                         ['until test',
+                          '  end'
+                         ])
+          expect(cop.offences.size).to eq(1)
+        end
+
+        it 'registers an offence for mismatched block end' do
+          inspect_source(cop,
+                         ['test do |ala|',
+                          '  end'
+                         ])
+          expect(cop.offences.size).to eq(1)
+        end
+
+        context 'with BlockAlignSchema set to StartOfAssignment' do
+          before do
+            EndAlignment.config = { 'BlockAlignSchema' => 'StartOfAssignment' }
+          end
+
+          it 'accepts end aligned with a variable' do
+            inspect_source(cop,
+                           ['variable = test do |ala|',
+                            'end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end with a variable' do
+            inspect_source(cop,
+                           ['variable = test do |ala|',
+                            '  end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+
+          it 'accepts end aligned with an instance variable' do
+            inspect_source(cop,
+                           ['@variable = test do |ala|',
+                            'end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end with an instance variable' do
+            inspect_source(cop,
+                           ['@variable = test do |ala|',
+                            '  end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+
+          it 'accepts end aligned with a class variable' do
+            inspect_source(cop,
+                           ['@@variable = test do |ala|',
+                            'end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end with a class variable' do
+            inspect_source(cop,
+                           ['@@variable = test do |ala|',
+                            '  end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+
+          it 'accepts end aligned with a global variable' do
+            inspect_source(cop,
+                           ['$variable = test do |ala|',
+                            'end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end with a global variable' do
+            inspect_source(cop,
+                           ['$variable = test do |ala|',
+                            '  end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+
+          it 'accepts end aligned with a constant' do
+            inspect_source(cop,
+                           ['CONSTANT = test do |ala|',
+                            'end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end with a constant' do
+            inspect_source(cop,
+                           ['Module::CONSTANT = test do |ala|',
+                            '  end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+
+          it 'accepts end aligned with an attribute writer method' do
+            inspect_source(cop,
+                           ['parser.child.consumer = lambda do |token|',
+                            '  token << 1',
+                            'end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end with an attribute writer method' do
+            inspect_source(cop,
+                           ['parser.child.consumer = lambda do |token|',
+                            '  token << 1',
+                            '  end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+
+          it 'accepts end aligned with an op-asgn (+=, -=)' do
+            inspect_source(cop,
+                           ['rb += files.select do |file|',
+                            '  file << something',
+                            'end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end with an op-asgn (+=, -=)' do
+            inspect_source(cop,
+                           ['rb += files.select do |file|',
+                            '  file << something',
+                            '  end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+
+          it 'accepts end aligned with an and-asgn (&&=)' do
+            inspect_source(cop,
+                           ['variable &&= test do |ala|',
+                            'end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end with an and-asgn (&&=)' do
+            inspect_source(cop,
+                           ['variable &&= test do |ala|',
+                            '  end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+
+          it 'accepts end aligned with an or-asgn (||=)' do
+            inspect_source(cop,
+                           ['variable ||= test do |ala|',
+                            'end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end with an or-asgn (||=)' do
+            inspect_source(cop,
+                           ['variable ||= test do |ala|',
+                            '  end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+
+          it 'accepts end aligned with a mass assignment' do
+            inspect_source(cop,
+                           ['var1, var2 = lambda do |test|',
+                            '  [1, 2]',
+                            'end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end with a mass assignment' do
+            inspect_source(cop,
+                           ['var1, var2 = lambda do |test|',
+                            '  [1, 2]',
+                            '  end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+        end
+
+        context 'with BlockAlignSchema set to StartOfBlockCommand' do
+          before do
+            EndAlignment.config = { 'BlockAlignSchema' => 'StartOfBlockCommand' }
+          end
+
+          it 'accepts end aligned with the method that invokes the block' do
+            inspect_source(cop,
+                           ['variable = test do |ala|',
+                            '           end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end with the method that invokes the block' do
+            inspect_source(cop,
+                           ['variable = test do |ala|',
+                            'end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+
+          it 'accepts end aligned with the method when return value is assigned to instance variable' do
+            inspect_source(cop,
+                           ['@variable = test do |ala|',
+                            '            end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end when return value is assigned to instance variable' do
+            inspect_source(cop,
+                           ['@variable = test do |ala|',
+                            'end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+
+          it 'accepts end aligned with the method when return value is assigned to class variable' do
+            inspect_source(cop,
+                           ['@@variable = test do |ala|',
+                            '             end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end when return value is assigned to class variable' do
+            inspect_source(cop,
+                           ['@@variable = test do |ala|',
+                            'end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+
+          it 'accepts end aligned with the method when return value is assigned to global variable' do
+            inspect_source(cop,
+                           ['$variable = test do |ala|',
+                            '            end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end when return value is assigned to global variable' do
+            inspect_source(cop,
+                           ['$variable = test do |ala|',
+                            'end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+
+          it 'accepts end aligned with the method when return value is assigned to constant' do
+            inspect_source(cop,
+                           ['CONSTANT = test do |ala|',
+                            '           end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end when return value is assigned to constant' do
+            inspect_source(cop,
+                           ['Module::CONSTANT = test do |ala|',
+                            'end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+
+          it 'accepts end aligned with the method when return value is assigned to attribute writer method' do
+            inspect_source(cop,
+                           ['parser.child.consumer = lambda do |token|',
+                            '                          token << 1',
+                            '                        end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end when return value is assigned to attribute writer method' do
+            inspect_source(cop,
+                           ['parser.child.consumer = lambda do |token|',
+                            '  token << 1',
+                            'end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+
+          it 'accepts end aligned with the method when return value is assigned using op-asgn (+=, -=)' do
+            inspect_source(cop,
+                           ['rb += files.select do |file|',
+                            '        file << something',
+                            '      end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end when return value is assigned using op-asgn (+=, -=)' do
+            inspect_source(cop,
+                           ['rb += files.select do |file|',
+                            '  file << something',
+                            'end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+
+          it 'accepts end aligned with the method when return value is assigned using and-asgn (&&=)' do
+            inspect_source(cop,
+                           ['variable &&= test do |ala|',
+                            '             end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end when return value is assigned using and-asgn (&&=)' do
+            inspect_source(cop,
+                           ['variable &&= test do |ala|',
+                            'end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+
+          it 'accepts end aligned with the method when return value is assigned using or-asgn (||=)' do
+            inspect_source(cop,
+                           ['variable ||= test do |ala|',
+                            '             end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end when return value is assigned using or-asgn (||=)' do
+            inspect_source(cop,
+                           ['variable ||= test do |ala|',
+                            'end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+
+          it 'accepts end aligned with the method when return value is assigned using mass assignment' do
+            inspect_source(cop,
+                           ['var1, var2 = lambda do |test|',
+                            '               [1, 2]',
+                            '             end'
+                           ])
+            expect(cop.offences).to be_empty
+          end
+
+          it 'registers an offence for mismatched block end when return value is assigned using mass assignment' do
+            inspect_source(cop,
+                           ['var1, var2 = lambda do |test|',
+                            '  [1, 2]',
+                            'end'
+                           ])
+            expect(cop.offences.size).to eq(1)
+          end
+        end
+      end
+    end
+  end
+end