icalendar 2.10.2 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25be453368a5f3878e1914626da23ed5116c8e7835f60bf67c2cf0d87f6766dc
-  data.tar.gz: 00163247da24fc8057dcd4e1955f72a709ad3fd668526e35af17004232d4b173
+  metadata.gz: 8a3ae780c56015cbd4ff657ce042c086038f2f922069fa40eaaeaeedd3b7144c
+  data.tar.gz: 88d669f06da7a9b91c3c8a92dd08e11e70b8712a2c4b05a752427abc1ed56435
 SHA512:
-  metadata.gz: d812eaf1f48875019ce982e7c6fc9ce900a1dccd315ae072867d62407ff8a13fbb0b2dae9e7c0c9b83870e1630fc5c63c09a4d0812eb539f7c8ffb799d5656b1
-  data.tar.gz: dcadb2f20833a329b0e4b3845ec2cf41c5b415f739cb34489f8987837892280b888f328dc3e07c6c2aeff6bc5cf5b1db24a9e061993b2868a51cf89444e037e2
+  metadata.gz: 250a5156dbb7f7ec7cd7f9fddd51982676d81b5a41ae2815c85b41f3f114e3b3c812c07794463d3563f85a93d8097075a19bb7d37b2ca4694682cc8804ff9be7
+  data.tar.gz: 11c71867043fd1fd94cc6199e470b9ff4ce55c7c5e2455d0435b46676b4017743cec130de8f5383faf66eee4e28a400b6b807bf76eb1c781fd47604b7276a4c5

data/.github/workflows/main.yml

@@ -18,9 +18,10 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - 3.1.6
-          - 3.2.4
-          - 3.3.4
+          - 3.1
+          - 3.2
+          - 3.3
+          - 3.4
 
     steps:
     - uses: actions/checkout@v4

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## Unreleased
 
+## 2.11.0 - 2025-04-12
+ - Require gems for ruby 3.4 that used to be in stdlib - Go Sueyoshi
+ - Refactor how timezone offsets are calculated - Pat Allan
+    - 'tzid' param is always returned as an array when accessing `ical_params` directly, rather than matching whatever the input parsed. ICS output remains unchanged
+
+## 2.10.3 - 2024-09-21
+ - Override Icalendar::Value.== so that value objects can be compared to each other.
+ - Correctly load activesupport before activesupport/time
+ - Load ostruct to address deprecation warning - aki77
+
 ## 2.10.2 - 2024-07-21
  - Raise Icalendar::Parser::ParseError on bad .ics file input instead of RuntimeError - Micah Geisel
  - Remove Ruby 3.0 from the test matrix - still should work for now with ice_cube < 0.17.0

data/icalendar.gemspec

@@ -31,7 +31,10 @@ ActiveSupport is required for TimeWithZone support, but not required for general
 
   s.required_ruby_version = '>= 2.4.0'
 
+  s.add_dependency 'base64'
   s.add_dependency 'ice_cube', '~> 0.16'
+  s.add_dependency 'logger'
+  s.add_dependency 'ostruct'
 
   s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'bundler', '~> 2.0'

data/lib/icalendar/offset/active_support_exact.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Icalendar
+  class Offset
+    class ActiveSupportExact < Icalendar::Offset
+      def valid?
+        support_classes_defined? && tz
+      end
+
+      def normalized_value
+        Icalendar.logger.debug("Plan a - parsing #{value}/#{tzid} as ActiveSupport::TimeWithZone")
+        # plan a - use ActiveSupport::TimeWithZone
+        Icalendar::Values::Helpers::ActiveSupportTimeWithZoneAdapter.new(nil, tz, value)
+      end
+
+      private
+
+      def tz
+        @tz ||= ActiveSupport::TimeZone[tzid]
+      end
+    end
+  end
+end

