navvy 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,8 @@
+*.sw?
+.DS_Store
+.yardoc
+coverage
+rdoc
+doc
+pkg
+tmp

data/LICENSE

@@ -0,0 +1,20 @@
+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.

data/README.textile

@@ -0,0 +1,9 @@
+h1. Navvy
+
+Navvy is a simple background job processor inspired by "delayed_job":http://github.com/tobi/delayed_job, but aiming for database agnosticism. 
+
+??“Navvy is a shorter form of navigator (UK) or navigational engineer (USA) and is particularly applied to describe the manual labourers working on major civil engineering projects. The term was coined in the late 18th century in Britain when numerous canals were being built, which were also sometimes known as "navigations". Canal navvies typically worked with shovels, pickaxes and barrows.”?? - "Wikipedia":http://en.wikipedia.org/wiki/Navvy
+
+h2. License
+
+Copyright (c) 2009 Jeff Kreeftmeijer, released under the MIT license

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "navvy"
+    gem.summary = %Q{Simple background job processor inspired by delayed_job, but aiming for database agnosticism.}
+    gem.description = %Q{Simple background job processor inspired by delayed_job, but aiming for database agnosticism.}
+    gem.email = "jeff@kreeftmeijer.nl"
+    gem.homepage = "http://github.com/jeffkreeftmeijer/navvy"
+    gem.authors = ["Jeff Kreeftmeijer"]
+    gem.add_dependency             "mongo_mapper",          ">= 0.6.10"
+    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 "machinist_mongomapper", ">= 0.9.7"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+
+require 'metric_fu'

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/job/mongo_mapper.rb

@@ -0,0 +1,74 @@
+require 'rubygems'
+require 'mongo_mapper'
+
+module Navvy
+  class Job
+    include MongoMapper::Document
+
+    key :object,    String
+    key :method,    Symbol
+    key :arguments, Array
+    key :exception, String
+    key :run_at,    Time
+    key :failed_at, Time
+
+    ##
+    # Add a job to the job queue.
+    #
+    # @param [Object] object the object you want to run a method from
+    # @param [Symbol, String] method 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, *args)
+      create(
+        :object =>    object.name,
+        :method =>    method.to_sym,
+        :run_at =>    Time.now,
+        :arguments => args
+      )
+    end
+
+    ##
+    # Find the next available job 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).
+    # 
+    #
+    # @return [Navvy::Job, nil] the next available job or nil if no jobs
+    # were found
+
+    def self.next
+      first(
+        :failed_at => nil,
+        :run_at => {'$lte', Time.now}
+      )
+    end
+
+    ##
+    # Run the job. Will delete the Navvy::Job record and return its return
+    # value if it runs successfully. 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 don't 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
+        result = object.constantize.send(method)
+        destroy
+        result
+      rescue Exception => exception
+        update_attributes({
+          :exception => exception.message,
+          :failed_at => Time.now
+        })
+      end
+    end
+  end
+end

data/lib/navvy.rb

@@ -0,0 +1,2 @@
+require File.expand_path(File.dirname(__FILE__) + '/navvy/job')
+require File.expand_path(File.dirname(__FILE__) + '/navvy/worker')

data/lib/navvy/job.rb

@@ -0,0 +1,16 @@
+module Navvy
+  class Job
+    class << self
+      attr_accessor :limit
+    end
+    
+    ##
+    # Default limit of jobs to be fetched
+    #
+    # @return [Integer] limit
+    
+    def self.limit
+      10
+    end
+  end
+end

data/lib/navvy/job/mongo_mapper.rb

@@ -0,0 +1,77 @@
+require 'rubygems'
+require 'mongo_mapper'
+
+module Navvy
+  class Job
+    include MongoMapper::Document
+
+    key :object,    String
+    key :method,    Symbol
+    key :arguments, Array
+    key :exception, String
+    key :run_at,    Time
+    key :failed_at, Time
+
+    ##
+    # Add a job to the job queue.
+    #
+    # @param [Object] object the object you want to run a method from
+    # @param [Symbol, String] method 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, *args)
+      create(
+        :object =>    object.name,
+        :method =>    method.to_sym,
+        :run_at =>    Time.now,
+        :arguments => args
+      )
+    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
+    # jobsn were found.
+
+    def self.next(limit = self.limit)
+      all(
+        :failed_at => nil,
+        :run_at => {'$lte', Time.now},
+        :limit => limit
+      )
+    end
+
+    ##
+    # Run the job. Will delete the Navvy::Job record and return its return
+    # value if it runs successfully. 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 don't 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
+        result = object.constantize.send(method)
+        destroy
+        result
+      rescue Exception => exception
+        update_attributes({
+          :exception => exception.message,
+          :failed_at => Time.now
+        })
+      end
+    end
+  end
+end

