disc 0.0.21 → 0.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6ebc5318a06c998692fa8d5ce44f942f76aa552
-  data.tar.gz: c8010f716c1b36209c6bdc9327dd62732be6c5cd
+  metadata.gz: c6bf616dea2ead6c544788565f1b487ddaedeffa
+  data.tar.gz: 191da0a289ac1ec6b1b60d76d547e996b7e56083
 SHA512:
-  metadata.gz: fd66d5822dc049f1947a2d57a3159928aab59559f34d566584b43a754a2bb1ca10111022d49697e05c2999928f3a04438779c30e4c65440b70688cb543d0508e
-  data.tar.gz: a91114eb1133456546a223a254aa0bacf1f754c7c581340a25232ca328d9319d77bc0fd10df89d44cc0ec40e4525ef463bd5a1c23fd48c51738c50e788fafe56
+  metadata.gz: 83c6e1a7cf0aaba55e156097a8f02f772227854fb93fcca59d10acd15df8dff8b1d4dc1582af091b1e926f2d5b011f2d122a64eb53223f2d841fbe87ea45485f
+  data.tar.gz: 212a4df34ad33ad7865e934e46964517aa77a6127d9545653ee148f9cdfcbfa3bebad9903577e35163939d9888df6e6a1cf2428022224b38319923ea1858dddf

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+rvm:
+  - 2.2
+sudo: false
+cache:
+  bundler: false
+  directories:
+    - disque
+    - gems
+before_install:
+  - test -d disque/.git || git clone -n https://github.com/antirez/disque.git
+  - cd disque && git fetch origin && git checkout -f master && make && cd ..
+install:
+  - export GEM_HOME=$PWD/gems/$RUBY_VERSION
+  - export GEM_PATH=$GEM_HOME:$GEM_PATH
+  - export PATH=$GEM_HOME/bin:$PWD/disque/src:$PATH
+  - mkdir -p $GEM_HOME
+  - which dep || gem install dep
+  - dep install
+before_script: disque-server --daemonize yes
+script: make test

data/README.md