data/lib/icalendar/offset/active_support_partial.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Icalendar
+  class Offset
+    class ActiveSupportPartial < Offset
+      def valid?
+        support_classes_defined? && tz
+      end
+
+      def normalized_value
+        # plan c - try to find an ActiveSupport::TimeWithZone based on the first word of the tzid
+        Icalendar.logger.debug("Plan c - parsing #{value}/#{tz.tzinfo.name} as ActiveSupport::TimeWithZone")
+        Icalendar::Values::Helpers::ActiveSupportTimeWithZoneAdapter.new(nil, tz, value)
+      end
+
+      def normalized_tzid
+        [tz.tzinfo.name]
+      end
+
+      private
+
+      def tz
+        @tz ||= ActiveSupport::TimeZone[tzid.split.first]
+      end
+    end
+  end
+end

data/lib/icalendar/offset/null.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Icalendar
+  class Offset
+    class Null < Offset
+      def valid?
+        true
+      end
+
+      def normalized_value
+        # plan d - just ignore the tzid
+        Icalendar.logger.info("Ignoring timezone #{tzid} for time #{value}")
+        nil
+      end
+    end
+  end
+end

data/lib/icalendar/offset/time_zone_store.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Icalendar
+  class Offset
+    class TimeZoneStore < Offset
+      def valid?
+        timezone_store && tz_info
+      end
+
+      def normalized_value
+        # plan b - use definition from provided `VTIMEZONE`
+        offset = tz_info.offset_for_local(value).to_s
+
+        Icalendar.logger.debug("Plan b - parsing #{value} with offset: #{offset}")
+        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
+
+      private
+
+      def tz_info
+        @tz_info ||= timezone_store.retrieve(tzid)
+      end
+    end
+  end
+end

data/lib/icalendar/offset.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Icalendar
+  class Offset
+    def self.build(value, params, timezone_store)
+      return nil if params.nil? || params['tzid'].nil?
+
+      tzid = Array(params['tzid']).first
+
+      [
+        Icalendar::Offset::ActiveSupportExact,
+        Icalendar::Offset::TimeZoneStore,
+        Icalendar::Offset::ActiveSupportPartial,
+        Icalendar::Offset::Null
+      ].lazy.map { |klass| klass.new(tzid, value, timezone_store) }.detect(&:valid?)
+    end
+
+    def initialize(tzid, value, timezone_store)
+      @tzid = tzid
+      @value = value
+      @timezone_store = timezone_store
+    end
+
+    def normalized_tzid
+      Array(tzid)
+    end
+
+    private
+
+    attr_reader :tzid, :value, :timezone_store
+
+    def support_classes_defined?
+      defined?(ActiveSupport::TimeZone) &&
+        defined?(Icalendar::Values::Helpers::ActiveSupportTimeWithZoneAdapter)
+    end
+  end
+end
+
+require_relative "offset/active_support_exact"
+require_relative "offset/active_support_partial"
+require_relative "offset/null"
+require_relative "offset/time_zone_store"

data/lib/icalendar/value.rb

@@ -45,6 +45,14 @@ module Icalendar
       self.class.value_type
     end
 
+    def ==(other)
+      if other.is_a?(Icalendar::Value)
+        super(other.value) && ical_params == other.ical_params
+      else
+        super
+      end
+    end
+
     private
 
     def needs_value_type?(default_type)

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

@@ -1,17 +1,14 @@
 # frozen_string_literal: true
 
+require "icalendar/offset"
+
 begin
+  require 'active_support'
   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
@@ -26,7 +23,13 @@ module Icalendar
           params = Icalendar::DowncasedHash(params)
           @tz_utc = params['tzid'] == 'UTC'
           @timezone_store = params.delete 'x-tz-store'
-          super (offset_value(value, params) || value), params
+
+          offset = Icalendar::Offset.build(value, params, timezone_store)
+
+          @offset_value = offset&.normalized_value
+          params['tzid'] = offset.normalized_tzid if offset
+
+          super (@offset_value || value), params
         end
 
         def __getobj__
@@ -34,9 +37,9 @@ module Icalendar
           if set_offset?
             orig_value
           else
-            offset = offset_value(orig_value, ical_params)
-            __setobj__(offset) unless offset.nil?
-            offset || orig_value
+            new_value = Icalendar::Offset.build(orig_value, ical_params, timezone_store)&.normalized_value
+            __setobj__(new_value) unless new_value.nil?
+            new_value || orig_value
           end
         end
 