data/lib/navvy/worker.rb

@@ -0,0 +1,23 @@
+module Navvy
+  class Worker
+    
+    ##
+    # Start the worker.
+    
+    def self.start
+      loop do
+        fetch_and_run_jobs
+        sleep 5
+      end
+    end
+    
+    ##
+    # Fetch jobs an run them.
+    
+    def self.fetch_and_run_jobs
+      Job.next.each do |job|
+        job.run
+      end
+    end
+  end
+end

data/navvy.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{navvy}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeff Kreeftmeijer"]
+  s.date = %q{2010-01-11}
+  s.description = %q{Simple background job processor inspired by delayed_job, but aiming for database agnosticism.}
+  s.email = %q{jeff@kreeftmeijer.nl}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "lib/job/mongo_mapper.rb",
+     "lib/navvy.rb",
+     "lib/navvy/job.rb",
+     "lib/navvy/job/mongo_mapper.rb",
+     "lib/navvy/worker.rb",
+     "navvy.gemspec",
+     "spec/job/mongo_mapper_spec.rb",
+     "spec/setup/mongo_mapper.rb",
+     "spec/spec_helper.rb",
+     "spec/worker_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/jeffkreeftmeijer/navvy}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Simple background job processor inspired by delayed_job, but aiming for database agnosticism.}
+  s.test_files = [
+    "spec/job/mongo_mapper_spec.rb",
+     "spec/setup/mongo_mapper.rb",
+     "spec/spec_helper.rb",
+     "spec/worker_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mongo_mapper>, [">= 0.6.10"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0.5.2"])
+      s.add_development_dependency(%q<metric_fu>, [">= 1.1.6"])
+      s.add_development_dependency(%q<machinist>, [">= 1.0.6"])
+      s.add_development_dependency(%q<machinist_mongomapper>, [">= 0.9.7"])
+    else
+      s.add_dependency(%q<mongo_mapper>, [">= 0.6.10"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0.5.2"])
+      s.add_dependency(%q<metric_fu>, [">= 1.1.6"])
+      s.add_dependency(%q<machinist>, [">= 1.0.6"])
+      s.add_dependency(%q<machinist_mongomapper>, [">= 0.9.7"])
+    end
+  else
+    s.add_dependency(%q<mongo_mapper>, [">= 0.6.10"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0.5.2"])
+    s.add_dependency(%q<metric_fu>, [">= 1.1.6"])
+    s.add_dependency(%q<machinist>, [">= 1.0.6"])
+    s.add_dependency(%q<machinist_mongomapper>, [">= 0.9.7"])
+  end
+end

data/spec/job/mongo_mapper_spec.rb

@@ -0,0 +1,111 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe 'Navvy::Job' do
+  before do
+    require File.expand_path(File.dirname(__FILE__) + '/../setup/mongo_mapper')
+  end
+    
+  describe '.enqueue' do
+    before(:each) do
+      Navvy::Job.delete_all
+    end
+
+    it 'should enqueue a job' do
+      Navvy::Job.enqueue(Cow, :speak)
+      Navvy::Job.count.should == 1
+    end
+
+    it 'should set the object and the method' do
+      Navvy::Job.enqueue(Cow, :speak)
+      job = Navvy::Job.first
+      job.object.should == 'Cow'
+      job.method.should == :speak
+    end
+
+    it 'should turn the method into a symbol' do
+      Navvy::Job.enqueue(Cow, 'speak')
+      job = Navvy::Job.first
+      job.method.should == :speak
+    end
+
+    it 'should set the arguments' do
+      Navvy::Job.enqueue(Cow, :speak, true, false)
+      job = Navvy::Job.first
+      job.arguments.should == [true, false]
+    end
+
+    it 'should set the run_at date' do
+      Navvy::Job.enqueue(Cow, :speak, true, false)
+      job = Navvy::Job.first
+      job.run_at.should be_instance_of Time
+      job.run_at.should <= Time.now
+    end
+  end
+
+  describe '.next' do
+    before(:each) do
+      Navvy::Job.delete_all
+      Navvy::Job.create(
+        :object =>    'Cow',
+        :method =>    :break,
+        :failed_at => Time.now
+      )
+      Navvy::Job.create(
+        :object =>  'Cow',
+        :method =>  :tomorrow,
+        :run_at =>  Time.now + 1.day
+      )
+      12.times do 
+        Navvy::Job.enqueue(Cow, :speak)
+      end
+    end
+
+    it 'should find the next 10 available jobs' do
+      jobs = Navvy::Job.next
+      jobs.count.should == 10
+      jobs.each do |job|
+        job.should be_instance_of Navvy::Job
+        job.method.should == :speak
+      end
+    end
+    
+    it 'should find the next 2 available jobs' do
+      Navvy::Job.next(2).count.should == 2
+    end
+    
+    it 'should find the next 4 available jobs' do
+      Navvy::Job.limit = 4
+      Navvy::Job.next
+    end
+  end
+
+  describe '#run' do
+    describe 'when everything goes well' do
+      before(:each) do
+        Navvy::Job.delete_all
+        Navvy::Job.enqueue(Cow, :speak)
+      end
+
+      it 'should run the job and delete it' do
+        jobs = Navvy::Job.next
+        jobs.first.run.should == 'moo'
+        Navvy::Job.count.should == 0
+      end
+    end
+
+    describe 'when a job fails' do
+      before(:each) do
+        Navvy::Job.delete_all
+        Navvy::Job.enqueue(Cow, :broken)
+      end
+
+      it 'should store the exception and current time' do
+        jobs = Navvy::Job.next
+        jobs.first.run
+        Navvy::Job.count.should == 1
+        jobs.first.exception.should == 'this method is broken'
+        jobs.first.failed_at.should be_instance_of Time
+      end
+    end
+  end
+end

data/spec/setup/mongo_mapper.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$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
+
+class Cow
+  def self.speak
+    'moo'
+  end
+
+  def self.broken
+    raise 'this method is broken'
+  end
+end

data/spec/worker_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Navvy::Worker do
+  describe '.fetch_and_run_jobs' do
+    before do
+      @jobs = [
+        Navvy::Job.enqueue(Cow, :speak),
+        Navvy::Job.enqueue(Cow, :speak),
+        Navvy::Job.enqueue(Cow, :speak)
+      ]
+      
+      Navvy::Job.stub!(:next).and_return(@jobs)
+    end    
+    
+    it 'should fetch jobs' do
+      Navvy::Job.should_receive(:next).and_return(@jobs)
+      Navvy::Worker.fetch_and_run_jobs
+    end
+    
+    it 'should run three jobs' do
+      @jobs.each do |job|
+        job.should_receive(:run)
+      end
+      Navvy::Worker.fetch_and_run_jobs
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: navvy
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Jeff Kreeftmeijer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-11 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.10
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: metric_fu
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: machinist
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: machinist_mongomapper
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.7
+    version: 
+description: Simple background job processor inspired by delayed_job, but aiming for database agnosticism.
+email: jeff@kreeftmeijer.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- lib/job/mongo_mapper.rb
+- lib/navvy.rb
+- lib/navvy/job.rb
+- lib/navvy/job/mongo_mapper.rb
+- lib/navvy/worker.rb
+- navvy.gemspec
+- spec/job/mongo_mapper_spec.rb
+- spec/setup/mongo_mapper.rb
+- spec/spec_helper.rb
+- spec/worker_spec.rb
+has_rdoc: true
+homepage: http://github.com/jeffkreeftmeijer/navvy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple background job processor inspired by delayed_job, but aiming for database agnosticism.
+test_files: 
+- spec/job/mongo_mapper_spec.rb
+- spec/setup/mongo_mapper.rb
+- spec/spec_helper.rb
+- spec/worker_spec.rb