rubocop 0.6.1 → 0.7.0

data/spec/rubocop/config_spec.rb

@@ -0,0 +1,399 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+DEFAULT_CONFIG = Rubocop::Config.load_file('config/default.yml')
+
+describe Rubocop::Config do
+  include FileHelper
+
+  subject(:configuration) { Rubocop::Config.new(hash, loaded_path) }
+  let(:hash) { {} }
+  let(:loaded_path) { 'example/.rubocop.yml' }
+
+  before { Rubocop::ConfigStore.prepare }
+
+  describe '.configuration_file_for', :isolated_environment do
+    subject(:configuration_file_for) do
+      Rubocop::Config.configuration_file_for(dir_path)
+    end
+
+    context 'when no config file exists in ancestor directories' do
+      let(:dir_path) { 'dir' }
+      before { create_file('dir/example.rb', '') }
+
+      context 'but a config file exists in home directory' do
+        before { create_file('~/.rubocop.yml', '') }
+
+        it 'returns the path to the file in home directory' do
+          expect(configuration_file_for).to end_with('home/.rubocop.yml')
+        end
+      end
+
+      context 'and no config file exists in home directory' do
+        it 'falls back to the provided default file' do
+          expect(configuration_file_for).to end_with('config/default.yml')
+        end
+      end
+    end
+
+    context 'when a config file exists in the parent directory' do
+      let(:dir_path) { 'dir' }
+
+      before do
+        create_file('dir/example.rb', '')
+        create_file('.rubocop.yml', '')
+      end
+
+      it 'returns the path to that configuration file' do
+        expect(configuration_file_for).to end_with('work/.rubocop.yml')
+      end
+    end
+
+    context 'when multiple config files exist in ancestor directories' do
+      let(:dir_path) { 'dir' }
+
+      before do
+        create_file('dir/example.rb', '')
+        create_file('dir/.rubocop.yml', '')
+        create_file('.rubocop.yml', '')
+      end
+
+      it 'prefers closer config file' do
+        expect(configuration_file_for).to end_with('dir/.rubocop.yml')
+      end
+    end
+  end
+
+  describe '.configuration_from_file', :isolated_environment do
+    subject(:configuration_from_file) do
+      Rubocop::Config.configuration_from_file(file_path)
+    end
+
+    context 'with any config file' do
+      let(:file_path) { '.rubocop.yml' }
+
+      before do
+        create_file(file_path, ['Encoding:',
+                                '  Enabled: false'])
+      end
+
+      it 'returns a configuration inheriting from default.yml' do
+        expect(configuration_from_file)
+          .to eq(DEFAULT_CONFIG.merge('Encoding' => { 'Enabled' => false }))
+      end
+    end
+
+    context 'when a file inherits from a parent and grandparent file' do
+      let(:file_path) { 'dir/subdir/.rubocop.yml' }
+
+      before do
+        create_file('dir/subdir/example.rb', '')
+
+        create_file('.rubocop.yml',
+                    ['LineLength:',
+                     '  Enabled: false',
+                     '  Max: 77'])
+
+        create_file('dir/.rubocop.yml',
+                    ['inherit_from: ../.rubocop.yml',
+                     '',
+                     'MethodLength:',
+                     '  Enabled: true',
+                     '  CountComments: false',
+                     '  Max: 10'
+                    ])
+
+        create_file(file_path,
+                    ['inherit_from: ../.rubocop.yml',
+                     '',
+                     'LineLength:',
+                     '  Enabled: true',
+                     '',
+                     'MethodLength:',
+                     '  Max: 5'
+                    ])
+      end
+
+      it 'returns the ancestor configuration plus local overrides' do
+        expect(configuration_from_file)
+          .to eq(DEFAULT_CONFIG.merge('LineLength' => {
+                                        'Enabled' => true,
+                                        'Max' => 77
+                                      },
+                                      'MethodLength' => {
+                                        'Enabled' => true,
+                                        'CountComments' => false,
+                                        'Max' => 5
+                                      }))
+      end
+    end
+
+    context 'when a file inherits from two configurations' do
+      let(:file_path) { '.rubocop.yml' }
+
+      before do
+        create_file('example.rb', '')
+
+        create_file('normal.yml',
+                    ['MethodLength:',
+                     '  Enabled: false',
+                     '  CountComments: true',
+                     '  Max: 79'])
+
+        create_file('special.yml',
+                    ['MethodLength:',
+                     '  Enabled: false',
+                     '  Max: 200'])
+
+        create_file(file_path,
+                    ['inherit_from:',
+                     '  - normal.yml',
+                     '  - special.yml',
+                     '',
+                     'MethodLength:',
+                     '  Enabled: true'
+                    ])
+      end
+
+      it 'returns values from the last one when possible' do
+        expect(configuration_from_file['MethodLength'])
+          .to eq('Enabled' => true,       # overridden in .rubocop.yml
+                 'CountComments' => true, # only defined in normal.yml
+                 'Max' => 200             # special.yml takes precedence
+                 )
+      end
+    end
+  end
+
+  describe '.load_file', :isolated_environment do
+    subject(:load_file) do
+      Rubocop::Config.load_file(configuration_path)
+    end
+
+    let(:configuration_path) { '.rubocop.yml' }
+
+    it 'returns a configuration loaded from the passed path' do
+      create_file(configuration_path, [
+        'Encoding:',
+        '  Enabled: true',
+      ])
+      configuration = load_file
+      expect(configuration['Encoding']).to eq({
+        'Enabled' => true
+      })
+    end
+  end
+
+  describe '.merge' do
+    subject(:merge) { Rubocop::Config.merge(base, derived) }
+
+    let(:base) do
+      {
+        'AllCops' => {
+          'Includes' => ['**/*.gemspec', '**/Rakefile'],
+          'Excludes' => []
+        }
+      }
+    end
+    let(:derived) do
+      { 'AllCops' => { 'Excludes' => ['example.rb', 'exclude_*'] } }
+    end
+
+    it 'returns a recursive merge of its two arguments' do
+      expect(merge).to eq('AllCops' => {
+                            'Includes' => ['**/*.gemspec', '**/Rakefile'],
+                            'Excludes' => ['example.rb', 'exclude_*']
+                          })
+    end
+  end
+
+  describe '#validate!', :isolated_environment do
+    # TODO: Because Config.load_file now outputs the validation warning,
+    #       it is inserting text into the rspec test output here.
+    #       The next 2 lines should be removed eventually.
+    before(:each) { $stdout = StringIO.new }
+    after(:each) { $stdout = STDOUT }
+
+    subject(:configuration) do
+      Rubocop::Config.load_file(configuration_path)
+    end
+
+    let(:configuration_path) { '.rubocop.yml' }
+
+    context 'when the configuration includes any unrecognized cop name' do
+      before do
+        create_file(configuration_path, [
+          'LyneLenth:',
+          '  Enabled: true',
+          '  Max: 100',
+        ])
+      end
+
+      it 'raises validation error' do
+        expect do
+          configuration.validate!
+        end.to raise_error(Rubocop::Config::ValidationError) do |error|
+          expect(error.message).to start_with('unrecognized cop LyneLenth')
+        end
+      end
+    end
+
+    context 'when the configuration includes any unrecognized parameter' do
+      before do
+        create_file(configuration_path, [
+          'LineLength:',
+          '  Enabled: true',
+          '  Min: 10',
+        ])
+      end
+
+      it 'raises validation error' do
+        expect do
+          configuration.validate!
+        end.to raise_error(Rubocop::Config::ValidationError) do |error|
+          expect(error.message).to
+            start_with('unrecognized parameter LineLength:Min')
+        end
+      end
+    end
+  end
+
+  describe '#file_to_include?' do
+    let(:hash) do
+      {
+        'AllCops' => {
+          'Includes' => ['Gemfile', 'config/unicorn.rb.example']
+        }
+      }
+    end
+
+    let(:loaded_path) { '/home/foo/project/.rubocop.yml' }
+
+    context 'when the passed path matches any of patterns to include' do
+      it 'returns true' do
+        file_path = '/home/foo/project/Gemfile'
+        expect(configuration.file_to_include?(file_path)).to be_true
+      end
+    end
+
+    context 'when the passed path does not match any of patterns to include' do
+      it 'returns false' do
+        file_path = '/home/foo/project/Gemfile.lock'
+        expect(configuration.file_to_include?(file_path)).to be_false
+      end
+    end
+  end
+
+  describe '#file_to_exclude?' do
+    let(:hash) do
+      {
+        'AllCops' => {
+          'Excludes' => ['log/*']
+        }
+      }
+    end
+
+    let(:loaded_path) { '/home/foo/project/.rubocop.yml' }
+
+    context 'when the passed path matches any of patterns to exclude' do
+      it 'returns true' do
+        file_path = '/home/foo/project/log/foo.rb'
+        expect(configuration.file_to_exclude?(file_path)).to be_true
+      end
+    end
+
+    context 'when the passed path does not match any of patterns to exclude' do
+      it 'returns false' do
+        file_path = '/home/foo/project/log_file.rb'
+        expect(configuration.file_to_exclude?(file_path)).to be_false
+      end
+    end
+  end
+
+  describe '#patterns_to_include' do
+    subject(:patterns_to_include) do
+      configuration = Rubocop::Config.new(hash, loaded_path)
+      configuration.patterns_to_include
+    end
+
+    let(:hash) { {} }
+    let(:loaded_path) { 'example/.rubocop.yml' }
+
+    context 'when config file has AllCops => Includes key' do
+      let(:hash) do
+        {
+          'AllCops' => {
+            'Includes' => ['Gemfile', 'config/unicorn.rb.example']
+          }
+        }
+      end
+
+      it 'returns the Includes value' do
+        expect(patterns_to_include).to eq([
+          'Gemfile',
+          'config/unicorn.rb.example'
+        ])
+      end
+    end
+  end
+
+  describe '#patterns_to_exclude' do
+    subject(:patterns_to_exclude) do
+      configuration = Rubocop::Config.new(hash, loaded_path)
+      configuration.patterns_to_exclude
+    end
+
+    let(:hash) { {} }
+    let(:loaded_path) { 'example/.rubocop.yml' }
+
+    context 'when config file has AllCops => Excludes key' do
+      let(:hash) do
+        {
+          'AllCops' => {
+            'Excludes' => ['log/*']
+          }
+        }
+      end
+
+      it 'returns the Excludes value' do
+        expect(patterns_to_exclude).to eq(['log/*'])
+      end
+    end
+  end
+
+  describe 'configuration for SymbolArray', :isolated_environment do
+    before do
+      create_file('example.rb', '# encoding: utf-8')
+    end
+
+    context 'when no config file exists for the target file' do
+      it 'is disabled' do
+        configuration = Rubocop::ConfigStore.for('example.rb')
+        expect(configuration.cop_enabled?('SymbolArray')).to be_false
+      end
+    end
+
+    context 'when a config file which does not mention SymbolArray exists' do
+      it 'is disabled' do
+        create_file('.rubocop.yml', [
+          'LineLength:',
+          '  Max: 79'
+        ])
+        configuration = Rubocop::ConfigStore.for('example.rb')
+        expect(configuration.cop_enabled?('SymbolArray')).to be_false
+      end
+    end
+
+    context 'when a config file which explicitly enables SymbolArray exists' do
+      it 'is enabled' do
+        create_file('.rubocop.yml', [
+          'SymbolArray:',
+          '  Enabled: true'
+        ])
+        configuration = Rubocop::ConfigStore.for('example.rb')
+        expect(configuration.cop_enabled?('SymbolArray')).to be_true
+      end
+    end
+  end
+end

