deferrer 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MWYxNDY1MDIxNTJkNTJiMmFkYWQyMWFmZWQ5Y2ZkZjMwMmE1MTkwZQ==
-  data.tar.gz: !binary |-
-    MjE0OWFiYjA1NjlkMmE0NjgwMzViMDY4ZjVmYTdhODQzNzdjYjJmMg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NjMzNmU0ZmVjOWRiYWVhODY1YzU4MmY5OTRmNzNhYTdiNTMwMmUzMTdlOTE3
-    NWIxNjI4MGI1ODkxNDVhODFhYjJjMDkyMzNlYTg1MDVkODU2NzY1YTMyMzEx
-    NGUxNzNjMjY5MWRjZDBhNDMwYzQ2YjZhMjkzN2EwMTg1ZDNmZjc=
-  data.tar.gz: !binary |-
-    YWEzOTI3NWVjNjk3OTVjMDdjOGM4NGU1ZTA2ZDFmOWE3OGE2NDM0NTJiZjkx
-    YTY5Y2Q1NmUzOTgzNjE0ZjZjNjY3YjYzZDlmNDAxNWJjY2Y2ZjZlNmM1Zjdm
-    NGNjM2E5ZmU5NTEwY2NjZGE3YjE3NzliNDI5YjBjZjZmYTNlN2Y=
+SHA1:
+  metadata.gz: 3177ff9473fe3ddecdc6579a2adcde3fa02112f5
+  data.tar.gz: de0bbbd3540ec14e50061ed917d633dd27be62d1
+SHA512:
+  metadata.gz: 5db8302690c0707b3d0ce6ae0ef03c87e26be05024565bd579121deb222cc4987788fd832d7366842a1d56e32acaea1abfc9702fef965c5c513e05427522f04c
+  data.tar.gz: f3cd63d60f6d37c4275781fb58a0ace53dcb730b5af152744de7059000ec4d2f4b9fc84785e5bbe45efc05d51ace50bf893a84938b18b8ddee1d1ee99f8620a2

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+.ruby-*
 .bundle
 .config
 .yardoc

data/.travis.yml

@@ -0,0 +1,10 @@
+rvm:
+  - 2.1.0
+cache:
+  - bundler
+notifications:
+  email:
+    - dalibor.nasevic@gmail.com
+services:
+  - redis-server
+script: bundle exec rspec spec

data/README.md

