guard-foodcritic 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5ba090d410a68b9560e508c75669b409b80b803
-  data.tar.gz: 4056d67e46503cb7f9d991c16bc7af86742b973f
+  metadata.gz: 7adec25f273f29d9106044263702f0c357d67e47
+  data.tar.gz: 0df741b9b1480d0127722d2af918f89eef8a9f04
 SHA512:
-  metadata.gz: 615e7a2b59f20f35d296b80d36826e15f328f6aa1a08f5bbd6f2c6bcc84c8d4c6885e5b96d33118ddb6b300dbca4a84a33a25160d1515dbed8a4664776bfb13e
-  data.tar.gz: 2b31dad8ffdc729e3f85a6ebf1de4f541aa2db67471215ddd029c35641c2a7a678bba8750f03d87cba8bdaae560c2ddb88b52e671ae3e2c3329d0d9134ab7518
+  metadata.gz: 5331253af58a5b67c1ac310b8dd41f40b233b4ad570379934cd4b50de879bd3ba8a4372ee38c5e2a45373f5ff4a4347aa09caaa6bf928f1f1a6d6653074a970e
+  data.tar.gz: 50de812e5476293606647b1a1b95b8e07cfebb6bff669d56e074580bcdb877cb7bc6d62a6e89e99ca1af14f9d40090f7b821eb0ea69fbdfe49d297ac285ca78a

data/.gitignore

@@ -1,18 +1,32 @@
 *.gem
 *.rbc
-.bundle
-.config
-.yardoc
-/.ruby-gemset
-coverage
-doc/
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
 Gemfile.lock
-InstalledFiles
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-_yardoc
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -1,2 +1,2 @@
 --color
---format doc
+--require spec_helper

data/.rubocop.todo.yml

@@ -1,6 +1,3 @@
-Style/HashSyntax:
-  Enabled: false
-
 Metrics/LineLength:
   Max: 100
 
@@ -8,4 +5,4 @@ Style/Documentation:
   Enabled: false
 
 Metrics/ModuleLength:
-  Max: 137
+  Max: 139

data/.ruby-version

@@ -1 +1 @@
-1.9.3
+2.3.0

data/.travis.yml

@@ -1,7 +1,4 @@
 language: ruby
 rvm:
-  - "2.0.0-p647"
-  - "2.1.7"
-  - "2.2.3"
-install: bundle install --binstubs
-env: TRAVIS_BUILD=true
+  - 2.1.6
+sudo: false

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Project History for guard-foodcritic
 
+## 2.1.0
+* depend on foodcritic ~> 6.0
+* Move to RSpec 3.0
+* Rubocop cleanup
+
 ## 2.0.0
 
 * depend on foodcritic ~> 5.0

data/Gemfile

@@ -1,3 +1,3 @@
 source 'https://rubygems.org'
 
-gemspec :development_group => :test
+gemspec development_group: :test

data/Guardfile

@@ -1,4 +1,4 @@
-guard 'rspec', :version => 2, :cli => '--format doc' do
+guard 'rspec', version: 2, cli: '--format doc' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb') { 'spec' }

data/README.md

