lucid_works 0.6.6 → 0.6.7

data/lib/lucid_works/datasource/schedule.rb

@@ -1,6 +1,19 @@
 module LucidWorks
   class Datasource
 
+    #
+    # Datasource::Schedule supplies numerous convenience methods to make it easy and clean to
+    # display and set schedules in simple formats
+    #
+    # The simple formats supported are:
+    #    hourly at 15 minutes past the hour # => {:frequency => 'hourly', :start => {:minutes => 15}}
+    #    daily at 3:15                      # => {:frequency => 'daily', :start => {:hours => 3, :minutes => 15}}
+    #    weekly at 3:15 on Tuesday          # => {:frequency => 'weekly', :start => {:days => 1, :hours => 3, :minutes => 15}}
+    #
+    # Notes:
+    #   day of week is specified as the # of days from Monday b/c Rails day of week helpers are monday-based
+    #   :start hash options keys are pluralized b/c we feed them direcly to Time.advance, e.g. Time.now.advance(:days => 3)
+    #
     class Schedule < Base
       self.singleton = true
       belongs_to :datasource
@@ -8,10 +21,14 @@ module LucidWorks
       schema do
         attribute :period
         attribute :start_time, :iso8601
-        attribute :active
+        attribute :active, :boolean
         attribute :type
       end
       
+      #
+      # returns hourly, daily, weekly based on period
+      # returns custom if it doesn't fit a supported interval
+      #
       def frequency
         case period
         when 1.weeks.seconds then 'weekly'
@@ -22,6 +39,9 @@ module LucidWorks
         end
       end
       
+      #
+      # accepts hourly, daily, weekly, and sets period to respective # of seconds
+      #
       def frequency=(frequency)
         self.period = case frequency
         when 'hourly' then 1.hours.seconds
@@ -31,7 +51,9 @@ module LucidWorks
         end
       end
       
+      #
       # predict when action will occur next if active at that time
+      #
       def next_start
         return start_time if reference_time <= start_time 
         # require 'ruby-debug'; debugger
@@ -47,8 +69,10 @@ module LucidWorks
         end
         start_time + period * next_interval_num
       end
-            
+      
+      #
       # Provide ability to override "now" explicitly for testing purposes
+      #
       def reference_time=(time); @reference_time = time; end
       def reference_time; @reference_time || Time.now.localtime; end
       
@@ -84,9 +108,7 @@ module LucidWorks
         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.active = all_attributes['active']  if all_attributes.keys.include?('active')
         
         self.frequency = all_attributes['frequency']
         self.start_time = 
@@ -107,18 +129,44 @@ module LucidWorks
           end
       end
 
+      #
+      # convenince method for setting the current value in a view selector
+      #
       def hour
         self.start_time.localtime.hour rescue nil
       end
       
+      #
+      # convenince method for setting the current value in a view selector
+      #
       def min
         self.start_time.localtime.min rescue nil
       end
       
+      #
+      # convenince method for setting the current value in a view selector
+      #
       def day_of_week
-        # subract 1 because '%u' returns 1-7, and this is for indexing a ruby array of day names
+        # subract 1 because '%u' returns 1-7, and this is working with zero-indexed ruby arrays
         self.start_time.localtime.strftime('%u').to_i - 1 rescue nil
       end
+      
+      def start_is_more_than_one_period_in_the_future?
+        # This works fine with start times that are multiple periods in the past
+        # because that gives a negative difference, and period is always >= 0
+          (self.start_time - self.reference_time) > self.period 
+      end
+      
+      #
+      # convenience method for detecting whether schedule can be represented in simple format
+      # or should be described as custom (meaning it is beyond the capabilities of the convenience methods)
+      #
+        def custom?
+          return true if self.frequency == 'custom'
+          return false unless self.start_time
+          return true if self.start_is_more_than_one_period_in_the_future?
+          return false
+        end
     end
   end
 end

data/lib/lucid_works/version.rb

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

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

@@ -258,9 +258,91 @@ describe LucidWorks::Datasource::Schedule do
     end
   end
 
-  # context 'sub-time convenience accessors' do
-  #   describe '#hour' do
-  #     @schedule.start_time = Time.iso8601("2011-05-09T00:30:00Z")
-  #   end
-  # end
+  context 'sub-time convenience accessors' do
+    describe '#hour' do
+      it 'should return the hour component of the time' do
+        @schedule.start_time = Time.new(2011, 4, 15, 13, 11, 56)
+        @schedule.hour.should == 13
+      end
+      
+      it 'should return nil if start_time == nil' do
+        @schedule.start_time = nil
+        @schedule.hour.should == nil
+      end
+    end
+
+    describe '#min' do
+      it 'should return the minute component of the time' do
+        @schedule.start_time = Time.new(2011, 4, 15, 13, 11, 56)
+        @schedule.min.should == 11
+      end
+      
+      it 'should return nil if start_time == nil' do
+        @schedule.start_time = nil
+        @schedule.min.should == nil
+      end
+    end
+
+    describe '#day_of_week' do
+      it 'should return the week component of the time' do
+        @schedule.start_time = Time.new(2011, 4, 15, 13, 11, 56)
+        @schedule.day_of_week.should == 4
+      end
+      
+      it 'should return nil if start_time == nil' do
+        @schedule.start_time = nil
+        @schedule.day_of_week.should == nil
+      end
+    end
+  end
+
+  describe '#custom?' do
+    context 'schedule can not be represent as simple weekly/daily/hourly' do
+      it 'should be true if frequency is non-standard' do
+        @schedule.period = 1
+        @schedule.should be_custom
+      end
+    
+      it 'should be true if period is standard but start_time is > 1 period from now' do
+        some_random_time = Time.new(2011, 4, 15, 13, 11, 56)
+        more_than_a_day_later = some_random_time.advance(:days => 2) 
+        
+        @schedule.reference_time = some_random_time
+        @schedule.frequency = 'daily'
+        @schedule.start_time = more_than_a_day_later
+
+        @schedule.should be_custom
+      end
+    end
+    
+    context 'schedule can be represent as simple weekly/daily/hourly' do
+      it 'should be false if period is standard and start_time is within period from now' do
+        half_past_midnight = Time.iso8601("2011-05-09T00:30:00Z")
+        a_standard_schedule = {"frequency"=>"hourly", "start"=>{"minutes"=>"15"}}
+        a_standard_reference_time = Time.iso8601('2011-05-09T01:15:00Z')
+        
+        @schedule.reference_time =          a_standard_reference_time        
+        @schedule.schedule =                a_standard_schedule
+        
+        @schedule.should_not be_custom
+      end
+      
+      it 'should be false if period is standard and start time is > 1 period in the past' do
+        some_random_time = Time.new(2011, 4, 15, 13, 11, 56)
+        more_than_a_day_ago = some_random_time.advance(:days => -2) 
+        @schedule.reference_time = some_random_time
+        @schedule.frequency = 'daily'
+        @schedule.start_time = more_than_a_day_ago
+
+        @schedule.should_not be_custom
+      end
+
+    end
+
+    it 'should be false if the start_time is nil and frequency is standard' do
+      @schedule.start_time = nil
+      @schedule.frequency = 'weekly'
+      @schedule.should_not be_custom
+    end
+  end
 end

metadata

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