guard-rubocop 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa248932e68a78aa1fc24ae53d4d300b71640a11
-  data.tar.gz: d23806def0e10055e1aa4988dcd0138a4fa9d43a
+  metadata.gz: 1535c13164518a07f9bd376581c0900c514ce4af
+  data.tar.gz: 279736e6d095f6a5c941ed5d8b2f52850c92c535
 SHA512:
-  metadata.gz: fc9f0a685b407939a1d8ea48498d0b5be5f1886c9108281f712cb5d0cc39fb7acad86d33cf8f9fe5a0f8211c716a10178682f457c9188e6529fcfaf2a32220d5
-  data.tar.gz: d00ac9dee7125d9b4fa215953121376d2dcce500a5261e58066748732454574b1c5768c74c88798bf27c1a67ead7c64d3aa197b155360a73b9f5736d23cab798
+  metadata.gz: 9db576e8a05603ebb436e244bc55a8f62bc436b7c3670211d82e5d4e990660eb8274fad252bcc4fe0b8461cb6130c5afa39d9eec4a5a43b3c81426328ff3011b
+  data.tar.gz: ae8db14b3b120dfbea98d0086c39348d4bd28f8a76188f463ceedf7fe6d67b3b975847a510430306c333a70d11381c702f3c3c4f16952737e268cc6c1cf786d4

data/.rubocop.yml

@@ -5,3 +5,7 @@ LineLength:
 # The default 10 lines limit is unrealistic.
 MethodLength:
   Max: 15
+
+RegexpLiteral:
+  Exclude:
+    - '**/Guardfile'

data/.travis.yml

@@ -4,7 +4,6 @@ rvm:
   - 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.2.0
