jekyll-ical-tag 1.2.4 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56b34cd54ee295b4125928f2d1c0ab010fc73073f013afcd485d3f94f2f7d1e7
-  data.tar.gz: 6c04c4593314888e2f9f4dfbf13f9b3bd980d0739d5661bbf41243d1d8834cc8
+  metadata.gz: d7d1dce12392f01bb0a4d092684ffcec0dd51dd099a5c4d84634c2a4f5873785
+  data.tar.gz: 3bea7aac7663335f7df8928a10cff12bdc45a0ed0d59dc98530e18f35ca302ce
 SHA512:
-  metadata.gz: 69a6fd90da57c3b2b2a26065f83d4197d82e8e8fcba655acaba83485e56dd26a23dfda4b5353491027146045f740649ce01897552e9a433292fe45f9b88aa0bc
-  data.tar.gz: dbdbb209e8fdfed7653383ffac23c45b00579a4384789c8e11d01110de3f62fe92dae6701eb8dd231e8ab4f4d48a1979f563474b22895b1b5388b8d148004b2f
+  metadata.gz: 422e9632764d6c14a00aabab84592fde181f66782870de1d9eeaee7bdfa2c7531cf262c00ec16d25c13951490a8a937edfc746cd55387870169aebb3687cc58c
+  data.tar.gz: 6cc3cb90d9c76cfb50768522dc6c0205fdeab97baf621fe9be7983185724cbd1c79773f5c5027fb5fe527995706b25b186d97327b08399fb45a5caa3ae26fd8f

data/.gitignore

@@ -1,3 +1,5 @@
 .DS_Store
 .bundle
-*.gem
+*.gem
+
+spec/examples.txt

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile.lock

@@ -43,7 +43,7 @@ GEM
       sassc (> 2.0.1, < 3.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    kramdown (2.3.0)
+    kramdown (2.3.1)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
@@ -52,13 +52,15 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.3.6)
-    mini_portile2 (2.4.0)
+    mini_portile2 (2.5.0)
     minitest (5.14.1)
-    nokogiri (1.10.8)
-      mini_portile2 (~> 2.4.0)
+    nokogiri (1.11.0)
+      mini_portile2 (~> 2.5.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)
     rb-inotify (0.10.1)
       ffi (~> 1.0)

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

@@ -6,15 +6,18 @@ require "jekyll-ical-tag/version"
 
 module Jekyll
   class IcalTag < Liquid::Block
-    require_relative "jekyll-ical-tag/event"
-    require_relative "jekyll-ical-tag/calendar_parser"
+    require_relative "jekyll-ical-tag/calendar_feed_coordinator"
+    require_relative "jekyll-ical-tag/calendar_fetcher"
     require_relative "jekyll-ical-tag/calendar_limiter"
+    require_relative "jekyll-ical-tag/calendar_parser"
+    require_relative "jekyll-ical-tag/event"
 
     include Convertible
 
     def initialize(tag_name, markup, parse_context)
       super
       @markup = markup
+      @attributes = {}
 
       scan_attributes!
       set_limit!
@@ -31,22 +34,15 @@ module Jekyll
       result = []
 
       context.stack do
-        url = get_dereferenced_url(context) ||
-              @url
-
-        raise "No URL provided or in innapropriate form '#{url}'" unless is_valid_url?(url)
-
-        puts "Fetching #{url}"
+        url = get_dereferenced_url(context) || @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)
-
-        events = parser.events
-        length = events.length
+        calendar_feed_coordinator = CalendarFeedCoordinator.new(
+          url: url, only: @only, reverse: @reverse,
+          before_date: @before_date, after_date: @after_date,
+          limit: @limit
+        )
+        events = calendar_feed_coordinator.events
+        event_count = events.length
 
         events.each_with_index do |event, index|
           # Init
@@ -69,32 +65,15 @@ module Jekyll
           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",
-            "length" => length,
+            "length" => event_count,
             "index" => index + 1,
             "index0" => index,
-            "rindex" => length - index,
-            "rindex0" => length - index - 1,
+            "rindex" => event_count - index,
+            "rindex0" => event_count - index - 1,
             "first" => (index == 0),
