guard-rubocop 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0dfc8d85682b0eb89593cac569aeb9c3287c0f3c
-  data.tar.gz: 09fe402f245769e82794e2da20af64c6474f2c44
+  metadata.gz: c0c295908d4ca4ca5f79bd5c4d85857dc2a05140
+  data.tar.gz: 7cd9a0ff0f3858ab1a9182cb4b2645e2778a8b2c
 SHA512:
-  metadata.gz: 73d2c70b2fa70867c5955f399e13485e36a8740ee5dc496d96abc568e72b5539affe589614de1c20aa8daa236f4a69c47a2734a91050bc2fbc2168a017e97b7d
-  data.tar.gz: d008aeeccc2be2404307980b01f8e5028508927871fbb1904c025920bfae005c3f23bffeec66f9e6f52c8c90e15e80303dbe46c61836f7115b4a7a56d263d7f9
+  metadata.gz: 84c30fe8fb9538d668bd2951ffd428dce9204d01f725f7ebb6df772652ec3223c767d9bc68a60d5f9f98b6b38aaaec44dc1cd7c9dfb9a84b8e72b8798141f5f5
+  data.tar.gz: b1d22e396e96132d9749a87aae7af718dac2a7c2b425b1a803836a7fdfdc8b793c49b89fd8423b6c83aa191f00950bfe8cc06cb3b745db31955c267a991ed1ad

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# CHANGELOG
+
+## v0.1.0
+
+* Update RuboCop dependency to 0.9 or later and earlier than 1.0
+* Rework with JSON formatter
+* Change the displayed text to "Inspecting ..."
+* Print relative file paths when they are under current working directory
+
+## v0.0.4
+
+* Specify dependency on rubocop gem as under 0.9.0
+* Force RuboCop to colorize output even though output is not TTY
+* Revert "Use rubocop 0.6.1 --no-color option instead of uncoloring colored output"
+
+## v0.0.3
+
+* Use rubocop 0.6.1 --no-color option instead of uncoloring colored output
+
+## v0.0.2
+
+* Fix capitalization of the name RuboCop in notification title
+
+## v0.0.1
+
+* Initial release

data/guard-rubocop.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Yuji Nakayama']
   spec.email         = ['nkymyj@gmail.com']
   spec.summary       = 'Guard plugin for RuboCop'
-  spec.description   = 'Guard::Rubocop allows you to automatically check 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'
 
@@ -20,10 +20,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "guard",          '~> 1.8'
-  spec.add_runtime_dependency "rubocop",        ['>= 0.8.2', '< 0.9.0']
-  spec.add_runtime_dependency "childprocess",   '~> 0.3'
-  spec.add_runtime_dependency "term-ansicolor", '~> 1.1'
+  spec.add_runtime_dependency 'guard',   '~> 1.8'
+  spec.add_runtime_dependency 'rubocop', '~> 0.9'
 
   spec.add_development_dependency 'bundler',     '~> 1.3'
   spec.add_development_dependency 'rake',        '~> 10.0'

data/lib/guard/rubocop.rb

@@ -26,26 +26,18 @@ module Guard
     end
 
     def run_all
-      UI.info 'Checking Ruby code style of all files'
-
-      runner = Runner.new(@options)
-      passed = runner.run
-      @failed_paths = runner.failed_paths
-
-      throw :task_has_failed unless passed
+      UI.info 'Inspecting Ruby code style of all files'
+      run
     end
 
     def run_on_changes(paths)
       paths += @failed_paths if @options[:keep_failed]
       paths = clean_paths(paths)
 
-      UI.info "Checking Ruby code styles: #{paths.join(' ')}"
+      displayed_paths = paths.map { |path| smart_path(path) }
+      UI.info "Inspecting Ruby code style: #{displayed_paths.join(' ')}"
 
-      runner = Runner.new(@options)
-      passed = runner.run(paths)
-      @failed_paths = runner.failed_paths
-
-      throw :task_has_failed unless passed
+      run(paths)
     end
 
     def reload
@@ -64,6 +56,16 @@ module Guard
 
     private
 
