guard-rails 0.2.3 → 0.3.0

data/.travis.yml

@@ -2,4 +2,5 @@ rvm:
   - 1.8.7
   - 1.9.2
   - ree
+  - 2.0.0
 script: "bundle exec rake spec"

data/Gemfile

@@ -5,13 +5,12 @@ gemspec
 gem 'rake'
 gem 'fakefs', :require => nil
 gem 'guard'
+gem 'guard-bundler'
 gem 'guard-rspec'
 
-case RUBY_PLATFORM.downcase
-when /darwin/
-  gem 'rb-fsevent', '>= 0.3.9'
-  gem 'growl', '>= 1.0.3'
-when /linux/
-  gem 'rb-inotify', '>= 0.5.1'
-  gem 'libnotify', '>= 0.1.3'
-end
+gem 'rb-fsevent', '>= 0.3.9'
+gem 'rb-inotify', '>= 0.5.1'
+
+# Notification System
+gem 'terminal-notifier-guard', :require => RUBY_PLATFORM.downcase.include?("darwin") ? 'terminal-notifier-guard' : nil
+gem 'libnotify', :require => RUBY_PLATFORM.downcase.include?("linux") ? 'libnotify' : nil

data/Guardfile

@@ -1,7 +1,13 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec' do
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'rspec', :cli => "--color --format documentation" do
+  watch('Gemfile.lock')
   watch(%r{^spec/.+_spec\.rb})
   watch(%r{^lib/(.+)\.rb})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb') { "spec" }

data/README.md