-            "last" => (index == length - 1),
+            "last" => (index == event_count - 1),
           }
 
           result << nodelist.map do |n|
@@ -112,10 +91,6 @@ module Jekyll
 
     private
 
-    def is_valid_url?(url)
-      !!(url =~ URI::regexp)
-    end
-
     def get_dereferenced_url(context)
       return unless context.key?(@url)
 
@@ -123,7 +98,6 @@ module Jekyll
     end
 
     def scan_attributes!
-      @attributes = {}
       @markup.scan(Liquid::TagAttributes) do |key, value|
         @attributes[key] = value
       end
@@ -135,7 +109,7 @@ module Jekyll
     end
 
     def set_reverse!
-      @reverse = @attributes["order"] == "reverse"
+      @reverse = @attributes["reverse"] == "true"
     end
 
     def set_url!
@@ -147,10 +121,11 @@ module Jekyll
       only_past = @attributes["only_past"] == "true"
 
       raise "Set only_future OR only_past, not both" if only_future && only_past
-      @only = case
-        when only_future
+
+      @only =
+        if only_future
           :future
-        when only_past
+        elsif only_past
           :past
         else
           :all
@@ -158,21 +133,19 @@ module Jekyll
     end
 
     def set_before_date!
-      @before_date = begin
-          if @attributes["before_date"]
-            Time.parse(@attributes["before_date"])
-          end
-        rescue => e
+      @before_date =
+        begin
+          Time.parse(@attributes["before_date"])
+        rescue
           nil
         end
     end
 
     def set_after_date!
-      @after_date = begin
-          if @attributes["after_date"]
-            Time.parse(@attributes["after_date"])
-          end
-        rescue => e
+      @after_date =
+        begin
+          Time.parse(@attributes["after_date"])
+        rescue
           nil
         end
     end

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

@@ -1,29 +1,25 @@
 # encoding: utf-8
 # frozen_string_literal: true
 
-require "api_cache"
 require "active_support"
 require "icalendar"
 
 module Jekyll
   class IcalTag
     class CalendarParser
-      def initialize(url)
-        @url = URI.unescape(url)
+      def initialize(raw_feed)
+        @raw_feed = raw_feed
       end
 
       def events
-        @events ||= begin
-          Icalendar::Event.parse(ics_feed)
-                          .sort { |e1, e2| e1.dtstart <=> e2.dtstart }
-                          .map { |e| Jekyll::IcalTag::Event.new(e) }
-        end
+        @events ||= parsed_feed.sort { |event1, event2| event1.dtstart <=> event2.dtstart }
+                               .map { |event| Jekyll::IcalTag::Event.new(event) }
       end
 
       private
 
-      def ics_feed
-        @ics_feed ||= APICache.get(@url)
+      def parsed_feed
+        Icalendar::Event.parse(@raw_feed)
       end
     end
   end

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

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require "uri"
+require "active_support"
 
 module Jekyll
   class IcalTag