@@ -1,4 +1,4 @@
-# Disc
+# Disc [![Build Status](https://travis-ci.org/pote/disc.svg?branch=master)](https://travis-ci.org/pote/disc)
 
 Disc fills the gap between your Ruby service objects and [antirez](http://antirez.com/)'s wonderful [Disque](https://github.com/antirez/disque) backend.
 
@@ -58,10 +58,10 @@ 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:
+Jobs are fairly straightforward 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.
@@ -72,7 +72,7 @@ Example:
 class ComplexJob
   include Disc::Job
   disc queue: 'urgent'
-  
+
   def perform(first_parameter, second_parameter)
     # do things...
   end
@@ -191,7 +191,7 @@ more information.
 ## Acknowledgements
 
 * 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 [@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/disc/version.rb

@@ -1,3 +1,3 @@
 class Disc
-  VERSION = "0.0.21"
+  VERSION = "0.0.22"
 end

data/lib/disc.rb

@@ -28,6 +28,14 @@ class Disc
     @disque_timeout = timeout
   end
 
+  def self.default_queue
+    @default_queue ||= 'default'
+  end
+
+  def self.default_queue=(queue)
+    @default_queue = queue
+  end
+
   def self.on_error(exception, job)
     $stderr.puts exception
   end
@@ -101,7 +109,8 @@ class Disc
         @disque = disque
       end
 
-      def disc(options = {})
+      def disc(queue: nil, **options)
+        @queue = queue
         @disc_options = options
       end
 
@@ -110,10 +119,14 @@ class Disc
       end
 
       def queue
-        disc_options.fetch(:queue, 'default')
+        @queue || Disc.default_queue
       end
 
-      def enqueue(args = [], at: nil, queue: nil)
+      def enqueue(args = [], at: nil, queue: nil, **options)
+        options = disc_options.merge(options).tap do |opt|
+          opt[:delay] = at.to_time.to_i - DateTime.now.to_time.to_i unless at.nil?
+        end
+
         disque.push(
           queue || self.queue,
           {
@@ -121,7 +134,7 @@ class Disc
             arguments: Array(args)
           }.to_msgpack,
           Disc.disque_timeout,
-          delay: at.nil? ? nil : (at.to_time.to_i - DateTime.now.to_time.to_i)
+          options
         )
       end
     end

data/test/disc_test.rb

@@ -2,6 +2,7 @@ require 'cutest'
 require 'disc'
 require 'msgpack'
 require 'pty'
+require 'timeout'
 
 require_relative '../examples/echoer'
 # class Echoer
@@ -30,10 +31,29 @@ require_relative '../examples/failer'
 # end
 
 prepare do
+  Disc.disque_timeout = 1 # 1ms so we don't wait at all.
   Disc.disque.call('DEBUG', 'FLUSHALL')
 end
 
 scope do
+  # Runs a given command, yielding the stdout (as an IO) and the PID (a String).
+  # Makes sure the process finishes after the block runs.
+  def run(command)
+    out, _, pid = PTY.spawn(command)
+    yield out, pid
+  ensure
+    Process.kill("KILL", pid)
+    sleep 0.1 # Make sure we give it time to finish.
+  end
+
+  # Checks whether a process is running.
+  def is_running?(pid)
+    Process.getpgid(pid)
+    true
+  rescue Errno::ESRCH
+    false
+  end
+
   test 'jobs are enqueued to the correct Disque queue with appropriate parameters and class' do
     jobid = Echoer.enqueue(['one argument', { random: 'data' }, 3])
 
@@ -59,16 +79,16 @@ scope do
   end
 
   test 'enqueue at timestamp behaves properly' do
-    jobid = Echoer.enqueue(['one argument', { random: 'data' }, 3], at: Time.now + 3)
+    jobid = Echoer.enqueue(['one argument', { random: 'data' }, 3], at: Time.now + 1)
 
     jobs = Array(Disc.disque.fetch(from: ['test'], timeout: Disc.disque_timeout, count: 1))
     assert jobs.empty?
 
-    sleep 1
+    sleep 0.5
     jobs = Array(Disc.disque.fetch(from: ['test'], timeout: Disc.disque_timeout, count: 1))
     assert jobs.empty?
 
-    sleep 2
+    sleep 0.5
     jobs = Array(Disc.disque.fetch(from: ['test'], timeout: Disc.disque_timeout, count: 1))
     assert jobs.any?
     assert_equal 1, jobs.size
@@ -85,68 +105,92 @@ scope do
   end
 
   test 'jobs are executed' do
-    begin
-      Echoer.enqueue(['one argument', { random: 'data' }, 3])
-
-      cout, _, pid = PTY.spawn(
-        'QUEUES=test,default ruby -Ilib bin/disc -r ./examples/echoer'
-      )
-      sleep 0.5
+    Echoer.enqueue(['one argument', { random: 'data' }, 3])
 
+    run('QUEUES=test ruby -Ilib bin/disc -r ./examples/echoer') do |cout, pid|
+      output = Timeout.timeout(1) { cout.take(3) }
       jobs = Disc.disque.fetch(from: ['test'], timeout: Disc.disque_timeout, count: 1)
       assert jobs.nil?
-
-      matched = false
-      counter = 0
-      while !matched && counter < 3
-        counter += 1
-        matched = cout.gets.match(/First: one argument, Second: {"random"=>"data"}, Third: 3/)
-      end
-
-      assert matched
-    ensure
-      Process.kill("KILL", pid)
+      assert output.grep(/First: one argument, Second: {"random"=>"data"}, Third: 3/).any?
     end
   end
 
   test 'Disc.on_error will catch unhandled exceptions and keep disc alive' do
-    begin
-      Failer.enqueue('this can only end positively')
-
-      cout, _, pid = PTY.spawn(
-        'QUEUES=test ruby -Ilib bin/disc -r ./examples/failer'
-      )
-      sleep 0.5
+    Failer.enqueue('this can only end positively')
 
+    run('QUEUES=test ruby -Ilib bin/disc -r ./examples/failer') do |cout, pid|
+      output = Timeout.timeout(1) { cout.take(5) }
       jobs = Disc.disque.fetch(from: ['test'], timeout: Disc.disque_timeout, count: 1)
       assert jobs.nil?
 
-      counter = 0
-      tasks = {
-        reported_error: false,
-        printed_message: false,
-        printed_job: false
-      }
-
-      while tasks.values.include?(false) && counter < 5
-        counter += 1
-        output = cout.gets
-
-        tasks[:reported_error] = true   if output.match(/<insert error reporting here>/)
-        tasks[:printed_message] = true  if output.match(/this can only end positively/)
-        tasks[:printed_job] = true      if output.match(/Failer/)
-      end
-
-      assert !tasks.values.include?(false)
-
-      begin
-        Process.getpgid(pid)
-        assert true
-      rescue Errno::ESRCH
-        assert false
-      end
-    ensure
-      Process.kill("KILL", pid)
+      assert output.grep(/<insert error reporting here>/).any?
+      assert output.grep(/this can only end positively/).any?
+      assert output.grep(/Failer/).any?
+
+      assert is_running?(pid)
     end
   end
+
+  test 'enqueue supports replicate' do
+    error = Echoer.enqueue(['one argument', { random: 'data' }, 3], replicate: 100) rescue $!
+
+    assert_equal RuntimeError, error.class
+    assert_equal "NOREPL Not enough reachable nodes for the requested replication level", error.message
+  end
+
+  test 'enqueue supports delay' do
+    jobid = Echoer.enqueue(['one argument', { random: 'data' }, 3], delay: 2)
+
+    jobs = Array(Disc.disque.fetch(from: ['test'], timeout: Disc.disque_timeout, count: 1))
+    assert jobs.empty?
+
+    sleep 1
+    jobs = Array(Disc.disque.fetch(from: ['test'], timeout: Disc.disque_timeout, count: 1))
+    assert jobs.empty?
+
+    sleep 2
+    jobs = Array(Disc.disque.fetch(from: ['test'], timeout: Disc.disque_timeout, count: 1))
+    assert jobs.any?
+    assert_equal 1, jobs.size
+  end
+
+  test 'enqueue supports retry' do
+    jobid = Echoer.enqueue(['one argument', { random: 'data' }, 3], retry: 1)
+
+    jobs = Array(Disc.disque.fetch(from: ['test'], timeout: Disc.disque_timeout, count: 1))
+    assert jobs.any?
+    assert_equal 1, jobs.size
+
+    sleep 1.5
+    jobs = Array(Disc.disque.fetch(from: ['test'], timeout: Disc.disque_timeout, count: 1))
+    assert jobs.any?
+    assert_equal 1, jobs.size
+  end
+
+  test 'enqueue supports ttl' do
+    jobid = Echoer.enqueue(['one argument', { random: 'data' }, 3], ttl: 1)
+
+    sleep 1.5
+    jobs = Array(Disc.disque.fetch(from: ['test'], timeout: Disc.disque_timeout, count: 1))
+    assert jobs.empty?
+  end
+
+  test 'enqueue supports maxlen' do
+    Echoer.enqueue(['one argument', { random: 'data' }, 3], maxlen: 1)
+    # disque off by-one bug? see: https://github.com/antirez/disque/issues/109
+    Echoer.enqueue(['one argument', { random: 'data' }, 3], maxlen: 1)
+    error = Echoer.enqueue(['one argument', { random: 'data' }, 3], maxlen: 1) rescue $!
+
+    assert_equal RuntimeError, error.class
+    assert_equal "MAXLEN Queue is already longer than the specified MAXLEN count", error.message
+  end
+
+  test 'enqueue supports async' do
+    jobid = Echoer.enqueue(['one argument', { random: 'data' }, 3], async: true)
+
+    sleep 1 # async is too fast to reliably assert an empty queue, let's wait instead
+    jobs = Array(Disc.disque.fetch(from: ['test'], timeout: Disc.disque_timeout, count: 1))
+    assert jobs.any?
+    assert_equal 1, jobs.size
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: disc
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.22
 platform: ruby
 authors:
 - pote
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: disque
@@ -63,6 +63,7 @@ files:
 - ".env.sample"
 - ".gems"
 - ".gitignore"
+- ".travis.yml"
 - 13Floor-circulo-1.png
 - CONTRIBUTING.md
 - LICENSE