icalendar 2.9.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f083428b61c781e197d459b5ba375139056f75e95b1b99e596169106a57ed20
-  data.tar.gz: acb3cdb07b0dc052664fc67619fa6301951daf70ac83a0430a839a0bdd3a5923
+  metadata.gz: 4a4c654b36ffe5a09f521ad3c012686f12e582ba5d380242c646334f47153360
+  data.tar.gz: 184399a11e6e8a39b18ceeef59de8a9b9f7cd581f0c7169cce5c7dca63575e3b
 SHA512:
-  metadata.gz: 595032415b8465be6f662f136a56dd6f4dd8af27e888c7a7b27ad1c688b3963466e34a949daa0111a65ea89037b33ea01d8f2ea24991f5d9a3869647521b6c7c
-  data.tar.gz: ac464077d0c421d27b39270f1d12af23b59383e3e8351b68ec41a8385cc26670ca31b2f8dba72212e8db0996ea4a9e7c4a1b7b6a9b1b34d632169fae5a715725
+  metadata.gz: 61837b5d19193d80d72f37edff89290fc2e5ffa0c6b9ee500036de58b0fbd9aacb5e0e9bc9f1a0a4e1ce7a3ad494ed0147e87bf697b54523d8b799e9eaa275fa
+  data.tar.gz: 00d54cc0ab4b7fc6acf616a537b426d110ddbe65dda1d6ab8ec938ba2df64e87def99023916c6193ab25d1885a2a60e8a1706617ed5a6e0adb5cb34671dae1ec

data/.github/workflows/main.yml

@@ -17,13 +17,12 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - 2.7.6
-          - 3.0.4
-          - 3.1.2
+          - 3.0.6
+          - 3.1.4
           - 3.2.2
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/History.txt

@@ -1,5 +1,10 @@
 === Unreleased
 
+=== 2.10.0 2023-11-01
+ * Add changelog metadata to gemspec - Juri Hahn
+ * Attempt to rescue timezone info when given a nonstandard tzid with no VTIMEZONE
+ * Move Values classes that shouldn't be directly used into Helpers module
+
 === 2.9.0 2023-08-11
  * Always include the VALUE of Event URLs for improved compatibility - Sean Kelley
  * Improved parse performance - Thomas Cannon

data/icalendar.gemspec

@@ -20,6 +20,10 @@ variety of calendaring applications.
 ActiveSupport is required for TimeWithZone support, but not required for general use.
   EOM
 
+  s.metadata = {
+    'changelog_uri' => 'https://github.com/icalendar/icalendar/blob/main/History.txt'
+  }
+
   s.files = `git ls-files`.split "\n"
   s.test_files = `git ls-files -- {test,spec,features}/*`.split "\n"
   s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename f }

data/lib/icalendar/has_properties.rb

@@ -148,7 +148,7 @@ module Icalendar
 
         define_method "#{prop}=" do |value|
           mapped = map_property_value value, klass, true, new_property
-          if mapped.is_a? Icalendar::Values::Array
+          if mapped.is_a? Icalendar::Values::Helpers::Array
             instance_variable_set property_var, mapped.to_a.compact
           else
             instance_variable_set property_var, [mapped].compact
@@ -179,7 +179,7 @@ module Icalendar
       if value.nil? || value.is_a?(Icalendar::Value)
         value
       elsif value.is_a? ::Array
-        Icalendar::Values::Array.new value, klass, params, {delimiter: (multi_valued ? ',' : ';')}
+        Icalendar::Values::Helpers::Array.new value, klass, params, {delimiter: (multi_valued ? ',' : ';')}
       else
         klass.new value, params
       end

data/lib/icalendar/parser.rb

@@ -84,7 +84,7 @@ module Icalendar
       klass = get_wrapper_class component, fields
       if wrap_in_array? klass, fields[:value], multi_property
         delimiter = fields[:value].match(WRAP_PROPERTY_VALUE_DELIMETER_REGEX)[1]
-        Icalendar::Values::Array.new fields[:value].split(WRAP_PROPERTY_VALUE_SPLIT_REGEX),
+        Icalendar::Values::Helpers::Array.new fields[:value].split(WRAP_PROPERTY_VALUE_SPLIT_REGEX),
                                      klass,
                                      fields[:params],
                                      delimiter: delimiter

