jekyll-feed 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f176689295e8ff51047858c3829bbdbd958bd7c
-  data.tar.gz: 9edc5f5304f28908f717ebfc06609d87689a4fcc
+  metadata.gz: 6f446d429dab098b3e1f5223df91297057ddcb61
+  data.tar.gz: 3b71084e350e4ce5f7c9ba4b8594b8b52c0bd239
 SHA512:
-  metadata.gz: c5679f2b5dcb9e07e57b158eb73bb79f45cadd216a860354219ad82b104c2644eb2df19bd455422c53a04bf7fad8ecf2ccc0b7239eae17434c43ae740a1617ac
-  data.tar.gz: 0abebac39dcf7a4483da39f0208449b0bbda5ff098ffa82ff42aa10278023b2e2f1956ff4e07ab7a58c2b4a34f9a5461c9f5b28bbd902d8047efa3b7b5e80e6d
+  metadata.gz: dcd339a74b9f38edb29d218fa58d8432e4b48a957942980ecaab9c89f9824987e5363d284bebc3d9be5759be2f77c9c0e298147a6904296071018e44a3cfe14f
+  data.tar.gz: 39b527846ec7e0a93150df7b22639a0a0e3b79c4857d64de71aa3b875912f812badce5f2e43494550c5cd05af51164d13b38729836cda176f7270333a45b259b

data/.travis.yml

@@ -1,25 +1,22 @@
 language: ruby
 rvm:
-- 2.1
-- 2.2
-- 2.0
-- 1.9
-script: "script/cibuild"
-before_script: bundle update
-cache: bundler
-sudo: false
-
+  - 2.2
+  - 2.1
+  - 2.0
 matrix:
-  exclude:
-    - rvm: 1.9
-      env: JEKYLL_VERSION=3.0.0.beta5
-    - env: JEKYLL_VERSION=2.4
-      rvm: 2.1
-    - rvm: 2.2
-      env: JEKYLL_VERSION=2.4
-
+  include:
+    - # Ruby 1.9
+      rvm: 1.9
+      env: JEKYLL_VERSION=2.0
 env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
   matrix:
-    - ""
-    - JEKYLL_VERSION=2.4
-    - JEKYLL_VERSION=3.0.0.beta5
+    - JEKYLL_VERSION=3.0
+    - JEKYLL_VERSION=2.5
+cache: bundler
+sudo: false
+before_script: bundle update
+script: ./script/cibuild
+notifications:
+  email: false

data/History.markdown

