jekyll-paginate-v2 1.5.0 → 1.5.1

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

@@ -1,8 +1,8 @@
 module Jekyll
   module PaginateV2
-    VERSION = "1.5.0"
+    VERSION = "1.5.1"
     # When modifying remember to issue a new tag command in git before committing, then push the new tag
-    # git tag -a v1.5.0 -m "Gem v1.5.0"
+    # git tag -a v1.5.1 -m "Gem v1.5.1"
     # git push origin --tags
-  end
-end
+  end # module PaginateV2
+end # module Jekyll

data/spec/{defaults_spec.rb → generator/defaults_spec.rb}

@@ -1,6 +1,6 @@
-require_relative 'spec_helper.rb'
+require_relative '../spec_helper.rb'
 
-module Jekyll::PaginateV2
+module Jekyll::PaginateV2::Generator
   describe "checking default config" do
 
     it "should always contain the following keys" do
@@ -13,7 +13,8 @@ module Jekyll::PaginateV2
       DEFAULT.must_include 'sort_reverse'
       DEFAULT.must_include 'sort_field'
       DEFAULT.must_include 'limit'
-      DEFAULT.size.must_be :>=, 9
+      DEFAULT.must_include 'debug'
+      DEFAULT.size.must_be :>=, 10
     end
 
     it "should always contain the following key defaults" do
@@ -26,6 +27,7 @@ module Jekyll::PaginateV2
       DEFAULT['sort_reverse'].must_equal false
       DEFAULT['sort_field'].must_equal 'date'
       DEFAULT['limit'].must_equal 0
+      DEFAULT['debug'].must_equal false
     end
 
   end

data/spec/generator/paginationPage_spec.rb

@@ -0,0 +1,12 @@
+require_relative '../spec_helper.rb'
+
+module Jekyll::PaginateV2::Generator
+  describe "tesing pagination page implementation" do
+
+    it "sould always read the template file into itself" do
+      # DUE TO THE JEKYLL:PAGE CLASS ACCESSING FILE IO DIRECTLY 
+      # I AM UNABLE TO MOCK OUT THE FILE OPERATIONS TO CREATE UNIT TESTS FOR THIS CLASS :/
+    end
+
+  end
+end

data/spec/{paginator_spec.rb → generator/paginator_spec.rb}

@@ -1,27 +1,30 @@
-require_relative 'spec_helper.rb'
+require_relative '../spec_helper.rb'
 
-module Jekyll::PaginateV2
+module Jekyll::PaginateV2::Generator
   describe Paginator do
 
     it "must include the necessary paginator attributes" do
 
-      pager = Paginator.new(10, "/page:num/", [], 1, 10, "/index.md")
-
-      err = ->{ pager.page }.wont_raise NoMethodError
-      err = ->{ pager.per_page }.wont_raise NoMethodError
-      err = ->{ pager.posts }.wont_raise NoMethodError
-      err = ->{ pager.total_posts }.wont_raise NoMethodError
-      err = ->{ pager.total_pages }.wont_raise NoMethodError
-      err = ->{ pager.previous_page }.wont_raise NoMethodError
-      err = ->{ pager.previous_page_path }.wont_raise NoMethodError
-      err = ->{ pager.next_page }.wont_raise NoMethodError
-      err = ->{ pager.next_page_path }.wont_raise NoMethodError
+      pager = Paginator.new(10, "/page:num/", [], 1, 10, "/index.md", "/index.md")
+
+      # None of these accessors should throw errors, just run through them to test
+      val = pager.page
+      val = pager.per_page
+      val = pager.posts
+      val = pager.total_posts
+      val = pager.total_pages
+      val = pager.previous_page
+      val = pager.previous_page_path
+      val = pager.next_page
+      val = pager.next_page_path
       
     end
 
     it "must throw an error if the current page number is greater than the total pages" do
-      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
+      err = -> { pager = Paginator.new(10, "/page:num/", [], 10, 8, "/index.md", "/index.md") }.must_raise RuntimeError
+
+      # No error should be raised below
+      pager = Paginator.new(10, "/page:num/", [], 8, 10, "/index.md", "/index.md")
     end
 
     it "must trim the list of posts correctly based on the cur_page_nr and per_page" do
