disc 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82dbce68f29a0a69c52cfed7c9845da55866ecd5
-  data.tar.gz: 36792205da60c1351d38a45ad5e9e2457662324e
+  metadata.gz: ef1c9ba1d12dd36f6ebbdcd38d2da62f9d5390f4
+  data.tar.gz: 893aa8601a0c096aa356696115c54187336989fb
 SHA512:
-  metadata.gz: 41be8dbe4bb699a597d32bcd622f4729df921aca7f8ea880652118b73ef198b4db2b1de2c558ab377469a5fe6e4c9af74b9eed181de821498b764ec8da30c747
-  data.tar.gz: dd9ceee2be8160ee955bd91871e0721f77b99d24b5fae0a473539a94c67c1e8ea43b0e7c56e8c5f71116c733fd61823e175a5bbf5a4e54c45f6c20c6006a8218
+  metadata.gz: a4a3f2476df67bae5fefa2ffccf83e2a006f8dd4aa8f91c9defbe5d1dd3e48d5085c3974912134067bf97e0f8c6e44d9f001dfc5d7929acf86d33c38421882fc
+  data.tar.gz: 41afd9edc3fd42ed2469c72095b102f1b463f7ac92a6a66648aa141a867b389c725ac2b6f19b1e9d508c325197531ef5379ceeeba0f6976dde16972d26377627

data/README.md

@@ -58,6 +58,29 @@ Disc fills the gap between your Ruby service objects and [antirez](http://antire
   ```bash
   $ QUEUES=urgent,default disc -r ./disc_init.rb
   ```
+  
+## Notes about Jobs
+
+Jobs are fairly straighforward Ruby classes, internally Disc serializes them to MessagePack so they can be stored in Disque, this has a few implications:
+
+* Don't enqueue complex objects! Instead of `user`, enqueue `user.id`!
+* If your job takes multiple arguments, you'll want to pass all those arguments in the first parameter of `#enqueue` as an array.
+
+Example:
+
+```ruby
+class ComplexJob
+  include Disc::Job
+  disc queue: 'urgent'
+  
+  def perform(first_parameter, second_parameter)
+    # do things...
+  end
+end
+
+
+ComplexJob.enqueue(['first argument', { second: 'argument' }]
+```
 
 ## Settings
 
@@ -100,7 +123,7 @@ The error handler function gets the data of the current job as a Hash, that has
 
 ## [Optional] Celluloid integration
 
-Disc workers can run just fine on their own, but if you happen to be using
+Disc workers run just fine on their own, but if you happen to be using
 [Celluloid](https://github.com/celluloid/celluloid) you might want Disc to take
 advantage of it and spawn multiple worker threads per process, doing this is
 trivial! Just require Celluloid before your init file:
@@ -113,7 +136,7 @@ Whenever Disc detects that Celluloid is available it will use it to  spawn a
 number of threads equal to the `DISC_CONCURRENCY` environment variable, or 25 by
 default.
 
-## Rails and ActiveJob integration
+## [Optional] Rails and ActiveJob integration
 
 You can use Disc easily in Rails without any more hassle, but if you'd like to use it via [ActiveJob](http://edgeguides.rubyonrails.org/active_job_basics.html) you can use the adapter included in this gem.
 
@@ -139,17 +162,27 @@ class CluJob < ActiveJob::Base
   end
 end
 
+# disc_init.rb
+require ::File.expand_path('../config/environment', __FILE__)
+
 # Wherever you want
 CluJob.perform_later(a_bunch_of_arguments)
 ```
 
-As always, make sure your `disc_init.rb` file requires the necessary jobs and you'll be good to go!
+Disc is run in the exact same way, for this example it'd be:
 
+```bash
+$ QUEUES=urgent disc -r ./disc_init.rb
+```
 
 ## A note on stability
 
 The version of Disque at the time of this writing is `0.0.1`. It is a wonderful project, I know of people running it in production and I expect it will only get better and better with time, but please do not expect Disc to be more production ready than Disque is.
 
+## Similar Projects
+
+If you want to use Disque but Disc isn't cutting it for you then you should take a look at [Havanna](https://github.com/djanowski/havanna), a project by my friend [@djanowski](https://twitter.com/djanowski).
+
 ## License
 
 The code is released under an MIT license. See the [LICENSE](./LICENSE) file for
@@ -157,7 +190,7 @@ more information.
 
 ## Acknowledgements
 
-* To [@godfoca](https://github.com/godfoca) for helping me ship a quality thing and putting up with my constant whining.
+* To [@foca](https://github.com/foca) for helping me ship a quality thing and putting up with my constant whining.
 * To [@antirez](https://github,com/antirez) for Redis, Disque, and his refreshing way of programming wonderful tools.
 * To [@soveran](https://github.com/soveran) for pushing me to work on this and publishing gems that keep me enjoying ruby.
 * To [all contributors](https://github.com/pote/disc/graphs/contributors)

data/lib/active_job/queue_adapters/disc_adapter.rb

@@ -1,4 +1,5 @@
 require 'date'
+require 'disc'
 require 'msgpack'
 
 module ActiveJob

data/lib/disc.rb

@@ -113,7 +113,7 @@ class Disc
         disc_options.fetch(:queue, 'default')
       end
 
-      def enqueue(args, at: nil, queue: nil)
+      def enqueue(args = [], at: nil, queue: nil)
         disque.push(
           queue || self.queue,
           {

data/lib/disc/version.rb

@@ -1,3 +1,3 @@
 class Disc
-  VERSION = "0.0.18"
+  VERSION = "0.0.19"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: disc
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - pote
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-21 00:00:00.000000000 Z
+date: 2015-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: disque