jekyll-itafroma-archive 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a0da89c7937de816b364c4f19166ef69930616e
-  data.tar.gz: 13df6c1b58667e2a6a402b87ed28b98bb3e40b14
+  metadata.gz: 80c55e7cff0aca89064cc7d9da5c9c43deb346bb
+  data.tar.gz: 58160aa10a21f01d43611d5768c651999d1829f3
 SHA512:
-  metadata.gz: 8081c7ab8333a9db05d617b4cd20ef17d2b6774da1c65b2fb6c215b9990a0ffeb869d18a45eb242f0b141c53a68cd9e685313c70634bc2c7d94356ef40a4c927
-  data.tar.gz: d3c73c4c9b353043a2a6348aca81c446749fa0ad35c9a769a5b774c2903611e61a75acb1e10a6f05208cc231f0b9aac304db576fae92ac3a84f938a49cc788eb
+  metadata.gz: cf02a340506e699b16f41034b6a00d7a3dad51c762bd97df86abaa0754c79e8314b3c3e59815c0fa1346b0a91b6e8a8adf5edba84b00006bff0d8fff5adf38c6
+  data.tar.gz: 683a3360166b583128226564d92b1055d80812579fa10201158843e59d011e7e5d096308fef15ff25beaab14ae4fef1a8765ccb077d8b89c74fc294ea928dabe

data/lib/jekyll/itafroma/archive.rb

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

data/lib/jekyll/itafroma/archive_generator.rb

@@ -5,7 +5,7 @@
 # contains a post.
 #
 # Author:: Mark Trapp
-# Copyright: Copyright (c) 2013-2014 Mark Trapp
+# Copyright: Copyright (c) 2013-2015 Mark Trapp
 # License:: MIT
 
 module Jekyll
@@ -15,21 +15,51 @@ module Jekyll
       # This generator is safe from arbitrary code execution.
       safe true
 
+      DEFAULT_LAYOUT = 'archive'
+      DEFAULT_PATH = '/'
+      DEFAULT_TITLE = 'Blog archive'
+      DEFAULT_INCLUSIONS = {}
+      DEFAULT_EXCLUSIONS = {}
+
       # Generate archive pages.
       #
       # site - The site.
       #
       # Returns nothing.
       def generate(site)
-        layout = site.config['archive']['layout'] || 'archive'
-        if site.layouts.key? layout
-          exclude_categories = site.config['archive']['exclude'] || []
-          posts = site.posts.select do |post|
-            (post.categories & exclude_categories).empty?
+        archives = site.config['archive'] || []
+
+        if archives.is_a? Hash
+          warn 'The configuration format used for Jekyll Archive Generator is deprecated. Please see README for the new format.'
+          archives = [archives]
+        end
+
+        archives.each do |archive|
+          layout = archive['layout'] || DEFAULT_LAYOUT
+          if site.layouts.key? layout
+            path = archive['path'] || DEFAULT_PATH
+            title = archive['title'] || DEFAULT_TITLE
+
+            inclusions = archive['include'] || DEFAULT_INCLUSIONS
+            posts = if inclusions.empty? 
+              site.posts
+            else 
+              site.posts.select do |post|
+                inclusions.any? do |key, inclusion|
+                  (post[key] & inclusion).any?
+                end
+              end
+            end
+
+            exclusions = archive['exclude'] || DEFAULT_EXCLUSIONS
+            exclusions.each do |key, exclusion|
+              posts.reject! do |post|
+                (post[key] & exclusion).any?
+              end
+            end
+
+            site.pages += generate_archive_pages(site, posts, layout, path, title)
           end
-          site.pages += generate_archive_pages(site, posts, '%Y/%m/%d')
-          site.pages += generate_archive_pages(site, posts, '%Y/%m')
-          site.pages += generate_archive_pages(site, posts, '%Y')
         end
       end
 
@@ -39,20 +69,19 @@ module Jekyll
       #
       # site    - The site.
       # posts   - The Posts to include in the archive.
-      # pattern - The date pattern to collate the archive on
+      # layout  - The layout to use for the archive page
+      # path    - The path to use for the archive page
+      # title   - The tokenized title to use for the archive page
       #
       # Returns an Array of archive Pages.
-      def generate_archive_pages(site, posts, pattern)
+      def generate_archive_pages(site, posts, layout, path, title)
         pages = []
 
-        collate(posts, pattern).each do |_, collated_posts|
-          pages << ArchivePage.new(site, site.source, pattern, collated_posts)
+        collate(posts, path).each do |_, collated_posts|
+          pages << ArchivePage.new(site, site.source, layout, path, title, collated_posts)
         end
 
         pages.each_with_index do |page, index|
-          # Deprecated: will be removed in 0.4.0 or later
-          page.pager = ArchivePager.new(site, index + 1, pages, pages.size)
-
           page.data['archive'].merge!({'paginator' => ArchivePager.new(site, index + 1, pages, pages.size)})
         end
 
@@ -62,13 +91,13 @@ module Jekyll
       # Collate an Array of Posts by a date pattern.
       #
       # posts - The Posts to collate
-      # pattern - The date pattern to collate the Posts on
+      # path - The path slug to collate the Posts on
       #
       # Returns a collated Hash of Posts.
-      def collate(posts, pattern)
+      def collate(posts, path)
         collated = {}
         posts.each do |post|
-          key = post.date.strftime(pattern)
+          key = ArchiveSubstitution.new(post).translate(path)
           collated[key] ||= []
           collated[key] << post
         end

data/lib/jekyll/itafroma/archive_page.rb

@@ -2,7 +2,7 @@
 # An archive listing page.
 #
 # Author:: Mark Trapp
-# Copyright: Copyright (c) 2013-2014 Mark Trapp
+# Copyright: Copyright (c) 2013-2015 Mark Trapp
 # License:: MIT
 # Acknowledgements:: Inspired by the work done by nlindley and ilkka on Github:
 #     https://gist.github.com/nlindley/6409459
@@ -18,52 +18,50 @@ module Jekyll
       #
       # site         - The site.
       # base         - The path to the site's root
+      # layout       - The layout to use for the archive page
+      # path         - The path to use for the archive page
+      # title        - The tokenized title to use for the archive page
       # 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)
+      def initialize(site, base, layout, path, title, posts)
         @site = site
-        @config = site.config['archive']
         @posts = posts
 
-        @date_pattern = date_pattern
+        @layout = layout
+        @path = path
+        @title = title
         @base = base
         @dir = dir
         @name = 'index.html'
 
         process(@name)
 
-        layout = @config['layout'] || 'archive'
-        read_yaml(File.join(base, '_layouts'), "#{layout}.html")
+        read_yaml(File.join(base, '_layouts'), "#{@layout}.html")
 
         populate_data!
       end
 
       # 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`.
+      # The date of the first post is used for the start date.
       #
       # 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)
+        @posts.first.date
       end
 
       # Generate the ArchivePage title.
       #
       # Returns a String containing the ArchivePage title.
       def title
-        tokenized_title = @config['title'] || 'Blog archive - :date'
-        tokenized_title.gsub(':date', date.strftime(@date_pattern))
+        ArchiveSubstitution.new(@posts.first).translate(@title)
       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')
+        File.join(ArchiveSubstitution.new(@posts.first).url(@path).to_s, 'index.html')
       end
 
       # Add the ArchivePage-specific data to the regular Page data.
@@ -73,7 +71,6 @@ module Jekyll
         data.merge!('date' => date,
                     'title' => title,
                     'archive' => {
-                      'date_pattern' => @date_pattern,
                       'posts' => @posts
                     })
       end

metadata

@@ -1,16 +1,40 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-itafroma-archive
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mark Trapp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-07 00:00:00.000000000 Z
-dependencies: []
-description: Jekyll plugin to create a set of archive pages.
+date: 2015-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: |2
+      Jekyll Archive Generator creates a set of archive pages for a Jekyll
+      website.
+
+      Oddly, Jekyll doesn't include a date-based archive for posts out of the box.
+      For example, if you have a permalink structure like `blog/2014/01/01/title,
+      URL hacking won't work because going to `blog/2014` will return 404 Page Not
+      Found.
+
+      Jekyll Archive Generator fixes that by generating all the necessary archive
+      pages for each part your blog URL structure.
 email: mark@marktrapp.com
 executables: []
 extensions: []
@@ -32,7 +56,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="