omnievent-icalendar 0.1.0.pre1 → 0.1.0.pre3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eac596fd4368bab161d6ee2a6a2d82934d7dfdcd3e7b0aad53c443b21aa91e05
-  data.tar.gz: 3bac6210eb54e610aae86530ed7a331f9ebcc542a1203f6d927986ce0f8fdad4
+  metadata.gz: 478361c4c57731a099c80c38f58324a9596e5868b6b24f50e3c404382b56b3b9
+  data.tar.gz: fa69074455c32057662f0d1e66496b6337bdde8c529bcae4c5eaa8e392916896
 SHA512:
-  metadata.gz: 0e5e5c18854bc19ad1289f07da2d15a73ba5f68ecf3ad97b18ad99d659466f5b0cab033d0022c5c0290605f4b858556a8b7f7a215b381cd5f664f109e91bd905
-  data.tar.gz: c1ce879167ef15c0b5793833a8e62dc0e4f2599d66eac80f38c4f1ec5e917273a58ae9e923ce31a10baeee7813d9b2a630154f185cc6578fd2a947fdd0a2c65b
+  metadata.gz: 7aa84afb2b0062dde09e598554fb68ac416fbff767ce3aa923b2bfd737048f2b64811d61bb4552c39165348cf1aa4f2fe0f7dbf8643c59095b1b1e2cd34dd6ff
+  data.tar.gz: 96b84d19fbd6dcb7de58ffc6043a091c4eecf660dcfcb9c4d60799fbaf37997d00953f590309ee21737287a6db151c962e370aafe62c1276342f824f5e05cf21

data/.rspec

@@ -1,3 +1,4 @@
 --format documentation
 --color
+--exclude-pattern vendor/**/*_spec.rb
 --require spec_helper

data/CHANGELOG.md

@@ -3,3 +3,11 @@
 ## [0.1.0.pre1] - 2022-09-05
 
 - Pre release
+
+## [0.1.0.pre2] - 2022-10-21
+
+- Add recurrence support
+
+## [0.1.0.pre3] - 2022-11-20
+
+- Fix various recurrence issues

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    omnievent-icalendar (0.1.0.pre1)
+    omnievent-icalendar (0.1.0.pre3)
       addressable (~> 2.7)
       icalendar
+      icalendar-recurrence (~> 1.1)
       omnievent
