navvy 0.1.0 → 0.1.1

data/Rakefile

@@ -12,11 +12,9 @@ begin
     gem.authors = ["Jeff Kreeftmeijer"]
     gem.add_development_dependency "rspec",                 ">= 1.2.9"
     gem.add_development_dependency "yard",                  ">= 0.5.2"
-    gem.add_development_dependency "metric_fu",             ">= 1.1.6"
-    gem.add_development_dependency "machinist",             ">= 1.0.6"
     gem.add_development_dependency "mongo_mapper",          ">= 0.6.10"
-    gem.add_development_dependency "machinist_mongomapper", ">= 0.9.7"
     gem.add_development_dependency "sequel",                ">= 3.8.0"
+    gem.add_development_dependency "sqlite3-ruby",          ">= 1.2.5"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
@@ -26,22 +24,26 @@ end
 require 'spec/rake/spectask'
 
 task :spec do
-  ['spec:active_record', 'spec:mongo_mapper', 'spec:sequel'].each do |spec|
+  ['spec:active_record', 'spec:mongo_mapper', 'spec:sequel', 'spec:data_mapper'].each do |spec|
     Rake::Task[spec].invoke
   end
 end
 
 namespace :spec do
   Spec::Rake::SpecTask.new(:active_record) do |spec|
-    spec.spec_files = FileList['spec/job/active_record_spec.rb', 'spec/*_spec.rb']
+    spec.spec_files = FileList['spec/setup/active_record.rb', 'spec/*_spec.rb']
   end
 
   Spec::Rake::SpecTask.new(:mongo_mapper) do |spec|
-    spec.spec_files = FileList['spec/job/mongo_mapper_spec.rb', 'spec/*_spec.rb']
+    spec.spec_files = FileList['spec/setup/mongo_mapper.rb', 'spec/*_spec.rb']
   end
 
   Spec::Rake::SpecTask.new(:sequel) do |spec|
-    spec.spec_files = FileList['spec/job/sequel_spec.rb', 'spec/*_spec.rb']
+    spec.spec_files = FileList['spec/setup/sequel.rb', 'spec/*_spec.rb']
+  end
+
+  Spec::Rake::SpecTask.new(:data_mapper) do |spec|
+    spec.spec_files = FileList['spec/setup/data_mapper.rb', 'spec/*_spec.rb']
   end
 end
 
@@ -62,5 +64,3 @@ rescue LoadError
     abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
   end
 end
-
-require 'metric_fu'

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/navvy/job/active_record.rb

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'active_record'
-require 'yaml'
 
 module Navvy
   class Job < ActiveRecord::Base
@@ -89,7 +88,7 @@ module Navvy
         ) unless keep?
       end
     end
-    
+
     ##
     # Run the job. Will delete the Navvy::Job record and return its return
     # value if it runs successfully unless Navvy::Job.keep is set. If a job
@@ -110,69 +109,69 @@ module Navvy
           result = object.constantize.send(method_name)
         else
           result = object.constantize.send(method_name, *args)
-        end        
+        end
         Navvy::Job.keep? ? completed : destroy
         result
       rescue Exception => exception
         failed(exception.message)
       end
     end
-    
+
     ##
-    # Mark the job as completed. Will set completed_at to the current time and 
+    # Mark the job as completed. Will set completed_at to the current time and
     # optionally add the return value if provided.
     #
     # @param [String] return_value the return value you want to store.
     #
     # @return [true, false] update_attributes the result of the
     # update_attributes call
-    
+
     def completed(return_value = nil)
       update_attributes({
         :completed_at =>  Time.now,
         :return =>        return_value
       })
     end
-    
+
     ##
-    # Mark the job as failed. Will set failed_at to the current time and 
+    # Mark the job as failed. Will set failed_at to the current time and
     # optionally add the exception message if provided.
     #
     # @param [String] exception the exception message you want to store.
     #
     # @return [true, false] update_attributes the result of the
     # update_attributes call
-    
+
     def failed(message = nil)
       update_attributes({
         :failed_at => Time.now,
         :exception => message
       })
     end
-    
+
     ##
-    # Check if the job has been run. 
+    # Check if the job has been run.
     #
     # @return [true, false] ran
