jekyll-feed 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31ec255441efdec76e24a57228ad15d4df8792aa
-  data.tar.gz: 771f380686b7c6b1f988924ad385abc7e45c044a
+  metadata.gz: dd1897a15ad66d115a4e4fba2981d29bf41b5c87
+  data.tar.gz: da12a240d6bca1c5e4fd64b24864c783d85ffd77
 SHA512:
-  metadata.gz: 4f380d4240ccedfe0d193b5ec88cf10feabae1bd948c982340fc078b1fb3653784c3be9188d42923978a67dc13d3be086d306fc324101cdc610dcd36530c664a
-  data.tar.gz: 85c8856882d47079feb5cedbb44975d077c48a6291e6ae181fc924952292fd02b8c1b09d60d3a561cb2b59cbafe281ea5a254b1be71864b2904b7b90cd8fef50
+  metadata.gz: c8b68581ece18c4615341881ee3ade2c33f87cbd38eb93c0085589b2f9e44b677ca615596408a05422657c1f8ddef51acb588c9bc565cfdc3d46a442c72a7b1f
+  data.tar.gz: 6a0fe34bcb0044dac585c0f552981ad781a54a6e8cd1c62d4c58d25a9b594f5133b2eac01286a58d2760bb43b30221ce0912e85bce3ec57a15439d8af0632fca

data/.travis.yml

@@ -1,12 +1,20 @@
 language: ruby
 rvm:
-  - 2.2
+- 2.2
 env:
   global:
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
 cache: bundler
 sudo: false
 before_script: bundle update
-script: ./script/cibuild
+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/History.markdown

