bridgetown-feed 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b50b2c9c0ca17130d8de98b10525376be36f485dbb15ed035924c2ff831a29e
+  data.tar.gz: 30bd31d0bef345dcfe543e0cb72f958023e074ddcff8b855d7d3cac5b921403e
+SHA512:
+  metadata.gz: 692474a5822f8fa91bbf9bfab116bdc171b04e5f4f3f8172db6087808b295f89ad19b93a66950365a3850c26f9c535fcdbde06447c474e8cbe7acc3be822f0fb
+  data.tar.gz: 67e3c6e9d1250dcbdf9963377c18636232c637a068d438fcad658a1ad7467aa4017b16e1acc6f0ca90e34264cc74124dfed52797e4dcec16b7fa24b5ab75a139

data/.gitignore

@@ -0,0 +1,21 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+spec/dest
+.bundle
+.bridgetown-metadata
+.bridgetown-cache

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,27 @@
+require: rubocop-jekyll
+
+inherit_gem:
+  rubocop-jekyll: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Include:
+    - lib/**/*.rb
+
+  Exclude:
+    - .gitignore
+    - .rspec
+    - .rubocop.yml
+    - .travis.yml
+
+    - Gemfile.lock
+    - History.markdown
+    - LICENSE.txt
+    - README.md
+
+    - script/**/*
+    - vendor/**/*
+
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - lib/bridgetown-feed/page-without-a-file.rb

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "brdgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]
+
+install_if -> { Gem.win_platform? } do
+  gem "tzinfo", "~> 1.2"
+  gem "tzinfo-data"
+end

data/History.markdown

@@ -0,0 +1,5 @@
+# Change Log
+
+## 1.0.0 / 2020-04-09
+
+Use Bridgetown gem and rename to bridgetown-feed.

