jekyll-feed 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8f54ea4d5e7e1cca4e3f97822892ebbbbf0e1e14
-  data.tar.gz: a8f9d0597adee1a4f894dd7721c708099135bdce
+SHA256:
+  metadata.gz: a2f39a0bbb0b44fe86056121002e483fdad9fd750d80df250c3bb8d2773deb62
+  data.tar.gz: 5b8873c7d89f01de3ab5d87c02a30b0186153d1f6c0b05812f8f428b83bfb54a
 SHA512:
-  metadata.gz: 4886bdd3fc8bf4bc520ddeab68ee7cc8823e3f6021f8633a5173390fc4ac59243edea9d69b651546f33f7d80e8aafba32cb21929bcdfda8c4480a7aeb2ac5212
-  data.tar.gz: 3b3614f94497c50ce1c091760be4e932b6cd917d40c540434d391e4d15cd5469e17a59f5d9a2bc61e61d807695071e2b945677e9b70391ac81625d1846d8f060
+  metadata.gz: 0dcd26441f769bef785939357a38cf4b7f299f10bd273553b2f0ee2aa1fde50b1664c94fbac3534bb14b3f8cb8e36e5f361b21e339a8b8e140f6ba3c839e68f6
+  data.tar.gz: 9f682591707af1c16b6756e1638acadaa1cd19ac141f3b816dcf3129cea5ef661fa9e6fe0b7a05a6c6000e07d7a147c89ba155e1932f1062211bbabc2e4f27c2

data/History.markdown

@@ -1,3 +1,19 @@
+## HEAD
+
+  * Release 💎 0.11 (#241)
+
+## 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

data/README.md

@@ -140,6 +140,48 @@ Want to style what your feed looks like in the browser? Simply add an XSLT at `/
 
 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
+```
+
+## 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
+```
+
 ## Contributing
 
 1. Fork it (https://github.com/jekyll/jekyll-feed/fork)

data/jekyll-feed.gemspec

@@ -18,12 +18,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r!^(test|spec|features)/!)
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "jekyll", "~> 3.3"
+  spec.required_ruby_version = ">= 2.3.0"
 
+  spec.add_dependency "jekyll", "~> 3.3"
   spec.add_development_dependency "bundler", "~> 1.15"
   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", "0.56"
+  spec.add_development_dependency "rubocop", "~> 0.57.2"
   spec.add_development_dependency "typhoeus", ">= 0.7", "< 2.0"
 end

data/lib/jekyll-feed/feed.xml

@@ -7,12 +7,20 @@
   <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,7 +39,10 @@
     </author>
   {% endif %}
 
-  {% assign posts = site.posts | where_exp: "post", "post.draft != true" %}
+  {% 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 limit: 10 %}
     <entry{% if post.lang %}{{" "}}xml:lang="{{ post.lang }}"{% endif %}>
       <title type="html">{{ post.title | smartify | strip_html | normalize_whitespace | xml_escape }}</title>

data/lib/jekyll-feed/generator.rb

@@ -8,8 +8,14 @@ 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
     end
 
     private
@@ -20,38 +26,86 @@ module JekyllFeed
     # 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"
+    # 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
-      File.expand_path "feed.xml", __dir__
+      @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, __dir__, "", 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)
+      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

@@ -14,7 +14,7 @@ module JekyllFeed
     private
 
     def config
-      @context.registers[:site].config
+      @config ||= @context.registers[:site].config
     end
 
     def attributes
@@ -27,11 +27,7 @@ module JekyllFeed
     end
 
     def path
-      if config["feed"] && config["feed"]["path"]
-        config["feed"]["path"]
-      else
-        "feed.xml"
-      end
+      config.dig("feed", "path") || "feed.xml"
     end
 
     def title

data/lib/jekyll-feed/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Feed
-    VERSION = "0.10.0"
+    VERSION = "0.11.0"
   end
 end

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/_posts/2013-12-12-dec-the-second.md

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

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

@@ -1,5 +1,6 @@
 ---
 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

@@ -3,6 +3,7 @@ tags:
  - '"/><VADER>'
 image:
   path: "/object-image.png"
+category: updates
 ---
 
 March the fourth!

data/spec/jekyll-feed_spec.rb

@@ -43,9 +43,9 @@ describe(JekyllFeed) do
   end
 
   it "puts all the posts in the feed.xml file" do
-    expect(contents).to match /http:\/\/example\.org\/2014\/03\/04\/march-the-fourth\.html/
-    expect(contents).to match /http:\/\/example\.org\/2014\/03\/02\/march-the-second\.html/
-    expect(contents).to match /http:\/\/example\.org\/2013\/12\/12\/dec-the-second\.html/
+    expect(contents).to match /http:\/\/example\.org\/updates\/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
@@ -125,7 +125,7 @@ describe(JekyllFeed) do
     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/2013/12/12/dec-the-second.html")
+      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
 
@@ -239,9 +239,9 @@ describe(JekyllFeed) do
     end
 
     it "correctly adds the baseurl to the posts" do
-      expect(contents).to match /http:\/\/example\.org\/bass\/2014\/03\/04\/march-the-fourth\.html/
-      expect(contents).to match /http:\/\/example\.org\/bass\/2014\/03\/02\/march-the-second\.html/
-      expect(contents).to match /http:\/\/example\.org\/bass\/2013\/12\/12\/dec-the-second\.html/
+      expect(contents).to match /http:\/\/example\.org\/bass\/updates\/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
@@ -290,6 +290,29 @@ describe(JekyllFeed) do
     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"?>')
@@ -310,4 +333,142 @@ describe(JekyllFeed) do
       expect(contents).to match %r!<entry>!
     end
   end
+
+  context "categories" do
+    context "with top-level post categories" do
+      let(:overrides) {
+        {
+          "feed" => { "categories" => ["news"] }
+        }
+      }
+      let(:news_feed) { File.read(dest_dir("feed/news.xml")) }
+
+      it "outputs the primary feed" do
+        expect(contents).to match /http:\/\/example\.org\/updates\/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\/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) {
+        {
+          "feed" => {
+            "collections" => {
+              "posts" => {
+                "categories" => ["news"]
+              }
+            }
+          }
+        }
+      }
+      let(:news_feed) { File.read(dest_dir("feed/news.xml")) }
+
+      it "outputs the primary feed" do
+        expect(contents).to match /http:\/\/example\.org\/updates\/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\/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) {
+        {
+          "collections" => {
+            "collection" => {
+              "output" => true
+            }
+          },
+          "feed" => { "collections" => ["collection"] }
+        }
+      }
+
+
+      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\/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) {
+        {
+          "collections" => {
+            "collection" => {
+              "output" => true
+            }
+          },
+          "feed" => {
+            "collections" => {
+              "collection" => {
+                "categories" => ["news"]
+              }
+            }
+          }
+        }
+      }
+      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\/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) {
+        {
+          "collections" => {
+            "collection" => {
+              "output" => true
+            }
+          },
+          "feed" => {
+            "collections" => {
+              "collection" => {
+                "categories" => ["news"],
+                "path" => "custom.xml"
+              }
+            }
+          }
+        }
+      }
+
+      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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-feed
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-05 00:00:00.000000000 Z
+date: 2018-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -84,16 +84,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.56'
+        version: 0.57.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.56'
+        version: 0.57.2
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +142,8 @@ files:
 - 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
@@ -171,7 +173,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -179,11 +181,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.7
 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