octopress-feeds 1.3.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fe46bf0122238ae29a7f72bbcc547c5fee9bf62
-  data.tar.gz: 6c4c906d9b62c705ee14e1218083ea4e86ad2dbd
+  metadata.gz: 6f264c935532788b05d291d01c76a1a559c7e0af
+  data.tar.gz: c31b8664e1e0125eb2fdc0e1af7c901859e3f341
 SHA512:
-  metadata.gz: 90f8609f0aa07406ad373ac2a24565f1aa091dcd68f6004a641f457debed0f8ead2d1c10dbecb7653406c8bf35bace8280f56ee1a230536043ef8a229cb46260
-  data.tar.gz: a82ea0f399c9c32d50b8228d58e8434fb939c3c626b6448f92b5fd7a2ada0ac844557ae8208090c7bc3c974a14dacecfe69733bfdfc86069501246b6045da740
+  metadata.gz: 261edcab26afb5fe009409ac3a9fdc89fe255dc290354fd661b01e0095304c021839920be37e15cfbe1fa9df72c23b448faa339e6aeda37556784d0ccd11bd48
+  data.tar.gz: 81d03cff3a35358e3afdfcbc6e98b8bf48d67955e18630c02ffbfac693e700e25465ba9f67653b500999bc5930674155fc7ad5817f5405a6fa664bf51aa90404

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### 1.4.0 (2015-02-20)
+- New: Added category index feeds
+- New: Better configuration management for titles and permalinks
+
 ### 1.3.4 (2015-02-14)
 
 - Only default feed language if a default site language is set.

data/README.md