data/LICENSE.txt

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present Jared White and Bridgetown contributors
+Copyright (c) 2015-2020 Ben Balter and jekyll-feed contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,201 @@
+# Bridgetown Feed plugin
+
+A Bridgetown plugin to generate an Atom (RSS-like) feed of your Bridgetown posts
+
+## Installation
+
+Run this command to add this plugin to your site's Gemfile:
+
+```shell
+$ bundle add bridgetown-feed -g bridgetown_plugins
+```
+
+Or simply add this line to your Gemfile:
+
+```ruby
+gem 'bridgetown-feed', group: "bridgetown_plugins"
+```
+
+## Usage
+
+The plugin will automatically generate an Atom feed at `/feed.xml`.
+
+### Optional configuration options
+
+The plugin will automatically use any of the following configuration variables, if they are present in your site's `bridgetown.config.yml` file.
+
+* `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 Bridgetown and other awesome things"
+* `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?
+
+Do you already have an existing feed someplace other than `/feed.xml`, but are on a host like GitHub Pages that doesn't support machine-friendly redirects? If you simply swap out `bridgetown-feed` for your existing template, your existing subscribers won't continue to get updates. Instead, you can specify a non-default path via your site's config.
+
+```yml
+feed:
+  path: atom.xml
+```
+
+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.
+
+### Optional front matter
+
+The plugin will use the following post metadata, automatically generated by Bridgetown, which you can override via a post's YAML front matter:
+
+* `date`
+* `title`
+* `excerpt`
+* `id`
+* `category`
+* `tags`
+
+Additionally, the plugin will use the following values, if present in a post's YAML front matter:
+
+* `image` - URL of an image that is representative of the post (can also be passed as `image.path`)
+
+* `author` - The author of the post, e.g., "Dr. Bridgetown". If none is given, feed readers will look to the feed author as defined in `bridgetown.config.yml`. Like the feed author, this can also be an object or a reference to an author in `_data/authors.yml` (see below).
+
+### 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.*
+
+There are several ways to convey author-specific information. Author information is found in the following order of priority:
+
+1. An `author` object, in the documents's front matter, e.g.:
+
+  ```yml
+  author:
+    twitter: MarinaDiamandis
+  ```
+
+2. An `author` object, in the site's `bridgetown.config.yml`, e.g.:
+
+  ```yml
+  author:
+    twitter: MarinaDiamandis
+  ```
+
+3. `site.data.authors[author]`, if an author is specified in the document's front matter, and a corresponding key exists in `site.data.authors`. E.g., you have the following in the document's front matter:
+
+  ```yml
+  author: marina
+  ```
+
+  And you have the following in `_data/authors.yml`:
+
+  ```yml
+  marina:
+    picture: /img/marina.png
+    twitter: MarinaDiamandis
+
+  jared:
+    picture: /img/jared.png
+    twitter: jaredcwhite
+  ```
+
+  In the above example, the author `marina`'s Twitter handle will be resolved to `@MarinaDiamandis`. This allows you to centralize author information in a single `_data/authors` file for site with many authors that require more than just the author's username.
+
+  *Pro-tip: If `authors` is present in the document's front matter as an array (and `author` is not), the plugin will use the first author listed.*
+
+4. An author in the document's front matter (the simplest way), e.g.:
+
+  ```yml
+  author: marina
+  ```
+
+5. An author in the site's `bridgetown.config.yml`, e.g.:
+
+  ```yml
+  author: marina
+  ```
+
+### Meta tags
+
+The plugin exposes a helper tag to expose the appropriate meta tags to support automated discovery of your feed. Simply place `{% feed_meta %}` someplace in your template's `<head>` section, to output the necessary metadata.
+
+### SmartyPants
+
+The plugin uses [Bridgetown's `smartify` filter](https://bridgetownrb.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.
+
+Bridgetown's `smartify` filter uses [kramdown](https://kramdown.gettalong.org/options.html) as a processor.  Accordingly, if you do not want "smart" typographic punctuation, disabling them in kramdown in your `bridgetown.config.yml` will disable them in your feed. For example:
+
+   ```yml
+   kramdown:
+     smart_quotes:               apos,apos,quot,quot
+     typographic_symbols:        {hellip: ...}
+   ```
+
+### Custom styling
+
+Want to style what your feed looks like in the browser? Simply add an XSLT at `/feed.xslt.xml` and Bridgetown 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/bridgetown/bridgetown-rss-feed/issues/2).
+
+## Categories
+
+Bridgetown Feed can generate feeds for each category. Simply define which categories you'd like feeds for in your config:
+
+```yml
+feed:
+  categories:
+    - news
+    - updates
+```
+
+## Collections
+
+Bridgetown 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:
+
+```yml
+feed:
+  collections:
+    - changes
+```
+
+By default, collection feeds will be outputted to `/feed/<COLLECTION>.xml`. If you'd like to customize the output path, specify a collection's custom path as follows:
+
+```yml
+feed:
+  collections:
+    changes:
+      path: "/changes.xml"
+```
+
+Finally, collections can also have category feeds which are outputted as `/feed/<COLLECTION>/<CATEGORY>.xml`. Specify categories like so:
+
+```yml
+feed:
+  collections:
+    changes:
+      path: "/changes.xml"
+      categories:
+        - news
+        - 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 it's set to `true` in `bridgetown.config.yml`, 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.
+
+
+## Contributing
+
+1. Fork it (https://github.com/bridgetownrb/bridgetown-feed/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bridgetown-feed.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown-feed/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown-feed"
+  spec.version       = Bridgetown::Feed::VERSION
+  spec.author        = "Bridgetown Team"
+  spec.email         = "maintainers@bridgetownrb.com"
+  spec.summary       = "A Bridgetown plugin to generate an Atom feed of your Bridgetown posts"
+  spec.homepage      = "https://github.com/bridgetownrb/bridgetown-feed"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r!^spec/!)
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.add_dependency "bridgetown", ">= 0.6", "< 2.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "nokogiri", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop-jekyll", "~> 0.5"
+  spec.add_development_dependency "typhoeus", ">= 0.7", "< 2.0"
+end

data/lib/bridgetown-feed.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require "fileutils"
+require "bridgetown-feed/generator"
+
+module BridgetownFeed
+  autoload :MetaTag,          "bridgetown-feed/meta-tag"
+  autoload :PageWithoutAFile, "bridgetown-feed/page-without-a-file.rb"
+end
+
+Liquid::Template.register_tag "feed_meta", BridgetownFeed::MetaTag

data/lib/bridgetown-feed/feed.xml

@@ -0,0 +1,96 @@
+<?xml version="1.0" encoding="utf-8"?>
+{% 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="https://bridgetownrb.com/" version="{{ bridgetown.version }}">Bridgetown</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>{{ page.url | absolute_url | xml_escape }}</id>
+
+  {% assign title = site.title | default: site.name %}
+  {% if page.collection != "posts" %}
+    {% assign collection = page.collection | capitalize %}
+    {% assign title = title | append: " | " | append: collection %}
+  {% endif %}
+  {% if page.category %}
+    {% assign category = page.category | capitalize %}
+    {% assign title = title | append: " | " | append: category %}
+  {% endif %}
+
+  {% if title %}
+    <title type="html">{{ title | smartify | xml_escape }}</title>
+  {% endif %}
+
+  {% if site.description %}
+    <subtitle>{{ site.description | xml_escape }}</subtitle>
+  {% endif %}
+
+  {% if site.author %}
+    <author>
+        <name>{{ site.author.name | default: site.author | xml_escape }}</name>
+      {% if site.author.email %}
+        <email>{{ site.author.email | xml_escape }}</email>
+      {% endif %}
+      {% if site.author.uri %}
+        <uri>{{ site.author.uri | xml_escape }}</uri>
+      {% endif %}
+    </author>
+  {% endif %}
+
+  {% assign posts = site[page.collection] | where_exp: "post", "post.draft != true" | sort: "date" | reverse %}
+  {% if page.category %}
+    {% assign posts = posts | where: "category",page.category %}
+  {% endif %}
+  {% for post in posts limit: 10 %}
+    <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 }}" />
+      <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>
+      {% 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 %}
+      {% assign post_author_email = post_author.email | default: nil %}
+      {% assign post_author_uri = post_author.uri | default: nil %}
+      {% assign post_author_name = post_author.name | default: post_author %}
+
+      <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 }}" />
+      {% endif %}
+
+      {% for tag in post.tags %}
+        <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>
+      {% endif %}
+
+      {% assign post_image = post.image.path | default: post.image %}
+      {% if post_image %}
+        {% unless post_image contains "://" %}
+          {% 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 %}
+</feed>