Use #run_on_modifications to suppress multiple run on a save with Vim

This closes #6.

Author: yujinakayama

lib/guard/rubocop.rb

@@ -30,19 +30,15 @@ def start
 
     def run_all
       UI.info 'Inspecting Ruby code style of all files'
-      run
+      inspect_with_rubocop
     end
 
-    def run_on_changes(paths)
-      paths += @failed_paths if @options[:keep_failed]
-      paths = clean_paths(paths)
-
-      return if paths.empty?
-
-      displayed_paths = paths.map { |path| smart_path(path) }
-      UI.info "Inspecting Ruby code style: #{displayed_paths.join(' ')}"
+    def run_on_additions(paths)
+      run_partially(paths)
+    end
 
-      run(paths)
+    def run_on_modifications(paths)
+      run_partially(paths)
     end
 
     def reload
@@ -62,7 +58,19 @@ def clean_paths(paths)
 
     private
 
-    def run(paths = [])
+    def run_partially(paths)
+      paths += @failed_paths if @options[:keep_failed]
+      paths = clean_paths(paths)
+
+      return if paths.empty?
+
+      displayed_paths = paths.map { |path| smart_path(path) }
+      UI.info "Inspecting Ruby code style: #{displayed_paths.join(' ')}"
+
+      inspect_with_rubocop(paths)
+    end
+
+    def inspect_with_rubocop(paths = [])
       runner = Runner.new(@options)
       passed = runner.run(paths)
       @failed_paths = runner.failed_paths

spec/guard/rubocop_spec.rb

@@ -111,69 +111,71 @@
     end
   end
 
-  describe '#run_on_changes', :processes_after_running do
-    subject { super().run_on_changes(changed_paths) }
-    let(:changed_paths) do
-      [
-        'lib/guard/rubocop.rb',
-        'spec/spec_helper.rb'
-      ]
-    end
-
-    before do
-      allow_any_instance_of(Guard::Rubocop::Runner).to receive(:run).and_return(true)
-      allow_any_instance_of(Guard::Rubocop::Runner).to receive(:failed_paths).and_return([])
-    end
+  [:run_on_additions, :run_on_modifications].each do |method|
+    describe "##{method}", :processes_after_running do
+      subject { super().send(method, changed_paths) }
+      let(:changed_paths) do
+        [
+          'lib/guard/rubocop.rb',
+          'spec/spec_helper.rb'
+        ]
+      end
 
-    it 'inspects changed files with rubocop' do
-      expect_any_instance_of(Guard::Rubocop::Runner).to receive(:run)
-      guard.run_on_changes(changed_paths)
-    end
+      before do
+        allow_any_instance_of(Guard::Rubocop::Runner).to receive(:run).and_return(true)
+        allow_any_instance_of(Guard::Rubocop::Runner).to receive(:failed_paths).and_return([])
+      end
 
-    it 'passes cleaned paths to rubocop' do
-      expect_any_instance_of(Guard::Rubocop::Runner).to receive(:run) do |paths|
-        expect(paths).to eq([
-          File.expand_path('some.rb'),
-          File.expand_path('dir/another.rb')
-        ])
+      it 'inspects changed files with rubocop' do
+        expect_any_instance_of(Guard::Rubocop::Runner).to receive(:run)
+        subject
       end
-      guard.run_on_changes(changed_paths)
-    end
 
-    context 'when cleaned paths are empty' do
-      before do
-        allow(guard).to receive(:clean_paths).and_return([])
+      it 'passes cleaned paths to rubocop' do
+        expect_any_instance_of(Guard::Rubocop::Runner).to receive(:run) do |paths|
+          expect(paths).to eq([
+            File.expand_path('some.rb'),
+            File.expand_path('dir/another.rb')
+          ])
+        end
+        subject
       end
 
-      it 'does nothing' do
-        expect_any_instance_of(Guard::Rubocop::Runner).not_to receive(:run)
-        guard.run_on_changes(changed_paths)
+      context 'when cleaned paths are empty' do
+        before do
+          allow(guard).to receive(:clean_paths).and_return([])
+        end
+
+        it 'does nothing' do
+          expect_any_instance_of(Guard::Rubocop::Runner).not_to receive(:run)
+          subject
+        end
       end
-    end
 
-    let(:failed_path) { File.expand_path('Rakefile') }
+      let(:failed_path) { File.expand_path('Rakefile') }
 
-    context 'when :keep_failed option is enabled' do
-      let(:options) { { keep_failed: true } }
+      context 'when :keep_failed option is enabled' do
+        let(:options) { { keep_failed: true } }
 
-      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(paths).to include failed_path
+        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(paths).to include failed_path
+          end
+          subject
         end
-        guard.run_on_changes(changed_paths)
       end
-    end
 
-    context 'when :keep_failed option is disabled' do
-      let(:options) { { keep_failed: false } }
+      context 'when :keep_failed option is disabled' do
+        let(:options) { { keep_failed: false } }
 
-      it 'inspects just changed paths' do
-        guard.failed_paths << failed_path
-        expect_any_instance_of(Guard::Rubocop::Runner).to receive(:run) do |paths|
-          expect(paths).to eq(changed_paths)
+        it 'inspects just changed paths' do
+          guard.failed_paths << failed_path
+          expect_any_instance_of(Guard::Rubocop::Runner).to receive(:run) do |paths|
+            expect(paths).to eq(changed_paths)
+          end
+          subject
         end
-        guard.run_on_changes(changed_paths)
       end
     end
   end