rams-jekyll-feed 0.13.0

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/appveyor.yml

@@ -0,0 +1,29 @@
+version: "{build}"
+clone_depth: 5
+build: off
+
+environment:
+  NOKOGIRI_USE_SYSTEM_LIBRARIES: true
+  JEKYLL_VERSION: "~> 3.8"
+  matrix:
+    - RUBY_FOLDER_VER: "26"
+      JEKYLL_VERSION : "~> 3.7.4"
+    - RUBY_FOLDER_VER: "26"
+      JEKYLL_VERSION : ">= 4.0.0.pre.alpha1"
+    - RUBY_FOLDER_VER: "26"
+    - RUBY_FOLDER_VER: "24"
+    - RUBY_FOLDER_VER: "23"
+
+install:
+  - SET PATH=C:\Ruby%RUBY_FOLDER_VER%-x64\bin;%PATH%
+  - bundle install --retry 5 --jobs=%NUMBER_OF_PROCESSORS% --clean --path vendor\bundle
+
+test_script:
+  - ruby --version
+  - gem --version
+  - bundler --version
+  - bash ./script/test
+
+cache:
+  # If one of the files after the right arrow changes, cache will be invalidated
+  - 'vendor\bundle -> appveyor.yml, Gemfile, jekyll-feed.gemspec'

data/lib/jekyll-feed.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "fileutils"
+require "jekyll-feed/generator"
+
+module JekyllFeed
+  autoload :MetaTag,          "jekyll-feed/meta-tag"
+  autoload :PageWithoutAFile, "jekyll-feed/page-without-a-file.rb"
+end
+
+Liquid::Template.register_tag "feed_meta", JekyllFeed::MetaTag

data/lib/jekyll-feed/feed.xml

@@ -0,0 +1,96 @@
+<?xml version="1.0" encoding="utf-8"?>
+{% if page.xsl %}
+  <?xml-stylesheet type="text/xml" href="{{ '/feed.xslt.xml' | absolute_url }}"?>
+{% endif %}
+<feed xmlns="http://www.w3.org/2005/Atom" {% if site.lang %}xml:lang="{{ site.lang }}"{% endif %}>
+  <generator uri="https://jekyllrb.com/" version="{{ jekyll.version }}">Jekyll</generator>
+  <link href="{{ page.url | absolute_url }}" rel="self" type="application/atom+xml" />
+  <link href="{{ '/' | absolute_url }}" rel="alternate" type="text/html" {% if site.lang %}hreflang="{{ site.lang }}" {% endif %}/>
+  <updated>{{ site.time | date_to_xmlschema }}</updated>
+  <id>{{ page.url | absolute_url | xml_escape }}</id>
+
+  {% assign title = site.title | default: site.name %}
+  {% if page.collection != "posts" %}
+    {% assign collection = page.collection | capitalize %}
+    {% assign title = title | append: " | " | append: collection %}
+  {% endif %}
+  {% if page.category %}
+    {% assign category = page.category | capitalize %}
+    {% assign title = title | append: " | " | append: category %}
+  {% endif %}
+
+  {% if title %}
+    <title type="html">{{ title | smartify | xml_escape }}</title>
+  {% endif %}
+
+  {% if site.description %}
+    <subtitle>{{ site.description | xml_escape }}</subtitle>
+  {% endif %}
+
+  {% if site.author %}
+    <author>
+        <name>{{ site.author.name | default: site.author | xml_escape }}</name>
+      {% if site.author.email %}
+        <email>{{ site.author.email | xml_escape }}</email>
+      {% endif %}
+      {% if site.author.uri %}
+        <uri>{{ site.author.uri | xml_escape }}</uri>
+      {% endif %}
+    </author>
+  {% endif %}
+
+  {% assign posts = site[page.collection] | where_exp: "post", "post.draft != true" | sort: "date" | reverse %}
+  {% if page.category %}
+    {% assign posts = posts | where: "category",page.category %}
+  {% endif %}
+  {% for post in posts %}
+    <entry{% if post.lang %}{{" "}}xml:lang="{{ post.lang }}"{% endif %}>
+      <title type="html">{{ post.title | smartify | strip_html | normalize_whitespace | xml_escape }}</title>
+      <link href="{{ post.url | absolute_url }}" rel="alternate" type="text/html" title="{{ post.title | xml_escape }}" />
+      <published>{{ post.date | date_to_xmlschema }}</published>
+      <updated>{{ post.last_modified_at | default: post.date | date_to_xmlschema }}</updated>
+      <id>{{ post.id | absolute_url | xml_escape }}</id>
+      {% assign excerpt_only = post.feed.excerpt_only | default: site.feed.excerpt_only %}
+      {% unless excerpt_only %}
+        <content type="html" xml:base="{{ post.url | absolute_url | xml_escape }}">{{ post.content | strip | xml_escape }}</content>
+      {% endunless %}
+
+      {% assign post_author = post.author | default: post.authors[0] | default: site.author %}
+      {% assign post_author = site.data.authors[post_author] | default: post_author %}
+      {% assign post_author_email = post_author.email | default: nil %}
+      {% assign post_author_uri = post_author.uri | default: nil %}
+      {% assign post_author_name = post_author.name | default: post_author %}
+
+      <author>
+          <name>{{ post_author_name | default: "" | xml_escape }}</name>
+        {% if post_author_email %}
+          <email>{{ post_author_email | xml_escape }}</email>
+        {% endif %}
+        {% if post_author_uri %}
+          <uri>{{ post_author_uri | xml_escape }}</uri>
+        {% endif %}
+      </author>
+
+      {% if post.category %}
+        <category term="{{ post.category | xml_escape }}" />
+      {% endif %}
+
+      {% for tag in post.tags %}
+        <category term="{{ tag | xml_escape }}" />
+      {% endfor %}
+
+      {% if post.excerpt and post.excerpt != empty %}
+        <summary type="html">{{ post.excerpt | strip_html | normalize_whitespace | xml_escape }}</summary>
+      {% endif %}
+
+      {% assign post_image = post.image.path | default: post.image %}
+      {% if post_image %}
+        {% unless post_image contains "://" %}
+          {% assign post_image = post_image | absolute_url %}
+        {% endunless %}
+        <media:thumbnail xmlns:media="http://search.yahoo.com/mrss/" url="{{ post_image | xml_escape }}" />
+        <media:content medium="image" url="{{ post_image | xml_escape }}" xmlns:media="http://search.yahoo.com/mrss/" />
+      {% endif %}
+    </entry>
+  {% endfor %}
+</feed>