data/lib/icalendar/value.rb

@@ -72,7 +72,7 @@ module Icalendar
 end
 
 # helpers; not actual iCalendar value type
-require_relative 'values/array'
+require_relative 'values/helpers/array'
 require_relative 'values/date_or_date_time'
 
 # iCalendar value types

data/lib/icalendar/values/date_time.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 require 'date'
-require_relative 'time_with_zone'
+require_relative 'helpers/time_with_zone'
 
 module Icalendar
   module Values
 
     class DateTime < Value
-      include TimeWithZone
+      include Helpers::TimeWithZone
 
       FORMAT = '%Y%m%dT%H%M%S'
 

data/lib/icalendar/values/helpers/active_support_time_with_zone_adapter.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Icalendar
+  module Values
+    module Helpers 
+      class ActiveSupportTimeWithZoneAdapter < ActiveSupport::TimeWithZone
+        # ActiveSupport::TimeWithZone implements a #to_a method that will cause
+        # unexpected behavior in components with multi_property DateTime
+        # properties when the setters for those properties are invoked with an
+        # Icalendar::Values::DateTime that is delegating for an
+        # ActiveSupport::TimeWithZone. To avoid this behavior, undefine #to_a.
+        undef_method :to_a
+      end
+    end
+  end
+end

data/lib/icalendar/values/helpers/array.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Icalendar
+  module Values
+    module Helpers
+
+      class Array < Value
+
+        attr_reader :value_delimiter
+
+        def initialize(value, klass, params = {}, options = {})
+          @value_delimiter = options[:delimiter] || ','
+          mapped = if value.is_a? ::Array
+                    value.map do |v|
+                      if v.is_a? Icalendar::Values::Helpers::Array
+                        Icalendar::Values::Helpers::Array.new v.value, klass, v.ical_params, delimiter: v.value_delimiter
+                      elsif v.is_a? ::Array
+                        Icalendar::Values::Helpers::Array.new v, klass, params, delimiter: value_delimiter
+                      elsif v.is_a? Icalendar::Value
+                        v
+                      else
+                        klass.new v, params
+                      end
+                    end
+                  else
+                    [klass.new(value, params)]
+                  end
+          super mapped
+        end
+
+        def params_ical
+          value.each do |v|
+            ical_params.merge! v.ical_params
+          end
+          super
+        end
+
+        def value_ical
+          value.map do |v|
+            v.value_ical
+          end.join value_delimiter
+        end
+
+        def valid?
+          klass = value.first.class
+          !value.all? { |v| v.class == klass }
+        end
+
+        def value_type
+          value.first.value_type
+        end
+
+        private
+
+        def needs_value_type?(default_type)
+          value.first.class != default_type
+        end
+      end
+
+    end
+  end
+end

data/lib/icalendar/values/helpers/time_with_zone.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+begin
+  require 'active_support/time'
+
+  if defined?(ActiveSupport::TimeWithZone)
+    require_relative 'active_support_time_with_zone_adapter'
+  end
+rescue NameError
+  # ActiveSupport v7+ needs the base require to be run first before loading
+  # specific parts of it.
+  # https://guides.rubyonrails.org/active_support_core_extensions.html#stand-alone-active-support
+  require 'active_support'
+  retry
+rescue LoadError
+  # tis ok, just a bit less fancy
+end
+
+module Icalendar
+  module Values
+    module Helpers
+      module TimeWithZone
+        attr_reader :tz_utc
+
+        def initialize(value, params = {})
+          params = Icalendar::DowncasedHash(params)
+          @tz_utc = params['tzid'] == 'UTC'
+          x_tz_info = params.delete 'x-tz-info'
+
+          offset_value = unless params['tzid'].nil?
+            tzid = params['tzid'].is_a?(::Array) ? params['tzid'].first : params['tzid']
+            support_classes_defined = defined?(ActiveSupport::TimeZone) && defined?(ActiveSupportTimeWithZoneAdapter)
+            if support_classes_defined && (tz = ActiveSupport::TimeZone[tzid])
+              # plan a - use ActiveSupport::TimeWithZone
+              ActiveSupportTimeWithZoneAdapter.new(nil, tz, value)
+            elsif !x_tz_info.nil?
+              # plan b - use definition from provided `VTIMEZONE`
+              offset = x_tz_info.offset_for_local(value).to_s
+              if value.respond_to?(:change)
+                value.change offset: offset
+              else
+                ::Time.new value.year, value.month, value.day, value.hour, value.min, value.sec, offset
+              end
+            elsif support_classes_defined && (tz = ActiveSupport::TimeZone[tzid.split.first])
+              # plan c - try to find an ActiveSupport::TimeWithZone based on the first word of the tzid
+              params['tzid'] = [tz.tzinfo.name]
+              ActiveSupportTimeWithZoneAdapter.new(nil, tz, value)
+            end
+            # plan d - just ignore the tzid
+          end
+          super((offset_value || value), params)
+        end
+
+        def params_ical
+          ical_params.delete 'tzid' if tz_utc
+          super
+        end
+      end
+    end
+  end
+end