@@ -31,7 +34,7 @@ module Jekyll::PaginateV2
       # Initialize a pager with
       #   5 posts per page
       #   at page 2 out of 5 pages
-      pager = Paginator.new(5, "/page:num/", posts, 2, 5, "/index.md")
+      pager = Paginator.new(5, "/page:num/", posts, 2, 5, "/index.md", "/index.md")
 
       pager.page.must_equal 2
       pager.per_page.must_equal 5
@@ -56,7 +59,7 @@ module Jekyll::PaginateV2
       # Initialize a pager with
       #   5 posts per page
       #   at page 2 out of 5 pages
-      pager = Paginator.new(5, "/page:num/", posts, 1, 5, "/index.md")
+      pager = Paginator.new(5, "/page:num/", posts, 1, 5, "/index.md", "/index.md")
 
       pager.page.must_equal 1
       pager.per_page.must_equal 5
@@ -81,7 +84,7 @@ module Jekyll::PaginateV2
       # Initialize a pager with
       #   5 posts per page
       #   at page 2 out of 5 pages
-      pager = Paginator.new(5, "/page:num/", posts, 5, 5, "/index.md")
+      pager = Paginator.new(5, "/page:num/", posts, 5, 5, "/index.md", "/index.md")
 
       pager.page.must_equal 5
       pager.per_page.must_equal 5

data/spec/generator/utils_spec.rb

@@ -0,0 +1,90 @@
+require_relative '../spec_helper.rb'
+
+module Jekyll::PaginateV2::Generator
+  describe Utils do
+
+    it "should always replace num format with the specified number" do
+      Utils.format_page_number( ":num", 7).must_equal "7"
+      Utils.format_page_number( ":num", 13).must_equal "13"
+      Utils.format_page_number( ":num", -2).must_equal "-2"
+      Utils.format_page_number( ":num", 0).must_equal "0"
+      Utils.format_page_number( ":num", 1000).must_equal "1000"
+    end
+
+    it "should always replace num format with the specified number and keep rest of formatting" do
+      Utils.format_page_number( "/page:num/", 7).must_equal "/page7/"
+      Utils.format_page_number( "/page:num/", 50).must_equal "/page50/"
+      Utils.format_page_number( "/page:num/", -5).must_equal "/page-5/"
+
+      Utils.format_page_number( "/car/:num/", 1).must_equal "/car/1/"
+      Utils.format_page_number( "/car/:num", 1).must_equal "/car/1"
+      Utils.format_page_number( "car/:num", 1).must_equal "car/1"
+      Utils.format_page_number( "/car//:num", 1).must_equal "/car//1"
+    end
+
+    it "make sure there is a leading slash in path" do
+      Utils.ensure_leading_slash("path/to/file/wow").must_equal "/path/to/file/wow"
+      Utils.ensure_leading_slash("/no/place/wow/").must_equal "/no/place/wow/"
+      Utils.ensure_leading_slash("/no").must_equal "/no"
+      Utils.ensure_leading_slash("no").must_equal "/no"
+    end    
+
+    it "make sure there is never a leading slash in path" do
+      Utils.remove_leading_slash("path/to/file/wow").must_equal "path/to/file/wow"
+      Utils.remove_leading_slash("/no/place/wow/").must_equal "no/place/wow/"
+      Utils.remove_leading_slash("/no").must_equal "no"
+      Utils.remove_leading_slash("no").must_equal "no"
+    end
+
+    it "paginate must return nil if cur_page_nr is nill" do
+      Utils.paginate_path(nil, nil, nil, nil).must_be_nil
+      Utils.paginate_path("/index/moore","/index/moore.md", nil, "/page:num/").must_be_nil
+    end
+
+    it "paginate must return the url to the template if cur_page_nr is equal to 1" do
+      Utils.paginate_path("/index/moore", "/index/moore.md", 1, "/page:num/").must_equal "/index/moore"
+      Utils.paginate_path("/index.html", "/index.html", 1, "/page/").must_equal "/index.html"
+    end
+
+    it "paginate must throw an error if the permalink path doesn't include :num" do
+      err = ->{ Utils.paginate_path("/index.html", "/index.html", 3, "/page/")}.must_raise ArgumentError
+      err.message.must_include ":num"
+    end
+
+    it "paginate must use the permalink value and format it based on the cur_page_nr" do
+      Utils.paginate_path("/index.html", "/index.html", 3, "/page:num/").must_equal "/page3/"
+      Utils.paginate_path("/index.html", "/index.html", 646, "/page/:num/").must_equal "/page/646/"
+    end
+
+    it "paginate must ensure a leading slash in the url it returns" do
+      Utils.paginate_path("/index.html", "/index.html", 3, "page:num/").must_equal "/page3/"
+      Utils.paginate_path("/index.html", "/index.html", 646, "page/:num/").must_equal "/page/646/"
+    end
+
+    it "paginate must pre-pend the template.path url to it if we're not at root" do
+      Utils.paginate_path("/sub/index.html", "/sub/index.html", 3, "page:num/").must_equal "/sub/index/page3/"
+      Utils.paginate_path("/sub/index", "/sub/index.html", 3, "page:num/").must_equal "/sub/index/page3/"
+      Utils.paginate_path("/index/", "/sub/index.html", 3, "page:num/").must_equal "/index/page3/"
+    end
+
+    it "sort must sort strings lowercase" do
+      Utils.sort_values( "AARON", "Aaron").must_equal 0
+      Utils.sort_values( "AARON", "aaron").must_equal 0
+      Utils.sort_values( "aaron", "AARON").must_equal 0 
+    end
+
+    it "when sorting by nested post data the values must be resolved fully" do
+      data = {'book'=>{ 'name' => { 'first'=> 'John', 'last'=> 'Smith'}, 'rank'=>20}}
+      Utils.sort_get_post_data(data, "book:rank").must_equal 20
+      Utils.sort_get_post_data(data, "book:name:first").must_equal "John"
+      Utils.sort_get_post_data(data, "book:name:last").must_equal "Smith"
+
+      Utils.sort_get_post_data(data, "book:name").must_be_nil
+      Utils.sort_get_post_data(data, "name").must_be_nil
+      Utils.sort_get_post_data(data, "book").must_be_nil
+    end
+
+
+  end
+end
+

