guard-rubocop 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0c295908d4ca4ca5f79bd5c4d85857dc2a05140
-  data.tar.gz: 7cd9a0ff0f3858ab1a9182cb4b2645e2778a8b2c
+  metadata.gz: ae91b5efb5588f487c013e9ce9bd122b8e5a3e5d
+  data.tar.gz: eb7c6e0877ece705ffc2ec3d0678be31c99ffde0
 SHA512:
-  metadata.gz: 84c30fe8fb9538d668bd2951ffd428dce9204d01f725f7ebb6df772652ec3223c767d9bc68a60d5f9f98b6b38aaaec44dc1cd7c9dfb9a84b8e72b8798141f5f5
-  data.tar.gz: b1d22e396e96132d9749a87aae7af718dac2a7c2b425b1a803836a7fdfdc8b793c49b89fd8423b6c83aa191f00950bfe8cc06cb3b745db31955c267a991ed1ad
+  metadata.gz: c145d8df9c847803da47b8837347afaa4792fc5a41e484824635a424e384daa2c3694fa109e47797ca17f9e7e6c8c1dbc9bdee7e88fd0de76cc1c7e19d7ff1d7
+  data.tar.gz: c8a27a5a563029a367fb65d2fa1bb00508f14bb56dc73e834f6767ee172b6e30d47fe4e0a0ba8c2e05ce26d61d67e0b7cd12e82cf75208bfab47aed94701a929

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## v0.2.0
+
+* Add `:cli` option which allows to specify additional command line arguments
+* Support JRuby and Rubinius in 1.9 modes
+
 ## v0.1.0
 
 * Update RuboCop dependency to 0.9 or later and earlier than 1.0

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 and MRI 2.0, according to RuboCop.
+Tested on MRI 1.9, MRI 2.0, JRuby and Rubinius in 1.9 modes.
 
 ## Installation
 
