icalendar 2.5.3 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cc6bb6eba99ce8e25232bb417cb9f3c5e9438b20a56a4a136e9b0d2f9a71b7c
-  data.tar.gz: f9022e04c0aad637791e0c964f6c27eef986f610bc2417c5f70b85ec65275445
+  metadata.gz: 165b0d4192335c7fb36354195666ea4d386d63029190d7c1248ab3d4fe1554ec
+  data.tar.gz: 3781a361f70f099aff7e891e7f3bc26eaaac059c615a40d377634d41d4905d3c
 SHA512:
-  metadata.gz: 2bd684301596f90024af2a690f7cbc20bdba2d02a902105fddc298a4108ac23825d444c2658dace796146cc0581c88ef2c6e62e229d4fa89ff2e89d8ac41eadb
-  data.tar.gz: e62e5f8f4fe3983d19cf213c505fe8f9f002cf7e0b1054a958af4874eddaf376b80660a3e3d1b6cac50cab96a0535169738adf443f5fcc982c318750f5f16200
+  metadata.gz: 682932f688906567e95fc58b4952b05664e9eeece75708bd83c1ebc42362e927a252f77a8124bf028500359e23aa1d7b071b9af5ccf1032d92074c29cecd6f3f
+  data.tar.gz: 38a5153c80c3b170c2d973104f565d3e0ff5a3c74b8573870331cc842e23e2918de712b6a0046cecb758a1aa3450c72f4aedaa2f22bb302a7343332f2c0a017a

data/.gitignore

@@ -6,3 +6,4 @@ pkg/
 .bundle
 coverage/
 tags
+.idea

data/.travis.yml

@@ -6,15 +6,11 @@ rvm:
   - 2.6
   - 2.5
   - 2.4
-  - 2.3
-  - 2.2
   - jruby-19mode
-  - rbx-3
   - ruby-head
   - jruby-head
 matrix:
   allow_failures:
-    - rvm: 2.2
     - rvm: ruby-head
     - rvm: jruby-head
 script: bundle exec rake spec

data/History.txt

@@ -1,3 +1,9 @@
+=== 2.6.0 2019-11-26
+ * Improve performance for calculating timezone offsets - Justin Howard
+ * Make it possible to de/serialize with Marshal - Pawel Niewiadomski
+ * Avoid FrozenError when running with frozen_string_literal
+ * Update minimum Ruby version to supported versions
+
 === 2.5.3 2019-03-04
  * Improve parsing performance - nehresma
  * Support tzinfo 2.0 - Misty De Meo

data/icalendar.gemspec

@@ -24,7 +24,7 @@ ActiveSupport is required for TimeWithZone support, but not required for general
   s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename f }
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 2.2.0'
+  s.required_ruby_version = '>= 2.4.0'
 
   s.add_dependency 'ice_cube', '~> 0.16'
 

data/lib/icalendar.rb

@@ -22,6 +22,7 @@ end
 
 require 'icalendar/has_properties'
 require 'icalendar/has_components'
+require 'icalendar/marshable'
 require 'icalendar/component'
 require 'icalendar/value'
 require 'icalendar/alarm'

data/lib/icalendar/has_components.rb

@@ -10,7 +10,7 @@ module Icalendar
     end
 
     def initialize(*args)
-      @custom_components = Hash.new { |h, k| h[k] = [] }
+      @custom_components = Hash.new
       super
     end
 
@@ -26,7 +26,7 @@ module Icalendar
       if method_name =~ /^add_(x_\w+)$/
         component_name = $1
         custom = args.first || Component.new(component_name, component_name.upcase)
-        custom_components[component_name] << custom
+        (custom_components[component_name] ||= []) << custom
         yield custom if block_given?
         custom
       else

data/lib/icalendar/has_properties.rb

@@ -10,7 +10,7 @@ module Icalendar
     end
 
     def initialize(*args)
-      @custom_properties = Hash.new { |h, k| h[k] = [] }
+      @custom_properties = Hash.new
       super
     end
 
@@ -39,7 +39,7 @@ module Icalendar
     end
 
     def custom_property(property_name)
-      custom_properties[property_name.downcase]
+      custom_properties[property_name.downcase] || []
     end
 
     def append_custom_property(property_name, value)
