jekyll-paginate-v2 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5815a5929c866dd11ae6f027f4f3d58bbd584f3f
-  data.tar.gz: 7d261bcb4d2089d8f196f0ddc71a7961992bbc5d
+  metadata.gz: 9254e3f2a00c883968a4d9c511541c99a768e9c4
+  data.tar.gz: b65e829454c441a37f427a29642c6a4ee1f17a0c
 SHA512:
-  metadata.gz: c18ad4a94390fd030c278ca84beceffe32643926775ca7596679278658ab7665a19f55fffe76662261f88f1e4d725ab6482f5d2e86ddd0d681ec939f9e1f8c1c
-  data.tar.gz: 823ab882ae1fa5342fd8eca1554b6b921c29abecd585967224c77717edd5e2ab6162b254a6d72fbe791893c3d879cade61d3d611690346285122f48240edd52d
+  metadata.gz: b886d5e8cada5d00c0fb94617bcb12c46ac6237e155eef36763f7dfdb489b4efd4356429f476764a7555169d7a3fd0e44b14d7132df1a345cfb5aad9fcab12b5
+  data.tar.gz: 2073fa3f77170a1a76ec41bb7ed0f64016143ca5a00b30d3b93b06b491922045a41288f0014d2fb9b06e1b0d17c493c48130db8dc5720603d3a9be79e83187fb

data/README.md

@@ -1,21 +1,24 @@
 # Jekyll::Paginate V2
 
