jekyll-paginate-v2 1.5.2 → 1.6.0

data/lib/jekyll-paginate-v2/generator/paginationPage.rb

@@ -6,33 +6,36 @@ module Jekyll
     # The code does the same things as the default Jekyll/page.rb code but just forces the code to look
     # into the template instead of the (currently non-existing) pagination page.
     #
+    # This page exists purely in memory and is not read from disk
+    #
     class PaginationPage < Page
-      def initialize(site, base, dir, template_path)
-        @site = site
-        @base = base
-        @dir = dir
-        @template = template_path
+      def initialize(page_to_copy, ignored)
+        @site = page_to_copy.site
+        @base = ''
+        @url = ''
         @name = 'index.html'
 
-        templ_dir = File.dirname(template_path)
-        templ_file = File.basename(template_path)
-
-        # Path is only used by the convertible module and accessed below when calling read_yaml
-        # in our case we have the path point to the original template instead of our faux new pagination page
-        @path = if site.in_theme_dir(base) == base # we're in a theme
-                  site.in_theme_dir(base, templ_dir, templ_file)
-                else
-                  site.in_source_dir(base, templ_dir, templ_file)
-                end
-        
-        self.process(@name)
-        self.read_yaml(templ_dir, templ_file)
+        self.process(@name) # Creates the basename and ext member values
 
-        data.default_proc = proc do |_, key|
-          site.frontmatter_defaults.find(File.join(templ_dir, templ_file), type, key)
+        # Only need to copy the data part of the page as it already contains the layout information
+        #self.data = Marshal.load(Marshal.dump(page_to_copy.data)) # Deep copying, http://stackoverflow.com/a/8206537/779521
+        self.data = Jekyll::Utils.deep_merge_hashes( page_to_copy.data, {} )
+        if !page_to_copy.data['autopage']
+          self.content = page_to_copy.content
         end
 
+        # Perform some validation that is also performed in Jekyll::Page
+        validate_data! page_to_copy.path
+        validate_permalink! page_to_copy.path
+
+        # Trigger a page event
+        #Jekyll::Hooks.trigger :pages, :post_init, self
+      end
+
+      def set_url(url_value)
+        @url = url_value
       end
     end # class PaginationPage
+
   end # module PaginateV2
 end # module Jekyll

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

@@ -6,16 +6,11 @@ module Jekyll
     #
     class Paginator
       attr_reader :page, :per_page, :posts, :total_posts, :total_pages,
-        :previous_page, :previous_page_path, :next_page, :next_page_path
+        :previous_page, :previous_page_path, :next_page, :next_page_path, :page_path
       
       # Initialize a new Paginator.
       #
-      # site     - the Jekyll::Site object
-      # page_nr  - The Integer page number.
-      # 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_per_page, config_permalink, posts, cur_page_nr, num_pages, template_url, template_path )
+      def initialize(config_per_page, first_index_page_url, paginated_page_url, posts, cur_page_nr, num_pages)
         @page = cur_page_nr
         @per_page = config_per_page.to_i
         @total_pages = num_pages
@@ -29,10 +24,11 @@ module Jekyll
 
         @total_posts = posts.size
         @posts = posts[init..offset]
+        @page_path = @page == 1 ? first_index_page_url : Utils.format_page_number(paginated_page_url, cur_page_nr, @total_pages)
         @previous_page = @page != 1 ? @page - 1 : nil
-        @previous_page_path = @page != 1 ? Utils.paginate_path(template_url, template_path, @previous_page, config_permalink) : nil
+        @previous_page_path = @page != 1 ? @page == 2 ? first_index_page_url : Utils.format_page_number(paginated_page_url, @previous_page, @total_pages) : nil
         @next_page = @page != @total_pages ? @page + 1 : nil
-        @next_page_path = @page != @total_pages ? Utils.paginate_path(template_url, template_path, @next_page, config_permalink) : nil
+        @next_page_path = @page != @total_pages ? Utils.format_page_number(paginated_page_url, @next_page, @total_pages) : nil
       end
 
       # Convert this Paginator's data to a Hash suitable for use by Liquid.
@@ -45,6 +41,7 @@ module Jekyll
           'total_posts' => total_posts,
           'total_pages' => total_pages,
           'page' => page,
+          'page_path' => page_path,
           'previous_page' => previous_page,
           'previous_page_path' => previous_page_path,
           'next_page' => next_page,

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

@@ -17,42 +17,20 @@ module Jekyll
         (all_posts.size.to_f / per_page.to_i).ceil
       end
 
-      # Static: Return the pagination path of the page
+      # Static: returns a fully formatted string with the current (:num) page number and maximum (:max) page count replaced if configured
       #
-      # site     - the Jekyll::Site object
-      # cur_page_nr - the pagination page number
-      # config - the current configuration in use
-      #
-      # Returns the pagination path as a string
-      def self.paginate_path(template_url, template_path, cur_page_nr, permalink_format)
-        return nil if cur_page_nr.nil?
-        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: '#{permalink_format}'. It must include ':num'.")
-        end
-
-        # If the template url is not just root "/" then pre-pend the template_url path to it
-        template_dir = File.dirname(template_path)
-        if( template_dir != "" && template_dir != "/" )
-          template_url_noext = File.join(File.dirname(template_url), File.basename(template_url, '.*'))
-          permalink_format = File.join(template_url_noext, permalink_format)
+      def self.format_page_number(toFormat, cur_page_nr, total_page_count=nil)
+        s = toFormat.sub(':num', cur_page_nr.to_s)
+        if !total_page_count.nil?
+          s = s.sub(':max', total_page_count.to_s)
         end
