sponges 0.1.0 → 0.1.1

data/README.md

@@ -5,16 +5,21 @@ stressed and eager to work. `sponges` helps you build this army of sponges, to
 control them, and, well, to kill them gracefully. Making them stressed and eager
 to work is your job. :)
 
+Basically, sponges is a ruby supervisor that forks processes and controls their
+execution and termination. For example the following will start a supervision 
+daemon and 8 processes of  "a_worker". 
+```bash
+ruby a_worker.rb start -d -s 8
+```
+If you kill the supervisor it will cleanly
+terminate the child processes.
+
 Internally, `sponges` strongly relies on Unix signals.
 
 ## Is it any good?
 
 [Yes.](http://news.ycombinator.com/item?id=3067434)
 
-## Production ready ?
-
-Not yet, but soon. Beware, api can change in 0.0.x.
-
 ## Installation
 
 Ruby 1.9.2 (or superior) and Redis are required.
@@ -95,6 +100,11 @@ Stop workers with a `QUIT` signal :
 ruby example.rb stop
 ```
 
+Stop workers with a `KILL` signal :
+``` bash
+ruby example.rb kill
+```
+
 Stop workers with a `HUP` signal :
 ``` bash
 ruby example.rb stop -g

data/lib/sponges/cli.rb

@@ -18,6 +18,11 @@ module Sponges
       Sponges::Commander.new(Sponges::Configuration.worker_name, options).stop
     end
 
+    desc "Kill workers"
+    def kill(options = {})
+      Sponges::Commander.new(Sponges::Configuration.worker_name, options).kill
+    end
+
     option :daemonize,  type: :boolean
     option :size,       type: :numeric
     option :gracefully, type: :boolean

data/lib/sponges/commander.rb

@@ -9,24 +9,30 @@ module Sponges
       @redis = Nest.new('sponges', Configuration.redis || Redis.new)[Socket.gethostname]
     end
 
-    def stop
+    # Kills the supervisor, and then all workers.
+    #
+    def kill
+      Sponges.logger.info "Runner #{@name} kill message received."
+      stop :KILL
+      Array(@redis[:worker][@name][:pids].smembers).each do|pid|
+        kill_process(:KILL, pid, "Worker")
+      end
+    end
+
+    # Stops supervisor, signal depends on options given by Boson.
+    #
+    def stop(signal = nil)
+      signal ||= gracefully? ? :HUP : :QUIT
       Sponges.logger.info "Runner #{@name} stop message received."
       if pid = @redis[:worker][@name][:supervisor].get
-        begin
-          Process.kill gracefully? ? :HUP : :QUIT, pid.to_i
-          while alive?(pid.to_i) do
-            Sponges.logger.info "Supervisor #{pid} still alive"
-            sleep 0.5
-          end
-          Sponges.logger.info "Supervisor #{pid} has stopped."
-        rescue Errno::ESRCH => e
-          Sponges.logger.error e
-        end
+        kill_process(signal, pid)
       else
         Sponges.logger.info "No supervisor found."
       end
     end
 
+    # Increment workers's pool by one.
+    #
     def increment
       Sponges.logger.info "Runner #{@name} increment message received."
       if pid = @redis[:worker][@name][:supervisor].get
@@ -40,6 +46,8 @@ module Sponges
       end
     end
 
+    # Decrement workers's pool by one.
+    #
     def decrement
       Sponges.logger.info "Runner #{@name} decrement message received."
       if pid = @redis[:worker][@name][:supervisor].get
@@ -55,6 +63,20 @@ module Sponges
 
     private
 
+    def kill_process(signal, pid, type = "Supervisor")
+      pid = pid.to_i
+      begin
+        Process.kill signal, pid
+        while alive?(pid) do
+          Sponges.logger.info "#{type} #{pid} still alive"
+          sleep 0.5
+        end
+        Sponges.logger.info "#{type} #{pid} has stopped."
+      rescue Errno::ESRCH => e
+        Sponges.logger.error e
+      end
+    end
+
     def alive?(pid)
       begin
         Process.kill 0, pid

data/lib/sponges/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Sponges
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sponges
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-30 00:00:00.000000000 Z
+date: 2012-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: boson
@@ -75,9 +75,10 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.10.0
-description: When I build some worker, I want them to be like an army of spongebob,
-  always stressed and eager to work. sponges helps you to build this army of sponge,
-  to control them, and, well, kill them gracefully.
+description: When I build workers, I want them to be like an army of spongebobs, always
+  stressed and eager to work. sponges helps you build this army of sponges, to control
+  them, and, well, to kill them gracefully. Making them stressed and eager to work
+  is your job. :)
 email:
 - jboyer@af83.com
 executables: []
@@ -116,5 +117,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Turn any ruby object in a daemons controlling an army of sponges.
+summary: Turn any ruby object to a daemon controlling an army of sponges.
 test_files: []