jekyll-feed 0.15.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8f1fde42e53f27b048363aa57f03f5d51a3f68fbe6af4e0ffb69209b373ffeb
-  data.tar.gz: aaaa1c370f29527e3806c6753ae76a2fa8297337f0e667f25fd43d05779fcfef
+  metadata.gz: 218e5f581b3f29f0f04eb49800c27b61cecb2ec769882ef2aa00008db2d6bd1a
+  data.tar.gz: b3f1ed32d77b488d45c5fcea9540224d2d340660b37db61958b4cd24d37e3bcc
 SHA512:
-  metadata.gz: 6800a223adf7b8c6ae236d6b9d3e355d4ca31c7d2e67752cfd2cb5b3fe599ddda2d9c6f28a38a7c6d5e648ac67ca585fe6fe2a2e08f38c158a1b6a95ded11fd7
-  data.tar.gz: a17bf5e936302721494bba9028ccda96ca88a4e229e0b1c88e6abe63f1ee2c60e3992296da05721d30400952fcc0ccafe4a2bd179038553ee57d3c940a1d04e9
+  metadata.gz: 2b6f1f23ae300ac0caad7a2123e73fb0ea403a9481a1bf71c90b07a166e91c4f64576d48606c960452e431fc1d26cb1531a6649dd622ad0d9c80722edc2a8d3c
+  data.tar.gz: de139bea2ba933414be45fcc6a4fe9e8e7431e8b7ea0bccc2df365121748e4bf07cd9020968670889c84688cc080ce22dc576b1d3936b8c34c07f7eabac727c5

data/History.markdown

