jekyll-feed 0.11.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2f39a0bbb0b44fe86056121002e483fdad9fd750d80df250c3bb8d2773deb62
-  data.tar.gz: 5b8873c7d89f01de3ab5d87c02a30b0186153d1f6c0b05812f8f428b83bfb54a
+  metadata.gz: 9c16a6de621d9c8d90b53acc943396557d63fb1b15a4cc31b749a8b955baf8dd
+  data.tar.gz: 9e913f474172053d3c89bc6de8c042a8649b33b1dd0d5004a8905eec4ad4e3a2
 SHA512:
-  metadata.gz: 0dcd26441f769bef785939357a38cf4b7f299f10bd273553b2f0ee2aa1fde50b1664c94fbac3534bb14b3f8cb8e36e5f361b21e339a8b8e140f6ba3c839e68f6
-  data.tar.gz: 9f682591707af1c16b6756e1638acadaa1cd19ac141f3b816dcf3129cea5ef661fa9e6fe0b7a05a6c6000e07d7a147c89ba155e1932f1062211bbabc2e4f27c2
+  metadata.gz: 553da9fe75950364d829b66a32e5db1018d9176ea490b70492e92ceff35a466dcfeb022341eac325c0e3517a54f598f5a29a1069a9ba038c59572e608f44ef0c
+  data.tar.gz: e37a5317f022496e92ec688a4558a8c1761436b5d72fd8ea6f6aea22f53baa88b4653fb0ae7f37a582a1224ba6504cfd320a4cf1ab0e090fffe43bd99344716d

data/History.markdown

@@ -1,6 +1,53 @@
-## HEAD
+## 0.15.0 / 2020-07-10
 
-  * Release 💎 0.11 (#241)
+### Minor Enhancements
+
+  * Add support for drafts (#316)
+
+## 0.14.0 / 2020-06-24
+
+### Minor Enhancements
+
+  * add support for categories (#153) (#233)
+  * add support for tags (#264)
+  * Make posts limit configurable (#314)
+  * XML escape the title field of feed_meta (#306)
+
+### Bug Fixes
+
+  * Fix feed link when post title contains HTML (#305)
+
+### Development Fixes
+
+  * Use Dir to list source files (#309)
+  * Require Ruby >=2.4.0 (#307)
+
+## 0.13.0 / 2019-11-13
+
+### Minor Enhancements
+
+  * Excerpt only flag (#287)
+  * Add media:content tag (#290)
+
+### Development Fixes
+
+  * test: use categories in post (#249)
+
+## 0.12.1 / 2019-03-23
+
+### Bug Fixes
+
+  * Re-introduce Ruby 2.3 support and test Jekyll 3.7+ (#272)
+
+## 0.12.0 / 2019-03-21
+
+  * Allow Jekyll v4 (still alpha)
+
+### Development Fixes
+
+  * style: fix offenses in specs (#248)
+  * dev: update CI and style settings (#258)
+  * Enable testing for Windows platform (#265)
 
 ## 0.11.0 / 2018-09-09
 

data/README.md

@@ -31,7 +31,7 @@ The plugin will automatically use any of the following configuration variables,
 
 * `title` or `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`.
+* `url` - The URL to your site, e.g., `https://example.com`. If none is provided, the plugin will try to use `site.github.url`.
 * `author` - Global author information (see below)
 
 ### Already have a feed path?
@@ -151,6 +151,15 @@ feed:
     - updates
 ```
 
+## Posts limit
+
+By default the plugin limits the number of posts in the feed to 10. Simply define a new limit in your config:
+
+```yml
+feed:
+  posts_limit: 20
+```
+
 ## 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:
@@ -182,6 +191,59 @@ feed:
         - updates
 ```
 
+## Excerpt Only flag
+
+Optional flag `excerpt_only` allows you to exclude post content from the Atom feed. Default value is `false` for backward compatibility.
+
+When in `config.yml` is `true` than all posts in feed will be without `<content>` tags.
+
+```yml
+feed:
+  excerpt_only: true
+```
+
+The same flag can be used directly in post file. It will be disable `<content>` tag for selected post.
+Settings in post file has higher priority than in config file.
+
+## Tags
+
+To automatically generate feeds for each tag you apply to your posts you can add a tags setting to your config:
+
+```yml
+feed:
+  tags: true
+```
+
+If there are tags you don't want included in this auto generation you can exclude them
+
+```yml
+feed:
+  tags:
+    except:
+      - tag-to-exclude
+      - another-tag
+```
+
+If you wish to change the location of these auto generated feeds (`/feed/by_tag/<TAG>.xml` by default) you can provide an alternative folder for them to live in.
+
+```yml
+feed:
+  tags:
+    path: "alternative/path/for/tags/feeds/"
+```
+
+If you only want to generate feeds for a few tags you can also set this.
+
+```yml
+feed:
+  tags:
+    only:
+      - tag-to-include
+      - another-tag
+```
+
+Note that if you include a tag that is excluded a feed will not be generated for it.
+
 ## Contributing
 
 1. Fork it (https://github.com/jekyll/jekyll-feed/fork)

data/lib/jekyll-feed/feed.xml

@@ -39,18 +39,32 @@
     </author>
   {% endif %}
 
-  {% assign posts = site[page.collection] | where_exp: "post", "post.draft != true" | sort: "date" | reverse %}
+  {% if page.tags %}
+    {% assign posts = site.tags[page.tags] %}
+  {% else %}
+    {% assign posts = site[page.collection] %}
+  {% endif %}
   {% if page.category %}
-    {% assign posts = posts | where: "category",page.category %}
+    {% assign posts = posts | where: "category", page.category %}
   {% endif %}
-  {% for post in posts limit: 10 %}
+  {% unless site.show_drafts %}
+    {% assign posts = posts | where_exp: "post", "post.draft != true" %}
+  {% endunless %}
+  {% assign posts = posts | sort: "date" | reverse %}
+  {% assign posts_limit = site.feed.posts_limit | default: 10 %}
+  {% for post in posts limit: posts_limit %}
     <entry{% if post.lang %}{{" "}}xml:lang="{{ post.lang }}"{% endif %}>
-      <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 }}" />
+      {% assign post_title = post.title | smartify | strip_html | normalize_whitespace | xml_escape %}
+
+      <title type="html">{{ post_title }}</title>
+      <link href="{{ post.url | absolute_url }}" rel="alternate" type="text/html" title="{{ post_title }}" />
       <published>{{ post.date | date_to_xmlschema }}</published>
       <updated>{{ post.last_modified_at | default: post.date | date_to_xmlschema }}</updated>
       <id>{{ post.id | absolute_url | xml_escape }}</id>
-      <content type="html" xml:base="{{ post.url | absolute_url | xml_escape }}">{{ post.content | strip | xml_escape }}</content>
+      {% 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>
+      {% endunless %}
 
       {% assign post_author = post.author | default: post.authors[0] | default: site.author %}
       {% assign post_author = site.data.authors[post_author] | default: post_author %}
@@ -70,6 +84,10 @@
 
       {% if post.category %}
         <category term="{{ post.category | xml_escape }}" />
+      {% elsif post.categories %}
+        {% for category in post.categories %}
+          <category term="{{ category | xml_escape }}" />
+        {% endfor %}
       {% endif %}
 
       {% for tag in post.tags %}
@@ -86,6 +104,7 @@
           {% assign post_image = post_image | absolute_url %}
         {% endunless %}
         <media:thumbnail xmlns:media="http://search.yahoo.com/mrss/" url="{{ post_image | xml_escape }}" />
+        <media:content medium="image" url="{{ post_image | xml_escape }}" xmlns:media="http://search.yahoo.com/mrss/" />
       {% endif %}
     </entry>
   {% endfor %}

data/lib/jekyll-feed/generator.rb

@@ -13,9 +13,11 @@ module JekyllFeed
         (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
+      generate_feed_by_tag if config["tags"] && !@site.tags.empty?
     end
 
     private
@@ -24,7 +26,7 @@ module JekyllFeed
     #   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+!
+    MINIFY_REGEX = %r!(?<=>|})\s+!.freeze
 
     # Returns the plugin's config or an empty hash if not set
     def config
@@ -68,6 +70,32 @@ module JekyllFeed
       @collections
     end
 
+    def generate_feed_by_tag
+      tags_config = config["tags"]
+      tags_config = {} unless tags_config.is_a?(Hash)
+
+      except    = tags_config["except"] || []
+      only      = tags_config["only"] || @site.tags.keys
+      tags_pool = only - except
+      tags_path = tags_config["path"] || "/feed/by_tag/"
+
+      generate_tag_feed(tags_pool, tags_path)
+    end
+
+    def generate_tag_feed(tags_pool, tags_path)
+      tags_pool.each do |tag|
+        # allow only tags with basic alphanumeric characters and underscore to keep
+        # feed path simple.
+        next if %r![^a-zA-Z0-9_]!.match?(tag)
+
+        Jekyll.logger.info "Jekyll Feed:", "Generating feed for posts tagged #{tag}"
+        path = "#{tags_path}#{tag}.xml"
+        next if file_exists?(path)
+
+        @site.pages << make_page(path, :tags => tag)
+      end
+    end
+
     # Path to feed.xml template file
     def feed_source_path
       @feed_source_path ||= File.expand_path "feed.xml", __dir__
@@ -84,7 +112,7 @@ module JekyllFeed
 
     # Generates contents for a file
 
-    def make_page(file_path, collection: "posts", category: nil)
+    def make_page(file_path, collection: "posts", category: nil, tags: nil)
       PageWithoutAFile.new(@site, __dir__, "", file_path).tap do |file|
         file.content = feed_template
         file.data.merge!(
@@ -92,7 +120,8 @@ module JekyllFeed
           "sitemap"    => false,
           "xsl"        => file_exists?("feed.xslt.xml"),
           "collection" => collection,
-          "category"   => category
+          "category"   => category,
+          "tags"       => tags
         )
         file.output
       end

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

@@ -7,7 +7,7 @@ module JekyllFeed
 
     def render(context)
       @context = context
-      attrs    = attributes.map { |k, v| %(#{k}="#{v}") }.join(" ")
+      attrs    = attributes.map { |k, v| %(#{k}=#{v.encode(:xml => :attr)}) }.join(" ")
       "<link #{attrs} />"
     end
 

data/lib/jekyll-feed/version.rb

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

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-feed
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Ben Balter
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-09 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -81,19 +87,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.2
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.2
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -114,58 +120,30 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 
+description:
 email:
 - ben.balter@github.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- History.markdown
+- LICENSE.txt
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- Gemfile
 - History.markdown
 - LICENSE.txt
 - README.md
-- Rakefile
-- jekyll-feed.gemspec
 - lib/jekyll-feed.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
 - lib/jekyll-feed/version.rb
-- script/bootstrap
-- script/cibuild
-- 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
-- spec/fixtures/_layouts/some_default.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/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/_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
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -173,35 +151,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.1.2
+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
-- spec/fixtures/_layouts/some_default.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/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/_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
+test_files: []