navvy 0.3.1 → 0.3.2

data/LICENSE

@@ -1,20 +1,3 @@
-Copyright (c) 2009 Jeff Kreeftmeijer
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright 2010 Jeff Kreeftmeijer.
+You may use this work without restrictions, as long as this notice is included.
+The work is provided "as is" without warranty of any kind, neither express nor implied.

data/README.textile

@@ -1,4 +1,4 @@
-h1. Navvy
+h1. Navvy "!http://stillmaintained.com/jeffkreeftmeijer/navvy.png!":http://stillmaintained.com/jeffkreeftmeijer/navvy
 
 Navvy is a simple Ruby background job processor inspired by "delayed_job":http://github.com/tobi/delayed_job, but aiming for database agnosticism. Currently Navvy supports ActiveRecord, MongoMapper, Sequel, DataMapper and Mongoid but it's extremely easy to write an adapter for your favorite ORM.
 
@@ -13,7 +13,3 @@ Check out the "Installation Guide":http://wiki.github.com/jeffkreeftmeijer/navvy
 h2. Contributing
 
 Found an issue? Have a great idea? Want to help? Great! Create an issue "issue":http://github.com/jeffkreeftmeijer/navvy/issues for it, "ask":http://github.com/inbox/new/jeffkreeftmeijer, or even better; fork the project and fix the problem yourself. Pull requests are always welcome. :)
-
-h2. License
-
-Copyright (c) 2009 Jeff Kreeftmeijer, released under the MIT license

data/lib/navvy.rb

@@ -1,6 +1,6 @@
-require File.expand_path(File.dirname(__FILE__) + '/navvy/worker')
-require File.expand_path(File.dirname(__FILE__) + '/navvy/logger')
-require File.expand_path(File.dirname(__FILE__) + '/navvy/configuration')
+require 'navvy/worker'
+require 'navvy/logger'
+require 'navvy/configuration'
 
 module Navvy
   class << self
@@ -19,3 +19,16 @@ module Navvy
     yield(self.configuration)
   end
 end
+
+
+if defined?(Rails)
+
+  module Navvy
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        require 'navvy/tasks.rb'
+      end
+    end
+  end
+
+end

data/lib/navvy/job.rb

@@ -64,8 +64,8 @@ module Navvy
     def run
       begin
         started
-        result = constantize(object).send(method_name, *args)
-        Navvy::Job.keep? ? completed : destroy
+        result = constantize(object).send(method_name, *args).inspect
+        Navvy::Job.keep? ? completed(result) : destroy
         result
       rescue Exception => exception
         failed(exception.message)
@@ -153,21 +153,21 @@ module Navvy
     alias_method :completed?, :completed_at?
     alias_method :failed?,    :failed_at?
 
-	private
-
-		##
-		# Turn a constant with potential namespacing into an object
-		#
-		# @return [Class] class
-
-		def constantize(str)
-			names = str.split('::')
-			names.shift if names.empty? || names.first.empty?
-			constant = Object
-			names.each do |name|
-				constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
-			end
-			constant
-		end
+  private
+
+    ##
+    # Turn a constant with potential namespacing into an object
+    #
+    # @return [Class] class
+
+    def constantize(str)
+      names = str.split('::')
+      names.shift if names.empty? || names.first.empty?
+      constant = Object
+      names.each do |name|
+        constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+      end
+      constant
+    end
   end
-end
+end

data/lib/navvy/job/active_record.rb

@@ -10,7 +10,7 @@ module Navvy
     # @param [Symbol, String] method_name the name of the method you want to run
     # @param [*] arguments optional arguments you want to pass to the method
     #
-    # @return [true, false]
+    # @return [Job, false] created Job or false if failed
 
     def self.enqueue(object, method_name, *args)
       options = {}
@@ -22,7 +22,7 @@ module Navvy
       create(
         :object =>      object.to_s,
         :method_name => method_name.to_s,
-        :arguments =>   args,
+        :arguments =>   args.to_yaml,
         :priority =>    options[:priority] || 0,
         :parent_id =>   options[:parent_id],
         :run_at =>      options[:run_at] || Time.now,
@@ -133,4 +133,4 @@ module Navvy
   end
 end
 
-require File.expand_path(File.dirname(__FILE__) + '/../job')
+require 'navvy/job'

data/lib/navvy/job/data_mapper.rb

@@ -1,4 +1,5 @@
 require 'dm-core'
+require 'dm-migrations'
 
 module Navvy
   class Job
@@ -26,7 +27,7 @@ module Navvy
     # run
     # @param [*] arguments optional arguments you want to pass to the method
     #
-    # @return [true, false]
+    # @return [Job, false] created Job or false if failed
 
     def self.enqueue(object, method_name, *args)
       options = {}
@@ -35,8 +36,7 @@ module Navvy
         args.pop if args.last.empty?
       end
 
-      new_job = self.new
-      new_job.attributes = {
+      new_job = Job.create(
         :object =>      object.to_s,
         :method_name => method_name.to_s,
         :arguments =>   args.to_yaml,
@@ -44,9 +44,7 @@ module Navvy
         :parent_id =>   options[:parent_id],
         :run_at =>      options[:run_at] || Time.now,
         :created_at =>  Time.now
-      }
-      new_job.save
-      new_job
+      )
     end
 
     ##
@@ -91,7 +89,7 @@ module Navvy
     # @return [true, false] deleted?
 
     def self.delete_all
-      Navvy::Job.all.destroy
+      Navvy::Job.destroy
     end
 
     ##
@@ -101,9 +99,7 @@ module Navvy
     # update_attributes call
 
     def started
-      update({
-        :started_at =>  Time.now
-      })
+      update(:started_at =>  Time.now)
     end
 
     ##
@@ -149,11 +145,10 @@ module Navvy
 
     def times_failed
       i = parent_id || id
-      self.class.all(
-        :conditions => ["(`id` = ? OR `parent_id` = ?) AND `failed_at` IS NOT NULL", i, i]
-      ).count
+      klass = self.class
+      (klass.all(:failed_at.not => nil) & (klass.all(:id => i) | klass.all(:parent_id => i))).count
     end
   end
 end
 
-require File.expand_path(File.dirname(__FILE__) + '/../job')
+require 'navvy/job'

data/lib/navvy/job/mongo_mapper.rb

@@ -25,7 +25,7 @@ module Navvy
     # run
     # @param [*] arguments optional arguments you want to pass to the method
     #
-    # @return [true, false]
+    # @return [Job, false] created Job or false if failed
 
     def self.enqueue(object, method_name, *args)
       options = {}
@@ -147,4 +147,4 @@ module Navvy
   end
 end
 
-require File.expand_path(File.dirname(__FILE__) + '/../job')
+require 'navvy/job'

data/lib/navvy/job/mongoid.rb

@@ -11,7 +11,7 @@ module Navvy
     field :priority,      :type => Integer, :default => 0
     field :return,        :type => String
     field :exception,     :type => String
-    field :parent_id,     :type => String
+    field :parent_id,     :type => BSON::ObjectId
     field :created_at,    :type => Time
     field :run_at,        :type => Time
     field :started_at,    :type => Time
@@ -29,7 +29,7 @@ module Navvy
     # run
     # @param [*] arguments optional arguments you want to pass to the method
     #
-    # @return [true, false]
+    # @return [Job, false] created Job or false if failed
 
     def self.enqueue(object, method_name, *args)
       options = {}
@@ -136,4 +136,4 @@ module Navvy
   end
 end
 
-require File.expand_path(File.dirname(__FILE__) + '/../job')
+require 'navvy/job'

data/lib/navvy/job/sequel.rb

@@ -12,7 +12,7 @@ module Navvy
     # run
     # @param [*] arguments optional arguments you want to pass to the method
     #
-    # @return [true, false]
+    # @return [Job, false] created Job or false if failed
 
     def self.enqueue(object, method_name, *args)
       options = {}
@@ -21,7 +21,7 @@ module Navvy
         args.pop if args.last.empty?
       end
 
-      insert(
+      Job[insert(
         :object =>      object.to_s,
         :method_name => method_name.to_s,
         :arguments =>   args.to_yaml,
@@ -29,8 +29,7 @@ module Navvy
         :parent_id =>   options[:parent_id],
         :run_at =>      options[:run_at] || Time.now,
         :created_at =>  Time.now
-      )
-      order(:id.desc).first
+      )]
     end
 
     ##
@@ -45,11 +44,11 @@ module Navvy
     # jobs were found.
 
     def self.next(limit = self.limit)
-      filter(
-            (:run_at <= Time.now),
-            {:failed_at    => nil,
-             :completed_at => nil}
-      ).order(:priority.desc, :created_at).first(limit)
+      filter(:failed_at => nil).
+        filter(:completed_at => nil).
+        filter{run_at <= Time.now}.
+        order(:priority.desc, :created_at).
+        first(limit)
     end
 
     ##
@@ -61,7 +60,8 @@ module Navvy
 
     def self.cleanup
       if keep.is_a? Fixnum
-        filter(:completed_at <= (Time.now - keep)).delete
+        time = Time.now - keep
+        filter{completed_at <= time}.delete
       else
         filter(~{:completed_at => nil}).delete unless keep?
       end
@@ -76,7 +76,6 @@ module Navvy
       Navvy::Job.destroy
     end
 
-
     ##
     # Mark the job as started. Will set started_at to the current time.
     #
@@ -84,9 +83,7 @@ module Navvy
     # update_attributes call
 
     def started
-      update({
-        :started_at =>  Time.now
-      })
+      update(:started_at =>  Time.now)
     end
 
     ##
@@ -99,10 +96,10 @@ module Navvy
     # update_attributes call
 
     def completed(return_value = nil)
-      update({
+      update(
         :completed_at =>  Time.now,
         :return =>        return_value
-      })
+      )
     end
 
     ##
@@ -131,11 +128,11 @@ module Navvy
 
     def times_failed
       i = parent_id || id
-      self.class.filter(
-        ({:id => i} | {:parent_id => i}), ~{:failed_at => nil}
-      ).count
+      self.class.filter({:id => i} | {:parent_id => i}).
+        filter(~{:failed_at => nil}).
+        count
     end
   end
 end
 
-require File.expand_path(File.dirname(__FILE__) + '/../job')
+require 'navvy/job'

data/lib/navvy/tasks.rb

@@ -10,4 +10,7 @@ namespace :navvy do
   task :work => :environment do
     Navvy::Worker.start
   end
-end
+end
+
+# heroku background jobs use jobs:work
+task 'jobs:work' => 'navvy:work'

data/spec/configuration_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe Navvy::Configuration do
   after do

data/spec/job_spec.rb

@@ -1,6 +1,14 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe 'Navvy::Job' do
+  before do
+    Timecop.freeze(Time.local(2010, 1, 1))
+  end
+
+  after do
+    Timecop.return
+  end
+
   describe '.keep?' do
     after(:each) do
       Navvy::Job.keep = false
@@ -70,17 +78,14 @@ describe 'Navvy::Job' do
     it 'should set the created_at date' do
       Navvy::Job.enqueue(Cow, :speak, true, false)
       job = first_job
-      job.created_at.should be_instance_of Time
-      job.created_at.should <= Time.now
-      job.created_at.should > Time.now - 10
+      job.created_at.should == Time.now
     end
 
     it 'should set the run_at date' do
       Navvy::Job.enqueue(Cow, :speak, true, false)
       job = first_job
-      job.run_at.should be_instance_of Time
-      job.run_at.should <= Time.now
-      job.created_at.should > Time.now - 10
+      job.run_at.should == Time.now
+      job.created_at.should == Time.now
     end
 
     it 'should return the enqueued job' do
@@ -201,27 +206,34 @@ describe 'Navvy::Job' do
 
       it 'should run the job and delete it' do
         jobs = Navvy::Job.next
-        jobs.first.run.should == 'moo'
+        jobs.first.run.should == '"moo"'
         job_count.should == 0
       end
 
       describe 'when Navvy::Job.keep is set' do
+        it 'should call #completed with the return value after processing the job' do
+          Navvy::Job.keep = true
+          jobs = Navvy::Job.next
+          jobs.first.should_receive(:completed).with('"moo"')
+          jobs.first.run
+        end
+
         it 'should mark the job as complete when keep is true' do
           Navvy::Job.keep = true
           jobs = Navvy::Job.next
           jobs.first.run
           job_count.should == 1
-          jobs.first.started_at.should be_instance_of Time
-          jobs.first.completed_at.should be_instance_of Time
+          jobs.first.started_at.should == Time.now
+          jobs.first.completed_at.should == Time.now
         end
 
-        it 'should mark the job as complete when keep has not passed yer' do
+        it 'should mark the job as complete when keep has not passed yet' do
           Navvy::Job.keep = (60 * 60)
           jobs = Navvy::Job.next
           jobs.first.run
           job_count.should == 1
-          jobs.first.started_at.should be_instance_of Time
-          jobs.first.completed_at.should be_instance_of Time
+          jobs.first.started_at.should == Time.now
+          jobs.first.completed_at.should == Time.now
         end
 
         it 'should delete the job when the "keep" flag has passed' do
@@ -243,8 +255,8 @@ describe 'Navvy::Job' do
         jobs = Navvy::Job.next
         jobs.first.run
         jobs.first.exception.should == 'this method is broken'
-        jobs.first.started_at.should be_instance_of Time
-        jobs.first.failed_at.should be_instance_of Time
+        jobs.first.started_at.should == Time.now
+        jobs.first.failed_at.should == Time.now
       end
     end
   end
@@ -358,25 +370,22 @@ describe 'Navvy::Job' do
     it 'should set the run_at date to about 16 seconds from now' do
       failed_job = Navvy::Job.enqueue(Cow, :speak, 'name' => 'Betsy')
       failed_job.stub!(:times_failed).and_return 2
-      now = Time.now
       job = failed_job.retry
-      job.run_at.to_i.should == (now + 16).to_i
+      job.run_at.to_i.should == (Time.now + 16).to_i
     end
 
     it 'should set the run_at date to about 256 seconds from now' do
       failed_job = Navvy::Job.enqueue(Cow, :speak, 'name' => 'Betsy')
       failed_job.stub!(:times_failed).and_return 4
-      now = Time.now
       job = failed_job.retry
-      job.run_at.to_i.should == (now + 256).to_i
+      job.run_at.to_i.should == (Time.now + 256).to_i
     end
 
     it 'should set the run_at date to about 4096 seconds from now' do
       failed_job = Navvy::Job.enqueue(Cow, :speak, 'name' => 'Betsy')
       failed_job.stub!(:times_failed).and_return 8
-      now = Time.now
       job = failed_job.retry
-      job.run_at.to_i.should == (now + 4096).to_i
+      job.run_at.to_i.should == (Time.now + 4096).to_i
     end
 
     it 'should set the parent_id to the master job id' do
@@ -458,7 +467,7 @@ describe 'Navvy::Job' do
         :completed_at =>  Time.now
       )
 
-      job.duration.should >= 2
+      job.duration.should == 2
     end
 
     it 'should return a duration if started_at and failed_at are set' do
@@ -467,7 +476,7 @@ describe 'Navvy::Job' do
         :failed_at =>   Time.now
       )
 
-      job.duration.should >= 3
+      job.duration.should == 3
     end
 
     it 'should return 0 if only started_at is set' do
@@ -488,9 +497,9 @@ describe 'Navvy::Job' do
   end
 
   describe '#namespaced' do
-		it 'should accept a namespaced class name' do
+    it 'should accept a namespaced class name' do
       job = Navvy::Job.enqueue(Animals::Cow, :speak)
-      job.run.should == 'moo'
+      job.run.should == '"moo"'
     end
   end
 end

data/spec/logger_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe Navvy::Logger do
   describe '#colorized_info' do

data/spec/setup/active_record.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../lib/navvy/job/active_record')
+require 'navvy/job/active_record'
 
 ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => '/tmp/navvy_test.sqlite')
 

data/spec/setup/data_mapper.rb

@@ -1,3 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../lib/navvy/job/data_mapper')
+require 'navvy/job/data_mapper'
 DataMapper.setup(:default, "sqlite3:///tmp/navvy_test.sqlite")
+DataMapper.finalize
 Navvy::Job.auto_migrate!