@@ -49,9 +49,9 @@ module Icalendar
       elsif self.class.multiple_properties.include? property_name
         send "append_#{property_name}", value
       elsif value.is_a? Icalendar::Value
-        custom_properties[property_name] << value
+        (custom_properties[property_name] ||= []) << value
       else
-        custom_properties[property_name] << Icalendar::Values::Text.new(value)
+        (custom_properties[property_name] ||= []) << Icalendar::Values::Text.new(value)
       end
     end
 

data/lib/icalendar/marshable.rb

@@ -0,0 +1,34 @@
+module Icalendar
+  module Marshable
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def marshal_dump
+      instance_variables
+        .reject { |ivar| self.class.transient_variables.include?(ivar) }
+        .each_with_object({}) do |ivar, serialized|
+
+        serialized[ivar] = instance_variable_get(ivar)
+      end
+    end
+
+    def marshal_load(serialized)
+      serialized.each do |ivar, value|
+        unless self.class.transient_variables.include?(ivar)
+          instance_variable_set(ivar, value)
+        end
+      end
+    end
+
+    module ClassMethods
+      def transient_variables
+        @transient_variables ||= [:@transient_variables]
+      end
+
+      def transient_variable(name)
+        transient_variables.push(name.to_sym)
+      end
+    end
+  end
+end

data/lib/icalendar/timezone.rb

@@ -14,10 +14,40 @@ module Icalendar
           optional_property :comment
           optional_property :rdate, Icalendar::Values::DateTime
           optional_property :tzname
+
+          transient_variable :@cached_occurrences
+          transient_variable :@occurrences
         end
       end
+
+      def occurrences
+        @occurrences ||= IceCube::Schedule.new(dtstart.to_time) do |s|
+          rrule.each do |rule|
+            s.add_recurrence_rule IceCube::Rule.from_ical(rule.value_ical)
+          end
+          rdate.each do |date|
+            s.add_recurrence_time date.to_time
+          end
+        end.all_occurrences_enumerator
+      end
+
+      def previous_occurrence(from)
+        from = IceCube::TimeUtil.match_zone(from, dtstart.to_time)
+
+        @cached_occurrences ||= []
+        while @cached_occurrences.empty? || @cached_occurrences.last <= from
+          begin
+            @cached_occurrences << occurrences.next
+          rescue StopIteration
+            break
+          end
+        end
+
+        @cached_occurrences.reverse_each.find { |occurrence| occurrence < from }
+      end
     end
     class Daylight < Component
+      include Marshable
       include TzProperties
 
       def initialize
@@ -25,6 +55,7 @@ module Icalendar
       end
     end
     class Standard < Component
+      include Marshable
       include TzProperties
 
       def initialize
@@ -75,30 +106,14 @@ module Icalendar
 
     def standard_for(local)
       possible = standards.map do |std|
-        schedule = IceCube::Schedule.new(std.dtstart.to_time) do |s|
-          std.rrule.each do |rule|
-            s.add_recurrence_rule IceCube::Rule.from_ical(rule.value_ical)
-          end
-          std.rdate.each do |date|
-            s.add_recurrence_time date.to_time
-          end
-        end
-        [schedule.previous_occurrence(local.to_time), std]
+        [std.previous_occurrence(local.to_time), std]
       end
       possible.sort_by(&:first).last
     end
 
     def daylight_for(local)
       possible = daylights.map do |day|
-        schedule = IceCube::Schedule.new(day.dtstart.to_time) do |s|
-          day.rrule.each do |rule|
-            s.add_recurrence_rule IceCube::Rule.from_ical(rule.value_ical)
-          end
-          day.rdate.each do |date|
-            s.add_recurrence_time date.to_time
-          end
-        end
-        [schedule.previous_occurrence(local.to_time), day]
+        [day.previous_occurrence(local.to_time), day]
       end
       possible.sort_by(&:first).last
     end

data/lib/icalendar/values/utc_offset.rb

@@ -37,8 +37,7 @@ module Icalendar
       end
 
       def parse_fields(value)
