actionable 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35e414933341959d1347c1cb41e4e2bae53e880d
-  data.tar.gz: 19d6241afa6343d0a0e69033fafe1600fa54655e
+  metadata.gz: 45a9bd1c736c4e4a5ad2b7346e96604fe762252f
+  data.tar.gz: afd9fa6c64ff5ca69285019c34605ed46c3abbdd
 SHA512:
-  metadata.gz: 4e3ca8e2f1875fd0a5301f96e6293ca62c60dcb835cd21442779995489730c0056ea2d14d81dad33110ea450964707c459d0bc22f179ce59b94b80bd37d1fb56
-  data.tar.gz: 9815bef64be1a7d64100144278bf6d8404551915f618f9215e4f5910178c77b736de4eefb6f69b44f5741bd99646cdc6d1e312f0cee3d9507b4a0f0611944302
+  metadata.gz: d63c6d2439e5923342173b1b998e122876c4d4533e24782fd2f4e5898ff0e57ed64dcbfe4306622684f5f1872227c203918fd0e579e5c41af2b502f27ccd61ec
+  data.tar.gz: b64f3d371ce3c95716162ed3ebf215351176253497ff7837d051b6966643aae9210101031a7d5b0b4b974738b076aa4d49a1f786327d21fc1e3d1e9eedb95df9

data/Gemfile

@@ -1,11 +1,5 @@
 source 'https://rubygems.org'
 
-gem 'resque', github: 'defunkt/resque', branch: 'master'
-gem 'redis'
-gem 'redis-namespace'
-
+gem 'resque', github: 'resque/resque', branch: 'master'
 gem 'mongoid', github: 'mongoid/mongoid', branch: 'master'
-gem 'moped'
-gem 'origin'
-
 gemspec

data/README.md

@@ -1,5 +1,10 @@
+
 # Actionable
 
