jekyll-feed 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 924d2b8683877244a4fb8950637804fc6e20e6dd16a119fef896705ae6d86bda
-  data.tar.gz: efe3bde414b3469f0e4106cab3fb5228e9f88fddeeae32cb61c6a6e7f2d5e706
+  metadata.gz: c244c9b3dc51c5a96051fe247af215ac0a136bb57fc6fe4f491ffa4acad122e6
+  data.tar.gz: a461c52155aa01616e59161c1c44a3eb1e0cfc3ebf58ef5bae70c9e5167272a5
 SHA512:
-  metadata.gz: 2af23e6f677d347c5b079ecdf7e06f43545dfdc49c5c9ed297e829a4de2149dbecdad81117b081040b86b96f23a90e0f9a81de99222603852ab927edb3b727a2
-  data.tar.gz: a977b4eb4316d1bfdb24d456f20c69b1e636511a773881cbed2de5d8d7a8281a744d64db4920a91e9b054ceedbc3417a1c2c1ce3df3ee63d7c4ca4f1825c43c7
+  metadata.gz: 5274b2f62e9fd6184bad9859bcd1ab4d10a0a2bc691393a3ccdae26de936b4a2fc8072db62b0f4cbab39c9efc8b284fb7b023bfac4f575af41efe8de16f609df
+  data.tar.gz: 5d0396d7edaa675efcf772cc57c9b7138e523b73a6a452274cca863483740a97d0036e871301dcea951eea1e0b04ce2551b2bc9b9bb4b92fc2d262100d7da45a

data/History.markdown

@@ -1,3 +1,21 @@
+## 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

data/README.md

@@ -151,6 +151,15 @@ feed:
     - 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:
@@ -196,6 +205,44 @@ feed:
 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
 

data/lib/jekyll-feed/feed.xml

@@ -39,14 +39,22 @@
     </author>
   {% endif %}
 
-  {% assign posts = site[page.collection] | where_exp: "post", "post.draft != true" | sort: "date" | reverse %}
+  {% if page.tags %}
+    {% assign entries = site.tags[page.tags] %}
+  {% else %}
+    {% assign entries = site[page.collection] %}
+  {% endif %}
+  {% assign posts = entries | where_exp: "post", "post.draft != true" | sort: "date" | reverse %}
   {% if page.category %}
     {% assign posts = posts | where: "category",page.category %}
   {% endif %}
-  {% for post in posts limit: 10 %}
+  {% 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 %}>
-      <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 }}" />
+      {% 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>
@@ -73,6 +81,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 %}

data/lib/jekyll-feed/generator.rb

@@ -17,6 +17,7 @@ module JekyllFeed
           @site.pages << make_page(path, :collection => name, :category => category)
         end
       end
+      generate_feed_by_tag if config["tags"] && !@site.tags.empty?
     end
 
     private
@@ -69,6 +70,32 @@ module JekyllFeed
       @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
       @feed_source_path ||= File.expand_path "feed.xml", __dir__
@@ -85,7 +112,7 @@ module JekyllFeed
 
     # Generates contents for a file
 
-    def make_page(file_path, collection: "posts", category: nil)
+    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!(
@@ -93,7 +120,8 @@ module JekyllFeed
           "sitemap"    => false,
           "xsl"        => file_exists?("feed.xslt.xml"),
           "collection" => collection,
-          "category"   => category
+          "category"   => category,
+          "tags"       => tags
         )
         file.output
       end

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

@@ -7,7 +7,7 @@ module JekyllFeed
 
     def render(context)
       @context = context