data/lib/icalendar/values/time.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 require 'date'
-require_relative 'time_with_zone'
+require_relative 'helpers/time_with_zone'
 
 module Icalendar
   module Values
 
     class Time < Value
-      include TimeWithZone
+      include Helpers::TimeWithZone
 
       FORMAT = '%H%M%S'
 

data/lib/icalendar/version.rb

@@ -2,6 +2,6 @@
 
 module Icalendar
 
-  VERSION = '2.9.0'
+  VERSION = '2.10.0'
 
 end

data/spec/roundtrip_spec.rb

@@ -14,7 +14,7 @@ describe Icalendar do
       event = Icalendar::Event.new
       parsed = Icalendar::Calendar.parse(source).first
       event.rdate = parsed.events.first.rdate
-      expect(event.rdate.first).to be_kind_of Icalendar::Values::Array
+      expect(event.rdate.first).to be_kind_of Icalendar::Values::Helpers::Array
       expect(event.rdate.first.params_ical).to eq ";TZID=US-Mountain"
     end
   end

data/spec/values/date_time_spec.rb

@@ -27,6 +27,22 @@ describe Icalendar::Values::DateTime do
           expect(subject.value.utc.hour).to eq 23
         end
       end
+
+      context 'nonstandard format tzid local time' do
+        let(:value) { '20230901T230404' }
+        let(:params) { {'tzid' => 'Singapore Standard Time'} }
+
+        it 'parses the value as local time' do
+          expect(subject.value.hour).to eq 23
+          expect(subject.value.utc_offset).to eq 28800
+          expect(subject.value.utc.hour).to eq 15
+        end
+
+        it 'updates the tzid' do
+          # use an array because that's how output from the parser will end up
+          expect(subject.ical_params['tzid']).to eq ['Asia/Singapore']
+        end
+      end
     end
 
   else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icalendar
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.10.0
 platform: ruby
 authors:
 - Ryan Ahearn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-11 00:00:00.000000000 Z
+date: 2023-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ice_cube
@@ -187,8 +187,6 @@ files:
 - lib/icalendar/todo.rb
 - lib/icalendar/tzinfo.rb
 - lib/icalendar/value.rb
-- lib/icalendar/values/active_support_time_with_zone_adapter.rb
-- lib/icalendar/values/array.rb
 - lib/icalendar/values/binary.rb
 - lib/icalendar/values/boolean.rb
 - lib/icalendar/values/cal_address.rb
@@ -197,12 +195,14 @@ files:
 - lib/icalendar/values/date_time.rb
 - lib/icalendar/values/duration.rb
 - lib/icalendar/values/float.rb
+- lib/icalendar/values/helpers/active_support_time_with_zone_adapter.rb
+- lib/icalendar/values/helpers/array.rb
+- lib/icalendar/values/helpers/time_with_zone.rb
 - lib/icalendar/values/integer.rb
 - lib/icalendar/values/period.rb
 - lib/icalendar/values/recur.rb
 - lib/icalendar/values/text.rb
 - lib/icalendar/values/time.rb
-- lib/icalendar/values/time_with_zone.rb
 - lib/icalendar/values/uri.rb
 - lib/icalendar/values/utc_offset.rb
 - lib/icalendar/version.rb
@@ -247,7 +247,8 @@ licenses:
 - BSD-2-Clause
 - GPL-3.0-only
 - icalendar
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/icalendar/icalendar/blob/main/History.txt
 post_install_message: 'ActiveSupport is required for TimeWithZone support, but not
   required for general use.
 
@@ -266,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A ruby implementation of the iCalendar specification (RFC-5545).

data/lib/icalendar/values/active_support_time_with_zone_adapter.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Icalendar
-  module Values
-    class ActiveSupportTimeWithZoneAdapter < ActiveSupport::TimeWithZone
-      # ActiveSupport::TimeWithZone implements a #to_a method that will cause
-      # unexpected behavior in components with multi_property DateTime
-      # properties when the setters for those properties are invoked with an
-      # Icalendar::Values::DateTime that is delegating for an
-      # ActiveSupport::TimeWithZone. To avoid this behavior, undefine #to_a.
-      undef_method :to_a
-    end
-  end
-end

data/lib/icalendar/values/array.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-module Icalendar
-  module Values
-
-    class Array < Value
-
-      attr_reader :value_delimiter
-
-      def initialize(value, klass, params = {}, options = {})
-        @value_delimiter = options[:delimiter] || ','
-        mapped = if value.is_a? ::Array
-                   value.map do |v|
-                     if v.is_a? Icalendar::Values::Array
-                       Icalendar::Values::Array.new v.value, klass, v.ical_params, delimiter: v.value_delimiter
-                     elsif v.is_a? ::Array
-                       Icalendar::Values::Array.new v, klass, params, delimiter: value_delimiter
-                     elsif v.is_a? Icalendar::Value
-                       v
-                     else
-                       klass.new v, params
-                     end
-                   end
-                 else
-                   [klass.new(value, params)]
-                 end
-        super mapped
-      end
-
-      def params_ical
-        value.each do |v|
-          ical_params.merge! v.ical_params
-        end
-        super
-      end
-
-      def value_ical
-        value.map do |v|
-          v.value_ical
-        end.join value_delimiter
-      end
-
-      def valid?
-        klass = value.first.class
-        !value.all? { |v| v.class == klass }
-      end
-
-      def value_type
-        value.first.value_type
-      end
-
-      private
-
-      def needs_value_type?(default_type)
-        value.first.class != default_type
-      end
-    end
-
-  end
-end

data/lib/icalendar/values/time_with_zone.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-require 'icalendar/timezone_store'
-
-begin
-  require 'active_support/time'
-
-  if defined?(ActiveSupport::TimeWithZone)
-    require 'icalendar/values/active_support_time_with_zone_adapter'
-  end
-rescue NameError
-  # ActiveSupport v7+ needs the base require to be run first before loading
-  # specific parts of it.
-  # https://guides.rubyonrails.org/active_support_core_extensions.html#stand-alone-active-support
-  require 'active_support'
-  retry
-rescue LoadError
-  # tis ok, just a bit less fancy
-end
-
-module Icalendar
-  module Values
-    module TimeWithZone
-      attr_reader :tz_utc
-
-      def initialize(value, params = {})
-        params = Icalendar::DowncasedHash(params)
-        @tz_utc = params['tzid'] == 'UTC'
-        x_tz_info = params.delete 'x-tz-info'
-
-        offset_value = unless params['tzid'].nil?
-          tzid = params['tzid'].is_a?(::Array) ? params['tzid'].first : params['tzid']
-          if defined?(ActiveSupport::TimeZone) &&
-              defined?(ActiveSupportTimeWithZoneAdapter) &&
-              (tz = ActiveSupport::TimeZone[tzid])
-            ActiveSupportTimeWithZoneAdapter.new(nil, tz, value)
-          elsif !x_tz_info.nil?
-            offset = x_tz_info.offset_for_local(value).to_s
-            if value.respond_to?(:change)
-              value.change offset: offset
-            else
-              ::Time.new value.year, value.month, value.day, value.hour, value.min, value.sec, offset
-            end
-          end
-        end
-        super((offset_value || value), params)
-      end
-
-      def params_ical
-        ical_params.delete 'tzid' if tz_utc
-        super
-      end
-    end
-  end
-end