jekyll-ical-tag 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b682456bd14cbe8d3461a834f13069b3a3f21b784262cd34539544f7f75cf1d
+  data.tar.gz: 7b8e9cf431e0461b8e42e8dd9dee886e3ac162b3ea98803827b1f4eca7f8dc14
+SHA512:
+  metadata.gz: 2f85c6e83e0169978388495bb42ed92a4015aa6a7db3445fd574e056f23de724980933c466415ef50a26214dd3150a29640d163b21a2c86266eaf1bdb43c740a
+  data.tar.gz: 6616759701233047f4fd9994ff4d2d58426900d3e30fb46fcf19628719d400b9ffa86321417ea0876ac3bea6d0b257f8922fe73be526c5ebb410b2e73253bdb2

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+.bundle

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gem 'jekyll', require: false
+
+gem 'api_cache'
+gem 'icalendar'
+gem 'activesupport'
+
+group :development, :test do
+  gem 'pry'
+  gem 'rspec'
+  gem 'nokogiri'
+end

data/Gemfile.lock

@@ -0,0 +1,97 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    api_cache (0.3.0)
+    coderay (1.1.2)
+    colorator (1.1.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    ffi (1.9.25)
+    forwardable-extended (2.6.0)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    icalendar (2.5.0)
+      ice_cube (~> 0.16)
+    ice_cube (0.16.3)
+    jekyll (3.6.3)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.14)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 3)
+      safe_yaml (~> 1.0)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
+    jekyll-watch (1.5.1)
+      listen (~> 3.0)
+    kramdown (1.17.0)
+    liquid (4.0.1)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    mercenary (0.3.6)
+    method_source (0.9.0)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
+    pathutil (0.16.1)
+      forwardable-extended (~> 2.6)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rouge (2.2.1)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    ruby_dep (1.5.0)
+    safe_yaml (1.0.4)
+    sass (3.6.0)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  api_cache
+  icalendar
+  jekyll
+  nokogiri
+  pry
+  rspec
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,52 @@
+# 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', git: "https://github.com/Rakefire/jekyll-ical-tag.git"`
+
+To your `_config.yml`
+
+```yml
+plugins:
+  - jekyll-ical-tag
+```
+
+## Syntax
+
+```html
+  {% calendar 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 }}
+  {% endcalendar %}
+```
+
+## 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).
+
+## Event Attributes:
+
+- `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.
+- `attendees` - [Array] of attendees names/emails

data/_plugins/ical_tag.rb

@@ -0,0 +1,189 @@
+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
+    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)

data/jekyll-ical-tag.gemspec

@@ -0,0 +1,41 @@
+# 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.3"
+  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"
+end

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

@@ -0,0 +1,43 @@
+# 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
+        else
+          parser.events
+        end
+      end
+
+      private
+
+      attr_reader :parser, :options
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# 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)
+      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
+      end
+
+      private
+
+      def ics_feed
+        @ics_feed ||= APICache.get(@url)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+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]*)?/
+      extend Forwardable
+
+      def initialize(event)
+        @event = event
+      end
+
+      def_delegators :event, :attendee, :uid, :summary, :description, :location, :url, :dtstart, :dtend
+
+      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>)
+            end
+          end
+        end
+      end
+
+      def attendees
+        attendee.map(&:to_s).map {|a| a.slice!("mailto:"); a }
+      end
+
+      def description_urls
+        @description_urls ||= description.scan(URL_REGEX).to_a
+      end
+
+      private
+
+      attr_reader :event
+    end
+  end
+end

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

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

data/lib/jekyll-ical-tag.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "jekyll-ical-tag/version"
+require "pry"
+
+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_limiter"
+
+    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|
+          context['event'] = {
+            'index' => index,
+            'uid' => event.uid.presence,
+            'summary' => event.summary.presence,
+            'description' => event.description.presence,
+            'simple_html_description' => event.simple_html_description.presence,
+            'location' => event.location.presence,
+            'url' => event.url&.to_s.presence || event.description_urls.first,
+            'start_time' => event.dtstart&.to_time.presence,
+            'end_time' => event.dtend&.to_time.presence,
+            'attendees' => event.attendees,
+          }
+
+          context['forloop'] = {
+            'name' => 'ical',
+            '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::IcalTag)

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-ical-tag
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Ricky Chilcott
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: api_cache
+  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: activesupport
+  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: icalendar
+  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: 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: 
+email:
+- ricky@rakefire.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- _plugins/ical_tag.rb
+- jekyll-ical-tag.gemspec
+- lib/jekyll-ical-tag.rb
+- lib/jekyll-ical-tag/calendar_limiter.rb
+- lib/jekyll-ical-tag/calendar_parser.rb
+- lib/jekyll-ical-tag/event.rb
+- lib/jekyll-ical-tag/version.rb
+homepage: https://github.com/rakefire/jekyll-ical-tag
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A Jekyll plugin to pull ICS feed and provide a for-like loop of calendar
+  events
+test_files: []