-
-        Utils.ensure_leading_slash(permalink_format)
-      end #function paginate_path
-      
-      # Static: returns a fully formatted string with the current page number if configured
-      #
-      def self.format_page_number(toFormat, cur_page_nr)
-        return toFormat.sub(':num', cur_page_nr.to_s)
+        return s
       end #function format_page_number
 
-      # Static: returns a fully formatted string with the :title variable replaced
+      # Static: returns a fully formatted string with the :title variable and the current (:num) page number and maximum (:max) page count replaced
       #
-      def self.format_page_title(toFormat, title)
-        return toFormat.sub(':title', title.to_s)
+      def self.format_page_title(toFormat, title, cur_page_nr=nil, total_page_count=nil)
+        return format_page_number(toFormat.sub(':title', title.to_s), cur_page_nr, total_page_count)
       end #function format_page_title
       
       # Static: Return a String version of the input which has a leading slash.

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

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

data/spec/generator/paginator_spec.rb

@@ -5,7 +5,8 @@ module Jekyll::PaginateV2::Generator
 
     it "must include the necessary paginator attributes" do
 
-      pager = Paginator.new(10, "/page:num/", [], 1, 10, "/index.md", "/index.md")
+      #  config_per_page, first_index_page_url, paginated_page_url, posts, cur_page_nr, num_pages
+      pager = Paginator.new(10, "index.html", "/page:num/", [], 1, 10)
 
       # None of these accessors should throw errors, just run through them to test
       val = pager.page
@@ -21,10 +22,10 @@ module Jekyll::PaginateV2::Generator
     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", "/index.md") }.must_raise RuntimeError
+      err = -> { pager = Paginator.new(10, "index.html", "/page:num/", [], 10, 8) }.must_raise RuntimeError
 
       # No error should be raised below
-      pager = Paginator.new(10, "/page:num/", [], 8, 10, "/index.md", "/index.md")
+      pager = Paginator.new(10, "index.html", "/page:num/", [], 8, 10)
     end
 
     it "must trim the list of posts correctly based on the cur_page_nr and per_page" do
@@ -34,7 +35,7 @@ module Jekyll::PaginateV2::Generator
       # 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", "/index.md")
+      pager = Paginator.new(5, "index.html", "/page:num/", posts, 2, 5)
 
       pager.page.must_equal 2
       pager.per_page.must_equal 5
@@ -47,7 +48,7 @@ module Jekyll::PaginateV2::Generator
       pager.posts[4].must_equal '10'
 
       pager.previous_page.must_equal 1
-      pager.previous_page_path.must_equal '/index.md'
+      pager.previous_page_path.must_equal 'index.html'
       pager.next_page.must_equal 3
       pager.next_page_path.must_equal '/page3/'
     end
@@ -59,7 +60,7 @@ module Jekyll::PaginateV2::Generator
       # 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", "/index.md")
+      pager = Paginator.new(5, "index.html", "/page:num/", posts, 1, 5)
 
       pager.page.must_equal 1
       pager.per_page.must_equal 5
@@ -84,7 +85,7 @@ module Jekyll::PaginateV2::Generator
       # 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", "/index.md")
+      pager = Paginator.new(5, "index.html", "/page:num/", posts, 5, 5)
 
       pager.page.must_equal 5
       pager.per_page.must_equal 5

data/spec/generator/utils_spec.rb

@@ -36,37 +36,6 @@ module Jekyll::PaginateV2::Generator
       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
@@ -84,6 +53,14 @@ module Jekyll::PaginateV2::Generator
       Utils.sort_get_post_data(data, "book").must_be_nil
     end
 
+    it "should always replace max format with the specified number if specified" do
+      Utils.format_page_number( ":num-:max", 7, 16).must_equal "7-16"
+      Utils.format_page_number( ":num-:max", 13, 20).must_equal "13-20"
+      Utils.format_page_number( ":num-:max", -2, -4).must_equal "-2--4"
+      Utils.format_page_number( ":num_of_:max", 0, 10).must_equal "0_of_10"
+      Utils.format_page_number( ":num/:max", 1000, 2000).must_equal "1000/2000"
+    end
+
 
   end
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-paginate-v2
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Sverrir Sigmundarson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-05 00:00:00.000000000 Z
+date: 2017-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
@@ -42,16 +42,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -59,9 +59,6 @@ dependencies:
     - - "~>"
       - !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
@@ -69,13 +66,11 @@ dependencies:
     - - "~>"
       - !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
-  and page configuration.
+  and page configuration. Optional features include auto-generation of paginated collection,
+  tag and category pages.
 email:
 - jekyll@sverrirs.com
 executables: []
@@ -85,12 +80,18 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
+- README-AUTOPAGES.md
+- README-GENERATOR.md
 - README.md
 - Rakefile
 - jekyll-paginate-v2.gemspec
 - lib/jekyll-paginate-v2.rb
-- lib/jekyll-paginate-v2/autopages/autoTagPages.rb
+- lib/jekyll-paginate-v2/autopages/autoPages.rb
 - lib/jekyll-paginate-v2/autopages/defaults.rb
+- lib/jekyll-paginate-v2/autopages/pages/baseAutoPage.rb
+- lib/jekyll-paginate-v2/autopages/pages/categoryAutoPage.rb
+- lib/jekyll-paginate-v2/autopages/pages/collectionAutoPage.rb
+- lib/jekyll-paginate-v2/autopages/pages/tagAutoPage.rb
 - lib/jekyll-paginate-v2/autopages/utils.rb
 - lib/jekyll-paginate-v2/generator/compatibilityUtils.rb
 - lib/jekyll-paginate-v2/generator/defaults.rb
@@ -118,7 +119,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:
   - - ">="

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

@@ -1,66 +0,0 @@
-#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