data/lib/jekyll-feed/generator.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module JekyllFeed
+  class Generator < Jekyll::Generator
+    safe true
+    priority :lowest
+
+    # Main plugin action, called by Jekyll-core
+    def generate(site)
+      @site = site
+      collections.each do |name, meta|
+        Jekyll.logger.info "Jekyll Feed:", "Generating feed for #{name}"
+        (meta["categories"] + [nil]).each do |category|
+          path = feed_path(:collection => name, :category => category)
+          next if file_exists?(path)
+
+          @site.pages << make_page(path, :collection => name, :category => category)
+        end
+      end
+    end
+
+    private
+
+    # Matches all whitespace that follows
+    #   1. A '>', which closes an XML tag or
+    #   2. A '}', which closes a Liquid tag
+    # We will strip all of this whitespace to minify the template
+    MINIFY_REGEX = %r!(?<=>|})\s+!.freeze
+
+    # Returns the plugin's config or an empty hash if not set
+    def config
+      @config ||= @site.config["feed"] || {}
+    end
+
+    # Determines the destination path of a given feed
+    #
+    # collection - the name of a collection, e.g., "posts"
+    # category - a category within that collection, e.g., "news"
+    #
+    # Will return "/feed.xml", or the config-specified default feed for posts
+    # Will return `/feed/category.xml` for post categories
+    # WIll return `/feed/collection.xml` for other collections
+    # Will return `/feed/collection/category.xml` for other collection categories
+    def feed_path(collection: "posts", category: nil)
+      prefix = collection == "posts" ? "/feed" : "/feed/#{collection}"
+      return "#{prefix}/#{category}.xml" if category
+
+      collections.dig(collection, "path") || "#{prefix}.xml"
+    end
+
+    # Returns a hash representing all collections to be processed and their metadata
+    # in the form of { collection_name => { categories = [...], path = "..." } }
+    def collections
+      return @collections if defined?(@collections)
+
+      @collections = if config["collections"].is_a?(Array)
+                       config["collections"].map { |c| [c, {}] }.to_h
+                     elsif config["collections"].is_a?(Hash)
+                       config["collections"]
+                     else
+                       {}
+                     end
+
+      @collections = normalize_posts_meta(@collections)
+      @collections.each_value do |meta|
+        meta["categories"] = (meta["categories"] || []).to_set
+      end
+
+      @collections
+    end
+
+    # Path to feed.xml template file
+    def feed_source_path
+      @feed_source_path ||= File.expand_path "feed.xml", __dir__
+    end
+
+    def feed_template
+      @feed_template ||= File.read(feed_source_path).gsub(MINIFY_REGEX, "")
+    end
+
+    # Checks if a file already exists in the site source
+    def file_exists?(file_path)
+      File.exist? @site.in_source_dir(file_path)
+    end
+
+    # Generates contents for a file
+
+    def make_page(file_path, collection: "posts", category: nil)
+      PageWithoutAFile.new(@site, __dir__, "", file_path).tap do |file|
+        file.content = feed_template
+        file.data.merge!(
+          "layout"     => nil,
+          "sitemap"    => false,
+          "xsl"        => file_exists?("feed.xslt.xml"),
+          "collection" => collection,
+          "category"   => category
+        )
+        file.output
+      end
+    end
+
+    # Special case the "posts" collection, which, for ease of use and backwards
+    # compatability, can be configured via top-level keys or directly as a collection
+    def normalize_posts_meta(hash)
+      hash["posts"] ||= {}
+      hash["posts"]["path"] ||= config["path"]
+      hash["posts"]["categories"] ||= config["categories"]
+      config["path"] ||= hash["posts"]["path"]
+      hash
+    end
+  end
+end

