jekyll-rss 1.0.0alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e174be5f9523489734e12dda4e22d66218f7990
+  data.tar.gz: 4ac3487bf2f4696cb15cad815267a68de149f342
+SHA512:
+  metadata.gz: e2490ce9f9b981eb8fd2513bacb514baa24308fe39c1a0b4336f112f571cf6322ca28fe401f5eeb07033ebbf695c46dee89002fbcde13fe21a4a56f982c0f906
+  data.tar.gz: 511e71b7d128d4545854cf7c43bc948ec7ff836d2bf16a883fc73bf89a488a4fad7f7e0f3c48d31afb92fb86e21b1f941f468eb5b40fb9abe0b7289161619ca7

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Bezalel Hermoso
+
+MIT License
+
+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/lib/jekyll-rss/category_feed.rb

@@ -0,0 +1,21 @@
+
+module Jekyll
+  module RSS
+    class CategoryFeed < RSSFeed
+    
+      NON_SLUG_REGEX = /[^a-z0-9\-_]/
+    
+      def initialize(site, path, category)
+        @category = category
+        @category_slug = category.strip.gsub(' ', '-').gsub(NON_SLUG_REGEX, '')
+        super site, path
+      end
+      
+      def url_placeholders
+        placeholders = super
+        placeholders[:category] = @category_slug
+        placeholders
+      end
+    end
+  end
+end

data/lib/jekyll-rss/generator.rb

@@ -0,0 +1,42 @@
+module Jekyll
+  module RSS
+    class Generator < ::Jekyll::Generator
+	    def generate(site)
+        return nil unless site.config['rss']
+        generate_blog_feed site if File.exists? File.join(site.source, '_rss', 'blog.xml')
+        generate_category_feeds site if File.exists? File.join(site.source, '_rss', 'category.xml')
+      end
+
+      def generate_blog_feed(site)
+        path = File.join site.source, '_rss', 'blog.xml'
+        feed = RSSFeed.new site, path
+        paginate_blog(site, feed) if site.config['rss'].is_a? Hash and site.config['rss']['paginate']
+        site.pages << feed
+      end
+
+      def generate_category_feeds(site)
+        path = File.join site.source, '_rss', 'category.xml'
+        site.categories.each do |category, posts|
+          feed = CategoryFeed.new site, path, category
+          paginate_category(site, feed, category, posts) if site.config['rss'].is_a? Hash and site.config['rss']['paginate']
+          site.pages << feed
+        end
+      end
+
+      def paginate_blog(site, feed)
+        Pagination.paginate site, feed, site.posts do |pager|
+          RSSFeed.new feed.site, feed.source
+        end
+      end
+
+      def paginate_category(site, feed, category_name, category_posts)
+        Pagination.paginate site, feed, category_posts do |pager|
+          category = CategoryFeed.new feed.site, feed.source, category_name
+          category.data['category'] = category_name
+          category.data['posts'] = category_posts
+          category
+        end
+      end
+	  end
+  end
+end

data/lib/jekyll-rss/pager.rb

@@ -0,0 +1,28 @@
+module Jekyll
+  module RSS
+    class Pager < ::Jekyll::Paginate::Pager
+
+      attr_reader :path_format
+
+      def initialize(site, page_num, posts, per_page, index_page)
+        @index_page = index_page
+        super site, page_num, posts, per_page
+        @previous_page_path = paginate_path site, @previous_page
+        @next_page_path = paginate_path site, @next_page
+      end
+
+      def paginated_permalink
+        @index_page.data['paginated_permalink']
+      end
+
+      def paginate_path(site, num_page)
+        return nil if num_page.nil?
+        return @index_page.url if num_page <= 1
+        placeholders = @index_page.url_placeholders
+        placeholders['num'] = num_page.to_s
+        url = ::Jekyll::URL.new :placeholders => placeholders, :permalink => paginated_permalink
+        url.to_s
+      end
+    end
+  end
+end

data/lib/jekyll-rss/pagination.rb

@@ -0,0 +1,30 @@
+module Jekyll
+  module RSS
+    class Pagination
+      def self.paginate(site, index_page, posts)
+        total_pages = Paginate::Pager.calculate_pages posts.sort_by(&self.sorter), self.per_page(site)
+        (1..total_pages).each do |page_num|
+          pager = Pager.new site, page_num, posts, total_pages, index_page
+          if page_num > 1
+            subpage = yield pager
+            subpage.data['permalink'] = index_page.data['paginated_permalink'].gsub(':num', page_num.to_s)
+            subpage.pager = pager
+            site.pages << subpage
+          else
+            index_page.pager = pager
+          end
+        end
+      end
+
+      def self.per_page(site)
+        paginate = site.config['rss']['paginate']
+        raise(ArgumentError, "rss.paginate is set to `#{paginate}`. Must be a number, and should be greater than 0") unless paginate.is_a? Integer and paginate > 0
+        return paginate
+      end
+
+      def self.sorter
+        lambda { |post| -post.date.to_f }
+      end
+    end
+  end
+end

data/lib/jekyll-rss/rss_feed.rb

@@ -0,0 +1,18 @@
+module Jekyll
+  module RSS
+    class RSSFeed < Page
+
+      attr_reader :source
+
+      def initialize(site, path)
+        @site = site
+        @base = site.source
+        @source = path
+        @dir = File.dirname(path)
+        basename = File.basename(path)
+        process basename
+        read_yaml File.dirname(path), basename
+      end
+    end
+  end
+end

data/lib/jekyll-rss/rss_templates/blog.xml

@@ -0,0 +1,35 @@
+---
+permalink: /rss/feed.xml
+paginated_permalink: /rss/:num/feed.xml
+---
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:dc="http://purl.org/dc/elements/1.1/">
+    <channel>
+        <title>{{ site.name | xml_escape }}</title>
+        <description>{% if site.description %}{{ site.description | xml_escape }}{% endif %}</description>
+        <link>{{ site.site_url }}</link>
+        <atom:link href="{{ site.site_url }}{{ page.url }}" rel="self" type="application/rss+xml" />
+        {% if paginator.next_page %}
+        <atom:link href="{{ site.site_url }}{{ paginator.next_page_path }}" rel="next" type="application/rss+xml" />
+        {% endif %}
+        {% if paginator.previous_page %}
+        <atom:link href="{{ site.site_url }}{{ paginator.previous_page_path }}" rel="previous" type="application/rss+xml" />
+        {% endif %}
+        {% for post in paginator.posts %}
+        <item>
+            <title>{{ post.title | xml_escape }}</title>
+            {% if post.author.name %}
+            <dc:creator>{{ post.author | xml_escape }}</dc:creator>
+            {% endif %}
+            {% if post.excerpt %}
+            <description>{{ post.excerpt | xml_escape }}</description>
+            {% else %}
+            <description>{{ post.content | xml_escape }}</description>
+            {% endif %}
+            <pubDate>{{ post.date | date: "%a, %d %b %Y %H:%M:%S %z" }}</pubDate>
+            <link>{{ site.site_url }}{{ post.url }}</link>
+            <guid isPermaLink="true">{{ site.site_url }}{{ post.url }}</guid>
+        </item>
+        {% endfor %}
+    </channel>
+</rss>

data/lib/jekyll-rss/rss_templates/category.xml

