disc 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f29a84d4cefb49cf688a2fe2fe2bc5fcfc0a29d6
-  data.tar.gz: 2314325e125adf600c3dc6f1190d9677574dc88a
+  metadata.gz: 65752990e4c8bb6460341783b4646d78098752f5
+  data.tar.gz: de08052069da3cd2d1147ed2cd4afcaff2b2bd7d
 SHA512:
-  metadata.gz: 8fa78c4be3782443580d74072aec81b09a6079630b7b22910a148f79f11d69d90ce178b3297ef42bee287a4d92676f685bc88d75f488184613ea4a846f71d9a2
-  data.tar.gz: 960d4938fe9f596f77c607a1622bda422285fdce50de362189406b684af0846846a5b51963c8d99518ed1478e242cb1c7ed80eecd8c97ef89c387b7783f1da52
+  metadata.gz: faac2698db6e1125aa696b8d3bb54a932fbc74a30947dbb6f7aa6987579145c007913f6da41851ebc0b796b82bdf1f90dd1c2948e373d4d7812030fefe19515e
+  data.tar.gz: 8db24310748e9c68a29f51b57d6fe6f887e5eaa867b6fed2aa99d88150f71583e2d91f5ab33804bf9f64cd193507efe53f3a3304f2a5b1106aaedde65d0409dd

data/README.md

@@ -1,46 +1,77 @@
 # Disc
 
-Disc allows you to easily leverage [antirez](http://antirez.com/)'s wonderful [Disque](https://github.com/antirez/disque) from your Ruby applications, filling the gap between your service objects and Disque.
+Disc fills the gap between your Ruby service objects and [antirez](http://antirez.com/)'s wonderful [Disque](https://github.com/antirez/disque) backend.
+
+<a href=https://www.flickr.com/photos/noodlefish/5321412234/in/photolist-91LsrP-4nrahM-91PzfG-92HS1v-8ApwqD-q5sH-dM6d74-52zUMi-cJ2iVN-cJ1Egs-hcQpne-9d9RyF-9dWnVK-b5EGYP-arSsBd-6JgG1Y-qJoCkE-88Vp8g-92M3HC-9CL8KH-97eCsN-8HtoUt-2PkxTh-993Jiy-ad7xjp-a3MKZU-8Hwxgu-raHDW-993JAC-AAEa-b9LKDR-8nW7mM-qJsPN4-6Bo8Fw-qJoFjL-9CEg7J-9RDVRc-rZWuCt-9751Cf-hZyWZw-gPqXZm-8KiTxg-dpoXjb-dpoNjB-93hj1h-9sX9ii-8KiJvr-LXLH5-dhe92T-3GQgs6" target="blank_">
+![Disc Wars!](./disc-wars.jpg)
+</a>
 
 ## Usage
 
 1.  Install the gem
 
-```bash
-$ gem install disc
-```
+  ```bash
+  $ gem install disc
+  ```
 
 2. Write your jobs
 
-```ruby
-requie 'disc'
+  ```ruby
+  requie 'disc'
 
-class CreateGameGrid
-  include Disc::Job
-  queue :urgent
+  class CreateGameGrid
+    include Disc::Job
+    disc queue: 'urgent'
 
-  def perform(type)
-    # perform rather lengthy operations here.
+    def perform(type)
+      # perform rather lengthy operations here.
+    end
   end
-end
-```
+  ```
 
 3. Enqueue them to perform them asynchronously
 
-```ruby
-CreateGameGrid.enqueue('ligth_cycle')
-```
+  ```ruby
+  CreateGameGrid.enqueue('ligth_cycle')
+  ```
 
 4. Or enqueue them to be performed at some time in the future.
 
-```ruby
-CreateGameGrid.enqueue('disc_arena', at: DateTime.new(2015, 12, 31))
-```
+  ```ruby
+  CreateGameGrid.enqueue_at(DateTime.new(2015, 12, 31), 'disc_arena')
+  ```
 
-5. Run as many Disc Worker processes as you wish.
+5. Create a file that requires anything needed for your jobs to run
 
-```bash
-$ DISQUE_QUEUES=urgent,default disc
-```
+  ```ruby
+# disc_init.rb
+  require 'ohm'
+  Dir.glob('jobs/**/*.rb') { |f| require_relative f }
+  ```
+
+6. Set your require file
+
+  ```bash
+  $ export DIC_REQUIRE='./disc_init.rb'
+  ```
+
+7. Run as many Disc Worker processes as you wish.
+
+  ```bash
+  $ QUEUES=urgent,default disc
+  ```
 
 You're done!
+
+
+### PowerUps
+
+Disc workers can run just fine on their own, but sometimes you migth want to have each process spawning multiple threads doing this is trivial: just make sure you require [Celluloid](https://github.com/celluloid/celluloid) in your Disc init file!
+
+```ruby
+# disq_init.rb
+
+require 'celluloid'
+```
+
+Whenever Disc detects that Celluloid is available it will leverage it and spawn a number of threads equal to the `DISC_CONCURRENCY` environment variable, or 25 by default.

data/bin/disc

@@ -4,7 +4,11 @@ require 'disc'
 require ENV.fetch('DISC_REQUIRE')
 
 if defined?(Celluloid)
-  raise 'not implemented yet genius'
+  concurrency = ENV.fetch('DISC_CONCURRENCY', '25').to_i
+  STDOUT.puts("[Notice] Disc running in celluloid-mode! Current DISC_CONCURRENCY is #{ concurrency }.")
+
+
 else
+  STDOUT.puts("[Notice] Disc running in non-threaded mode, make sure to `require 'cellulloid'` for a significant powerup!")
   Disc::Worker.run
 end

data/disc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = 'disc'
-  s.version           = '0.0.2'
+  s.version           = '0.0.3'
   s.summary           = 'A simple disque and powerful job implementation'
   s.description       = ''
   s.authors           = ['pote']

data/disc_init_example.rb

@@ -0,0 +1 @@
+Dir.glob('./**/*.rb') { |f| require_relative f }

data/examples/greeter.rb

@@ -0,0 +1,10 @@
+require 'disc'
+
+class Greeter
+  include Disc::Job
+  disc queue: 'test_medium'
+
+  def perform(string)
+    `say #{string}`
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: disc
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - pote
@@ -51,7 +51,10 @@ files:
 - Makefile
 - README.md
 - bin/disc
+- disc-wars.jpg
 - disc.gemspec
+- disc_init_example.rb
+- examples/greeter.rb
 - lib/disc.rb
 - test/disc_test.rb
 homepage: https://github.com/pote/disque-job