data/spec/spec_helper.rb

@@ -3,33 +3,11 @@ 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/compatibilityUtils'
-require_relative '../lib/jekyll-paginate-v2/paginator'
-require_relative '../lib/jekyll-paginate-v2/paginationPage'
-require_relative '../lib/jekyll-paginate-v2/paginationModel'
-require_relative '../lib/jekyll-paginate-v2/paginationGenerator'
-
-# From: http://stackoverflow.com/a/32335990/779521
-module MiniTest
-  module Assertions
-    def refute_raises *exp
-      msg = "#{exp.pop}.\n" if String === exp.last
-
-      begin
-        yield
-      rescue MiniTest::Skip => e
-        return e if exp.include? MiniTest::Skip
-        raise e
-      rescue Exception => e
-        exp = exp.first if exp.size == 1
-        flunk "unexpected exception raised: #{e}"
-      end
-
-    end
-  end
-  module Expectations
-    infect_an_assertion :refute_raises, :wont_raise
-  end
-end 
+require_relative '../lib/jekyll-paginate-v2/generator/defaults'
+require_relative '../lib/jekyll-paginate-v2/generator/utils'
+require_relative '../lib/jekyll-paginate-v2/generator/compatibilityUtils'
+require_relative '../lib/jekyll-paginate-v2/generator/paginationIndexer'
+require_relative '../lib/jekyll-paginate-v2/generator/paginator'
+require_relative '../lib/jekyll-paginate-v2/generator/paginationPage'
+require_relative '../lib/jekyll-paginate-v2/generator/paginationModel'
+require_relative '../lib/jekyll-paginate-v2/generator/paginationGenerator'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-paginate-v2
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Sverrir Sigmundarson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-01 00:00:00.000000000 Z
+date: 2016-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -52,6 +52,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.3
 description: 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
