lucid_works 0.6.5 → 0.6.6

data/lib/lucid_works/datasource/schedule.rb

@@ -31,10 +31,6 @@ module LucidWorks
         end
       end
       
-      def time_of_day
-        Time.now
-      end
-      
       # predict when action will occur next if active at that time
       def next_start
         return start_time if reference_time <= start_time 
@@ -54,14 +50,44 @@ module LucidWorks
             
       # Provide ability to override "now" explicitly for testing purposes
       def reference_time=(time); @reference_time = time; end
-      def reference_time; @reference_time || Time.now.utc; end
+      def reference_time; @reference_time || Time.now.localtime; end
       
+      #
       # phantom attribute for compiling real start time and frequency from appropriate form data
+      # Allows the user to specify a schedule simply with repeat interval (hourly, daily, weekly)
+      # and time within the interval to run (e.g 5 past, or Tuesdays at 2:15)
+      # 
+      # We have to figure out when the actual start time will be because we are not asking 
+      # the user for this. It needs to be:
+      #   * at the requested time relative to the interval chosen
+      #   * as soon as possible
+      #   * in the future
+      #
+      # This is obvious to humans, but when computing it, you run into the following problem. It
+      # happens with all interval sizes, but for the sake of example, we'll use weekly:
+      #
+      # Problem 1) If today is Thursday, and the user asks for "weekly on Wednesdays," Wednesday has
+      # already happened this week. We have to make sure we pick the nearest wednesday that is in 
+      # the future
+      #
+      # Problem 2) If today is Tuesday, and the user asks for "weekly on Wednesdays,", the simple solution
+      # to problem 1 (start next week instead of this week) causes you to skip this Tuesday, even though
+      # it is valid and is what the user would expect
+      #
+      # The algorith to solve both problems at once is this: 
+      #    * From Time.now, back up to the beginning of the interval even if it is in the past. 
+      #    * Fast forward to the requested siimple start time
+      #    * If you are still in the past, advance by one interval
+      #
       def schedule=(all_attributes)
         # convert to format accepted by Time.advance
         all_attributes['start'].to_options!
         all_attributes['start'].each{|k,v| all_attributes['start'][k]=v.to_i}
 
+        if all_attributes.keys.include?('active')
+          self.active = (all_attributes['active'].to_s.downcase == 'true')
+        end
+        
         self.frequency = all_attributes['frequency']
         self.start_time = 
           case all_attributes['frequency']
@@ -80,6 +106,19 @@ module LucidWorks
             raise "unexpected frequency encountered"
           end
       end
+
+      def hour
+        self.start_time.localtime.hour rescue nil
+      end
+      
+      def min
+        self.start_time.localtime.min rescue nil
+      end
+      
+      def day_of_week
+        # subract 1 because '%u' returns 1-7, and this is for indexing a ruby array of day names
+        self.start_time.localtime.strftime('%u').to_i - 1 rescue nil
+      end
     end
   end
 end

data/lib/lucid_works/version.rb

@@ -1,3 +1,3 @@
 module LucidWorks
-  VERSION = "0.6.5"
+  VERSION = "0.6.6"
 end

data/spec/lib/lucid_works/datasource/schedule_spec.rb

@@ -1,16 +1,17 @@
 require 'spec_helper'
 
-class String
-  def weekday
-    Time.iso8601(self).strftime('%A')
+# convenience methods for readability of these tests themselves
+  class String
+    def weekday
+      Time.iso8601(self).strftime('%A')
+    end
   end
-end
 
-class Time
-  def weekday
-    self.strftime('%A')
+  class Time
+    def weekday
+      self.strftime('%A')
+    end
   end
-end
 
 describe LucidWorks::Datasource::Schedule do
   before do
@@ -19,17 +20,22 @@ describe LucidWorks::Datasource::Schedule do
   end
 
   describe '#frequency' do
-    it "should return 'daily'" do
+    it "should return 'weekly' when period == num of seconds in a week" do
+      @schedule.period = 604800
+      @schedule.frequency.should == 'weekly'
+    end
+
+    it "should return 'daily' when period == num of seconds in a day" do
       @schedule.period = 86400
       @schedule.frequency.should == 'daily'
     end
 
