jekyll-feed 0.9.0 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dd1897a15ad66d115a4e4fba2981d29bf41b5c87
-  data.tar.gz: da12a240d6bca1c5e4fd64b24864c783d85ffd77
+SHA256:
+  metadata.gz: e8f1fde42e53f27b048363aa57f03f5d51a3f68fbe6af4e0ffb69209b373ffeb
+  data.tar.gz: aaaa1c370f29527e3806c6753ae76a2fa8297337f0e667f25fd43d05779fcfef
 SHA512:
-  metadata.gz: c8b68581ece18c4615341881ee3ade2c33f87cbd38eb93c0085589b2f9e44b677ca615596408a05422657c1f8ddef51acb588c9bc565cfdc3d46a442c72a7b1f
-  data.tar.gz: 6a0fe34bcb0044dac585c0f552981ad781a54a6e8cd1c62d4c58d25a9b594f5133b2eac01286a58d2760bb43b30221ce0912e85bce3ec57a15439d8af0632fca
+  metadata.gz: 6800a223adf7b8c6ae236d6b9d3e355d4ca31c7d2e67752cfd2cb5b3fe599ddda2d9c6f28a38a7c6d5e648ac67ca585fe6fe2a2e08f38c158a1b6a95ded11fd7
+  data.tar.gz: a17bf5e936302721494bba9028ccda96ca88a4e229e0b1c88e6abe63f1ee2c60e3992296da05721d30400952fcc0ccafe4a2bd179038553ee57d3c940a1d04e9

data/History.markdown