data/spec/setup/mongo_mapper.rb

@@ -1,2 +1,2 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../lib/navvy/job/mongo_mapper')
+require 'navvy/job/mongo_mapper'
 MongoMapper.database = 'navvy_test'

data/spec/setup/mongoid.rb

@@ -6,4 +6,4 @@ Mongoid.configure do |config|
   config.master = Mongo::Connection.new.db(name)
 end
 
-require File.expand_path(File.dirname(__FILE__) + '/../../lib/navvy/job/mongoid')
+require 'navvy/job/mongoid'

data/spec/setup/sequel.rb

@@ -18,4 +18,4 @@ Sequel::DATABASES[0].create_table!(:jobs) do
   DateTime  :failed_at
 end
 
-require File.expand_path(File.dirname(__FILE__) + '/../../lib/navvy/job/sequel')
+require 'navvy/job/sequel'

data/spec/spec_helper.rb

@@ -1,11 +1,8 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'navvy'
-require 'spec'
-require 'spec/autorun'
-
-Spec::Runner.configure do |config|
-end
+require 'rspec'
+require 'timecop'
 
 def job_count
   if defined? Navvy::Job.count
@@ -30,13 +27,13 @@ class Cow
 end
 
 module Animals
-	class Cow
-		def self.speak
-			'moo'
-		end
+  class Cow
+    def self.speak
+      'moo'
+    end
 
-		def self.broken
-			raise 'this method is broken'
-		end
-	end
+    def self.broken
+      raise 'this method is broken'
+    end
+  end
 end

data/spec/worker_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe Navvy::Worker do
   describe '.fetch_and_run_jobs' do

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: navvy
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Jeff Kreeftmeijer
@@ -14,37 +15,113 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-09 00:00:00 +02:00
+date: 2011-01-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: rake
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
-        - 1
-        - 2
-        - 9
-        version: 1.2.9
+        - 0
+        version: "0"
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: yard
+  name: sqlite3-ruby
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 0
         - 5
         - 2
         version: 0.5.2
   type: :development
-  version_requirements: *id002
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 3
+        - 5
+        version: 0.3.5
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: fuubar
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 0
+        version: "0.0"
+  type: :development
+  version_requirements: *id007
 description: Simple background job processor inspired by delayed_job, but aiming for database agnosticism.
 email: jeff@kreeftmeijer.nl
 executables: []
@@ -91,23 +168,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Simple background job processor inspired by delayed_job, but aiming for database agnosticism.