@@ -62,97 +82,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- examples/01-typicalblog/Gemfile
-- examples/01-typicalblog/README.md
-- examples/01-typicalblog/_config.yml
-- examples/01-typicalblog/_includes/header.html
-- examples/01-typicalblog/_layouts/home.html
-- examples/01-typicalblog/_posts/2016-11-20-geography-of-minneapolis.md
-- examples/01-typicalblog/_posts/2016-11-21-sailing-summer-olympics-1988.md
-- examples/01-typicalblog/_posts/2016-11-22-rotary-engine.md
-- examples/01-typicalblog/_posts/2016-11-23-luft-fahrzeug-gesellschaft.md
-- examples/01-typicalblog/_posts/2016-11-24-narcisse-snake-pits.md
-- examples/01-typicalblog/_posts/2016-11-25-tele7jours.md
-- examples/01-typicalblog/_posts/2016-11-26-columbia-river.md
-- examples/01-typicalblog/_posts/2016-11-27-welcome-to-jekyll-paginate-v2.md
-- examples/01-typicalblog/about.md
-- examples/01-typicalblog/index.html
-- examples/02-category/Gemfile
-- examples/02-category/README.md
-- examples/02-category/_config.yml
-- examples/02-category/_includes/header.html
-- examples/02-category/_layouts/home.html
-- examples/02-category/_posts/2016-10-27-welcome-to-jekyll-paginate-v2.md
-- examples/02-category/about.md
-- examples/02-category/cars/_posts/2016-10-18-Porsche-918-Spyder.md
-- examples/02-category/cars/_posts/2016-10-19-Porsche-964.md
-- examples/02-category/cars/_posts/2016-10-20-porsche-911-gt3.md
-- examples/02-category/cars/_posts/2016-10-21-porsche-911.md
-- examples/02-category/cars/_posts/2016-10-22-porsche-962.md
-- examples/02-category/cars/_posts/2016-10-23-Toyota-GT-One.md
-- examples/02-category/cars/_posts/2016-10-24-Mercedes-Benz-CLK-GTR.md
-- examples/02-category/cars/_posts/2016-10-25-rolls-royce-silver-ghost.md
-- examples/02-category/categories/byname.md
-- examples/02-category/categories/porsche.md
-- examples/02-category/index.md
-- examples/02-category/toyota/index.md
-- examples/03-tags/Gemfile
-- examples/03-tags/README.md
-- examples/03-tags/_biography/all/born-to-run.md
-- examples/03-tags/_biography/all/forty-autumns.md
-- examples/03-tags/_biography/all/life-in-questions-a.md
-- examples/03-tags/_biography/all/not-dead-yet.md
-- examples/03-tags/_biography/all/princess-diarist-the.md
-- examples/03-tags/_biography/all/when-breath-becomes-air.md
-- examples/03-tags/_biography/biography-musicians.md
-- examples/03-tags/_biography/index.md
-- examples/03-tags/_config.yml
-- examples/03-tags/_fantasy/all/harry-potter-deathly-hallows.md
-- examples/03-tags/_fantasy/all/harry-potter-philosophers-stone.md
-- examples/03-tags/_fantasy/all/mistborn-trilogy.md
-- examples/03-tags/_fantasy/all/ready-player-one.md
-- examples/03-tags/_fantasy/all/sword-of-destiny.md
-- examples/03-tags/_fantasy/all/terry-pratchet-diary-2017.md
-- examples/03-tags/_includes/header.html
-- examples/03-tags/_layouts/home.html
-- examples/03-tags/_layouts/post.html
-- examples/03-tags/_romance/all/breath-of-snow-and-ashes-a.md
-- examples/03-tags/_romance/all/dressmaker-the.md
-- examples/03-tags/_romance/all/fiery-cross-the.md
-- examples/03-tags/_romance/all/it-ends-with-us.md
-- examples/03-tags/_romance/all/outlander-novel.md
-- examples/03-tags/_romance/all/virgins-outlander-short-story.md
-- examples/03-tags/_romance/romance-historical.md
-- examples/03-tags/blog/_posts/2016-09-30-welcome-to-jekyll-paginate-v2.md
-- examples/03-tags/byisbn.md
-- examples/03-tags/index.md
-- examples/03-tags/tags/contemporary.md
-- examples/03-tags/tags/fantasy.md
-- examples/03-tags/tags/sci-fi.md
-- examples/README.md
-- examples/img/01-example-screenshot-main.png
-- examples/img/02-example-screenshot-main.png
-- examples/img/03-example-screenshot-main.png
 - jekyll-paginate-v2.gemspec
 - lib/jekyll-paginate-v2.rb