@@ -1,4 +1,38 @@
-## HEAD
+## 0.17.0 / 2022-10-14
+
+### Documentation
+
+  * Update CI status badge (#363)
+
+### Development Fixes
+
+  * Add Ruby 3.1 to the CI matrix (#365)
+
+### Minor Enhancements
+
+  * Allow disabling of jekyll-feed while in development (#370)
+
+## 0.16.0 / 2022-01-03
+
+### Minor Enhancements
+
+  * Add support for `page.description` in front matter to become entry `<summary>` (#297)
+
+### Bug Fixes
+
+  * Fold private methods into the `:render` method as local variables (#327)
+  * Check `post.categories` instead of `post.category` (#357)
+  * Switched xml_escape for `<![CDATA[]]>` for post content (#332)
+
+### Development Fixes
+
+  * Add Ruby 3.0 to CI (#337)
+  * Lock RuboCop to v1.18.x (#348)
+  * Add workflow to release gem via GH Action (#355)
+
+### Documentation
+
+  * Use `.atom` extension in documented examples since we write an Atom feed (#359)
 
 ## 0.15.1 / 2020-10-04
 

data/README.md

@@ -2,7 +2,7 @@
 
 A Jekyll plugin to generate an Atom (RSS-like) feed of your Jekyll posts
 
-[![Build Status](https://travis-ci.org/jekyll/jekyll-feed.svg)](https://travis-ci.org/jekyll/jekyll-feed) [![Gem Version](https://badge.fury.io/rb/jekyll-feed.svg)](https://badge.fury.io/rb/jekyll-feed)
+[![Continuous Integration](https://github.com/jekyll/jekyll-feed/actions/workflows/ruby.yml/badge.svg)](https://github.com/jekyll/jekyll-feed/actions/workflows/ruby.yml) [![Gem Version](https://badge.fury.io/rb/jekyll-feed.svg)](https://badge.fury.io/rb/jekyll-feed)
 
 ## Installation
 
@@ -40,7 +40,7 @@ Do you already have an existing feed someplace other than `/feed.xml`, but are o
 
 ```yml
 feed:
-  path: atom.xml
+  path: /blog/feed.atom
 ```
 
 To note, you shouldn't have to do this unless you already have a feed you're using, and you can't or wish not to redirect existing subscribers.
@@ -62,6 +62,8 @@ Additionally, the plugin will use the following values, if present in a post's Y
 
 * `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 or a reference to an author in `_data/authors.yml` (see below).
 
+* `description` - A short description of the post.
+
 ### Author information
 
 *TL;DR: In most cases, put `author: [your name]` in the document's front matter, for sites with multiple authors. If you need something more complicated, read on.*
@@ -176,7 +178,7 @@ By default, collection feeds will be outputted to `/feed/<COLLECTION>.xml`. If y
 feed:
   collections:
     changes:
-      path: "/changes.xml"
+      path: "/changes.atom"
 ```
 
 Finally, collections can also have category feeds which are outputted as `/feed/<COLLECTION>/<CATEGORY>.xml`. Specify categories like so:
@@ -185,7 +187,7 @@ Finally, collections can also have category feeds which are outputted as `/feed/
 feed:
   collections:
     changes:
-      path: "/changes.xml"
+      path: "/changes.atom"
       categories:
         - news
         - updates
@@ -244,6 +246,16 @@ feed:
 
 Note that if you include a tag that is excluded a feed will not be generated for it.
 
+## Skip development
+
+Use `disable_in_development: true` if you want to turn off feed generation when `jekyll.environment == "development"`,
+but don't want to remove the plugin (so you don't accidentally commit the removal). Default value is `false`.
+
+```yml
+feed:
+  disable_in_development: true
+```
+
 ## Contributing
 
 1. Fork it (https://github.com/jekyll/jekyll-feed/fork)

data/lib/jekyll-feed/feed.xml

@@ -45,7 +45,7 @@
     {% assign posts = site[page.collection] %}
   {% endif %}
   {% if page.category %}
-    {% assign posts = posts | where: "category", page.category %}
+    {% assign posts = posts | where: "categories", page.category %}
   {% endif %}
   {% unless site.show_drafts %}
     {% assign posts = posts | where_exp: "post", "post.draft != true" %}
@@ -63,7 +63,7 @@
       <id>{{ post.id | absolute_url | xml_escape }}</id>
       {% assign excerpt_only = post.feed.excerpt_only | default: site.feed.excerpt_only %}
       {% unless excerpt_only %}
-        <content type="html" xml:base="{{ post.url | absolute_url | xml_escape }}">{{ post.content | strip | xml_escape }}</content>
+        <content type="html" xml:base="{{ post.url | absolute_url | xml_escape }}"><![CDATA[{{ post.content | strip }}]]></content>
       {% endunless %}
 
       {% assign post_author = post.author | default: post.authors[0] | default: site.author %}
@@ -94,8 +94,9 @@
         <category term="{{ tag | xml_escape }}" />
       {% endfor %}
 
-      {% if post.excerpt and post.excerpt != empty %}
-        <summary type="html">{{ post.excerpt | strip_html | normalize_whitespace | xml_escape }}</summary>
+      {% assign post_summary = post.description | default: post.excerpt %}
+      {% if post_summary and post_summary != empty %}
+        <summary type="html"><![CDATA[{{ post_summary | strip_html | normalize_whitespace }}]]></summary>
       {% endif %}
 
       {% assign post_image = post.image.path | default: post.image %}

data/lib/jekyll-feed/generator.rb

@@ -8,6 +8,10 @@ module JekyllFeed
     # Main plugin action, called by Jekyll-core
     def generate(site)
       @site = site
+      if disabled_in_development?
+        Jekyll.logger.info "Jekyll Feed:", "Skipping feed generation in development"
+        return
+      end
       collections.each do |name, meta|
         Jekyll.logger.info "Jekyll Feed:", "Generating feed for #{name}"
         (meta["categories"] + [nil]).each do |category|
@@ -54,9 +58,10 @@ module JekyllFeed
     def collections
       return @collections if defined?(@collections)
 
-      @collections = if config["collections"].is_a?(Array)
+      @collections = case config["collections"]
+                     when Array
                        config["collections"].map { |c| [c, {}] }.to_h
-                     elsif config["collections"].is_a?(Hash)
+                     when Hash
                        config["collections"]
                      else
                        {}
@@ -136,5 +141,9 @@ module JekyllFeed
       config["path"] ||= hash["posts"]["path"]
       hash
     end
+
+    def disabled_in_development?
+      config && config["disable_in_development"] && Jekyll.env == "development"
+    end
   end
 end

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

@@ -6,35 +6,22 @@ module JekyllFeed
     include Jekyll::Filters::URLFilters
 
     def render(context)
+      # Jekyll::Filters::URLFilters requires `@context` to be set in the environment.
       @context = context
-      attrs    = attributes.map do |k, v|
-        v = v.to_s unless v.respond_to?(:encode)
-        %(#{k}=#{v.encode(:xml => :attr)})
-      end
-      "<link #{attrs.join(" ")} />"
-    end
-
-    private
-
-    def config
-      @config ||= @context.registers[:site].config
-    end
 
-    def attributes
-      {
-        :type  => "application/atom+xml",
-        :rel   => "alternate",
-        :href  => absolute_url(path),
-        :title => title,
-      }.keep_if { |_, v| v }
-    end
+      config = context.registers[:site].config
+      path   = config.dig("feed", "path") || "feed.xml"
+      title  = config["title"] || config["name"]
 
-    def path
-      config.dig("feed", "path") || "feed.xml"
-    end
+      attributes = {
+        :type => "application/atom+xml",
+        :rel  => "alternate",
+        :href => absolute_url(path),
+      }
+      attributes[:title] = title if title
 
-    def title
-      config["title"] || config["name"]
+      attrs = attributes.map { |k, v| "#{k}=#{v.to_s.encode(:xml => :attr)}" }.join(" ")
+      "<link #{attrs} />"
     end
   end
 end

data/lib/jekyll-feed/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Feed
-    VERSION = "0.15.1"
+    VERSION = "0.17.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-feed
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.17.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-04 00:00:00.000000000 Z
+date: 2022-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -151,14 +151,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A Jekyll plugin to generate an Atom feed of your Jekyll posts