-    
+
     def ran?
       completed? || failed?
     end
-    
+
     ##
     # Check how long it took for a job to complete or fail
     #
     # @return [Time, Integer] time the time it took
-    
+
     def duration
       ran? ? (completed_at || failed_at) - started_at : 0
     end
-    
+
     ##
     # Check if completed_at is set
     #
     # @return [true, false] set?
-    
+
     def completed_at?
       !completed_at.nil?
     end
@@ -181,31 +180,20 @@ module Navvy
     # Check if failed_at is set
     #
     # @return [true, false] set?
-    
+
     def failed_at?
       !failed_at.nil?
     end
-    
+
     ##
     # Get the job arguments as an array
     #
     # @return [array] arguments
-    
+
     def args
       arguments.is_a?(Array) ? arguments : YAML.load(arguments)
     end
-    
-    ##
-    # Get the job status
-    #
-    # @return [:pending, :completed, :failed] status
-    
-    def status
-      return :completed if completed?
-      return :failed if failed?
-      :pending
-    end
-    
+
     alias_method :completed?, :completed_at?
     alias_method :failed?,    :failed_at?
   end

data/lib/navvy/job/data_mapper.rb

@@ -0,0 +1,213 @@
+require 'rubygems'
+require 'dm-core'
+
+module Navvy
+  class Job
+    include DataMapper::Resource
+
+    class << self
+      attr_writer :limit
+      attr_accessor :keep
+    end
+
+    property :id,            Serial
+    property :object,        String
+    property :method_name,   String
+    property :arguments,     String
+    property :priority,      Integer, :default => 0
+    property :return,        String
+    property :exception,     String
+    property :created_at,    Time
+    property :run_at,        Time
+    property :started_at,    Time
+    property :completed_at,  Time
+    property :failed_at,     Time
+
+    ##
+    # Default limit of jobs to be fetched
+    #
+    # @return [Integer] limit
+
+    def self.limit
+      @limit || 100
+    end
+
+    ##
+    # Should the job be kept?
+    #
+    # @return [true, false] keep
+
+    def self.keep?
+      keep = (@keep || false)
+      return (Time.now + keep) >= Time.now if keep.is_a? Fixnum
+      keep
+    end
+
+    ##
+    # Add a job to the job queue.
+    #
+    # @param [Object] object the object you want to run a method from
+    # @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]
+
+    def self.enqueue(object, method_name, *args)
+      new_job = self.new
+      new_job.attributes = {
+        :object =>      object.to_s,
+        :method_name => method_name.to_s,
+        :arguments =>   args.to_yaml,
+        :run_at =>      Time.now,
+        :created_at =>  Time.now
+      }
+      new_job.save
+      new_job
+    end
+
+    ##
+    # Find the next available jobs in the queue. This will not include failed
+    # jobs (where :failed_at is not nil) and jobs that should run in the future
+    # (where :run_at is greater than the current time).
+    #
+    # @param [Integer] limit the limit of jobs to be fetched. Defaults to
+    # Navvy::Job.limit
+    #
+    # @return [array, nil] the next available jobs in an array or nil if no
+    # jobs were found.
+
+    def self.next(limit = self.limit)
+      all(
+        :failed_at =>     nil,
+        :completed_at =>  nil,
+        :run_at.lte =>     Time.now,
+        :order =>         [ :priority.desc, :created_at.asc ],
+        :limit =>         limit
+      )
+    end
+
+    ##
+    # Clean up jobs that we don't need to keep anymore. If Navvy::Job.keep is
+    # false it'll delete every completed job, if it's a timestamp it'll only
+    # delete completed jobs that have passed their keeptime.
+    #
+    # @return [true, false] delete_all the result of the delete_all call
+
+    def self.cleanup
+      if keep.is_a? Fixnum
+        all( :completed_at.lte => (Time.now - keep)).destroy
+      else
+        all( :completed_at.not => nil ).destroy unless keep?
+      end
+    end
+
+    ##
+    # Run the job. Will delete the Navvy::Job record and return its return
+    # value if it runs successfully unless Navvy::Job.keep is set. If a job
+    # fails, it'll update the Navvy::Job record to include the exception
+    # message it sent back and set the :failed_at date. Failed jobs never get
+    # deleted.
+    #
+    # @example
+    #   job = Navvy::Job.next # finds the next available job in the queue
+    #   job.run               # runs the job and returns the job's return value
+    #
+    # @return [String] return value of the called method.
+
+    def run
+      begin
+        update(:started_at => Time.now)
+        if args.empty?
+          result = Kernel.const_get(object).send(method_name)
+        else
+          result = Kernel.const_get(object).send(method_name, *args)
+        end
+        Navvy::Job.keep? ? completed : destroy
+        result
+      rescue Exception => exception
+        failed(exception.message)
+      end
+    end
+
+    ##
+    # Mark the job as completed. Will set completed_at to the current time and
+    # optionally add the return value if provided.
+    #
+    # @param [String] return_value the return value you want to store.
+    #
+    # @return [true, false] update_attributes the result of the
+    # update_attributes call
+
+    def completed(return_value = nil)
+      update(
+        :completed_at =>  Time.now,
+        :return =>        return_value
+      )
+    end
+
+    ##
+    # Mark the job as failed. Will set failed_at to the current time and
+    # optionally add the exception message if provided.
+    #
+    # @param [String] exception the exception message you want to store.
+    #
+    # @return [true, false] update_attributes the result of the
+    # update_attributes call
+
+    def failed(message = nil)
+      update(
+        :failed_at => Time.now,
+        :exception => message
+      )
+    end
+
+    ##
+    # Check if the job has been run.
+    #
+    # @return [true, false] ran
+
+    def ran?
+      completed? || failed?
+    end
+
+    ##
+    # Check if completed_at is set
+    #
+    # @return [true, false] set?
+
+    def completed_at?
+      !completed_at.nil?
+    end
+
+    ##
+    # Check if failed_at is set
+    #
+    # @return [true, false] set?
+
+    def failed_at?
+      !failed_at.nil?
+    end
+
+    ##
+    # Check how long it took for a job to complete or fail
+    #
+    # @return [Time, Integer] time the time it took
+
+    def duration
+      ran? ? (completed_at || failed_at) - started_at : 0
+    end
+
+    ##
+    # Get the job arguments as an array
+    #
+    # @return [array] arguments
+
+    def args
+      arguments.is_a?(Array) ? arguments : YAML.load(arguments)
+    end
+
+    alias_method :completed?, :completed_at?
+    alias_method :failed?,    :failed_at?
+  end
+end