+    def run(paths = [])
+      runner = Runner.new(@options)
+      passed = runner.run(paths)
+      @failed_paths = runner.failed_paths
+      throw :task_has_failed unless passed
+    rescue => error
+      UI.error 'The following exception occurred while running guard-rubocop: ' +
+               "#{error.backtrace.first} #{error.message} (#{error.class.name})"
+    end
+
     def included_in_other_path?(target_path, other_paths)
       dir_paths = other_paths.select { |path| File.directory?(path) }
       dir_paths.delete(target_path)
@@ -71,5 +73,13 @@ module Guard
         target_path.start_with?(dir_path)
       end
     end
+
+    def smart_path(path)
+      if path.start_with?(Dir.pwd)
+        Pathname.new(path).relative_path_from(Pathname.getwd).to_s
+      else
+        path
+      end
+    end
   end
 end

data/lib/guard/rubocop/runner.rb

@@ -1,98 +1,91 @@
 # coding: utf-8
 
-require 'childprocess'
-require 'term/ansicolor'
+require 'json'
 
 module Guard
   class Rubocop
     class Runner
-      PASSED_EXIT_CODE = 0
-      MINIMUM_POLL_INTERVAL = 0.1
-
-      attr_reader :passed, :output
-
-      alias_method :passed?, :passed
-
       def initialize(options)
         @options = options
       end
 
       def run(paths = [])
-        exit_code, output = rubocop(paths)
-        @passed = (exit_code == PASSED_EXIT_CODE)
-        @output = Term::ANSIColor.uncolor(output)
+        command = build_command(paths)
+        passed = system(*command)
 
         case @options[:notification]
         when :failed
-          notify unless passed?
+          notify(passed) unless passed
         when true
-          notify
+          notify(passed)
         end
 
         passed
       end
 
-      def rubocop(args)
-        process = ChildProcess.build('rubocop', *args)
-
-        # Force Rainbow inside RuboCop to colorize output
-        # even though output is not TTY.
-        # https://github.com/sickill/rainbow/blob/0b64edc/lib/rainbow.rb#L7
-        process.environment['CLICOLOR_FORCE'] = '1'
-
-        stdout_reader, process.io.stdout = IO.pipe
-        process.start
-
-        output = ''
+      def build_command(paths)
+        command = ['rubocop']
+        command.concat(%w(--format progress)) # Keep default formatter for console.
+        command.concat(['--format', 'json', '--out', json_file_path])
+        command.concat(paths)
+      end
 
-        loop do
-          output << capture_and_print_output(stdout_reader)
-          break if process.exited?
+      def json_file_path
+        @tempfile_path ||= begin
+          # Just generate random tempfile path.
+          basename = self.class.name.downcase.gsub('::', '_')
+          tempfile = Tempfile.new(basename)
+          tempfile.close
+          tempfile.path
         end
+      end
 
-        [process.exit_code, output]
+      def result
+        @result ||= begin
+          File.open(json_file_path) do |file|
+            JSON.load(file, nil, symbolize_names: true)
+          end
+        end
       end
 
-      def notify
+      def notify(passed)
         image = passed ? :success : :failed
-        Notifier.notify(summary, title: 'RuboCop results', image: image)
+        Notifier.notify(summary_text, title: 'RuboCop results', image: image)
       end
 
-      def summary
-        return nil unless output
-        output.lines.to_a.last.chomp
+      def summary_text
+        summary = result[:summary]
+
+        text = pluralize(summary[:inspected_file_count], 'file')
+        text << ' inspected, '
+
+        text << pluralize(summary[:offence_count], 'offence', no_for_zero: true)
+        text << ' detected'
       end
 
       def failed_paths
-        return [] unless output
-        output.scan(/^== (.+) ==$/).flatten
+        failed_files = result[:files].reject do |file|
+          file[:offences].empty?
+        end
+        failed_files.map do |file|
+          file[:path]
+        end
       end
 
-      private
-
-      def capture_and_print_output(output)
-        available_ios, = IO.select([output], nil, nil, MINIMUM_POLL_INTERVAL)
-        return '' unless available_ios
-        chunk = available_ios.first.read_available_nonblock
-        $stdout.write chunk
-        chunk
-      end
+      def pluralize(number, thing, options = {})
+        text = ''
 
-      class IO < ::IO
-        READ_CHUNK_SIZE = 10000
-
-        def read_available_nonblock
-          data = ''
-          loop do
-            begin
-              data << read_nonblock(READ_CHUNK_SIZE)
-            rescue ::IO::WaitReadable, EOFError
-              return data
-            end
-          end
+        if number == 0 && options[:no_for_zero]
+          text = 'no'
+        else
+          text << number.to_s
         end
-      end
 
+        text << " #{thing}"
+        text << 's' unless number == 1
+
+        text
+      end
     end
   end
 end

data/lib/guard/rubocop/version.rb

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

data/spec/guard/rubocop/runner_spec.rb

@@ -1,11 +1,8 @@
 # coding: utf-8
 
 require 'spec_helper.rb'
-require 'term/ansicolor'
-
-describe Guard::Rubocop::Runner, :silence_output do
-  include CaptureHelper
 
+describe Guard::Rubocop::Runner do
   subject(:runner) { Guard::Rubocop::Runner.new(options) }
   let(:options) { {} }
 
@@ -14,24 +11,26 @@ describe Guard::Rubocop::Runner, :silence_output do
     let(:paths) { ['spec/spec_helper.rb'] }
 
     before do
-      runner.stub(:rubocop)
+      runner.stub(:system)
     end
 
     it 'executes rubocop' do
-      runner.should_receive(:rubocop)
+      runner.should_receive(:system) do |*args|
+        args.first.should == 'rubocop'
+      end
       runner.run
     end
 
-    context 'when all files are passed' do
+    context 'when RuboCop exited with 0 status' do
       before do
-        runner.stub(:rubocop).and_return(0)
+        runner.stub(:system).and_return(true)
       end
       it { should be_true }
     end
 
-    context 'when any file is failed' do
+    context 'when RuboCop exited with non 0 status' do
       before do
-        runner.stub(:rubocop).and_return(1)
+        runner.stub(:system).and_return(false)
       end
       it { should be_false }
     end
@@ -53,7 +52,7 @@ describe Guard::Rubocop::Runner, :silence_output do
     shared_examples 'notification' do |expectations|
       context 'when passed' do
         before do
-          runner.stub(:rubocop).and_return(0)
+          runner.stub(:system).and_return(true)
         end
 
         if expectations[:passed]
@@ -65,7 +64,7 @@ describe Guard::Rubocop::Runner, :silence_output do
 
       context 'when failed' do
         before do
-          runner.stub(:rubocop).and_return(1)
+          runner.stub(:system).and_return(false)
         end
 
         if expectations[:failed]
@@ -92,116 +91,198 @@ describe Guard::Rubocop::Runner, :silence_output do
     end
   end
 
-  describe '#rubocop' do
-    let(:paths) { ['spec/spec_helper.rb'] }
+  describe '#build_command' do
+    let(:paths) { %w(file1.rb file2.rb) }
 
-    it 'runs rubocop command' do
-      capture(:stdout) do
-        runner.rubocop(paths)
-      end.should include 'inspected'
+    it 'adds args for the default formatter for console' do
+      runner.build_command(paths)[0..2].should == %w(rubocop --format progress)
     end
 
-    it 'returns exit code and output' do
-      exit_code, output = runner.rubocop(paths)
-      exit_code.should == 0
-      output.should include 'inspected'
+    it 'adds args for JSON formatter ' do
+      runner.build_command(paths)[3..4].should == %w(--format json)
     end
-  end
-
-  describe '#output' do
-    subject { super().output }
-    let(:paths) { ['spec/spec_helper.rb'] }
 
-    context 'before running' do
-      it { should be_nil }
+    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
     end
 
-    context 'after running' do
-      before do
-        runner.stub(:notify)
-      end
+    it 'adds the passed paths' do
+      runner.build_command(paths)[7..-1].should == %w(file1.rb file2.rb)
+    end
+  end
 
