guard-cane 0.1.0.pre

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 progress

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard :cane, cli: "--color" do
+  watch(/.*\.rb/) 
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Justin Campbell
+
+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,33 @@
+# Guard::Cane
+[![Build Status](https://secure.travis-ci.org/justincampbell/guard-cane.png)](https://secure.travis-ci.org/justincampbell/guard-cane)
+[![Gem Version](https://badge.fury.io/rb/guard-cane.png)](http://badge.fury.io/rb/guard-cane)
+
+Guard::Cane automatically runs [Cane](https://github.com/square/cane#usage)
+when files change.
+
+## Installation
+
+Put this in your Gemfile:
+
+```rb
+gem 'guard-cane'
+```
+
+And then install with:
+
+```sh
+$ bundle
+$ guard init cane
+```
+
+This will place the following in your Guardfile:
+
+```rb
+guard :cane, cli: "--color" do
+  watch(/.*\.rb/) 
+end
+```
+
+Also recommended is adding a `.cane` file to your project. See
+[square/cane](https://github.com/square/cane#usage) for details.
+

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require 'cane/rake_task'
+require 'rspec/core/rake_task'
+
+task default: :ci
+
+task :ci do
+  Rake::Task["spec"].invoke
+  Rake::Task["cane"].invoke
+end
+
+Cane::RakeTask.new
+RSpec::Core::RakeTask.new

data/guard-cane.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'guard-cane'
+  gem.version       = '0.1.0.pre'
+  gem.authors       = ["Justin Campbell"]
+  gem.email         = ["justin@justincampbell.me"]
+  gem.summary       = "Guard plugin for Cane"
+  gem.description   = "Guard::Cane automatically runs Cane when files change"
+  gem.homepage      = "https://github.com/justincampbell/guard-cane"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'cane'
+  gem.add_dependency 'guard'
+
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

data/lib/guard/cane.rb

@@ -0,0 +1,69 @@
+require 'guard'
+require 'guard/guard'
+
+module Guard
+  # Defines the guard, which is automatically seen by Guard
+  class Cane < Guard
+    DEFAULTS = {
+      run_all_on_start: true
+    }
+
+    SUCCESS = ["Passed", { title: "Passed", image: :success }]
+    FAILED = ["Failed", { title: "Failed", image: :failed }]
+
+    attr_reader :last_result, :options
+
+    def initialize(watchers = [], options = {})
+      super
+
+      @options = DEFAULTS.merge(options)
+    end
+
+    def start
+      UI.info "Guard::Cane is running"
+
+      run_all if options[:run_all_on_start]
+    end
+
+    def run_all
+      cane
+    end
+
+    def run_on_changes(paths)
+      cane paths
+    end
+
+    def cane(paths = [])
+      command = build_command(paths)
+
+      UI.info "Running Cane: #{command}"
+
+      result = system command
+
+      if result
+        Notifier.notify(*SUCCESS) if last_result == false
+      else
+        Notifier.notify(*FAILED)
+      end
+
+      @last_result = result
+
+      result
+    end
+
+    def build_command(paths)
+      command = []
+
+      command << (options[:command] || "cane")
+
+      if paths.any?
+        joined_paths = paths.join(',')
+        command << "--all '{#{joined_paths}}'"
+      end
+
+      command << options[:cli]
+
+      command.compact.join(" ")
+    end
+  end
+end

data/lib/guard/cane/templates/Guardfile

@@ -0,0 +1,3 @@
+guard :cane, cli: "--color" do
+  watch(/.*\.rb/) 
+end

data/spec/guard/cane_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+describe Guard::Cane do
+  subject { guard }
+  let(:guard) { described_class.new(watchers, options) }
+
+  let(:options) { {} }
+  let(:paths) { [] }
+  let(:watchers) { [] }
+
+  before do
+    Guard::Notifier.stub :notify
+
+    Guard::UI.stub :info
+    Guard::UI.stub :error
+  end
+
+  describe "#start" do
+    subject(:start) { guard.start }
+
+    it "runs all" do
+      guard.should_receive :run_all
+
+      start
+    end
+
+    context "with run_all_on_start: false" do
+      let(:options) { { run_all_on_start: false } }
+
+      it "does not run all" do
+        guard.should_not_receive :run_all
+
+        start
+      end
+    end
+  end
+
+  describe "#run_all" do
+    subject(:run_all) { guard.run_all }
+
+    it "runs cane with no arguments" do
+      guard.should_receive(:cane).with()
+
+      run_all
+    end
+  end
+
+  describe "#run_on_changes" do
+    subject(:run_on_changes) { guard.run_on_changes(paths) }
+
+    let(:paths) { %w[a b c] }
+
+    it "runs cane with the paths" do
+      guard.should_receive(:cane).with(paths)
+
+      run_on_changes
+    end
+  end
+
+  describe "#cane" do
+    subject(:cane) { guard.cane(paths) }
+
+    let(:result) { true }
+
+    before do
+      guard.stub system: result
+    end
+
+    it { should be_true }
+
+    it "does not notify of success" do
+      Guard::Notifier.should_not_receive(:notify)
+
+      cane.should == true
+    end
+
+    context "when failed" do
+      let(:result) { false }
+
+      it { should be_false }
+
+      it "notifies of a failure" do
+        Guard::Notifier.should_receive(:notify).with(*described_class::FAILED)
+
+        cane
+      end
+    end
+
+    context "when failing and then succeeding" do
+      it "notifies of a success" do
+        guard.stub system: false
+        Guard::Notifier.should_receive(:notify).with(*described_class::FAILED)
+
+        guard.cane(paths)
+
+        guard.stub system: true
+        Guard::Notifier.should_receive(:notify).with(*described_class::SUCCESS)
+
+        guard.cane(paths)
+      end
+    end
+  end
+
+  describe "#build_command" do
+    subject(:build_command) { guard.build_command(paths) }
+
+    it { should == "cane" }
+
+    context "with paths" do
+      let(:paths) { %w[a b c] }
+
+      it { should == "cane --all '{a,b,c}'" }
+    end
+
+    context "with cli arguments" do
+      let(:options) { { cli: "--color" } }
+
+      it { should == "cane --color" }
+    end
+
+    context "with a custom command" do
+      let(:options) { { command: "rake quality" } }
+
+      it { should == "rake quality" }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+ENV['RUBY_ENV'] ||= 'test'
+
+require 'guard/cane'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = :random
+end
+

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: guard-cane
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+  prerelease: 6
+platform: ruby
+authors:
+- Justin Campbell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Guard::Cane automatically runs Cane when files change
+email:
+- justin@justincampbell.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- guard-cane.gemspec
+- lib/guard/cane.rb
+- lib/guard/cane/templates/Guardfile
+- spec/guard/cane_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/justincampbell/guard-cane
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Guard plugin for Cane
+test_files: []
+has_rdoc: