urge 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZjYwNzQxMzM3ZmQyNGJlNzBhOWY2YTJmZTFlMzk0ODFlODA1NjExYw==
+    Nzg5ZjVlOTg2MWUzYWE5NTYxZTliZmE3Y2ZiOWVkMzA1N2JjMTRlNg==
   data.tar.gz: !binary |-
-    M2NmZGU5ZWY0OGVkZmI0MzU5NDYyMzc0NThhOTU2Yjc2NDA0ZGFkNw==
+    MmFhZjQyZTUzYTBlNGQ2Njg4MTBiNjU0NzFkNDNjZmQ2ZTMyYjg0OQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MzA2NDVlMWQ1OWJkNzY1OGJjNDhkNzllMjI0NzlmODg3YzczOTQyYjUxMjZh
-    MzMyNjZmYzRlZmUwYmI1OTFlNGZlZDNhZmIyZjEwYThjZmM4Zjg4ZGQyZDY2
-    OTYxYjljZTQzYjNlYjdlYTcwYmNkYTZmNmFlNGRkYjlmMzU2NGM=
+    MzNlN2Y2M2M5ZDRmYThmOWQxZmMyYzg1N2EyN2YwOTA5NTBiZTdiNDcxYzQ2
+    ZDg0MDhjYjU4NjExNmJhYmU5ZjRlZjQzNTZkZTk1ZjgwYTJlOWU2NTY3NTc1
+    YTYxOWU5ZjUxNWQ4OTZiZWZkMTAzNTkzNDFiNTBlMzhjZTQ2ZmE=
   data.tar.gz: !binary |-
-    NmY5M2QwNjNkZWY0N2EyOTA5MWNiMzA1NjY1ZWVmZjgwOTA3YjQzNjg3NTk4
-    YjhmZjhmYWFmZTc4ODEyZDNkNzJhODZjZTUyZmJhZTNhY2EzMWNmNzhjYjg3
-    ZTgzZjRlYTUwNGFiM2FkMDc3MDAwMmVkYzNmYWQzYWE3MjMzZmM=
+    M2FiM2I2MThjY2UxNTdiMzMyNzcwYTJiMDA0YmMxODQ1MDgwNDI1MjhlZGJk
+    ZjYxMTQyOTVlOGJmZDViZjEwZDE1MTYyNzE5YjNjODJlNmFmZWU1MjNkOWU3
+    MzQ2MmFiN2FhMjE1YzYzM2IxODk0YzQ4MTJkOWI3OGViNmQxZWI=

data/lib/urge/persistence/active_record_persistence.rb

@@ -11,10 +11,10 @@ module Urge
       module ClassMethods
 
         # AR finder
-        def ready_to_run( name, at = DateTime.now )
-          options = schedules[name]
+        def urgent( name, at = DateTime.now )
+          options = urge_schedules[name]
           raise 'Unknown schedule' unless options
-          where( "#{attr_name(name)} < ?", at )
+          where( "#{urge_attr_name(name)} < ?", at )
         end
 
 
@@ -36,22 +36,16 @@ module Urge
         #   matches
         # end
   
-        # Same as Scheduled::run_all but saves the rescheduled task
-        def run_all!( name )
-          now = DateTime.now
-          logger.debug "run_all! Time now: #{now}"
-          ready_to_run( now ).each do |task|
-            logger.debug "Task of class #{task.class.name} is about to be run! (with a bang)"
-            task.run!( name )
-          end
+        def urge_all!( name )
+          urgent( name ).each { |u| u.urge!( name ) }
         end
       
       end
       
       module InstanceMethods
         
-        def run!( name, options = {} )
-          run( name, options )
+        def urge!( name, options = {} )
+          urge( name, options )
           save!
         end
         

data/lib/urge/version.rb

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

data/lib/urge.rb

@@ -1,10 +1,117 @@
 require 'urge/version'
-require 'urge/scheduled'
 require 'urge/persistence'
 
-# require 'urge/credit_control'
-
 require 'logging'
 
 module Urge