@@ -42,10 +42,10 @@ Please read the [Guard usage documentation](https://github.com/guard/guard#readm
 
 ## Options
 
-You can pass some options in `Guardfile`:
+You can pass some options in `Guardfile` like the following example:
 
 ```ruby
-guard :rubocop, all_on_start: false, notification: true do
+guard :rubocop, all_on_start: false, cli: ['--format', 'clang', '--rails'] do
   # ...
 end
 ```
@@ -53,9 +53,14 @@ end
 ### Available Options
 
 ```ruby
-all_on_start: true     # Check all files at Guard startup, default: true
-keep_failed: true      # Keep failed files until they pass, default: true
-notification: :failed  # Display Growl notification after each run
+all_on_start: true     # Check all files at Guard startup.
+                       #   default: true
+cli: ['--rails']       # Pass arbitrary RuboCop CLI arguments.
+                       # An array or string is acceptable.
+                       #   default: nil
+keep_failed: true      # Keep failed files until they pass.
+                       #   default: true
+notification: :failed  # Display Growl notification after each run.
                        #   true    - Always notify
                        #   false   - Never notify
                        #   :failed - Notify only when failed

data/lib/guard/rubocop.rb

@@ -4,6 +4,8 @@ require 'guard'
 require 'guard/guard'
 
 module Guard
+  # 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 < Guard
     autoload :Runner, 'guard/rubocop/runner'
 
@@ -15,7 +17,8 @@ module Guard
       @options = {
         all_on_start: true,
         keep_failed:  true,
-        notification: :failed
+        notification: :failed,
+        cli: nil
       }.merge(options)
 
       @failed_paths = []

data/lib/guard/rubocop/runner.rb

@@ -2,9 +2,15 @@
 
 require 'json'
 
+# rubocop:disable Documentation
+
 module Guard
   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
+      # rubocop:enable Documentation
+
       def initialize(options)
         @options = options
       end
@@ -25,11 +31,43 @@ module Guard
 
       def build_command(paths)
         command = ['rubocop']
-        command.concat(%w(--format progress)) # Keep default formatter for console.
+
+        unless include_formatter_for_console?(args_specified_by_user)
+          command.concat(%w(--format progress)) # Keep default formatter for console.
+        end
+
         command.concat(['--format', 'json', '--out', json_file_path])
+        command.concat(args_specified_by_user)
         command.concat(paths)
       end
 
+      def args_specified_by_user
+        @args_specified_by_user ||= begin
+          args = @options[:cli]
+          case args
+          when Array    then args
+          when String   then args.shellsplit
+          when NilClass then []
+          else fail ':cli option must be either an array or string'
+          end
+        end
+      end
+
+      def include_formatter_for_console?(cli_args)
+        index = -1
+        formatter_args = cli_args.group_by do |arg|
+          if %w(-f --format).include?(arg)
+            index += 1
+          end
+          index
+        end
+        formatter_args.delete(-1)
+
+        formatter_args.each_value.any? do |args|
+          args.none? { |a| %w(-o --out).include?(a) }
+        end
+      end
+
       def json_file_path
         @tempfile_path ||= begin
           # Just generate random tempfile path.
@@ -43,7 +81,8 @@ module Guard
       def result
         @result ||= begin
           File.open(json_file_path) do |file|
-            JSON.load(file, nil, symbolize_names: true)
+            # Rubinius 2.0.0.rc1 does not support `JSON.load` with 3 args.
+            JSON.parse(file.read, symbolize_names: true)
           end
         end
       end

data/lib/guard/rubocop/version.rb

@@ -6,7 +6,7 @@ module Guard
   module RubocopVersion
     # http://semver.org/
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     PATCH = 0
     VERSION = [MAJOR, MINOR, PATCH].join('.')
   end

data/spec/guard/rubocop/runner_spec.rb

@@ -92,24 +92,147 @@ describe Guard::Rubocop::Runner do
   end
 
   describe '#build_command' do
+    subject(:build_command) { runner.build_command(paths) }
+    let(:options) { { cli: %w(--debug --rails) } }
     let(:paths) { %w(file1.rb file2.rb) }
 
-    it 'adds args for the default formatter for console' do
-      runner.build_command(paths)[0..2].should == %w(rubocop --format progress)
+    context 'when :cli option includes formatter for console' do
+      let(:options) { { cli: %w(--format simple) } }
+
+      it 'does not add args for the default formatter for console' do
+        build_command[0..2].should_not == %w(rubocop --format progress)
+      end
+    end
+
+    context 'when :cli option does not include formatter for console' do
+      let(:options) { { cli: %w(--format simple --out simple.txt) } }
+
+      it 'adds args for the default formatter for console' do
+        build_command[0..2].should == %w(rubocop --format progress)
+      end
     end
 
     it 'adds args for JSON formatter ' do
-      runner.build_command(paths)[3..4].should == %w(--format json)
+      build_command[3..4].should == %w(--format json)
     end
 
     it 'adds args for output file path of JSON formatter ' do
-      command = runner.build_command(paths)
-      command[5].should == '--out'
-      command[6].should_not be_empty
+      build_command[5].should == '--out'
+      build_command[6].should_not be_empty
+    end
+
+    it 'adds args specified by user' do
+      build_command[7..8].should == %w(--debug --rails)
     end
 
     it 'adds the passed paths' do
-      runner.build_command(paths)[7..-1].should == %w(file1.rb file2.rb)
+      build_command[9..-1].should == %w(file1.rb file2.rb)
+    end
+
+    context 'when the value of :cli option is a string' do
+      let(:options) { { cli: '--debug --rails' } }
+
+      it 'handles' do
+        build_command[7..8].should == %w(--debug --rails)
+      end
+    end
+  end
+
+  describe '#args_specified_by_user' do
+    context 'when :cli option is nil' do
+      let(:options) { { cli: nil } }
+
+      it 'returns empty array' do
+        runner.args_specified_by_user.should == []
+      end
+    end
+
+    context 'when :cli option is an array' do
+      let(:options) { { cli: ['--out', 'output file.txt'] } }
+
+      it 'just returns the array' do
+        runner.args_specified_by_user.should == ['--out', 'output file.txt']
+      end
+    end
+
+    context 'when :cli option is a string' do
+      let(:options) { { cli: '--out "output file.txt"' } }
+
+      it 'returns an array from String#shellsplit' do
+        runner.args_specified_by_user.should == ['--out', 'output file.txt']
+      end
+    end
+
+    context 'when :cli option is other types' do
+      let(:options) { { cli: { key: 'value' } } }
+
+      it 'raises error' do
+        expect { runner.args_specified_by_user }.to raise_error
+      end
+    end
+  end
+
+  describe '#include_formatter_for_console?' do
+    subject(:include_formatter_for_console?) { runner.include_formatter_for_console?(args) }
+
+    context 'when the passed args include a -f/--format' do
+      context 'but does not include an -o/--output' do
+        let(:args) { %w(--format simple --debug) }
+
+        it 'returns true' do
+          include_formatter_for_console?.should be_true
+        end
+      end
+
+      context 'and include an -o/--output just after the -f/--format' do
+        let(:args) { %w(--format simple --out simple.txt) }
+
+        it 'returns false' do
+          include_formatter_for_console?.should be_false
+        end
+      end
+
+      context 'and include an -o/--output after the -f/--format across another arg' do
+        let(:args) { %w(--format simple --debug --out simple.txt) }
+
+        it 'returns false' do
+          include_formatter_for_console?.should be_false
+        end
+      end
+    end
+
+    context 'when the passed args include multiple -f/--format' do
+      context 'and all -f/--format have associated -o/--out' do
+        let(:args) { %w(--format simple --out simple.txt --format emacs --out emacs.txt) }
+
+        it 'returns false' do
+          include_formatter_for_console?.should be_false
+        end
+      end
+
+      context 'and any -f/--format has associated -o/--out' do
+        let(:args) { %w(--format simple --format emacs --out emacs.txt) }
+
+        it 'returns true' do
+          include_formatter_for_console?.should be_true
+        end
+      end
+
+      context 'and no -f/--format has associated -o/--out' do
+        let(:args) { %w(--format simple --format emacs) }
+
+        it 'returns true' do
+          include_formatter_for_console?.should be_true
+        end
+      end
+    end
+
+    context 'when the passed args do not include -f/--format' do
+      let(:args) { %w(--debug) }
+
+      it 'returns false' do
+        include_formatter_for_console?.should be_false
+      end
     end
   end
 

data/spec/guard/rubocop_spec.rb

@@ -17,6 +17,7 @@ describe Guard::Rubocop, :silence_output do
       its([:all_on_start]) { should be_true }
       its([:keep_failed])  { should be_true }
       its([:notification]) { should == :failed }
+      its([:cli])          { should be_nil }
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-rubocop
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yuji Nakayama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-01 00:00:00.000000000 Z
+date: 2013-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard