havanna 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 083b1457c1f1af6aa4327822bbb00daba957324d
-  data.tar.gz: c5118e5d44add3623f7457caab9d8d1fda81a399
+  metadata.gz: 4067d3aa7fa9709542485efc5a24afbe69d6a0d8
+  data.tar.gz: 7a5919caa52c44b111082c6a2dbab0d81fdc7777
 SHA512:
-  metadata.gz: f0e1927e6176f9fa7bb90be4524a52d136bdf8fb3c7221baadb861221fb0eb03a0030d9e5df429bc8f54baa872d23c1df4a0134fe08278577684d1effba8b78f
-  data.tar.gz: 55d2ebf43d9fdfcce39a20fd848c8b72fe3e9393133a8eacf56a003ddc44c87a4ca6f5847b5b495f61a1f6c4f9e57c8b372eeedff89c880439c6680c60893969
+  metadata.gz: 6d00fb0b93047de33f2d27f8ef239125bb1db26e12db91358c2f36e6e9d2f6d5857d86d661b2e2d3db9ec7c2387d22ad4e96ddba8d7afbc87c6fe9b687808780
+  data.tar.gz: 65c38b4356e5876c6340d3a963ab83267d03fe66191b4c108f1b94b9ebbd8ccbccbb9ad485fe86871d847f85c76a71001bd279d94e56c4df20d21685c22c2155

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+1.1.0 - 2015-08-05
+==================
+
+* Havanna now exits forcefully when receiving INT or TERM twice within 5
+  seconds.
+
+* Workers listed in `Havannafile` must respond to `#to_h`. If you were using
+  your own classes, make them inherit from `Havanna::Worker`.

data/README.md

@@ -3,25 +3,57 @@ Havanna
 
 Ruby workers with [Disque][disque].
 
+
 Usage
 -----
 
-Create a worker:
+Similar to Rack's `config.ru`, Havanna has an entry point file where you
+explicitly declare handlers for your queues.
+The minimum you need to use Havanna is to create a `Havannafile`:
+
+```
+require "app"
+
+Havanna.run(Hello: -> job {
+  puts("Hello, #{job}")
+})
+```
+
+Now on the command line, start Havanna:
+
+```
+$ havanna start
+```
+
+In a different window, try queuing a job using Disque's built-in client:
+
+```
+$ disque addjob Hello world 5000
+```
+
+As expected, you should see the string "Hello, world" in the terminal where you
+started Havanna.
+
+
+Workers
+-------
+
+If you prefer to use classes to model your workers, there's `Havanna::Worker`.
+For instance, this could be `workers/mailer.rb`:
 
 ```ruby
-class Mailer
+require "havanna/worker"
+
+class Mailer < Havanna::Worker
   def call(item)
-    puts "Emailing #{item}..."
+    puts("Emailing #{item}...")
 
     # Actually do it.
   end
 end
 ```
 
-Havanna doesn't perform any kind of magic autodiscovery of
-your workers. Similar to Rack's `config.ru`, Havanna has an
-entry point file where you explicitly declare your workers.
-This would be a valid `Havannafile`:
+Then your `Havannafile` would look like this:
 
 ```ruby
 require "app"
@@ -29,21 +61,11 @@ require "app"
 Havanna.run(Mailer)
 ```
 
-Now on the command line, start your workers:
-
-```
-$ havanna start
-```
-
-In a different window, try queuing a job using Disque's
-built-in client:
 
-```
-$ disque addjob Mailer foo@example.com 5000
-```
+Administration
+--------------
 
-Once you're up and running, deploy your workers with `-d`
-for daemonization:
+Once you're up and running, deploy your workers with `-d` for daemonization:
 
 ```
 $ havanna start -d

data/bin/havanna

@@ -1,8 +1,13 @@
 #! /usr/bin/env ruby
 
+stop_requested_at = nil
+
 stop = proc do
-  if defined?(Havanna)
+  if stop_requested_at && Time.now - stop_requested_at < 5
+    exit 0
+  elsif defined?(Havanna)
     Havanna.stop
+    stop_requested_at = Time.now
   else
     exit 0
   end
@@ -14,7 +19,7 @@ trap(:TERM, &stop)
 usage = <<-EOS
 Usage:
 
-  havanna start [-r <require>] [-d] [-p <pid-path>] [-l <log-path>]
+  havanna start [-r <require>] [-d] [-p <pid-path>] [-l <log-path>] [-s <pool-size>
   havanna stop [-p <pid-path>]
 
 EOS
@@ -44,8 +49,6 @@ command, _ = Clap.run ARGV,
     opts[:requires] << file
   },
   "-v" => -> {
-    require_relative "../lib/havanna/version"
-
     puts Havanna::VERSION
 
     exit 0
@@ -104,7 +107,7 @@ when "start"
     accum.concat(Array.new(threads_per_worker) do
       Thread.new(worker) do |worker|
         Thread.current.abort_on_exception = true
-        Havanna.start(worker)
+        Havanna.start(*worker.to_h.to_a.first)
       end
     end)
   end

data/lib/havanna.rb

@@ -1,24 +1,22 @@
 require "disque"
 
 module Havanna
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 
   def self.connect(*args)
     @connect = args
     @disque = Disque.new(*args)
   end
 
-  def self.start(worker)
-    instance = worker.new
-
+  def self.start(name, handler)
     begin
       disque = Disque.new(*@connect)
 
-      printf("Started worker %s\n", worker)
+      printf("Started worker %s\n", name)
 
       loop do
-        disque.fetch(from: [worker.name], timeout: 5000) do |job|
-          instance.call(job)
+        disque.fetch(from: [name], timeout: 5000) do |job|
+          handler.call(job)
         end
 
         break if @stop

data/lib/havanna/worker.rb

@@ -0,0 +1,7 @@
+module Havanna
+  class Worker
+    def self.to_h
+      {name => new.method(:call)}
+    end
+  end
+end

data/test/havanna_test.rb

@@ -11,7 +11,7 @@ def wait_for_pid(pid)
 end
 
 def wait_for_child(pid)
-  Timeout.timeout(5) do
+  Timeout.timeout(6) do
     Process.wait(pid)
   end
 end
@@ -45,6 +45,8 @@ def root(path)
   File.expand_path("../#{path}", File.dirname(__FILE__))
 end
 
+LIB = root("lib")
+
 disque = Disque.new("127.0.0.1:7711")
 
 prepare do
@@ -56,7 +58,7 @@ test "start" do
   pid = nil
 
   begin
-    pid = spawn("#{root("bin/havanna")} start", chdir: "test/workers/echo")
+    pid = spawn({"RUBYLIB" => LIB}, "#{root("bin/havanna")} start", chdir: "test/workers/echo")
 
     disque.push("Echo", 2, 5000)
 
@@ -72,7 +74,7 @@ test "gracefully handles TERM signals" do
   disque.push("Slow", 3, 5000)
 
   begin
-    spawn("#{root("bin/havanna")} -d start", chdir: "test/workers/slow")
+    spawn({"RUBYLIB" => LIB}, "#{root("bin/havanna")} -d start", chdir: "test/workers/slow")
 
     pid = read_pid_file("./test/workers/slow/havanna.pid")
 
@@ -87,11 +89,11 @@ test "gracefully handles TERM signals" do
 end
 
 test "stop waits for workers to be done" do
-  spawn("#{root("bin/havanna")} start -d", chdir: "test/workers/slow")
+  spawn({"RUBYLIB" => LIB}, "#{root("bin/havanna")} start -d", chdir: "test/workers/slow")
 
   pid = read_pid_file("./test/workers/slow/havanna.pid")
 
-  stopper = spawn("#{root("bin/havanna")} stop", chdir: "test/workers/slow")
+  stopper = spawn({"RUBYLIB" => LIB}, "#{root("bin/havanna")} stop", chdir: "test/workers/slow")
 
   # Let the stop command start.
   wait_for { running?(stopper) }
@@ -112,7 +114,7 @@ test "use a specific path for the pid file" do
   pid_path = "./test/workers/echo/foo.pid"
 
   begin
-    spawn("#{root("bin/havanna")} -d start -p foo.pid", chdir: "test/workers/echo")
+    spawn({"RUBYLIB" => LIB}, "#{root("bin/havanna")} -d start -p foo.pid", chdir: "test/workers/echo")
 
     pid = read_pid_file(pid_path)
 
@@ -130,13 +132,13 @@ test "load Havannafile" do
   pid = nil
 
   begin
-    pid = spawn("#{root("bin/havanna")} start", chdir: "test/workers/echo")
+    pid = spawn({"RUBYLIB" => LIB}, "#{root("bin/havanna")} start", chdir: "test/workers/echo")
 
     disque.push("Echo", 2, 5000)
 
     value = wait_for { disque.fetch(from: ["Echo:result"]) }
 
-    assert_equal "2", value
+    assert_equal "2", value[0][2]
   ensure
     Process.kill(:INT, pid) if pid
   end
@@ -152,13 +154,13 @@ test "redirect stdout and stderr to a log file when daemonizing" do
   File.delete(log_path) if File.exist?(log_path)
 
   begin
-    pid = spawn("#{root("bin/havanna")} -d start", chdir: "test/workers/logger")
+    pid = spawn({"RUBYLIB" => LIB}, "#{root("bin/havanna")} -d start", chdir: "test/workers/logger")
 
     assert wait_for {
       `ps -p #{pid} -o state`.lines.to_a.last[/(\w+)/, 1] == "Z"
     }
 
-    redis.lpush("Logger", 1)
+    disque.push("Logger", "1", 5000)
   ensure
     detached_pid = read_pid_file(pid_path)
 
@@ -168,7 +170,7 @@ test "redirect stdout and stderr to a log file when daemonizing" do
 
   wait_for_pid(detached_pid)
 
-  assert_equal "out: 1\nerr: 1\n", File.read(log_path)
+  assert_equal "Started worker Logger\nout: 1\nerr: 1\n", File.read(log_path)
 end
 
 test "redirect stdout and stderr to a different log file when daemonizing" do
@@ -181,13 +183,13 @@ test "redirect stdout and stderr to a different log file when daemonizing" do
   File.delete(log_path) if File.exist?(log_path)
 
   begin
-    pid = spawn("#{root("bin/havanna")} -d -l foo.log start", chdir: "test/workers/logger")
+    pid = spawn({"RUBYLIB" => LIB}, "#{root("bin/havanna")} -d -l foo.log start", chdir: "test/workers/logger")
 
     assert wait_for {
       `ps -p #{pid} -o state`.lines.to_a.last[/(\w+)/, 1] == "Z"
     }
 
-    redis.lpush("Logger", 1)
+    disque.push("Logger", "1", 5000)
   ensure
     detached_pid = read_pid_file(pid_path)
 
@@ -197,7 +199,7 @@ test "redirect stdout and stderr to a different log file when daemonizing" do
 
   wait_for_pid(detached_pid)
 
-  assert_equal "out: 1\nerr: 1\n", File.read(log_path)
+  assert_equal "Started worker Logger\nout: 1\nerr: 1\n", File.read(log_path)
 end
 
 test "daemonizes" do
@@ -206,7 +208,7 @@ test "daemonizes" do
   pid_path = "./test/workers/echo/havanna.pid"
 
   begin
-    pid = spawn("#{root("bin/havanna")} -d start", chdir: "test/workers/echo")
+    pid = spawn({"RUBYLIB" => LIB}, "#{root("bin/havanna")} -d start", chdir: "test/workers/echo")
 
     assert wait_for {
       `ps -p #{pid} -o state`.lines.to_a.last[/(\w+)/, 1] == "Z"

data/test/workers/echo/Havannafile

@@ -1,3 +1,5 @@
-require_relative "echo"
+Havanna.connect("127.0.0.1:7711")
 
-Havanna.run(Echo)
+Havanna.run(Echo: -> job {
+  Havanna.push("Echo:result", job, 5000)
+})

data/test/workers/logger/logger.rb

@@ -1,6 +1,8 @@
 Havanna.connect("127.0.0.1:7711")
 
-class Logger
+require "havanna/worker"
+
+class Logger < Havanna::Worker
   def call(id)
     $stdout.puts("out: #{id}")
     $stderr.puts("err: #{id}")

data/test/workers/slow/slow.rb

@@ -1,6 +1,8 @@
 Havanna.connect("127.0.0.1:7711")
 
-class Slow
+require "havanna/worker"
+
+class Slow < Havanna::Worker
   def call(n)
     sleep(n.to_i)
     Havanna.push("Slow:result", n, 5000)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: havanna
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Damian Janowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-11 00:00:00.000000000 Z
+date: 2015-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: disque
@@ -61,15 +61,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - LICENSE
 - README.md
 - bin/havanna
 - havanna.gemspec
 - lib/havanna.rb
+- lib/havanna/worker.rb
 - makefile
 - test/havanna_test.rb
 - test/workers/echo/Havannafile
-- test/workers/echo/echo.rb
 - test/workers/logger/Havannafile
 - test/workers/logger/logger.rb
 - test/workers/slow/Havannafile

data/test/workers/echo/echo.rb

@@ -1,7 +0,0 @@
-Havanna.connect("127.0.0.1:7711")
-
-class Echo
-  def call(job)
-    Havanna.push("Echo:result", job, 5000)
-  end
-end