@@ -3,26 +3,41 @@
 [![Gem Version](https://badge.fury.io/rb/guard-rails.png)](http://badge.fury.io/rb/guard-rails)
 [![Build Status](https://travis-ci.org/ranmocy/guard-rails.png)](https://travis-ci.org/ranmocy/guard-rails)
 [![Dependency Status](https://gemnasium.com/ranmocy/guard-rails.png)](https://gemnasium.com/ranmocy/guard-rails)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/ranmocy/guard-rails)
+[![Code Climate](https://codeclimate.com/github/ranmocy/guard-rails.png)](https://codeclimate.com/github/ranmocy/guard-rails)
 
-Want to restart your Rails development server whilst you work? Now you can!
+## Want to restart your Rails development server whilst you work? Now you can!
 
     guard 'rails', :port => 5000 do
       watch('Gemfile.lock')
       watch(%r{^(config|lib)/.*})
     end
 
-Lots of fun options!
+## Lots of fun options growing!
 
-* `:port` is the port number to run on (default `3000`)
-* `:environment` is the environment to use (default `development`)
-* `:start_on_start` will start the server when starting Guard (default `true`)
-* `:force_run` kills any process that's holding open the listen port before attempting to (re)start Rails (default `false`).
-* `:daemon` runs the server as a daemon, without any output to the terminal that ran `guard` (default `false`).
-* `:debugger` runs the server with the debugger enabled (default `false`). Required ruby-debug gem.
-* `:timeout` waits this number of seconds when restarting the Rails server before reporting there's a problem (default `20`).
-* `:server` lets you specify the webserver engine to use (try `:server => :thin`).
-* `:pid_file` specify your pid_file, so that maybe you can run multiple instances with same rails_env (default `tmp/pids/[RAILS_ENV].pid`).
-* `:zeus` support [zeus](https://github.com/burke/zeus) to boost rails init speed (default `false`).
+* `:daemon` runs the server as a daemon, without any output to the terminal that ran `guard` (**default `false`**)
+* `:debugger` enable the debugger in server. Required ruby-debug gem. (**default `false`**)
+* `:environment` is the server environment (**default `development`**)
+* `:force_run` kills any process that's holding the listen port before attempting to (re)start Rails (**default `false`**)
+* `:pid_file` specify your pid\_file (**default `tmp/pids/[RAILS_ENV].pid`**)
+* `:port` is the server port number (**default `3000`**)
+* `:server` the webserver engine to use (**try `:server => :thin`**)
+* `:start_on_start` will start the server when starting Guard (**default `true`**)
+* `:timeout` waits when restarting the Rails server, in seconds (**default `30`**).
+* `:zeus_plan` the [custom plan](https://github.com/burke/zeus/blob/master/docs/ruby/modifying.md) in zeus, only works when `zeus` option is `true` (**default `server`**)
+* `:zeus` support [zeus](https://github.com/burke/zeus) to boost rails init speed (**default `false`**).
+* `:CLI` construct the runner command as your willing! Will omit all options above except `pid_file`! (**default `rails server --pid tmp/pids/[RAILS_ENV].pid`**)
 
+## How-to
+
+* **Multiple instances** use `pid_file` option to run multiple instances with same rails\_env
+
+## Contribute
 Feel free to fork'n'fix for any willing.
+
+Or
+
+Tell.me in: any.way
+
+## Philosophy
+
+* [Semantic Version](http://semver.org/)

data/Rakefile

@@ -1,26 +1,32 @@
-include Rake::DSL if defined?(Rake::DSL)
-
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
 require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
 
-desc 'Push everywhere!'
-task :publish do
-  system %{git push origin}
-  system %{git push guard}
-  system %{git push gitcafe}
+require 'rake/version_task'
+Rake::VersionTask.new do |task|
+  task.with_git_tag = true
 end
 
-RSpec::Core::RakeTask.new(:spec)
+include Rake::DSL if defined?(Rake::DSL)
+RVM_PREFIX = "rvm 1.8.7@guard-rails,1.9.3-p327@guard-rails,2.0.0@guard-rails do"
+
 
 namespace :spec do
   desc "Run on three Rubies"
   task :platforms do
-    prefix = "rvm 1.8.7,1.9.2,ree,1.9.3 do"
-    system %{#{prefix} bundle}
-    system %{#{prefix} bundle exec rake spec}
+    system %{#{RVM_PREFIX} bundle}
+    system %{#{RVM_PREFIX} bundle exec rake spec}
     exit $?.exitstatus if $?.exitstatus != 0
   end
 end
 
 task :default => 'spec:platforms'
+
+desc 'Push everywhere!'
+task :publish do
+  system %{git push origin}
+  system %{git push guard}
+  system %{git push gitcafe}
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/guard-rails.gemspec

@@ -1,9 +1,8 @@
 $:.push File.expand_path("../lib", __FILE__)
-require "guard/rails/version"
 
 Gem::Specification.new do |s|
   s.name        = "guard-rails"
-  s.version     = GuardRails::VERSION
+  s.version     = File.open('VERSION') { |f| f.read }
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["John Bintz", "Wanzhang Sheng"]
   s.email       = ["john@coswellproductions.com", "Ranmocy@gmail.com"]
@@ -19,6 +18,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'guard', '>= 0.2.2'
+  s.add_dependency 'version', '>= 1.0.0'
 
   s.add_development_dependency 'rspec', '>= 2.6.0'
   s.add_development_dependency 'mocha', '>= 0.13.1'

data/lib/guard/rails.rb

@@ -2,22 +2,29 @@ require 'guard'
 require 'guard/guard'
 require 'guard/rails/runner'
 require 'rbconfig'
+require "version"
 
 module Guard
   class Rails < ::Guard::Guard
+    # Use gem `version` to support versioning
+    is_versioned
+
     attr_reader :options, :runner
 
     DEFAULT_OPTIONS = {
-        :port => 3000,
-        :environment => 'development',
-        :start_on_start => true,
-        :force_run => false,
-        :timeout => 30,
-        :server => nil,
-        :debugger => false,
-        :pid_file => nil,
-        :zeus => false,
-      }
+      :CLI => nil,
+      :daemon => false,
+      :debugger => false,
+      :environment => 'development',
+      :force_runs => false,
+      :pid_file => nil, # construct the filename based on options[:environment] on runtime
+      :port => 3000,
+      :server => nil, # specified by rails
+      :start_on_start => true,
+      :timeout => 30,
+      :zeus_plan => 'server',
+      :zeus => false,
+    }
 
     def initialize(watchers = [], options = {})
       super
@@ -57,4 +64,3 @@ module Guard
     alias :run_on_change :run_on_changes
   end
 end
-

data/lib/guard/rails/runner.rb

@@ -34,19 +34,25 @@ module Guard
     end
 
     def build_rails_command
+      return %{sh -c 'cd #{Dir.pwd} && #{options[:CLI]} --pid #{pid_file} &'} if options[:CLI]
+
       rails_options = [
+        options[:daemon] && '-d',
+        options[:debugger] && '-u',
         '-e', options[:environment],
-        '-p', options[:port],
         '--pid', pid_file,
-        options[:daemon] ? '-d' : '',
-        options[:debugger] ? '-u' : '',
-        options[:server].nil? ? '' : options[:server],
+        '-p', options[:port],
+        options[:server] || '',
+      ]
+
+      zeus_options = [
+        options[:zeus_plan] || 'server',
       ]
 
       # omit env when use zeus
-      rails_runner = options[:zeus] ? 'zeus' : "RAILS_ENV=#{options[:environment]} rails"
+      rails_runner = options[:zeus] ? "zeus #{zeus_options.join(' ')}" : "RAILS_ENV=#{options[:environment]} rails server"
 
-      %{sh -c 'cd #{Dir.pwd} && #{rails_runner} server #{rails_options.join(' ')} &'}
+      %{sh -c 'cd #{Dir.pwd} && #{rails_runner} #{rails_options.join(' ')} &'}
     end
 
     def pid_file

data/spec/lib/guard/rails/runner_spec.rb

@@ -34,20 +34,47 @@ describe Guard::RailsRunner do
   end
 
   describe '#build_rails_command' do
-    context 'no daemon' do
-      it "should not have a daemon switch" do
+    context "CLI" do
+      let(:custom_cli) { 'custom_CLI_command' }
+      let(:options) { default_options.merge(:CLI => custom_cli) }
+      it "should have only custom CLI" do
+        runner.build_rails_command.should match(%r{&& #{custom_cli} --pid })
+      end
+
+      let(:custom_pid_file) { "tmp/pids/rails_dev.pid" }
+      let(:options) { default_options.merge(:CLI => custom_cli, :pid_file => custom_pid_file) }
+      it "should use custom pid_file" do
+        pid_file_path = File.expand_path custom_pid_file
+        runner.build_rails_command.should match(%r{&& #{custom_cli} --pid #{pid_file_path}})
+      end
+    end
+
+    context "daemon" do
+      it "should should not have daemon switch" do
         runner.build_rails_command.should_not match(%r{ -d})
       end
     end
 
-    context 'daemon' do
+    context "no daemon" do
       let(:options) { default_options.merge(:daemon => true) }
-
       it "should have a daemon switch" do
         runner.build_rails_command.should match(%r{ -d})
       end
     end
 
+    context "development" do
+      it "should have environment switch to development" do
+        runner.build_rails_command.should match(%r{ -e development})
+      end
+    end
+
+    context "test" do
+      let(:options) { default_options.merge(:environment => 'test') }
+      it "should have environment switch to test" do
+        runner.build_rails_command.should match(%r{ -e test})
+      end
+    end
+
     context 'debugger' do
       let(:options) { default_options.merge(:debugger => true) }
 
@@ -80,6 +107,31 @@ describe Guard::RailsRunner do
         runner.build_rails_command.should match(%r{ --pid #{pid_file_path}})
       end
     end
+
+    context "zeus enabled" do
+      let(:options) { default_options.merge(:zeus => true) }
+      it "should have zeus in command" do
+        runner.build_rails_command.should match(%r{ zeus server })
+      end
+
+      context "custom zeus plan" do
+        let(:options) { default_options.merge(:zeus => true, :zeus_plan => 'test_server') }
+        it "should use custom zeus plan" do
+          runner.build_rails_command.should match(%r{ zeus test_server})
+        end
+      end
+    end
+
+    context "zeus disabled" do
+      it "should not have zeus in command" do
+        runner.build_rails_command.should_not match(%r{ zeus server })
+      end
+
+      let(:options) { default_options.merge(:zeus_plan => 'test_server') }
+      it "should have no effect of command" do
+        runner.build_rails_command.should_not match(%r{test_server})
+      end
+    end
   end
 
   describe '#start' do

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: guard-rails
 version: !ruby/object:Gem::Version
+  version: 0.3.0
   prerelease: 
-  version: 0.2.3
 platform: ruby
 authors:
 - John Bintz
@@ -10,56 +10,72 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-03 00:00:00.000000000 Z
+date: 2013-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.2.2
-    none: false
+  type: :runtime
   prerelease: false
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: version
+  requirement: !ruby/object:Gem::Requirement
     none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :runtime
-- !ruby/object:Gem::Dependency
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.6.0
-    none: false
-  prerelease: false
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.6.0
-    none: false
   type: :development
-- !ruby/object:Gem::Dependency
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.13.1
-    none: false
-  prerelease: false
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.13.1
-    none: false
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.13.1
 description: Restart Rails when things change in your app
 email:
 - john@coswellproductions.com
@@ -74,12 +90,12 @@ files:
 - Guardfile
 - README.md
 - Rakefile
+- VERSION
 - guard-rails.gemspec
 - lib/guard-rails.rb
 - lib/guard/rails.rb
 - lib/guard/rails/runner.rb
 - lib/guard/rails/templates/Guardfile
-- lib/guard/rails/version.rb
 - spec/lib/guard/rails/runner_spec.rb
 - spec/lib/guard/rails_spec.rb
 - spec/spec_helper.rb
@@ -90,26 +106,26 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
       segments:
       - 0
-      hash: 4523290980617449306
-  none: false
+      hash: 2850314987821883862
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
       segments:
       - 0
-      hash: 4523290980617449306
-  none: false
+      hash: 2850314987821883862
 requirements: []
 rubyforge_project: guard-rails
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Guard your Rails to always be there.

data/lib/guard/rails/version.rb

@@ -1,4 +0,0 @@
-module GuardRails
-  VERSION = '0.2.3'
-end
-