localjob 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f40a0417920e5c4e5ef5bc6cdb5586f09f67e2a
-  data.tar.gz: 3851bec9273ffdbb4c30ea47010588e51af98b98
+  metadata.gz: 162114bce1539ca945710b05070111780c6b4aa4
+  data.tar.gz: 8c3d1941d8e4f4a709aee68dcbbc15008bbe86b2
 SHA512:
-  metadata.gz: d80362eb2ee2f24eef60f7500cf22d692222dd6ef7bccdda64f44c6b0a853bc84b4fb84542aadd2ba3ceaaf7320f197c5c31ec4cf2b6719c055fd8344e0682f9
-  data.tar.gz: 27a5dec0c5281dd20fd698eefd99487203ff764fa13ca777a0046fc744639e62b1ff0c5c0ec7eedfee2e4ee418e0dc60c60b598778574c28aaefaefe906465c0
+  metadata.gz: 94919e17376f5b869d7eac9a7ead522ca3aedf967ff8431019463487138b5b43b127021d63036adff9510a8664794c09e0c88e35f8618d43f9b4d0e03a3a9df3
+  data.tar.gz: 5bc9fd26d206583f8c7a23a895dd0cc6107a7ee51dd8fecdfa157bd5aaadde1e67ca4d81dc43a0a090ecbf81e8c19000862f913890df5f090b0abe8a27b72872

data/README.md

@@ -3,7 +3,8 @@
 Localjob is a simple, self-contained background queue built on top of [System V
 message queues][sysv] (SysV Message Queue => SysV MQ for short). Workers and the
 app pushing to the queue must reside on the same machine. It's the sqlite of
-background queues. Here's a post about [how it works][blog].
+background queues. Here's a post about [how it works][blog]. You can run
+Localjob either as a seperate process, or as a thread in your app.
 
 Localjob is for early-development situations where you don't need a
 full-featured background queue, but just want to get started with something
@@ -16,7 +17,7 @@ Localjob works on Ruby >= 2.0.0 on Linux and OS X.
 Add it to your Gemfile:
 
 ```ruby
-gem 'localjob', "~> 0.2"
+gem 'localjob'
 ```
 
 ## Usage
@@ -67,6 +68,24 @@ BackgroundQueue << EmailJob.new(current_user.id, welcome_email)
 
 ### Managing workers
 
+There are two ways to spawn workers, either a thread inside the process emitting
+events, or as a separate process managed with the `localjob` command-line
+utility.
+
+#### Thread
+
+Spawn the worker thread in an initializer where you are initializing Localjob as
+well:
+
+```ruby
+BackgroundQueue = Localjob.new
+
+worker = Localjob::Worker.new(BackgroundQueue, logger: Rails.logger)
+worker.work(thread: true)
+```
+
+#### Process
+
 Spawning workers can be done with `localjob`. Run `localjob work` to spawn a
 single worker. It takes a few arguments. The most important being `--require`
 which takes a path the worker will require before processing jobs. For Rails,
@@ -114,5 +133,19 @@ def test_pop_and_send_to_worker
 end
 ```
 
+### Multiple queues
+
+If you wish to have multiple queues you can have multiple Localjob objects
+referencing different queues. A worker can only work off a single queue at a
+time, so you will have to spawn multiple thread or process workers. Example:
+
+```ruby
+MailQueue    = Localjob.new(0xDEADC0DE)
+DefaultQueue = Localjob.new(0xDEADCAFE)
+```
+
+Note that Localjob takes a hex value as the queue name. This is how the SysV
+adapter identifies different queues.
+
 [sysv]: http://man7.org/linux/man-pages/man7/svipc.7.html
 [blog]: http://sirupsen.com/unix-background-queue/

data/lib/localjob/cli.rb

@@ -5,11 +5,10 @@ class Localjob
     option :queue,     aliases: ["-q"], type: :string, default: "0x10CA110B"
     option :require,   aliases: ["-r"], type: :string, default: "."
     option :pid_file,  aliases: ["-p"], type: :string
-    option :daemon,    aliases: ["-d"], type: :boolean
     desc "work", "Start worker to process jobs"
     def work
       load_environment options[:require]
-      Localjob::Worker.new(options[:queue].to_i(16), *options.slice(:daemon, :pid_file)).work
+      Localjob::Worker.new(options[:queue].to_i(16), *options.slice(:pid_file)).work
     end
 
     private
@@ -20,6 +19,15 @@ class Localjob
         ::Rails.application.eager_load!
       elsif File.file?(file)
         require File.expand_path(file)
+      else
+        puts <<EOS
+To run a localjob worker, you must supply the --require flag. This is the file
+the worker requires before working off jobs.
+
+Otherwise localjob will complain about undefined classes, because they are not
+loaded in the context of the worker.
+EOS
+        exit!
       end
     end
 

data/lib/localjob/version.rb

@@ -1,3 +1,3 @@
 class Localjob
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/lib/localjob/worker.rb

@@ -81,6 +81,7 @@ class Localjob
     def trap_signals
       Signal.trap("QUIT") { shutdown }
       Signal.trap("INT") { shutdown }
+      Signal.trap("TERM") { shutdown }
     end
 
     def create_pid_file(path)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: localjob
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Simon Eskildsen