data/lib/navvy/job/mongo_mapper.rb

@@ -19,7 +19,7 @@ module Navvy
     key :started_at,    Time
     key :completed_at,  Time
     key :failed_at,     Time
-    
+
     ##
     # Default limit of jobs to be fetched
     #
@@ -44,7 +44,7 @@ module Navvy
     # Add a job to the job queue.
     #
     # @param [Object] object the object you want to run a method from
-    # @param [Symbol, String] method_name the name of the method you want to 
+    # @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
     #
@@ -75,7 +75,7 @@ module Navvy
       all(
         :failed_at =>     nil,
         :completed_at =>  nil,
-        :run_at =>        {'$lte', Time.now},
+        :run_at =>        {'$lte' => Time.now},
         :limit =>         limit,
         :order =>         'created_at'
       )
@@ -127,70 +127,67 @@ module Navvy
         failed(exception.message)
       end
     end
-    
+
     ##
-    # Mark the job as completed. Will set completed_at to the current time and 
+    # Mark the job as completed. Will set completed_at to the current time and
     # optionally add the return value if provided.
     #
     # @param [String] return_value the return value you want to store.
     #
     # @return [true, false] update_attributes the result of the
     # update_attributes call
-    
+
     def completed(return_value = nil)
       update_attributes({
         :completed_at =>  Time.now,
         :return =>        return_value
       })
     end
-    
+
     ##
-    # Mark the job as failed. Will set failed_at to the current time and 
+    # Mark the job as failed. Will set failed_at to the current time and
     # optionally add the exception message if provided.
     #
     # @param [String] exception the exception message you want to store.
     #
     # @return [true, false] update_attributes the result of the
     # update_attributes call
-    
+
     def failed(message = nil)
       update_attributes({
         :failed_at => Time.now,
         :exception => message
       })
     end