-      attrs    = attributes.map { |k, v| %(#{k}="#{v}") }.join(" ")
+      attrs    = attributes.map { |k, v| %(#{k}=#{v.encode(:xml => :attr)}) }.join(" ")
       "<link #{attrs} />"
     end
 

data/lib/jekyll-feed/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Feed
-    VERSION = "0.13.0"
+    VERSION = "0.14.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-feed
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Ben Balter
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-13 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -120,59 +120,30 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 
+description:
 email:
 - ben.balter@github.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- History.markdown
+- LICENSE.txt
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- Gemfile
 - History.markdown
 - LICENSE.txt
 - README.md
-- Rakefile
-- appveyor.yml
-- jekyll-feed.gemspec
 - lib/jekyll-feed.rb
 - lib/jekyll-feed/feed.xml
 - lib/jekyll-feed/generator.rb
 - lib/jekyll-feed/meta-tag.rb
 - lib/jekyll-feed/page-without-a-file.rb
 - lib/jekyll-feed/version.rb
-- script/bootstrap
-- script/cibuild
-- script/fmt
-- script/release
-- script/test
-- spec/fixtures/_collection/2018-01-01-collection-doc.md
-- spec/fixtures/_collection/2018-01-02-collection-category-doc.md
-- spec/fixtures/_config.yml
-- spec/fixtures/_data/authors.yml
-- spec/fixtures/_drafts/2015-01-12-a-draft.md
-- spec/fixtures/_layouts/some_default.html
-- spec/fixtures/_posts/2013-12-12-dec-the-second.md
-- spec/fixtures/_posts/2014-03-02-march-the-second.md
-- spec/fixtures/_posts/2014-03-04-march-the-fourth.md
-- spec/fixtures/_posts/2015-01-18-jekyll-last-modified-at.md
-- spec/fixtures/_posts/2015-02-12-strip-newlines.md
-- spec/fixtures/_posts/2015-05-12-liquid.md
-- spec/fixtures/_posts/2015-05-12-pre.html
-- spec/fixtures/_posts/2015-05-18-author-detail.md
-- spec/fixtures/_posts/2015-08-08-stuck-in-the-middle.html
-- spec/fixtures/_posts/2016-04-25-author-reference.md
-- spec/fixtures/feed.xslt.xml
-- spec/jekyll-feed_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/jekyll/jekyll-feed
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -180,34 +151,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A Jekyll plugin to generate an Atom feed of your Jekyll posts
-test_files:
-- spec/fixtures/_collection/2018-01-01-collection-doc.md
-- spec/fixtures/_collection/2018-01-02-collection-category-doc.md
-- spec/fixtures/_config.yml
-- spec/fixtures/_data/authors.yml
-- spec/fixtures/_drafts/2015-01-12-a-draft.md
-- spec/fixtures/_layouts/some_default.html
-- spec/fixtures/_posts/2013-12-12-dec-the-second.md
-- spec/fixtures/_posts/2014-03-02-march-the-second.md
-- spec/fixtures/_posts/2014-03-04-march-the-fourth.md
-- spec/fixtures/_posts/2015-01-18-jekyll-last-modified-at.md
-- spec/fixtures/_posts/2015-02-12-strip-newlines.md
-- spec/fixtures/_posts/2015-05-12-liquid.md
-- spec/fixtures/_posts/2015-05-12-pre.html
-- spec/fixtures/_posts/2015-05-18-author-detail.md
-- spec/fixtures/_posts/2015-08-08-stuck-in-the-middle.html
-- spec/fixtures/_posts/2016-04-25-author-reference.md
-- spec/fixtures/feed.xslt.xml
-- spec/jekyll-feed_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.gitignore

@@ -1,21 +0,0 @@
-/vendor
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-*.gem
-Gemfile.lock
-spec/dest
-.bundle
-spec/fixtures/.jekyll-metadata
-spec/fixtures/.jekyll-cache

data/.rspec

@@ -1,2 +0,0 @@
---color
---format progress

data/.rubocop.yml

@@ -1,27 +0,0 @@
-require: rubocop-jekyll
-
-inherit_gem:
-  rubocop-jekyll: .rubocop.yml
-
-AllCops:
-  TargetRubyVersion: 2.3
-  Include:
-    - lib/**/*.rb
-
-  Exclude:
-    - .gitignore
-    - .rspec
-    - .rubocop.yml
-    - .travis.yml
-
-    - Gemfile.lock
-    - History.markdown
-    - LICENSE.txt
-    - README.md
-
-    - script/**/*
-    - vendor/**/*
-
-Naming/MemoizedInstanceVariableName:
-  Exclude:
-    - lib/jekyll-feed/page-without-a-file.rb

data/.travis.yml

@@ -1,32 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - &latest_ruby 2.6
-  - 2.4
-  - 2.3
-env:
-  global:
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
-  matrix:
-    - JEKYLL_VERSION="~> 3.8"
-matrix:
-  include:
-    - rvm: *latest_ruby
-      env: JEKYLL_VERSION="~> 3.7.4"
-    - rvm: *latest_ruby
-      env: JEKYLL_VERSION=">= 4.0.0.pre.alpha1"
-before_install:
-- gem update --system
-- gem install bundler
-before_script: bundle update
-script: script/cibuild
-notifications:
-  email: false
-deploy:
-  provider: rubygems
-  api_key:
-    secure: qz0q6ur0kGo03jjLdoAak6WcEAwxX2r9LG3DVrhOrcfoFipkuW+uwR0et4tpK8uFrz0P9y7eTIKOb0XCXeIsIXWj6R5benpRGr2U8m9A+tE/jxviBFUaxaokte0lqWiX1fEyhRmW3zvcdLQ47Vd2EwTNaq6ZmPulmEe9gS0rBQghyclakGlZ17LI7oGgiNL9SQ335Yqa1qJklTHYHbodWQ3Z07v7VN2jxqi3WH6NacT5gUGp5iCNCLLa8+jpKr4uONNIoy6/geAWdqtvgGUE8oTjIWDoJarrknJpqfx9Rd0KLDzkyneAigHDYPW60QtrE6GGpK/+TF1pF4DzdK2EgTWqGFnZf8ehfnxmtHVl2Xq/DPr6hS8Q/f+ut4ioMzBQxPD0hfh8/EOMYKsO8mOuOlYTiZXC7iuGyvFUOl2hnBgWA99t+I0NNB06qFp3ZxIjolEc3zjzc9f1a5HUXlEut5V8nqvCwbctNiTVpT8ZEWlsQlyRUnr9cIMUTEfLgQ+v6DnvAJBMO1EILq6liB5qfutjNhzhlREt7P/ZdppGsAzWpgt0q2PafqVoPe62WR3+/8Lj2ErMr034xSSqZVNcBS0mbdvW6k3jaABo1VJ4XuHm6/yDuemWzWb7kdG9/14+IIJMW1VuaWcmnCnB6gxjkCW3Dm2ftYiN7Rfn3AUz/nU=
-  gem: jekyll-feed
-  on:
-    tags: true
-    repo: jekyll/jekyll-feed

data/Gemfile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-gemspec
-
-gem "jekyll", ENV["JEKYLL_VERSION"] if ENV["JEKYLL_VERSION"]
-
-install_if -> { Gem.win_platform? } do
-  gem "tzinfo", "~> 1.2"
-  gem "tzinfo-data"
-end

data/Rakefile

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

data/appveyor.yml

@@ -1,29 +0,0 @@
-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/jekyll-feed.gemspec

@@ -1,30 +0,0 @@
-# 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          = "jekyll-feed"
-  spec.version       = Jekyll::Feed::VERSION
-  spec.authors       = ["Ben Balter"]
-  spec.email         = ["ben.balter@github.com"]
-  spec.summary       = "A Jekyll plugin to generate an Atom feed of your Jekyll posts"
-  spec.homepage      = "https://github.com/jekyll/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

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

data/script/cibuild

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

data/script/fmt

@@ -1,10 +0,0 @@
-#!/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

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

data/script/test

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

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

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

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

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

data/spec/fixtures/_config.yml

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

data/spec/fixtures/_data/authors.yml

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

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

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

data/spec/fixtures/_layouts/some_default.html

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

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

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

data/spec/fixtures/_posts/2014-03-02-march-the-second.md

@@ -1,6 +0,0 @@
----
-image: https://cdn.example.org/absolute.png?h=188&w=250
-category: news
----
-
-March the second!

data/spec/fixtures/_posts/2014-03-04-march-the-fourth.md

@@ -1,9 +0,0 @@
----
-tags:
- - '"/><VADER>'
-image:
-  path: "/object-image.png"
-categories: updates jekyll
----
-
-March the fourth!

data/spec/fixtures/_posts/2015-01-18-jekyll-last-modified-at.md

@@ -1,5 +0,0 @@
----
-last_modified_at: 2015-05-12T13:27:59+00:00
----
-
-Please don't modify this file. It's modified time is important.

data/spec/fixtures/_posts/2015-02-12-strip-newlines.md

@@ -1,6 +0,0 @@
----
-title:
-    The plugin
-    will properly
-    strip newlines.
----

data/spec/fixtures/_posts/2015-05-12-liquid.md

@@ -1,7 +0,0 @@
----
----
-
-{% capture liquidstring %}
-Liquid is not rendered.
-{% endcapture %}
-{{ liquidstring | replace:'not ','' }}

data/spec/fixtures/_posts/2015-05-12-pre.html

@@ -1,8 +0,0 @@
----
-author: Pat
-lang: en
----
-
-<pre>Line 1
-Line 2
-Line 3</pre>

data/spec/fixtures/_posts/2015-05-18-author-detail.md

@@ -1,9 +0,0 @@
----
-excerpt: ""
-author:
-  name: Ben
-  uri: "http://ben.balter.com"
-  email: ben@example.com
----
-
-# December the twelfth, actually.

data/spec/fixtures/_posts/2015-08-08-stuck-in-the-middle.html

@@ -1,6 +0,0 @@
----
-feed:
-  excerpt_only: true
----
-
-This content should not be in feed.

data/spec/fixtures/_posts/2016-04-25-author-reference.md

@@ -1,6 +0,0 @@
----
-excerpt: ""
-author: garthdb
----
-
-# April the twenty-fifth?

data/spec/jekyll-feed_spec.rb

@@ -1,524 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-describe(JekyllFeed) do
-  let(:overrides) { {} }
-  let(:config) do
-    Jekyll.configuration(Jekyll::Utils.deep_merge_hashes({
-      "full_rebuild" => true,
-      "source"       => source_dir,
-      "destination"  => dest_dir,
-      "show_drafts"  => true,
-      "url"          => "http://example.org",
-      "name"         => "My awesome site",
-      "author"       => {
-        "name" => "Dr. Jekyll",
-      },
-      "collections"  => {
-        "my_collection" => { "output" => true },
-        "other_things"  => { "output" => false },
-      },
-    }, overrides))
-  end
-  let(:site)     { Jekyll::Site.new(config) }
-  let(:contents) { File.read(dest_dir("feed.xml")) }
-  let(:context)  { make_context(:site => site) }
-  let(:feed_meta) { Liquid::Template.parse("{% feed_meta %}").render!(context, {}) }
-  before(:each) do
-    site.process
-  end
-
-  it "has no layout" do
-    expect(contents).not_to match(%r!\ATHIS IS MY LAYOUT!)
-  end
-
-  it "creates a feed.xml file" do
-    expect(Pathname.new(dest_dir("feed.xml"))).to exist
-  end
-
-  it "doesn't have multiple new lines or trailing whitespace" do
-    expect(contents).to_not match %r!\s+\n!
-    expect(contents).to_not match %r!\n{2,}!
-  end
-
-  it "puts all the posts in the feed.xml file" do
-    expect(contents).to match "http://example.org/updates/jekyll/2014/03/04/march-the-fourth.html"
-    expect(contents).to match "http://example.org/news/2014/03/02/march-the-second.html"
-    expect(contents).to match "http://example.org/news/2013/12/12/dec-the-second.html"
-    expect(contents).to match "http://example.org/2015/08/08/stuck-in-the-middle.html"
-    expect(contents).to_not match "http://example.org/2016/02/09/a-draft.html"
-  end
-
-  it "does not include assets or any static files that aren't .html" do
-    expect(contents).not_to match "http://example.org/images/hubot.png"
-    expect(contents).not_to match "http://example.org/feeds/atom.xml"
-  end
-
-  it "preserves linebreaks in preformatted text in posts" do
-    expect(contents).to match "Line 1\nLine 2\nLine 3"
-  end
-
-  it "supports post author name as an object" do
-    expect(contents).to match %r!<author>\s*<name>Ben</name>\s*<email>ben@example\.com</email>\s*<uri>http://ben\.balter\.com</uri>\s*</author>!
-  end
-
-  it "supports post author name as a string" do
-    expect(contents).to match %r!<author>\s*<name>Pat</name>\s*</author>!
-  end
-
-  it "does not output author tag no author is provided" do
-    expect(contents).not_to match %r!<author>\s*<name></name>\s*</author>!
-  end
-
-  it "does use author reference with data from _data/authors.yml" do
-    expect(contents).to match %r!<author>\s*<name>Garth</name>\s*<email>example@mail\.com</email>\s*<uri>http://garthdb\.com</uri>\s*</author>!
-  end
-
-  it "converts markdown posts to HTML" do
-    expect(contents).to match %r!&lt;p&gt;March the second\!&lt;/p&gt;!
-  end
-
-  it "uses last_modified_at where available" do
-    expect(contents).to match %r!<updated>2015-05-12T13:27:59\+00:00</updated>!
-  end
-
-  it "replaces newlines in posts to spaces" do
-    expect(contents).to match '<title type="html">The plugin will properly strip newlines.</title>'
-  end
-
-  it "renders Liquid inside posts" do
-    expect(contents).to match "Liquid is rendered."
-    expect(contents).not_to match "Liquid is not rendered."
-  end
-
-  context "images" do
-    let(:image1) { 'http://example.org/image.png' }
-    let(:image2) { 'https://cdn.example.org/absolute.png?h=188&amp;w=250' }
-    let(:image3) { 'http://example.org/object-image.png' }
-
-    it "includes the item image" do
-      expect(contents).to include(%(<media:thumbnail xmlns:media="http://search.yahoo.com/mrss/" url="#{image1}" />))
-      expect(contents).to include(%(<media:thumbnail xmlns:media="http://search.yahoo.com/mrss/" url="#{image2}" />))
-      expect(contents).to include(%(<media:thumbnail xmlns:media="http://search.yahoo.com/mrss/" url="#{image3}" />))
-    end
-
-    it "included media content for mail templates (Mailchimp)" do
-      expect(contents).to include(%(<media:content medium="image" url="#{image1}" xmlns:media="http://search.yahoo.com/mrss/" />))
-      expect(contents).to include(%(<media:content medium="image" url="#{image2}" xmlns:media="http://search.yahoo.com/mrss/" />))
-      expect(contents).to include(%(<media:content medium="image" url="#{image3}" xmlns:media="http://search.yahoo.com/mrss/" />))
-    end
-  end
-
-  context "parsing" do
-    let(:feed) { RSS::Parser.parse(contents) }
-
-    it "outputs an RSS feed" do
-      expect(feed.feed_type).to eql("atom")
-      expect(feed.feed_version).to eql("1.0")
-      expect(feed.encoding).to eql("UTF-8")
-      expect(feed.lang).to be_nil
-      expect(feed.valid?).to eql(true)
-    end
-
-    it "outputs the link" do
-      expect(feed.link.href).to eql("http://example.org/feed.xml")
-    end
-
-    it "outputs the generator" do
-      expect(feed.generator.content).to eql("Jekyll")
-      expect(feed.generator.version).to eql(Jekyll::VERSION)
-    end
-
-    it "includes the items" do
-      expect(feed.items.count).to eql(10)
-    end
-
-    it "includes item contents" do
-      post = feed.items.last
-      expect(post.title.content).to eql("Dec The Second")
-      expect(post.link.href).to eql("http://example.org/news/2013/12/12/dec-the-second.html")
-      expect(post.published.content).to eql(Time.parse("2013-12-12"))
-    end
-
-    it "includes the item's excerpt" do
-      post = feed.items.last
-      expect(post.summary.content).to eql("Foo")
-    end
-
-    it "doesn't include the item's excerpt if blank" do
-      post = feed.items.first
-      expect(post.summary).to be_nil
-    end
-
-    context "with site.lang set" do
-      lang = "en_US"
-      let(:overrides) { { "lang" => lang } }
-      it "outputs a valid feed" do
-        expect(feed.feed_type).to eql("atom")
-        expect(feed.feed_version).to eql("1.0")
-        expect(feed.encoding).to eql("UTF-8")
-        expect(feed.valid?).to eql(true)
-      end
-
-      it "outputs the correct language" do
-        expect(feed.lang).to eql(lang)
-      end
-
-      it "sets the language of entries" do
-        post = feed.items.first
-        expect(post.lang).to eql(lang)
-      end
-
-      it "renders the feed meta" do
-        expected = %r!<link href="http://example.org/" rel="alternate" type="text/html" hreflang="#{lang}" />!
-        expect(contents).to match(expected)
-      end
-    end
-
-    context "with site.title set" do
-      let(:site_title) { "My Site Title" }
-      let(:overrides) { { "title" => site_title } }
-
-      it "uses site.title for the title" do
-        expect(feed.title.content).to eql(site_title)
-      end
-    end
-
-    context "with site.name set" do
-      let(:site_name) { "My Site Name" }
-      let(:overrides) { { "name" => site_name } }
-
-      it "uses site.name for the title" do
-        expect(feed.title.content).to eql(site_name)
-      end
-    end
-
-    context "with site.name and site.title set" do
-      let(:site_title) { "My Site Title" }
-      let(:site_name) { "My Site Name" }
-      let(:overrides) { { "title" => site_title, "name" => site_name } }
-
-      it "uses site.title for the title, dropping site.name" do
-        expect(feed.title.content).to eql(site_title)
-      end
-    end
-  end
-
-  context "smartify" do
-    let(:site_title) { "Pat's Site" }
-    let(:overrides) { { "title" => site_title } }
-    let(:feed) { RSS::Parser.parse(contents) }
-
-    it "processes site title with SmartyPants" do
-      expect(feed.title.content).to eql("Pat’s Site")
-    end
-  end
-
-  context "validation" do
-    it "validates" do
-      skip "Typhoeus couldn't find the 'libcurl' module on Windows" if Gem.win_platform?
-      # See https://validator.w3.org/docs/api.html
-      url = "https://validator.w3.org/feed/check.cgi?output=soap12"
-      response = Typhoeus.post(url, :body => { :rawdata => contents }, :accept_encoding => "gzip")
-      pending "Something went wrong with the W3 validator" unless response.success?
-      result = Nokogiri::XML(response.body)
-      result.remove_namespaces!
-
-      result.css("warning").each do |warning|
-        # Quiet a warning that results from us passing the feed as a string
-        next if warning.css("text").text =~ %r!Self reference doesn't match document location!
-
-        # Quiet expected warning that results from blank summary test case
-        next if warning.css("text").text =~ %r!(content|summary) should not be blank!
-
-        # Quiet expected warning about multiple posts with same updated time
-        next if warning.css("text").text =~ %r!Two entries with the same value for atom:updated!
-
-        warn "Validation warning: #{warning.css("text").text} on line #{warning.css("line").text} column #{warning.css("column").text}"
-      end
-
-      errors = result.css("error").map do |error|
-        "Validation error: #{error.css("text").text} on line #{error.css("line").text} column #{error.css("column").text}"
-      end
-
-      expect(result.css("validity").text).to eql("true"), errors.join("\n")
-    end
-  end
-
-  context "with a baseurl" do
-    let(:overrides) do
-      { "baseurl" => "/bass" }
-    end
-
-    it "correctly adds the baseurl to the posts" do
-      expect(contents).to match "http://example.org/bass/updates/jekyll/2014/03/04/march-the-fourth.html"
-      expect(contents).to match "http://example.org/bass/news/2014/03/02/march-the-second.html"
-      expect(contents).to match "http://example.org/bass/news/2013/12/12/dec-the-second.html"
-    end
-
-    it "renders the feed meta" do
-      expected = 'href="http://example.org/bass/feed.xml"'
-      expect(feed_meta).to include(expected)
-    end
-  end
-
-  context "feed meta" do
-    it "renders the feed meta" do
-      expected = '<link type="application/atom+xml" rel="alternate" href="http://example.org/feed.xml" title="My awesome site" />'
-      expect(feed_meta).to eql(expected)
-    end
-
-    context "with a blank site name" do
-      let(:config) do
-        Jekyll.configuration(
-          "source"      => source_dir,
-          "destination" => dest_dir,
-          "url"         => "http://example.org"
-        )
-      end
-
-      it "does not output blank title" do
-        expect(feed_meta).not_to include("title=")
-      end
-    end
-  end
-
-  context "changing the feed path" do
-    let(:overrides) do
-      {
-        "feed" => {
-          "path" => "atom.xml",
-        },
-      }
-    end
-
-    it "should write to atom.xml" do
-      expect(Pathname.new(dest_dir("atom.xml"))).to exist
-    end
-
-    it "renders the feed meta with custom feed path" do
-      expected = 'href="http://example.org/atom.xml"'
-      expect(feed_meta).to include(expected)
-    end
-  end
-
-  context "changing the file path via collection meta" do
-    let(:overrides) do
-      {
-        "feed" => {
-          "collections" => {
-            "posts" => {
-              "path" => "atom.xml",
-            },
-          },
-        },
-      }
-    end
-
-    it "should write to atom.xml" do
-      expect(Pathname.new(dest_dir("atom.xml"))).to exist
-    end
-
-    it "renders the feed meta with custom feed path" do
-      expected = 'href="http://example.org/atom.xml"'
-      expect(feed_meta).to include(expected)
-    end
-  end
-
-  context "feed stylesheet" do
-    it "includes the stylesheet" do
-      expect(contents).to include('<?xml-stylesheet type="text/xml" href="http://example.org/feed.xslt.xml"?>')
-    end
-  end
-
-  context "with site.lang set" do
-    let(:overrides) { { "lang" => "en-US" } }
-
-    it "should set the language" do
-      expect(contents).to match 'type="text/html" hreflang="en-US" />'
-    end
-  end
-
-  context "with post.lang set" do
-    it "should set the language for that entry" do
-      expect(contents).to match '<entry xml:lang="en">'
-      expect(contents).to match '<entry>'
-    end
-  end
-
-  context "categories" do
-    context "with top-level post categories" do
-      let(:overrides) do
-        {
-          "feed" => { "categories" => ["news"] },
-        }
-      end
-      let(:news_feed) { File.read(dest_dir("feed/news.xml")) }
-
-      it "outputs the primary feed" do
-        expect(contents).to match "http://example.org/updates/jekyll/2014/03/04/march-the-fourth.html"
-        expect(contents).to match "http://example.org/news/2014/03/02/march-the-second.html"
-        expect(contents).to match "http://example.org/news/2013/12/12/dec-the-second.html"
-        expect(contents).to match "http://example.org/2015/08/08/stuck-in-the-middle.html"
-        expect(contents).to_not match "http://example.org/2016/02/09/a-draft.html"
-      end
-
-      it "outputs the category feed" do
-        expect(news_feed).to match '<title type="html">My awesome site | News</title>'
-        expect(news_feed).to match "http://example.org/news/2014/03/02/march-the-second.html"
-        expect(news_feed).to match "http://example.org/news/2013/12/12/dec-the-second.html"
-        expect(news_feed).to_not match "http://example.org/updates/jekyll/2014/03/04/march-the-fourth.html"
-        expect(news_feed).to_not match "http://example.org/2015/08/08/stuck-in-the-middle.html"
-      end
-    end
-
-    context "with collection-level post categories" do
-      let(:overrides) do
-        {
-          "feed" => {
-            "collections" => {
-              "posts" => {
-                "categories" => ["news"],
-              },
-            },
-          },
-        }
-      end
-      let(:news_feed) { File.read(dest_dir("feed/news.xml")) }
-
-      it "outputs the primary feed" do
-        expect(contents).to match "http://example.org/updates/jekyll/2014/03/04/march-the-fourth.html"
-        expect(contents).to match "http://example.org/news/2014/03/02/march-the-second.html"
-        expect(contents).to match "http://example.org/news/2013/12/12/dec-the-second.html"
-        expect(contents).to match "http://example.org/2015/08/08/stuck-in-the-middle.html"
-        expect(contents).to_not match "http://example.org/2016/02/09/a-draft.html"
-      end
-
-      it "outputs the category feed" do
-        expect(news_feed).to match '<title type="html">My awesome site | News</title>'
-        expect(news_feed).to match "http://example.org/news/2014/03/02/march-the-second.html"
-        expect(news_feed).to match "http://example.org/news/2013/12/12/dec-the-second.html"
-        expect(news_feed).to_not match "http://example.org/updates/jekyll/2014/03/04/march-the-fourth.html"
-        expect(news_feed).to_not match "http://example.org/2015/08/08/stuck-in-the-middle.html"
-      end
-    end
-  end
-
-  context "collections" do
-    let(:collection_feed) { File.read(dest_dir("feed/collection.xml")) }
-
-    context "when initialized as an array" do
-      let(:overrides) do
-        {
-          "collections" => {
-            "collection" => {
-              "output" => true,
-            },
-          },
-          "feed"        => { "collections" => ["collection"] },
-        }
-      end
-
-      it "outputs the collection feed" do
-        expect(collection_feed).to match '<title type="html">My awesome site | Collection</title>'
-        expect(collection_feed).to match "http://example.org/collection/2018-01-01-collection-doc.html"
-        expect(collection_feed).to match "http://example.org/collection/2018-01-02-collection-category-doc.html"
-        expect(collection_feed).to_not match "http://example.org/updates/jekyll/2014/03/04/march-the-fourth.html"
-        expect(collection_feed).to_not match "http://example.org/2015/08/08/stuck-in-the-middle.html"
-      end
-    end
-
-    context "with categories" do
-      let(:overrides) do
-        {
-          "collections" => {
-            "collection" => {
-              "output" => true,
-            },
-          },
-          "feed"        => {
-            "collections" => {
-              "collection" => {
-                "categories" => ["news"],
-              },
-            },
-          },
-        }
-      end
-      let(:news_feed) { File.read(dest_dir("feed/collection/news.xml")) }
-
-      it "outputs the collection category feed" do
-        expect(news_feed).to match '<title type="html">My awesome site | Collection | News</title>'
-        expect(news_feed).to match "http://example.org/collection/2018-01-02-collection-category-doc.html"
-        expect(news_feed).to_not match "http://example.org/collection/2018-01-01-collection-doc.html"
-        expect(news_feed).to_not match "http://example.org/updates/jekyll/2014/03/04/march-the-fourth.html"
-        expect(news_feed).to_not match "http://example.org/2015/08/08/stuck-in-the-middle.html"
-      end
-    end
-
-    context "with a custom path" do
-      let(:overrides) do
-        {
-          "collections" => {
-            "collection" => {
-              "output" => true,
-            },
-          },
-          "feed"        => {
-            "collections" => {
-              "collection" => {
-                "categories" => ["news"],
-                "path"       => "custom.xml",
-              },
-            },
-          },
-        }
-      end
-
-      it "should write to the custom path" do
-        expect(Pathname.new(dest_dir("custom.xml"))).to exist
-        expect(Pathname.new(dest_dir("feed/collection.xml"))).to_not exist
-        expect(Pathname.new(dest_dir("feed/collection/news.xml"))).to exist
-      end
-    end
-  end
-
-  context "excerpt_only flag" do
-    context "backward compatibility for no excerpt_only flag" do
-      it "should be in contents" do
-        expect(contents).to match '<content '
-      end
-    end
-
-    context "when site.excerpt_only flag is true" do
-      let(:overrides) do
-        { "feed" => { "excerpt_only" => true } }
-      end
-
-      it "should not set any contents" do
-        expect(contents).to_not match '<content '
-      end
-    end
-
-    context "when site.excerpt_only flag is false" do
-      let(:overrides) do
-        { "feed" => { "excerpt_only" => false } }
-      end
-
-      it "should be in contents" do
-        expect(contents).to match '<content '
-      end
-    end
-
-    context "when post.excerpt_only flag is true" do
-      let(:overrides) do
-        { "feed" => { "excerpt_only" => false } }
-      end
-
-      it "should not be in contents" do
-        expect(contents).to_not match "This content should not be in feed.</content>"
-      end
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require "jekyll"
-require "typhoeus" unless Gem.win_platform?
-require "nokogiri"
-require "rss"
-require File.expand_path("../lib/jekyll-feed", __dir__)
-
-Jekyll.logger.log_level = :error
-
-RSpec.configure do |config|
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-  config.order = "random"
-
-  SOURCE_DIR = File.expand_path("fixtures", __dir__)
-  DEST_DIR   = File.expand_path("dest",     __dir__)
-
-  def source_dir(*files)
-    File.join(SOURCE_DIR, *files)
-  end
-
-  def dest_dir(*files)
-    File.join(DEST_DIR, *files)
-  end
-
-  def make_context(registers = {})
-    Liquid::Context.new({}, {}, { :site => site }.merge(registers))
-  end
-end