guard-rails 0.0.1 → 0.0.2

data/Gemfile

@@ -3,3 +3,11 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in guard-rails.gemspec
 gemspec
 gem 'rake', '0.8.7'
+gem 'fakefs', :require => nil
+gem 'guard'
+gem 'guard-rspec'
+
+# TODO: make this more OS-independent...like the rest of the gem
+gem 'growl'
+gem 'rb-fsevent'
+

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/README.md

@@ -5,13 +5,15 @@ Want to restart your Rails development server whilst you work? Now you can!
       watch(%r{^(config|lib)/.*})
     end
 
-Four fun options!
+Lots of fun options!
 
 * `: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`).
+* `:timeout` waits this number of seconds when restarting the Rails server before reporting there's a problem (default `20`).
 
 This is super-alpha, but it works for me! Only really hand-tested in Mac OS X. Feel free to fork'n'fix for other
-OSes, and to add some real tests.
+OSes, and to add some more real tests.
 

data/Rakefile

@@ -1,2 +1,24 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+namespace :spec do
+  desc "Run on three Rubies"
+  task :platforms do
+    current = %x{rvm-prompt v}
+    
+    fail = false
+    %w{1.8.7 1.9.2 ree}.each do |version|
+      puts "Switching to #{version}"
+      system %{rvm #{version}}
+      system %{bundle exec rspec spec}
+      if $?.exitstatus != 0
+        fail = true
+        break
+      end
+    end
+
+    system %{rvm #{current}}
+
+    exit (fail ? 1 : 0)
+  end
+end

data/guard-rails.gemspec

@@ -20,4 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'guard', '>= 0.2.2'
+
+  s.add_development_dependency 'rspec', '~> 2.6.0'
+  s.add_development_dependency 'mocha'
 end

data/lib/guard/rails.rb

@@ -1,77 +1,52 @@
 require 'guard'
 require 'guard/guard'
+require 'guard/rails/runner'
 require 'rbconfig'
 
 module Guard
   class Rails < ::Guard::Guard
-    attr_reader :options
+    attr_reader :options, :runner
 
-    def initialize(watchers = [], options = {})
-      super
-      @options = {
+    DEFAULT_OPTIONS = {
         :port => 3000,
         :environment => 'development',
         :start_on_start => true,
-        :force_run => false
-      }.merge(options)
+        :force_run => false,
+        :timeout => 20
+      }
+
+    def initialize(watchers = [], options = {})
+      super
+      @options = DEFAULT_OPTIONS.merge(options)
+
+      @runner = RailsRunner.new(@options)
     end
 
     def start
-      UI.info "Guard::Rails restarting app on port #{options[:port]} using #{options[:environment]} environment."
+      UI.info "Guard::Rails will now restart your app on port #{options[:port]} using #{options[:environment]} environment."
       run_all if options[:start_on_start]
     end
 
     def run_all
+      UI.info "Restarting Rails..."
       Notifier.notify("Rails restarting on port #{options[:port]} in #{options[:environment]} environment...", :title => "Restarting Rails...", :image => :pending)
-      stop_rails ; start_rails
-      Notifier.notify("Rails restarted on port #{options[:port]}.", :title => "Rails restarted!", :image => :success)
+      if runner.restart
+        UI.info "Rails restarted, pid #{runner.pid}"
+        Notifier.notify("Rails restarted on port #{options[:port]}.", :title => "Rails restarted!", :image => :success)
+      else
+        UI.info "Rails NOT restarted, check your log files."
+        Notifier.notify("Rails NOT restarted, check your log files.", :title => "Rails NOT restarted!", :image => :failure)
+      end
     end
 
     def stop
       Notifier.notify("Until next time...", :title => "Rails shutting down.", :image => :pending)
-      stop_rails
+      runner.stop
     end
 
     def run_on_change(paths)
       run_all
     end
-
-    private
-    def pid_file
-      File.expand_path("tmp/pids/#{options[:environment]}.pid")
-    end
-
-    def start_rails
-      kill_unmanaged_pid! if options[:force_run]
-      system %{sh -c 'cd #{Dir.pwd} && rails s -e #{options[:environment]} -p #{options[:port]} --pid #{pid_file} &'}
-      while !File.file?(pid_file)
-        sleep 0.5
-      end
-      UI.info "Rails restarted, pid #{File.read(pid_file)}"
-    end
-
-    def stop_rails
-      if File.file?(pid_file)
-        system %{kill -INT #{File.read(pid_file).strip}}
-      end
-    end
-
-    def unmanaged_pid
-      if RbConfig::CONFIG['host_os'] =~ /darwin/
-        %x{lsof -P}.each_line { |line|
-          if line["*:#{options[:port]} "]
-            return line.split("\s")[1]
-          end
-        }
-      end
-      nil
-    end
-
-    def kill_unmanaged_pid!
-      if pid = unmanaged_pid
-        system %{kill -INT #{pid}}
-      end
-    end
   end
 end
 

data/lib/guard/rails/runner.rb

@@ -0,0 +1,88 @@
+module Guard
+  class RailsRunner
+    MAX_WAIT_COUNT = 10
+
+    attr_reader :options
+
+    def initialize(options)
+      @options = options
+    end
+
+    def start
+      kill_unmanaged_pid! if options[:force_run]
+      run_rails_command!
+      count = 0
+      while !has_pid? && count < MAX_WAIT_COUNT
+        wait_for_pid_action
+        count += 1
+      end
+      !(count == MAX_WAIT_COUNT)
+    end
+
+    def stop
+      if File.file?(pid_file)
+        system %{kill -INT #{File.read(pid_file).strip}}
+      end
+    end
+    
+    def restart
+      stop
+      start
+    end
+
+    def build_rails_command
+      rails_options = [
+        '-e', options[:environment],
+        '-p', options[:port],
+        '--pid', pid_file
+      ]
+
+      rails_options << '-d' if options[:daemon]
+
+      %{sh -c 'cd #{Dir.pwd} && rails s #{rails_options.join(' ')} &'}
+    end
+
+    def pid_file
+      File.expand_path("tmp/pids/#{options[:environment]}.pid")
+    end
+
+    def pid
+      File.file?(pid_file) ? File.read(pid_file).to_i : nil
+    end
+
+    def sleep_time
+      options[:timeout].to_f / MAX_WAIT_COUNT.to_f
+    end
+
+    private
+    def run_rails_command!
+      system build_rails_command
+    end
+
+    def has_pid?
+      File.file?(pid_file)
+    end
+
+    def wait_for_pid_action
+      sleep sleep_time
+    end
+
+    def kill_unmanaged_pid!
+      if pid = unmanaged_pid
+        system %{kill -INT #{pid}}
+      end
+    end
+
+    def unmanaged_pid
+      if RbConfig::CONFIG['host_os'] =~ /darwin/
+        %x{lsof -P}.each_line { |line|
+          if line["*:#{options[:port]} "]
+            return line.split("\s")[1]
+          end
+        }
+      end
+      nil
+    end
+  end
+end
+

data/lib/guard/rails/version.rb

@@ -1,4 +1,4 @@
 module GuardRails
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end
 

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

@@ -0,0 +1,106 @@
+require 'spec_helper'
+require 'guard/rails/runner'
+require 'fakefs/spec_helpers'
+
+describe Guard::RailsRunner do
+  let(:runner) { Guard::RailsRunner.new(options) }
+  let(:environment) { 'development' }
+  let(:port) { 3000 }
+  
+  let(:default_options) { { :environment => environment, :port => port } }
+  let(:options) { default_options }
+  
+  describe '#pid' do
+    include FakeFS::SpecHelpers
+
+    context 'pid file exists' do
+      let(:pid) { 12345 }
+
+      before do
+        File.open(runner.pid_file, 'w') { |fh| fh.print pid }
+      end
+
+      it "should read the pid" do
+        runner.pid.should == pid
+      end
+    end
+
+    context 'pid file does not exist' do
+      it "should return nil" do
+        runner.pid.should be_nil
+      end
+    end
+  end
+
+  describe '#build_rails_command' do
+    context 'no daemon' do
+      it "should not have a daemon switch" do
+        runner.build_rails_command.should_not match(%r{ -d})
+      end
+    end
+
+    context '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
+  end
+
+  describe '#start' do
+    let(:kill_expectation) { runner.expects(:kill_unmanaged_pid!) }
+    let(:pid_stub) { runner.stubs(:has_pid?) }
+
+    before do
+      runner.expects(:run_rails_command!).once
+    end
+
+    context 'do not force run' do
+      before do
+        pid_stub.returns(true)
+        kill_expectation.never
+        runner.expects(:wait_for_pid_action).never
+      end
+
+      it "should act properly" do
+        runner.start.should be_true
+      end
+    end
+
+    context 'force run' do
+      let(:options) { default_options.merge(:force_run => true) }
+
+      before do
+        pid_stub.returns(true)
+        kill_expectation.once
+        runner.expects(:wait_for_pid_action).never
+      end
+
+      it "should act properly" do
+        runner.start.should be_true
+      end
+    end
+
+    context "don't write the pid" do
+      before do
+        pid_stub.returns(false)
+        kill_expectation.never
+        runner.expects(:wait_for_pid_action).times(Guard::RailsRunner::MAX_WAIT_COUNT)
+      end
+
+      it "should act properly" do
+        runner.start.should be_false
+      end
+    end
+  end
+
+  describe '#sleep_time' do
+    let(:timeout) { 30 }
+    let(:options) { default_options.merge(:timeout => timeout) }
+
+    it "should adjust the sleep time as necessary" do
+      runner.sleep_time.should == (timeout.to_f / Guard::RailsRunner::MAX_WAIT_COUNT.to_f)
+    end
+  end
+end

data/spec/lib/guard/rails_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+require 'guard/rails'
+
+describe Guard::Rails do
+  let(:guard) { Guard::Rails.new(watchers, options) }
+  let(:watchers) { [] }
+  let(:options) { {} }
+
+  describe '#initialize' do
+    it "should initialize with options" do
+      guard
+
+      guard.runner.options[:port].should == 3000
+    end
+  end
+
+  describe '#start' do
+    let(:ui_expectation) { Guard::UI.expects(:info).with(regexp_matches(/#{Guard::Rails::DEFAULT_OPTIONS[:port]}/)) }
+
+    context 'start on start' do
+      it "should show the right message and run startup" do
+        guard.expects(:run_all).once
+        ui_expectation
+        guard.start
+      end
+    end
+
+    context 'no start on start' do
+      let(:options) { { :start_on_start => false } }
+
+      it "should show the right message and not run startup" do
+        guard.expects(:run_all).never
+        ui_expectation
+        guard.start
+      end
+    end
+  end
+
+  describe '#run_all' do
+    let(:pid) { '12345' }
+
+    before do
+      Guard::UI.expects(:info).with('Restarting Rails...')
+      Guard::Notifier.expects(:notify).with(regexp_matches(/Rails restarting/), anything)
+      Guard::RailsRunner.any_instance.stubs(:pid).returns(pid)
+    end
+
+    let(:runner_stub) { Guard::RailsRunner.any_instance.stubs(:restart) }
+
+    context 'with pid file' do
+      before do
+        runner_stub.returns(true)
+      end
+
+      it "should restart and show the pid file" do
+        Guard::UI.expects(:info).with(regexp_matches(/#{pid}/))
+        Guard::Notifier.expects(:notify).with(regexp_matches(/Rails restarted/), anything)
+
+        guard.run_all
+      end
+    end
+
+    context 'no pid file' do
+      before do
+        runner_stub.returns(false)
+      end
+
+      it "should restart and show the pid file" do
+        Guard::UI.expects(:info).with(regexp_matches(/#{pid}/)).never
+        Guard::UI.expects(:info).with(regexp_matches(/Rails NOT restarted/))
+        Guard::Notifier.expects(:notify).with(regexp_matches(/Rails NOT restarted/), anything)
+
+        guard.run_all
+      end
+    end
+  end
+  
+  describe '#stop' do
+    it "should stop correctly" do
+      Guard::Notifier.expects(:notify).with('Until next time...', anything)
+      guard.stop
+    end
+  end
+
+  describe '#run_on_change' do
+    it "should run on change" do
+      guard.expects(:run_all).once
+      guard.run_on_change([])
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'mocha'
+
+RSpec.configure do |c|
+  c.mock_with :mocha
+end

metadata

@@ -2,7 +2,7 @@
 name: guard-rails
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - John Bintz
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-31 00:00:00 -04:00
+date: 2011-06-03 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,6 +24,28 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
 description: Restart Rails when things change in your app
 email: 
 - john@coswellproductions.com
@@ -36,13 +58,18 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- Guardfile
 - README.md
 - Rakefile
 - 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
 has_rdoc: true
 homepage: ""
 licenses: []
@@ -57,7 +84,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 104230829909269231
+      hash: -1829971580643100829
       segments: 
       - 0
       version: "0"
@@ -66,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 104230829909269231
+      hash: -1829971580643100829
       segments: 
       - 0
       version: "0"
@@ -77,5 +104,7 @@ rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Restart Rails when things change in your app
-test_files: []
-
+test_files: 
+- spec/lib/guard/rails/runner_spec.rb
+- spec/lib/guard/rails_spec.rb
+- spec/spec_helper.rb