jekyll-paginate-v2 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd4827a1c9dd80de07ba232d75d61c573b52eeaf
-  data.tar.gz: a6238314308d5a386f8fab3f2b28f730b51ab8a7
+  metadata.gz: 80775a1edd643521212d16cdaab6e1c983a0e7dd
+  data.tar.gz: 2fde95bfee813f020993d8076e8ba95897a07017
 SHA512:
-  metadata.gz: 917b6eadca4c14048091ee608c8a284ba17ed3d5a8430c8723828b5cfda7918a64658dbbf7fccd53783ea25253a6e3edaf6432bce4c878c34d6a81884e151466
-  data.tar.gz: 72686ab7df0df3a8d2686f4c8141645df09c82248c547215f1fc2a5bbe4f4db40e19f2a672d8869abfac8a6408f36d0ce16aa983cc35736b35c50596ec93bc36
+  metadata.gz: 054388632b1064bda7bdb101ef988cb4b3abb28203f674fcf3e69e930c67fab6783fe3c1ce0d672bbd344489095797e119b74517a2039eeb6a12a4fb6c022f61
+  data.tar.gz: 2970a984f3ef365a0ad3ff329793a6ea45a7d1a845e0ed8068e3c4db0f4bf049fe85c725da720f26f79f613ee5fecdd021a3e12c3186dd9c2e9d2bba85308499

data/README.md

@@ -1,12 +1,27 @@
 # Jekyll::Paginate V2
 
-Pagination plugin built specially for Jekyll 3 and newer.
+Pagination gem built specially for Jekyll 3 and newer.
+https://rubygems.org/gems/jekyll-paginate-v2
 
-Enhanced replacement for the previously built-in [jekyll-paginate gem](https://github.com/jekyll/jekyll-paginate).
+Fully backwards compatable and enhanced replacement for the previously built-in [jekyll-paginate gem](https://github.com/jekyll/jekyll-paginate).
 
-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 https://github.com/jekyll/jekyll-paginate/issues/27) and some from the excellent [Octopress::Paginate code](https://github.com/octopress/paginate). 
+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:
+
+
+## Installation
+
+```
+gem install jekyll-paginate-v2
+```
+
+Update your [_config.yml](#site-configuration) and [pages](#page-configuration).
+
+> Although backwards compatible, this gem needs slightly extended [site yml](#site-configuration) configuration and adds miniscule new front-matter for the [paging templates](#page-configuration) configuration elements.
+
+Now you're ready to run `jekyll serve` and your paginated files should be generated.
 
-Thanks everybody :heart:
 
 ## Features
 
@@ -23,42 +38,20 @@ 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)).
 
-## Installation
-
-Currently this plugin is in develpment mode and is not yet distributed as a gem (mostly because I don't know how).
-
-To install, simply copy the `lib\jekyll-paginate-v2.rb` file into the `_plugins` folder under your Jekyll site root. 
-> If the _plugins folder does not exist simply create it.
-
-Then add the necessary [Site YML](#site-configuration) and [Page](#page-configuration) configuration elements.
-
-Run `jekyll serve` and you should see the pagination plugin debug messages printed during site generation:
-
-``` bash
-  Generating...
-    Pagination: found template: pictures/bestof.md
-    Pagination: found template: puffins/list.html
-    Pagination: found template: index.html
-```
-
-## Current state
-
-Currently this code is in dire need of feedback, code review and testing.
-
-I also would welcome guidance on how to write automated tests for this code so that I can publish it as a Gem.
-
-Come to think of it, I currently have no idea on how to publish a Gem... :/
-
-> Don't worry too much about the current structure, this is just the first iteration.
-> The code is currently a single file `jekyll-paginate-v2.rb` only because it makes it faster to develop and debug. As soon as I and hopefully other people test and green-light the logic I intend to break this code into separate files and distribute as a gem.  
 
 ## Contributing
 
+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. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+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
+
+Note: This project uses [semantic versioning](http://semver.org/).
 
 ## Site configuration
 
@@ -109,8 +102,11 @@ pagination:
 To enable pagination on a page (i.e. make that page a template for pagination) then simply include the minimal pagination configuration in the page front-matter:
 
 ``` yml
+---
+layout: page
 pagination: 
   enabled: true
+---
 ```
 
 Then you can use the normal `paginator.posts` logic to iterate through the posts.
@@ -125,17 +121,17 @@ And to display pagination links, simply
 
 ``` html
 {% if paginator.total_pages > 1 %}
-<ul class="pager">
-    {% if paginator.previous_page %}
-    <li class="previous">
-        <a href="{{ paginator.previous_page_path | prepend: site.baseurl | replace: '//', '/' }}">Newer Posts</a>
-    </li>
-    {% endif %}
-    {% if paginator.next_page %}
-    <li class="next">
-        <a href="{{ paginator.next_page_path | prepend: site.baseurl | replace: '//', '/' }}">Older Posts</a>
-    </li>
-    {% endif %}
+<ul>
+  {% if paginator.previous_page %}
+  <li>
+    <a href="{{ paginator.previous_page_path | prepend: site.baseurl }}">Newer</a>
+  </li>
+  {% endif %}
+  {% if paginator.next_page %}
+  <li>
+    <a href="{{ paginator.next_page_path | prepend: site.baseurl }}">Older</a>
+  </li>
+  {% endif %}
 </ul>
 {% endif %}
 ```

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rake'
+require 'rake/testtask'
+
+#$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
+#require 'lib/jekyll-paginate-v2/version'
+
+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']
+end
+
+desc "Run tests"
+task :default => [:test]

data/jekyll-paginate-v2.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "jekyll-paginate-v2"
   spec.version       = Jekyll::PaginateV2::VERSION
   spec.platform      = Gem::Platform::RUBY
-  spec.date          = '2016-11-18'
+  spec.date          = '2016-11-19'
   spec.authors       = ["Sverrir Sigmundarson"]
   spec.email         = ["jekyll@sverrirs.com"]
   spec.homepage      = "https://github.com/sverrirs/jekyll-paginate-v2"
@@ -18,11 +18,10 @@ Gem::Specification.new do |spec|
   
   spec.files         = `git ls-files -z`.split("\x0")
   #spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  #spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "jekyll", ">= 3.0"
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.0"
 end

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

@@ -215,11 +215,11 @@ 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, using_posts, cur_page_nr, total_pages, template )
+          pager = PaginatorV2.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)
             newpage.pager = pager
-            newpage.dir = Utils.paginate_path(template, cur_page_nr, config)
+            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']

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

@@ -15,9 +15,9 @@ module Jekyll
       # all_posts - The Array of all the site's Posts.
       # num_pages - The Integer number of pages or nil if you'd like the number
       #             of pages calculated.
-      def initialize(config, posts, cur_page_nr, num_pages, template )
+      def initialize(config_per_page, config_permalink, posts, cur_page_nr, num_pages, template_url )
         @page = cur_page_nr
-        @per_page = config['per_page'].to_i
+        @per_page = config_per_page.to_i
         @total_pages = num_pages
 
         if @page > @total_pages
@@ -30,9 +30,9 @@ module Jekyll
         @total_posts = posts.size
         @posts = posts[init..offset]
         @previous_page = @page != 1 ? @page - 1 : nil
-        @previous_page_path = Utils.paginate_path(template, @previous_page, config)
+        @previous_page_path = @page != 1 ? Utils.paginate_path(template_url, @previous_page, config_permalink) : nil
         @next_page = @page != @total_pages ? @page + 1 : nil
-        @next_page_path = Utils.paginate_path(template, @next_page, config)
+        @next_page_path = @page != @total_pages ? Utils.paginate_path(template_url, @next_page, config_permalink) : nil
       end
 
       # Convert this Paginator's data to a Hash suitable for use by Liquid.

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

@@ -14,16 +14,15 @@ module Jekyll
       # config - the current configuration in use
       #
       # Returns the pagination path as a string
-      def self.paginate_path(template, cur_page_nr, config)
+      def self.paginate_path(template_url, cur_page_nr, permalink_format)
         return nil if cur_page_nr.nil?
-        return template.url if cur_page_nr <= 1
-        format = config['permalink']
-        if format.include?(":num")
-          format = Utils.format_page_number(format, cur_page_nr)
+        return template_url if cur_page_nr <= 1
+        if permalink_format.include?(":num")
+          permalink_format = Utils.format_page_number(permalink_format, cur_page_nr)
         else
-          raise ArgumentError.new("Invalid pagination path: '#{format}'. It must include ':num'.")
+          raise ArgumentError.new("Invalid pagination path: '#{permalink_format}'. It must include ':num'.")
         end
-        Utils.ensure_leading_slash(format)
+        Utils.ensure_leading_slash(permalink_format)
       end #function paginate_path
       
       # Static: returns a fully formatted string with the current page number if configured

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

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

data/spec/defaults_spec.rb

@@ -0,0 +1,32 @@
+require_relative 'spec_helper.rb'
+
+module Jekyll::PaginateV2
+  describe "checking default config" do
+
+    it "should always contain the following keys" do
+      DEFAULT.must_include 'enabled'
+      DEFAULT.must_include 'collection'
+      DEFAULT.must_include 'per_page'
+      DEFAULT.must_include 'permalink'
+      DEFAULT.must_include 'title_suffix'
+      DEFAULT.must_include 'page_num'
+      DEFAULT.must_include 'sort_reverse'
+      DEFAULT.must_include 'sort_field'
+      DEFAULT.must_include 'limit'
+      DEFAULT.size.must_be :>=, 9
+    end
+
+    it "should always contain the following key defaults" do
+      DEFAULT['enabled'].must_equal false
+      DEFAULT['collection'].must_equal 'posts'
+      DEFAULT['per_page'].must_equal 10
+      DEFAULT['permalink'].must_equal '/page:num/'
+      DEFAULT['title_suffix'].must_equal ' - page :num'
+      DEFAULT['page_num'].must_equal 1
+      DEFAULT['sort_reverse'].must_equal false
+      DEFAULT['sort_field'].must_equal 'date'
+      DEFAULT['limit'].must_equal 0
+    end
+
+  end
+end

data/spec/paginator_spec.rb

@@ -0,0 +1,103 @@
+require_relative 'spec_helper.rb'
+
+module Jekyll::PaginateV2
+  describe PaginatorV2 do
+
+    it "must include the necessary paginator attributes" do
+
+      pager = PaginatorV2.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
+      
+    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
+    end
+
+    it "must trim the list of posts correctly based on the cur_page_nr and per_page" do
+      # Create a dummy list of posts that is easy to track
+      posts = ['1','2','3','4','5','6','7','8','9','10','11','12','13','14','15','16','17','18','19','20','21','22','23','24','25','26','27','28','29','30','31','32','33','34','35']
+
+      # 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.page.must_equal 2
+      pager.per_page.must_equal 5
+      pager.total_pages.must_equal 5
+
+      pager.total_posts.must_equal 35
+
+      pager.posts.size.must_equal 5
+      pager.posts[0].must_equal '6'
+      pager.posts[4].must_equal '10'
+
+      pager.previous_page.must_equal 1
+      pager.previous_page_path.must_equal '/index.md'
+      pager.next_page.must_equal 3
+      pager.next_page_path.must_equal '/page3/'
+    end
+
+    it "must not create a previous page if we're at first page" do
+      # Create a dummy list of posts that is easy to track
+      posts = ['1','2','3','4','5','6','7','8','9','10','11','12','13','14','15','16','17','18','19','20','21','22','23','24','25','26','27','28','29','30','31','32','33','34','35']
+
+      # 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.page.must_equal 1
+      pager.per_page.must_equal 5
+      pager.total_pages.must_equal 5
+
+      pager.total_posts.must_equal 35
+
+      pager.posts.size.must_equal 5
+      pager.posts[0].must_equal '1'
+      pager.posts[4].must_equal '5'
+
+      pager.previous_page.must_be_nil
+      pager.previous_page_path.must_be_nil
+      pager.next_page.must_equal 2
+      pager.next_page_path.must_equal '/page2/'
+    end
+
+    it "must not create a next page if we're at the final page" do
+      # Create a dummy list of posts that is easy to track
+      posts = ['1','2','3','4','5','6','7','8','9','10','11','12','13','14','15','16','17','18','19','20','21','22','23','24','25','26','27','28','29','30','31','32','33','34','35']
+
+      # 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.page.must_equal 5
+      pager.per_page.must_equal 5
+      pager.total_pages.must_equal 5
+
+      pager.total_posts.must_equal 35
+
+      pager.posts.size.must_equal 5
+      pager.posts[0].must_equal '21'
+      pager.posts[4].must_equal '25'
+
+      pager.previous_page.must_equal 4
+      pager.previous_page_path.must_equal '/page4/'
+      pager.next_page.must_be_nil
+      pager.next_page_path.must_be_nil
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+
+require 'jekyll'
+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'
+
+# 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 

data/spec/utils_spec.rb

@@ -0,0 +1,65 @@
+require_relative 'spec_helper.rb'
+
+module Jekyll::PaginateV2
+  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).must_be_nil
+      Utils.paginate_path("/index/moore", 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", 1, "/page:num/").must_equal "/index/moore"
+      Utils.paginate_path("/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", 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", 3, "/page:num/").must_equal "/page3/"
+      Utils.paginate_path("/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", 3, "page:num/").must_equal "/page3/"
+      Utils.paginate_path("/index.html", 646, "page/:num/").must_equal "/page/646/"
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-paginate-v2
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sverrir Sigmundarson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-18 00:00:00.000000000 Z
+date: 2016-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 description: An enhanced in-place replacement for the previously built-in jekyll-paginate
   gem offering full backwards compatability as well as a slew of new frequently requested
   features
@@ -79,6 +65,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - jekyll-paginate-v2.gemspec
 - lib/jekyll-paginate-v2.rb
 - lib/jekyll-paginate-v2/defaults.rb
@@ -86,6 +73,10 @@ files:
 - lib/jekyll-paginate-v2/paginator.rb
 - lib/jekyll-paginate-v2/utils.rb
 - lib/jekyll-paginate-v2/version.rb
+- spec/defaults_spec.rb
+- spec/paginator_spec.rb
+- spec/spec_helper.rb
+- spec/utils_spec.rb
 homepage: https://github.com/sverrirs/jekyll-paginate-v2
 licenses:
 - MIT
@@ -110,4 +101,8 @@ rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Pagination Generator for Jekyll 3
-test_files: []
+test_files:
+- spec/defaults_spec.rb
+- spec/paginator_spec.rb
+- spec/spec_helper.rb
+- spec/utils_spec.rb