-end
+
+  module ClassMethods
+
+    # def run_all( name )
+    #   now = DateTime.now
+    #   logger.debug "run_all. Time now: #{now}"
+    #   ready_to_run( name, now ).each do |task|
+    #     logger.debug "Task of class #{task.class.name} named: #{name} is about to be run"
+    #     task.run( name )
+    #   end
+    # end
+    # 
+    # def inspect_all( name )
+    #   now = DateTime.now
+    #   tasks = ready_to_run( name, now )
+    #   logger.info "inspect_queue. Time now: #{now}. The following #{tasks.size} tasks are ready to run"
+    #   tasks.each { |task| logger.info task.inspect }
+    #   tasks
+    # end
+
+    def urge_logger
+      @@urge_logger ||= Logging.logger[self]
+    end
+
+    def urge_schedule( name, options = {} )
+
+      urge_logger.info "Defining schedule: #{name}. Options: #{options}. Class: #{self.name}"
+
+      # Warn if a schedule with this name already exists, but don't bail out.
+      # It's not necessarily an error. Rails autoloading classes is an example where it's not...
+      urge_logger.warn "A schedule with this name already exists. Old options: #{urge_schedules[name]}" if urge_schedules[name]
+
+      # NEW. Set defaults. The name pf the action metod is the same as the name of the schedule, and the name of the timestamp
+      # attribute is likewise, but with _at appended.
+
+      # For example, if the schedule name is 'check_credit', the signature of the action method - unless overridden - is 
+      # expected to be 
+
+      # def check_credit( options )
+      # end
+
+      # The timestamp name - unless set explicitly - is check_credit_at
+      options[:timestamp_name] ||= "#{name}_at"
+      options[:action] ||= name
+
+      urge_schedules[name] = options
+    end
+
+    def urge_schedules
+      @@urge_per_class_schedules ||= {}
+      @@urge_per_class_schedules[self.name] ||= {}
+    end
+
+    def urge_all_schedules
+      @@urge_per_class_schedules
+    end
+
+    # private
+
+    def urge_attr_name( name )
+      raise 'Non existent schedule name' unless urge_schedules[name]
+      urge_schedules[name][:timestamp_name]
+    end
+
+  end
+
+  # 
+  # 
+  # 
+  module InstanceMethods
+
+    def urgent?( name )
+      ts = self.send( urge_attr_name( name ) )
+      ts ? (DateTime.now >= ts) : false
+    end
+
+    def urge_reschedule( name, _when )
+      urge_logger.debug "ScheduledTask#reschedule about to reschedule for #{_when}"
+      self.send( "#{urge_attr_name(name)}=", _when )
+    end
+
+    # Takes action and reschedules itself. That is all, and that is enough!
+    def urge( name, options = {} )
+
+      return false unless urgent?( name )
+
+      interval = self.send( self.class.urge_schedules[name][:action].to_sym, options )
+      urge_reschedule( name, interval ? interval.from_now : nil )
+      true
+
+    end
+
+  private
+
+    def urge_attr_name( name )
+      self.class.urge_attr_name( name )
+    end
+    
+    def urge_logger
+      self.class.urge_logger
+    end
+  
+  end
+
+  def self.included(base)
+    base.extend ClassMethods
+    base.send :include, InstanceMethods
+    Urge::Persistence.set_persistence(base)
+  end
+
+end

data/spec/{lib → models}/active_record/dual_action_model_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+require 'spec_helper'
 
 load_schema
 
@@ -14,10 +14,10 @@ logger = Logging.logger['simple']
 
 class DualActionGuest < ActiveRecord::Base
 
-  include Urge::Scheduled
+  include Urge
 
-  urge_schedule( :status_check,    :scheduled_for => :status_check_at, :action => :check_status )
-  urge_schedule( :insurance_check, :scheduled_for => :insurance_check_at, :action => :check_insurance )
+  urge_schedule( :status_check,    :timestamp_name => :status_check_at, :action => :check_status )
+  urge_schedule( :insurance_check, :timestamp_name => :insurance_check_at, :action => :check_insurance )
   
   def status_checked?
     @status_checked
@@ -83,13 +83,13 @@ describe 'AR model with more than one schedule' do
         @checks = [:status_check, :insurance_check]
       end
 
-      it "both checks should be ready to run" do
-        @checks.each { |c| @guest.should be_ready_to_run( c ) }
+      it "both checks should be urgent" do
+        @checks.each { |c| @guest.should be_urgent( c ) }
       end
 
       context "when run" do
         before(:each) do
-          @checks.each { |c| @guest.run( c )}
+          @checks.each { |c| @guest.urge( c )}
         end
         
         it "should result in the guest having his status and his insurance checked" do
@@ -118,14 +118,12 @@ describe "AR finders" do
   
   it "should return the correct number guests ready to run" do
 