-    it "should return 'hourly'" do
+    it "should return 'hourly' when period == num of seconds in an hour" do
       @schedule.period = 3600
       @schedule.frequency.should == 'hourly'
     end
 
-    it "should return 'custom'" do
+    it "should return 'custom' when period does not correspond to a common number of seconds" do
       @schedule.period = 1
       @schedule.frequency.should == 'custom'
     end
@@ -41,7 +47,7 @@ describe LucidWorks::Datasource::Schedule do
   end
 
   describe '#next_start' do
-    describe 'start_time is in the future' do
+    context 'start_time is in the future' do
       it 'should return start_time' do
         @schedule.reference_time = Time.now.utc
         @schedule.start_time = @schedule.reference_time + 30.minutes
@@ -104,9 +110,49 @@ describe LucidWorks::Datasource::Schedule do
     end
   end
 
+  describe '#active, #active=' do 
+    it 'should maintain specified value' do
+      @schedule.active = true
+      @schedule.active.should == true
+      @schedule.active = false
+      @schedule.active.should == false
+      # make sure the first true wasn't luck
+      @schedule.active = true
+      @schedule.active.should == true
+    end
+  end
+  
   describe '#schedule=' do
-    context 'supplied start time has elapsed w/rt current interval' do
+    context 'active attribute supplied' do
+      describe 'updates the "active" attribute in the model' do
+        it 'should update the "active" attribute in the model' do
+          @schedule.active = true
+          attributes = {"frequency"=>"hourly", "start"=>{"minutes"=>"15"}, "active" => 'false'}
+          @schedule.schedule = attributes
+          @schedule.active.should == false
 
+          attributes = {"frequency"=>"hourly", "start"=>{"minutes"=>"15"}, "active" => 'true'}
+          @schedule.schedule = attributes
+          @schedule.active.should == true
+        end
+      end
+      
+      describe 'with active attribute not supplied' do
+        it 'should not change the attribute in the model' do
+          attributes = {"frequency"=>"hourly", "start"=>{"minutes"=>"15"}}
+          @schedule.active= true
+          @schedule.schedule = attributes
+          @schedule.active.should == true
+          
+          @schedule.active= false
+          @schedule.schedule = attributes
+          @schedule.active.should == false
+        end
+        
+      end
+    end
+    
+    context 'supplied start time has elapsed w/rt current interval' do
       describe 'with hourly frequency' do
         it "should advance the start time" do
           half_past_midnight = Time.iso8601("2011-05-09T00:30:00Z")
@@ -115,6 +161,7 @@ describe LucidWorks::Datasource::Schedule do
           
           @schedule.reference_time =          half_past_midnight
           @schedule.start_time.should_not ==  quarter_past_1_am
+          
           @schedule.schedule =                hourly_at_quarter_past
           @schedule.start_time.should ==      quarter_past_1_am
         end
@@ -128,6 +175,7 @@ describe LucidWorks::Datasource::Schedule do
           
           @schedule.reference_time =          today_at_noon
           @schedule.start_time.should_not ==  tomorrow_at_eleven_am
+          
           @schedule.schedule =                daily_at_11_am
           @schedule.start_time.should ==      tomorrow_at_eleven_am
         end
@@ -146,6 +194,7 @@ describe LucidWorks::Datasource::Schedule do
           
           @schedule.reference_time =          friday_of_this_week
           @schedule.start_time.should_not ==  wednesday_of_next_week
+          
           @schedule.schedule =                weekly_on_wednesday
           @schedule.start_time.should ==      wednesday_of_next_week
         end
@@ -208,4 +257,10 @@ describe LucidWorks::Datasource::Schedule do
       end
     end
   end
+
+  # context 'sub-time convenience accessors' do
+  #   describe '#hour' do
+  #     @schedule.start_time = Time.iso8601("2011-05-09T00:30:00Z")
+  #   end
+  # end
 end

metadata

@@ -2,7 +2,7 @@
 name: lucid_works
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.6.5
+  version: 0.6.6
 platform: ruby
 authors: 
 - Sam Pierson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-16 00:00:00 -07:00
+date: 2011-05-17 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency