jekyll-itafroma-archive 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9db9109c4075f3d01236e4c785e8bfadf4bbd81
-  data.tar.gz: 017053e6f01893e37526e1f809945720bc40eb7f
+  metadata.gz: ab0d1eafe7e7202e6ade0f08785acff15d18817b
+  data.tar.gz: 924cacc3a7c34d321a0aa5b5f86f54bda6c76132
 SHA512:
-  metadata.gz: bc839479f6b3d44222df6dd346a11ec97037ba81df96597abe9fed85712dfaa2dc65ae641cca520e6e621a8e79f57be24382cd9a6de25106be93f6b461b60032
-  data.tar.gz: c4537df2b5c1b40c4316afd0c9c20a7f7dfdf01bc7ce6c877c096dab104d72094e47dd346787ba4a0fd0459bf1676320f8e536da19fa83036e8120ea14b3db62
+  metadata.gz: 55ac6cf9979f3041f4689cdd8ad16fb751758be7616de616de40c71e0010560b8af9799542ec9a081d199df4ef3b7f4a297454b4b18663e5ac824a5c01734e31
+  data.tar.gz: 05c833f81b8cfe010fc198e2a1220ba0e11a3876467b3b1cacae093b592dcab25e56472bc6b9dd9880da5e8d2843b7dcec144fa90218cba1d4d975f68f45914d

data/lib/jekyll/itafroma/archive.rb

@@ -1,2 +1,3 @@
 require 'jekyll/itafroma/archive_generator'
 require 'jekyll/itafroma/archive_page'
+require 'jekyll/itafroma/archive_pager'

data/lib/jekyll/itafroma/archive_generator.rb

@@ -10,9 +10,16 @@
 
 module Jekyll
   module Itafroma
+    # Generator for archive listings.
     class ArchiveGenerator < Generator
+      # This generator is safe from arbitrary code execution.
       safe true
 
+      # Generate archive pages.
+      #
+      # site - The site.
+      #
+      # Returns nothing.
       def generate(site)
         layout = site.config['archive']['layout'] || 'archive'
         if site.layouts.key? layout
@@ -28,14 +35,33 @@ module Jekyll
 
       private
 
+      # Generate an archive page group.
+      #
+      # site    - The site.
+      # posts   - The Posts to include in the archive.
+      # pattern - The date pattern to collate the archive on
+      #
+      # Returns an Array of archive Pages.
       def generate_archive_pages(site, posts, pattern)
         pages = []
+
         collate(posts, pattern).each do |_, collated_posts|
           pages << ArchivePage.new(site, site.source, pattern, collated_posts)
         end
+
+        pages.each_with_index do |page, index|
+          page.pager = ArchivePager.new(site, index + 1, pages, pages.size)
+        end
+
         pages
       end
 
+      # Collate an Array of Posts by a date pattern.
+      #
+      # posts - The Posts to collate
+      # pattern - The date pattern to collate the Posts on
+      #
+      # Returns a collated Hash of Posts.
       def collate(posts, pattern)
         collated = {}
         posts.each do |post|

data/lib/jekyll/itafroma/archive_page.rb

@@ -12,44 +12,70 @@
 
 module Jekyll
   module Itafroma
-    ##
     # Represents an archive listing page.
-
     class ArchivePage < Page
-      def initialize(site, base, pattern, posts)
+      # Initalize a new ArchivePage.
+      #
+      # site         - The site.
+      # base         - The path to the site's root
+      # date_pattern - The pattern of the date the posts are collated on
+      # posts        - The posts to be added to the ArchivePage.
+      def initialize(site, base, date_pattern, posts)
         @site = site
+        @config = site.config['archive']
+        @posts = posts
+
+        @date_pattern = date_pattern
         @base = base
-        @dir = posts.first.date.strftime(pattern)
+        @dir = dir
         @name = 'index.html'
-        @config = site.config['archive']
 
         process(@name)
 
         layout = @config['layout'] || 'archive'
         read_yaml(File.join(base, '_layouts'), "#{layout}.html")
 
-        data['posts'] = posts
-        data['date'] = {
-          'value' => posts.first.date,
-          'pattern' => pattern,
-        }
-        data['title'] = title
+        populate_data!
       end
 
-      def url
-        base = site.config['archive']['path'] || '/'
-        File.join(base, @dir, 'index.html')
+      # Generate the start date of the archive.
+      #
+      # To determine the archive's start date, the date of the first post is
+      # converted to a string using `@date_pattern`. Doing this will clear any
+      # precision beyond what's specified in `@date_pattern`.
+      #
+      # Returns a DateTime containing the archive's start date.
+      def date
+        date_string = @posts.first.date.strftime(@date_pattern)
+        DateTime.strptime(date_string, @date_pattern)
       end
 
+      # Generate the ArchivePage title.
+      #
+      # Returns a String containing the ArchivePage title.
       def title
         tokenized_title = @config['title'] || 'Blog archive - :date'
-        date = data['date']['value']
-        pattern = data['date']['pattern']
-        tokenized_title.gsub(':date', date.strftime(pattern))
+        tokenized_title.gsub(':date', date.strftime(@date_pattern))
+      end
+
+      # Generate the ArchivePage url.
+      #
+      # Returns a String containing the ArchivePage url.
+      def url
+        base = @config['path'] || '/'
+        File.join(base, date.strftime(@date_pattern), 'index.html')
       end
 
-      def to_liquid
-        data.deep_merge('url' => url, 'content' => content)
+      # Add the ArchivePage-specific data to the regular Page data.
+      #
+      # Returns nothing.
+      def populate_data!
+        data.merge!('date' => date,
+                    'title' => title,
+                    'archive' => {
+                      'date_pattern' => @date_pattern,
+                      'posts' => @posts
+                    })
       end
     end
   end

data/lib/jekyll/itafroma/archive_pager.rb

@@ -0,0 +1,43 @@
+#
+# An archive listing pager.
+#
+# Author:: Mark Trapp
+# Copyright: Copyright (c) 2013 Mark Trapp
+# License:: MIT
+# Acknowledgements:: Inspired by the work done by nlindley and ilkka on Github:
+#     https://gist.github.com/nlindley/6409459
+#     https://gist.github.com/nlindley/6409441
+#     https://gist.github.com/ilkka/707020
+#     https://gist.github.com/ilkka/707909
+module Jekyll
+  module Itafroma
+    # Represents the pager used for ArchivePages.
+    class ArchivePager < Pager
+      # Static: Return the pagination path of the archive page
+      #
+      # posts     - The Array of the archive's Posts.
+      # num_page  - the pagination page number
+      #
+      # Returns the pagination path as a string
+      def self.paginate_archive_path(posts, num_page)
+        return posts.first.url if num_page.nil?
+        return nil if num_page < 1
+        return nil if num_page > posts.size
+        posts[num_page - 1].url
+      end
+
+      # Initialize a new Archive Pager.
+      #
+      # site      - the Jekyll::Site object
+      # page      - The Integer page number.
+      # all_posts - The Array of the archive's Posts.
+      # num_pages - The Integer number of pages or nil if you'd like the number
+      #             of pages calculated.
+      def initialize(site, page, all_posts, num_pages = nil)
+        super
+        @previous_page_path = ArchivePager.paginate_archive_path(all_posts, @previous_page)
+        @next_page_path = ArchivePager.paginate_archive_path(all_posts, @next_page)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-itafroma-archive
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Mark Trapp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-05 00:00:00.000000000 Z
+date: 2014-02-14 00:00:00.000000000 Z
 dependencies: []
 description: Jekyll plugin to create a set of archive pages.
 email: mark@marktrapp.com
@@ -19,6 +19,7 @@ files:
 - lib/jekyll/itafroma/archive.rb
 - lib/jekyll/itafroma/archive_generator.rb
 - lib/jekyll/itafroma/archive_page.rb
+- lib/jekyll/itafroma/archive_pager.rb
 homepage: http://marktrapp.com/projects/jekyll-archive
 licenses:
 - MIT