jekyll-ical-tag 1.0.9 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0aa8b610c5113e232c010134e97b4ba1af55e07f92bba29cd820f1c2daaa0e1
-  data.tar.gz: fe4a3829d1a32311f773ab8c3825de673dec80586f2e49a569a57748d5475ff4
+  metadata.gz: cdb49ea6fd0b6d006435344649a8a7d30f19155f7e1424683d8774b59e9bdcf2
+  data.tar.gz: e323590a17d904763e2169446a2152b24eeb90629fd4f88bba0adbac1bde523c
 SHA512:
-  metadata.gz: 5848157e8929d51d128d372dd1d037f997ec74240ccf437bfe593deb70ec41b9299ef9364555dd2a290d235f984d413c9621706d012b38ab720e5f6aae9aeba3
-  data.tar.gz: ee10e4e946fd367ee92ae463f44a8873d7d834b60b1eb8b27f939e3acb2296077440992db42967f84658d854ce7832da40d974745903a9da9bca8832fb8d4413
+  metadata.gz: 6b3abd193f1de3eea850f2218ad8f42b7186e889b9915335a5da89418d59913898e09dc84e9f1d5fcf858eff2e9f49d4e0b960494fa2d930e3e2cfe75ff941a6
+  data.tar.gz: 93db87869c4f8d9b8c0e019a0e6c9bdd201d30a6b1edae8a0f1b1c3a68beeaa3fe1940435fbefb78cb521b2364b9955492657fb0f3f93278253e60232bb2c833

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/lib/jekyll-ical-tag.rb

@@ -30,35 +30,60 @@ module Jekyll
 
       result = []
 
-      set_url_from_assigned_value!(context)
-      set_url_from_page_attributes!(context)
+      context.stack do
+        url = get_url_from_assigned_value(context) ||
+              get_url_from_page_attributes(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
+              else
+                value
+              end
+            v.presence
+          end
 
           context["forloop"] = {
             "name" => "ical",
@@ -86,34 +111,23 @@ module Jekyll
 
     private
 
-    def has_valid_url?
-      !!(@url =~ URI::regexp)
+    def is_valid_url?(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
-
+    def get_url_from_page_attributes(context)
+      # 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]
+      context.registers.dig(*dig_attrs) # will return result or nil (if not found)
     end
 
-    def as_utf8(str)
-      return unless str
+    def get_url_from_assigned_value(context)
+      return unless scope = context.scopes.find { |scope| scope[@url] }
 
-      str.force_encoding("UTF-8")
+      # Dereference the URL if we were passed a variable name.
+      scope[@url]
     end
 
     def scan_attributes!

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

@@ -13,7 +13,23 @@ module Jekyll
         @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
@@ -35,6 +51,7 @@ module Jekyll
 
       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.1.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-ical-tag
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.1.0
 platform: ruby
 authors:
 - Ricky Chilcott