jekyll-paginate-v2 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80775a1edd643521212d16cdaab6e1c983a0e7dd
-  data.tar.gz: 2fde95bfee813f020993d8076e8ba95897a07017
+  metadata.gz: 80659d18067d2e6e70c308778083386e55baa867
+  data.tar.gz: 24d4018f4b1df421583e0412079e6fd71cb6ab9d
 SHA512:
-  metadata.gz: 054388632b1064bda7bdb101ef988cb4b3abb28203f674fcf3e69e930c67fab6783fe3c1ce0d672bbd344489095797e119b74517a2039eeb6a12a4fb6c022f61
-  data.tar.gz: 2970a984f3ef365a0ad3ff329793a6ea45a7d1a845e0ed8068e3c4db0f4bf049fe85c725da720f26f79f613ee5fecdd021a3e12c3186dd9c2e9d2bba85308499
+  metadata.gz: 8a49c16c2a1e5e450e39a169362a4702ec769160338a9ad081ad0e3a84a4c118117e3ea6039debdd16f05d2d3de35b7837558bf967ac06b5a62f5ecbf065a849
+  data.tar.gz: f34d20de449ce50b39f7c6015425f0f9f8b4ee52d7e04b9faaf5961470b90e6c2e4c0e6fc486714b7c11d29e20394c09c6d25e9c6e690cac14a5186938801594

data/README.md