@@ -1,3 +1,118 @@
+## HEAD
+
+## 0.15.1 / 2020-10-04
+
+### Bug Fixes
+
+  * MetaTag: when encoding for XML special characters, handle non-string objects (#326)
+
+## 0.15.0 / 2020-07-10
+
+### Minor Enhancements
+
+  * Add support for drafts (#316)
+
+## 0.14.0 / 2020-06-24
+
+### Minor Enhancements
+
+  * add support for categories (#153) (#233)
+  * add support for tags (#264)
+  * Make posts limit configurable (#314)
+  * XML escape the title field of feed_meta (#306)
+
+### Bug Fixes
+
+  * Fix feed link when post title contains HTML (#305)
+
+### Development Fixes
+
+  * Use Dir to list source files (#309)
+  * Require Ruby >=2.4.0 (#307)
+
+## 0.13.0 / 2019-11-13
+
+### Minor Enhancements
+
+  * Excerpt only flag (#287)
+  * Add media:content tag (#290)
+
+### Development Fixes
+
+  * test: use categories in post (#249)
+
+## 0.12.1 / 2019-03-23
+
+### Bug Fixes
+
+  * Re-introduce Ruby 2.3 support and test Jekyll 3.7+ (#272)
+
+## 0.12.0 / 2019-03-21
+
+  * Allow Jekyll v4 (still alpha)
+
+### Development Fixes
+
+  * style: fix offenses in specs (#248)
+  * dev: update CI and style settings (#258)
+  * Enable testing for Windows platform (#265)
+
+## 0.11.0 / 2018-09-09
+
+### Development Fixes
+
+  * Require Ruby 2.3 (#222)
+  * Refactor to remove redundant calls and variables (#240)
+
+### Minor Enhancements
+
+  * Categories and collections (#228)
+  * Remove check for older version of Jekyll (#234)
+
+## 0.10.0 / 2018-06-04
+
+### Bug Fixes
+
+  * Escape image URL (#209)
+
+### Development Fixes
+
+  * Rubocop 0.55 (#223)
+  * Bump Rubocop (#230)
+
+### Minor Enhancements
+
+  * Support Typhoeus 1.0 (#232)
+
+## 0.9.3 / 2018-02-04
+
+  * Define path with __dir (#187)
+  * Bump Ruby for Travis (#188)
+
+### Documentation
+
+  * Fix: Add note about using plugins instead of gems key (#197)
+  * Add documentation for disabling smartify filter (#205)
+  * Use `https` in more places. (#165)
+
+### Development Fixes
+
+  * Rubocop: Target Ruby 2.2 (#195)
+  * Test feeds that have a `site.lang` (#164)
+  * Test against Ruby 2.5 (#201)
+
+### Minor Enhancements
+
+  * fix <entry> template for posts with post.lang defined (#168)
+
+## 0.9.3 / 2017-03-28
+
+## 0.9.1 / 2017-02-17
+
+### Minor Enhancements
+
+  * Update feed.xml (#162)
+
 ## 0.9.0 / 2017-02-16
 
 ### Minor Enhancements

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Ben Balter
+Copyright (c) 2015-present Ben Balter and jekyll-feed contributors
 
 MIT License
 

data/README.md

@@ -2,7 +2,7 @@
 
 A Jekyll plugin to generate an Atom (RSS-like) feed of your Jekyll posts
 
-[![Build Status](https://travis-ci.org/jekyll/jekyll-feed.svg)](https://travis-ci.org/jekyll/jekyll-feed) [![Gem Version](https://badge.fury.io/rb/jekyll-feed.svg)](http://badge.fury.io/rb/jekyll-feed)
+[![Build Status](https://travis-ci.org/jekyll/jekyll-feed.svg)](https://travis-ci.org/jekyll/jekyll-feed) [![Gem Version](https://badge.fury.io/rb/jekyll-feed.svg)](https://badge.fury.io/rb/jekyll-feed)
 
 ## Installation
 
@@ -15,10 +15,12 @@ gem 'jekyll-feed'
 And then add this line to your site's `_config.yml`:
 
 ```yml
-gems:
+plugins:
   - jekyll-feed
 ```
 
+:warning: If you are using Jekyll < 3.5.0 use the `gems` key instead of `plugins`.
+
 ## Usage
 
 The plugin will automatically generate an Atom feed at `/feed.xml`.
@@ -29,7 +31,7 @@ The plugin will automatically use any of the following configuration variables,
 
 * `title` or `name` - The title of the site, e.g., "My awesome site"
 * `description` - A longer description of what your site is about, e.g., "Where I blog about Jekyll and other awesome things"
-* `url` - The URL to your site, e.g., `http://example.com`. If none is provided, the plugin will try to use `site.github.url`.
+* `url` - The URL to your site, e.g., `https://example.com`. If none is provided, the plugin will try to use `site.github.url`.
 * `author` - Global author information (see below)
 
 ### Already have a feed path?
@@ -122,14 +124,126 @@ The plugin exposes a helper tag to expose the appropriate meta tags to support a
 
 The plugin uses [Jekyll's `smartify` filter](https://jekyllrb.com/docs/templates/) for processing the site title and post titles. This will translate plain ASCII punctuation into "smart" typographic punctuation. This will not render or strip any Markdown you may be using in a title.
 
+Jekyll's `smartify` filter uses [kramdown](https://kramdown.gettalong.org/options.html) as a processor.  Accordingly, if you do not want "smart" typographic punctuation, disabling them in kramdown in your `_config.yml` will disable them in your feed. For example:
+
+   ```yml
+   kramdown:
+     smart_quotes:               apos,apos,quot,quot
+     typographic_symbols:        {hellip: ...}
+   ```
+
 ### Custom styling
 
-Want to style what your feed looks like in the browser? Simply add an XSLT at `/feed.xslt.xml` and Jekyll Feed will link to the stylesheet.
+Want to style what your feed looks like in the browser? When a XSLT Styleheet file named `feed.xslt.xml` exists at the root of your repository, a link to this stylesheet is added to the generated feed.
 
 ## Why Atom, and not RSS?
 
 Great question. In short, Atom is a better format. Think of it like RSS 3.0. For more information, see [this discussion on why we chose Atom over RSS 2.0](https://github.com/jekyll/jekyll-rss-feed/issues/2).
 
+## Categories
+
+Jekyll Feed can generate feeds for each category. Simply define which categories you'd like feeds for in your config:
+
+```yml
+feed:
+  categories:
+    - news
+    - updates
+```
+
+## Posts limit
+
+By default the plugin limits the number of posts in the feed to 10. Simply define a new limit in your config:
+
+```yml
+feed:
+  posts_limit: 20
+```
+
+## Collections
+
+Jekyll Feed can generate feeds for collections other than the Posts collection. This works best for chronological collections (e.g., collections with dates in the filenames). Simply define which collections you'd like feeds for in your config:
+
+```yml
+feed:
+  collections:
+    - changes
+```
+
+By default, collection feeds will be outputted to `/feed/<COLLECTION>.xml`. If you'd like to customize the output path, specify a collection's custom path as follows:
+
+```yml
+feed:
+  collections:
+    changes:
+      path: "/changes.xml"
+```
+
+Finally, collections can also have category feeds which are outputted as `/feed/<COLLECTION>/<CATEGORY>.xml`. Specify categories like so:
+
+```yml
+feed:
+  collections:
+    changes:
+      path: "/changes.xml"
+      categories:
+        - news
+        - updates
+```
+
+## Excerpt Only flag
+
+Optional flag `excerpt_only` allows you to exclude post content from the Atom feed. Default value is `false` for backward compatibility.
+
+When in `config.yml` is `true` than all posts in feed will be without `<content>` tags.
+
+```yml
+feed:
+  excerpt_only: true
+```
+
+The same flag can be used directly in post file. It will be disable `<content>` tag for selected post.
+Settings in post file has higher priority than in config file.
+
+## Tags
+
+To automatically generate feeds for each tag you apply to your posts you can add a tags setting to your config:
+
+```yml
+feed:
+  tags: true
+```
+
+If there are tags you don't want included in this auto generation you can exclude them
+
+```yml
+feed:
+  tags:
+    except:
+      - tag-to-exclude
+      - another-tag
+```
+
+If you wish to change the location of these auto generated feeds (`/feed/by_tag/<TAG>.xml` by default) you can provide an alternative folder for them to live in.
+
+```yml
+feed:
+  tags:
+    path: "alternative/path/for/tags/feeds/"
+```
+
+If you only want to generate feeds for a few tags you can also set this.
+
+```yml
+feed:
+  tags:
+    only:
+      - tag-to-include
+      - another-tag
+```
+
+Note that if you include a tag that is excluded a feed will not be generated for it.
+
 ## Contributing
 
 1. Fork it (https://github.com/jekyll/jekyll-feed/fork)

data/lib/jekyll-feed.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "jekyll"
 require "fileutils"
 require "jekyll-feed/generator"

data/lib/jekyll-feed/feed.xml

@@ -2,17 +2,25 @@
 {% 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="http://jekyllrb.com" version="{{ jekyll.version }}">Jekyll</generator>
+<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>{{ '/' | absolute_url | xml_escape }}</id>
+  <id>{{ page.url | absolute_url | xml_escape }}</id>
 
-  {% if site.title %}
-    <title type="html">{{ site.title | smartify | xml_escape }}</title>
-  {% elsif site.name %}
-    <title type="html">{{ site.name | smartify | xml_escape }}</title>
+  {% 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 %}
@@ -31,15 +39,32 @@
     </author>
   {% endif %}
 
-  {% assign posts = site.posts | where_exp: "post", "post.draft != true" %}
-  {% for post in posts limit: 10 %}
-    <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 }}" />
+  {% if page.tags %}
+    {% assign posts = site.tags[page.tags] %}
+  {% else %}
+    {% assign posts = site[page.collection] %}
+  {% endif %}
+  {% if page.category %}
+    {% assign posts = posts | where: "category", page.category %}
+  {% endif %}
+  {% unless site.show_drafts %}
+    {% assign posts = posts | where_exp: "post", "post.draft != true" %}
+  {% endunless %}
+  {% assign posts = posts | sort: "date" | reverse %}
+  {% assign posts_limit = site.feed.posts_limit | default: 10 %}
+  {% for post in posts limit: posts_limit %}
+    <entry{% if post.lang %}{{" "}}xml:lang="{{ post.lang }}"{% endif %}>
+      {% assign post_title = post.title | smartify | strip_html | normalize_whitespace | xml_escape %}
+
+      <title type="html">{{ post_title }}</title>
+      <link href="{{ post.url | absolute_url }}" rel="alternate" type="text/html" title="{{ post_title }}" />
       <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>
-      <content type="html" xml:base="{{ post.url | absolute_url | xml_escape }}">{{ post.content | strip | xml_escape }}</content>
+      {% 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 %}
@@ -59,6 +84,10 @@
 
       {% if post.category %}
         <category term="{{ post.category | xml_escape }}" />
+      {% elsif post.categories %}
+        {% for category in post.categories %}
+          <category term="{{ category | xml_escape }}" />
+        {% endfor %}
       {% endif %}
 
       {% for tag in post.tags %}
@@ -72,9 +101,10 @@
       {% assign post_image = post.image.path | default: post.image %}
       {% if post_image %}
         {% unless post_image contains "://" %}
-          {% assign post_image = post_image | absolute_url | xml_escape  %}
+          {% assign post_image = post_image | absolute_url %}
         {% endunless %}
-        <media:thumbnail xmlns:media="http://search.yahoo.com/mrss/" url="{{ post_image }}" />
+        <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 %}

data/lib/jekyll-feed/generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JekyllFeed
   class Generator < Jekyll::Generator
     safe true
@@ -6,8 +8,16 @@ module JekyllFeed
     # Main plugin action, called by Jekyll-core
     def generate(site)
       @site = site
-      return if file_exists?(feed_path)
-      @site.pages << content_for_file(feed_path, feed_source_path)
+      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
+      generate_feed_by_tag if config["tags"] && !@site.tags.empty?
     end
 
     private
@@ -16,40 +26,115 @@ module JekyllFeed
     #   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+!
-
-    # Path to feed from config, or feed.xml for default
-    def feed_path
-      if @site.config["feed"] && @site.config["feed"]["path"]
-        @site.config["feed"]["path"]
-      else
-        "feed.xml"
+    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
+
+    def generate_feed_by_tag
+      tags_config = config["tags"]
+      tags_config = {} unless tags_config.is_a?(Hash)
+
+      except    = tags_config["except"] || []
+      only      = tags_config["only"] || @site.tags.keys
+      tags_pool = only - except
+      tags_path = tags_config["path"] || "/feed/by_tag/"
+
+      generate_tag_feed(tags_pool, tags_path)
+    end
+
+    def generate_tag_feed(tags_pool, tags_path)
+      tags_pool.each do |tag|
+        # allow only tags with basic alphanumeric characters and underscore to keep
+        # feed path simple.
+        next if %r![^a-zA-Z0-9_]!.match?(tag)
+
+        Jekyll.logger.info "Jekyll Feed:", "Generating feed for posts tagged #{tag}"
+        path = "#{tags_path}#{tag}.xml"
+        next if file_exists?(path)
+
+        @site.pages << make_page(path, :tags => tag)
       end
     end
 
     # Path to feed.xml template file
     def feed_source_path
-      File.expand_path "./feed.xml", File.dirname(__FILE__)
+      @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)
-      if @site.respond_to?(:in_source_dir)
-        File.exist? @site.in_source_dir(file_path)
-      else
-        File.exist? Jekyll.sanitized_path(@site.source, file_path)
-      end
+      File.exist? @site.in_source_dir(file_path)
     end
 
     # Generates contents for a file
-    def content_for_file(file_path, file_source_path)
-      file = PageWithoutAFile.new(@site, File.dirname(__FILE__), "", file_path)
-      file.content = File.read(file_source_path).gsub(MINIFY_REGEX, "")
-      file.data["layout"] = nil
-      file.data["sitemap"] = false
-      file.data["xsl"] = file_exists?("feed.xslt.xml")
-      file.output
-      file
+
+    def make_page(file_path, collection: "posts", category: nil, tags: 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,
+          "tags"       => tags
+        )
+        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