@@ -85,65 +85,9 @@ each language. Your feed urls will be organized by language. For example:
 
 To change the URL for these pages, read the [Feed Permalinks](#feed-permalinks) section below.
 
-## Customize feeds
-
-To list detailed information about this plugin, run `$ octopress ink list feeds`. This will output something like this:
-
-```
-Plugin: Octopress Feeds - v1.1.5
-Slug: feeds
-RSS feeds for Jekyll sites, featuring link-blogging and multilingual support.
-https://github.com/octopress/feeds
-=============================================================
- includes:
-  - article-feed.xml
-  - entry.xml
-  - head.xml
-  - link-feed.xml
-  - main-feed.xml
-
- pages:                             urls:
-  - main.xml                         /feed/
-  - links.xml                        /feed/links/       # with octopress-linkblog
-  - articles.xml                     /feed/articles/    # with octopress-linkblog
-
- config:
-   count: 20
-   excerpts: false         # Feed excerpts post content
-   external_links: true    # Linkposts should direct visitors to the linked site
-   titles:
-     main-feed: "Posts Feed"
-     article-feed: "Articles-only Feed"
-     link-feed: "Links-only Feed"
-```
-
-If you have posts written in English and German, and are using [octopress-multilingual](https://github.com/octopress/multilingual),
-your permalinks will automatically be name-spaced by language, like this:
-
-```
-pages:                              urls:
-  - main                             /en/feed/
-  - links                            /en/feed/links/
-  - articles                         /en/feed/articles/
-  - main_de                          /de/feed/
-  - links_de                         /de/feed/links/
-  - articles_de                      /de/feed/articles/
-```
-
-Octopress Ink can copy all of the plugin's assets to `_plugins/feeds/*` where you can override them with your own modifications. This is
-only necessary if you want to modify this plugin's behavior.
-
-```
-octopress ink copy feeds
-```
-
-This will copy the plugin's configuration, pages, and includes from the gem, to your local site. If, for example, you want to change the XML for an entry, you can simply edit the `_plugins/feeds/includes/entry.xml` file.
-
-If you want to revert to the defaults, simply delete any file you don't care to override from the `_plugins/feeds/` directory.
-
 ## Configuration
 
-To configure this plugin, first create a configuration file at `_plugins/feeds/config.yml`. If you like, you can have Octopress Ink add it for you.
+To configure this plugin, first copy the plugin's configuration file to `_plugins/feeds/config.yml` buy running:
 
 ```
 $ octopress ink copy feeds --config-file
@@ -151,51 +95,45 @@ $ octopress ink copy feeds --config-file
 
 This will create a configuration file populated with the defaults for this plugin. Deleting this file will restore the default configuration.
 
+### Configuration defaults
 
-| Option                | Description                                                 | Default     |
-|:----------------------|:------------------------------------------------------------|:------------|
-| `count`               | How many posts should appear in your feeds.                 | 20          |
-| `excerpts`            | Feed entries will contain excerpts of post content.         | false       |
-| `external_linkposts`  | Link posts should direct visitors to the linked site.       | true        |
-| `articles_feed`       | Add an additional articles-only feed.                       | false       |
-| `linkposts_feed`      | Add an additional link-posts-only feed.                     | false       |
-| `titles`              | Set feed titles for main, article, and link feeds.          | [see below] |
-| `permalinks`          | Set the permalink for feed pages.                           | {}          |
+```
+count: 20               # Maximum number of posts in a feed
+excerpts: false         # Use post excerpts in feeds
+external_links: true    # Linkposts should direct visitors to the linked site
+category_feeds: false   # Add a feed for post categories
+categories: []          # Only add feeds for these categories. (empty adds feeds for all categories)
 
+titles:
+  main:      site.name - Posts
+  links:     site.name - Links-only
+  articles:  site.name - Articles-only
+  category:  site.name - Posts in category.name
+
+permalinks: 
+  main:     /feed/
+  links:    /feed/links/
+  articles: /feed/articles/
+  category: /feed/categories/category.name/
+```
 
 ### Feed titles
 
 The `titles` configuration allows you to control the title that RSS subscribers see for your feed.
 
-```yaml
-titles:
-  main-feed: Posts Feed
-  article-feed: Articles-only Feed
-  link-feed: Links-only Feed
-```
+As you'd expect, `site.name` is replaced with the value from your site configuration and `category.name` is replaced with the
+category for that feed.
 
 If you want to change the title for other languages you can add a new language localized config file. For example if you have German
 feeds, you would add a config file at `_plugins/feeds/config_de.yml` and set titles for your German language feeds.
 
 ### Feed permalinks
 
-You can set the URL for the feed pages by configuring the `permalink` setting. Here's an example:
-
-```yaml
-permalinks:
-  main: /rss/
-  links: /rss/links/
-  articles: /rss/articles/
-```
+You can set the URL for the feed pages by configuring the `permalinks` setting.
 
-Now when you run `$ octopress ink list feeds` the pages section will look like this:
-
-```
-pages:                              urls:
-  - main                             /rss/
-  - links                            /rss/links/
-  - articles                         /rss/articles/
-```
+If you are running a multilingual site with [octopress-multilingual](https://github.com/octopress/multilingual) permalinks will be
+prepended with the lanugage code that corresponds with the posts in that feed. So `/feeds/` will become `/en/feeds/` and `/de/feeds/`
+and so on.
 
 ### Excerpted feeds
 
@@ -205,6 +143,34 @@ posts, You can change that to something like `<!--more-->` and place that commen
 split the content there.
 
 
+### Customizing feed templates
+
+When you run `$ octopress ink list feeds` the includes and templates section might like this:
+
+```
+includes:
+  - entry.xml
+  - head.xml
+ 
+templates:
+ - articles.xml                  # template file
+    /feed/articles/index.xml     # page generated from template
+ - category.xml
+ - links.xml
+    /feed/links/index.xml
+ - main.xml
+    /feed/index.xml
+```
+
+To customize feed templates and inlcudes, Copy all of the plugin's assets to `_plugins/feeds/` by running this command:
+
+```
+octopress ink copy feeds --templates --includes
+```
+
+Any changes you make to these templates will override the templates in the plugin.  If you want to revert to the defaults, simply delete any file you don't care to override from the `_plugins/feeds/` directory.
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/octopress/feeds/fork )

data/assets/config.yml

@@ -1,8 +1,17 @@
-count: 20
-excerpts: false         # Feed excerpts post content
+count: 20               # Maximum number of posts in a feed
+excerpts: false         # Use post excerpts in feeds
 external_links: true    # Linkposts should direct visitors to the linked site
+category_feeds: false   # Add a feed for categories
+categories: []          # Only add feeds for these categories. (empty adds feeds for all categories)
 
 titles:
-  main-feed: Posts Feed
-  article-feed: Articles-only Feed
-  link-feed: Links-only Feed
+  main:      site.name - Posts
+  links:     site.name - Links-only
+  articles:  site.name - Articles-only
+  category:  site.name - Posts in category.name
+
+permalinks: 
+  main:     /feed/
+  links:    /feed/links/
+  articles: /feed/articles/
+  category: /feed/categories/category.name/

data/assets/{includes/article-feed.xml → templates/articles.xml}

@@ -1,4 +1,6 @@
-{% assign feed_type = 'articles' %}{% include feeds:head.xml %}
+---
+---
+{% include feeds:head.xml %}
 {% for post in site.articles limit:plugins.feeds.count %}
   <entry>
     {% include feeds:entry.xml %}

data/assets/templates/category.xml

@@ -0,0 +1,9 @@
+---
+---
+{% include feeds:head.xml %}
+{% for post in site.categories[page.category] limit:plugins.feeds.count %}
+  <entry>
+    {% include feeds:entry.xml %}
+  </entry>
+{% endfor %}
+</feed>

data/assets/{includes/link-feed.xml → templates/links.xml}

@@ -1,4 +1,6 @@
-{% assign feed_type = 'linkposts' %}{% include feeds:head.xml %}
+---
+---
+{% include feeds:head.xml %}
 {% for post in site.linkposts limit:plugins.feeds.count %}
   <entry>
     {% include feeds:entry.xml %}

data/assets/{includes/main-feed.xml → templates/main.xml}

@@ -1,4 +1,6 @@
-{% assign feed_type = 'posts' %}{% include feeds:head.xml %}
+---
+---
+{% include feeds:head.xml %}
 {% for post in site.posts limit:plugins.feeds.count %}
   <entry>
     {% include feeds:entry.xml %}

data/lib/octopress-feeds/tags.rb

@@ -2,8 +2,10 @@ module Octopress
   module Feeds
     class FeedTag < Liquid::Tag
       def render(context)
-        Octopress::Ink.plugin('feeds').pages.dup
-          .map { |p| tag(p.page) }
+        Octopress::Ink.plugin('feeds').templates
+          .sort_by { |template| template.file.size }
+          .map { |template| template.pages }
+          .flatten.map {|page| tag(page) }
           .join("\n")
       end
 
@@ -14,9 +16,7 @@ module Octopress
       end
 
       def page_title(page)
-        title = page.site.config['name'].dup || ''
-        title << ': ' unless title.empty?
-        title << page_title_config(page)
+        title = page_title_config(page)
 
         if defined?(Octopress::Multilingual) && page.lang
           title << " (#{Octopress::Multilingual.language_name(page.lang)})"
@@ -26,29 +26,36 @@ module Octopress
       end
 
       def page_title_config(page)
-        plugin = page.plugin
-        config = plugin.config(page.lang)
+        plugin = Octopress::Ink.plugin('feeds')
+        config = plugin.config(page.lang)['titles']
 
-        case plugin.feed_type(page.asset)
-        when 'article'; config['titles']['article-feed']
-        when 'link'; config['titles']['link-feed']
-        else config['titles']['main-feed']
+        site_name = page.site.config['name'] || ''
+        type = page.data['feed_type']
+        title = config[type]
+
+        if type == 'category'
+          category = page.data['category'].capitalize
+
+          if labels = Octopress.site.config['category_labels']
+            category = labels[category.downcase] || category
+          end
+
+          title = title.sub(/category\.name/, category)
         end
+
+        title.sub(/site\.name/, site_name)
       end
     end
 
     class FeedUpdatedTag < Liquid::Tag
       def render(context)
-        feed = context['feed_type'] || 'posts'
+        feed = context['page.feed_type']
         site = context['site']
 
-        case feed
-        when 'articles'
-          posts = site['articles']
-        when 'linkposts'
-          posts = site['linkposts']
+        if feed == 'category'
+          posts = site['categories'][context['page.category']]
         else
-          posts = site['posts']
+          posts = site[feed] || site['posts']
         end
 
         if posts && !posts.empty?

data/lib/octopress-feeds/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Feeds
-    VERSION = "1.3.4"
+    VERSION = "1.4.0"
   end
 end

data/lib/octopress-feeds.rb

@@ -4,88 +4,92 @@ require 'octopress-include-tag'
 require 'octopress-return-tag'
 require 'octopress-date-format'
 require 'octopress-feeds/tags'
-require 'octopress-feeds/config-asset'
 
 
 module Octopress
   module Feeds
     class Plugin < Ink::Plugin
 
-      def config_defaults
-        @config ||= Feeds::Config.new(self, @config_file)
+      def multilingual?
+        (defined?(Octopress::Multilingual) && !Octopress.site.config['lang'].nil?)
       end
 
-      def add_pages
-        super
-
+      def add_template_pages
         # Remove linkblog pages if the octopress-linkblog plugin isn't installed
-
-        unless defined? Octopress::Linkblog
-          @pages.reject! do |p|
-            p.file =~ /(article|link)/
+        if multilingual?
+          # Add pages for other languages
+          Octopress::Multilingual.languages.each do |lang|
+            add_feeds(lang)
           end
+        else
+          add_feeds
         end
+      end
 
-        @pages.sort_by! {|p| p.path.size }
+      def add_feeds(lang=nil)
 
-        if defined?(Octopress::Multilingual) && Octopress.site.config['lang']
+        lang = nil unless multilingual?
 
-          # Add default language to main feeds
-          @pages.each do |page| 
-            lang = Octopress.site.config['lang']
-            page.data.merge!({'lang' => lang}) 
-            page.permalink ||= lang_permalink(page, lang)
-          end
+        config = self.config(lang)
+        files = ['main.xml']
 
-          # Ensure multilingual pages are set up for `ink list` view
-          Octopress.site.read if Octopress.site.posts.empty?
+        if defined? Octopress::Linkblog
+          files.concat %w{links.xml articles.xml}
+        end
 
-          # Add pages for other languages
-          Octopress::Multilingual.languages.each do |lang|
-            next if lang == Octopress::Multilingual.main_language
-            @pages.concat add_lang_pages(lang)
-          end
+        files.each do |file|
+          add_template_page(file, permalink(file, lang), {
+            'lang' => lang,
+            'feed_type' => feed_type(file)
+          })
         end
-      end
 
-      def lang_permalink(page, lang)
-        File.join("/#{lang}", "feed", feed_url(page), '/')
+        if config['category_feeds']
+          add_category_feeds(config, lang)
+        end
       end
 
-      def add_lang_pages(lang)
-        lang_pages = []
-
-        # For each page template, create a new page, and configure its permalink defaults
-        #
-        @pages.each do |page|
-          # New name for permalink settings in plugin config.yml
-          permalink_name = "#{page.permalink_name}_#{lang}"
+      def add_category_feeds(config, lang)
+        categories = Array(config['categories'])
 
-          # Set the permalink default to /[lang]/feed/[type]
-          permalink = File.join("/#{lang}", "feed", feed_url(page), '/')
-
-          # Create a copy of the page
-          lang_pages << begin
-            p = page.clone(permalink, permalink_name).merge_data({'lang'=>lang})
+        if categories.empty?
+          if lang
+            categories = Octopres::Multilingual.categories_by_language(lang).keys
+          else
+            categories = Octopress.site.categories.keys
           end
         end
 
-        lang_pages.sort_by {|p| p.path.size }
+        categories.each do |category|
+          category = category.downcase
+          dir = config['permalinks']['category'].sub('category.name', category)
+          permalink = File.join(lang || '', dir, 'index.xml')
+          add_template_page('category.xml', permalink, {
+            'lang' => lang,
+            'category' => category,
+            'feed_type' => 'category'
+          })
+        end
       end
 
-      def feed_url(page)
-        case feed_type(page)
-        when 'article'; 'articles'
-        when 'link'; 'links'
-        else ''
+      def permalink(template, lang)
+        type = feed_type(template)
+        url = File.join(lang || '', config(lang)['permalinks'][type])
+
+        # Allow permalinks to specify a filename (ugh, if you must…)
+        unless File.extname(url) == '.xml'
+          url = File.join(url, 'index.xml')
         end
+
+        url
       end
 
-      def feed_type(page)
-        if page.file =~ /article/
-          'article'
-        elsif page.file =~ /link/
-          'link'
+      # Discern feed type based on filename
+      def feed_type(template)
+        if template =~ /articles/
+          'articles'
+        elsif template =~ /links/
+          'links'
         else
           'main'
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-feeds
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.4.0
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-15 00:00:00.000000000 Z
+date: 2015-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octopress-ink
@@ -161,16 +161,13 @@ files:
 - LICENSE.txt
 - README.md
 - assets/config.yml
-- assets/includes/article-feed.xml
 - assets/includes/entry.xml
 - assets/includes/head.xml
-- assets/includes/link-feed.xml
-- assets/includes/main-feed.xml
-- assets/pages/articles.xml
-- assets/pages/links.xml
-- assets/pages/main.xml
+- assets/templates/articles.xml
+- assets/templates/category.xml
+- assets/templates/links.xml
+- assets/templates/main.xml
 - lib/octopress-feeds.rb
-- lib/octopress-feeds/config-asset.rb
 - lib/octopress-feeds/tags.rb
 - lib/octopress-feeds/version.rb
 homepage: https://github.com/octopress/feeds

data/assets/pages/articles.xml

@@ -1,5 +0,0 @@
----
-permalink: /feed/articles/
-feed: true
----
-{% include feeds:article-feed.xml %}

data/assets/pages/links.xml

@@ -1,5 +0,0 @@
----
-permalink: /feed/links/
-feed: true
----
-{% include feeds:link-feed.xml %}

data/assets/pages/main.xml

@@ -1,5 +0,0 @@
----
-permalink: /feed/
-feed: true
----
-{% include feeds:main-feed.xml %}

data/lib/octopress-feeds/config-asset.rb

@@ -1,25 +0,0 @@
-module Octopress
-  module Feeds
-    class Config < Ink::Assets::Config
-      def read
-        config = super
-        if defined? Octopress::Multilingual
-          config = Jekyll::Utils.deep_merge_hashes(multilingual_permalinks, config)
-        end
-        config
-      end
-
-      def multilingual_permalinks
-        if lang = Octopress.site.config['lang']
-          { "permalinks" => {
-            "main"    => "/#{lang}/feed/",
-            "links"    => "/#{lang}/feed/links/",
-            "articles" => "/#{lang}/feed/articles/"
-          }}
-        else
-          {}
-        end
-      end
-    end
-  end
-end