say_when 0.1.0

data/spec/say_when/cron_expression_spec.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe SayWhen::CronExpression do
+
+  it "should set the time_zone" do
+    @ce = SayWhen::CronExpression.new("0 0 12 ? * 1#1 *", 'Pacific Time (US & Canada)')
+    @ce.time_zone.should == 'Pacific Time (US & Canada)'
+  end
+
+  describe 'get first sunday in the month with "1#1' do
+
+    before do
+      @ce = SayWhen::CronExpression.new("0 0 12 ? * 1#1 *", 'Pacific Time (US & Canada)')
+    end
+
+    it "finds first sunday in the same month" do
+      @ce.next_fire_at(Time.utc(2008,1,1)).should == Time.parse('2008-01-06 12:00:00 -0800')
+    end
+
+
+    it "finds first sunday in the next month" do
+      @ce.next_fire_at(Time.utc(2008,1,7)).should == Time.parse('2008-02-03 12:00:00 -0800')
+    end
+
+    it "finds last sunday in the same month" do
+      @ce.last_fire_at(Time.utc(2008,1,10)).should == Time.parse('2008-01-06 12:00:00 -0800')
+    end
+
+    it "finds sundays in the prior months and years" do
+      @ce.last_fire_at(Time.utc(2008,1,5)).should == Time.parse('2007-12-02 12:00:00 -0800')
+      @ce.last_fire_at(Time.parse('2007-12-02 12:00:00 -0800') - 1.second).should == Time.parse('2007-11-04 12:00:00 -0800')
+      @ce.last_fire_at(Time.parse('2007-11-04 12:00:00 -0800') - 1.second).should == Time.parse('2007-10-07 12:00:00 -0700')
+      @ce.next_fire_at(Time.parse('2007-10-07 12:00:00 -0700') + 1.second).should == Time.parse('2007-11-04 12:00:00 -0800')
+    end
+  end
+
+  describe 'get last sunday in the month with "1L"' do
+    before do
+      @ce = SayWhen::CronExpression.new("0 0 12 ? * 1L *", 'Pacific Time (US & Canada)')
+    end
+
+    it "gets next final sunday for same month" do
+      @ce.next_fire_at(Time.utc(2008,1,1)).should == Time.parse('2008-01-27 12:00:00 -0800')
+    end
+
+
+    it "gets next final sunday for next month" do
+      @ce.next_fire_at(Time.utc(2008,1,28)).should == Time.parse('2008-02-24 12:00:00 -0800')
+    end  
+
+    it "gets last final sunday for same month" do
+      @ce.last_fire_at(Time.utc(2008,1,28)).should == Time.parse('2008-01-27 12:00:00 -0800')
+    end  
+
+    it "gets last sunday for prior month and year" do
+      @ce.last_fire_at(Time.utc(2008,1,1)).should == Time.parse('2007-12-30 12:00:00 -0800')
+    end  
+
+
+    it "gets last sunday for prior month and year" do
+      nfa = @ce.last_fire_at(Time.utc(2007,12,1))
+      nfa.should == Time.parse('2007-11-25 12:00:00 -0800')
+
+      nfa = @ce.last_fire_at(nfa - 1.second)
+      nfa.should == Time.parse('2007-10-28 12:00:00 -0700')
+
+      nfa = @ce.next_fire_at(nfa + 1.second)
+      nfa.should == Time.parse('2007-11-25 12:00:00 -0800')
+    end  
+
+  end
+end

data/spec/say_when/scheduler_spec.rb