data/spec/rubocop/config_store_spec.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Rubocop
+  describe ConfigStore do
+    before(:each) { ConfigStore.prepare }
+    before do
+      Config.stub(:configuration_file_for) do |arg|
+        # File tree:
+        # file1
+        # dir/.rubocop.yml
+        # dir/file2
+        # dir/subdir/file3
+        (arg =~ /dir/ ? 'dir' : '.') + '/.rubocop.yml'
+      end
+      Config.stub(:configuration_from_file) { |arg| arg }
+      Config.stub(:load_file) { |arg| "#{arg} loaded" }
+      Config.stub(:merge_with_default) { |config, file| "merged #{config}" }
+    end
+
+    describe '.prepare' do
+      it 'resets @options_config' do
+        ConfigStore.set_options_config(:options_config)
+        ConfigStore.prepare
+        Config.should_receive(:configuration_file_for)
+        ConfigStore.for('file1')
+      end
+
+      it 'resets @config_cache' do
+        ConfigStore.for('file1')
+        ConfigStore.prepare
+        Config.should_receive(:configuration_file_for)
+        ConfigStore.for('file1')
+      end
+    end
+
+    describe '.for' do
+      it 'always uses config specified in command line' do
+        ConfigStore.set_options_config(:options_config)
+        expect(ConfigStore.for('file1')).to eq('merged options_config loaded')
+      end
+
+      context 'when no config specified in command line' do
+        it 'gets config path and config from cache if available' do
+          Config.should_receive(:configuration_file_for).once.with('dir')
+          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')
+
+          ConfigStore.for('dir/file2')
+          ConfigStore.for('dir/file2')
+          ConfigStore.for('dir/subdir/file3')
+        end
+
+        it 'searches for config path if not available in cache' do
+          Config.should_receive(:configuration_file_for).once
+          Config.should_receive(:configuration_from_file).once
+          ConfigStore.for('file1')
+        end
+      end
+    end
+  end
+end