ri_cal 0.5.2 → 0.5.3

data/History.txt

@@ -1,3 +1,6 @@
+=== 0.5.3 - 1 June, 2009
+ * Improved performance of time zone enumeration, TimeZonePeriod now caches occurrences
+ * Added a profiling directory which contains ruby programs which benchmark and/or profile performance
 === 0.5.2
  * Fixed http://rick_denatale.lighthouseapp.com/projects/30941/tickets/11
    Export folding is not UTF-8 Safe

data/Manifest.txt

@@ -89,6 +89,10 @@ lib/ri_cal/property_value/text.rb
 lib/ri_cal/property_value/uri.rb
 lib/ri_cal/property_value/utc_offset.rb
 lib/ri_cal/required_timezones.rb
+profiling/ical_files/profile3.ics
+profiling/profile1.rb
+profiling/profile2.rb
+profiling/profile3.rb
 ri_cal.gemspec
 sample_ical_files/from_ical_dot_app/test1.ics
 script/console

data/Rakefile

@@ -10,12 +10,13 @@ $hoe = Hoe.new('ri_cal', RiCal::VERSION) do |p|
   p.developer('author=Rick DeNatale', 'rick.denatale@gmail.com')
   p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
   # p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
-  p.rubyforge_name       = 'rical'
+  p.rubyforge_name       = 'ri-cal'
   # p.extra_deps         = [
   #   ['tzinfo','>= 2.0.2'],
   # ]
   p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"]
+    ['newgem', ">= #{::Newgem::VERSION}"],
+    'ruby-prof'
   ]
 
   p.clean_globs |= %w[**/.DS_Store tmp *.log]

data/lib/ri_cal.rb

@@ -4,6 +4,9 @@
 # and building calendars and calendar components.
 module RiCal
   
+  require 'stringio'
+  require 'rational'
+  
   my_dir =  File.dirname(__FILE__)
   
   autoload :Component, "#{my_dir}/ri_cal/component.rb"
@@ -11,7 +14,7 @@ module RiCal
   autoload :OccurrenceEnumerator, "#{my_dir}/ri_cal/occurrence_enumerator.rb"
   
   # :stopdoc:
-  VERSION = '0.5.2'
+  VERSION = '0.5.3'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
 
@@ -137,8 +140,36 @@ module RiCal
   def self.Todo(&init_block)
     Component::Todo.new(&init_block)
   end
+  
+  def self.ro_calls=(value)
+    @ro_calls = value
+  end
+  
+  def self.ro_calls
+    @ro_calls ||= 0
+  end
+  
+  def self.ro_misses=(value)
+    @ro_misses = value
+  end
+  
+  def self.ro_misses
+    @ro_misses ||= 0
+  end
+  
+  def self.RationalOffset
+    self.ro_calls += 1
+    @rational_offset ||= Hash.new {|h, seconds|
+      self.ro_misses += 1
+      h[seconds] = Rational(seconds, 86400)}
+  end
+
 end  # module RiCal
 
-RiCal.require_all_libs_relative_to(__FILE__)
+(-12..12).each do |hour_offset|
+  RiCal.RationalOffset[hour_offset * 86400]
+end
+
 
+RiCal.require_all_libs_relative_to(__FILE__)
 # EOF

data/lib/ri_cal/component/calendar.rb

@@ -140,7 +140,8 @@ module RiCal
 
 
         def rational_utc_offset(local)
-          Rational(tzinfo.period_for_local(local, true).utc_total_offset, 3600) / 24
+          # 86400 is the number of seconds in a day
+          RiCal.RationalOffset[tzinfo.period_for_local(local, true).utc_total_offset]
         end
 
       end

data/lib/ri_cal/component/timezone.rb

@@ -24,7 +24,8 @@ module RiCal
         end
         
         def rational_utc_offset(local) #:nodoc:
-          Rational(period_for_local(local, true).utc_total_offset, 3600) / 24
+          # 86400 is the number of seconds in a day
+          RiCal.RationalOffset[period_for_local(local, true).utc_total_offset]
         end
 
         # Returns the TimezonePeriod for the given UTC time. utc can either be a DateTime,

data/lib/ri_cal/component/timezone/timezone_period.rb

@@ -14,6 +14,10 @@ module RiCal
 
         include OccurrenceEnumerator
 
+        def occurrence_cache #:nodoc:
+          @occurrence_cache ||= []
+        end
+
         def zone_identifier #:nodoc:
           tzname.first
         end
@@ -25,7 +29,7 @@ module RiCal
         def exdate_property #:nodoc:
           nil
         end
-        
+
         def utc_total_offset #:nodoc:
           tzoffsetto_property.to_seconds
         end
@@ -38,13 +42,34 @@ module RiCal
           last_before_local(utc_time + tzoffsetfrom_property)
         end
 