@@ -0,0 +1,76 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../active_record_spec_helper'
+
+describe SayWhen::Scheduler do
+
+  describe "class methods" do
+
+    it "can return singleton" do
+      s = SayWhen::Scheduler.scheduler
+      s.should_not be_nil
+      s.should == SayWhen::Scheduler.scheduler
+    end
+
+    it "can be configured" do
+      SayWhen::Scheduler.configure do |scheduler|
+        scheduler.storage_strategy = :active_record
+        scheduler.processor_class  = SayWhen::Test::TestProcessor
+      end
+      SayWhen::Scheduler.scheduler.storage_strategy.should == :active_record
+      SayWhen::Scheduler.scheduler.processor_class.should == SayWhen::Test::TestProcessor
+    end
+
+    it "can schedule a new job" do
+      SayWhen::Scheduler.configure do |scheduler|
+        scheduler.storage_strategy = :active_record
+        scheduler.processor_class  = SayWhen::Test::TestProcessor
+      end
+
+      job = SayWhen::Scheduler.schedule(
+        :trigger_strategy => 'once',
+        :trigger_options  => 10.second.since,
+        :job_class        => 'SayWhen::Test::TestTask',
+        :job_method       => 'execute'
+      )
+      job.should_not be_nil
+    end
+
+  end
+
+  describe "instance methods" do
+
+    before(:all) do
+      SayWhen::Scheduler.configure do |scheduler|
+        scheduler.storage_strategy = :active_record
+        scheduler.processor_class  = SayWhen::Test::TestProcessor
+      end
+      @scheduler = SayWhen::Scheduler.scheduler
+    end
+
+    it "should instantiate the processor from its class" do      
+      @scheduler.processor.should be_a(SayWhen::Test::TestProcessor)
+    end
+
+    it "should get the job class based on the strategy" do
+      @scheduler.job_class.should == SayWhen::Storage::ActiveRecord::Job
+    end
+
+    it "should start the scheduler running and stop it" do
+      @scheduler.running.should be_false
+
+      puts 'starting'
+      scheduler_thread = Thread.start{@scheduler.start}
+      puts 'started'
+      sleep(0.1)
+      @scheduler.running.should == true
+
+      puts 'stop'
+      @scheduler.stop
+      puts 'wait for it'
+      @scheduler.running.should == false
+    end
+
+  end
+
+
+end

data/spec/say_when/storage/active_record/job_spec.rb

@@ -0,0 +1,84 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+require File.dirname(__FILE__) + '/../../../active_record_spec_helper'
+require File.dirname(__FILE__) + '/../../../../lib/say_when/storage/active_record/job'
+
+describe SayWhen::Storage::ActiveRecord::Job do
+
+  before(:each) do
+    @valid_attributes = {
+      :trigger_strategy => :cron,
+      :trigger_options  => {:expression => '0 0 12 ? * * *', :time_zone  => 'Pacific Time (US & Canada)'},
+      :data             => {:foo=>'bar', :result=>1},
+      :job_class        => 'SayWhen::Test::TestTask',
+      :job_method       => 'execute'
+    }
+  end
+
+  it "can be instantiated" do
+    j = SayWhen::Storage::ActiveRecord::Job.create!(@valid_attributes)
+    j.should_not be_nil
+  end
+
+  it "can execute the task for the job" do
+    j = SayWhen::Storage::ActiveRecord::Job.create(@valid_attributes)
+    j.execute_job({:result=>1}).should == 1
+  end
+
+  it "can execute the job" do
+    j = SayWhen::Storage::ActiveRecord::Job.create(@valid_attributes)
+    j.execute.should == 1
+  end
+
+  it "derives a trigger from the attributes" do
+    t = SayWhen::Storage::ActiveRecord::Job.create(@valid_attributes)
+    t.trigger.should_not be_nil
+    t.trigger.should be_a SayWhen::Triggers::CronStrategy
+  end
+
+  it "has a waiting state on create" do
+    t = SayWhen::Storage::ActiveRecord::Job.create(@valid_attributes)
+    t.status.should == SayWhen::BaseJob::STATE_WAITING
+  end
+
+  it "has a next fire at set on create" do
+    opts = @valid_attributes[:trigger_options]
+    ce = SayWhen::CronExpression.new(opts[:expression], opts[:time_zone])
+    j = SayWhen::Storage::ActiveRecord::Job.create(@valid_attributes)
+    j.status.should == SayWhen::BaseJob::STATE_WAITING
+    j.next_fire_at.should == ce.next_fire_at
+  end
+
+  it "can find the next job" do
+    j2_opts = {
+      :trigger_strategy => :cron,
+      :trigger_options  => {:expression => '0 0 10 ? * * *', :time_zone  => 'Pacific Time (US & Canada)'},
+      :data             => {:foo=>'bar', :result=>2},
+      :job_class        => 'SayWhen::Test::TestTask',
+      :job_method       => 'execute'
+    }
+
+    j1 = SayWhen::Storage::ActiveRecord::Job.create(@valid_attributes)
+    j2 = SayWhen::Storage::ActiveRecord::Job.create(j2_opts)
+    next_job = SayWhen::Storage::ActiveRecord::Job.acquire_next(1.day.since)
+    next_job.should == j2
+  end
+
+  it "can be fired" do
+    opts = @valid_attributes[:trigger_options]
+    ce = SayWhen::CronExpression.new(opts[:expression], opts[:time_zone])
+    j = SayWhen::Storage::ActiveRecord::Job.create(@valid_attributes)
+    nfa = ce.last_fire_at(j.created_at - 1.second)
+    lfa = ce.last_fire_at(nfa - 1.second)
+    j.next_fire_at = nfa
+    j.last_fire_at = lfa
+
+    now = Time.now
+    Time.stub!(:now).and_return(now)
+
+    j.fired
+    j.next_fire_at.should == ce.next_fire_at(now)
+    j.last_fire_at.should == now
+    j.status.should == SayWhen::BaseJob::STATE_WAITING
+  end
+
+end

data/spec/say_when/storage/memory/job_spec.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+require File.dirname(__FILE__) + '/../../../../lib/say_when/storage/memory/job'
+
+describe SayWhen::Store::Memory::Job do
+
+  before(:each) do
+    @valid_attributes = {
+      :name       => 'Memory::Job::Test',
+      :group      => 'Test',
+      :data       => {:foo=>'bar', :result=>1},
+      :job_class  => 'SayWhen::Test::TestTask',
+      :job_method => 'execute'
+    }
+  end
+
+  it "can be instantiated" do
+    j = SayWhen::Store::Memory::Job.new(@valid_attributes)
+    j.should_not be_nil
+  end
+
+  it "can execute the task for the job" do
+    j = SayWhen::Store::Memory::Job.new(@valid_attributes)
+    j.execute_job({:result=>1}).should == 1
+  end
+
+  it "can execute the job" do
+    j = SayWhen::Store::Memory::Job.new(@valid_attributes)
+    j.execute.should == 1
+  end
+
+end

data/spec/say_when/storage/memory/trigger_spec.rb

@@ -0,0 +1,54 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+# require File.dirname(__FILE__) + '/../../../../lib/say_when/store/memory/trigger'
+
+# describe SayWhen::Store::Memory::Trigger do
+
+#   before(:each) do
+#     @valid_attributes = {
+#       :expression => '0 0 12 ? * * *',
+#       :time_zone  => 'Pacific Time (US & Canada)'
+#     }
+#   end
+
+#   it "can be instantiated" do
+#     t = SayWhen::Store::Memory::Trigger.new(@valid_attributes)
+#     t.should_not be_nil
+#   end
+
+#   it "sets a cron_expression" do
+#     t = SayWhen::Store::Memory::Trigger.new(@valid_attributes)
+#     t.cron_expression.should_not be_nil
+#     t.cron_expression.expression.should == '0 0 12 ? * * *'
+#     t.cron_expression.time_zone.should == 'Pacific Time (US & Canada)'
+#   end
+
+#   it "has a waiting state on instantiate" do
+#     t = SayWhen::Store::Memory::Trigger.new(@valid_attributes)
+#     t.status.should == SayWhen::BaseTrigger::STATE_WAITING
+#   end
+
+#   it "has a next fire at set on instantiate" do
+#     ce = SayWhen::CronExpression.new(@valid_attributes[:expression], @valid_attributes[:time_zone])
+#     t = SayWhen::Store::Memory::Trigger.new(@valid_attributes)
+#     t.status.should == SayWhen::BaseTrigger::STATE_WAITING
+#     t.next_fire_at.should == ce.next_fire_at
+#   end
+
+#   it "can be fired" do
+#     ce = SayWhen::CronExpression.new(@valid_attributes[:expression], @valid_attributes[:time_zone])
+#     t = SayWhen::Store::Memory::Trigger.new(@valid_attributes)
+#     nfa = ce.last_fire_at(1.second.ago)
+#     lfa = ce.last_fire_at(nfa - 1.second)
+#     t.next_fire_at = nfa
+#     t.last_fire_at = lfa
+
+#     now = Time.now
+#     Time.stub!(:now).and_return(now)
+
+#     t.fired
+#     t.next_fire_at.should == ce.next_fire_at(now)
+#     t.last_fire_at.should == now
+#     t.status.should == SayWhen::BaseTrigger::STATE_WAITING
+#   end
+
+# end