-    logger.info "All schedules: #{DualActionGuest.all_schedules}"
-    
     expect {
-      DualActionGuest.ready_to_run( :default )
+      DualActionGuest.urgent( :default )
     }.to raise_error( RuntimeError )
     
-    DualActionGuest.ready_to_run( :status_check ).should have(@count).items
-    DualActionGuest.ready_to_run( :insurance_check ).should have(@count).items
+    DualActionGuest.urgent( :status_check ).should have(@count).items
+    DualActionGuest.urgent( :insurance_check ).should have(@count).items
   end
   
 end

data/spec/{lib → models}/active_record/simple_model_spec.rb

@@ -1,17 +1,16 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+require 'spec_helper'
 
 load_schema
 
 class SimpleGuest < ActiveRecord::Base
 
-  include Urge::Scheduled
-
-  urge_schedule( :default, :scheduled_for => :scheduled_for, :action => :take_action )
+  include Urge
+  urge_schedule( :default, :timestamp_name => :scheduled_for, :action => :take_action )
 
 private
 
   def take_action( options )
-    logger.debug "In take_action. About to return empty set"
+    logger.debug "In take_action. About to return nil"
     nil
   end
 
@@ -52,7 +51,7 @@ describe 'Simplest active record model' do
   end
   
   it "should be ready to run" do
-    @guest.should be_ready_to_run( :default )
+    @guest.should be_urgent( :default )
   end
   
   it "should raise an exception if an attempt is made to access a schedule that doesn't exist" do
@@ -61,9 +60,9 @@ describe 'Simplest active record model' do
     }.to raise_error
   end
   
-  context "when run" do
+  context "when urged" do
     before(:each) do
-      @guest.run :default
+      @guest.urge :default
     end
     
     it "should not be rescheduled" do
@@ -73,7 +72,7 @@ describe 'Simplest active record model' do
   
 end
 
-describe "AR finders" do
+describe "Class method finders" do
   
   before(:each) do
     
@@ -85,9 +84,39 @@ describe "AR finders" do
     end
   end
   
-  it "should return the correct number guests ready to run" do
-    SimpleGuest.ready_to_run( :default ).should have(@count).items
+  it "should find the correct number of urgent guests" do
+    SimpleGuest.urgent( :default ).should have(@count).items
   end
   
 end
 
+
+describe "AR saving. 10 guests, when scheduled" do
+  
+  before(:each) do
+
+    SimpleGuest.delete_all
+    @count = 10
+    @count.times do |index|
+      FactoryGirl.create :simple_guest, :scheduled_for => 1.day.ago
+    end
+    
+  end
+  
+  it "should return the correct number of urgent guests" do
+    SimpleGuest.urgent( :default ).should have(@count).items
+  end
+
+  context "when urged" do
+    
+    before(:each) do
+      SimpleGuest.urge_all! :default
+    end
+    
+    it "should have no urgent guests" do
+      SimpleGuest.urgent( :default ).should be_empty
+    end
+    
+  end
+  
+end

data/spec/{lib → models}/dual_action_spec.rb

@@ -1,11 +1,11 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 # 
 # 
 # 
 class TwoTask
   
-  include Urge::Scheduled
+  include Urge
   
   attr_accessor :scheduled_for_one, :scheduled_for_two
   
@@ -15,13 +15,13 @@ class TwoTask
     @scheduled_for_one = attrs[:scheduled_for_one]
     @scheduled_for_two = attrs[:scheduled_for_two]
 
-    @logger = options[:logger] || Logging.logger['scheduled_test']
+    @logger = options[:logger] || Logging.logger['test']
 
     @actions = options[:actions]
   end
 
-  urge_schedule( :one, :scheduled_for => :scheduled_for_one, :action => :take_one )
-  urge_schedule( :two, :scheduled_for => :scheduled_for_two, :action => :take_two )
+  urge_schedule( :one, :timestamp_name => :scheduled_for_one, :action => :take_one )
+  urge_schedule( :two, :timestamp_name => :scheduled_for_two, :action => :take_two )
   
   def take_one( options )
     @actions << :action_one
@@ -35,7 +35,7 @@ class TwoTask
   
 end
 
-describe Urge::Scheduled do
+describe Urge do
   
   context "when applied to an in memory object requiring two separate actions, that object" do
     
@@ -53,10 +53,10 @@ describe Urge::Scheduled do
       @actions.should be_empty
     end
     