-        value.gsub!(/\s+/, '')
-        md = /\A(?<behind>[+-])(?<hours>\d{2})(?<minutes>\d{2})(?<seconds>\d{2})?\z/.match value
+        md = /\A(?<behind>[+-])(?<hours>\d{2})(?<minutes>\d{2})(?<seconds>\d{2})?\z/.match value.gsub(/\s+/, '')
         {
           behind: (md[:behind] == '-'),
           hours: md[:hours].to_i,

data/lib/icalendar/version.rb

@@ -1,5 +1,5 @@
 module Icalendar
 
-  VERSION = '2.5.3'
+  VERSION = '2.6.0'
 
 end

data/spec/calendar_spec.rb

@@ -2,6 +2,12 @@ require 'spec_helper'
 
 describe Icalendar::Calendar do
 
+  context 'marshalling' do
+    it 'can be de/serialized' do
+      Marshal.load(Marshal.dump(subject))
+    end
+  end
+
   context 'values' do
     let(:property) { 'my-value' }
 

data/spec/event_spec.rb

@@ -113,6 +113,13 @@ describe Icalendar::Event do
     end
   end
 
+  describe "#custom_property" do
+    it "returns a default for missing properties" do
+      expect(subject.x_doesnt_exist).to eq([])
+      expect(subject.custom_property "x_doesnt_exist").to eq([])
+    end
+  end
+
   describe '.parse' do
     let(:source) { File.read File.join(File.dirname(__FILE__), 'fixtures', fn) }
     let(:fn) { 'event.ics' }

data/spec/timezone_spec.rb

@@ -28,4 +28,52 @@ describe Icalendar::Timezone do
       it { should_not be_valid }
     end
   end
+
+  context 'marshalling' do
+    context 'with standard/daylight components' do
+      before do
+        subject.standard do |standard|
+          standard.rrule = Icalendar::Values::Recur.new("FREQ=YEARLY;INTERVAL=1;BYDAY=-1SU;BYMONTH=10")
+          standard.dtstart = Icalendar::Values::DateTime.new("16010101T030000")
+          standard.tzoffsetfrom = Icalendar::Values::UtcOffset.new("+0200")
+          standard.tzoffsetto = Icalendar::Values::UtcOffset.new("+0100")
+        end
+
+        subject.daylight do |daylight|
+          daylight.rrule = Icalendar::Values::Recur.new("FREQ=YEARLY;INTERVAL=1;BYDAY=-1SU;BYMONTH=3")
+          daylight.dtstart = Icalendar::Values::DateTime.new("16010101T020000")
+          daylight.tzoffsetfrom = Icalendar::Values::UtcOffset.new("+0100")
+          daylight.tzoffsetto = Icalendar::Values::UtcOffset.new("+0200")
+        end
+      end
+
+      it 'can be de/serialized' do
+        first_standard = subject.standards.first
+        first_daylight = subject.daylights.first
+
+        expect(first_standard.valid?).to be_truthy
+        expect(first_daylight.valid?).to be_truthy
+
+        # calling previous_occurrence intializes @cached_occurrences with a time that's not handled by ruby marshaller
+        first_occurence_for = Time.new(1601, 10, 31)
+
+        standard_previous_occurrence = first_standard.previous_occurrence(first_occurence_for)
+        expect(standard_previous_occurrence).not_to be_nil
+
+        daylight_previous_occurrence = first_daylight.previous_occurrence(first_occurence_for)
+        expect(daylight_previous_occurrence).not_to be_nil
+
+        deserialized = nil
+
+        expect { deserialized = Marshal.load(Marshal.dump(subject)) }.not_to raise_exception
+
+        expect(deserialized.standards.first.previous_occurrence(first_occurence_for)).to eq(standard_previous_occurrence)
+        expect(deserialized.daylights.first.previous_occurrence(first_occurence_for)).to eq(daylight_previous_occurrence)
+      end
+    end
+
+    it 'can be de/serialized' do
+      expect { Marshal.load(Marshal.dump(subject)) }.not_to raise_exception
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icalendar
 version: !ruby/object:Gem::Version
-  version: 2.5.3
+  version: 2.6.0
 platform: ruby
 authors:
 - Ryan Ahearn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-05 00:00:00.000000000 Z
+date: 2019-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ice_cube
@@ -180,6 +180,7 @@ files:
 - lib/icalendar/has_properties.rb
 - lib/icalendar/journal.rb
 - lib/icalendar/logger.rb
+- lib/icalendar/marshable.rb
 - lib/icalendar/parser.rb
 - lib/icalendar/timezone.rb
 - lib/icalendar/timezone_store.rb
@@ -253,14 +254,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A ruby implementation of the iCalendar specification (RFC-5545).