+
+* Add `:hide_stdout` option ([#15](https://github.com/yujinakayama/guard-rubocop/pull/15))
+
 ## v1.1.0
 
 * Use RuboCop's `--force-exclusion` option to always ignore files specified in the `Exclude` configuration in `.rubocop.yml`

data/Guardfile

@@ -5,8 +5,8 @@ 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" }
+    watch('spec/spec_helper.rb')     { 'spec' }
+    watch(%r{^spec/support/.+\.rb$}) { 'spec' }
   end
 
   guard :rubocop do

data/README.md

@@ -62,6 +62,8 @@ all_on_start: true     # Check all files at Guard startup.
 cli: '--rails'         # Pass arbitrary RuboCop CLI arguments.
                        # An array or string is acceptable.
                        #   default: nil
+hide_stdout: false      # Do not display console output (in case outputting to file).
+                       #   default: false
 keep_failed: true      # Keep failed files until they pass.
                        #   default: true
 notification: :failed  # Display Growl notification after each run.

data/Rakefile

@@ -1,9 +1,11 @@
+# coding: utf-8
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-Rubocop::RakeTask.new(:style)
+RuboCop::RakeTask.new(:style)
 
 namespace :ci do
   task :spec do

data/guard-rubocop.gemspec

@@ -7,17 +7,18 @@ require 'guard/rubocop/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'guard-rubocop'
-  spec.version       = Guard::RubocopVersion.to_s
+  spec.version       = Guard::RuboCopVersion.to_s
   spec.authors       = ['Yuji Nakayama']
   spec.email         = ['nkymyj@gmail.com']
   spec.summary       = 'Guard plugin for RuboCop'
-  spec.description   = 'Guard::Rubocop automatically checks Ruby code style with RuboCop when files are modified.'
+  spec.description   = 'Guard::Rubocop automatically checks Ruby code style with RuboCop ' \
+                       'when files are modified.'
   spec.homepage      = 'https://github.com/yujinakayama/guard-rubocop'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^spec\//)
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'guard',   '~> 2.0'
@@ -25,7 +26,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler',     '~> 1.3'
   spec.add_development_dependency 'rake',        '~> 10.0'
-  spec.add_development_dependency 'rspec',       '~> 3.0.0.beta1'
+  spec.add_development_dependency 'rspec',       '~> 3.0'
   spec.add_development_dependency 'simplecov',   '~> 0.7'
   spec.add_development_dependency 'guard-rspec', '>= 4.2.3', '< 5.0'
   spec.add_development_dependency 'ruby_gntp',   '~> 0.3'

data/lib/guard/rubocop.rb

@@ -4,9 +4,9 @@ require 'guard'
 require 'guard/plugin'
 
 module Guard
-  # This class gets API calls from `guard` and runs `rubocop` command via {Guard::Rubocop::Runner}.
+  # This class gets API calls from `guard` and runs `rubocop` command via {Guard::RuboCop::Runner}.
   # An instance of this class stays alive in a `guard` command session.
-  class Rubocop < Plugin
+  class RuboCop < Plugin
     autoload :Runner, 'guard/rubocop/runner'
 
     attr_reader :options, :failed_paths
@@ -18,7 +18,8 @@ module Guard
         all_on_start: true,
         keep_failed:  true,
         notification: :failed,
-        cli: nil
+        cli: nil,
+        hide_stdout: false
       }.merge(options)
 
       @failed_paths = []

data/lib/guard/rubocop/runner.rb

@@ -3,7 +3,7 @@
 require 'json'
 
 module Guard
-  class Rubocop
+  class RuboCop
     # This class runs `rubocop` command, retrieves result and notifies.
     # An instance of this class is intended to invoke `rubocop` only once in its lifetime.
     class Runner
@@ -28,7 +28,7 @@ module Guard
       def build_command(paths)
         command = ['rubocop']
 
-        unless include_formatter_for_console?(args_specified_by_user)
+        if should_add_default_formatter_for_console?
           command.concat(%w(--format progress)) # Keep default formatter for console.
         end
 
@@ -38,6 +38,10 @@ module Guard
         command.concat(paths)
       end
 
+      def should_add_default_formatter_for_console?
+        !@options[:hide_stdout] && !include_formatter_for_console?(args_specified_by_user)
+      end
+
       def args_specified_by_user
         @args_specified_by_user ||= begin
           args = @options[:cli]

data/lib/guard/rubocop/version.rb

@@ -1,12 +1,12 @@
 # coding: utf-8
 
 module Guard
-  # A workaround for declaring `class Rubocop`
-  # before `class Rubocop < Guard` in rubocop.rb
-  module RubocopVersion
+  # A workaround for declaring `class RuboCop`
+  # before `class RuboCop < Guard` in rubocop.rb
+  module RuboCopVersion
     # http://semver.org/
     MAJOR = 1
-    MINOR = 1
+    MINOR = 2
     PATCH = 0
 
     def self.to_s

data/spec/guard/rubocop/runner_spec.rb

@@ -2,8 +2,8 @@
 
 require 'spec_helper.rb'
 
-describe Guard::Rubocop::Runner do
-  subject(:runner) { Guard::Rubocop::Runner.new(options) }
+describe Guard::RuboCop::Runner do
+  subject(:runner) { Guard::RuboCop::Runner.new(options) }
   let(:options) { {} }
 
   describe '#run' do
@@ -96,19 +96,41 @@ describe Guard::Rubocop::Runner do
     let(:options) { { cli: %w(--debug --rails) } }
     let(:paths) { %w(file1.rb file2.rb) }
 
-    context 'when :cli option includes formatter for console' do
-      let(:options) { { cli: %w(--format simple) } }
+    context 'when :hide_stdout is not set' do
+      context 'and :cli option includes formatter for console' do
+        before { options[:cli] = %w(--format simple) }
 
-      it 'does not add args for the default formatter for console' do
-        expect(build_command[0..2]).not_to eq(%w(rubocop --format progress))
+        it 'does not add args for the default formatter for console' do
+          expect(build_command[0..2]).not_to eq(%w(rubocop --format progress))
+        end
+      end
+
+      context 'and :cli option does not include formatter for console' do
+        before { options[:cli] = %w(--format simple --out simple.txt) }
+
+        it 'adds args for the default formatter for console' do
+          expect(build_command[0..2]).to eq(%w(rubocop --format progress))
+        end
       end
     end
 
-    context 'when :cli option does not include formatter for console' do
-      let(:options) { { cli: %w(--format simple --out simple.txt) } }
+    context 'when :hide_stdout is set' do
+      before { options[:hide_stdout] = true }
+
+      context 'and :cli option includes formatter for console' do
+        before { options[:cli] = %w(--format simple) }
 
-      it 'adds args for the default formatter for console' do
-        expect(build_command[0..2]).to eq(%w(rubocop --format progress))
+        it 'does not add args for the default formatter for console' do
+          expect(build_command[0..2]).not_to eq(%w(rubocop --format progress))
+        end
+      end
+
+      context 'and :cli option does not include formatter for console' do
+        before { options[:cli] = %w(--format simple --out simple.txt) }
+
+        it 'does not add args for the default formatter for console' do
+          expect(build_command[0..2]).not_to eq(%w(rubocop --format progress))
+        end
       end
     end
 

data/spec/guard/rubocop_spec.rb

@@ -2,8 +2,8 @@
 
 require 'spec_helper.rb'
 
-describe Guard::Rubocop, :silence_output do
-  subject(:guard) { Guard::Rubocop.new(options) }
+describe Guard::RuboCop, :silence_output do
+  subject(:guard) { Guard::RuboCop.new(options) }
   let(:options) { {} }
 
   describe '#options' do
@@ -57,13 +57,13 @@ describe Guard::Rubocop, :silence_output do
   shared_examples 'processes after running', :processes_after_running do
     context 'when passed' do
       it 'throws nothing' do
-        allow_any_instance_of(Guard::Rubocop::Runner).to receive(:run).and_return(true)
+        allow_any_instance_of(Guard::RuboCop::Runner).to receive(:run).and_return(true)
         expect { subject }.not_to throw_symbol
       end
 
       it 'clears failed paths' 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([])
+        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([])
         subject
         expect(guard.failed_paths).to be_empty
       end
@@ -71,7 +71,7 @@ describe Guard::Rubocop, :silence_output do
 
     context 'when failed' do
       it 'throws symbol :task_has_failed' do
-        allow_any_instance_of(Guard::Rubocop::Runner).to receive(:run).and_return(false)
+        allow_any_instance_of(Guard::RuboCop::Runner).to receive(:run).and_return(false)
         expect { subject }.to throw_symbol(:task_has_failed)
       end
 
@@ -81,8 +81,8 @@ describe Guard::Rubocop, :silence_output do
           'some_failed_file.rb',
           'dir/another_failed_file.rb'
         ]
-        allow_any_instance_of(Guard::Rubocop::Runner).to receive(:run).and_return(false)
-        allow_any_instance_of(Guard::Rubocop::Runner)
+        allow_any_instance_of(Guard::RuboCop::Runner).to receive(:run).and_return(false)
+        allow_any_instance_of(Guard::RuboCop::Runner)
           .to receive(:failed_paths).and_return(failed_paths)
         subject
         expect(guard.failed_paths).to eq(failed_paths)
@@ -91,7 +91,7 @@ describe Guard::Rubocop, :silence_output do
 
     context 'when an exception is raised' do
       it 'prevents itself from firing' do
-        allow_any_instance_of(Guard::Rubocop::Runner).to receive(:run).and_raise(RuntimeError)
+        allow_any_instance_of(Guard::RuboCop::Runner).to receive(:run).and_raise(RuntimeError)
         expect { subject }.not_to raise_error
       end
     end
@@ -101,12 +101,12 @@ describe Guard::Rubocop, :silence_output do
     subject { super().run_all }
 
     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([])
+      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 'inspects all files with rubocop' do
-      expect_any_instance_of(Guard::Rubocop::Runner).to receive(:run).with([])
+      expect_any_instance_of(Guard::RuboCop::Runner).to receive(:run).with([])
       guard.run_all
     end
   end
@@ -122,17 +122,17 @@ describe Guard::Rubocop, :silence_output do
       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([])
+        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 'inspects changed files with rubocop' do
-        expect_any_instance_of(Guard::Rubocop::Runner).to receive(:run)
+        expect_any_instance_of(Guard::RuboCop::Runner).to receive(:run)
         subject
       end
 
       it 'passes cleaned paths to rubocop' do
-        expect_any_instance_of(Guard::Rubocop::Runner).to receive(:run) do |_instance, paths|
+        expect_any_instance_of(Guard::RuboCop::Runner).to receive(:run) do |_instance, paths|
           expect(paths).to eq([
             File.expand_path('lib/guard/rubocop.rb'),
             File.expand_path('spec/spec_helper.rb')
@@ -147,7 +147,7 @@ describe Guard::Rubocop, :silence_output do
         end
 
         it 'does nothing' do
-          expect_any_instance_of(Guard::Rubocop::Runner).not_to receive(:run)
+          expect_any_instance_of(Guard::RuboCop::Runner).not_to receive(:run)
           subject
         end
       end
@@ -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 |_instance, 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 |_instance, paths|
+          expect_any_instance_of(Guard::RuboCop::Runner).to receive(:run) do |_instance, paths|
             expect(paths).to eq([
               File.expand_path('lib/guard/rubocop.rb'),
               File.expand_path('spec/spec_helper.rb')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-rubocop
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Yuji Nakayama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-13 00:00:00.000000000 Z
+date: 2014-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta1
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta1
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -176,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Guard plugin for RuboCop