@@ -0,0 +1,35 @@
+---
+permalink: /rss/:category.xml
+paginated_permalink: /rss/:num/:category.xml
+---
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:dc="http://purl.org/dc/elements/1.1/">
+    <channel>
+        <title>{{ site.name | xml_escape }}</title>
+        <description>{% if site.description %}{{ site.description | xml_escape }}{% endif %}</description>
+        <link>{{ site.site_url }}/{{ page.category }}</link>
+        <atom:link href="{{ site.site_url }}{{ page.url }}" rel="self" type="application/rss+xml" />
+        {% if paginator.next_page %}
+        <atom:link href="{{ site.site_url }}{{ paginator.next_page_path }}" rel="next" type="application/rss+xml" />
+        {% endif %}
+        {% if paginator.previous_page %}
+        <atom:link href="{{ site.site_url }}{{ paginator.previous_page_path }}" rel="previous" type="application/rss+xml" />
+        {% endif %}
+        {% for post in paginator.posts %}
+        <item>
+            <title>{{ post.title | xml_escape }}</title>
+            {% if post.author.name %}
+            <dc:creator>{{ post.author | xml_escape }}</dc:creator>
+            {% endif %}
+            {% if post.excerpt %}
+            <description>{{ post.excerpt | xml_escape }}</description>
+            {% else %}
+            <description>{{ post.content | xml_escape }}</description>
+            {% endif %}
+            <pubDate>{{ post.date | date: "%a, %d %b %Y %H:%M:%S %z" }}</pubDate>
+            <link>{{ site.site_url }}{{ post.url }}</link>
+            <guid isPermaLink="true">{{ site.site_url }}{{ post.url }}</guid>
+        </item>
+        {% endfor %}
+    </channel>
+</rss>

data/lib/jekyll-rss/rss_templates_command.rb

@@ -0,0 +1,42 @@
+module Jekyll
+  module RSS
+    class RSSTemplatesCommand < ::Jekyll::Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:rss_template) do |c|
+            c.syntax 'rss_template [options]'
+            c.description 'Create the template files you need to format your RSS/Atom feeds.'
+            c.option 'blog', '-B', '--blog', 'Generate the blog RSS/Atom feed template'
+            c.option 'category', '-C', '--category', 'Generate the category RSS/Atom feed template'
+
+            c.action do |args, options|
+              process options
+            end
+          end
+        end
+
+        def process(options)
+          config = configuration_from_options(options)
+          %w(blog category).each do |template|
+            create_template(config, template) if config[template]
+          end
+        end
+
+        def create_template(config, template)
+          from = File.expand_path File.join('..', 'rss_templates', "#{template}.xml"), __FILE__
+          dest_dir = File.join File.expand_path(config['source']), '_rss'
+          to = File.join dest_dir, "#{template}.xml"
+
+          FileUtils.mkdir(dest_dir) unless Dir.exists? dest_dir
+
+          if File.exists? to
+              Jekyll.logger.error "#{to} already exists and I refuse to overwrite it, because of reasons."
+          else
+              FileUtils.cp from, to
+              Jekyll.logger.info "#{to} created."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-rss/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module RSS
+    VERSION = "1.0.0alpha"
+  end
+end

data/lib/jekyll-rss.rb

@@ -0,0 +1,12 @@
+require 'jekyll-rss/version'
+require 'jekyll-rss/generator'
+require 'jekyll-rss/rss_feed'
+require 'jekyll-rss/category_feed'
+require 'jekyll-rss/pager'
+require 'jekyll-rss/pagination'
+require 'jekyll-rss/rss_templates_command'
+
+module Jekyll
+  module RSS
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-rss
+version: !ruby/object:Gem::Version
+  version: 1.0.0alpha
+platform: ruby
+authors:
+- Bez Hermoso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll-paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: Generate RSS/Atom feeds for your Jekyll site. You can have a feed for
+  all blog posts and also feeds for each category. Pagination supported.
+email: bezalelhermoso@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/jekyll-rss.rb
+- lib/jekyll-rss/category_feed.rb
+- lib/jekyll-rss/generator.rb
+- lib/jekyll-rss/pager.rb
+- lib/jekyll-rss/pagination.rb
+- lib/jekyll-rss/rss_feed.rb
+- lib/jekyll-rss/rss_templates/blog.xml
+- lib/jekyll-rss/rss_templates/category.xml
+- lib/jekyll-rss/rss_templates_command.rb
+- lib/jekyll-rss/version.rb
+homepage: https://github.com/bezhermoso/jekyll-rss
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: RSS/Atom feeds for Jekyll
+test_files: []