+[![Code Climate](https://codeclimate.com/github/dluxemburg/actionable.png)](https://codeclimate.com/github/dluxemburg/actionable)
+
+<img src="https://semaphoreapp.com/api/v1/projects/d32a2e65068b7b995bd9e9e2f8beb99a64c7f98d/36068/badge.png">
+
 TODO: Write a gem description
 
 ## Installation

data/Rakefile

@@ -1,6 +1,7 @@
 require "bundler/gem_tasks"
 require 'actionable/tasks'
 require 'resque/tasks'
+require 'rspec/core/rake_task'
 
 task "resque:setup" do
   puts File.expand_path('../spec/support/*.rb', __FILE__)
@@ -13,4 +14,9 @@ task "resque:setup" do
   Mongoid.configure do |config|
     config.connect_to('actionable_test')
   end
-end
+end
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/actionable.gemspec

@@ -27,8 +27,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rb-fsevent"
   spec.add_development_dependency "terminal-notifier-guard"
 
-  spec.add_dependency "resque"
-  spec.add_dependency "mongoid"
+  spec.add_dependency "resque", "~> 2.0.0.pre.1"
+  spec.add_dependency "mongoid", "~> 4.0.0"
   spec.add_dependency "rufus-scheduler"
 
 

data/lib/actionable.rb

@@ -12,6 +12,8 @@ require "actionable/mongoid_store/action"
 require "actionable/target"
 require "actionable/sweep"
 require "actionable/job"
+require "actionable/recurrence"
+
 
 module Actionable
   def self.store

data/lib/actionable/recurrence.rb

@@ -0,0 +1,61 @@
+require 'rufus/scheduler'
+
+module Actionable
+  class Recurrence
+
+      include Mongoid::Document
+      include Actionable::Target
+
+      store_in(collection: 'recurring_actionables')
+
+      field :recurrence_string
+      field :job_class,         type: String
+      field :payload,           type: Hash,   default: {}
+
+      after_create :schedule_next
+
+      validate :valid_recurrence_string
+      validate :valid_job_class
+
+      def schedule_next
+        schedule_actionable(next_run_time,job_class,payload)
+      end
+
+      def next_scheduled?
+        Actionable::Action.where(status: :scheduled, target_id: id).exists?
+      end
+
+      def ensure_scheduled
+        schedule_next unless next_scheduled?
+      end
+
+      private
+
+      def next_run_time
+        Rufus::CronLine.new(recurrence_string).next_time.to_datetime
+      end
+
+      def job_class
+        unless read_attribute(:job_class).blank?
+          read_attribute(:job_class).constantize 
+        end
+      end
+
+      def valid_recurrence_string
+        begin
+          next_run_time
+        rescue => e
+          errors.add(:recurrence_string,e.message)
+        end
+      end
+
+      def valid_job_class
+        begin
+          job_class
+        rescue => e
+          errors.add(:job_class,e.message)
+        end
+      end
+
+  end
+end

data/lib/actionable/sweep.rb

@@ -9,6 +9,7 @@ module Actionable
 
     def self.perform
       Actionable::Action.to_do.each(&:enqueue)
+      Actionable::Recurrence.all.each(&:ensure_scheduled)
     end
 
   end

data/lib/actionable/target.rb

@@ -16,7 +16,6 @@ module Actionable
       @actionable_errors
     end
 
-
     def schedule_actionable(execution_time,job_class_name,payload={})
       
       # force memoized values to refresh

data/lib/actionable/version.rb

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

data/spec/{work_spec.rb → job_spec.rb}

@@ -1,20 +1,30 @@
 require "spec_helper"
 
+class TestWorker
+  
+  attr_accessor :pid
+
+  def spawn
+    @pid = Kernel.spawn('bundle exec rake resque:work QUEUES=actionable,actionable_sweep')
+  end
+
+  def kill
+    system("kill -9 #{pid}")
+  end
 
-def start_test_worker
-  spawn('bundle exec rake resque:work PIDFILE=resque.pid QUEUES=actionable,actionable_sweep INTERVAL=1')
 end
 
-def kill_test_worker
-  pid = File.new(File.expand_path("../../resque.pid",__FILE__)).read
-  system("kill -9 #{pid}")
-  system("rm resque.pid")
+def run_test_worker(id)
+  w = TestWorker.new
+  w.spawn
+  poll_for_finished(id)
+  w.kill
 end
 
-def run_test_worker
-  start_test_worker
-  sleep(5)
-  kill_test_worker
+def poll_for_finished(id)
+  while TestModel.find(id).reload.number == 3
+    sleep(1)
+  end
 end
 
 describe Actionable::Job do
@@ -44,7 +54,7 @@ describe Actionable::Job do
 
     it "should be executed by a worker in another processes" do
       id = target.id
-      run_test_worker
+      run_test_worker(id)
       expect(TestModel.find(id).number).to eq(6)
       expect(TestModel.find(id).name).to eq('blue square')
     end

data/spec/recurrence_spec.rb

@@ -0,0 +1,99 @@
+require "spec_helper"
+
+describe Actionable::Recurrence do
+
+  let(:every_five){ "*/5 * * * *" }
+  let(:new_args){
+    { recurrence_string:every_five, job_class: RecurringTestJob }
+  }
+
+  let(:recurrence) {
+    Actionable::Recurrence.create(new_args)
+  }
+
+  it "should be instantiated with a recurrence string and a job class" do
+    r = Actionable::Recurrence.new(new_args)
+    expect(r).to be_valid
+  end
+
+  it "should refuse to save with a bad recurrence string" do
+    new_args[:recurrence_string] = '* D * L * . *'
+    r = Actionable::Recurrence.new(new_args)
+    expect(r).to_not be_valid
+  end
+
+  it "should refuse to save with a non-existent class" do
+    new_args[:job_class] = "NonExistentJob"
+    r = Actionable::Recurrence.new(new_args)
+    expect(r).to_not be_valid
+  end
+
+
+  it "should not add to the database until saved" do
+    r = Actionable::Recurrence.new(new_args)
+    expect(Actionable::Recurrence.count).to eq(0)
+  end
+
+  it "should add to the database afer being committed" do
+    r = Actionable::Recurrence.new(new_args)
+    r.save
+    expect(Actionable::Recurrence.count).to eq(1)
+  end
+
+  it "should know its job class" do
+    expect(recurrence.send(:job_class)).to eq(RecurringTestJob)
+  end
+
+  it "should create an actionable upon creation" do
+    expect(Actionable::Action.count).to eq(0)
+    Actionable::Recurrence.create(new_args)
+    expect(Actionable::Action.count).to eq(1)
+  end
+
+  context "when time passes" do
+
+    before do
+      Resque.inline = true
+      recurrence.valid?
+      Timecop.travel(5.minutes.from_now)
+    end
+  
+    it "should run the first action and create a new one on sweep" do
+      expect(Actionable::Action.count).to eq(1)
+      Actionable::Sweep.perform
+      expect(Actionable::Action.count).to eq(2)
+    end
+
+  end
+
+  context "when no time passes" do
+
+    before do
+      Resque.inline = true
+      recurrence.valid?
+    end
+
+    it "should not run the first action or create a new one" do
+      expect(Actionable::Action.count).to eq(1)
+      Actionable::Sweep.perform
+      expect(Actionable::Action.count).to eq(1)
+    end
+
+  end
+
+  context "over the course of an hour" do
+
+    it "should create and perform the job 11 times" do
+      RecurringTestJob.should_receive(:go).exactly(12).times
+      Timecop.travel(1.hour.from_now.change(minutes:0))
+      recurrence.valid?
+      60.times do
+        Actionable::Sweep.perform
+        Timecop.travel(1.minute.from_now)
+      end
+      expect(Actionable::Action.count).to be_within(1).of(12)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -19,10 +19,17 @@ end
 
 RSpec.configure do |config|
 
-  config.before(:each) do
+  config.after(:each) do
     Resque.purge!
     Mongoid.purge!
     Timecop.return
   end
 
+  config.before(:all) do
+    Resque.purge!
+    Mongoid.purge!
+    Timecop.return
+    Resque.inline = false
+  end
+
 end

data/spec/support/recurring_test_job.rb

@@ -0,0 +1,12 @@
+class RecurringTestJob < Actionable::Job
+
+  def perform
+    RecurringTestJob.go    
+  end
+
+  def self.go
+
+  end
+
+
+end

data/spec/sweep_spec.rb

@@ -6,31 +6,35 @@ describe Actionable::Sweep do
     TestModel.create
   }
 
-  before do
-    target.schedule_actionable(1.hour.from_now,TestJob)
-    Timecop.travel(2.hours.from_now)
-  end
-
-  it "should leave one job in the to do list before being performed" do
-    expect(Resque.size('actionables')).to eq(0)
-    expect(Actionable::Action.to_do.count).to eq(1)
-  end
-
-  it "should move one job from the to do list to the queue after being performed" do
-    Actionable::Sweep.perform
-    expect(Actionable::Action.to_do.count).to eq(0)
-    expect(Resque.size('actionables')).to eq(1)
-  end
-
-  pending "should enqueue a job that knows the id for its target" do
-    Actionable::Sweep.perform
-    expect(Resque.queue('actionables').pop['args'].first).to eq(target.actionables.first.id.to_s)
-  end
+  context "single jobs" do
+
+    before do
+      target.schedule_actionable(1.hour.from_now,TestJob)
+      Timecop.travel(2.hours.from_now)
+    end
+
+    it "should leave one job in the to do list before being performed" do
+      expect(Resque.size('actionable')).to eq(0)
+      expect(Actionable::Action.to_do.count).to eq(1)
+    end
+
+    it "should move one job from the to do list to the queue after being performed" do
+      Actionable::Sweep.perform
+      expect(Actionable::Action.to_do.count).to eq(0)
+      expect(Resque.size('actionable')).to eq(1)
+    end
+
+    it "should enqueue a job that knows the id for its target" do
+      Actionable::Sweep.perform
+      expect(Resque.queue('actionable').pop['args'].first).to eq(target.actionables.first.id.to_s)
+    end
+
+    it "should update the actionable's status to 'enqueued'" do
+      expect(target.actionables.first.status).to eq(:scheduled)    
+      Actionable::Sweep.perform
+      expect(target.actionables.first.status).to eq(:enqueued)
+    end
 
-  it "should update the actionable's status to 'enqueued'" do
-    expect(target.actionables.first.status).to eq(:scheduled)    
-    Actionable::Sweep.perform
-    expect(target.actionables.first.status).to eq(:enqueued)
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Daniel Luxemburg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-23 00:00:00.000000000 Z
+date: 2013-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,30 +126,30 @@ dependencies:
   name: resque
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0.pre.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0.pre.1
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
   requirement: !ruby/object:Gem::Requirement
@@ -184,18 +184,21 @@ files:
 - lib/actionable/memory_store/action.rb
 - lib/actionable/mongoid_store.rb
 - lib/actionable/mongoid_store/action.rb
+- lib/actionable/recurrence.rb
 - lib/actionable/resque.rb
 - lib/actionable/sweep.rb
 - lib/actionable/target.rb
 - lib/actionable/tasks.rb
 - lib/actionable/version.rb
 - spec/action_spec.rb
-- spec/schedule_spec.rb
+- spec/job_spec.rb
+- spec/recurrence_spec.rb
 - spec/spec_helper.rb
+- spec/support/recurring_test_job.rb
 - spec/support/test_job.rb
 - spec/support/test_model.rb
 - spec/sweep_spec.rb
-- spec/work_spec.rb
+- spec/target_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -223,9 +226,11 @@ summary: Store stuff in Mongo, keep track of it in Redis, log lots of stuff, inc
   test help
 test_files:
 - spec/action_spec.rb
-- spec/schedule_spec.rb
+- spec/job_spec.rb
+- spec/recurrence_spec.rb
 - spec/spec_helper.rb
+- spec/support/recurring_test_job.rb
 - spec/support/test_job.rb
 - spec/support/test_model.rb
 - spec/sweep_spec.rb
-- spec/work_spec.rb
+- spec/target_spec.rb