@@ -38,6 +38,15 @@ In addition to all the features offered by the older [jekyll-paginate gem](https
 
 All this while being fully backwards compatible with the old [jekyll-paginate](https://github.com/jekyll/jekyll-paginate) gem (requires minimal additional front-matter, see [page-configuration](#page-configuration)).
 
+## Issues / to-be-completed
+* Not fully compatible with the old jekyll-paginate plugin configuration yet.
+* Incomplete unit-tests 
+* Missing integration tests [#2](https://github.com/jekyll/jekyll-paginate/pull/2)
+* Missing more detailed examples
+* Code is still too tightly coupled with `site` [#26](https://github.com/jekyll/jekyll-paginate/issues/26)
+* Unable to paginate _pages_ (still under consideration)
+* Unable to auto-generate category/tag/language pagination pages. Still requires programmer to specify the pages him/herself.
+* _Exclude_ filter not implemented [#6](https://github.com/jekyll/jekyll-paginate/issues/6) 
 
 ## Contributing
 
@@ -45,11 +54,12 @@ I currently need testers and people willing to give me feedback and code reviews
 
 1. Fork it ( https://github.com/sverrirs/jekyll-paginate-v2/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Build the gem locally (`gem build jekyll-paginate-v2.gemspec`)
-5. Test and verify the gem locally (`gem install ./jekyll-paginate-v2-x.x.x.gem`) 
-6. Push to the branch (`git push origin my-new-feature`)
-7. Create new Pull Request
+3. Run the unit tests (`rake`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Build the gem locally (`gem build jekyll-paginate-v2.gemspec`)
+6. Test and verify the gem locally (`gem install ./jekyll-paginate-v2-x.x.x.gem`) 
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create new Pull Request
 
 Note: This project uses [semantic versioning](http://semver.org/).
 
@@ -136,6 +146,8 @@ And to display pagination links, simply
 {% endif %}
 ```
 
+> All posts that have the `hidden: true` in their front matter are ignored by the pagination logic.
+
 The code is fully backwards compatible and you will have access to all the normal paginator variables defined in the [official jekyll documentation](https://jekyllrb.com/docs/pagination/#liquid-attributes-available). 
 
 Neat!
@@ -241,4 +253,12 @@ pagination:
   category: ruby
   sort_field: 'title'
   sort_reverse: false
-```
+```
+
+## Common issues
+
+#### I'm getting a bundler error after upgrading the gem (Bundler::GemNotFound)
+
+> 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.

data/lib/jekyll-paginate-v2.rb

@@ -13,7 +13,8 @@ require "jekyll-paginate-v2/version"
 require "jekyll-paginate-v2/defaults"
 require "jekyll-paginate-v2/utils"
 require "jekyll-paginate-v2/paginator"
-require "jekyll-paginate-v2/pagination"
+require "jekyll-paginate-v2/paginationModel"
+require "jekyll-paginate-v2/paginationGenerator"
 
 module Jekyll 
   module PaginateV2

data/lib/jekyll-paginate-v2/paginationGenerator.rb

@@ -0,0 +1,66 @@
+module Jekyll
+  module PaginateV2
+  
+    #
+    # The main entry point into the generator, called by Jekyll
+    # this function extracts all the necessary information from the jekyll end and passes it into the pagination 
+    # logic. Additionally it also contains all site specific actions that the pagination logic needs access to
+    # (such as how to create new pages)
+    # 
+    class PaginationGenerator < Generator
+      # This generator is safe from arbitrary code execution.
+      safe true
+
+      # This generator should be passive with regard to its execution
+      priority :lowest
+      
+      # Generate paginated pages if necessary (Default entry point)
+      # site - The Site.
+      #
+      # Returns nothing.
+      def generate(site)
+
+        # Retrieve and merge the pagination configuration from the site yml file
+        default_config = DEFAULT.merge(site.config['pagination'] || {})
+        
+        # If disabled then simply quit
+        if !default_config['enabled']
+          Jekyll.logger.info "Pagination:","disabled in site.config."
+          return
+        end
+        
+        Jekyll.logger.debug "Pagination:","Starting"
+
+        ################# 1 ###################
+        # Extract the necessary information out of the site object and then instantiate the model
+
+        # Get all posts that will be generated (excluding hidden posts that have hidden:true in the front matter)
+        all_posts = site.site_payload['site']['posts'].reject { |post| post['hidden'] }
+
+        # Get all pages in the site (this will be used to find the pagination templates)
+        all_pages = site.pages
+
+        # Get the default title of the site (used as backup when there is no title available for pagination)
+        site_title = site.config['title']
+
+        ################ 2 ####################
+        # Create the proc that constructs the real-life site page
+        page_create_lambda = lambda do | template_dir, template_name |
+          # Create the new page
+          newpage = Page.new( site, site.source, template_dir, template_name)
+          # Add the page to the site so that it is generated correctly
+          site.pages << newpage
+          # Return the site to the calling code
+          return newpage
+        end
+
+        ################ 3 ####################
+        # Now create and call the model with the real-life page creation proc and site data
+        model = PaginationModel.new()
+        model.run(default_config, all_pages, site_title, all_posts, &page_create_lambda)
+
+      end
+    end # class PaginationGenerator
+
+  end # module PaginateV2
+end # module Jekyll

data/lib/jekyll-paginate-v2/{pagination.rb → paginationModel.rb}

@@ -1,41 +1,21 @@
 module Jekyll
   module PaginateV2
 
-    class PaginationV2 < Generator
-      # This generator is safe from arbitrary code execution.
-      safe true
+    class PaginationModel
+
+      def run(default_config, site_pages, site_title, all_posts, &page_create_proc)
+        #if !block_given?
+        #  raise ArgumentError.new("No page creation block given, cannot continue.")
+        #end
 
-      # This generator should be passive with regard to its execution
-      priority :lowest
-      
-      # Generate paginated pages if necessary (Default entry point)
-      # site - The Site.
-      #
-      # Returns nothing.
-      def generate(site)
-        
-        # Retrieve and merge the folate configuration from the site yml file
-        default_config = DEFAULT.merge(site.config['pagination'] || {})
-        
-        # If disabled then simply quit
-        if !default_config['enabled']
-          Jekyll.logger.info "Pagination:","disabled in site.config."
-          return
-        end
-        
-        Jekyll.logger.debug "Pagination:","Starting"
-        
         # By default if pagination is enabled we attempt to find all index.html pages in the site
-        templates = self.discover_paginate_templates(site)
+        templates = self.discover_paginate_templates(site_pages)
         if( templates.size.to_i <= 0 )
           Jekyll.logger.warn "Pagination:","is enabled, but I couldn't find " +
           "any index.html page to use as the pagination template. Skipping pagination."
           return
         end
 
-        # Get all posts that will be generated (excluding hidden posts such as drafts)
-        all_posts = site.site_payload['site']['posts'].reject { |post| post['hidden'] }
-
         # Create the necessary indexes for the posts
         all_categories = self.index_posts_by(all_posts, 'categories')
         all_categories['posts'] = all_posts; # Popuplate a category for all posts 
@@ -56,7 +36,8 @@ module Jekyll
             if( template_config['enabled'] )
               Jekyll.logger.info "Pagination:","found template: "+template.path
               # Now construct the pagination data for this template page
-              self.paginate(site, template, template_config, all_posts, all_tags, all_categories, all_locales)
+              #self.paginate(site, template, template_config, all_posts, all_tags, all_categories, all_locales)
+              self.paginate(template, template_config, site_title, all_posts, all_tags, all_categories, all_locales, &page_create_proc)
             end
           end
         end #for
@@ -64,13 +45,14 @@ module Jekyll
       end # function generate
       
       #
-      # Rolls through the entire site and finds all index.html pages available
+      # Rolls through all the pages passed in and finds all pages that have pagination enabled on them.
+      # These pages will be used as templates
       #
-      # site - The Site.
+      # site_pages - All pages in the site
       #
-      def discover_paginate_templates(site)
+      def discover_paginate_templates(site_pages)
         candidates = []
-        site.pages.select do |page|
+        site_pages.select do |page|
           # If the page has the enabled config set, supports any type of file name html or md
           if page.data['pagination'].is_a?(Hash) && page.data['pagination']['enabled']
             candidates << page
@@ -183,8 +165,7 @@ module Jekyll
       # template - The index.html Page that requires pagination.
       # config - The configuration settings that should be used
       #
-      def paginate(site, template, config, all_posts, all_tags, all_categories, all_locales)
-        
+      def paginate(template, config, site_title, all_posts, all_tags, all_categories, all_locales, &page_create_proc)
         # By default paginate on all posts in the site
         using_posts = all_posts
         
@@ -215,21 +196,21 @@ module Jekyll
         # This .pager member is a built in thing in Jekyll and defines the paginator implementation
         # Simpy override to use mine
         (1..total_pages).each do |cur_page_nr|
-          pager = PaginatorV2.new( config['per_page'], config['permalink'], using_posts, cur_page_nr, total_pages, template.url )
+          pager = Paginator.new( config['per_page'], config['permalink'], using_posts, cur_page_nr, total_pages, template.url )
           if( cur_page_nr > 1)
-            newpage = Page.new( site, site.source, template.dir, template.name)
+            # External Proc call to create the actual page for us (this is passed in when the pagination is run)
+            newpage = page_create_proc.call( template.dir, template.name )
             newpage.pager = pager
             newpage.dir = Utils.paginate_path(template.url, cur_page_nr, config['permalink'])
             if( config.has_key?('title_suffix'))
               if( !template.data['title'] )
-                tmp_title = site.config['title']
+                tmp_title = site_title
               else
                 tmp_title = template.data['title']
               end
                
               newpage.data['title'] = "#{tmp_title}#{Utils.format_page_number(config['title_suffix'], cur_page_nr)}"
             end
-            site.pages << newpage
           else
             template.pager = pager
           end

data/lib/jekyll-paginate-v2/paginator.rb

@@ -4,7 +4,7 @@ module Jekyll
     #
     # Handles the preparation of all the posts based on the current page index
     #
-    class PaginatorV2
+    class Paginator
       attr_reader :page, :per_page, :posts, :total_posts, :total_pages,
         :previous_page, :previous_page_path, :next_page, :next_page_path
       
@@ -52,7 +52,7 @@ module Jekyll
         }
       end
       
-    end # class PaginatorV2
+    end # class Paginator
 
   end # module PaginateV2
 end # module Jekyll

data/lib/jekyll-paginate-v2/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module PaginateV2
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/spec/paginator_spec.rb

@@ -1,11 +1,11 @@
 require_relative 'spec_helper.rb'
 
 module Jekyll::PaginateV2
-  describe PaginatorV2 do
+  describe Paginator do
 
     it "must include the necessary paginator attributes" do
 
-      pager = PaginatorV2.new(10, "/page:num/", [], 1, 10, "/index.md")
+      pager = Paginator.new(10, "/page:num/", [], 1, 10, "/index.md")
 
       err = ->{ pager.page }.wont_raise NoMethodError
       err = ->{ pager.per_page }.wont_raise NoMethodError
@@ -20,8 +20,8 @@ module Jekyll::PaginateV2
     end
 
     it "must throw an error if the current page number is greater than the total pages" do
-      err = -> { pager = PaginatorV2.new(10, "/page:num/", [], 10, 8, "/index.md") }.must_raise RuntimeError
-      err = -> { pager = PaginatorV2.new(10, "/page:num/", [], 8, 10, "/index.md") }.wont_raise RuntimeError
+      err = -> { pager = Paginator.new(10, "/page:num/", [], 10, 8, "/index.md") }.must_raise RuntimeError
+      err = -> { pager = Paginator.new(10, "/page:num/", [], 8, 10, "/index.md") }.wont_raise RuntimeError
     end
 
     it "must trim the list of posts correctly based on the cur_page_nr and per_page" do
@@ -31,7 +31,7 @@ module Jekyll::PaginateV2
       # Initialize a pager with
       #   5 posts per page
       #   at page 2 out of 5 pages
-      pager = PaginatorV2.new(5, "/page:num/", posts, 2, 5, "/index.md")
+      pager = Paginator.new(5, "/page:num/", posts, 2, 5, "/index.md")
 
       pager.page.must_equal 2
       pager.per_page.must_equal 5
@@ -56,7 +56,7 @@ module Jekyll::PaginateV2
       # Initialize a pager with
       #   5 posts per page
       #   at page 2 out of 5 pages
-      pager = PaginatorV2.new(5, "/page:num/", posts, 1, 5, "/index.md")
+      pager = Paginator.new(5, "/page:num/", posts, 1, 5, "/index.md")
 
       pager.page.must_equal 1
       pager.per_page.must_equal 5
@@ -81,7 +81,7 @@ module Jekyll::PaginateV2
       # Initialize a pager with
       #   5 posts per page
       #   at page 2 out of 5 pages
-      pager = PaginatorV2.new(5, "/page:num/", posts, 5, 5, "/index.md")
+      pager = Paginator.new(5, "/page:num/", posts, 5, 5, "/index.md")
 
       pager.page.must_equal 5
       pager.per_page.must_equal 5

data/spec/spec_helper.rb

@@ -2,10 +2,12 @@ require 'minitest/spec'
 require 'minitest/autorun'
 
 require 'jekyll'
+require_relative '../lib/jekyll-paginate-v2/version'
 require_relative '../lib/jekyll-paginate-v2/defaults'
 require_relative '../lib/jekyll-paginate-v2/utils'
 require_relative '../lib/jekyll-paginate-v2/paginator'
-require_relative '../lib/jekyll-paginate-v2/pagination'
+require_relative '../lib/jekyll-paginate-v2/paginationModel'
+require_relative '../lib/jekyll-paginate-v2/paginationGenerator'
 
 # From: http://stackoverflow.com/a/32335990/779521
 module MiniTest

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-paginate-v2
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Sverrir Sigmundarson
@@ -69,7 +69,8 @@ files:
 - jekyll-paginate-v2.gemspec
 - lib/jekyll-paginate-v2.rb
 - lib/jekyll-paginate-v2/defaults.rb
-- lib/jekyll-paginate-v2/pagination.rb
+- lib/jekyll-paginate-v2/paginationGenerator.rb
+- lib/jekyll-paginate-v2/paginationModel.rb
 - lib/jekyll-paginate-v2/paginator.rb
 - lib/jekyll-paginate-v2/utils.rb
 - lib/jekyll-paginate-v2/version.rb