data/spec/say_when/storage/mongoid/trigger_spec.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+require File.dirname(__FILE__) + '/../../../mongoid_spec_helper'
+# require File.dirname(__FILE__) + '/../../../../lib/say_when/store/mongoid/trigger'
+
+# describe SayWhen::Store::Mongoid::Trigger do
+
+#   before(:each) do
+#     SayWhen::Store::Mongoid::Trigger.delete_all
+#     @valid_attributes = {
+#       :expression => '0 0 12 ? * * *',
+#       :time_zone  => 'Pacific Time (US & Canada)'
+#     }
+#   end
+
+#   it "can be created using new and save" do
+#     t = SayWhen::Store::Mongoid::Trigger.new(@valid_attributes)
+#     t.should be_valid
+#     t.save
+#   end
+
+#   it "sets a cron_expression" do
+#     t = SayWhen::Store::Mongoid::Trigger.create(@valid_attributes)
+#     t.cron_expression.should_not be_nil
+#     t.cron_expression.expression.should == '0 0 12 ? * * *'
+#     t.cron_expression.time_zone.should == 'Pacific Time (US & Canada)'
+#   end
+
+#   it "has a waiting state on create" do
+#     t = SayWhen::Store::Mongoid::Trigger.create(@valid_attributes)
+#     t.status.should == SayWhen::BaseTrigger::STATE_WAITING
+#   end
+
+#   it "has a next fire at set on create" do
+#     ce = SayWhen::CronExpression.new(@valid_attributes[:expression], @valid_attributes[:time_zone])
+#     t = SayWhen::Store::Mongoid::Trigger.create(@valid_attributes)
+#     t.status.should == SayWhen::BaseTrigger::STATE_WAITING
+#     t.next_fire_at.should == ce.next_fire_at(t.created_at)
+#   end
+
+#   it "can be fired" do
+#     ce = SayWhen::CronExpression.new(@valid_attributes[:expression], @valid_attributes[:time_zone])
+#     t = SayWhen::Store::Mongoid::Trigger.create(@valid_attributes)
+#     nfa = ce.last_fire_at(t.created_at - 1.second)
+#     lfa = ce.last_fire_at(nfa - 1.second)
+#     t.next_fire_at = nfa
+#     t.last_fire_at = lfa
+
+#     now = Time.now
+#     Time.stub!(:now).and_return(now)
+
+#     t.fired
+#     t.next_fire_at.should == ce.next_fire_at(now)
+#     t.last_fire_at.should == now
+#     t.status.should == SayWhen::BaseTrigger::STATE_WAITING
+#   end
+
+# end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+ENV['RAILS_ENV']='test'
+
+require "rubygems"
+require 'bundler/setup'
+require 'active_support'
+
+require 'spec'
+require 'spec/autorun'
+
+$: << (File.dirname(__FILE__) + "/../lib")
+require "say_when"
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+Spec::Runner.configure do |config|
+  config.mock_with :rspec
+end
+
+module SayWhen
+  module Test
+
+    class TestTask
+      def execute(data)
+        data[:result] || 0
+      end
+    end
+
+    class TestProcessor < SayWhen::Processor::Base
+      attr_accessor :jobs
+
+      def initialize(scheduler)
+        super(scheduler)
+        reset
+      end
+
+      def process(job)
+        self.jobs << job
+      end
+
+      def reset
+        self.jobs = []
+      end
+    end
+
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,31 @@
+require 'active_support'
+
+class TestModel < Object
+  attr_accessor :id
+
+  def initialize(id=nil)
+    @id = id
+  end
+  
+  def ==(b)
+    return false unless b
+    # puts "compare: #{self.class.name}_#{@id} == #{b.class.name}_#{b.id}"
+    @id == b.id
+  end
+  
+  class << self
+
+    def find(ids=nil)
+      Array(ids).collect{|i| self.new(i)}
+    end
+
+  end
+
+end
+
+class User < TestModel
+end
+
+class Account < TestModel
+  attr_accessor :owner
+end

