jekyll-ical-tag 1.3.3 → 1.4.0

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

@@ -0,0 +1,169 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require "jekyll"
+require "jekyll-ical-tag/version"
+
+module Jekyll
+  class IcalTag < Liquid::Block
+    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!
+      set_reverse!
+      set_url!
+      set_only!
+    end
+
+    def render(context)
+      context.registers[:ical] ||= Hash.new(0)
+
+      result = []
+
+      context.stack do
+        url = get_dereferenced_url(context) || @url
+        before_date = before_date_from(context)
+        after_date = after_date_from(context)
+
+        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
+          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"]
+
+          context["forloop"] = {
+            "name" => "ical",
+            "length" => event_count,
+            "index" => index + 1,
+            "index0" => index,
+            "rindex" => event_count - index,
+            "rindex0" => event_count - index - 1,
+            "first" => (index == 0),
+            "last" => (index == event_count - 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 get_dereferenced_url(context)
+      return unless context.key?(@url)
+
+      context[@url]
+    end
+
+    def after_date_from(context)
+      safely_cast_to_time(
+        dereferenced_liquid_val(context, "after_date")
+      ).tap { |v| pp v }
+    end
+
+    def before_date_from(context)
+
+      safely_cast_to_time(
+        dereferenced_liquid_val(context, "before_date")
+      ).tap { |v| pp v }
+    end
+
+    def safely_cast_to_time(val)
+      case val
+      when String
+        Time.parse(val)
+      when Date, DateTime, Time
+        val
+      when NilClass
+        # Do nothing
+      else
+        raise "Cannot cast to Time: #{val}"
+      end
+    end
+
+    def dereferenced_liquid_val(context, variable_name)
+      raw_value = @attributes[variable_name]
+
+      context.key?(raw_value) ? context[raw_value] : raw_value
+    end
+
+    def scan_attributes!
+      @markup.scan(Liquid::TagAttributes) do |key, value|
+        @attributes[key] = value
+      end
+    end
+
+    def set_limit!
+      @limit = nil
+      @limit = @attributes["limit"].to_i if @attributes["limit"]
+    end
+
+    def set_reverse!
+      @reverse = @attributes["reverse"] == "true"
+    end
+
+    def set_url!
+      @url = @attributes["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 =
+        if only_future
+          :future
+        elsif only_past
+          :past
+        else
+          :all
+        end
+    end
+  end
+end
+
+Liquid::Template.register_tag("ical", Jekyll::IcalTag)

data/_site/spec/calendar_feed_coordinator_spec.rb

@@ -0,0 +1,219 @@
+require "spec_helper"
+
+EXAMPLE_RAW_FEEDS = {
+  empty: "",
+  basic: File.read("spec/support/basic.ics"),
+  italian: File.read("spec/support/italian.ics"),
+  sesh: File.read("spec/support/sesh.ics")
+}
+
+RSpec.describe Jekyll::IcalTag::CalendarFeedCoordinator do
+  context "happy path" do
+    let(:coordinator) { Jekyll::IcalTag::CalendarFeedCoordinator.new(url: "https://space.floern.com/launch.ics") }
+
+    it "should not raise error" do
+      expect { coordinator.events }.to_not raise_error
+    end
+
+    it "should return accurate event count" do
+      expect(coordinator.events.count).to be > 0
+    end
+
+    it "should be able to parse all parse of each event" do
+      coordinator.events.each do |event|
+        expect { event.all_properties }.to_not raise_error
+        expect { event.simple_html_description }.to_not raise_error
+        expect { event.attendees }.to_not raise_error
+        expect { event.description_urls }.to_not raise_error
+      end
+    end
+  end
+
+  context "with empty feed" do
+    let(:fake_url) { "https://www.calendarfeed.com/feed.ics"}
+    let(:mock_feed) { double(:mock_feed, fetch: EXAMPLE_RAW_FEEDS[:empty])}
+
+    before do
+      allow(Jekyll::IcalTag::CalendarFetcher).to receive(:new).and_return(mock_feed)
+    end
+
+    let(:coordinator) { Jekyll::IcalTag::CalendarFeedCoordinator.new(url: fake_url) }
+
+    it "should not raise error" do
+      expect { coordinator.events }.to_not raise_error
+    end
+
+    it "should return accurate event count" do
+      expect(coordinator.events.count).to eq(0)
+    end
+  end
+
+  context "with basic feed" do
+    let(:fake_url) { "https://www.calendarfeed.com/feed.ics"}
+    let(:mock_feed) { double(:mock_feed, fetch: EXAMPLE_RAW_FEEDS[:basic])}
+    before { allow(Jekyll::IcalTag::CalendarFetcher).to receive(:new).and_return(mock_feed) }
+    let(:coordinator) { Jekyll::IcalTag::CalendarFeedCoordinator.new(url: fake_url) }
+
+    it "should not raise error" do
+      expect {
+        coordinator.events
+      }.to_not raise_error
+    end
+
+    it "should return accurate event count" do
+      expect(coordinator.events.count).to eq(66)
+    end
+
+    it "should be able to parse all parse of each event" do
+      coordinator.events.each do |event|
+        expect { event.all_properties }.to_not raise_error
+        expect { event.simple_html_description }.to_not raise_error
+        expect { event.attendees }.to_not raise_error
+        expect { event.description_urls }.to_not raise_error
+      end
+    end
+
+    it "should return dates from oldest to newest first" do
+      first_date = coordinator.events.first.dtstart.to_date
+      last_date = coordinator.events.last.dtstart.to_date
+
+      expect(first_date).to be < last_date
+    end
+
+    describe "limit" do
+      let(:coordinator) { Jekyll::IcalTag::CalendarFeedCoordinator.new(url: fake_url, limit: 5) }
+
+      it "should return accurate event count" do
+        expect(coordinator.events.count).to eq(5)
+      end
+    end
+
+    describe "only future" do
+      let(:coordinator) { Jekyll::IcalTag::CalendarFeedCoordinator.new(url: fake_url, only: :future) }
+
+      it "should return accurate event count" do
+        expect(coordinator.events.count).to eq(1)
+      end
+    end
+
+    describe "only past" do
+      let(:coordinator) { Jekyll::IcalTag::CalendarFeedCoordinator.new(url: fake_url, only: :past) }
+
+      it "should return accurate event count" do
+        expect(coordinator.events.count).to eq(65)
+      end
+    end
+
+    describe "only all" do
+      let(:coordinator) { Jekyll::IcalTag::CalendarFeedCoordinator.new(url: fake_url, only: :all) }
+
+      it "should return accurate event count" do
+        expect(coordinator.events.count).to eq(66)
+      end
+    end
+
+    describe "before date" do
+      let(:coordinator) { Jekyll::IcalTag::CalendarFeedCoordinator.new(url: fake_url, before_date: Date.parse("1/1/2020")) }
+
+      it "should return accurate event count" do
+        expect(coordinator.events.count).to eq(55)
+      end
+    end
+
+    describe "after date" do
+      let(:coordinator) { Jekyll::IcalTag::CalendarFeedCoordinator.new(url: fake_url, after_date: Date.parse("1/1/2020")) }
+
+      it "should return accurate event count" do
+        expect(coordinator.events.count).to eq(11)
+      end
+    end
+
+    describe "reverse" do
+      let(:coordinator) { Jekyll::IcalTag::CalendarFeedCoordinator.new(url: fake_url, reverse: true) }
+
+      it "should return dates from oldest to newest first" do
+        first_date = coordinator.events.first.dtstart.to_date
+        last_date = coordinator.events.last.dtstart.to_date
+
+        expect(first_date).to be > last_date
+      end
+    end
+  end
+
+  context "with italian feed" do
+    let(:fake_url) { "https://www.calendarfeed.com/feed.ics"}
+    let(:mock_feed) { double(:mock_feed, fetch: EXAMPLE_RAW_FEEDS[:italian])}
+    before { allow(Jekyll::IcalTag::CalendarFetcher).to receive(:new).and_return(mock_feed) }
+    let(:coordinator) { Jekyll::IcalTag::CalendarFeedCoordinator.new(url: fake_url) }
+
+    it "should not raise error" do
+      expect {
+        coordinator.events
+      }.to_not raise_error
+    end
+
+    it "should return accurate event count" do
+      expect(coordinator.events.count).to eq(10)
+    end
+
+    it "should be able to parse all parse of each event" do
+      coordinator.events.each do |event|
+        expect { event.all_properties }.to_not raise_error
+        expect { event.simple_html_description }.to_not raise_error
+        expect { event.attendees }.to_not raise_error
+        expect { event.description_urls }.to_not raise_error
+      end
+    end
+
+    it "selected outputs should always be strings" do
+      coordinator.events.each do |event|
+        expect(event.simple_html_description.to_s).to be_a String
+        expect(event.description.to_s).to be_a String
+        event.all_properties.each do |property, value|
+          expect(value).to be_a(Time)
+                           .or be_a(Date)
+                           .or be_a(String)
+                           .or be_a(NilClass)
+        end
+      end
+    end
+  end
+
+
+  context "with sesh feed" do
+    let(:fake_url) { "https://www.calendarfeed.com/feed.ics"}
+    let(:mock_feed) { double(:mock_feed, fetch: EXAMPLE_RAW_FEEDS[:sesh])}
+    before { allow(Jekyll::IcalTag::CalendarFetcher).to receive(:new).and_return(mock_feed) }
+    let(:coordinator) { Jekyll::IcalTag::CalendarFeedCoordinator.new(url: fake_url) }
+
+    it "should return accurate event count" do
+      expect(coordinator.events.count).to eq(3)
+    end
+
+    describe "reverse" do
+      let(:coordinator) { Jekyll::IcalTag::CalendarFeedCoordinator.new(url: fake_url, reverse: reverse) }
+
+      context "when reversed" do
+        let(:reverse) { true }
+
+        it "should return dates from oldest to newest first" do
+          first_date = coordinator.events.first.dtstart.to_date
+          last_date = coordinator.events.last.dtstart.to_date
+
+          expect(first_date).to be > last_date
+        end
+      end
+
+      context "when not reversed" do
+        let(:reverse) { false }
+
+        it "should return dates from oldest to newest first" do
+          first_date = coordinator.events.first.dtstart.to_date
+          last_date = coordinator.events.last.dtstart.to_date
+
+          expect(first_date).to be < last_date
+        end
+      end
+    end
+  end
+end

data/_site/spec/spec_helper.rb

@@ -0,0 +1,85 @@
+require "rspec"
+
+require "./lib/jekyll-ical-tag"
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It"s recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  # config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it"s useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end