jekyll-ical-tag 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7d1dce12392f01bb0a4d092684ffcec0dd51dd099a5c4d84634c2a4f5873785
-  data.tar.gz: 3bea7aac7663335f7df8928a10cff12bdc45a0ed0d59dc98530e18f35ca302ce
+  metadata.gz: 138258ebd3c243d7029b59499ed3efb4b26aacbeada1a965e5775f0df4d8ef19
+  data.tar.gz: c5085b894aa91497fdec2a0505138a5acacbe5e47e0934491fb9f79311371e36
 SHA512:
-  metadata.gz: 422e9632764d6c14a00aabab84592fde181f66782870de1d9eeaee7bdfa2c7531cf262c00ec16d25c13951490a8a937edfc746cd55387870169aebb3687cc58c
-  data.tar.gz: 6cc3cb90d9c76cfb50768522dc6c0205fdeab97baf621fe9be7983185724cbd1c79773f5c5027fb5fe527995706b25b186d97327b08399fb45a5caa3ae26fd8f
+  metadata.gz: 0deebc23d524101ca2e1ec02c1351316228f1d94533fc5646c4886ad979be920add4ffcdd58831bd654b2ae09669c51fa6bc939ee7ccae200c3a0f61e3329343
+  data.tar.gz: a02c429cb649bfd8e9abb70499d711e2417d0c35eb24a477ade046c1f95083cda9f90e1afcdc9b95bb10028746e3b68759f98ed71f7c99bdb453f716ae3ac5aa

data/.tool-versions

@@ -0,0 +1 @@
+ruby system

data/Gemfile.lock