data/lib/jekyll-feed/meta-tag.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module JekyllFeed
+  class MetaTag < Liquid::Tag
+    # Use Jekyll's native relative_url filter
+    include Jekyll::Filters::URLFilters
+
+    def render(context)
+      @context = context
+      attrs    = attributes.map { |k, v| %(#{k}="#{v}") }.join(" ")
+      "<link #{attrs} />"
+    end
+
+    private
+
+    def config
+      @config ||= @context.registers[:site].config
+    end
+
+    def attributes
+      {
+        :type  => "application/atom+xml",
+        :rel   => "alternate",
+        :href  => absolute_url(path),
+        :title => title,
+      }.keep_if { |_, v| v }
+    end
+
+    def path
+      config.dig("feed", "path") || "feed.xml"
+    end
+
+    def title
+      config["title"] || config["name"]
+    end
+  end
+end

data/lib/jekyll-feed/page-without-a-file.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module JekyllFeed
+  class PageWithoutAFile < Jekyll::Page
+    def read_yaml(*)
+      @data ||= {}
+    end
+  end
+end

data/lib/jekyll-feed/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Feed
+    VERSION = "0.13.0"
+  end
+end

data/rams-jekyll-feed.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll-feed/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rams-jekyll-feed"
+  spec.version       = Jekyll::Feed::VERSION
+  spec.authors       = ["Ram Patra"]
+  spec.email         = ["hi@rampatra.com"]
+  spec.summary       = "A Jekyll plugin to generate an Atom feed of your Jekyll posts without the hard limit of 10 posts."
+  spec.homepage      = "https://github.com/rampatra/jekyll-feed"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r!^spec/!)
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.add_dependency "jekyll", ">= 3.7", "< 5.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "nokogiri", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop-jekyll", "~> 0.5"
+  spec.add_development_dependency "typhoeus", ">= 0.7", "< 2.0"
+end

data/script/bootstrap

@@ -0,0 +1,3 @@
+#! /bin/bash
+
+bundle install

data/script/cibuild

@@ -0,0 +1,7 @@
+#! /bin/bash
+
+set -e
+
+script/test
+script/fmt
+bundle exec rake build

data/script/fmt

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -e
+
+echo "Rubocop $(bundle exec rubocop --version)"
+bundle exec rubocop -D -E $@
+success=$?
+if ((success != 0)); then
+   echo -e "\nTry running \`script/fmt -a\` to automatically fix errors"
+fi
+exit $success

data/script/release

@@ -0,0 +1,7 @@
+#!/bin/sh
+# Tag and push a release.
+
+set -e
+
+script/cibuild
+bundle exec rake release

data/script/test

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -ex
+
+bundle exec rspec "$@"

data/spec/fixtures/_collection/2018-01-01-collection-doc.md

@@ -0,0 +1,4 @@
+---
+---
+
+Look at me! I'm a collection!

data/spec/fixtures/_collection/2018-01-02-collection-category-doc.md

@@ -0,0 +1,5 @@
+---
+category: news
+---
+
+Look at me! I'm a collection doc in a category!

data/spec/fixtures/_config.yml

@@ -0,0 +1,9 @@
+timezone: UTC
+
+defaults:
+  -
+    scope:
+      path: ""
+      type: pages
+    values:
+      layout: some_default

data/spec/fixtures/_data/authors.yml

@@ -0,0 +1,5 @@
+garthdb:
+  name: Garth
+  twitter: garthdb
+  uri: "http://garthdb.com"
+  email: example@mail.com

data/spec/fixtures/_drafts/2015-01-12-a-draft.md

@@ -0,0 +1,4 @@
+---
+---
+
+This is a draft.

data/spec/fixtures/_layouts/some_default.html

@@ -0,0 +1,11 @@
+---
+---
+<html>
+  <head>
+    {% feed_meta %}
+  </head>
+  <body>
+THIS IS MY LAYOUT
+{{ content }}
+  </body>
+</html>

data/spec/fixtures/_posts/2013-12-12-dec-the-second.md

@@ -0,0 +1,7 @@
+---
+excerpt: "Foo"
+image: "/image.png"
+category: news
+---
+
+# December the twelfth, actually.