guard-rubocop 1.0.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ec82afdd85de6be92deca90949f571a84eae25cf
-  data.tar.gz: 68d6f82e862a90d3625e4fcf0b1c06d36a67221c
+SHA256:
+  metadata.gz: e66ec8cc26e03e6fc402a04e57ba01155e2811f53e2bbc07537ce83657240ee4
+  data.tar.gz: 98c66cd08f8ac9bbf37b259c11250bb24b2e123005c8306c066e0111f6cac935
 SHA512:
-  metadata.gz: d40d80a751bc72240d3c0d5b1c1ace21c12e1792a66ee481511733c91ff1f360c478eda6ccf31bf80cf2475ab1c4464176ebf979f61514a668998339687328ea
-  data.tar.gz: 5a2c18d2e662dc0744463c374bd94cf55979b816538726dd89f81bac3dce0d14850ced6d4dbd35a72caf3c72372cf96cb433651a775ccfdb4eef8ac1cd6127cd
+  metadata.gz: '09bf72978e4a18615a30494e8422c7f66cac1fd0f01ede788966ab47f2ea41541b08fe81e6dae2200e09407973cefc821deabe7577e8983b52788e9d005324fa'
+  data.tar.gz: '0490a4d82a4fc9385c8e01ffe6cf7bec665d67d494a830b5bd8063b281c8a2b501210f46ea93c2c03d11cfa5f8ae2d883cd4e3db267efb8103f426192a850420'

data/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  rspec:
+    name: RSpec
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.4, 2.5, 2.6, 2.7]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle install
+      - run: bundle exec rspec
+      - uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+  rubocop:
+    name: RuboCop
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - run: bundle install
+      - run: bundle exec rubocop

data/.gitignore

@@ -11,6 +11,7 @@ doc/
 lib/bundler/man
 pkg
 rdoc
+spec/examples.txt
 spec/reports
 test/tmp
 test/version_tmp

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -1,7 +1,36 @@
-# The default 79 character limit is sometimes unproductive.
-LineLength:
+inherit_from: .rubocop_todo.yml
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/LineLength:
   Max: 100
 
-# The default 10 lines limit is unrealistic.
-MethodLength:
+Lint/MissingSuper:
+  Exclude:
+    - spec/support/silence_output.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/MethodLength:
   Max: 15
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: error
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - lib/guard/rubocop/templates/Guardfile
+
+Style/RegexpLiteral:
+  Exclude:
+    - '**/*.gemspec'
+    - '**/Guardfile'

data/.rubocop_todo.yml

@@ -0,0 +1,12 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-01-20 14:55:30 +0900 using RuboCop version 0.52.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 103

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 ## Development
 