-- lib/jekyll-paginate-v2/compatibilityUtils.rb
-- lib/jekyll-paginate-v2/defaults.rb
-- lib/jekyll-paginate-v2/paginationGenerator.rb
-- lib/jekyll-paginate-v2/paginationModel.rb
-- lib/jekyll-paginate-v2/paginationPage.rb
-- lib/jekyll-paginate-v2/paginator.rb
-- lib/jekyll-paginate-v2/utils.rb
+- lib/jekyll-paginate-v2/autopages/autoTagPages.rb
+- lib/jekyll-paginate-v2/autopages/defaults.rb
+- lib/jekyll-paginate-v2/autopages/utils.rb
+- lib/jekyll-paginate-v2/generator/compatibilityUtils.rb
+- lib/jekyll-paginate-v2/generator/defaults.rb
+- lib/jekyll-paginate-v2/generator/paginationGenerator.rb
+- lib/jekyll-paginate-v2/generator/paginationIndexer.rb
+- lib/jekyll-paginate-v2/generator/paginationModel.rb
+- lib/jekyll-paginate-v2/generator/paginationPage.rb
+- lib/jekyll-paginate-v2/generator/paginator.rb
+- lib/jekyll-paginate-v2/generator/utils.rb
 - lib/jekyll-paginate-v2/version.rb
-- spec/defaults_spec.rb
-- spec/paginator_spec.rb
+- spec/generator/defaults_spec.rb
+- spec/generator/paginationPage_spec.rb
+- spec/generator/paginator_spec.rb
+- spec/generator/utils_spec.rb
 - spec/spec_helper.rb
-- spec/utils_spec.rb
 homepage: https://github.com/sverrirs/jekyll-paginate-v2
 licenses:
 - MIT
@@ -178,7 +131,8 @@ signing_key:
 specification_version: 4
 summary: Pagination Generator for Jekyll 3
 test_files:
-- spec/defaults_spec.rb
-- spec/paginator_spec.rb
+- spec/generator/defaults_spec.rb
+- spec/generator/paginationPage_spec.rb
+- spec/generator/paginator_spec.rb
+- spec/generator/utils_spec.rb
 - spec/spec_helper.rb
-- spec/utils_spec.rb

data/examples/01-typicalblog/Gemfile

@@ -1,28 +0,0 @@
-source "https://rubygems.org"
-ruby RUBY_VERSION
-
-# Hello! This is where you manage which Jekyll version is used to run.
-# When you want to use a different version, change it below, save the
-# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
-#
-#     bundle exec jekyll serve
-#
-# This will help ensure the proper Jekyll version is running.
-# Happy Jekylling!
-gem "jekyll", "3.3.0"
-
-# This is the default theme for new Jekyll sites. You may change this to anything you like.
-gem "minima", "~> 2.0"
-
-# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
-# uncomment the line below. To upgrade, run `bundle update github-pages`.
-# gem "github-pages", group: :jekyll_plugins
-
-source 'https://rubygems.org'
-
-group :jekyll_plugins do
-  gem "jekyll-paginate-v2"
-  gem "jekyll-feed"
-end
-
-gem 'wdm', '>= 0.1.0' if Gem.win_platform?