@@ -1,9 +1,10 @@
+![Travis status](https://travis-ci.org/madmimi/deferrer.png)
+
 # Deferrer
 
 Defer executions and run only the last update at the scheduled time
 
 
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -38,7 +39,14 @@ Define deferrer class (must have perform class method)
 
 Start a worker process. It needs to have redis configured and access to deferrer classes.
 
-    Deferrer.run
+    Deferrer.run(options = {})
+
+    # Following `options` are available:
+    #   loop_frequency - sleep between loops, default to 0.1 seconds
+    #   logger         - logging mechanism, needs to respond to `info` and `error`
+    #   before_each    - callback to run before processing an item, needs to respond to `call`
+    #   after_each     - callback to run after processing an item, needs to respond to `call`
+    #   single_run     - process items only for a single loop, useful for testing
 
 
 Defer some executions

data/deferrer.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "multi_json"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
 end

data/lib/deferrer/deferral.rb

@@ -4,23 +4,18 @@ module Deferrer
     LIST_KEY = :deferred_list
 
     def run(options = {})
-      loop_frequency = options[:loop_frequency] || 0.1
-      logger = options[:logger] || nil
+      loop_frequency = options.fetch(:loop_frequency, 0.1)
+      logger         = options.fetch(:logger, nil)
+      before_each    = options.fetch(:before_each, nil)
+      after_each     = options.fetch(:after_each, nil)
+      single_run     = options.fetch(:single_run, false)
 
       loop do
         while item = next_item
-          begin
-            klass = constantize(item['class'])
-            args  = item['args']
-
-            logger.info("Executing: #{item['key']}") if logger
-
-            klass.send(:perform, *args)
-          rescue Exception => e
-            logger.error("Error: #{e.class}: #{e.detail}") if logger
-          end
+          process_item(item, logger, before_each, after_each)
         end
 
+        break if single_run
         sleep loop_frequency
       end
     end
@@ -33,9 +28,11 @@ module Deferrer
       key = redis.zrangebyscore(LIST_KEY, '-inf', score, :limit => [0, 1]).first
 
       if key
-        _, item = redis.brpop(key, 0)
-        decoded_item = decode(item) if item
-        decoded_item['key'] = key
+        item = redis.rpop(key)
+        if item
+          decoded_item = decode(item)
+          decoded_item['key'] = key
+        end
 
         remove(key)
       end
@@ -70,6 +67,19 @@ module Deferrer
     end
 
     private
+    def process_item(item, logger, before_each, after_each)
+      before_each.call if before_each
+      klass = constantize(item['class'])
+      args  = item['args']
+
+      logger.info("Executing: #{item['key']}") if logger
+
+      klass.send(:perform, *args)
+      after_each.call if after_each
+    rescue Exception => e
+      logger.error("Error: #{e.class}: #{e.message}") if logger
+    end
+
     def build_item(klass, args)
       {'class' => klass.to_s, 'args' => args}
     end

data/lib/deferrer/version.rb

@@ -1,3 +1,3 @@
 module Deferrer
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/deferrer/deferral_spec.rb

@@ -1,8 +1,24 @@
 require 'spec_helper'
+require 'timeout'
 
 class CarDeferrer
   def self.perform(car)
-    car.upcase
+  end
+
+  def self.callback
+  end
+end
+
+class Logger
+  def self.info(message)
+  end
+
+  def self.error(message)
+  end
+end
+
+class InvalidLogger
+  def self.error(message)
   end
 end
 
@@ -14,7 +30,39 @@ describe Deferrer::Deferral do
   let(:list_key) { Deferrer::Deferral::LIST_KEY }
 
   before :each do
-    redis.flushall
+    redis.flushdb
+  end
+
+  describe "run" do
+    it "processes jobs" do
+      CarDeferrer.should_receive(:perform).with(car)
+      Deferrer.defer_in(-1, identifier, CarDeferrer, car)
+      Deferrer.run(single_run: true)
+    end
+
+    it "logs info messages if logger provided" do
+      Logger.should_receive(:info).with("Executing: deferred:#{identifier}")
+      Deferrer.defer_in(-1, identifier, CarDeferrer, car)
+      Deferrer.run(single_run: true, logger: Logger)
+    end
+
+    it "logs error messages if logger provided" do
+      InvalidLogger.should_receive(:error).with("Error: NoMethodError: undefined method `info' for InvalidLogger:Class")
+      Deferrer.defer_in(-1, identifier, CarDeferrer, car)
+      Deferrer.run(single_run: true, logger: InvalidLogger)
+    end
+
+    it "runs before callback" do
+      CarDeferrer.should_receive(:callback)
+      Deferrer.defer_in(-1, identifier, CarDeferrer, car)
+      Deferrer.run(single_run: true, before_each: Proc.new { CarDeferrer.callback })
+    end
+
+    it "runs after callback" do
+      CarDeferrer.should_receive(:callback)
+      Deferrer.defer_in(-1, identifier, CarDeferrer, car)
+      Deferrer.run(single_run: true, after_each: Proc.new { CarDeferrer.callback })
+    end
   end
 
   describe ".defer_at" do
@@ -25,7 +73,7 @@ describe Deferrer::Deferral do
       redis.exists(Deferrer.item_key(identifier)).should be_true
     end
 
-    it "deferrs in given interval" do
+    it "defers in given interval" do
       Deferrer.defer_in(1, identifier, CarDeferrer, car)
 
       redis.zrangebyscore(list_key, '-inf', (Time.now + 1).to_f, :limit => [0, 1]).first.should_not be_nil
@@ -73,5 +121,13 @@ describe Deferrer::Deferral do
       redis.exists(Deferrer.item_key(identifier)).should be_false
       Deferrer.next_item.should be_nil
     end
+
+    it "doesn't block on empty lists" do
+      Deferrer.defer_in(-1, identifier, CarDeferrer, car)
+      redis.del Deferrer.item_key(identifier)
+
+      Timeout::timeout(2) { Deferrer.next_item.should be_nil }
+      redis.zrangebyscore(list_key, '-inf', 'inf', :limit => [0, 1]).first.should be_nil
+    end
   end
 end

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: deferrer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dalibor Nasevic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-03 00:00:00.000000000 Z
+date: 2014-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
 description: Defer executions and run only the last update
 email:
 - dalibor.nasevic@gmail.com
@@ -73,8 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -101,20 +116,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Defer executions and run only the last update at the scheduled time
 test_files:
 - spec/deferrer/deferral_spec.rb
 - spec/spec_helper.rb
+has_rdoc: