delayed_job_active_record_threaded 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4a6bd62a6a5e97dd63f75c7d18de220d1494304
-  data.tar.gz: 308d9aed19966440ae784559d7651b07675884a4
+  metadata.gz: 864851553076265c22eb06a51fbc06894bbaa3a5
+  data.tar.gz: 5cbfba03389e2369e1824e65abc7746dacbaad84
 SHA512:
-  metadata.gz: a2798cb2e8f68d171724c34d8114ec2e284c797191463804a17a3e1230a8c04c69c4727ed85dceaa68acf61b471984c8ba3f262008519d32b8f9bf1d56326eac
-  data.tar.gz: 51afdb426a5b47f0b0d6aa978ef3899a6b0a6a24133a98fefcc2f771a24e8e6a73b58185e2e3b19008a2d06043ac3359a10173a936565fe2d5e2c725db7afc0f
+  metadata.gz: 72e07e672c5ae64722d932a5a418fddbff0d2d40eadfc134bcd6a3f20eb9912722db28abe9b1dee17af433adcc9b8edda2fadadac91dea6621736a8de9e3dfc4
+  data.tar.gz: c00333cf69cffa44bf5ae44455acfce75d092607b6ee740058a509d31a27ab9b65e2c6ca9c3ecff88fa482c39d9eeb4d8205145d8cc67776edd0510881dde601

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## v0.0.2
+
+* fixed issues with tasks
+
+## v0.0.1
+
+* initial release

data/README.md

@@ -1,6 +1,9 @@
-# DelayedJobActiveRecordThreaded
+# DelayedJobActiveRecordThreaded [![Build Status](https://travis-ci.org/zxiest/delayed_job_active_record_threaded.png)](http://travis-ci.org/zxiest/delayed_job_active_record_threaded)
 
-TODO: Write a gem description
+DelayedJob allows you to execute long-running jobs at a later time. For more information on how to create and delay a job, follow https://github.com/collectiveidea/delayed_job
+
+This gem processes your delayed jobs with a single threaded process (instead of multiple processes). 
+This helps avoid database deadlocks and saves computing resources.
 
 ## Installation
 
@@ -16,9 +19,58 @@ Or install it yourself as:
 
     $ gem install delayed_job_active_record_threaded
 
+
+## Setup
+Make sure to pick the correct setup method prior to proceeding:
+
+### Fresh setup
+Follow this setup method if you do have not been using delayed_job_active_record in your project and do not have a "delayed_jobs" table created:
+    
+    $ rails generate delayed_job:active_record
+    $ rake db:migrate
+
+### Upgrading from delayed_job_active_record
+
+If you were previously using delayed_job_active_record, follow the steps below:
+
+    $ rails generate delayed_job:upgrade
+    $ rake db:migrate
+    
+This will add columns to your delayed_jobs table.
+
 ## Usage
 
-TODO: Write usage instructions here
+For information on how to create delayed_jobs and enqueue them, follow https://github.com/collectiveidea/delayed_job
+
+In order to start the threaded process this gem provides, use the following:
+
+### Defaults
+
+    $ bundle exec rake delayed_job:start
+    or
+    $ bundle exec rake dj:start
+
+### With Options
+
+    The default task processes items belonging to all the queues. This is, most of times, not desirable as tasks with higher priority in a given queue take precedence over tasks in another queue.
+
+    You can have multiple queues processed simultaneously, each with its own options.
+    In the example below, we assume you have an "ebooks" and an "albums" queues.
+
+    The command below will process the queues ebooks and albums simultaneously
+    $ bundle exec rake "dj:start[ebooks&albums]"
+
+    $ bundle exec rake "dj:start[ebooks[workers_number]=16&ebooks[worker_timeout]=60&albums[workers_number]=32&albums[worker_timeout]=120]"
+
+    The expression "ebooks[workers_number]=16&ebooks[worker_timeout]=60" is a parsed similarly to a URL's query string and would be converted into the following hash:
+
+        {"ebooks"=>{"workers_number"=>"16", "worker_timeout"=>"60"}, "albums"=>{"workers_number"=>"32", "worker_timeout"=>"120"}}
+
+    The rake task above will start a process in the background and process two queues, "ebooks" with 16 working threads and times out after 60 seconds and "albums" with 32 working threads and times out after 120 seconds.
+
+    Default options:
+        workers_number: 16
+        worker_timeout: 60
 
 ## Contributing
 

data/delayed_job_active_record_threaded.gemspec

@@ -25,5 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency   'activerecord', ['>= 3.0', '< 4.1']
   spec.add_dependency   'delayed_job',  ['>= 3.0', '< 4.1']
   spec.add_dependency   'celluloid', ['>=0.14.1']
-  spec.version = "0.0.1"
+  spec.version = "0.0.2"
 end

data/lib/tasks/dj.rake

@@ -2,11 +2,11 @@ require 'rack/utils'
 
 namespace :dj do
   task :run, [:args_expr ] => :environment do |t,args|
-    Rake::Task["delayed_job:run"].invoke(args[:args_expr].nil? ? args : args[:args_expr])
+    Rake::Task["delayed_job:run"].invoke(args[:args_expr])
   end
 
   task :start, [:args_expr ] => :environment do |t,args|
-    Rake::Task["delayed_job:start"].invoke(args[:args_expr].nil? ? args : args[:args_expr])
+    Rake::Task["delayed_job:start"].invoke(args[:args_expr])
   end
 
   task :stop, [:args_expr ] => :environment do |t,args|
@@ -18,7 +18,7 @@ namespace :dj do
   end
 
   task :print_options, [:args_expr ] => :environment do |t,args|
-    Rake::Task["delayed_job:print_options"].invoke(args[:args_expr].nil? ? args : args[:args_expr])
+    Rake::Task["delayed_job:print_options"].invoke(args[:args_expr])
   end
 end
 
@@ -72,8 +72,8 @@ namespace :delayed_job do
   task :start, [ :args_expr ] => :environment do |t, args|
     puts "#{args[:args_expr]}"
 
-    cmd = %(if [ -f #{dj_pid} ] && [ -n `cat #{dj_pid}` ] && [ ps -p `cat #{dj_pid}` > /dev/null ]; then sudo kill -9 `cat #{dj_pid}`; fi
-            (bundle exec rake "delayed_job:run[#{args[:args_expr]}]" >> log/delayed_job.log 2>&1) & (echo $! > tmp/pids/dj.pid)
+    cmd = %(if [ -f #{dj_pid} ] && [ -n `cat #{dj_pid}` ] && ps -p `cat #{dj_pid}` > /dev/null; then kill `cat #{dj_pid}`; fi
+            (bundle exec rake "delayed_job:run[#{args[:args_expr]}]" >> log/delayed_job.log 2>&1) & (echo $! > #{dj_pid})
            )
 
     puts "executing: #{cmd}"
@@ -83,7 +83,7 @@ namespace :delayed_job do
   end
 
   task :stop => :environment do |t, args|
-    cmd = %(if [ -f #{dj_pid} ] && [ -n `cat #{dj_pid}` ] && [ ps -p `cat #{dj_pid}` > /dev/null ]; then kill -9 `cat #{dj_pid}`; fi)
+    cmd = %(if [ -f #{dj_pid} ] && [ -n `cat #{dj_pid}` ] && ps -p `cat #{dj_pid}` > /dev/null; then kill -9 `cat #{dj_pid}`; fi)
 
     # execute cmd
     %x(#{cmd})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delayed_job_active_record_threaded
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Abdo Achkar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-17 00:00:00.000000000 Z
+date: 2013-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -163,6 +163,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md