-      open-uri
+      open-uri (= 0.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -17,64 +18,59 @@ GEM
     concurrent-ruby (1.1.10)
     crack (0.4.5)
       rexml
-    date (3.2.2)
     diff-lcs (1.5.0)
     hashdiff (1.0.1)
     hashie (5.0.0)
     icalendar (2.8.0)
       ice_cube (~> 0.16)
+    icalendar-recurrence (1.1.3)
+      icalendar (~> 2.0)
+      ice_cube (~> 0.16)
     ice_cube (0.16.4)
     iso-639 (0.3.5)
     json (2.6.2)
-    omnievent (0.1.0.pre1)
+    omnievent (0.1.0.pre3)
       hashie (>= 3.4.6)
       iso-639 (~> 0.3.5)
       tzinfo (~> 2.0)
-    open-uri (0.2.0)
-      stringio
-      time
-      uri
+    open-uri (0.1.0)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
     public_suffix (5.0.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.0)
+    regexp_parser (2.6.1)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.1)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.1)
-    rubocop (1.36.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.39.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
+    rubocop-ast (1.23.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    stringio (3.0.2)
-    time (0.2.0)
-      date
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
-    uri (0.11.0)
     webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
@@ -92,4 +88,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.3.14
+   2.3.24

data/README.md

@@ -1,11 +1,11 @@
 # OmniEvent iCalendar (Pre Release)
 
+> Please note that this gem is pre release and is not yet ready for production.
+
 This gem contains a generic iCalendar strategy for [OmniEvent](https://github.com/paviliondev/omnievent).
 
 ## Installation
 
-> Please note that this gem is pre release and is not yet ready for production.
-
 First install [OmniEvent](https://rubygems.org/gems/omnievent).
 
     $ gem install omnievent
@@ -16,8 +16,6 @@ Then install this gem:
 
 ## Usage
 
-> Please note that this gem is pre release and is not yet ready for production.
-
 Please see ["Usage" in the OmniEvent Readme](https://github.com/paviliondev/omnievent#usage)
 
 ## Development

data/lib/omnievent/icalendar/version.rb

@@ -2,6 +2,6 @@
 
 module OmniEvent
   module Icalendar
-    VERSION = "0.1.0.pre1"
+    VERSION = "0.1.0.pre3"
   end
 end

data/lib/omnievent/strategies/icalendar.rb

@@ -2,6 +2,7 @@
 
 require_relative "../../omnievent/icalendar/version"
 require "icalendar"
+require "icalendar-recurrence"
 require "open-uri"
 require "addressable/uri"
 
@@ -14,6 +15,7 @@ module OmniEvent
       include OmniEvent::Strategy
 
       option :name, "icalendar"
+      option :expand_recurrences
       option :uri, ""
 
       def raw_events
@@ -32,6 +34,8 @@ module OmniEvent
           result += calendar.events
         end
 
+        result = expand_recurrences(result) if options.expand_recurrences
+
         result
       end
 
@@ -44,18 +48,10 @@ module OmniEvent
           url: raw_event.url.to_s
         }
 
-        metadata = {
-          uid: format_uid(raw_event),
-          taxonomies: raw_event.categories.to_s,
-          status: convert_status(raw_event.status),
-          created_at: format_time(raw_event.created),
-          updated_at: format_time(raw_event.last_modified)
-        }
-
         OmniEvent::EventHash.new(
           provider: name,
           data: data,
-          metadata: metadata
+          metadata: retrieve_metadata(raw_event)
         )
       end
 
@@ -76,11 +72,31 @@ module OmniEvent
         end
       end
 
+      def retrieve_metadata(event)
+        metadata = {
+          uid: format_uid(event),
+          taxonomies: event.categories.to_s,
+          status: convert_status(event.status),
+          created_at: format_time(event.created),
+          updated_at: format_time(event.last_modified),
+          sequence: nil,
+          series_id: nil,
+          occurrence_id: nil
+        }
+
+        metadata[:sequence] = event.sequence.to_s if event.sequence
+
+        if event.recurrence_id
+          metadata[:series_id] = event.uid.to_s
+          metadata[:occurrence_id] = event.recurrence_id.to_s
+        end
+
+        metadata
+      end
+
       def format_uid(event)
-        # See https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.4.4
         event_uid = event.uid.to_s
         event_uid += "#{options.uid_delimiter}#{event.recurrence_id}" if event.recurrence_id
-        event_uid += "#{options.uid_delimiter}#{event.sequence}" if event.sequence
         event_uid
       end
 
@@ -96,6 +112,56 @@ module OmniEvent
           "published"
         end
       end
+
+      def expand_recurrences(events)
+        result = []
+
+        events.each do |event|
+          if recurrence?(event)
+            schedule = ::Icalendar::Recurrence::Schedule.new(event)
+            exceptions = events.select { |e| e.recurrence_id && (e.uid == event.uid) }
+
+            extract_occurences(schedule).each do |occurrence|
+              next if exception?(exceptions, occurrence)
+
+              occurrence_event = event.clone
+              occurrence_event.recurrence_id = occurrence.start_time
+              occurrence_event.dtstart = occurrence.start_time
+              occurrence_event.dtend = occurrence.end_time
+
+              result << occurrence_event
+            end
+          else
+            siblings = events
+                       .select { |e| e.recurrence_id.to_i == event.recurrence_id.to_i }
+                       .sort_by(&:sequence)
+
+            result << event if siblings.none? || (siblings.last.sequence == event.sequence)
+          end
+        end
+
+        result.sort_by(&:dtstart)
+      end
+
+      def extract_occurences(schedule)
+        if options.from_time && options.to_time
+          schedule.occurrences_between(options.from_time, options.to_time)
+        else
+          schedule.all_occurrences
+        end
+      end
+
+      def recurrence?(event)
+        present?(event.rrule) || present?(event.rdate)
+      end
+
+      def present?(property)
+        !!property && property.any?
+      end
+
+      def exception?(exceptions, occurrence)
+        exceptions.any? { |e| e.recurrence_id.to_i == occurrence.start_time.to_i }
+      end
     end
   end
 end

data/omnievent-icalendar.gemspec

@@ -30,8 +30,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "addressable", "~> 2.7"
   spec.add_dependency "icalendar"
+  spec.add_dependency "icalendar-recurrence", "~> 1.1"
   spec.add_dependency "omnievent"
-  spec.add_dependency "open-uri"
+  spec.add_dependency "open-uri", "0.1.0"
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "webmock"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omnievent-icalendar
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre1
+  version: 0.1.0.pre3
 platform: ruby
 authors:
 - Angus McLeod
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-03 00:00:00.000000000 Z
+date: 2022-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: icalendar-recurrence
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: omnievent
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +70,16 @@ dependencies:
   name: open-uri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: OmniEvent iCalendar strategy