jekyll-ical-tag 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e12845744cce14e1ec5537ff8441fa364e001443c396a66dbc85a16f03bbfac
-  data.tar.gz: afbefb0515a7b9f5fc4c2b8f998488e3da03bfa8b03591b53944b41559848947
+  metadata.gz: 1b71de33f80f9e2ff9554027bea500fa7e66d68468aaed22e539e4551b5e2132
+  data.tar.gz: 130b7534016609598f51c37216a95c36993c78e0e75569107f5eb521d12a4e31
 SHA512:
-  metadata.gz: 2cacc0f5a846afab872099b0681c784c831eef23e09606e2e9bb989feaf527539cbcca91fe087c906d253ef7481a1a24ccd422ea6f3e5554a67e634f729ca2ec
-  data.tar.gz: a30558531827aab593381b88b0e3b943c0405d2993c1abeb5605930566de7665be5f77854a1080305aa0b74f7e57403d99e7e11181478ee32a8a9d62e81f123e
+  metadata.gz: 70b795e541f7c3b15f588d606e0f5aaf0734a9e0fae90a6980b2fdafbd871d2e97a25e772aec02faa16441ff828acc6fb3d9afa36e6d66cc2307c9868504ec3f
+  data.tar.gz: eaaf3787045379728460e53d317becabf502cc9382e41cb60ff4a965ad264a5292acf25f2b7d325bb53eda68ccca1bb830322438f66b6ed9fdd2af582ab046fa

data/.github/workflows/build.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.3
+        bundler-cache: true
+
+    - run: bin/standardrb
+
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [3.0, 3.1, 3.2, 3.3]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - run: bundle exec rspec

data/Gemfile

@@ -1,12 +1,14 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'jekyll', require: false
+gem "jekyll", require: false
 
-gem 'api_cache'
-gem 'icalendar', "~> 2.10.1"
-gem 'activesupport'
+gem "activesupport"
+gem "api_cache"
+gem "icalendar", "~> 2.10.1"
+gem "icalendar-recurrence"
 
 group :development, :test do
-  gem 'rspec'
-  gem 'nokogiri'
+  gem "rspec"
+  gem "nokogiri"
+  gem "standard"
 end

data/Gemfile.lock

@@ -14,6 +14,7 @@ GEM
     addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
     api_cache (0.3.0)
+    ast (2.4.2)
     base64 (0.2.0)
     bigdecimal (3.1.6)
     colorator (1.1.0)
@@ -34,6 +35,10 @@ GEM
       concurrent-ruby (~> 1.0)
     icalendar (2.10.1)
       ice_cube (~> 0.16)
+    icalendar-recurrence (1.2.0)
+      icalendar (~> 2.0)
+      ice_cube (~> 0.16)
+      tzinfo (~> 2.0)
     ice_cube (0.16.4)
     jekyll (4.3.2)
       addressable (~> 2.4)
@@ -55,10 +60,13 @@ GEM
       sass-embedded (~> 1.54)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
+    json (2.7.2)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
     liquid (4.0.4)
     listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
@@ -70,14 +78,20 @@ GEM
     nokogiri (1.15.2)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
+    parallel (1.25.1)
+    parser (3.3.4.0)
+      ast (~> 2.4.1)
+      racc
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (5.0.1)
     racc (1.7.1)
+    rainbow (3.1.1)
     rake (13.0.6)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
+    regexp_parser (2.9.2)
     rexml (3.2.5)
     rouge (4.1.2)
     rspec (3.12.0)
@@ -93,11 +107,40 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     safe_yaml (1.0.5)
     sass-embedded (1.63.6)
       google-protobuf (~> 3.23)
       rake (>= 13.0.0)
+    standard (1.39.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.64.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.4)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.4.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.21.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     tzinfo (2.0.6)
@@ -112,9 +155,11 @@ DEPENDENCIES
   activesupport
   api_cache
   icalendar (~> 2.10.1)
+  icalendar-recurrence
   jekyll
   nokogiri
   rspec
+  standard
 
 BUNDLED WITH
-   2.1.4
+   2.5.16

data/README.md

