guard-rubocop 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec82afdd85de6be92deca90949f571a84eae25cf
-  data.tar.gz: 68d6f82e862a90d3625e4fcf0b1c06d36a67221c
+  metadata.gz: 381f4bdd0bfd18f0421441c723f6d15b7fa60483
+  data.tar.gz: 706e9ce598392012ba485deb21c6fc127fc333ac
 SHA512:
-  metadata.gz: d40d80a751bc72240d3c0d5b1c1ace21c12e1792a66ee481511733c91ff1f360c478eda6ccf31bf80cf2475ab1c4464176ebf979f61514a668998339687328ea
-  data.tar.gz: 5a2c18d2e662dc0744463c374bd94cf55979b816538726dd89f81bac3dce0d14850ced6d4dbd35a72caf3c72372cf96cb433651a775ccfdb4eef8ac1cd6127cd
+  metadata.gz: a2d6bc60c3f2cbe194e7a5036b1510b8a1a38d7a9c9261a17505d9af95094a84e7b97b6ce7e7fe4a3fdaf792a2990d9af317a3741500820fc1883d1c8b59f0ff
+  data.tar.gz: 6caa97c34c3a4c380a25f0bf869a0bbc1648aef2105d774b2cb51f728a4720f039322afe40249f89919f41876855b8cd66ad19c7d3dbd5e1ce386b55bfe595f9

data/.travis.yml

@@ -2,7 +2,9 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
   - jruby-19mode
+  - rbx
 script:
   - bundle exec rspec
   - bundle exec rubocop

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Development
 
+## v1.0.2
+
+* Support both spelling “offense” (RuboCop 0.19 or later) and “offence” (prior to RuboCop 0.19) ([rubocop#700](https://github.com/bbatsov/rubocop/issues/700))
+
 ## v1.0.1
 
 * Fix inappripriate multiple run on a save with Vim ([#6](https://github.com/yujinakayama/guard-rubocop/pull/6))

data/Gemfile

@@ -7,3 +7,10 @@ group :test do
   gem 'simplecov-rcov', '~> 0.2'
   gem 'ci_reporter',    '~> 1.8'
 end
+
+platforms :rbx do
+  gem 'rubysl'
+  gem 'rubinius-developer_tools'
+  gem 'json'
+  gem 'racc' # Needed for RuboCop
+end

data/Guardfile

@@ -1,14 +1,16 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard :rspec, all_after_pass: true, all_on_start: true, keep_failed: true do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})        { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')     { "spec" }
-  watch(%r{^spec/support/.+\.rb$}) { "spec" }
-end
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, all_after_pass: true, all_on_start: true, cmd: 'bundle exec rspec' do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})        { |m| "spec/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb')     { "spec" }
+    watch(%r{^spec/support/.+\.rb$}) { "spec" }
+  end
 
-guard :rubocop do
-  watch(%r{.+\.rb$})
-  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  guard :rubocop do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
 end

data/README.md

@@ -4,7 +4,7 @@
 
 Guard::Rubocop allows you to automatically check Ruby code style with [RuboCop](https://github.com/bbatsov/rubocop) when files are modified.
 
-Tested on MRI 1.9, MRI 2.0, JRuby and Rubinius in 1.9 modes.
+Tested on MRI 1.9, 2.0, 2.1, JRuby in 1.9 mode and Rubinius.
 
 ## Installation
 
@@ -55,7 +55,7 @@ end
 ```ruby
 all_on_start: true     # Check all files at Guard startup.
                        #   default: true
-cli: ['--rails']       # Pass arbitrary RuboCop CLI arguments.
+cli: '--rails'         # Pass arbitrary RuboCop CLI arguments.
                        # An array or string is acceptable.
                        #   default: nil
 keep_failed: true      # Keep failed files until they pass.
@@ -67,6 +67,31 @@ notification: :failed  # Display Growl notification after each run.
                        #   default: :failed
 ```
 
+## Advanced Tips
+
+If you're using a testing Guard plugin such as [`guard-rspec`](https://github.com/guard/guard-rspec) together with `guard-rubocop` in the TDD way (the red-green-refactor cycle),
+you might be uncomfortable with the offense reports from RuboCop in the red-green phase:
+
+* In the red-green phase, you're not necessarily required to write clean code – you just focus writing code to pass the test. It means, in this phase, `guard-rspec` should be run but `guard-rubocop` should not.
+* In the refactor phase, you're required to make the code clean while keeping the test passing. In this phase, both `guard-rspec` and `guard-rubocop` should be run.
+
+In this case, you may think the following `Guardfile` structure useful:
+
+```ruby
+# This group allows to skip running RuboCop when RSpec failed.
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec do
+    # ...
+  end
+
+  guard :rubocop do
+    # ...
+  end
+end
+```
+
+Note: You need to use `guard-rspec` 4.2.3 or later due to a [bug](https://github.com/guard/guard-rspec/pull/234) where it unintentionally fails when there are no spec files to be run.
+
 ## Contributing
 
 1. Fork it

data/guard-rubocop.gemspec

@@ -25,8 +25,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler',     '~> 1.3'
   spec.add_development_dependency 'rake',        '~> 10.0'
-  spec.add_development_dependency 'rspec',       '~> 2.14'
+  spec.add_development_dependency 'rspec',       '~> 3.0.0.beta1'
   spec.add_development_dependency 'simplecov',   '~> 0.7'
-  spec.add_development_dependency 'guard-rspec', '~> 4.0'
+  spec.add_development_dependency 'guard-rspec', '>= 4.2.3', '< 5.0'
   spec.add_development_dependency 'ruby_gntp',   '~> 0.3'
 end

data/lib/guard/rubocop/runner.rb

@@ -92,13 +92,15 @@ module Guard
         text = pluralize(summary[:inspected_file_count], 'file')
         text << ' inspected, '
 
-        text << pluralize(summary[:offence_count], 'offence', no_for_zero: true)
+        offense_count = summary[:offense_count] || summary[:offence_count]
+        text << pluralize(offense_count, 'offense', no_for_zero: true)
         text << ' detected'
       end
 
       def failed_paths
         failed_files = result[:files].reject do |file|
-          file[:offences].empty?
+          offenses = file[:offenses] || file[:offences]
+          offenses.empty?
         end
         failed_files.map do |file|
           file[:path]

data/lib/guard/rubocop/version.rb

@@ -7,7 +7,7 @@ module Guard
     # http://semver.org/
     MAJOR = 1
     MINOR = 0
-    PATCH = 1
+    PATCH = 2
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/spec/guard/rubocop/runner_spec.rb

@@ -25,14 +25,14 @@ describe Guard::Rubocop::Runner do
       before do
         allow(runner).to receive(:system).and_return(true)
       end
-      it { should be_true }
+      it { should be_truthy }
     end
 
     context 'when RuboCop exited with non 0 status' do
       before do
         allow(runner).to receive(:system).and_return(false)
       end
-      it { should be_false }
+      it { should be_falsey }
     end
 
     shared_examples 'notifies', :notifies do
@@ -172,7 +172,7 @@ describe Guard::Rubocop::Runner do
         let(:args) { %w(--format simple --debug) }
 
         it 'returns true' do
-          expect(include_formatter_for_console?).to be_true
+          expect(include_formatter_for_console?).to be_truthy
         end
       end
 
@@ -180,7 +180,7 @@ describe Guard::Rubocop::Runner do
         let(:args) { %w(--format simple --out simple.txt) }
 
         it 'returns false' do
-          expect(include_formatter_for_console?).to be_false
+          expect(include_formatter_for_console?).to be_falsey
         end
       end
 
@@ -188,7 +188,7 @@ describe Guard::Rubocop::Runner do
         let(:args) { %w(--format simple --debug --out simple.txt) }
 
         it 'returns false' do
-          expect(include_formatter_for_console?).to be_false
+          expect(include_formatter_for_console?).to be_falsey
         end
       end
     end
@@ -198,7 +198,7 @@ describe Guard::Rubocop::Runner do
         let(:args) { %w(-fs --debug) }
 
         it 'returns true' do
-          expect(include_formatter_for_console?).to be_true
+          expect(include_formatter_for_console?).to be_truthy
         end
       end
 
@@ -206,7 +206,7 @@ describe Guard::Rubocop::Runner do
         let(:args) { %w(-fs -osimple.txt) }
 
         it 'returns false' do
-          expect(include_formatter_for_console?).to be_false
+          expect(include_formatter_for_console?).to be_falsey
         end
       end
     end
@@ -216,7 +216,7 @@ describe Guard::Rubocop::Runner do
         let(:args) { %w(--format simple --out simple.txt --format emacs --out emacs.txt) }
 
         it 'returns false' do
-          expect(include_formatter_for_console?).to be_false
+          expect(include_formatter_for_console?).to be_falsey
         end
       end
 
@@ -224,7 +224,7 @@ describe Guard::Rubocop::Runner do
         let(:args) { %w(--format simple --format emacs --out emacs.txt) }
 
         it 'returns true' do
-          expect(include_formatter_for_console?).to be_true
+          expect(include_formatter_for_console?).to be_truthy
         end
       end
 
@@ -232,7 +232,7 @@ describe Guard::Rubocop::Runner do
         let(:args) { %w(--format simple --format emacs) }
 
         it 'returns true' do
-          expect(include_formatter_for_console?).to be_true
+          expect(include_formatter_for_console?).to be_truthy
         end
       end
     end
@@ -241,14 +241,14 @@ describe Guard::Rubocop::Runner do
       let(:args) { %w(--debug) }
 
       it 'returns false' do
-        expect(include_formatter_for_console?).to be_false
+        expect(include_formatter_for_console?).to be_falsey
       end
     end
   end
 
   describe '#json_file_path' do
     it 'is not world readable' do
-      expect(File.world_readable?(runner.json_file_path)).to be_false
+      expect(File.world_readable?(runner.json_file_path)).to be_falsey
     end
   end
 
@@ -265,10 +265,10 @@ describe Guard::Rubocop::Runner do
           },
           "files": [{
               "path": "lib/foo.rb",
-              "offences": []
+              "offenses": []
             }, {
               "path": "lib/bar.rb",
-              "offences": [{
+              "offenses": [{
                   "severity": "convention",
                   "message": "Line is too long. [81/79]",
                   "cop_name": "LineLength",
@@ -289,7 +289,7 @@ describe Guard::Rubocop::Runner do
             }
           ],
           "summary": {
-            "offence_count": 2,
+            "offense_count": 2,
             "target_file_count": 2,
             "inspected_file_count": 2
           }
@@ -301,7 +301,7 @@ describe Guard::Rubocop::Runner do
 
   describe '#result', :json_file do
     it 'parses JSON file' do
-      expect(runner.result[:summary][:offence_count]).to eq(2)
+      expect(runner.result[:summary][:offense_count]).to eq(2)
     end
   end
 
@@ -310,7 +310,7 @@ describe Guard::Rubocop::Runner do
       allow(runner).to receive(:result).and_return(
         {
           summary: {
-            offence_count: 4,
+            offense_count: 4,
             target_file_count: 3,
             inspected_file_count: 2
           }
@@ -320,7 +320,7 @@ describe Guard::Rubocop::Runner do
 
     it 'notifies summary' do
       expect(Guard::Notifier).to receive(:notify) do |message, options|
-        expect(message).to eq('2 files inspected, 4 offences detected')
+        expect(message).to eq('2 files inspected, 4 offenses detected')
       end
       runner.notify(true)
     end
@@ -356,7 +356,7 @@ describe Guard::Rubocop::Runner do
       allow(runner).to receive(:result).and_return(
         {
           summary: {
-            offence_count: offence_count,
+            offense_count: offense_count,
             target_file_count: target_file_count,
             inspected_file_count: inspected_file_count
           }
@@ -366,7 +366,7 @@ describe Guard::Rubocop::Runner do
 
     subject(:summary_text) { runner.summary_text }
 
-    let(:offence_count)        { 0 }
+    let(:offense_count)        { 0 }
     let(:target_file_count)    { 0 }
     let(:inspected_file_count) { 0 }
 
@@ -391,31 +391,88 @@ describe Guard::Rubocop::Runner do
       end
     end
 
-    context 'when no offences are detected' do
-      let(:offence_count) { 0 }
-      it 'includes "no offences"' do
-        expect(summary_text).to include 'no offences'
+    context 'when no offenses are detected' do
+      let(:offense_count) { 0 }
+      it 'includes "no offenses"' do
+        expect(summary_text).to include 'no offenses'
       end
     end
 
-    context 'when an offence is detected' do
-      let(:offence_count) { 1 }
-      it 'includes "1 offence"' do
-        expect(summary_text).to include '1 offence'
+    context 'when an offense is detected' do
+      let(:offense_count) { 1 }
+      it 'includes "1 offense"' do
+        expect(summary_text).to include '1 offense'
       end
     end
 
-    context 'when 2 offences are detected' do
-      let(:offence_count) { 2 }
-      it 'includes "2 offences"' do
-        expect(summary_text).to include '2 offences'
+    context 'when 2 offenses are detected' do
+      let(:offense_count) { 2 }
+      it 'includes "2 offenses"' do
+        expect(summary_text).to include '2 offenses'
+      end
+    end
+
+    context 'with spelling "offence" in old RuboCop' do
+      before do
+        allow(runner).to receive(:result).and_return(
+          {
+            summary: {
+              offence_count: 2,
+              target_file_count: 1,
+              inspected_file_count: 1
+            }
+          }
+        )
+      end
+
+      it 'handles the spelling' do
+        expect(summary_text).to include '2 offenses'
       end
     end
   end
 
   describe '#failed_paths', :json_file do
-    it 'returns file paths which have offences' do
+    it 'returns file paths which have offenses' do
       expect(runner.failed_paths).to eq(['lib/bar.rb'])
     end
+
+    context 'with spelling "offence" in old RuboCop' do
+      before do
+        json = <<-END
+          {
+            "files": [{
+                "path": "lib/foo.rb",
+                "offences": []
+              }, {
+                "path": "lib/bar.rb",
+                "offences": [{
+                    "severity": "convention",
+                    "message": "Line is too long. [81/79]",
+                    "cop_name": "LineLength",
+                    "location": {
+                      "line": 546,
+                      "column": 80
+                    }
+                  }, {
+                    "severity": "warning",
+                    "message": "Unreachable code detected.",
+                    "cop_name": "UnreachableCode",
+                    "location": {
+                      "line": 15,
+                      "column": 9
+                    }
+                  }
+                ]
+              }
+            ]
+          }
+        END
+        File.write(runner.json_file_path, json)
+      end
+
+      it 'handles the spelling' do
+        expect(runner.failed_paths).to eq(['lib/bar.rb'])
+      end
+    end
   end
 end

data/spec/guard/rubocop_spec.rb

@@ -14,12 +14,12 @@ describe Guard::Rubocop, :silence_output do
 
       describe '[:all_on_start]' do
         subject { super()[:all_on_start] }
-        it { should be_true }
+        it { should be_truthy }
       end
 
       describe '[:keep_failed]' do
         subject { super()[:keep_failed] }
-        it { should be_true }
+        it { should be_truthy }
       end
 
       describe '[:notification]' do
@@ -132,7 +132,7 @@ describe Guard::Rubocop, :silence_output do
       end
 
       it 'passes cleaned paths to rubocop' do
-        expect_any_instance_of(Guard::Rubocop::Runner).to receive(:run) do |paths|
+        expect_any_instance_of(Guard::Rubocop::Runner).to receive(:run) do |instance, paths|
           expect(paths).to eq([
             File.expand_path('some.rb'),
             File.expand_path('dir/another.rb')
@@ -159,7 +159,7 @@ describe Guard::Rubocop, :silence_output do
 
         it 'also inspects paths which are failed last time' do
           guard.failed_paths << failed_path
-          expect_any_instance_of(Guard::Rubocop::Runner).to receive(:run) do |paths|
+          expect_any_instance_of(Guard::Rubocop::Runner).to receive(:run) do |instance, paths|
             expect(paths).to include failed_path
           end
           subject
@@ -171,7 +171,7 @@ describe Guard::Rubocop, :silence_output do
 
         it 'inspects just changed paths' do
           guard.failed_paths << failed_path
-          expect_any_instance_of(Guard::Rubocop::Runner).to receive(:run) do |paths|
+          expect_any_instance_of(Guard::Rubocop::Runner).to receive(:run) do |instance, paths|
             expect(paths).to eq(changed_paths)
           end
           subject

data/spec/spec_helper.rb

@@ -5,7 +5,9 @@ RSpec.configure do |config|
     c.syntax = :expect
   end
 
-  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.mock_with :rspec do |c|
+    c.syntax = :expect
+  end
 end
 
 Dir[File.join(File.dirname(__FILE__), 'support', '*')].each do |path|

data/spec/support/silence_output.rb

@@ -1,14 +1,23 @@
 # coding: utf-8
 
 shared_context 'silence output', silence_output: true do
-  before do
-    null_output = double('output').as_null_object
+  null_object = BasicObject.new
+
+  class << null_object
+    # #respond_to_missing? does not work.
+    def respond_to?(*)
+      true
+    end
+
+    def method_missing(*)
+    end
+  end
 
+  before do
     @original_stdout = $stdout
     @original_stderr = $stderr
-
-    $stdout = null_output
-    $stderr = null_output
+    $stdout = null_object
+    $stderr = null_object
   end
 
   after do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-rubocop
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Yuji Nakayama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-02 00:00:00.000000000 Z
+date: 2014-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: 3.0.0.beta1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: 3.0.0.beta1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -98,16 +98,22 @@ dependencies:
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.3
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.3
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: ruby_gntp
   requirement: !ruby/object:Gem::Requirement
@@ -170,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Guard plugin for RuboCop