@@ -1,3 +1,23 @@
+## 0.9.0 / 2017-02-16
+
+### Minor Enhancements
+
+  * Use absolute_url to generate the feed_meta url (#150)
+  * Make feed stylesheet optional (#149)
+  * Use new `normalize_whitespace` filter (#143)
+  * Feed entries must contain <author> (#152)
+  * Remove trailing slash from feed ID (#159)
+
+### Development Fixes
+
+  * Simplify minify regular expression (#141)
+  * Namespace as JekyllFeed (#151)
+  * rubocop -a (#160)
+
+### Bug Fixes
+
+  * Filter out drafts before limit (#154)
+
 ## 0.8.0 / 2016-10-06
 
   * Use filters to clean up Liquid template (#134)

data/README.md

@@ -122,6 +122,10 @@ 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.
 
+### 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.
+
 ## 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).

data/jekyll-feed.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-feed"
-  spec.version       = "0.8.0"
+  spec.version       = "0.9.0"
   spec.authors       = ["Ben Balter"]
   spec.email         = ["ben.balter@github.com"]
   spec.summary       = "A Jekyll plugin to generate an Atom feed of your Jekyll posts"

data/lib/jekyll-feed.rb

@@ -1,3 +1,10 @@
-require "jekyll/feed_meta_tag"
-require "jekyll/jekyll-feed"
-require "jekyll/page_without_a_file"
+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/{feed.xml → jekyll-feed/feed.xml}

@@ -1,11 +1,13 @@
 <?xml version="1.0" encoding="utf-8"?>
-<?xml-stylesheet type="text/xml" href="{{ '/feed.xslt.xml' | absolute_url }}"?>
+{% 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>
   <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>{{ '/' | absolute_url | xml_escape }}</id>
 
   {% if site.title %}
     <title type="html">{{ site.title | smartify | xml_escape }}</title>
@@ -29,10 +31,10 @@
     </author>
   {% endif %}
 
-  {% for post in site.posts limit: 10 %}
-  {% unless post.draft %}
+  {% 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 | replace: '\n', ' ' | strip | xml_escape }}</title>
+      <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>
@@ -45,17 +47,15 @@
       {% assign post_author_uri = post_author.uri | default: nil %}
       {% assign post_author_name = post_author.name | default: post_author %}
 
-      {% if post_author %}
-        <author>
-            <name>{{ post_author_name | 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>
-      {% endif %}
+      <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 }}" />
@@ -66,7 +66,7 @@
       {% endfor %}
 
       {% if post.excerpt and post.excerpt != empty %}
-        <summary type="html">{{ post.excerpt | strip_html | replace: '\n', ' ' | strip | xml_escape }}</summary>
+        <summary type="html">{{ post.excerpt | strip_html | normalize_whitespace | xml_escape }}</summary>
       {% endif %}
 
       {% assign post_image = post.image.path | default: post.image %}
@@ -77,6 +77,5 @@
         <media:thumbnail xmlns:media="http://search.yahoo.com/mrss/" url="{{ post_image }}" />
       {% endif %}
     </entry>
-  {% endunless %}
   {% endfor %}
 </feed>

data/lib/{jekyll/jekyll-feed.rb → jekyll-feed/generator.rb}

@@ -1,23 +1,23 @@
-require "fileutils"
-
-module Jekyll
-  class JekyllFeed < Jekyll::Generator
+module JekyllFeed
+  class Generator < Jekyll::Generator
     safe true
     priority :lowest
 
     # Main plugin action, called by Jekyll-core
     def generate(site)
       @site = site
-      unless file_exists?(feed_path)
-        @site.pages << content_for_file(feed_path, feed_source_path)
-      end
-      unless file_exists?(xslt_path)
-        @site.pages << content_for_file(xslt_path, xslt_source_path)
-      end
+      return if file_exists?(feed_path)
+      @site.pages << content_for_file(feed_path, feed_source_path)
     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+!
+
     # Path to feed from config, or feed.xml for default
     def feed_path
       if @site.config["feed"] && @site.config["feed"]["path"]
@@ -27,19 +27,9 @@ module Jekyll
       end
     end
 
-    # Path to feed stylesheet from config
-    def xslt_path
-      "feed.xslt.xml"
-    end
-
     # Path to feed.xml template file
     def feed_source_path
-      File.expand_path "../feed.xml", File.dirname(__FILE__)
-    end
-
-    # Path to the feed.xslt.xml template file
-    def xslt_source_path
-      File.expand_path "../feed.xslt.xml", File.dirname(__FILE__)
+      File.expand_path "./feed.xml", File.dirname(__FILE__)
     end
 
     # Checks if a file already exists in the site source
@@ -54,9 +44,10 @@ module Jekyll
     # 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(%r!(?<\!")\s+([<{])!, '\1')
+      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
     end

data/lib/{jekyll/feed_meta_tag.rb → jekyll-feed/meta-tag.rb}

@@ -1,5 +1,8 @@
-module Jekyll
-  class FeedMetaTag < Liquid::Tag
+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(" ")
@@ -16,8 +19,8 @@ module Jekyll
       {
         :type  => "application/atom+xml",
         :rel   => "alternate",
-        :href  => "#{url}/#{path}",
-        :title => title
+        :href  => absolute_url(path),
+        :title => title,
       }.keep_if { |_, v| v }
     end
 
@@ -29,18 +32,8 @@ module Jekyll
       end
     end
 
-    def url
-      if config["url"]
-        URI.join(config["url"], config["baseurl"])
-      elsif config["github"] && config["github"]["url"]
-        config["github"]["url"]
-      end
-    end
-
     def title
       config["title"] || config["name"]
     end
   end
 end
-
-Liquid::Template.register_tag("feed_meta", Jekyll::FeedMetaTag)

data/lib/{jekyll/page_without_a_file.rb → jekyll-feed/page-without-a-file.rb}

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

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

@@ -0,0 +1,2 @@
+---
+---

data/spec/jekyll-feed_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe(Jekyll::JekyllFeed) do
+describe(JekyllFeed) do
   let(:overrides) { Hash.new }
   let(:config) do
     Jekyll.configuration(Jekyll::Utils.deep_merge_hashes({
@@ -35,9 +35,6 @@ describe(Jekyll::JekyllFeed) do
     expect(Pathname.new(dest_dir("feed.xml"))).to exist
   end
 
-  it "creates a feed.xslt.xml file" do
-    expect(Pathname.new(dest_dir("feed.xslt.xml"))).to exist
-  end
 
   it "doesn't have multiple new lines or trailing whitespace" do
     expect(contents).to_not match /\s+\n/
@@ -48,6 +45,7 @@ describe(Jekyll::JekyllFeed) 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/2015/08/08/stuck-in-the-middle.html"
     expect(contents).to_not match /http:\/\/example\.org\/2016\/02\/09\/a-draft\.html/
   end
 
@@ -118,7 +116,7 @@ describe(Jekyll::JekyllFeed) do
     end
 
     it "includes the items" do
-      expect(feed.items.count).to eql(9)
+      expect(feed.items.count).to eql(10)
     end
 
     it "includes item contents" do
@@ -265,7 +263,7 @@ describe(Jekyll::JekyllFeed) do
   end
 
   context "feed stylesheet" do
-    it "includes a default 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-feed
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-06 00:00:00.000000000 Z
+date: 2017-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -125,12 +125,11 @@ files:
 - README.md
 - Rakefile
 - jekyll-feed.gemspec
-- lib/feed.xml
-- lib/feed.xslt.xml
 - lib/jekyll-feed.rb
-- lib/jekyll/feed_meta_tag.rb
-- lib/jekyll/jekyll-feed.rb
-- lib/jekyll/page_without_a_file.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
 - script/bootstrap
 - script/cibuild
 - script/release
@@ -146,7 +145,9 @@ files:
 - 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
@@ -169,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A Jekyll plugin to generate an Atom feed of your Jekyll posts
@@ -186,6 +187,8 @@ test_files:
 - 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

data/lib/feed.xslt.xml

@@ -1,41 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<xsl:transform  version="1.0"
-  xmlns:a="http://www.w3.org/2005/Atom"
-  xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
->
-
-  <xsl:strip-space elements="*"/>
-  <xsl:output method="text"/>
-
-  <xsl:template match="*"/>
-
-  <xsl:template match="a:feed">
-    <xsl:text>Atom Feed: </xsl:text><xsl:value-of select="a:id"/>
-    <xsl:text>&#10;</xsl:text>
-    <xsl:apply-templates/>
-  </xsl:template>
-
-  <xsl:template match="a:entry">
-    <xsl:text>  ----------------------------------------&#10;</xsl:text>
-    <xsl:text>  Feed entry: </xsl:text><xsl:value-of select="a:id"/>
-    <xsl:text>&#10;</xsl:text>
-    <xsl:apply-templates/>
-  </xsl:template>
-
-  <xsl:template match="a:title">
-    <xsl:if test="parent::a:entry">
-      <xsl:value-of select="'  '"/>
-    </xsl:if>
-    <xsl:value-of select="local-name()"/>: <xsl:apply-templates/>
-    <xsl:text>&#10;</xsl:text>
-  </xsl:template>
-
-  <xsl:template match="a:published|a:updated">
-    <xsl:if test="parent::a:entry">
-      <xsl:value-of select="'  '"/>
-    </xsl:if>
-    <xsl:value-of select="local-name()"/>: <xsl:apply-templates/>
-    <xsl:text>&#10;</xsl:text>
-  </xsl:template>
-
-</xsl:transform>