guard-passenger 0.1.0 → 0.2.0

data/README.rdoc

@@ -1,6 +1,6 @@
 = Guard::Passenger
 
-Guard::Passenger is the useful development server solution. The guard automatically starts passenger and intelligently restarts the server when needed.
+Guard::Passenger is the useful development server solution. The guard automatically starts Passenger and intelligently restarts the server when needed.
 
 == Install
 
@@ -24,36 +24,36 @@ Please read {guard usage doc}[http://github.com/guard/guard#readme]
 
 == Guardfile
 
-Passenger guard can be really be adapted to all kind of rack project with passenger.
+Passenger guard can be really be adapted to all kind of rack project with Passenger.
 Please read {guard doc}[http://github.com/guard/guard#readme] for more info about Guardfile DSL.
 
 === Standard rails app
 
     guard 'passenger' do
-      watch('lib/.*\.rb')
-      watch('config/.*\.rb')
+      watch(%|lib/.*\.rb|)
+      watch(%|config/.*\.rb|)
     end
 
 === Passenger standalone
 
-To use passenger standalone you can pass options to the guard. Guard::Passenger will start passenger on startup and take it down on exit.
-By default passenger standalone is deactivated and port is set to 3000.
+Passenger standalone is used as default. You can pass options to the guard to disable or configure it. Guard::Passenger will start Passenger on startup and take it down on exit.
+By default Passenger standalone is activated and port is set to 3000.
 
-    guard 'passenger', :standalone => true, :port => 3001 do
-      watch('lib/.*\.rb')
-      watch('config/.*\.rb')
-    end
+=== Ping
+
+You can choose to ping localhost:port(/path) after Passenger has been restarted, it's done asynchronously so it won't block other guards execution. If you set :ping to true, it will ping localhost:3000/, it you set :ping to a String, it will append the path to localhost:3000/ for the ping.
+If the ping responds with a non-5XX response, Passenger is considered as running, otherwise, there is probably a problem with Passenger.
 
 === Guard options
 
 Guard::Passenger accepts some options for configuration.
 
-    # :standalone    boolean     run passenger standalone                     (default: true)
-    # :port          integer     using the given port                         (default: 3000)
-    # :env           string      framework environment                        (default: development)
-    # :touch         string      path to check if restart was successful      (default: /)            (false = off)
+    # :standalone    boolean            run Passenger standalone                (default: true)
+    # :port          integer            using the given port                    (default: 3000)
+    # :env           string             framework environment                   (default: development)
+    # :ping          boolean or string  ping localhost after Passenger restart  (default: false)
 
-    guard 'passenger', :standalone => false, :port => 3001, :env => 'production', :touch => '/users/all' do
+    guard 'passenger', :standalone => false, :port => 3001, :env => 'production', :ping => '/foo' do
     end
 
 == Development
@@ -65,4 +65,7 @@ Pull requests are very welcome! Make sure your patches are well tested. Please c
 
 == Authors
 
-{Fabio Kuhn}[http://github.com/mordaroso]
+{Fabio Kuhn}[https://github.com/mordaroso]
+
+{Contributors}[https://github.com/mordaroso/guard-passenger/contributors]
+{Forks}[https://github.com/mordaroso/guard-passenger/network/members]

data/lib/guard/passenger.rb

@@ -4,79 +4,64 @@ require 'rubygems'
 
 module Guard
   class Passenger < Guard
-
+    
     autoload :Runner, 'guard/passenger/runner'
-    autoload :Toucher, 'guard/passenger/toucher'
-
-    attr_reader :port, :env, :touch
-
+    autoload :Pinger, 'guard/passenger/pinger'
+    
+    attr_reader :port, :env, :ping
+    
     def standalone?
       @standalone
     end
-
-    # ================
-    # = Guard method =
-    # ================
-
+    
+    # =================
+    # = Guard methods =
+    # =================
+    
     def initialize(watchers = [], options = {})
       super
       @standalone = options[:standalone].nil? ? true : options[:standalone]
-      @port = options[:port].nil? ? 3000 : options[:port]
-      @env = options[:env].nil? ? 'development' : options[:env]
-      @touch = options[:touch].nil? ? '/' : options[:touch]
+      @port       = options[:port] || 3000
+      @env        = options[:env] || 'development'
+      ping_opt = unless options[:touch].nil?
+        UI.info "Warning: The :touch option has been replaced by the :ping option, usage is still the same."
+        options[:touch]
+      else
+        options[:ping]
+      end
+      @ping = ping_opt.eql?(true) ? '/' : ping_opt
     end
-
+    
     # Call once when guard starts
     def start
-      UI.info "Guard::Passenger is guarding your changes!"
-      if standalone?
-        Runner.start_passenger(port, env)
-      else
-        true
-      end
+      UI.info 'Guard::Passenger is running!'
+      standalone? ? Runner.start_passenger(port, env) : true
     end
-
+    
     # Call with Ctrl-C signal (when Guard quit)
     def stop
-      if standalone?
-        Runner.stop_passenger(port)
-      else
-        true
-      end
+      UI.info 'Stopping Passenger...'
+      standalone? ? Runner.stop_passenger(port) : true
     end
-
+    
     # Call with Ctrl-Z signal
     def reload
-      restart_and_touch
+      restart_and_ping
     end
-
-    # Call with Ctrl-/ signal
-    def run_all
-      true
-    end
-
+    
     # Call on file(s) modifications
-    def run_on_change(paths)
-      restart_and_touch
+    def run_on_change(paths = {})
+      restart_and_ping
     end
-
+    
     private
-      def restart_and_touch
-        if Runner.restart_passenger & touch_url
-          UI.info 'Successfully restarted passenger'
-          true
-        else
-          UI.error 'Restarting passenger failed'
-          false
-        end
-      end
-
-      def touch_url
-        if touch
-          Toucher.touch('localhost', port, touch)
-        else
-          true
-        end
-      end
+    
+    def restart_and_ping
+      UI.info 'Restarting Passenger...'
+      restarted = Runner.restart_passenger
+      Pinger.ping('localhost', port, ping) if ping
+      restarted
+    end
+    
   end
-end
+end

data/lib/guard/passenger/pinger.rb

@@ -0,0 +1,32 @@
+require 'net/http'
+
+module Guard
+  class Passenger
+    module Pinger
+      class << self
+
+        # try to ping given url (e.g. http://localhost:3000/) and display a message to inform of the result
+        # failure == response status is 5xx
+        # otherwise, it's a success
+        def ping(host, port, path = '/')
+          path = "/#{path}" unless path.match(/^\//)
+          ping_in_thread = Thread.start {
+            begin
+              response = Net::HTTP.start(host, port) do |http|
+                http.head(path)
+              end
+              if response.is_a? Net::HTTPServerError
+                Notifier.notify("Passenger is not running!", :title => "Passenger", :image => :failed)
+              else
+                Notifier.notify("Passenger is running.", :title => "Passenger", :image => :success)
+              end
+            rescue
+              # do nothing
+            end
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/guard/passenger/runner.rb

@@ -2,34 +2,42 @@ module Guard
   class Passenger
     module Runner
       class << self
-
+        
         def restart_passenger
-           system 'touch tmp/restart.txt'
+           succeed = system("touch tmp/restart.txt")
+           if succeed
+             UI.info "Passenger successfully restarted."
+           else
+             UI.error "Passenger failed to restart!"
+           end
+           succeed
         end
-
+        
         def start_passenger(port, environment)
           if passenger_standalone_installed?
-            result = system "passenger start -p #{port} -d -e #{environment}"
-            if result
-              UI.info "Passenger standalone startet at port #{port}"
+            succeed = system("passenger start -p #{port} -d -e #{environment}")
+            if succeed
+              UI.info "Passenger standalone (port #{port}) started."
             else
-              UI.error "Passenger standalone failed to start at port #{port}"
+              UI.error "Passenger standalone (port #{port}) failed to start!"
             end
-            result
+            succeed
           else
-            UI.error "Passenger standalone is not installed. You need at least passenger version >= 3.0.0.\nPlease run 'gem install passenger' or add it to your Gemfile."
+            UI.error "Passenger standalone is not installed. You need at least Passenger version >= 3.0.0.\nPlease run 'gem install passenger' or add it to your Gemfile."
             false
           end
         end
-
+        
         def stop_passenger(port)
-          result = system "passenger stop -p #{port}"
-          if result
-            UI.info "Passenger standalone stopped"
+          succeed = system("passenger stop -p #{port}")
+          if succeed
+            UI.info "Passenger standalone (port #{port}) stopped."
+          else
+            UI.error "Passenger standalone (port #{port}) failed to stop!"
           end
-          true
+          succeed
         end
-
+        
         def passenger_standalone_installed?
           begin
             gem "passenger", ">=3.0.0"
@@ -38,7 +46,8 @@ module Guard
           end
           true
         end
+        
       end
     end
   end
-end
+end

data/lib/guard/passenger/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module PassengerVersion
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: guard-passenger
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Fabio Kuhn
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-06 00:00:00 +01:00
+date: 2010-11-29 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,7 +24,7 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 21
         segments: 
@@ -35,22 +35,70 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: bundler
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 25
+        segments: 
+        - 1
+        - 0
+        - 7
+        version: 1.0.7
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 2
+        - 2
+        - 0
+        version: 2.2.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
         - 0
         - 1
-        version: 2.0.1
+        - 8
+        version: 0.1.8
   type: :development
-  version_requirements: *id002
-description: Guard::Passenger automatically restarts passenger when needed
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: guard-bundler
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :development
+  version_requirements: *id005
+description: Guard::Passenger automatically restarts Passenger when needed.
 email: 
 - mordaroso@gmail.com
 executables: []
@@ -60,9 +108,9 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/guard/passenger/pinger.rb
 - lib/guard/passenger/runner.rb
 - lib/guard/passenger/templates/Guardfile
-- lib/guard/passenger/toucher.rb
 - lib/guard/passenger/version.rb
 - lib/guard/passenger.rb
 - LICENSE

data/lib/guard/passenger/toucher.rb

@@ -1,23 +0,0 @@
-require 'net/http'
-
-module Guard
-  class Passenger
-    module Toucher
-      class << self
-
-        # try recieve header from given url (e.g. http://localhost:3000/) and return false if response status is 500
-        def touch(host, port, path)
-          begin
-            response = nil;
-            Net::HTTP.start(host, port) do |http|
-              response = http.head(path)
-            end
-            response['status'].to_i != 500
-          rescue
-            false
-          end
-        end
-      end
-    end
-  end
-end