@@ -47,36 +50,6 @@ module Icalendar
 
         private
 
-        def offset_value(value, params)
-          @offset_value = unless params.nil? || 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])
-              Icalendar.logger.debug("Plan a - parsing #{value}/#{tzid} as ActiveSupport::TimeWithZone")
-              # plan a - use ActiveSupport::TimeWithZone
-              ActiveSupportTimeWithZoneAdapter.new(nil, tz, value)
-            elsif !timezone_store.nil? && !(x_tz_info = timezone_store.retrieve(tzid)).nil?
-              # plan b - use definition from provided `VTIMEZONE`
-              offset = x_tz_info.offset_for_local(value).to_s
-              Icalendar.logger.debug("Plan b - parsing #{value} with offset: #{offset}")
-              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
-              Icalendar.logger.debug("Plan c - parsing #{value}/#{tz.tzinfo.name} as ActiveSupport::TimeWithZone")
-              params['tzid'] = [tz.tzinfo.name]
-              ActiveSupportTimeWithZoneAdapter.new(nil, tz, value)
-            else
-              # plan d - just ignore the tzid
-              Icalendar.logger.info("Ignoring timezone #{tzid} for time #{value}")
-              nil
-            end
-          end
-        end
-
         def set_offset?
           !!@offset_value
         end

data/lib/icalendar/version.rb

@@ -2,6 +2,6 @@
 
 module Icalendar
 
-  VERSION = '2.10.2'
+  VERSION = '2.11.0'
 
 end

data/spec/spec_helper.rb

@@ -12,6 +12,12 @@ end
 require 'timecop'
 require 'icalendar'
 
+if defined?(ActiveSupport)
+  # this has been default behavior for new Rails apps for a long time, and the
+  # only option once ActiveSupport goes to 8.x
+  ActiveSupport.to_time_preserves_timezone = true if ActiveSupport.respond_to?(:to_time_preserves_timezone=)
+end
+
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus

data/spec/values/date_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Icalendar::Values::Date do
+
+  subject { described_class.new value, params }
+  let(:value) { '20140209' }
+  let(:params) { {} }
+
+  describe "#==" do
+    let(:other) { described_class.new value }
+
+    it "is equivalent to another Icalendar::Values::Date" do
+      expect(subject).to eq other
+    end
+
+    context "differing params" do
+      let(:params) { {"x-custom-param": "param-value"} }
+
+      it "is no longer equivalent" do
+        expect(subject).not_to eq other
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: icalendar
 version: !ruby/object:Gem::Version
-  version: 2.10.2
+  version: 2.11.0
 platform: ruby
 authors:
 - Ryan Ahearn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-21 00:00:00.000000000 Z
+date: 2025-04-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ice_cube
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +223,11 @@ files:
 - lib/icalendar/journal.rb
 - lib/icalendar/logger.rb
 - lib/icalendar/marshable.rb
+- lib/icalendar/offset.rb
+- lib/icalendar/offset/active_support_exact.rb
+- lib/icalendar/offset/active_support_partial.rb
+- lib/icalendar/offset/null.rb
+- lib/icalendar/offset/time_zone_store.rb
 - lib/icalendar/parser.rb
 - lib/icalendar/timezone.rb
 - lib/icalendar/timezone_store.rb
@@ -237,6 +284,7 @@ files:
 - spec/todo_spec.rb
 - spec/tzinfo_spec.rb
 - spec/values/date_or_date_time_spec.rb
+- spec/values/date_spec.rb
 - spec/values/date_time_spec.rb
 - spec/values/duration_spec.rb
 - spec/values/period_spec.rb
@@ -304,6 +352,7 @@ test_files:
 - spec/todo_spec.rb
 - spec/tzinfo_spec.rb
 - spec/values/date_or_date_time_spec.rb
+- spec/values/date_spec.rb
 - spec/values/date_time_spec.rb
 - spec/values/duration_spec.rb
 - spec/values/period_spec.rb