-    context "when run in the context of task 1" do
+    context "when urged in the context of task 1" do
       
       before(:each) do
-        @object.run( :one )
+        @object.urge( :one )
       end
       
       it "should produce one action" do
@@ -70,10 +70,10 @@ describe Urge::Scheduled do
       
     end
 
-    context "when run in the context of task 2" do
+    context "when urged in the context of task 2" do
       
       before(:each) do
-        @object.run( :two )
+        @object.urge( :two )
       end
       
       it "should produce another action" do
@@ -87,11 +87,11 @@ describe Urge::Scheduled do
       
     end
     
-    context "when run in the context of both tasks" do
+    context "when urged in the context of both tasks" do
 
       before(:each) do
-        @object.run( :one )
-        @object.run( :two )
+        @object.urge( :one )
+        @object.urge( :two )
       end
 
       it "should produce two actions" do

data/spec/{lib → models}/scheduled_spec.rb

@@ -1,38 +1,42 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 Logging.logger['simple'].tap {|logger| 
   logger.add_appenders 'colourful_stdout'
   logger.level = :info
 }
 
-
 # 
 # 
 # 
 class Simple
+
+  # By including the Urge module, we drag in all the class methods from that module
+  include Urge
   
-  include Urge::Scheduled
-  
-  attr_accessor :scheduled_for
+  attr_accessor :something_at
   attr_reader :actions, :logger
   
   def initialize( attrs = {} )
-    self.scheduled_for = attrs[:scheduled_for]
+    self.something_at = attrs[:something_at]
 
     @logger = Logging.logger['simple']
     @actions = []
   end
 
-  urge_schedule( :something, :scheduled_for => :scheduled_for, :action => :do_something )
+  urge_schedule :something, :action => 'do_something'
   
   def do_something( options )
     @actions << :foo
     nil
   end
   
+  # def self.attr_name( name )
+  #   raise 'ILLEGAL!'
+  # end
+  
 end
 
-describe Urge::Scheduled do
+describe Urge do
   
   context "when applied to a simple, in memory object" do
     
@@ -47,10 +51,10 @@ describe Urge::Scheduled do
     
     context "that is not scheduled" do
       
-      context "when run in the correct context" do
+      context "when urged to do something" do
 
         before(:each) do
-          @object.run( :something )
+          @object.urge( :something )
         end
 
         it "should do nothing" do
@@ -64,13 +68,13 @@ describe Urge::Scheduled do
     context "that has been scheduled to run 1 second ago" do
       
       before(:each) do
-        @object.scheduled_for = 1.second.ago
+        @object.something_at = 1.second.ago
       end
 
-      context "when run in the correct context" do
+      context "when urged in the correct context" do
 
         before(:each) do
-          @object.run( :something )
+          @object.urge( :something )
         end
 
         it "should produce one action" do
@@ -79,16 +83,16 @@ describe Urge::Scheduled do
         end
 
         it "should not be rescheduled" do
-          @object.scheduled_for.should be_nil
+          @object.something_at.should be_nil
         end
 
       end
       
-      context "when run in a non existent context" do
+      context "when urged in a non existent context" do
         
         it "should raise an error" do
           expect {
-            @object.run( :doesnt_exist )
+            @object.urge( :doesnt_exist )
           }.to raise_error( RuntimeError )
         end
         

data/spec/spec_helper.rb

@@ -26,7 +26,7 @@ Logging.configure do
     )
   )
 
-  test_loggers = %w{ scheduled_task_test credit_control_test scheduled_test scheduled }
+  test_loggers = %w{ test }
   # test_loggers = []
     
   test_loggers.each do |name|
@@ -40,31 +40,13 @@ end
 
 require 'aasm'
 require 'logging'
-require 'urge/scheduled'
 require 'active_support/time'
 require 'active_record'
 require 'factory_girl'
 
 FactoryGirl.find_definitions
 
-class ScheduledTask
-
-  include Urge::Scheduled
-  
-  attr_reader :logger
-
-  def initialize( name, options = {} )
-    if options[:logger]
-      @logger = options[:logger]
-    else
-      @logger = Logging.logger['scheduled_task_test']
-    end
-    self.name = name
-  end
-
-end
-
-ActiveRecord::Base.logger = Logging.logger['credit_control_test']
+ActiveRecord::Base.logger = Logging.logger['test']
 
 def load_schema
   config = YAML::load( IO.read( File.dirname(__FILE__) + '/database.yml' ) )