metadata

@@ -0,0 +1,224 @@
+--- !ruby/object:Gem::Specification 
+name: say_when
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Andrew Kuklewicz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activemessaging
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 9
+        - 0
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 3
+        - 14
+        version: 2.3.14
+  type: :development
+  prerelease: false
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 3
+        - 14
+        version: 2.3.14
+  type: :development
+  prerelease: false
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 1
+        - 9
+        - 5
+        version: 1.9.5
+  type: :development
+  prerelease: false
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  prerelease: false
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  requirement: *id007
+description: 
+email: 
+- andrew@prx.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- generators/say_when_migration/say_when_migration_generator.rb
+- generators/say_when_migration/templates/migration.rb
+- lib/generators/.DS_Store
+- lib/generators/say_when/migration/migration_generator.rb
+- lib/generators/say_when/migration/templates/migration.rb
+- lib/say_when.rb
+- lib/say_when/base_job.rb
+- lib/say_when/cron_expression.rb
+- lib/say_when/processor/active_messaging.rb
+- lib/say_when/processor/base.rb
+- lib/say_when/processor/simple.rb
+- lib/say_when/scheduler.rb
+- lib/say_when/storage/active_record/acts.rb
+- lib/say_when/storage/active_record/job.rb
+- lib/say_when/storage/active_record/job_execution.rb
+- lib/say_when/storage/memory/base.rb
+- lib/say_when/storage/memory/job.rb
+- lib/say_when/storage/mongoid/job.rb
+- lib/say_when/tasks.rb
+- lib/say_when/triggers/base.rb
+- lib/say_when/triggers/cron_strategy.rb
+- lib/say_when/triggers/once_strategy.rb
+- lib/say_when/version.rb
+- lib/tasks/say_when.rake
+- say_when.gemspec
+- spec/active_record_spec_helper.rb
+- spec/db/schema.rb
+- spec/db/test.db
+- spec/mongoid_spec_helper.rb
+- spec/say_when/cron_expression_spec.rb
+- spec/say_when/scheduler_spec.rb
+- spec/say_when/storage/active_record/job_spec.rb
+- spec/say_when/storage/memory/job_spec.rb
+- spec/say_when/storage/memory/trigger_spec.rb
+- spec/say_when/storage/mongoid/trigger_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/models.rb
+homepage: http://labs.prx.org
+licenses: []
+
+post_install_message: 
+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.8.22
+signing_key: 
+specification_version: 3
+summary: Scheduling system for programmatically defined and stored jobs.
+test_files: 
+- spec/active_record_spec_helper.rb
+- spec/db/schema.rb
+- spec/db/test.db
+- spec/mongoid_spec_helper.rb
+- spec/say_when/cron_expression_spec.rb
+- spec/say_when/scheduler_spec.rb
+- spec/say_when/storage/active_record/job_spec.rb
+- spec/say_when/storage/memory/job_spec.rb
+- spec/say_when/storage/memory/trigger_spec.rb
+- spec/say_when/storage/mongoid/trigger_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/models.rb