-Pagination gem built specially for Jekyll 3 and newer.
-https://rubygems.org/gems/jekyll-paginate-v2
+Pagination gem built specially for Jekyll 3 and newer and is a fully backwards compatable and enhanced replacement for the previously built-in [jekyll-paginate gem](https://github.com/jekyll/jekyll-paginate). View it on [rubygems.org](https://rubygems.org/gems/jekyll-paginate-v2).
 
-Fully backwards compatable and enhanced replacement for the previously built-in [jekyll-paginate gem](https://github.com/jekyll/jekyll-paginate).
+[![Build Status](https://travis-ci.org/sverrirs/jekyll-paginate-v2.svg?branch=master)](https://travis-ci.org/sverrirs/jekyll-paginate-v2) 
+[![Gem Version](https://badge.fury.io/rb/jekyll-paginate-v2.svg)](https://badge.fury.io/rb/jekyll-paginate-v2)
+[![Dependency Status](https://gemnasium.com/badges/github.com/sverrirs/jekyll-paginate-v2.svg)](https://gemnasium.com/github.com/sverrirs/jekyll-paginate-v2)
 
-The code was based on the original design of [jekyll-paginate](https://github.com/jekyll/jekyll-paginate) and features were mostly drawn from discussions from the issues pages (especially [#27](https://github.com/jekyll/jekyll-paginate/issues/27)) and some from the excellent [Octopress::Paginate code](https://github.com/octopress/paginate). 
-
-:heart:
+Reach me at the [project issues](https://github.com/sverrirs/jekyll-paginate-v2/issues) section or via email at [jekyll@sverrirs.com](mailto:jekyll@sverrirs.com).
 
+> The code was based on the original design of [jekyll-paginate](https://github.com/jekyll/jekyll-paginate) and features were sourced discussions such as [#27](https://github.com/jekyll/jekyll-paginate/issues/27) (thanks [Günter Kits](https://github.com/gynter)).
 
 * [Installation](#installation)
-* [Examples](https://github.com/sverrirs/jekyll-paginate-v2/tree/master/examples)
-* [Features](#features)
-* [New site configuration](#site-configuration)
-* [New page configuration](#page-configuration)
+* [Example Sites](https://github.com/sverrirs/jekyll-paginate-v2/tree/master/examples)
+* [Site configuration](#site-configuration)
+* [Page configuration](#page-configuration)
 * [Backwards compatibility](#backwards-compatibility-with-jekyll-paginate)
+* [Paginating collections](#paginating-collections)
+  + [Single collection](#paginating-a-single-collection)
+  + [Multiple collection](#paginating-multiple-collections)
+  + [The special 'all' collection](#the-special-all-collection)
 * [How to paginate categories, tags, locales](#paginate-categories-tags-locales)
   + [Filtering categories](#filtering-categories)
   + [Filtering tags](#filtering-tags)
@@ -33,6 +36,10 @@ The code was based on the original design of [jekyll-paginate](https://github.co
 * [Issues / to-be-completed](#issues--to-be-completed)
 * [How to Contribute](#contributing)
 
+> _"Be excellent to each other"_
+
+:heart:
+
 ## Installation
 
 ```
@@ -45,23 +52,7 @@ Update your [_config.yml](#site-configuration) and [pages](#page-configuration).
 
 Now you're ready to run `jekyll serve` and your paginated files should be generated.
 
-Please see the [Examples](https://github.com/sverrirs/jekyll-paginate-v2/tree/master/examples) for more information on how to configure the pagination logic.
-
-
-## Features
-
-In addition to all the features offered by the older [jekyll-paginate gem](https://github.com/jekyll/jekyll-paginate) this new pagination plugin features include
-
-1. Works with any type of file ending (HTML, Markdown, etc) as long as the file has front-matter and the minimum page level pagination meta (see [page-configuration](#page-configuration)).
-2. Paginated files can have any file name (not just index.html).
-3. Supports category, tag and locale filtering.
-4. Supports any combination of category, tag and locale filtering (e.g. _all posts in the 'ruby' category written for 'en\_US'_ or _all posts in 'car' and 'cycle' category tagged with 'cool' written for 'fr\_FR'_)
-5. Sorting of posts by any field. Decending or Ascending.
-6. Optional limits of number of pagenated pages (e.g. _only produce 15 pages_)
-7. Fully customizable permalink format. E.g `/page:num/` or `/page/:num/` or `/:num/` or really anything you want.
-8. Optional title suffix for paginated pages (e.g. _Index - Page 2_)
-
-All this while being fully backwards compatible with the old [jekyll-paginate](https://github.com/jekyll/jekyll-paginate) gem.
+Please see the [Examples](https://github.com/sverrirs/jekyll-paginate-v2/tree/master/examples) for tips and tricks on how to configure the pagination logic.
 
 ## Site configuration
 
@@ -76,6 +67,9 @@ pagination:
   # Site-wide kill switch, disabled here it doesn't run at all 
   enabled: true
 
+  # Set to 'true' to enable pagination debugging. This can be enabled in the site config or only for individual pagination pages
+  debug: false
+
   # The default document collection to paginate if nothing is specified ('posts' is default)
   collection: 'posts'
 
@@ -85,8 +79,8 @@ pagination:
   # The permalink structure for the paginated pages (this can be any level deep)
   permalink: '/page/:num/'
 
-  # Optional additional suffix for the title of the paginated pages (the prefix is inherited from the original page)
-  title_suffix: ' - page :num'
+  # Optional the title format for the paginated pages (supports :title for original page title, :num for pagination page number)
+  title: ':title - page :num'
 
   # Limit how many pagenated pages to create (default: 0, means all)
   limit: 0
@@ -97,15 +91,15 @@ pagination:
   # Optional, sorts the posts in reverse order (omit to default decending or sort_reverse: true)
   sort_reverse: true
 
-  # The default category to use, just leave this as 'posts' to get a backwards-compatible behavior (all posts)
+  # Optional, the default category to use, omit or just leave this as 'posts' to get a backwards-compatible behavior (all posts)
   category: 'posts'
 
   # Optional, the default tag to use, omit to disable
-  tag: 'cool'
+  tag: ''
 
   # Optional, the default locale to use, omit to disable (depends on a field 'locale' to be specified in the posts, 
   # in reality this can be any value, suggested are the Microsoft locale-codes (e.g. en_US, en_GB) or simply the ISO-639 language code )
-  locale: 'en_US' 
+  locale: '' 
 
 ############################################################
 ```
@@ -161,7 +155,7 @@ The code is fully backwards compatible and you will have access to all the norma
 
 Neat!
 
-Please see the [Examples](https://github.com/sverrirs/jekyll-paginate-v2/tree/master/examples) for more detailed information and working site configurations.
+Don't delay, go see the [Examples](https://github.com/sverrirs/jekyll-paginate-v2/tree/master/examples), they're way more useful than read-me docs at this point :)
 
 ## Backwards compatibility with jekyll-paginate
 This gem is fully backwards compatible with the old [jekyll-paginate](https://github.com/jekyll/jekyll-paginate) gem and can be used as a zero-configuration replacement for it. If the old site config is detected then the gem will fall back to the old logic of pagination. 
@@ -359,7 +353,7 @@ author:
 ---
 ```
 
-You can define pagination sorting on the nested `last` field like so
+You can define pagination sorting on the nested `first` field like so
 
 ``` yml
 ---
@@ -417,15 +411,18 @@ end
 
 > bundler/spec_set.rb:95:in `block in materialize': Could not find jekyll-paginate-v2-1.0.0 in any of the sources (Bundler::GemNotFound)
 
-When running `jekyll serve` if you ever get an error similar to the one above the solution is to delete your `Gemfile.lock` file and try again.
+Delete your `Gemfile.lock` file and try again.
 
 ### My pagination pages are not being found (Couldn't find any pagination page. Skipping pagination)
 
 > Pagination: Is enabled, but I couldn't find any pagination page. Skipping pagination...
 
-Pagination only works inside **pages** they are not supported in the liquid templates. Those are the files that live in the folders prefixed by the underscore (i.e. files under `_layouts/`, `_includes/`, `_posts/` etc ). 
-
-Create a normal page with a `layout:page` in it's front-matter and place the pagination logic there.
+* Ensure that you have the correct minimum front-matter in the pagination pages
+``` yml
+pagination:
+  enabled: true
+```
+* You can place pagination logic into either the pages or liquid templates (templates are stored under the `_layouts/` and `_includes/` folders).
 
 ### My pages are being nested multiple levels deep
 
@@ -449,15 +446,16 @@ pagination:
 Make absolutely sure that your pagination permalink paths do not clash with any other paths in your final site. For simplicity it is recommended that you keep all custom pagination (non root index.html) in a single or multiple separate sub folders under your site root.
 
 ## Issues / to-be-completed
-* Incomplete unit-tests 
-* No integration tests [#2](https://github.com/jekyll/jekyll-paginate/pull/2)
+* A few missing unit-tests 
+* No integration tests yet [#2](https://github.com/jekyll/jekyll-paginate/pull/2)
 * _Exclude_ filter not implemented [#6](https://github.com/jekyll/jekyll-paginate/issues/6)
-* Pagination for [Collections](http://ben.balter.com/2015/02/20/jekyll-collections/) not implemented yet
-* Feature being considered is to auto-generate category/tag/language pagination pages. Project still requires programmer to specify the pages him/herself.
+* Considering adding a feature to auto-generate collection/category/tag/locale pagination pages. In cases where projects have hundreds of tags creating the pages by hand is not a feasible option.
 
 ## Contributing
 
-I currently need testers and people willing to give me feedback and code reviews.
+I currently really need testers for the gem and people willing to give me feedback and code reviews. 
+
+If you don't want to open issues here on Github, you can also send me your feedback by email at [jekyll@sverrirs.com](mailto:jekyll@sverrirs.com).
 
 1. Fork it ( https://github.com/sverrirs/jekyll-paginate-v2/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/Rakefile

@@ -8,8 +8,8 @@ Rake::TestTask.new do |t|
   t.libs.push 'lib'
   t.libs.push 'specs'
   t.verbose = true
-  t.pattern = "spec/*_spec.rb"
-  t.test_files = FileList['spec/*_spec.rb']
+  t.pattern = "spec/**/*_spec.rb"
+  t.test_files = FileList['spec/**/*_spec.rb']
 end
 
 desc "Run tests"

data/jekyll-paginate-v2.gemspec

@@ -16,7 +16,8 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Pagination Generator for Jekyll 3}
   spec.description   = %q{An enhanced zero-configuration in-place replacement for the now decomissioned built-in jekyll-paginate gem. This pagination gem offers full backwards compatability as well as a slew of new frequently requested features with minimal additional site and page configuration.}
   
-  spec.files         = `git ls-files -z`.split("\x0")
+  #spec.files         = `git ls-files -z`.split("\x0")
+  spec.files          = Dir['CODE_OF_CONDUCT.md', 'README.md', 'LICENSE', 'Rakefile', '*.gemspec', 'Gemfile', 'lib/**/*', 'spec/**/*']
   #spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
@@ -24,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "jekyll", ">= 3.0"
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", '~> 5.4', '>= 5.4.3'
 end

data/lib/jekyll-paginate-v2.rb

@@ -1,4 +1,4 @@
-# Jekyll::Paginate V2 is a gem built for Jekyll 3 that generates pagiatation for posts, categories and tags.
+# Jekyll::Paginate V2 is a gem built for Jekyll 3 that generates pagiatation for posts, collections, categories and tags.
 # 
 # It is based on https://github.com/jekyll/jekyll-paginate, the original Jekyll paginator
 # which was decommissioned in Jekyll 3 release onwards. This code is currently not officially
@@ -10,13 +10,17 @@
 #   - https://opensource.org/licenses/MIT
 
 require "jekyll-paginate-v2/version"
-require "jekyll-paginate-v2/defaults"
-require "jekyll-paginate-v2/compatibilityUtils"
-require "jekyll-paginate-v2/utils"
-require "jekyll-paginate-v2/paginator"
-require "jekyll-paginate-v2/paginationPage"
-require "jekyll-paginate-v2/paginationModel"
-require "jekyll-paginate-v2/paginationGenerator"
+# Files needed for the pagination generator
+require "jekyll-paginate-v2/generator/defaults"
+require "jekyll-paginate-v2/generator/compatibilityUtils"
+require "jekyll-paginate-v2/generator/utils"
+require "jekyll-paginate-v2/generator/paginationIndexer"
+require "jekyll-paginate-v2/generator/paginator"
+require "jekyll-paginate-v2/generator/paginationPage"
+require "jekyll-paginate-v2/generator/paginationModel"
+require "jekyll-paginate-v2/generator/paginationGenerator"
+# Files needed for the auto category and tag pages
+
 
 module Jekyll 
   module PaginateV2

data/lib/jekyll-paginate-v2/autopages/autoTagPages.rb

@@ -0,0 +1,66 @@
+#module Jekyll
+#  module PaginateV2::AutoPages
+#
+#    #
+#    # This code is adapted from Stephen Crosby's code https://github.com/stevecrozz
+#    Jekyll::Hooks.register :site, :post_read do |site|
+#
+#      # Get the configuration for the auto pages
+#      default_config = DEFAULT.merge(site.config['autopages'] || {})
+#
+#      # If disabled then don't do anything
+#      if !default_config['enabled'] || !default_config['tags']
+#        Jekyll.logger.debug "AutoPages:","Disabled/Not configured in site.config."
+#        return
+#      end
+#
+#      # TODO: Should I detect here and disable if we're running the legacy paginate code???!
+#
+#      # Roll through all documents in the posts collection and extract the tags
+#      # construct the paginated tag page for each
+#      site.posts.docs.map { |p| p.data['tags'] }.reduce(&:|).each do |tag|
+#        site.pages << PaginatedTagPage.new(site, site.source, '', tag, default_config['tags'])
+#      end
+#    end
+#
+#    class PaginatedTagPage < Jekyll::Page
+#      def initialize(site, base, dir, tag, tags_config)
+#        @site = site
+#        @base = base
+#        @dir = dir
+#        @name = 'index.html'
+#        @ext = '.html'
+#        @url = Utils.format_tag_macro(tags_config['permalink'], tag)
+#
+#        self.read_yaml(File.join(base, '_layouts'), tags_config['layout'])
+#        self.data['layout'] = File.basename(tags_config['layout'], File.extname(tags_config['layout']))
+#        self.data['title'] = Utils.format_tag_macro(tags_config['title'], tag)
+#        self.data['pagination'] = {
+#          'enabled' => true,
+#          'collection' => 'posts',
+#          'sort_field' => 'date',
+#          'sort_reverse' => true,
+#          'tag' => tag
+#        }
+#
+#        'enabled'      => false,
+#      'collection'   => 'posts',
+#      'per_page'     => 10,
+#      'permalink'    => '/page:num/', # Supports :num as customizable elements
+#      'title_suffix' => ' - page :num', # Supports :num as customizable elements
+#      'page_num'     => 1,
+#      'sort_reverse' => false,
+#      'sort_field'   => 'date',
+#      'limit'        => 0, # Limit how many content objects to paginate (default: 0, means all)
+#
+#        self.process(@name)
+#
+#        data.default_proc = proc do |_, key|
+#          site.frontmatter_defaults.find(File.join(dir, name), type, key)
+#        end
+#
+#        Jekyll::Hooks.trigger :pages, :post_init, self
+#      end
+#    end
+#  end # module PaginateV2
+#end # module Jekyll

data/lib/jekyll-paginate-v2/autopages/defaults.rb

@@ -0,0 +1,26 @@
+module Jekyll
+  module PaginateV2::AutoPages
+
+    # Construct an extended version of the pagination config for the tag pages
+    tagDefaults = Jekyll::PaginateV2::Generator::DEFAULT.merge({
+      'layout'        => 'autopage_tags.html',
+      'title'         => 'Posts tagged with :tag',
+      'permalink'     => '/tags/:tag'
+    })
+
+    # Extend the pagination config for the categories as well
+    catDefaults = Jekyll::PaginateV2::Generator::DEFAULT.merge({
+      'layout'        => 'autopage_category.html',
+      'title'         => 'Posts in category :cat',
+      'permalink'     => '/category/:cat'
+    })
+
+    # The default configuration for the AutoPages
+    DEFAULT = {
+      'enabled' => false,
+      'tags'    => tagDefaults,
+      'category'=> catDefaults 
+    }
+
+  end # module PaginateV2
+end # module Jekyll

data/lib/jekyll-paginate-v2/autopages/utils.rb

@@ -0,0 +1,21 @@
+module Jekyll
+  module PaginateV2::AutoPages
+
+    class Utils
+
+      # Static: returns a fully formatted string with the tag macro (:tag) replaced
+      #
+      def self.format_tag_macro(toFormat, tag)
+        return toFormat.sub(':tag', Jekyll::Utils.slugify(tag.to_s)
+      end #function format_tag_macro
+
+      # Static: returns a fully formatted string with the category macro (:cat) replaced
+      #
+      def self.format_cat_macro(toFormat, category)
+        return toFormat.sub(':cat', Jekyll::Utils.slugify(category.to_s))
+      end #function format_tag_macro
+
+    end # class Utils
+
+  end # module PaginateV2
+end # module Jekyll

data/lib/jekyll-paginate-v2/{compatibilityUtils.rb → generator/compatibilityUtils.rb}

@@ -1,5 +1,5 @@
 module Jekyll 
-  module PaginateV2
+  module PaginateV2::Generator
 
     #
     # Static utility functions that provide backwards compatibility with the old 
@@ -7,6 +7,8 @@ module Jekyll
     # that sites still running the old gem work without problems
     # (REMOVE AFTER 2018-01-01)
     #
+    # THIS CLASS IS ADAPTED FROM THE ORIGINAL IMPLEMENTATION AND WILL BE REMOVED, THERE ARE DELIBERATELY NO TESTS FOR THIS CLASS
+    #
     class CompatibilityUtils
 
       # Public: Find the Jekyll::Page which will act as the pager template
@@ -48,7 +50,7 @@ module Jekyll
       # directories, e.g.: page2/index.html, page3/index.html, etc and adds more
       # site-wide data.
       #
-      def self.paginate(legacy_config, all_posts, page, page_create_lambda, logging_lambda )
+      def self.paginate(legacy_config, all_posts, page, page_create_lambda )
         pages = Utils.calculate_number_of_pages(all_posts, legacy_config['per_page'].to_i)
         (1..pages).each do |num_page|
           pager = Paginator.new( legacy_config['per_page'], legacy_config['permalink'], all_posts, num_page, pages, page.url, page.path )

data/lib/jekyll-paginate-v2/{defaults.rb → generator/defaults.rb}

@@ -1,5 +1,5 @@
 module Jekyll
-  module PaginateV2
+  module PaginateV2::Generator
 
     # The default configuration for the Paginator
     DEFAULT = {
@@ -7,11 +7,12 @@ module Jekyll
       'collection'   => 'posts',
       'per_page'     => 10,
       'permalink'    => '/page:num/', # Supports :num as customizable elements
-      'title_suffix' => ' - page :num', # Supports :num as customizable elements
+      'title'        => ':title - page :num', # Supports :num as customizable elements
       'page_num'     => 1,
       'sort_reverse' => false,
       'sort_field'   => 'date',
       'limit'        => 0, # Limit how many content objects to paginate (default: 0, means all)
+      'debug'        => false, # Turns on debug output for the gem
       'legacy'       => false # Internal value, do not use (will be removed after 2018-01-01)
     }
 

data/lib/jekyll-paginate-v2/{paginationGenerator.rb → generator/paginationGenerator.rb}

@@ -1,5 +1,5 @@
 module Jekyll
-  module PaginateV2
+  module PaginateV2::Generator
   
     #
     # The main entry point into the generator, called by Jekyll
@@ -48,7 +48,12 @@ module Jekyll
           Jekyll.logger.info "Pagination:","Disabled in site.config."
           return
         end
-        
+
+        # Handle deprecation of settings and features
+        if( !default_config['title_suffix' ].nil? )
+          Jekyll.logger.warn "Pagination:", "The 'title_suffix' configuration has been deprecated. Please use 'title'. See https://github.com/sverrirs/jekyll-paginate-v2#site-configuration"
+        end
+
         Jekyll.logger.debug "Pagination:","Starting"
 
         ################ 0 #################### 
@@ -108,24 +113,24 @@ module Jekyll
         # Decoupling Jekyll specific logging
         logging_lambda = lambda do | message, type="info" |
           if type == 'debug'
-            Jekyll.logger.debug "Pagination:", message
+            Jekyll.logger.debug "Pagination:","#{message}"
           elsif type == 'error'
-            Jekyll.logger.error "Pagination:", message
+            Jekyll.logger.error "Pagination:", "#{message}"
           elsif type == 'warn'
-            Jekyll.logger.warn "Pagination:", message
+            Jekyll.logger.warn "Pagination:", "#{message}"
           else
-            Jekyll.logger.info "Pagination:", message
+            Jekyll.logger.info "Pagination:", "#{message}"
           end
         end
 
         ################ 4 ####################
         # Now create and call the model with the real-life page creation proc and site data
-        model = PaginationModel.new()
+        model = PaginationModel.new(logging_lambda, page_create_lambda, page_remove_lambda, collection_by_name_lambda)
         if( default_config['legacy'] ) #(REMOVE AFTER 2018-01-01)
           all_posts = site.site_payload['site']['posts'].reject { |post| post['hidden'] }
-          model.run_compatability(default_config, all_pages, site_title, all_posts, page_create_lambda, logging_lambda) #(REMOVE AFTER 2018-01-01)
+          model.run_compatability(default_config, all_pages, site_title, all_posts) #(REMOVE AFTER 2018-01-01)
         else
-          model.run(default_config, all_pages, site_title, page_create_lambda, logging_lambda, page_remove_lambda, collection_by_name_lambda)
+          model.run(default_config, all_pages, site_title)
         end
 
       end