@@ -72,6 +54,4 @@ def load_schema
   load( File.dirname(__FILE__) + "/schema.rb" )
 end
 
-class Client < ActiveRecord::Base
-end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urge
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nick Adams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-02 00:00:00.000000000 Z
+date: 2013-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -110,15 +110,14 @@ files:
 - lib/urge/persistence.rb
 - lib/urge/persistence/active_record_persistence.rb
 - lib/urge/persistence/base.rb
-- lib/urge/scheduled.rb
 - lib/urge/version.rb
 - spec/aasm.sqlite3.db
 - spec/database.yml
 - spec/factories/factory.rb
-- spec/lib/active_record/dual_action_model_spec.rb
-- spec/lib/active_record/simple_model_spec.rb
-- spec/lib/dual_action_spec.rb
-- spec/lib/scheduled_spec.rb
+- spec/models/active_record/dual_action_model_spec.rb
+- spec/models/active_record/simple_model_spec.rb
+- spec/models/dual_action_spec.rb
+- spec/models/scheduled_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb
 - urge.gemspec
@@ -149,9 +148,9 @@ test_files:
 - spec/aasm.sqlite3.db
 - spec/database.yml
 - spec/factories/factory.rb
-- spec/lib/active_record/dual_action_model_spec.rb
-- spec/lib/active_record/simple_model_spec.rb
-- spec/lib/dual_action_spec.rb
-- spec/lib/scheduled_spec.rb
+- spec/models/active_record/dual_action_model_spec.rb
+- spec/models/active_record/simple_model_spec.rb
+- spec/models/dual_action_spec.rb
+- spec/models/scheduled_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb

data/lib/urge/scheduled.rb

@@ -1,95 +0,0 @@
-require 'logging'
-
-module Urge
-  module Scheduled
-    module ClassMethods
-
-      def run_all( name )
-        now = DateTime.now
-        logger.debug "run_all. Time now: #{now}"
-        ready_to_run( name, now ).each do |task|
-          logger.debug "Task of class #{task.class.name} named: #{name} is about to be run"
-          task.run( name )
-        end
-      end
-        
-      def inspect_all( name )
-        now = DateTime.now
-        tasks = ready_to_run( name, now )
-        logger.info "inspect_queue. Time now: #{now}. The following #{tasks.size} tasks are ready to run"
-        tasks.each { |task| logger.info task.inspect }
-        tasks
-      end
-      
-      def logger
-        @@logger ||= Logging.logger[self]
-      end
-
-      def urge_schedule( name, options = {} )
-        logger.info "Defining schedule: #{name}. Options: #{options}. Class: #{self.name}"
-        raise 'Cannot have two schedules with the same name' if schedules[name]
-        schedules[name] = options
-      end
-      
-      def schedules
-        @@per_class_schedules ||= {}
-        @@per_class_schedules[self.name] ||= {}
-      end
-
-      def attr_name( name )
-        raise 'Non existent schedule name' if schedules[name].blank?
-        schedules[name][:scheduled_for] || "scheduled_for_#{name}"
-      end
-      
-      def all_schedules
-        @@per_class_schedules
-      end
-
-    end
-  
-    module InstanceMethods
-
-      def ready_to_run?( name )
-        ts = self.send( attr_name( name ) )
-        ts ? (DateTime.now >= ts) : false
-      end
-
-      def reschedule( name, _when )
-        logger.debug "ScheduledTask#reschedule about to reschedule for #{_when}"
-        self.send( "#{attr_name(name)}=", _when )
-      end
-
-      # Takes action and reschedules itself. That is all, and that is enough!
-      def run( name, options = {} )
-
-        return false unless ready_to_run?( name )
-        
-        logger.debug "About to call take_action_#{name}"
-        interval = internal_take_action( name, options )
-
-        logger.debug "Action taken. Calculated run interval: #{interval ? interval : 'none - task will *not* be rescheduled'}"
-        reschedule( name, interval ? interval.from_now : nil )
-        
-        true
-
-      end
-
-    private
-
-      def internal_take_action( name, options )
-        self.send( self.class.schedules[name][:action] || "take_action_#{name}".to_sym, options )
-      end
-
-      def attr_name( name )
-        self.class.attr_name( name )
-      end
-      
-    end
-  
-    def self.included(base)
-      base.extend ClassMethods
-      base.send :include, InstanceMethods
-      Urge::Persistence.set_persistence(base)
-    end
-  end
-end