@@ -8,11 +8,11 @@
 
 [![Code Climate](https://codeclimate.com/github/Nordstrom/guard-foodcritic/badges/gpa.svg)](https://codeclimate.com/github/Nordstrom/guard-foodcritic)
 
-Guard::Foodcritic automatically runs foodcritic.
+Guard::Foodcritic automatically runs [foodcritic](http://www.foodcritic.io/).
 
 ## Installation
 
-guard-foodcritic depends on foodcritic v5.x, which only works with Ruby
+guard-foodcritic depends on foodcritic v6.x, which only works with Ruby
 v2.0.0 and higher.  If you are still using Ruby v1.9.3, you should use
 v1.1.1 of this gem.  The current best practice for running foodcritic
 against cookbooks is to use [ChefDK](https://downloads.chef.io/chef-dk/)

data/Rakefile

@@ -1,7 +1,15 @@
 #!/usr/bin/env rake
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-
-task :default => :spec
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new
+
+RuboCop::RakeTask.new do |rubocop|
+  rubocop.options = ['-D']
+end
+
+desc 'Run all style checks and unit tests'
+task test: [:rubocop, :spec]
+
+task default: :test

data/guard-foodcritic.gemspec

@@ -16,9 +16,10 @@ Gem::Specification.new do |gem|
   gem.version       = Guard::FOODCRITIC_VERSION
 
   gem.add_runtime_dependency 'guard', '~> 2.12'
-  gem.add_dependency 'guard-compat', '~> 1.1'
-  gem.add_runtime_dependency 'foodcritic', '~> 5.0'
+  gem.add_dependency 'guard-compat', '~> 1.2'
+  gem.add_runtime_dependency 'foodcritic', '~> 6.0'
 
-  gem.add_development_dependency 'rake', '~> 10.0'
-  gem.add_development_dependency 'rspec', '~> 2.10'
+  gem.add_development_dependency 'rake', '~> 11.0'
+  gem.add_development_dependency 'rspec', '~> 3.4'
+  gem.add_development_dependency 'rubocop', '~> 0.39'
 end

data/lib/guard/foodcritic.rb

@@ -8,9 +8,9 @@ module Guard
       super
 
       @options = {
-        :all_on_start => true,
-        :cookbook_paths => ['cookbooks'],
-        :notification => true
+        all_on_start: true,
+        cookbook_paths: ['cookbooks'],
+        notification: true
       }.merge(@options)
     end
 
@@ -56,9 +56,9 @@ module Guard
 
     def run!(paths)
       if runner.run(paths)
-        Guard::Compat::UI.notify 'Foodcritic passed', :image => :success if @options[:notification]
+        Guard::Compat::UI.notify 'Foodcritic passed', image: :success if @options[:notification]
       else
-        Guard::Compat::UI.notify 'Foodcritic failed', :image => :failed if @options[:notification]
+        Guard::Compat::UI.notify 'Foodcritic failed', image: :failed if @options[:notification]
         throw :task_has_failed
       end
     end

data/lib/guard/foodcritic/runner.rb

@@ -7,7 +7,7 @@ module Guard
 
       def initialize(options = {})
         @options = {
-          :cli => '--epic-fail any'
+          cli: '--epic-fail any'
         }.merge(options)
       end
 

data/lib/guard/foodcritic/version.rb

@@ -1,3 +1,3 @@
 module Guard
-  FOODCRITIC_VERSION = '2.0.0'
+  FOODCRITIC_VERSION = '2.1.0'.freeze
 end

data/spec/guard/foodcritic/runner_spec.rb

@@ -1,17 +1,16 @@
-require 'spec_helper'
 require 'guard/compat/test/helper'
 require 'guard/foodcritic/runner'
 
 module Guard
-  describe Foodcritic::Runner do
+  RSpec.describe Foodcritic::Runner do
     describe '#options' do
       it 'remembers the initialized options' do
-        options = { :foo => 'bar' }
-        described_class.new(options).options.should include options
+        options = { foo: 'bar' }
+        expect(described_class.new(options).options).to include options
       end
 
       it "[:cli] defaults to '--epic-fail any'" do
-        described_class.new.options[:cli].should == '--epic-fail any'
+        expect(described_class.new.options[:cli]).to eq('--epic-fail any')
       end
     end
 
@@ -21,37 +20,37 @@ module Guard
       subject { runner.command(paths) }
 
       it 'calls the foodcritic executable' do
-        should start_with 'foodcritic'
+        is_expected.to start_with 'foodcritic'
       end
 
       it 'passes the given paths to the foodcritic executable' do
-        should end_with paths.join(' ')
+        is_expected.to end_with paths.join(' ')
       end
 
       it 'includes the cli option' do
-        should include runner.options[:cli]
+        is_expected.to include runner.options[:cli]
       end
     end
 
     describe '#run' do
       let(:runner) { described_class.new }
       let(:command) { double 'command' }
-      before { runner.stub(:command).and_return(command) }
+      before { allow(runner).to receive(:command).and_return(command) }
 
       it 'generates the command with the given paths and runs it' do
         paths = %w(recipes/default.rb attributes/default.rb)
-        runner.should_receive(:system).with(command)
+        expect(runner).to receive(:system).with(command)
         runner.run(paths)
       end
 
       it 'returns true when foodcritic suceeds' do
-        runner.stub(:system).and_return(true)
-        runner.run([]).should be true
+        allow(runner).to receive(:system).and_return(true)
+        expect(runner.run([])).to be true
       end
 
       it 'returns false when foodcritic finds fault' do
-        runner.stub(:system).and_return(false)
-        runner.run([]).should be false
+        allow(runner).to receive(:system).and_return(false)
+        expect(runner.run([])).to be false
       end
     end
   end

data/spec/guard/foodcritic_spec.rb

@@ -1,40 +1,39 @@
-require 'spec_helper'
 require 'guard/compat/test/helper'
 require 'guard/foodcritic'
 
 module Guard
-  describe Foodcritic do
+  RSpec.describe Foodcritic do
     before do
-      Notifier.stub(:notify)
-      UI.stub(:info)
+      allow(Guard::Compat::UI).to receive(:notify)
+      allow(Guard::Compat::UI).to receive(:info)
     end
 
-    it { should be_a_kind_of ::Guard::Plugin }
+    it { is_expected.to be_a_kind_of ::Guard::Plugin }
 
     describe '#options' do
       it '[:all_on_start] defaults to true' do
-        described_class.new.options[:all_on_start].should be true
+        expect(described_class.new.options[:all_on_start]).to be true
       end
 
       it "[:cookbook_paths] defaults to ['cookbooks']" do
-        described_class.new.options[:cookbook_paths].should == ['cookbooks']
+        expect(described_class.new.options[:cookbook_paths]).to eq(['cookbooks'])
       end
 
       it '[:notification] defaults to true' do
-        described_class.new.options[:notification].should be true
+        expect(described_class.new.options[:notification]).to be true
       end
     end
 
     shared_examples 'handles runner results' do
       context 'the runner fails' do
-        before { runner.stub(:run).and_return(false) }
+        before { allow(runner).to receive(:run).and_return(false) }
         it { expect { subject }.to throw_symbol :task_has_failed }
 
         context 'notifications are enabled' do
           let(:notification) { true }
 
           it 'notifies the user of the failure' do
-            Notifier.should_receive(:notify).with('Foodcritic failed', :image => :failed)
+            expect(Guard::Compat::UI).to receive(:notify).with('Foodcritic failed', image: :failed)
             catch(:task_has_failed) { subject }
           end
         end
@@ -43,21 +42,21 @@ module Guard
           let(:notification) { false }
 
           it 'does not notify the user of the failure' do
-            Notifier.should_not_receive(:notify)
+            expect(Guard::Compat::UI).not_to receive(:notify)
             catch(:task_has_failed) { subject }
           end
         end
       end
 
       context 'the runner succeeds' do
-        before { runner.stub(:run).and_return(true) }
+        before { allow(runner).to receive(:run).and_return(true) }
         it { expect { subject }.not_to throw_symbol :task_has_failed }
 
         context 'notifications are enabled' do
           let(:notification) { true }
 
           it 'notifies the user of the success' do
-            Notifier.should_receive(:notify).with('Foodcritic passed', :image => :success)
+            expect(Guard::Compat::UI).to receive(:notify).with('Foodcritic passed', image: :success)
             subject
           end
         end
@@ -66,7 +65,7 @@ module Guard
           let(:notification) { false }
 
           it 'does not notify the user of the success' do
-            Notifier.should_not_receive(:notify)
+            expect(Guard::Compat::UI).not_to receive(:notify)
             subject
           end
         end
@@ -77,21 +76,21 @@ module Guard
       subject { guard.run_all }
       let(:guard) do
         described_class.new(
-          :cookbook_paths => %w(cookbooks site-cookbooks),
-          :notification => notification
+          cookbook_paths: %w(cookbooks site-cookbooks),
+          notification: notification
         )
       end
       let(:notification) { false }
-      let(:runner) { double 'runner', :run => true }
-      before { guard.stub(:runner).and_return(runner) }
+      let(:runner) { double 'runner', run: true }
+      before { allow(guard).to receive(:runner).and_return(runner) }
 
       it 'runs the runner with the cookbook paths' do
-        runner.should_receive(:run).with(guard.options[:cookbook_paths]).and_return(true)
+        expect(runner).to receive(:run).with(guard.options[:cookbook_paths]).and_return(true)
         subject
       end
 
       it 'informs the user' do
-        UI.should_receive(:info).with('Linting all cookbooks', {})
+        expect(Guard::Compat::UI).to receive(:info).with('Linting all cookbooks')
         subject
       end
 
@@ -99,19 +98,21 @@ module Guard
     end
 
     shared_examples 'lints specified cookbook files' do
-      let(:guard) { described_class.new(:notification => notification) }
+      let(:guard) { described_class.new(notification: notification) }
       let(:notification) { false }
       let(:paths) { %w(recipes/default.rb attributes/default.rb) }
-      let(:runner) { double 'runner', :run => true }
-      before { guard.stub(:runner).and_return(runner) }
+      let(:runner) { double 'runner', run: true }
+      before { allow(guard).to receive(:runner).and_return(runner) }
 
       it 'runs the runner with the changed paths' do
-        runner.should_receive(:run).with(paths).and_return(true)
+        expect(runner).to receive(:run).with(paths).and_return(true)
         subject
       end
 
       it 'informs the user' do
-        UI.should_receive(:info).with('Linting: recipes/default.rb attributes/default.rb', {})
+        expect(Guard::Compat::UI).to receive(:info).with(
+          'Linting: recipes/default.rb attributes/default.rb'
+        )
         subject
       end
 
@@ -135,40 +136,40 @@ module Guard
 
     describe '#runner' do
       it 'returns a Runner' do
-        described_class.new.runner.should be_a_kind_of Foodcritic::Runner
+        expect(described_class.new.runner).to be_a_kind_of Foodcritic::Runner
       end
 
       it 'memoizes the runner' do
         guard = described_class.new
-        guard.runner.should equal guard.runner
+        expect(guard.runner).to equal guard.runner
       end
 
       it 'configured the runner with the guard options' do
         guard = described_class.new
         runner = guard.runner
-        runner.options.should include guard.options
+        expect(runner.options).to include guard.options
       end
     end
 
     describe '#start' do
       it 'runs all on start if the :all_on_start option is set to true' do
-        guard = described_class.new(:all_on_start => true)
-        guard.should_receive(:run_all)
+        guard = described_class.new(all_on_start: true)
+        expect(guard).to receive(:run_all)
         guard.start
       end
 
       it 'does not run all on start if the :all_on_start option is set to false' do
-        guard = described_class.new(:all_on_start => false)
-        guard.should_not_receive(:run_all)
+        guard = described_class.new(all_on_start: false)
+        expect(guard).not_to receive(:run_all)
         guard.start
       end
     end
 
     describe '#respond_to' do
-      it { should respond_to :run_on_additions }
-      it { should respond_to :run_on_modifications }
-      it { should_not respond_to :run_on_change }
-      it { should_not respond_to :run_on_deletion }
+      it { is_expected.to respond_to :run_on_additions }
+      it { is_expected.to respond_to :run_on_modifications }
+      it { is_expected.not_to respond_to :run_on_change }
+      it { is_expected.not_to respond_to :run_on_deletion }
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,14 +1,92 @@
-require 'bundler/setup'
-require 'rspec/autorun'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
 
-ENV['GUARD_ENV'] = 'test'
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
 
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |file| require file }
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
 
-RSpec.configure do |config|
-  config.mock_framework = :rspec
-  # default in RSpec 3
-  config.treat_symbols_as_metadata_keys_with_true_values = true
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = false
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-foodcritic
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Chris Griego
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-18 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -31,56 +31,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: foodcritic
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.39'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.39'
 description: Guard::Foodcritic automatically runs foodcritic.
 email:
 - cgriego@gmail.com
@@ -128,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Guard::Foodcritic automatically runs foodcritic.