@@ -27,52 +28,84 @@ module Jekyll
         (?::\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
+      def initialize(ical_event)
+        @ical_event = ical_event
+        setup_all_properties!
+        setup_property_accessor_methods!
       end
 
-      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
+      attr_reader :all_properties
 
       def simple_html_description
         @simple_html_description ||= begin
-            description&.clone.tap do |d|
-              description_urls.each do |url|
-                d.force_encoding("UTF-8").gsub! url, %(<a href='#{url}'>#{url}</a>)
-              end
+          description.clone.tap do |description|
+            description_urls.each do |url|
+              description.gsub! url, %(<a href='#{url}'>#{url}</a>)
             end
           end
+        end
       end
 
       def attendees
-        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
-        @description_urls ||= description.to_s.force_encoding("UTF-8").scan(URL_REGEX).to_a
+        return [] unless description
+
+        @description_urls ||= description.scan(URL_REGEX).to_a
       end
 
       private
 
-      def_delegators :event, :description, :attendee
-      attr_reader :event
+      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/lib/jekyll-ical-tag/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-ical-tag
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.3
 platform: ruby
 authors:
 - Ricky Chilcott
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-10 00:00:00.000000000 Z
+date: 2021-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -102,13 +102,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - Gemfile.lock
 - README.md
-- _plugins/ical_tag.rb
 - bin/build-and-publish-gem
+- bin/rspec
 - jekyll-ical-tag.gemspec
 - lib/jekyll-ical-tag.rb
+- lib/jekyll-ical-tag/calendar_feed_coordinator.rb
+- lib/jekyll-ical-tag/calendar_fetcher.rb
 - lib/jekyll-ical-tag/calendar_limiter.rb
 - lib/jekyll-ical-tag/calendar_parser.rb
 - lib/jekyll-ical-tag/event.rb

data/_plugins/ical_tag.rb

@@ -1,187 +0,0 @@
-require "api_cache"
-require "active_support"
-require "icalendar"
-
-class CalendarParser
-  def initialize(url)
-    @url = URI.unescape(url)
-  end
-
-  def events
-    @events ||= Icalendar::Event.parse(ics_feed).sort { |e1, e2| e1.dtstart <=> e2.dtstart }
-  end
-
-  private
-
-  def ics_feed
-    @ics_feed ||= APICache.get(@url)
-  end
-end
-
-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].to_i)
-    else
-      parser.events
-    end
-  end
-
-  private
-
-  attr_reader :parser, :options
-end
-
-module Jekyll
-  class CalendarTag < Liquid::Block
-    include Convertible
-
-    def initialize(tag_name, markup, parse_context)
-      super
-
-      @markup = markup
-
-      scan_attributes!
-      set_reverse!
-      set_url!
-      set_only!
-      set_before_date!
-      set_after_date!
-    end
-
-    def render(context)
-      context.registers[:ical] ||= Hash.new(0)
-
-      result = []
-
-      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)
-
-      events = parser.events
-      length = events.length
-
-      context.stack do
-        events.each_with_index do |event, index|
-          attendees = event.attendee.map(&:to_s).map { |a| a.slice!("mailto:"); a }
-
-          context["event"] = {
-            "index" => index,
-            "uid" => event.uid,
-            "summary" => event.summary,
-            "description" => event.description,
-            "location" => event.location,
-            "url" => event.url&.to_s,
-            "start_time" => event.dtstart&.to_time,
-            "end_time" => event.dtend&.to_time,
-            "attendees" => attendees,
-          }
-
-          context["forloop"] = {
-            "name" => "calendar",
-            "length" => length,
-            "index" => index + 1,
-            "index0" => index,
-            "rindex" => length - index,
-            "rindex0" => length - index - 1,
-            "first" => (index == 0),
-            "last" => (index == length - 1),
-          }
-
-          result << nodelist.map do |n|
-            if n.respond_to? :render
-              n.render(context)
-            else
-              n
-            end
-          end.join
-        end
-      end
-
-      result
-    end
-
-    private
-
-    def scan_attributes!
-      @attributes = {}
-      @markup.scan(Liquid::TagAttributes) do |key, value|
-        @attributes[key] = value
-      end
-    end
-
-    def set_reverse!
-      @reverse = @attributes["order"] == "reverse"
-    end
-
-    def set_url!
-      @url = @attributes["url"]
-      raise "No URL provided" unless @url
-    end
-
-    def set_only!
-      only_future = @attributes["only_future"] == "true"
-      only_past = @attributes["only_past"] == "true"
-
-      raise "Set only_future OR only_past, not both" if only_future && only_past
-      @only = case
-        when only_future
-          :future
-        when only_past
-          :past
-        else
-          :all
-        end
-    end
-
-    def set_before_date!
-      @before_date = begin
-          if @attributes["before_date"]
-            Time.parse(@attributes["before_date"])
-          end
-        rescue => e
-          nil
-        end
-    end
-
-    def set_after_date!
-      @after_date = begin
-          if @attributes["after_date"]
-            Time.parse(@attributes["after_date"])
-          end
-        rescue => e
-          nil
-        end
-    end
-  end
-end
-
-Liquid::Template.register_tag("ical", Jekyll::CalendarTag)