-      it 'returns uncolored output of rubocop command' do
-        captured_output = capture(:stdout) { runner.run(paths) }
-        runner.output.should == Term::ANSIColor.uncolor(captured_output)
-      end
+  describe '#json_file_path' do
+    it 'is not world readable' do
+      File.world_readable?(runner.json_file_path).should be_false
     end
   end
 
-  shared_context 'stubbed output', :stubbed_output do
+  shared_context 'JSON file', :json_file do
     before do
-      runner.stub(:output) do
-<<OUTPUT
-== /home/foo/guard-rubocop/lib/guard/rubocop.rb ==
-C:  1: Missing encoding comment.
-== /home/foo/guard-rubocop/spec/support/silence_output.rb ==
-C:  3: Ruby 1.8 hash syntax detected
+      json = <<-END
+        {
+          "metadata": {
+            "rubocop_version": "0.9.0",
+            "ruby_engine": "ruby",
+            "ruby_version": "2.0.0",
+            "ruby_patchlevel": "195",
+            "ruby_platform": "x86_64-darwin12.3.0"
+          },
+          "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
+                  }
+                }
+              ]
+            }
+          ],
+          "summary": {
+            "offence_count": 2,
+            "target_file_count": 2,
+            "inspected_file_count": 2
+          }
+        }
+      END
+      File.write(runner.json_file_path, json)
+    end
+  end
 
-7 files inspected, 2 offences detected
-OUTPUT
-      end
+  describe '#result', :json_file do
+    it 'parses JSON file' do
+      runner.result[:summary][:offence_count].should == 2
     end
   end
 
-  describe '#notify', :stubbed_output do
+  describe '#notify' do
+    before do
+      runner.stub(:result).and_return(
+        {
+          summary: {
+            offence_count: 4,
+            target_file_count: 3,
+            inspected_file_count: 2
+          }
+        }
+      )
+    end
+
     it 'notifies summary' do
       Guard::Notifier.should_receive(:notify) do |message, options|
-        message.should == '7 files inspected, 2 offences detected'
+        message.should == '2 files inspected, 4 offences detected'
       end
-      runner.notify
+      runner.notify(true)
     end
 
     it 'notifies with title "RuboCop results"' do
       Guard::Notifier.should_receive(:notify) do |message, options|
         options[:title].should == 'RuboCop results'
       end
-      runner.notify
+      runner.notify(true)
     end
 
     context 'when passed' do
-      before do
-        runner.stub(:passed).and_return(true)
-      end
-
       it 'shows success image' do
         Guard::Notifier.should_receive(:notify) do |message, options|
           options[:image].should == :success
         end
-        runner.notify
+        runner.notify(true)
       end
     end
 
     context 'when failed' do
-      before do
-        runner.stub(:passed).and_return(false)
-      end
-
       it 'shows failed image' do
         Guard::Notifier.should_receive(:notify) do |message, options|
           options[:image].should == :failed
         end
-        runner.notify
+        runner.notify(false)
       end
     end
   end
 
-  describe '#summary', :stubbed_output do
-    subject { super().summary }
+  describe '#summary_text' do
+    before do
+      runner.stub(:result).and_return(
+        {
+          summary: {
+            offence_count: offence_count,
+            target_file_count: target_file_count,
+            inspected_file_count: inspected_file_count
+          }
+        }
+      )
+    end
+
+    subject(:summary_text) { runner.summary_text }
+
+    let(:offence_count)        { 0 }
+    let(:target_file_count)    { 0 }
+    let(:inspected_file_count) { 0 }
 
-    it 'returns summary line of output' do
-      should == '7 files inspected, 2 offences detected'
+    context 'when no files are inspected' do
+      let(:inspected_file_count) { 0 }
+      it 'includes "0 files"' do
+        summary_text.should include '0 files'
+      end
     end
-  end
 
-  describe '#failed_paths', :stubbed_output do
-    subject { super().failed_paths }
+    context 'when a file is inspected' do
+      let(:inspected_file_count) { 1 }
+      it 'includes "1 file"' do
+        summary_text.should include '1 file'
+      end
+    end
 