@@ -1,93 +1,97 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.4.3)
+    activesupport (7.0.4.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     api_cache (0.3.0)
     colorator (1.1.0)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    em-websocket (0.5.1)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
-      http_parser.rb (~> 0.6.0)
+      http_parser.rb (~> 0)
     eventmachine (1.2.7)
-    ffi (1.12.2)
+    ffi (1.15.5)
     forwardable-extended (2.6.0)
-    http_parser.rb (0.6.0)
-    i18n (1.8.2)
+    google-protobuf (3.22.0)
+    http_parser.rb (0.8.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    icalendar (2.5.0)
+    icalendar (2.8.0)
       ice_cube (~> 0.16)
-    ice_cube (0.16.3)
-    jekyll (4.0.0)
+    ice_cube (0.16.4)
+    jekyll (4.3.2)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
-      i18n (>= 0.9.5, < 2)
-      jekyll-sass-converter (~> 2.0)
+      i18n (~> 1.0)
+      jekyll-sass-converter (>= 2.0, < 4.0)
       jekyll-watch (~> 2.0)
-      kramdown (~> 2.1)
+      kramdown (~> 2.3, >= 2.3.1)
       kramdown-parser-gfm (~> 1.0)
       liquid (~> 4.0)
-      mercenary (~> 0.3.3)
+      mercenary (>= 0.3.6, < 0.5)
       pathutil (~> 0.9)
-      rouge (~> 3.0)
+      rouge (>= 3.0, < 5.0)
       safe_yaml (~> 1.0)
-      terminal-table (~> 1.8)
-    jekyll-sass-converter (2.1.0)
-      sassc (> 2.0.1, < 3.0)
+      terminal-table (>= 1.8, < 4.0)
+      webrick (~> 1.7)
+    jekyll-sass-converter (3.0.0)
+      sass-embedded (~> 1.54)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    kramdown (2.3.1)
+    kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    liquid (4.0.3)
-    listen (3.2.1)
+    liquid (4.0.4)
+    listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    mercenary (0.3.6)
-    mini_portile2 (2.5.0)
-    minitest (5.14.1)
-    nokogiri (1.11.0)
-      mini_portile2 (~> 2.5.0)
+    mercenary (0.4.0)
+    mini_portile2 (2.8.1)
+    minitest (5.17.0)
+    nokogiri (1.14.2)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (4.0.3)
-    racc (1.5.2)
-    rb-fsevent (0.10.3)
+    public_suffix (5.0.1)
+    racc (1.6.2)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rexml (3.2.4)
-    rouge (3.17.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.0)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rexml (3.2.5)
+    rouge (4.1.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
     safe_yaml (1.0.5)
-    sassc (2.2.1)
-      ffi (~> 1.9)
-    terminal-table (1.8.0)
-      unicode-display_width (~> 1.1, >= 1.1.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
+    sass-embedded (1.58.3)
+      google-protobuf (~> 3.21)
+      rake (>= 10.0.0)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    webrick (1.8.1)
 
 PLATFORMS
   ruby
@@ -101,4 +105,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   2.1.4
+   2.3.10

data/_site/README.md

@@ -0,0 +1,64 @@
+# Jekyll ical tag
+
+Author: Ricky Chilcott https://www.rakefire.io
+
+Description: Pull ICS feed and provide a for-like loop of calendar events
+
+## Installation
+
+To your Gemfile:
+
+`gem 'jekyll-ical-tag'`
+
+To your `_config.yml`
+
+```yml
+plugins:
+  - jekyll-ical-tag
+```
+
+## Syntax
+
+```html
+  {% ical url: https://space.floern.com/launch.ics reverse: true only_future: true %}
+    {{ event.summary }}
+    {{ event.description }}
+    {{ event.simple_html_description }}
+    {{ event.start_time }}
+    {{ event.end_time }}
+    {{ event.url }}
+    {{ event.attendees }}
+  {% endical %}
+```
+
+## Options
+
+- `reverse` - Defaults to 'false', ordering events by start_time (or reverse start_time).
+- `only_past` - Defaults to 'false', limits returned events to start_times before now.
+- `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).
+- `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.
+
+## Event Attributes:
+
+All RFC 5545 properties are supported, examples:
+
+- `dtstart` - start time of event
+- `dtend` - end time of event
+- `summary` - Title or name of event
+- `description` - Notes/description of event
+- `location` - Location of event
+- `url` - url of event, if provided, if not, take the first url from the description.
+
+A few helper properties are also supported:
+
+- `attendees` - [Array] of attendees names/emails
+- `simple_html_description` - Notes/description of event with urls auto-linked
+- `start_time` - start time of event
+- `end_time` - end time of event
+
+# Special Thanks
+
+Special thanks to the following contributors: @marchehab98 @meitar

data/_site/bin/build-and-publish-gem

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+rm -f *.gem
+bundle exec gem build jekyll-ical-tag.gemspec
+bundle exec gem push jekyll-ical-tag-*.gem

data/_site/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' 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("rspec-core", "rspec")

data/_site/jekyll-ical-tag.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "jekyll"
+require "jekyll-ical-tag/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "jekyll-ical-tag"
+  spec.version = Jekyll::IcalTag::VERSION
+  spec.authors = ["Ricky Chilcott"]
+  spec.email = ["ricky@rakefire.io"]
+  spec.summary = "A Jekyll plugin to pull ICS feed and provide a for-like loop of calendar events"
+  spec.homepage = "https://github.com/rakefire/jekyll-ical-tag"
+  spec.license = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.required_ruby_version = ">= 2.3.0"
+
+  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.require_paths = ["lib"]
+
+  spec.add_dependency "jekyll", "> 3"
+  spec.add_dependency "api_cache"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "icalendar"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rspec", "~> 3.5"
+end

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

@@ -0,0 +1,40 @@
+# 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)
+        @url = url
+        @only = only
+        @reverse = reverse
+        @before_date = before_date
+        @after_date = after_date
+        @limit = limit
+      end
+
+      def events
+        parser.events
+      end
+
+      private
+
+      attr_reader :url, :only, :reverse, :before_date, :after_date, :limit
+
+      def raw_ical
+        @raw_ical ||= CalendarFetcher.new(url).fetch
+      end
+
+      def parser
+        @parser ||= begin
+          parser = CalendarParser.new(raw_ical)
+          parser = CalendarLimiter.new(parser, only: only)
+          parser = CalendarLimiter.new(parser, reverse: reverse)
+          parser = CalendarLimiter.new(parser, before_date: before_date)
+          parser = CalendarLimiter.new(parser, after_date: after_date)
+          CalendarLimiter.new(parser, limit: limit)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require "cgi"
+require "api_cache"
+
+module Jekyll
+  class IcalTag
+    class CalendarFetcher
+      def initialize(url)
+        @url = CGI.unescape(url)
+
+        raise "No URL provided or in innapropriate form '#{url}'" unless is_valid_url?
+      end
+
+      def fetch
+        puts "Fetching #{url}"
+        @fetch ||= APICache.get(url)
+      end
+
+      private
+
+      attr_reader :url
+
+      def is_valid_url?
+        !!(url =~ URI::regexp)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Jekyll
+  class IcalTag
+    class CalendarLimiter
+      def initialize(parser, options = {})
+        @parser = parser
+        @options = options
+      end
+
+      def events
+        case
+        when options[:only] == :future
+          now = Time.now
+          parser.events.select do |event|
+            event.dtstart.to_time >= now
+          end
+        when options[:only] == :past
+          now = Time.now
+          parser.events.select do |event|
+            event.dtstart.to_time < now
+          end
+        when options[:reverse]
+          parser.events.reverse
+        when options[:after_date]
+          parser.events.select do |event|
+            event.dtstart.to_time >= options[:after_date]
+          end
+        when options[:before_date]
+          parser.events.select do |event|
+            event.dtstart.to_time < options[:before_date]
+          end
+        when options[:limit]
+          parser.events.first(options[:limit])
+        else
+          parser.events
+        end
+      end
+
+      private
+
+      attr_reader :parser, :options
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require "active_support"
+require "icalendar"
+
+module Jekyll
+  class IcalTag
+    class CalendarParser
+      def initialize(raw_feed)
+        @raw_feed = raw_feed
+      end
+
+      def events
+        @events ||= parsed_feed.sort { |event1, event2| event1.dtstart <=> event2.dtstart }
+                               .map { |event| Jekyll::IcalTag::Event.new(event) }
+      end
+
+      private
+
+      def parsed_feed
+        Icalendar::Event.parse(@raw_feed)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require "uri"
+require "active_support"
+
+module Jekyll
+  class IcalTag
+    class Event
+      URL_REGEX = /
+        (?:(?:https?|ftp):\/\/) # Allowable schemes
+        (?:\S+(?::\S*)?@)?      # username:password, which is optional
+        (?:                     # Domain part follows; non-capturing
+          # These IP addresses are valid domain values
+          (?!10(?:\.\d{1,3}){3})
+          (?!127(?:\.\d{1,3}){3})
+          (?!169\.254(?:\.\d{1,3}){2})
+          (?!192\.168(?:\.\d{1,3}){2})
+          (?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})
+          (?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])
+          (?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}
+          (?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))
+          |
+          (?:(?:[a-z\u00a1-\uffff0-9]+-?)*[a-z\u00a1-\uffff0-9]+)
+          (?:\.(?:[a-z\u00a1-\uffff0-9]+-?)*[a-z\u00a1-\uffff0-9]+)*
+          (?:\.(?:[a-z\u00a1-\uffff]{2,}))
+        )
+        (?::\d{2,5})?           # Optional port number
+        (?:\/[^\s"]*)?          # Anything that is not a space or a double quote
+        /x
+
+      def initialize(ical_event)
+        @ical_event = ical_event
+        setup_all_properties!
+        setup_property_accessor_methods!
+      end
+
+      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
+          end
+        end
+      end
+
+      def attendees
+        ical_event.attendee.map(&:to_s).map { |a| a.slice!("mailto:"); a }
+      end
+
+      def description_urls
+        return [] unless description
+
+        @description_urls ||= description.scan(URL_REGEX).to_a
+      end
+
+      private
+
+      attr_reader :ical_event
+
+      def setup_all_properties!
+        @all_properties ||= begin
+          props = {}
+
+          # RFC 5545 Properties
+          ical_event.class.properties.each do |property|
+            props[property] = ical_event.property(property)
+          end
+
+          # custom properties
+          props = props.merge(ical_event.custom_properties)
+
+          # Ensure all arrays get flattened to utf8 encoded strings
+          # Ensure all event values are utf8 encoded strings
+          # Ensure times (from dates)
+          # Ensure present
+          props.transform_values! do |value|
+            new_value =
+              case value
+              when Array, Icalendar::Values::Array
+                value.join("\n").force_encoding("UTF-8")
+              when String, Icalendar::Values::Text
+                value.force_encoding("UTF-8")
+              when Date, Icalendar::Values::DateTime
+                value.to_time
+              when Icalendar::Values::Uri
+                value.to_s
+              else
+                value
+              end
+
+            new_value.presence
+          end
+
+          props
+        end
+      end
+
+      def setup_property_accessor_methods!
+        all_properties.each do |prop, value|
+          define_singleton_method prop do
+            all_properties[prop]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class IcalTag < Liquid::Block
+    VERSION = "1.3.3"
+  end
+end