@@ -1,3 +1,5 @@
+[![Actions Status](https://github.com/Rakefire/jekyll-ical-tag/workflows/CI/badge.svg)](https://github.com/Rakefire/jekyll-ical-tag/actions)
+
 # Jekyll ical tag
 
 Author: Ricky Chilcott https://www.rakefire.io
@@ -38,9 +40,12 @@ plugins:
 - `only_future` - Defaults to 'false', limits returned events to start_time after now.
 
 - `before_date` - limits returned events to dates before a specific date. This gets parsed with Ruby's Time.parse (e.g. 01-01-2018)
-- `after_date` - limits returned events to dates before a specific date. This gets parsed with Ruby's Time.parse (e.g. 01-01-2018).
+- `after_date` - limits returned events to dates after a specific date. This gets parsed with Ruby's Time.parse (e.g. 01-01-2018).
 - `limit` - limits the number of returned events to the first N events matching the specified criteria. For example, `{% ical url: https://example.com/events.ics only_future:true limit:5 %}` returns the first five future events.
 
+- `recurring_start_date` - limits returned events to recurring occurances after a specific date. If you don't have recurring events in your feed, you can ignore it. Deafults to 'today'
+- `recurring_end_date` - limits returned events to recurring occurances before a specific date. If you don't have recurring events in your feed, you can ignore it. Deafults to '1 year from today'
+
 ## Event Attributes:
 
 All RFC 5545 properties are supported, examples:
@@ -61,4 +66,4 @@ A few helper properties are also supported:
 
 # Special Thanks
 
-Special thanks to the following contributors: @marchehab98 @meitar
+Special thanks to the following contributors: [@marchehab98](github.com/marchehab98] [@meitar](github.com/meitar) [@whatnotery](github.com/whatnotery)

data/bin/standardrb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'standardrb' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("standard", "standardrb")

data/jekyll-ical-tag.gemspec

@@ -25,15 +25,16 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.3.0"
 
-  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|spec|features)/!) }
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r!^exe/!) { |f| File.basename(f) }
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "jekyll", "> 3"
   spec.add_dependency "api_cache"
   spec.add_dependency "activesupport", "~> 7.1"
   spec.add_dependency "icalendar", "~> 2.10.1"
+  spec.add_dependency "icalendar-recurrence"
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rspec", "~> 3.5"

data/lib/jekyll-ical-tag/calendar_feed_coordinator.rb

@@ -1,16 +1,17 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module Jekyll
   class IcalTag
     class CalendarFeedCoordinator
-      def initialize(url:, only: nil, reverse: nil, before_date: nil, after_date: nil, limit: nil)
+      def initialize(url:, only: nil, reverse: nil, before_date: nil, after_date: nil, limit: nil, recurring_start_date: nil, recurring_end_date: nil)
         @url = url
         @only = only
         @reverse = reverse
         @before_date = before_date
         @after_date = after_date
         @limit = limit
+        @recurring_start_date = recurring_start_date
+        @recurring_end_date = recurring_end_date
       end
 
       def events
@@ -27,7 +28,7 @@ module Jekyll
 
       def parser
         @parser ||= begin
-          parser = CalendarParser.new(raw_ical)
+          parser = CalendarParser.new(raw_ical, recurring_start_date: recurring_start_date, recurring_end_date: recurring_end_date)
           parser = CalendarLimiter.new(parser, only: only)
           parser = CalendarLimiter.new(parser, reverse: reverse)
           parser = CalendarLimiter.new(parser, before_date: before_date)
@@ -35,6 +36,14 @@ module Jekyll
           CalendarLimiter.new(parser, limit: limit)
         end
       end
+
+      def recurring_start_date
+        @recurring_start_date || after_date || Date.today
+      end
+
+      def recurring_end_date
+        @recurring_end_date || before_date || (recurring_start_date + 1.year)
+      end
     end
   end
 end

data/lib/jekyll-ical-tag/calendar_fetcher.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require "cgi"
@@ -23,7 +22,7 @@ module Jekyll
       attr_reader :url
 
       def is_valid_url?
-        !!(url =~ URI::regexp)
+        !!(url =~ URI::DEFAULT_PARSER.make_regexp)
       end
     end
   end

data/lib/jekyll-ical-tag/calendar_limiter.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module Jekyll
@@ -10,28 +9,27 @@ module Jekyll
       end
 
       def events
-        case
-        when options[:only] == :future
+        if options[:only] == :future
           now = Time.now
           parser.events.select do |event|
             event.dtstart.to_time >= now
           end
-        when options[:only] == :past
+        elsif options[:only] == :past
           now = Time.now
           parser.events.select do |event|
             event.dtstart.to_time < now
           end
-        when options[:reverse]
+        elsif options[:reverse]
           parser.events.reverse
-        when options[:after_date]
+        elsif options[:after_date]
           parser.events.select do |event|
             event.dtstart.to_time >= options[:after_date]
           end
-        when options[:before_date]
+        elsif options[:before_date]
           parser.events.select do |event|
             event.dtstart.to_time < options[:before_date]
           end
-        when options[:limit]
+        elsif options[:limit]
           parser.events.first(options[:limit])
         else
           parser.events

data/lib/jekyll-ical-tag/calendar_parser.rb

@@ -1,25 +1,56 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require "active_support"
 require "icalendar"
+require "icalendar/recurrence"
 
 module Jekyll
   class IcalTag
     class CalendarParser
-      def initialize(raw_feed)
+      def initialize(raw_feed, recurring_start_date:, recurring_end_date:)
         @raw_feed = raw_feed
+        @recurring_start_date = recurring_start_date
+        @recurring_end_date = recurring_end_date
       end
 
       def events
-        @events ||= parsed_feed.sort { |event1, event2| event1.dtstart <=> event2.dtstart }
-                               .map { |event| Jekyll::IcalTag::Event.new(event) }
+        @events ||=
+          parsed_events
+            .sort_by(&:dtstart)
+            .map { |event| Jekyll::IcalTag::Event.new(event) }
       end
 
       private
 
-      def parsed_feed
-        Icalendar::Event.parse(@raw_feed)
+      def parsed_events
+        events = Icalendar::Event.parse(@raw_feed)
+
+        recurring_events =
+          events
+            .select { |event| event.rrule.present? }
+            .flat_map do |event|
+              event
+                .occurrences_between(@recurring_start_date, @recurring_end_date)
+                .map { |occurrence| build_occurance_event(event, occurrence) }
+            end
+            .compact
+
+        events.concat(recurring_events)
+      end
+
+      # return a new event with the same attributes, but different start and end times
+      def build_occurance_event(event, occurrence)
+        return if is_duplicate_event?(event, occurrence)
+
+        event.dup.tap do |e|
+          e.dtstart = occurrence.start_time
+          e.dtend = occurrence.end_time
+        end
+      end
+
+      def is_duplicate_event?(event, occurrence)
+        event.dtstart.to_time == occurrence.start_time.to_time ||
+          event.dtend.to_time == occurrence.end_time.to_time
       end
     end
   end

data/lib/jekyll-ical-tag/event.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require "uri"
@@ -39,17 +38,18 @@ module Jekyll
       attr_reader :all_properties
 
       def simple_html_description
-        @simple_html_description ||= begin
-          description.clone.tap do |description|
-            description_urls.each do |url|
-              description.gsub! url, %(<a href='#{url}'>#{url}</a>)
-            end
+        @simple_html_description ||= description.clone.tap do |description|
+          description_urls.each do |url|
+            description.gsub! url, %(<a href='#{url}'>#{url}</a>)
           end
         end
       end
 
       def attendees
-        ical_event.attendee.map(&:to_s).map { |a| a.slice!("mailto:"); a }
+        ical_event.attendee.map(&:to_s).map { |a|
+          a.slice!("mailto:")
+          a
+        }
       end
 
       def description_urls

data/lib/jekyll-ical-tag/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   class IcalTag < Liquid::Block
-    VERSION = "1.5.1"
+    VERSION = "1.6.0"
   end
 end

data/lib/jekyll-ical-tag.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require "jekyll"
@@ -26,19 +25,27 @@ module Jekyll
     end
 
     def render(context)
+      self.context = context
       context.registers[:ical] ||= Hash.new(0)
 
+      set_recurring_dates!
+
       result = []
 
       context.stack do
-        url = dereferenced_liquid_val(context, "url")
-        before_date = before_date_from(context)
-        after_date = after_date_from(context)
+        url = dereferenced_liquid_val("url")
+        before_date = before_date_from
+        after_date = after_date_from
 
         calendar_feed_coordinator = CalendarFeedCoordinator.new(
-          url: url, only: @only, reverse: @reverse,
-          before_date: before_date, after_date: after_date,
-          limit: @limit
+          url: url,
+          only: @only,
+          reverse: @reverse,
+          before_date: before_date,
+          after_date: after_date,
+          limit: @limit,
+          recurring_start_date: @recurring_start_date,
+          recurring_end_date: @recurring_end_date
         )
         events = calendar_feed_coordinator.events
         event_count = events.length
@@ -72,7 +79,7 @@ module Jekyll
             "rindex" => event_count - index,
             "rindex0" => event_count - index - 1,
             "first" => (index == 0),
-            "last" => (index == event_count - 1),
+            "last" => (index == event_count - 1)
           }
 
           result << nodelist.map do |n|
@@ -90,15 +97,17 @@ module Jekyll
 
     private
 
-    def after_date_from(context)
+    attr_accessor :context
+
+    def after_date_from
       safely_cast_to_time(
-        dereferenced_liquid_val(context, "after_date")
+        dereferenced_liquid_val("after_date")
       )
     end
 
-    def before_date_from(context)
+    def before_date_from
       safely_cast_to_time(
-        dereferenced_liquid_val(context, "before_date")
+        dereferenced_liquid_val("before_date")
       )
     end
 
@@ -115,7 +124,7 @@ module Jekyll
       end
     end
 
-    def dereferenced_liquid_val(context, variable_name)
+    def dereferenced_liquid_val(variable_name)
       raw_value = @attributes[variable_name]
 
       context.key?(raw_value) ? context[raw_value] : raw_value
@@ -151,6 +160,18 @@ module Jekyll
           :all
         end
     end
+
+    def set_recurring_dates!
+      @recurring_end_date =
+        safely_cast_to_time(
+          dereferenced_liquid_val("recurring_end_date")
+        )
+
+      @recurring_start_date =
+        safely_cast_to_time(
+          dereferenced_liquid_val("recurring_start_date")
+        )
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-ical-tag
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Ricky Chilcott
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-23 00:00:00.000000000 Z
+date: 2024-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.10.1
+- !ruby/object:Gem::Dependency
+  name: icalendar-recurrence
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
 - ".tool-versions"
@@ -109,6 +124,7 @@ files:
 - README.md
 - bin/build-and-publish-gem
 - bin/rspec
+- bin/standardrb
 - jekyll-ical-tag.gemspec
 - lib/jekyll-ical-tag.rb
 - lib/jekyll-ical-tag/calendar_feed_coordinator.rb
@@ -137,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: A Jekyll plugin to pull ICS feed and provide a for-like loop of calendar