+        def fill_cache(local_time)
+          if occurrence_cache.empty? || occurrence_cache.last.dtstart_property <= local_time
+            while true
+              occurrence = enumeration_instance.next_occurrence
+              break unless occurrence
+              occurrence = recurrence(occurrence)
+              occurrence_cache << occurrence
+              break if occurrence.dtstart_property > local_time
+            end
+          end
+        end
+
         def last_before_local(local_time) #:nodoc:
-          cand_occurrence = nil
-          each do |occurrence|
-            return cand_occurrence if occurrence.dtstart_property > local_time
-            cand_occurrence = occurrence
+          if recurs?
+            fill_cache(local_time)
+            cand_occurrence = nil
+            occurrence_cache.each do |occurrence|
+              return cand_occurrence if occurrence.dtstart_property > local_time
+              cand_occurrence = occurrence
+            end
+            return cand_occurrence
+          else
+            return self
           end
-          return cand_occurrence
+        end
+
+         def enumeration_instance
+          @enumeration_instance ||= super
         end
       end
     end

data/lib/ri_cal/component/todo.rb

@@ -13,6 +13,7 @@ module RiCal
     # to see the methods for enumerating occurrences of recurring to-dos see the RiCal::OccurrenceEnumerator module
     class Todo < Component
       include Properties::Todo
+      include OccurrenceEnumerator
 
       def self.entity_name #:nodoc:
         "VTODO"

data/lib/ri_cal/core_extensions/time/conversions.rb

@@ -52,7 +52,8 @@ module RiCal
           #   your_time = Time.parse("1/13/2009 1:13:03 P.M.")  # => Tue Jan 13 13:13:03 -0500 2009
           #   your_time.to_datetime                             # => Tue, 13 Jan 2009 13:13:03 -0500
           def to_datetime
-            ::DateTime.civil(year, month, day, hour, min, sec, Rational(utc_offset, 86400))
+            # 86400 is the number of seconds in a day
+            ::DateTime.civil(year, month, day, hour, min, sec, RiCal.RationalOffset[utc_offset])
           end
         end
       end

data/lib/ri_cal/floating_timezone.rb

@@ -15,7 +15,7 @@ module RiCal
     end
 
   def self.rational_utc_offset(local) #:nodoc:
-    Rational(0, 24)
+    @offset = RiCal.RationalOffset[0]
   end
 
     # Return the time unchanged

data/lib/ri_cal/occurrence_enumerator.rb

@@ -5,7 +5,7 @@ module RiCal
   # OccurrenceEnumerator provides common methods for CalendarComponents that support recurrence
   # i.e. Event, Journal, Todo, and TimezonePeriod
   module OccurrenceEnumerator
-    
+
     include Enumerable
 
     def default_duration # :nodoc:
@@ -20,17 +20,17 @@ module RiCal
       def self.next_occurrence
         nil
       end
-      
+
       def self.bounded?
         true
       end
-      
+
       def self.empty?
         true
       end
     end
-    
-    # OccurrenceMerger takes multiple recurrence rules and enumerates the combination in sequence. 
+
+    # OccurrenceMerger takes multiple recurrence rules and enumerates the combination in sequence.
     class OccurrenceMerger # :nodoc:
       def self.for(component, rules)
         if rules.nil? || rules.empty?
@@ -41,20 +41,20 @@ module RiCal
           new(component, rules)
         end
       end
-      
+
       attr_accessor :enumerators, :nexts
-      
+
       def initialize(component, rules)
         self.enumerators = rules.map {|rrule| rrule.enumerator(component)}
         @bounded = enumerators.all? {|enumerator| enumerator.bounded?}
         @empty = enumerators.all? {|enumerator| enumerator.empty?}
         self.nexts = @enumerators.map {|enumerator| enumerator.next_occurrence}
       end
-      
+
       def empty?
         @empty
       end
-      
+
       # return the earliest of each of the enumerators next occurrences
       def next_occurrence
         result = nexts.compact.sort.first
@@ -63,25 +63,22 @@ module RiCal
         end
         result
       end
-      
+
       def bounded?
         @bounded
       end
     end
-    
+
     # EnumerationInstance holds the values needed during the enumeration of occurrences for a component.
     class EnumerationInstance # :nodoc:
       include Enumerable
-      
-      def initialize(component, options = {})
+
+      def initialize(component)
         @component = component
-        @start = options[:starting]
-        @cutoff = options[:before]
-        @count = options[:count]
         @rrules = OccurrenceMerger.for(@component, [@component.rrule_property, @component.rdate_property].flatten.compact)
         @exrules = OccurrenceMerger.for(@component, [@component.exrule_property, @component.exdate_property].flatten.compact)
       end
-      
+
       # return the next exclusion which starts at the same time or after the start time of the occurrence
       # return nil if this exhausts the exclusion rules
       def exclusion_for(occurrence)
@@ -96,48 +93,76 @@ module RiCal
       def exclusion_match?(occurrence, exclusion)
         exclusion && (occurrence.dtstart == exclusion.dtstart)
       end
-      
+
       # Also exclude occurrences before the :starting date_time
-      def exclude?(occurrence)
-        exclusion_match?(occurrence, exclusion_for(occurrence)) ||
-          (@start && occurrence.dtstart.to_datetime < @start)
+      def before_start?(occurrence)
+        (@start && occurrence.dtstart.to_datetime < @start)
+      end
+
+      def next_occurrence
+        @yielded ||= 0
+        @next_exclusion ||= @exrules.next_occurrence
+        occurrence = nil
+
+        until occurrence
+          if (occurrence = @rrules.next_occurrence)
+            if exclusion_match?(occurrence, exclusion_for(occurrence))
+              occurrence = nil # Look for the next one
+            end
+          else
+            break
+          end
+        end
+        occurrence
+      end
+
+      def options_stop(occurrence)
+        occurrence != :excluded &&
+        (@cutoff && occurrence.dtstart.to_datetime >= @cutoff) || (@count && @yielded >= @count)
       end
-      
+
+
       # yield each occurrence to a block
-      # some components may be open-ended, e.g. have no COUNT or DTEND 
-      def each
+      # some components may be open-ended, e.g. have no COUNT or DTEND
+      def each(options = nil)
+        process_options(options) if options
         if @rrules.empty?
           yield @component
         else
-          occurrence = @rrules.next_occurrence
-          yielded = 0
-          @next_exclusion = @exrules.next_occurrence
+          occurrence = next_occurrence
           while (occurrence)
-            if (@cutoff && occurrence.dtstart.to_datetime >= @cutoff) || (@count && yielded >= @count)
+            if options_stop(occurrence)
               occurrence = nil
             else
-              unless exclude?(occurrence)
-                yielded += 1
+              unless before_start?(occurrence)
+                @yielded += 1
                 yield @component.recurrence(occurrence)
               end
-              occurrence = @rrules.next_occurrence
+              occurrence = next_occurrence
             end
           end
         end
       end
-      
+
       def bounded?
         @rrules.bounded? || @count || @cutoff
       end
-      
-      def to_a
+
+      def process_options(options)
+        @start = options[:starting]
+        @cutoff = options[:before]
+        @count = options[:count]
+      end
+
+      def to_a(options = {})
+        process_options(options)
         raise ArgumentError.new("This component is unbounded, cannot produce an array of occurrences!") unless bounded?
-        super
+        super()
       end
-      
+
       alias_method :entries, :to_a
     end
-    
+
     # return an array of occurrences according to the options parameter.  If a component is not bounded, and
     # the number of occurrences to be returned is not constrained by either the :before, or :count options
     # an ArgumentError will be raised.
@@ -148,22 +173,27 @@ module RiCal
     #
     # parameter options:
     # * :starting:: a Date, Time, or DateTime, no occurrences starting before this argument will be returned
-    # * :before:: a Date, Time, or DateTime, no occurrences starting on or after this argument will be returned. 
+    # * :before:: a Date, Time, or DateTime, no occurrences starting on or after this argument will be returned.
     # * :count:: an integer which limits the number of occurrences returned.
     def occurrences(options={})
-      EnumerationInstance.new(self, options).to_a    
+      enumeration_instance.to_a(options)
     end
-    
+
+    # TODO: Thread safe?
+    def enumeration_instance #:nodoc:
+      EnumerationInstance.new(self)
+    end
+
     # execute the block for each occurrence
     def each(&block) # :yields: Component
-      EnumerationInstance.new(self).each(&block)
+      enumeration_instance.each(&block)
     end
-    
+
     # A predicate which determines whether the component has a bounded set of occurrences
     def bounded?
-      EnumerationInstance.new(self).bounded?
+      enumeration_instance.bounded?
     end
-    
+
     # Return a array whose first element is a UTC DateTime representing the start of the first
     # occurrence, and whose second element is a UTC DateTime representing the end of the last
     # occurrence.
@@ -182,7 +212,7 @@ module RiCal
       end
       [first.zulu_occurrence_range_start_time, last ? last.zulu_occurrence_range_finish_time : nil]
     end
-    
+
     def set_occurrence_properties!(occurrence) # :nodoc:
       occurrence_end = occurrence.dtend
       occurrence_start = occurrence.dtstart
@@ -196,11 +226,16 @@ module RiCal
       end
       @dtstart_property = dtstart_property.for_occurrence(occurrence_start)
       @dtend_property = dtend_property.for_occurrence(occurrence_end) if @dtend_property
-      self      
+      self
     end
-    
+
     def recurrence(occurrence) # :nodoc:
       result = self.dup.set_occurrence_properties!(occurrence)
     end
+    
+    def recurs?
+      @rrule_property && @rrule_property.length > 0 || @rdate_property && @rdate_property.length > 0
+    end
+
   end
 end