-    
+
     ##
-    # Check if the job has been run. 
+    # Check if the job has been run.
     #
     # @return [true, false] ran
-    
+
     def ran?
       completed? || failed?
     end
-    
+
     ##
     # Check how long it took for a job to complete or fail
     #
     # @return [Time, Integer] time the time it took
-    
+
     def duration
       ran? ? (completed_at || failed_at) - started_at : 0
     end
-    
+
     ##
-    # Get the job status
-    #
-    # @return [:pending, :completed, :failed] status
-    
-    def status
-      return :completed if completed?
-      return :failed if failed?
-      :pending
+    # Get the job arguments as an array
+    #
+    # @return [array] arguments
+
+    def args
+      arguments.is_a?(Array) ? arguments : YAML.load(arguments)
     end
-    
+
     alias_method :completed?, :completed_at?
     alias_method :failed?,    :failed_at?
-    alias_method :args,       :arguments
   end
 end

data/lib/navvy/job/sequel.rb

@@ -33,7 +33,7 @@ module Navvy
     # Add a job to the job queue.
     #
     # @param [Object] object the object you want to run a method from
-    # @param [Symbol, String] method_name the name of the method you want to 
+    # @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
     #
@@ -43,7 +43,7 @@ module Navvy
       create(
         :object =>      object.to_s,
         :method_name => method_name.to_s,
-        :arguments =>   YAML::dump(args),
+        :arguments =>   args.to_yaml,
         :run_at =>      Time.now,
         :created_at =>  Time.now
       )
@@ -81,7 +81,7 @@ module Navvy
         filter('`completed_at` IS NOT NULL').delete unless keep?
       end
     end
-    
+
     ##
     # Run the job. Will delete the Navvy::Job record and return its return
     # value if it runs successfully unless Navvy::Job.keep is set. If a job
@@ -105,62 +105,62 @@ module Navvy
         failed(exception.message)
       end
     end
-    
+
     ##
-    # Mark the job as completed. Will set completed_at to the current time and 
+    # Mark the job as completed. Will set completed_at to the current time and
     # optionally add the return value if provided.
     #
     # @param [String] return_value the return value you want to store.
     #
     # @return [true, false] update_attributes the result of the
     # update_attributes call
-    
+
     def completed(return_value = nil)
       update({
         :completed_at =>  Time.now,
         :return =>        return_value
       })
     end
-    
+
     ##
-    # Mark the job as failed. Will set failed_at to the current time and 
+    # Mark the job as failed. Will set failed_at to the current time and
     # optionally add the exception message if provided.
     #
     # @param [String] exception the exception message you want to store.
     #
     # @return [true, false] update_attributes the result of the
     # update_attributes call
-    
+
     def failed(message = nil)
       update({
         :failed_at => Time.now,
         :exception => message
       })
     end
-    
+
     ##
-    # Check if the job has been run. 
+    # Check if the job has been run.
     #
     # @return [true, false] ran
-    
+
     def ran?
       completed? || failed?
     end
-    
+
     ##
     # Check how long it took for a job to complete or fail
     #
     # @return [Time, Integer] time the time it took
-    
+
     def duration
       ran? ? (completed_at || failed_at) - started_at : 0
     end
-    
+
     ##
     # Check if completed_at is set
     #
     # @return [true, false] set?
-    
+
     def completed_at?
       !completed_at.nil?
     end
@@ -169,31 +169,20 @@ module Navvy
     # Check if failed_at is set
     #
     # @return [true, false] set?
-    
+
     def failed_at?
       !failed_at.nil?
     end
-    
+
     ##
     # Get the job arguments as an array
     #
     # @return [array] arguments
-    
+
     def args
-      arguments.first.is_a?(Array) ? arguments : YAML.load(arguments)
-    end
-    
-    ##
-    # Get the job status
-    #
-    # @return [:pending, :completed, :failed] status
-    
-    def status
-      return :completed if completed?
-      return :failed if failed?
-      :pending
+      arguments.is_a?(Array) ? arguments : YAML.load(arguments)
     end
-    
+
     alias_method :completed?, :completed_at?
     alias_method :failed?,    :failed_at?
   end