jekyll-feed 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79e4003a864be95fa4d845116d5719a76f8906c1
-  data.tar.gz: a41c885f6259a7b939b4cdcab4b2243c55ceb32f
+  metadata.gz: 14ee44b7a02f6709b95e9266a5e3b56d36ac065d
+  data.tar.gz: 25ea1ebdaf2ae8f7a5993726e9e73402b96a1136
 SHA512:
-  metadata.gz: 247ff0949c0070bd2b7b589fab0b5486ad7d8f1917c38720e48b8aa6bb23a644ae80f803055e172dc50a8fd96407b5e73e9403bb06c9eba6d75ecc444d0d5c12
-  data.tar.gz: 3cddc65822777dddb916d88a84dbb9065cdaba9da1e29341273f9975b0b4f10575553ba55a701e3c813df035ac4f623bb8f920f6adc6fa7cc6269f8c35c98392
+  metadata.gz: f9a1af3d768c6d8c921c11d3eb71205119b8b01e9569ca2f3697ee2f2c8f38c3e73cf9f7857b52fec581da487bd022499deab2a0cbfa4ff212af15737e6d06f6
+  data.tar.gz: 59435b91142b86809fd70e33b9293125e2a3e9ac28c789e0f735436ed4355e0a2d0378acf3fbad0148ce38a6b537e0f27af8d36bd728f297cdec78042c820c2d

data/README.md

@@ -30,7 +30,11 @@ The plugin will automatically use any of the following configuration variables,
 * `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`.
-* `author` - Your name, e.g., "Dr. Jekyll"
+* `author` - Your name, e.g., "Dr. Jekyll." This can be a string (with the author's name), or an object with the following properties:
+  - `name` - **Required** Display name of the author
+  - `email` - Email address of the author
+  - `uri` - Webpage where more information about the author can be found
+
 
 ### Optional front matter
 
@@ -45,7 +49,7 @@ The plugin will use the following post metadata, automatically generated by Jeky
 
 Additionally, the plugin will use the following values, if present in a post's YAML front matter:
 
-* `author` - The author of the post, e.g., "Dr. Jekyll". If none is given, feed readers will look to the feed author as defined in `_config.yml`
+* `author` - The author of the post, e.g., "Dr. Jekyll". If none is given, feed readers will look to the feed author as defined in `_config.yml`. Like the feed author, this can also be an object.
 
 ### Meta tags
 

data/jekyll-feed.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-feed"
-  spec.version       = "0.1.4"
+  spec.version       = "0.2.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"
@@ -20,5 +20,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "typhoeus", "~> 0.7"
   spec.add_development_dependency "nokogiri", "~> 1.6"
+  spec.add_development_dependency "jekyll-last-modified-at", "0.3.4"
 
 end

data/lib/feed.xml

@@ -21,7 +21,19 @@
 
   {% if site.author %}
     <author>
-      <name>{{ site.author | xml_escape }}</name>
+      {% if site.author.name %}
+        <name>{{ site.author.name | xml_escape }}</name>
+      {% else %}
+        <name>{{ site.author | xml_escape }}</name>
+      {% endif %}
+      {% if site.author.email %}
+        <email>{{ site.author.email | xml_escape }}</email>
+      {% endif %}
+      {% if site.author.uri %}
+        </uri>{{ site.author.uri | xml_escape }}</uri>
+      {% elsif site.author.url %}
+        </uri>{{ site.author.url | xml_escape }}</uri>
+      {% endif %}
     </author>
   {% endif %}
 
@@ -30,14 +42,30 @@
       <title>{{ post.title | markdownify | strip_html | strip_newlines | 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>
-      <updated>{{ post.date | date_to_xmlschema }}</updated>
+      {% if post.last_modified_at %}
+        <updated>{{ post.last_modified_at | date_to_xmlschema }}</updated>
+      {% else %}
+        <updated>{{ post.date | date_to_xmlschema }}</updated>
+      {% 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>
 
       {% if post.author %}
         <author>
+          {% if post.author.name %}
+            <name>{{ post.author.name | xml_escape }}</name>
+          {% else %}
             <name>{{ post.author | xml_escape }}</name>
+          {% endif %}
+          {% if post.author.email %}
+            <email>{{ post.author.email | xml_escape }}</email>
+          {% endif %}
+          {% if post.author.url %}
+            </uri>{{ post.author.url | xml_escape }}</uri>
+          {% elsif post.author.url %}
+            </uri>{{ post.author.url | xml_escape }}</uri>
+          {% endif %}
         </author>
       {% endif %}
 

data/spec/fixtures/_config.yml

@@ -1,5 +1,8 @@
 timezone: UTC
 
+gems:
+  - jekyll-last-modified-at
+
 defaults:
   -
     scope:

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

@@ -1,4 +1,5 @@
 ---
+author: Pat
 ---
 
 <pre>Line 1

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

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

data/spec/jekyll-feed_spec.rb

@@ -53,10 +53,26 @@ describe(Jekyll::JekyllFeed) 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 /<author>\s*<name>Ben<\/name>\s*<email>ben@example.com<\/email>\s*<\/author>/
+  end
+
+  it "supports post author name as a string" do
+    expect(contents).to match /<author>\s*<name>Pat<\/name>\s*<\/author>/
+  end
+
+  it "does not output author tag no author is provided" do
+    expect(contents).not_to match /<author>\s*<name><\/name>\s*<\/author>/
+  end
+
   it "converts markdown posts to HTML" do
     expect(contents).to match /&lt;p&gt;March the second!&lt;\/p&gt;/
   end
 
+  it "converts uses last_modified_at where available" do
+    expect(contents).to match /<updated>2015-05-12T13:27:59\+00:00<\/updated>/
+  end
+
   context "parsing" do
     let(:feed) { RSS::Parser.parse(contents) }
 
@@ -76,7 +92,7 @@ describe(Jekyll::JekyllFeed) do
     end
 
     it "includes the items" do
-      expect(feed.items.count).to eql(6)
+      expect(feed.items.count).to eql(7)
     end
 
     it "includes item contents" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-feed
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: jekyll-last-modified-at
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.4
 description: 
 email:
 - ben.balter@github.com
@@ -126,6 +140,7 @@ files:
 - 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-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
@@ -173,6 +188,7 @@ test_files:
 - 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-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