@@ -0,0 +1,5 @@
+## 0.4.0 / 2015-12-30
+
+  * Feed uses `site.title`, or `site.name` if `title` doesn't exist (#72)
+  * Replace newlines with spaces in `title` and `summary` elements (#67)
+  * Properly render post content with Jekyll (#73)

data/jekyll-feed.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-feed"
-  spec.version       = "0.3.1"
+  spec.version       = "0.4.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/feed.xml

@@ -11,7 +11,9 @@
   <updated>{{ site.time | date_to_xmlschema }}</updated>
   <id>{{ url_base | xml_escape }}/</id>
 
-  {% if site.name %}
+  {% if site.title %}
+    <title>{{ site.title | xml_escape }}</title>
+  {% elsif site.name %}
     <title>{{ site.name | xml_escape }}</title>
   {% endif %}
 
@@ -37,7 +39,7 @@
 
   {% for post in site.posts limit: 10 %}
     <entry>
-      <title>{{ post.title | markdownify | strip_html | strip_newlines | xml_escape }}</title>
+      <title>{{ post.title | markdownify | strip_html | replace: '\n', ' ' | strip | xml_escape }}</title>
       <link href="{{ post.url | prepend: url_base }}" rel="alternate" type="text/html" title="{{ post.title | xml_escape }}" />
       <published>{{ post.date | date_to_xmlschema }}</published>
       {% if post.last_modified_at %}
@@ -47,7 +49,7 @@
       {% endif %}
 
       <id>{{ post.id | prepend: url_base | xml_escape }}</id>
-      <content type="html" xml:base="{{ post.url | prepend: url_base | xml_escape }}">{{ post.content | markdownify | xml_escape }}</content>
+      <content type="html" xml:base="{{ post.url | prepend: url_base | xml_escape }}">{{ post.content | strip | xml_escape }}</content>
 
       {% if post.author %}
         <author>
@@ -73,8 +75,8 @@
         <category term="{{ tag | xml_escape }}" />
       {% endfor %}
 
-      {% if post.excerpt and post.excerpt != blank %}
-        <summary>{{ post.excerpt | markdownify | strip_html | strip_newlines | xml_escape }}</summary>
+      {% if post.excerpt and post.excerpt != empty %}
+        <summary>{{ post.excerpt | strip_html | replace: '\n', ' ' | strip | xml_escape }}</summary>
       {% endif %}
     </entry>
   {% endfor %}

data/lib/jekyll-feed.rb

@@ -1,4 +1,4 @@
-require 'fileutils'
+require "fileutils"
 
 module Jekyll
   class PageWithoutAFile < Page
@@ -7,6 +7,12 @@ module Jekyll
     end
   end
 
+  module StripWhitespace
+    def strip(input)
+      input.to_s.strip
+    end
+  end
+
   class FeedMetaTag < Liquid::Tag
     def config
       @context.registers[:site].config
@@ -52,9 +58,7 @@ module Jekyll
       @site = site
       @site.config["time"] = Time.new
       unless feed_exists?
-        write
-        @site.keep_files ||= []
-        @site.keep_files << path
+        @site.pages << feed_content
       end
     end
 
@@ -63,27 +67,13 @@ module Jekyll
       File.expand_path "feed.xml", File.dirname(__FILE__)
     end
 
-    # Destination for feed.xml file within the site source directory
-    def destination_path
-      if @site.respond_to?(:in_dest_dir)
-        @site.in_dest_dir(path)
-      else
-        Jekyll.sanitized_path(@site.dest, path)
-      end
-    end
-
-    # copy feed template from source to destination
-    def write
-      FileUtils.mkdir_p File.dirname(destination_path)
-      File.open(destination_path, 'w') { |f| f.write(feed_content) }
-    end
-
     def feed_content
-      site_map = PageWithoutAFile.new(@site, File.dirname(__FILE__), "", path)
-      site_map.content = File.read(source_path).gsub(/\s*\n\s*/, "\n").gsub(/\n{%/, "{%")
-      site_map.data["layout"] = nil
-      site_map.render(Hash.new, @site.site_payload)
-      site_map.output
+      feed = PageWithoutAFile.new(@site, File.dirname(__FILE__), "", path)
+      feed.content = File.read(source_path).gsub(/\s*\n\s*/, "\n").gsub(/\s+{%/, "{%").gsub(/\s+</,"<")
+      feed.data["layout"] = nil
+      feed.data["sitemap"] = false
+      feed.output
+      feed
     end
 
     # Checks if a feed already exists in the site source
@@ -97,4 +87,8 @@ module Jekyll
   end
 end
 
-Liquid::Template.register_tag('feed_meta', Jekyll::FeedMetaTag)
+unless defined? Liquid::StandardFilters.strip
+    Liquid::Template.register_filter(Jekyll::StripWhitespace)
+end
+
+Liquid::Template.register_tag("feed_meta", Jekyll::FeedMetaTag)

data/script/cibuild

@@ -3,4 +3,4 @@
 set -e
 
 bundle exec rspec
-gem build jekyll-feed.gemspec
+bundle exec rake build

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

@@ -1,4 +1,5 @@
 ---
+excerpt: "Foo"
 ---
 
 # December the twelfth, actually.

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

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

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

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

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

@@ -1,4 +1,5 @@
 ---
+excerpt: ""
 author:
   name: Ben
   uri: "http://ben.balter.com"

data/spec/jekyll-feed_spec.rb

@@ -1,8 +1,9 @@
 require 'spec_helper'
 
 describe(Jekyll::JekyllFeed) do
-  let(:overrides) do
-    {
+  let(:overrides) { Hash.new }
+  let(:config) do
+    Jekyll.configuration(Jekyll::Utils.deep_merge_hashes({
       "full_rebuild" => true,
       "source"      => source_dir,
       "destination" => dest_dir,
@@ -15,10 +16,7 @@ describe(Jekyll::JekyllFeed) do
         "my_collection" => { "output" => true },
         "other_things"  => { "output" => false }
       }
-    }
-  end
-  let(:config) do
-    Jekyll.configuration(overrides)
+    }, overrides))
   end
   let(:site)     { Jekyll::Site.new(config) }
   let(:contents) { File.read(dest_dir("feed.xml")) }
@@ -74,6 +72,15 @@ describe(Jekyll::JekyllFeed) do
     expect(contents).to match /<updated>2015-05-12T13:27:59\+00:00<\/updated>/
   end
 
+  it "replaces newlines in posts to spaces" do
+    expect(contents).to match /<title>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 "parsing" do
     let(:feed) { RSS::Parser.parse(contents) }
 
@@ -93,7 +100,7 @@ describe(Jekyll::JekyllFeed) do
     end
 
     it "includes the items" do
-      expect(feed.items.count).to eql(7)
+      expect(feed.items.count).to eql(8)
     end
 
     it "includes item contents" do
@@ -102,6 +109,44 @@ describe(Jekyll::JekyllFeed) do
       expect(post.link.href).to eql("http://example.org/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.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 "validation" do
@@ -128,8 +173,8 @@ describe(Jekyll::JekyllFeed) do
   end
 
   context "with a baseurl" do
-    let(:config) do
-      Jekyll.configuration(Jekyll::Utils.deep_merge_hashes(overrides, {"baseurl" => "/bass"}))
+    let(:overrides) do
+      { "baseurl" => "/bass" }
     end
 
     it "correctly adds the baseurl to the posts" do
@@ -148,10 +193,14 @@ describe(Jekyll::JekyllFeed) do
   end
 
   context "changing the feed path" do
-    let(:config) do
-      Jekyll.configuration(Jekyll::Utils.deep_merge_hashes(overrides, {"feed" => {"path" => "atom.xml"}}))
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-feed
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-18 00:00:00.000000000 Z
+date: 2015-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -125,6 +125,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- History.markdown
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -136,25 +137,15 @@ files:
 - script/release
 - spec/fixtures/_config.yml
 - spec/fixtures/_layouts/some_default.html
-- spec/fixtures/_my_collection/custom_permalink.md
-- spec/fixtures/_my_collection/custom_permalink_2.md
-- spec/fixtures/_my_collection/test.html
-- spec/fixtures/_other_things/test2.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/2014-05-11-exclude-this-post.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/feeds/atom.xml
-- spec/fixtures/images/hubot.png
 - spec/fixtures/index.html
-- spec/fixtures/jekyll-last-modified-at/page.html
-- spec/fixtures/some-subfolder/exclude-this-page.html
-- spec/fixtures/some-subfolder/test_index.html
-- spec/fixtures/some-subfolder/this-is-a-subfile.html
-- spec/fixtures/some-subfolder/this-is-a-subpage.html
 - spec/jekyll-feed_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jekyll/jekyll-feed
@@ -177,31 +168,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: A Jekyll plugin to generate an Atom feed of your Jekyll posts
 test_files:
 - spec/fixtures/_config.yml
 - spec/fixtures/_layouts/some_default.html
-- spec/fixtures/_my_collection/custom_permalink.md
-- spec/fixtures/_my_collection/custom_permalink_2.md
-- spec/fixtures/_my_collection/test.html
-- spec/fixtures/_other_things/test2.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/2014-05-11-exclude-this-post.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/feeds/atom.xml
-- spec/fixtures/images/hubot.png
 - spec/fixtures/index.html
-- spec/fixtures/jekyll-last-modified-at/page.html
-- spec/fixtures/some-subfolder/exclude-this-page.html
-- spec/fixtures/some-subfolder/test_index.html
-- spec/fixtures/some-subfolder/this-is-a-subfile.html
-- spec/fixtures/some-subfolder/this-is-a-subpage.html
 - spec/jekyll-feed_spec.rb
 - spec/spec_helper.rb

data/spec/fixtures/_my_collection/custom_permalink.md

@@ -1,5 +0,0 @@
----
-permalink: /permalink/
----
-
-# Custom permalink

data/spec/fixtures/_my_collection/custom_permalink_2.md

@@ -1,5 +0,0 @@
----
-permalink: /permalink/unique_name.html
----
-
-# Unique html name

data/spec/fixtures/_my_collection/test.html

@@ -1,4 +0,0 @@
----
----
-
-This is just a test.

data/spec/fixtures/_other_things/test2.html

@@ -1,4 +0,0 @@
----
----
-
-This file shouldn't show up in the sitemap.

data/spec/fixtures/_posts/2014-05-11-exclude-this-post.md

@@ -1,5 +0,0 @@
----
-sitemap: false
----
-
-This post should not appear in the sitemap.

data/spec/fixtures/feeds/atom.xml

@@ -1,6 +0,0 @@
----
----
-
-<?xml version="1.0" encoding="utf-8"?>
-<feed xmlns="http://www.w3.org/2005/Atom">
-</feed>

data/spec/fixtures/jekyll-last-modified-at/page.html

@@ -1,4 +0,0 @@
----
----
-
-This is a page with a modified time.

data/spec/fixtures/some-subfolder/exclude-this-page.html

@@ -1,5 +0,0 @@
----
-sitemap: false
----
-
-Exclude this page

data/spec/fixtures/some-subfolder/test_index.html

@@ -1,4 +0,0 @@
----
----
-
-The permalink of this page does not end with a '/', but with a filename

data/spec/fixtures/some-subfolder/this-is-a-subpage.html

@@ -1,4 +0,0 @@
----
----
-
-This is a subpage!