guard-foodcritic 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/.rvmrc

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3@guard-foodcritic"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.12.2 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+  if [[ $- == *i* ]] # check for interactive shells
+  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | grep -vE '^Using|Your bundle is complete'
+# fi

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+bundler_args: --without development

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec :development_group => :test
+
+group :development do
+  gem "growl"
+  gem "guard-bundler"
+  gem "guard-rspec"
+  gem "rb-fsevent"
+  gem "travis-lint"
+end

data/Guardfile

@@ -0,0 +1,11 @@
+guard "bundler" do
+  watch("Gemfile")
+  watch(/^.+\.gemspec/)
+end
+
+guard "rspec", :version => 2, :cli=> "--format nested" 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$}) { |m| "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Chris Griego
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Guard::Foodcritic
+
+[![Build History][2]][1] [![Dependency Status][4]][3]
+
+Guard::Foodcritic automatically runs foodcritic.
+
+[1]: http://travis-ci.org/cgriego/guard-foodcritic
+[2]: https://secure.travis-ci.org/cgriego/guard-foodcritic.png?branch=master
+[3]: https://gemnasium.com/cgriego/guard-foodcritic
+[4]: https://gemnasium.com/cgriego/guard-foodcritic.png
+
+## Installation
+
+Please be sure to have [Guard](https://github.com/guard/guard) installed before continuing.
+
+Install the gem:
+
+    $ gem install guard-foodcritic
+
+Add the guard-foodcritic definition to your Guardfile by running this command:
+
+    $ guard init foodcritic
+
+## Options
+
+```ruby
+:all_on_start => false    # Whether to run Foodcritic on all cookbooks at startup
+                          # default: true
+
+:cli => "--epic-fail any" # Command line arguments passed to foodcritic
+                          # default: "--epic-fail any"
+
+:cookbook_paths => "."    # The path(s) to your cookbooks
+                          # default: ["cookbooks"]
+
+:notification => false    # Whether to display notifications after the lint is done running
+                          # default: true
+```

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new

data/guard-foodcritic.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/guard/foodcritic/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Chris Griego"]
+  gem.email         = ["cgriego@gmail.com"]
+  gem.description   = %q{Guard::Foodcritic automatically runs foodcritic.}
+  gem.summary       = %q{Guard::Foodcritic automatically runs foodcritic.}
+  gem.homepage      = "https://github.com/cgriego/guard-foodcritic"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "guard-foodcritic"
+  gem.require_paths = ["lib"]
+  gem.version       = Guard::FOODCRITIC_VERSION
+
+  gem.add_runtime_dependency "guard", "~> 1.0"
+  gem.add_runtime_dependency "foodcritic", "~> 1.3"
+
+  gem.add_development_dependency "bundler", "~> 1.0"
+  gem.add_development_dependency "rake", "~> 0.9.0"
+  gem.add_development_dependency "rspec", "~> 2.10"
+end

data/lib/guard/foodcritic/runner.rb

@@ -0,0 +1,23 @@
+require "guard/foodcritic"
+
+module Guard
+  class Foodcritic
+    class Runner
+      attr_reader :options
+
+      def initialize(options={})
+        @options = {
+          :cli => "--epic-fail any",
+        }.merge(options)
+      end
+
+      def command(paths)
+        ["foodcritic", @options[:cli], paths].flatten(1).join(' ')
+      end
+
+      def run(paths)
+        system command(paths)
+      end
+    end
+  end
+end

data/lib/guard/foodcritic/templates/Guardfile

@@ -0,0 +1,6 @@
+guard "foodcritic" do
+  watch(%r{attributes/.+\.rb$})
+  watch(%r{providers/.+\.rb$})
+  watch(%r{recipes/.+\.rb$})
+  watch(%r{resources/.+\.rb$})
+end

data/lib/guard/foodcritic/version.rb

@@ -0,0 +1,3 @@
+module Guard
+  FOODCRITIC_VERSION = "1.0.0"
+end

data/lib/guard/foodcritic.rb

@@ -0,0 +1,67 @@
+require "guard"
+require "guard/guard"
+
+module Guard
+  class Foodcritic < Guard
+    autoload :Runner, "guard/foodcritic/runner"
+
+    def initialize(watchers=[], options={})
+      super
+
+      @options = {
+        :all_on_start => true,
+        :cookbook_paths => ["cookbooks"],
+        :notification => true,
+      }.merge(@options)
+    end
+
+    def runner
+      @runner ||= Runner.new(@options)
+    end
+
+    def start
+      run_all if @options[:all_on_start]
+    end
+
+    def run_all
+      UI.info "Linting all cookbooks"
+      run! @options[:cookbook_paths]
+    end
+
+    def run_on_additions(paths)
+      run_paths paths
+    end
+
+    def run_on_change(paths)
+      run_paths paths
+    end
+
+    def run_on_modifications(paths)
+      run_paths paths
+    end
+
+    def respond_to?(method_name, include_private=false)
+      if %w(run_on_deletion run_on_change).include? method_name.to_s
+        false
+      else
+        super
+      end
+    end
+
+    private
+
+    def run_paths(paths)
+      UI.info "Linting: #{paths.join(' ')}"
+      run! paths
+    end
+
+    def run!(paths)
+      if runner.run(paths)
+        Notifier.notify "Foodcritic passed", :image => :success if @options[:notification]
+      else
+        Notifier.notify "Foodcritic failed", :image => :failed if @options[:notification]
+        throw :task_has_failed
+      end
+    end
+  end
+end

data/spec/guard/foodcritic/runner_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+require "guard/foodcritic/runner"
+
+module Guard
+  describe Foodcritic::Runner do
+    describe "#options" do
+      it "remembers the initialized options" do
+        options = { :foo => "bar" }
+        described_class.new(options).options.should include options
+      end
+
+      it "[:cli] defaults to '--epic-fail any'" do
+        described_class.new.options[:cli].should == "--epic-fail any"
+      end
+    end
+
+    describe "#command" do
+      let(:runner) { described_class.new }
+      let(:paths) { %w(recipes/default.rb attributes/default.rb) }
+      subject { runner.command(paths) }
+
+      it "calls the foodcritic executable" do
+        should start_with "foodcritic"
+      end
+
+      it "passes the given paths to the foodcritic executable" do
+        should end_with paths.join(" ")
+      end
+
+      it "includes the cli option" do
+        should include runner.options[:cli]
+      end
+    end
+
+    describe "#run" do
+      let(:runner) { described_class.new }
+      let(:command) { mock "command" }
+      before { runner.stub(: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)
+        runner.run(paths)
+      end
+
+      it "returns true when foodcritic suceeds" do
+        runner.stub(:system).and_return(true)
+        runner.run([]).should be_true
+      end
+
+      it "returns false when foodcritic finds fault" do
+        runner.stub(:system).and_return(false)
+        runner.run([]).should be_false
+      end
+    end
+  end
+end

data/spec/guard/foodcritic_spec.rb

@@ -0,0 +1,165 @@
+require "spec_helper"
+require "guard/foodcritic"
+
+module Guard
+  describe Foodcritic do
+    before { Notifier.stub(:notify) }
+
+    it { should be_a_kind_of ::Guard::Guard }
+
+    describe "#options" do
+      it "[:all_on_start] defaults to true" do
+        described_class.new.options[:all_on_start].should be_true
+      end
+
+      it "[:cookbook_paths] defaults to ['cookbooks']" do
+        described_class.new.options[:cookbook_paths].should == ["cookbooks"]
+      end
+
+      it "[:notification] defaults to true" do
+        described_class.new.options[:notification].should be_true
+      end
+    end
+
+    shared_examples "handles runner results" do
+      context "the runner fails" do
+        before { runner.stub(: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)
+            catch(:task_has_failed) { subject }
+          end
+        end
+
+        context "notifications are disabled" do
+          let(:notification) { false }
+
+          it "does not notify the user of the failure" do
+            Notifier.should_not_receive(:notify)
+            catch(:task_has_failed) { subject }
+          end
+        end
+      end
+
+      context "the runner succeeds" do
+        before { runner.stub(: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)
+            subject
+          end
+        end
+
+        context "notifications are disabled" do
+          let(:notification) { false }
+
+          it "does not notify the user of the success" do
+            Notifier.should_not_receive(:notify)
+            subject
+          end
+        end
+      end
+    end
+
+    describe "#run_all" do
+      subject { guard.run_all }
+      let(:guard) { described_class.new [], :cookbook_paths => %w(cookbooks site-cookbooks), :notification => notification }
+      let(:notification) { false }
+      let(:runner) { mock "runner", :run => true }
+      before { guard.stub(: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)
+        subject
+      end
+
+      it "informs the user" do
+        UI.should_receive(:info).with("Linting all cookbooks")
+        subject
+      end
+
+      include_examples "handles runner results"
+    end
+
+    shared_examples "lints specified cookbook files" do
+      let(:guard) { described_class.new([], :notification => notification) }
+      let(:notification) { false }
+      let(:paths) { %w(recipes/default.rb attributes/default.rb) }
+      let(:runner) { mock "runner", :run => true }
+      before { guard.stub(:runner).and_return(runner) }
+
+      it "runs the runner with the changed paths" do
+        runner.should_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")
+        subject
+      end
+
+      include_examples "handles runner results"
+    end
+
+    describe "#run_on_additions" do
+      subject { guard.run_on_additions(paths) }
+      include_examples "lints specified cookbook files"
+    end
+
+    describe "#run_on_change" do
+      subject { guard.run_on_change(paths) }
+      include_examples "lints specified cookbook files"
+    end
+
+    describe "#run_on_modifications" do
+      subject { guard.run_on_modifications(paths) }
+      include_examples "lints specified cookbook files"
+    end
+
+    describe "#runner" do
+      it "returns a Runner" do
+        described_class.new.runner.should be_a_kind_of Foodcritic::Runner
+      end
+
+      it "memoizes the runner" do
+        guard = described_class.new
+        guard.runner.should 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
+      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.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.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 }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "bundler/setup"
+require "rspec/autorun"
+
+ENV["GUARD_ENV"] = "test"
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |file| require file }
+
+RSpec.configure do |config|
+  config.mock_framework = :rspec
+  config.treat_symbols_as_metadata_keys_with_true_values = true # default in RSpec 3
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: guard-foodcritic
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Chris Griego
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: foodcritic
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+description: Guard::Foodcritic automatically runs foodcritic.
+email:
+- cgriego@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- guard-foodcritic.gemspec
+- lib/guard/foodcritic.rb
+- lib/guard/foodcritic/runner.rb
+- lib/guard/foodcritic/templates/Guardfile
+- lib/guard/foodcritic/version.rb
+- spec/guard/foodcritic/runner_spec.rb
+- spec/guard/foodcritic_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cgriego/guard-foodcritic
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Guard::Foodcritic automatically runs foodcritic.
+test_files:
+- spec/guard/foodcritic/runner_spec.rb
+- spec/guard/foodcritic_spec.rb
+- spec/spec_helper.rb
+has_rdoc: