jekyll-ical-tag 1.0.9 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0aa8b610c5113e232c010134e97b4ba1af55e07f92bba29cd820f1c2daaa0e1
-  data.tar.gz: fe4a3829d1a32311f773ab8c3825de673dec80586f2e49a569a57748d5475ff4
+  metadata.gz: 299387790191b2247ec79cfed707a29b6e1e6f52585f5abaff7de47b9706dae7
+  data.tar.gz: 8123a5b839ec83de6a63a11a7fbcf9a2b1318ae9c1b4713a85561dacb83948a0
 SHA512:
-  metadata.gz: 5848157e8929d51d128d372dd1d037f997ec74240ccf437bfe593deb70ec41b9299ef9364555dd2a290d235f984d413c9621706d012b38ab720e5f6aae9aeba3
-  data.tar.gz: ee10e4e946fd367ee92ae463f44a8873d7d834b60b1eb8b27f939e3acb2296077440992db42967f84658d854ce7832da40d974745903a9da9bca8832fb8d4413
+  metadata.gz: c890d519e3f4922732f9f086fc73e97e1fec970379f256ef35c337793cc4e2e4c0f08b63a9e5843e89b5e76e9f87b70bbd326a59d24828d9c8ee05256d0be19c
+  data.tar.gz: cb75fe2e7b9d45a2d75168fd32db14566f1811bef15534f6af428db700acf6f3c76f4fc1a5de43432adda7c834f50ec09aa82a69dc68cd22bb64ddc6facaec04

data/Gemfile

@@ -7,7 +7,6 @@ gem 'icalendar'
 gem 'activesupport'
 
 group :development, :test do
-  gem 'pry'
   gem 'rspec'
   gem 'nokogiri'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.1)
+    activesupport (5.2.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -9,9 +9,8 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     api_cache (0.3.0)
-    coderay (1.1.2)
     colorator (1.1.0)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.6)
     diff-lcs (1.3)
     em-websocket (0.5.1)
       eventmachine (>= 0.12.9)
@@ -20,7 +19,7 @@ GEM
     ffi (1.12.2)
     forwardable-extended (2.6.0)
     http_parser.rb (0.6.0)
-    i18n (1.1.1)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
     icalendar (2.5.0)
       ice_cube (~> 0.16)
@@ -44,7 +43,8 @@ GEM
       sassc (> 2.0.1, < 3.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    kramdown (2.1.0)
+    kramdown (2.3.0)
+      rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     liquid (4.0.3)
@@ -52,20 +52,17 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.3.6)
-    method_source (0.9.0)
     mini_portile2 (2.4.0)
-    minitest (5.11.3)
+    minitest (5.14.1)
     nokogiri (1.10.8)
       mini_portile2 (~> 2.4.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
     public_suffix (4.0.3)
     rb-fsevent (0.10.3)
     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)
@@ -86,7 +83,7 @@ GEM
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
 
@@ -99,7 +96,6 @@ DEPENDENCIES
   icalendar
   jekyll
   nokogiri
-  pry
   rspec
 
 BUNDLED WITH

data/README.md

@@ -43,14 +43,21 @@ plugins:
 
 ## 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
-- `simple_html_description` - Notes/description of event with urls auto-linked
 - `location` - Location of event
-- `start_time` - start time of event
-- `end_time` - end time 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
 

data/jekyll-ical-tag.gemspec

@@ -34,7 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "api_cache"
   spec.add_dependency "activesupport"
   spec.add_dependency "icalendar"
-  spec.add_dependency "pry"
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rspec", "~> 3.5"

data/lib/jekyll-ical-tag.rb

@@ -30,35 +30,61 @@ module Jekyll
 
       result = []
 
-      set_url_from_assigned_value!(context)
-      set_url_from_page_attributes!(context)
+      context.stack do
+        url = get_dereferenced_url(context) ||
+              @url
 
-      raise "No URL provided or in innapropriate form '#{@url}'" unless has_valid_url?
+        raise "No URL provided or in innapropriate form '#{url}'" unless is_valid_url?(url)
 
-      parser = CalendarParser.new(@url)
-      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)
-      parser = CalendarLimiter.new(parser, limit: @limit)
+        puts "Fetching #{url}"
 
-      events = parser.events
-      length = events.length
+        parser = CalendarParser.new(url)
+        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)
+        parser = CalendarLimiter.new(parser, limit: @limit)
+
+        events = parser.events
+        length = events.length
 
-      context.stack do
         events.each_with_index do |event, index|
-          context["event"] = {
-            "index" => index,
-            "uid" => event.uid.presence,
-            "summary" => as_utf8(event.summary).presence,
-            "description" => as_utf8(event.description).presence,
-            "simple_html_description" => as_utf8(event.simple_html_description).presence,
-            "location" => as_utf8(event.location).presence,
-            "url" => as_utf8(event.url&.to_s.presence || event.description_urls.first).presence,
-            "start_time" => event.dtstart&.to_time.presence,
-            "end_time" => event.dtend&.to_time.presence,
-            "attendees" => event.attendees,
-          }
+          # Init
+          context["event"] = {}
+
+          # Jekyll helper variables
+          context["event"]["index"] = index
+
+          # RFC 5545 conformant and custom properties.
+          context["event"].merge!(event.all_properties)
+
+          # Supported but non-standard attributes.
+          context["event"]["attendees"] = event.attendees
+          context["event"]["simple_html_description"] = event.simple_html_description
+
+          # Overridden values
+          context["event"]["url"] ||= event.description_urls.first
+
+          # Deprecated attribute names.
+          context["event"]["end_time"] = context["event"]["dtend"]
+          context["event"]["start_time"] = context["event"]["dtstart"]
+
+          # Ensure all event values are utf8 encoded strings
+          # Ensure times (from dates)
+          # Ensure present
+          context["event"].transform_values! do |value|
+            v = case value
+              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
+            v.presence
+          end
 
           context["forloop"] = {
             "name" => "ical",
@@ -86,34 +112,14 @@ module Jekyll
 
     private
 
-    def has_valid_url?
-      !!(@url =~ URI::regexp)
-    end
-
-    def set_url_from_page_attributes!(context)
-      return if has_valid_url?
-
-      # Dereference @url from something like "page.calender_url" to the page's calendar_url
-
-      dig_attrs = @url.split(".")
-      dig_attrs[0] = dig_attrs[0].to_sym if dig_attrs[0].present?
-      if dug_result = context.registers.dig(*dig_attrs)
-        @url = dug_result
-      end
-    end
-
-    def set_url_from_assigned_value!(context)
-      return if has_valid_url?
-      return unless context.scopes.first[@url]
-
-      # Dereference the URL if we were passed a variable name.
-      @url = context.scopes.first[@url]
+    def is_valid_url?(url)
+      !!(url =~ URI::regexp)
     end
 
-    def as_utf8(str)
-      return unless str
+    def get_dereferenced_url(context)
+      return unless context.key?(@url)
 
-      str.force_encoding("UTF-8")
+      context[@url]
     end
 
     def scan_attributes!

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

@@ -6,20 +6,56 @@ require "uri"
 module Jekyll
   class IcalTag
     class Event
-      URL_REGEX = /(?:(?:https?|ftp):\/\/)(?:\S+(?::\S*)?@)?(?:(?!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})?(?:\/[^\s]*)?/
+      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
       extend Forwardable
 
       def initialize(event)
         @event = event
       end
 
-      def_delegators :event, :attendee, :uid, :summary, :description, :location, :url, :dtstart, :dtend
+      def_delegators :event, :dtstart, :dtend
+
+      def all_properties
+        @props ||= begin
+            props = {}
+
+            # RFC 5545 Properties
+            event.class.properties.each do |property|
+              props[property] = event.property(property)
+            end
+
+            # custom properties
+            props = props.merge(event.custom_properties)
+
+            props
+          end
+      end
 
       def simple_html_description
         @simple_html_description ||= begin
             description&.clone.tap do |d|
               description_urls.each do |url|
-                d.gsub! url, %(<a href='#{url}'>#{url}</a>)
+                d.force_encoding("UTF-8").gsub! url, %(<a href='#{url}'>#{url}</a>)
               end
             end
           end
@@ -30,11 +66,12 @@ module Jekyll
       end
 
       def description_urls
-        @description_urls ||= description.to_s.scan(URL_REGEX).to_a
+        @description_urls ||= description.to_s.force_encoding("UTF-8").scan(URL_REGEX).to_a
       end
 
       private
 
+      def_delegators :event, :description, :attendee
       attr_reader :event
     end
   end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-ical-tag
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.2.3
 platform: ruby
 authors:
 - Ricky Chilcott
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-08 00:00:00.000000000 Z
+date: 2020-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  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
@@ -108,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
-description: 
+description:
 email:
 - ricky@rakefire.io
 executables: []
@@ -132,7 +118,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A Jekyll plugin to pull ICS feed and provide a for-like loop of calendar
   events