-    it 'returns failed file paths as array' do
-      should == [
-        '/home/foo/guard-rubocop/lib/guard/rubocop.rb',
-        '/home/foo/guard-rubocop/spec/support/silence_output.rb'
-      ]
+    context 'when 2 files are inspected' do
+      let(:inspected_file_count) { 2 }
+      it 'includes "2 files"' do
+        summary_text.should include '2 files'
+      end
+    end
+
+    context 'when no offences are detected' do
+      let(:offence_count) { 0 }
+      it 'includes "no offences"' do
+        summary_text.should include 'no offences'
+      end
+    end
+
+    context 'when an offence is detected' do
+      let(:offence_count) { 1 }
+      it 'includes "1 offence"' do
+        summary_text.should include '1 offence'
+      end
+    end
+
+    context 'when 2 offences are detected' do
+      let(:offence_count) { 2 }
+      it 'includes "2 offences"' do
+        summary_text.should include '2 offences'
+      end
     end
   end
 
+  describe '#failed_paths', :json_file do
+    it 'returns file paths which have offences' do
+      runner.failed_paths.should == ['lib/bar.rb']
+    end
+  end
 end

data/spec/guard/rubocop_spec.rb

@@ -73,6 +73,13 @@ describe Guard::Rubocop, :silence_output do
         guard.failed_paths.should == failed_paths
       end
     end
+
+    context 'when an exception is raised' do
+      it 'prevents itself from firing' do
+        runner.stub(:run).and_raise(RuntimeError)
+        expect { subject }.not_to raise_error
+      end
+    end
   end
 
   describe '#run_all', :processes_after_running do
@@ -80,10 +87,11 @@ describe Guard::Rubocop, :silence_output do
 
     before do
       runner.stub(:run).and_return(true)
+      runner.stub(:failed_paths).and_return([])
     end
 
     it 'inspects all files with rubocop' do
-      runner.should_receive(:run).with(no_args)
+      runner.should_receive(:run).with([])
       guard.run_all
     end
   end
@@ -94,6 +102,7 @@ describe Guard::Rubocop, :silence_output do
 
     before do
       runner.stub(:run).and_return(true)
+      runner.stub(:failed_paths).and_return([])
     end
 
     it 'inspects changed files with rubocop' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-rubocop
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Yuji Nakayama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-14 00:00:00.000000000 Z
+date: 2013-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -26,52 +26,18 @@ dependencies:
         version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.8.2
-    - - <
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.8.2
-    - - <
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-- !ruby/object:Gem::Dependency
-  name: childprocess
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +122,15 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.3'
-description: Guard::Rubocop allows you to automatically check Ruby code style with
-  RuboCop when files are modified.
+description: Guard::Rubocop automatically checks Ruby code style with RuboCop when
+  files are modified.
 email:
 - nkymyj@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -177,7 +144,6 @@ files:
 - spec/guard/rubocop/runner_spec.rb
 - spec/guard/rubocop_spec.rb
 - spec/spec_helper.rb
-- spec/support/capture_helper.rb
 - spec/support/silence_output.rb
 homepage: https://github.com/yujinakayama/guard-rubocop
 licenses:
@@ -207,6 +173,5 @@ test_files:
 - spec/guard/rubocop/runner_spec.rb
 - spec/guard/rubocop_spec.rb
 - spec/spec_helper.rb
-- spec/support/capture_helper.rb
 - spec/support/silence_output.rb
 has_rdoc: 

data/spec/support/capture_helper.rb

@@ -1,20 +0,0 @@
-# coding: utf-8
-
-module CaptureHelper
-  # rubocop:disable Eval
-  def capture(stream_name)
-    stream_name = stream_name.to_s.downcase
-    original_stream = eval("$#{stream_name}")
-    eval("$#{stream_name} = StringIO.new")
-
-    begin
-      yield
-      result = eval("$#{stream_name}").string
-    ensure
-      eval("$#{stream_name} = original_stream")
-    end
-
-    result
-  end
-  # rubocop:enable Eval
-end