rubocop 0.13.1 → 0.14.0

data/spec/rubocop/cop/variable_inspector_spec.rb

@@ -2,30 +2,26 @@
 
 require 'spec_helper'
 
-module Rubocop
-  module Cop
-    describe VariableInspector do
-      include AST::Sexp
+describe Rubocop::Cop::VariableInspector do
+  include AST::Sexp
 
-      class ExampleInspector
-        include VariableInspector
-      end
+  class ExampleInspector
+    include Rubocop::Cop::VariableInspector
+  end
 
-      subject(:inspector) { ExampleInspector.new }
+  subject(:inspector) { ExampleInspector.new }
 
-      describe '#process_node' do
-        before do
-          inspector.variable_table.push_scope(s(:def))
-        end
+  describe '#process_node' do
+    before do
+      inspector.variable_table.push_scope(s(:def))
+    end
 
-        context 'when processing lvar node' do
-          let(:node) { s(:lvar, :foo) }
+    context 'when processing lvar node' do
+      let(:node) { s(:lvar, :foo) }
 
-          context 'when the variable is not yet declared' do
-            it 'does not raise error' do
-              expect { inspector.process_node(node) }.not_to raise_error
-            end
-          end
+      context 'when the variable is not yet declared' do
+        it 'does not raise error' do
+          expect { inspector.process_node(node) }.not_to raise_error
         end
       end
     end

data/spec/rubocop/formatter/clang_style_formatter_spec.rb

@@ -6,43 +6,9 @@ require 'stringio'
 module Rubocop
   module Formatter
     describe ClangStyleFormatter do
-      subject(:formatter) { ClangStyleFormatter.new(output) }
+      subject(:formatter) { described_class.new(output) }
       let(:output) { StringIO.new }
 
-      describe '#report_summary' do
-        context 'when no files inspected' do
-          it 'handles pluralization correctly' do
-            formatter.report_summary(0, 0)
-            expect(output.string).to eq(
-              "\n0 files inspected, no offences detected\n")
-          end
-        end
-
-        context 'when a file inspected and no offences detected' do
-          it 'handles pluralization correctly' do
-            formatter.report_summary(1, 0)
-            expect(output.string).to eq(
-              "\n1 file inspected, no offences detected\n")
-          end
-        end
-
-        context 'when a offence detected' do
-          it 'handles pluralization correctly' do
-            formatter.report_summary(1, 1)
-            expect(output.string).to eq(
-              "\n1 file inspected, 1 offence detected\n")
-          end
-        end
-
-        context 'when 2 offences detected' do
-          it 'handles pluralization correctly' do
-            formatter.report_summary(2, 2)
-            expect(output.string).to eq(
-              "\n2 files inspected, 2 offences detected\n")
-          end
-        end
-      end
-
       describe '#report_file' do
         it 'displays text containing the offending source line' do
           cop = Cop::Cop.new
@@ -73,7 +39,7 @@ module Rubocop
                           Parser::Source::Range.new(source_buffer, 0, 2),
                           'message 1')
           cop.add_offence(:fatal, nil,
-                          Parser::Source::Range.new(source_buffer, 6, 4),
+                          Parser::Source::Range.new(source_buffer, 6, 10),
                           'message 2')
 
           formatter.report_file('test', cop.offences)
@@ -83,6 +49,39 @@ module Rubocop
                                        '^^^^',
                                        ''].join("\n")
         end
+
+        let(:file) { '/path/to/file' }
+
+        let(:offence) do
+          Cop::Offence.new(:convention, location,
+                           'This is a message.', 'CopName', corrected)
+        end
+
+        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
+
+        context 'when the offence is not corrected' do
+          let(:corrected) { false }
+
+          it 'prints message as-is' do
+            formatter.report_file(file, [offence])
+            expect(output.string)
+              .to include(': This is a message.')
+          end
+        end
+
+        context 'when the offence is automatically corrected' do
+          let(:corrected) { true }
+
+          it 'prints [Corrected] along with message' do
+            formatter.report_file(file, [offence])
+            expect(output.string)
+              .to include(': [Corrected] This is a message.')
+          end
+        end
       end
     end
   end

data/spec/rubocop/formatter/disabled_config_formatter_spec.rb

@@ -7,7 +7,7 @@ require 'ostruct'
 module Rubocop
   module Formatter
     describe DisabledConfigFormatter do
-      subject(:formatter) { DisabledConfigFormatter.new(output) }
+      subject(:formatter) { described_class.new(output) }
       let(:output) do
         o = StringIO.new
         def o.path
@@ -26,7 +26,7 @@ module Rubocop
         it 'displays YAML configuration disabling all cops with offences' do
           formatter.file_finished('test.rb', offences)
           formatter.finished(['test.rb'])
-          expect(output.string).to eq(DisabledConfigFormatter::HEADING +
+          expect(output.string).to eq(described_class::HEADING +
                                       ['',
                                        '',
                                        'Cop1:',

data/spec/rubocop/formatter/emacs_style_formatter_spec.rb

@@ -6,7 +6,7 @@ require 'stringio'
 module Rubocop
   module Formatter
     describe EmacsStyleFormatter do
-      subject(:formatter) { EmacsStyleFormatter.new(output) }
+      subject(:formatter) { described_class.new(output) }
       let(:output) { StringIO.new }
 
       describe '#file_finished' do
@@ -26,6 +26,29 @@ module Rubocop
           expect(output.string).to eq ['test:1:1: C: message 1',
                                        "test:3:6: F: message 2\n"].join("\n")
         end
+
+        context 'when the offence is automatically corrected' do
+          let(:file) { '/path/to/file' }
+
+          let(:offence) do
+            Cop::Offence.new(:convention, location,
+                             'This is a message.', 'CopName', corrected)
+          end
+
+          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
+
+          let(:corrected) { true }
+
+          it 'prints [Corrected] along with message' do
+            formatter.file_finished(file, [offence])
+            expect(output.string)
+              .to include(': [Corrected] This is a message.')
+          end
+        end
       end
 
       describe '#finished' do

data/spec/rubocop/formatter/file_list_formatter_spec.rb

@@ -6,7 +6,7 @@ require 'stringio'
 module Rubocop
   module Formatter
     describe FileListFormatter do
-      subject(:formatter) { FileListFormatter.new(output) }
+      subject(:formatter) { described_class.new(output) }
       let(:output) { StringIO.new }
 
       describe '#file_finished' do

data/spec/rubocop/formatter/formatter_set_spec.rb

@@ -6,7 +6,7 @@ require 'tempfile'
 module Rubocop
   module Formatter
     describe FormatterSet do
-      subject(:formatter_set) { FormatterSet.new }
+      subject(:formatter_set) { described_class.new }
 
       it 'responds to all formatter API methods' do
         [:started, :file_started, :file_finished, :finished].each do |method|
@@ -88,7 +88,7 @@ module Rubocop
 
       describe '#builtin_formatter_class' do
         def builtin_formatter_class(string)
-          FormatterSet.new.send(:builtin_formatter_class, string)
+          described_class.new.send(:builtin_formatter_class, string)
         end
 
         it 'returns class which matches passed alias name exactly' do
@@ -105,7 +105,7 @@ module Rubocop
 
       describe '#custom_formatter_class' do
         def custom_formatter_class(string)
-          FormatterSet.new.send(:custom_formatter_class, string)
+          described_class.new.send(:custom_formatter_class, string)
         end
 
         it 'returns constant represented by the passed string' do

data/spec/rubocop/formatter/json_formatter_spec.rb

@@ -5,7 +5,7 @@ require 'stringio'
 
 module Rubocop
   describe Formatter::JSONFormatter do
-    subject(:formatter) { Formatter::JSONFormatter.new(output) }
+    subject(:formatter) { described_class.new(output) }
     let(:output) { StringIO.new }
     let(:files) { %w(/path/to/file1 /path/to/file2) }
     let(:location) do
@@ -14,7 +14,8 @@ module Rubocop
       Parser::Source::Range.new(source_buffer, 9, 10)
     end
     let(:offence) do
-      Cop::Offence.new(:convention, location, 'This is message', 'CopName')
+      Cop::Offence.new(:convention, location,
+                       'This is message', 'CopName', true)
     end
 
     describe '#started' do
@@ -116,6 +117,10 @@ module Rubocop
         expect(hash[:cop_name]).to eq('CopName')
       end
 
+      it 'sets Offence#corrected? value for :corrected key' do
+        expect(hash[:corrected]).to be_true
+      end
+
       before do
         formatter.stub(:hash_for_location).and_return(location_hash)
       end

data/spec/rubocop/formatter/offence_count_formatter_spec.rb

@@ -7,7 +7,7 @@ require 'tempfile'
 module Rubocop
   module Formatter
     describe OffenceCountFormatter do
-      subject(:formatter) { Formatter::OffenceCountFormatter.new(output) }
+      subject(:formatter) { described_class.new(output) }
       let(:output) { StringIO.new }
 
       let(:files) do

data/spec/rubocop/formatter/progress_formatter_spec.rb

@@ -5,7 +5,7 @@ require 'stringio'
 
 module Rubocop
   describe Formatter::ProgressFormatter do
-    subject(:formatter) { Formatter::ProgressFormatter.new(output) }
+    subject(:formatter) { described_class.new(output) }
     let(:output) { StringIO.new }
 
     let(:files) do

data/spec/rubocop/formatter/simple_text_formatter_spec.rb

@@ -7,14 +7,29 @@ require 'tempfile'
 module Rubocop
   module Formatter
     describe SimpleTextFormatter do
-      subject(:formatter) { SimpleTextFormatter.new(output) }
+      subject(:formatter) { described_class.new(output) }
       let(:output) { StringIO.new }
 
       describe '#report_file' do
         before do
-          formatter.report_file(file, [])
+          formatter.report_file(file, [offence])
         end
 
+        let(:file) { '/path/to/file' }
+
+        let(:offence) do
+          Cop::Offence.new(:convention, location,
+                           'This is a message.', 'CopName', corrected)
+        end
+
+        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
+
+        let(:corrected) { false }
+
         context 'the file is under the current working directory' do
           let(:file) { File.expand_path('spec/spec_helper.rb') }
 
@@ -34,12 +49,30 @@ module Rubocop
             expect(output.string).to include("== #{file} ==")
           end
         end
+
+        context 'when the offence is not corrected' do
+          let(:corrected) { false }
+
+          it 'prints message as-is' do
+            expect(output.string)
+              .to include(': This is a message.')
+          end
+        end
+
+        context 'when the offence is automatically corrected' do
+          let(:corrected) { true }
+
+          it 'prints [Corrected] along with message' do
+            expect(output.string)
+              .to include(': [Corrected] This is a message.')
+          end
+        end
       end
 
       describe '#report_summary' do
         context 'when no files inspected' do
           it 'handles pluralization correctly' do
-            formatter.report_summary(0, 0)
+            formatter.report_summary(0, 0, 0)
             expect(output.string).to eq(
               "\n0 files inspected, no offences detected\n")
           end
@@ -47,7 +80,7 @@ module Rubocop
 
         context 'when a file inspected and no offences detected' do
           it 'handles pluralization correctly' do
-            formatter.report_summary(1, 0)
+            formatter.report_summary(1, 0, 0)
             expect(output.string).to eq(
               "\n1 file inspected, no offences detected\n")
           end
@@ -55,7 +88,7 @@ module Rubocop
 
         context 'when a offence detected' do
           it 'handles pluralization correctly' do
-            formatter.report_summary(1, 1)
+            formatter.report_summary(1, 1, 0)
             expect(output.string).to eq(
               "\n1 file inspected, 1 offence detected\n")
           end
@@ -63,11 +96,27 @@ module Rubocop
 
         context 'when 2 offences detected' do
           it 'handles pluralization correctly' do
-            formatter.report_summary(2, 2)
+            formatter.report_summary(2, 2, 0)
             expect(output.string).to eq(
               "\n2 files inspected, 2 offences detected\n")
           end
         end
+
+        context 'when an offence is corrected' do
+          it 'prints about correction' do
+            formatter.report_summary(1, 1, 1)
+            expect(output.string).to eq(
+              "\n1 file inspected, 1 offence detected, 1 offence corrected\n")
+          end
+        end
+
+        context 'when 2 offences are corrected' do
+          it 'handles pluralization correctly' do
+            formatter.report_summary(1, 1, 2)
+            expect(output.string).to eq(
+              "\n1 file inspected, 1 offence detected, 2 offences corrected\n")
+          end
+        end
       end
     end
   end

data/spec/rubocop/options_spec.rb

@@ -0,0 +1,233 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Options, :isolated_environment do
+  include FileHelper
+
+  subject(:options) { described_class.new(config_store) }
+  let(:config_store) { Rubocop::ConfigStore.new }
+
+  before(:each) do
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+  end
+
+  after(:each) do
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+
+  def abs(path)
+    File.expand_path(path)
+  end
+
+  describe 'option' do
+    describe '-h/--help' do
+      it 'exits cleanly' do
+        expect { options.parse ['-h'] }.to exit_with_code(0)
+        expect { options.parse ['--help'] }.to exit_with_code(0)
+      end
+
+      it 'shows help text' do
+        begin
+          options.parse(['--help'])
+        rescue SystemExit # rubocop:disable HandleExceptions
+        end
+
+        expected_help = <<-END
+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.
+        --show-cops                  Shows cops and their config for the
+                                     current directory.
+    -f, --format FORMATTER           Choose an output formatter. This option
+                                     can be specified multiple times to enable
+                                     multiple formatters at the same time.
+                                       [p]rogress (default)
+                                       [s]imple
+                                       [c]lang
+                                       [e]macs
+                                       [j]son
+                                       [f]iles
+                                       [o]ffences
+                                       custom formatter class name
+    -o, --out FILE                   Write output to a file instead of STDOUT.
+                                     This option applies to the previously
+                                     specified --format, or the default format
+                                     if no format is specified.
+    -r, --require FILE               Require Ruby file.
+    -R, --rails                      Run extra Rails cops.
+    -l, --lint                       Run only lint cops.
+    -a, --auto-correct               Auto-correct offences.
+    -n, --no-color                   Disable color output.
+    -v, --version                    Display version.
+    -V, --verbose-version            Display verbose version.
+      END
+
+        expect($stdout.string).to eq(expected_help)
+      end
+
+      it 'lists all builtin formatters' do
+        begin
+          options.parse(['--help'])
+        rescue SystemExit # rubocop:disable HandleExceptions
+        end
+
+        option_sections = $stdout.string.lines.slice_before(/^\s*-/)
+
+        format_section = option_sections.find do |lines|
+          lines.first =~ /^\s*-f/
+        end
+
+        formatter_keys = format_section.reduce([]) do |keys, line|
+          match = line.match(/^[ ]{39}(\[[a-z\]]+)/)
+          next keys unless match
+          keys << match.captures.first.gsub(/\[|\]/, '')
+        end.sort
+
+        expected_formatter_keys =
+          Rubocop::Formatter::FormatterSet::BUILTIN_FORMATTERS_FOR_KEYS
+          .keys.sort
+
+        expect(formatter_keys).to eq(expected_formatter_keys)
+      end
+    end
+
+    describe '--version' do
+      it 'exits cleanly' do
+        expect { options.parse ['-v'] }.to exit_with_code(0)
+        expect { options.parse ['--version'] }.to exit_with_code(0)
+        expect($stdout.string).to eq((Rubocop::Version::STRING + "\n") * 2)
+      end
+    end
+
+    describe '--only' do
+      it 'exits with error if an incorrect cop name is passed' do
+        expect { options.parse(%w(--only 123)) }
+          .to raise_error(ArgumentError, /Unrecognized cop name: 123./)
+      end
+    end
+
+    describe '--show-cops' do
+      let(:cops) { Rubocop::Cop::Cop.all }
+
+      let(:global_conf) do
+        config_path = Rubocop::Config.configuration_file_for(Dir.pwd.to_s)
+        Rubocop::Config.configuration_from_file(config_path)
+      end
+
+      let(:stdout) { $stdout.string }
+
+      before do
+        expect { options.parse ['--show-cops'] }.to exit_with_code(0)
+      end
+
+      # Extracts the first line out of the description
+      def short_description_of_cop(cop)
+        desc = full_description_of_cop(cop)
+        desc ? desc.lines.first.strip : ''
+      end
+
+      # Gets the full description of the cop or nil if no description is set.
+      def full_description_of_cop(cop)
+        cop_config = global_conf.for_cop(cop)
+        cop_config['Description']
+      end
+
+      it 'prints all available cops and their description' do
+        cops.each do |cop|
+          expect(stdout).to include cop.cop_name
+          expect(stdout).to include short_description_of_cop(cop)
+        end
+      end
+
+      it 'prints all types' do
+        cops
+          .types
+          .map(&:to_s)
+          .map(&:capitalize)
+          .each { |type| expect(stdout).to include(type) }
+      end
+
+      it 'prints all cops in their right type listing' do
+        lines = stdout.lines
+        lines.slice_before(/Type /).each do |slice|
+          types = cops.types.map(&:to_s).map(&:capitalize)
+          current = types.delete(slice.shift[/Type '(?<c>[^'']+)'/, 'c'])
+          # all cops in their type listing
+          cops.with_type(current).each do |cop|
+            expect(slice.any? { |l| l.include? cop.cop_name }).to be_true
+          end
+
+          # no cop in wrong type listing
+          types.each do |type|
+            cops.with_type(type).each do |cop|
+              expect(slice.any? { |l| l.include? cop.cop_name }).to be_false
+            end
+          end
+        end
+      end
+
+      it 'prints the current configuration' do
+        out = stdout.lines.to_a
+        cops.each do |cop|
+          conf = global_conf[cop.cop_name].dup
+          confstrt =
+            out.find_index { |i| i.include?("- #{cop.cop_name}") } + 1
+          c = out[confstrt, conf.keys.size].to_s
+          conf.delete('Description')
+          expect(c).to include(short_description_of_cop(cop))
+          conf.each do |k, v|
+            # ugly hack to get hash/array content tested
+            if v.kind_of?(Hash) || v.kind_of?(Array)
+              expect(c).to include "#{k}: #{v.to_s.dump[2, -2]}"
+            else
+              expect(c).to include "#{k}: #{v}"
+            end
+          end
+        end
+      end
+    end
+
+    describe '--require' do
+      let(:required_file_path) { './path/to/required_file.rb' }
+
+      before do
+        create_file('example.rb', '# encoding: utf-8')
+
+        create_file(required_file_path, [
+                                         '# encoding: utf-8',
+                                         "puts 'Hello from required file!'"
+                                        ])
+      end
+
+      it 'requires the passed path' do
+        options.parse(['--require', required_file_path, 'example.rb'])
+        expect($stdout.string).to start_with('Hello from required file!')
+      end
+    end
+  end
+
+  unless Rubocop::Version::STRING.start_with?('0')
+    describe '-e/--emacs option' do
+      it 'is dropped in RuboCop 1.0.0' do
+        # This spec can be removed once the option is dropped.
+        expect { options.parse(['--emacs']) }
+          .to raise_error(OptionParser::InvalidOption)
+      end
+    end
+
+    describe '-s/--silent option' do
+      it 'raises error in RuboCop 1.0.0' do
+        # This spec can be removed
+        # once Options#ignore_dropped_options is removed.
+        expect { options.parse(['--silent']) }
+          .to raise_error(OptionParser::InvalidOption)
+      end
+    end
+  end
+end