+## v1.4.0
+
+* Support RuboCop 1.0
+
+## v1.3.0
+
+* Add `:launchy` option ([#21](https://github.com/yujinakayama/guard-rubocop/pull/21), [#35](https://github.com/yujinakayama/guard-rubocop/pull/35))
+* Modify the `Guardfile` template so that RuboCop can be run when `.rubocop_todo.yml` is modified ([#36](https://github.com/yujinakayama/guard-rubocop/pull/36))
+
+## 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`
+
+## 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

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
 group :test do
-  gem 'coveralls',      '~> 0.6'
-  gem 'simplecov-rcov', '~> 0.2'
-  gem 'ci_reporter',    '~> 1.8'
+  gem 'simplecov-lcov'
 end

data/Guardfile

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 # 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

@@ -1,10 +1,13 @@
-[![Gem Version](https://badge.fury.io/rb/guard-rubocop.png)](http://badge.fury.io/rb/guard-rubocop) [![Dependency Status](https://gemnasium.com/yujinakayama/guard-rubocop.png)](https://gemnasium.com/yujinakayama/guard-rubocop) [![Build Status](https://travis-ci.org/yujinakayama/guard-rubocop.png?branch=master)](https://travis-ci.org/yujinakayama/guard-rubocop) [![Coverage Status](https://coveralls.io/repos/yujinakayama/guard-rubocop/badge.png?branch=master)](https://coveralls.io/r/yujinakayama/guard-rubocop) [![Code Climate](https://codeclimate.com/github/yujinakayama/guard-rubocop.png)](https://codeclimate.com/github/yujinakayama/guard-rubocop)
+[![Gem Version](https://badge.fury.io/rb/guard-rubocop.svg)](http://badge.fury.io/rb/guard-rubocop)
+[![CI](https://github.com/yujinakayama/guard-rubocop/workflows/CI/badge.svg)](https://github.com/yujinakayama/guard-rubocop/actions)
+[![Coverage Status](https://coveralls.io/repos/yujinakayama/guard-rubocop/badge.svg?branch=master&service=github)](https://coveralls.io/github/yujinakayama/guard-rubocop?branch=master)
+[![Code Climate](https://codeclimate.com/github/yujinakayama/guard-rubocop/badges/gpa.svg)](https://codeclimate.com/github/yujinakayama/guard-rubocop)
 
-# Guard::Rubocop
+# guard-rubocop
 
-Guard::Rubocop allows you to automatically check Ruby code style with [RuboCop](https://github.com/bbatsov/rubocop) when files are modified.
+**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 2.4 - 2.7.
 
 ## Installation
 
@@ -30,7 +33,7 @@ or install it yourself as:
 $ gem install guard-rubocop
 ```
 
-Add the default Guard::Rubocop definition to your `Guardfile` by running:
+Add the default Guard::RuboCop definition to your `Guardfile` by running:
 
 ```sh
 $ guard init rubocop
@@ -55,9 +58,11 @@ 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
+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.
@@ -65,8 +70,46 @@ notification: :failed  # Display Growl notification after each run.
                        #   false   - Never notify
                        #   :failed - Notify only when failed
                        #   default: :failed
+launchy: nil           # Filename to launch using Launchy after RuboCop runs.
+                       #   default: nil
+```
+
+### Using Launchy to view results
+
+guard-rubocop can be configured to launch a results file in lieu of or in addition to outputing results to the terminal.
+Configure your Guardfile with the launchy option:
+
+``` ruby
+guard :rubocop, cli: %w(--format fuubar --format html -o ./tmp/rubocop_results.html), launchy: './tmp/rubocop_results.html' do
+  # ...
+end
+```
+
+## 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 consider making use of the [group method](https://github.com/guard/guard/wiki/Guardfile-DSL---Configuring-Guard#group) in your `Guardfile`:
+
+```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
@@ -77,6 +120,6 @@ notification: :failed  # Display Growl notification after each run.
 
 ## License
 
-Copyright (c) 2013 Yuji Nakayama
+Copyright (c) 2013–2014 Yuji Nakayama
 
 See the [LICENSE.txt](LICENSE.txt) for details.

data/Rakefile

@@ -1,23 +1,10 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-Rubocop::RakeTask.new(:style)
-
-namespace :ci do
-  task :spec do
-    ENV['CI'] = 'true'
-
-    ENV['CI_REPORTS'] = 'spec/reports'
-    require 'ci/reporter/rake/rspec'
-    Rake::Task['ci:setup:rspec'].invoke
-
-    Rake::Task['spec'].invoke
-  end
-end
-
-desc 'Run RSpec and RuboCop'
-task all: [:spec, :style]
+RuboCop::RakeTask.new(:style)
 
-task default: :all
+task ci: %i[spec style]

data/guard-rubocop.gemspec

@@ -1,32 +1,35 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'guard/rubocop/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'guard-rubocop'
-  spec.version       = Guard::RubocopVersion.to_s
+  spec.version       = GuardRuboCopVersion.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.required_ruby_version = '>= 2.4'
+
+  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'
-  spec.add_runtime_dependency 'rubocop', '~> 0.10'
+  spec.add_runtime_dependency 'rubocop', '< 2.0'
 
-  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 'bundler'
+  spec.add_development_dependency 'guard-rspec', '>= 4.2.3', '< 5.0'
+  spec.add_development_dependency 'launchy',     '~> 2.4'
+  spec.add_development_dependency 'rake',        '>= 12.0'
+  spec.add_development_dependency 'rspec',       '~> 3.0'
   spec.add_development_dependency 'simplecov',   '~> 0.7'
-  spec.add_development_dependency 'guard-rspec', '~> 4.0'
-  spec.add_development_dependency 'ruby_gntp',   '~> 0.3'
 end

data/lib/guard/rubocop.rb

@@ -1,12 +1,12 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 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
@@ -16,9 +16,10 @@ module Guard
 
       @options = {
         all_on_start: true,
-        keep_failed:  true,
+        keep_failed: true,
         notification: :failed,
-        cli: nil
+        cli: nil,
+        hide_stdout: false
       }.merge(options)
 
       @failed_paths = []
@@ -64,8 +65,8 @@ module Guard
       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: ' +
+    rescue StandardError => error
+      UI.error 'The following exception occurred while running guard-rubocop: ' \
                "#{error.backtrace.first} #{error.message} (#{error.class.name})"
     end
 
@@ -74,7 +75,8 @@ module Guard
       paths.map! { |path| File.expand_path(path) }
       paths.uniq!
       paths.reject! do |path|
-        next true unless File.exists?(path)
+        next true unless File.exist?(path)
+
         included_in_other_path?(path, paths)
       end
       paths

data/lib/guard/rubocop/runner.rb

@@ -1,9 +1,9 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 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
@@ -22,21 +22,28 @@ module Guard
           notify(passed)
         end
 
+        open_launchy_if_needed
+
         passed
       end
 
       def build_command(paths)
         command = ['rubocop']
 
-        unless include_formatter_for_console?(args_specified_by_user)
-          command.concat(%w(--format progress)) # Keep default formatter for console.
+        if should_add_default_formatter_for_console?
+          command.concat(%w[--format progress]) # Keep default formatter for console.
         end
 
         command.concat(['--format', 'json', '--out', json_file_path])
+        command << '--force-exclusion'
         command.concat(args_specified_by_user)
         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]
@@ -44,7 +51,7 @@ module Guard
           when Array    then args
           when String   then args.shellsplit
           when NilClass then []
-          else fail ':cli option must be either an array or string'
+          else raise ArgumentError, ':cli option must be either an array or string'
           end
         end
       end
@@ -92,13 +99,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]
@@ -106,19 +115,26 @@ module Guard
       end
 
       def pluralize(number, thing, options = {})
-        text = ''
-
-        if number == 0 && options[:no_for_zero]
-          text = 'no'
-        else
-          text << number.to_s
-        end
+        text =
+          if number.zero? && options[:no_for_zero]
+            +'no'
+          else
+            number.to_s
+          end
 
         text << " #{thing}"
         text << 's' unless number == 1
 
         text
       end
+
+      def open_launchy_if_needed
+        return unless (output_path = @options[:launchy])
+        return unless File.exist?(output_path)
+
+        require 'launchy'
+        ::Launchy.open(output_path)
+      end
     end
   end
 end