jekyll-paginate-cats 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b832a106d1eb388dece2b22b02071932515877b4
-  data.tar.gz: 6aff1db70130e4255949c2747202fd7317bad327
+  metadata.gz: b1d4877fa75c43beb9e690e8c3a2d530ca421053
+  data.tar.gz: 7374bd21f236c2618a45b96a78d537236ece6cc5
 SHA512:
-  metadata.gz: bc5fc9eee4a18aea52f5d2b09ed716263d1b70729d202a34496ec20d613fe111c50be40fe4056cd4d84cc913c29f2818876b816a98a19df605f307d0217276b6
-  data.tar.gz: cd227e103db2ade640bb0d7c7d33cfdae1761bcb9c34c041b2deebfe33c85ec4e115ae9e8327e27300a5ac82be93ab45fdbb040feba4754fb82c1d4cbc35c146
+  metadata.gz: ac9f7e70587eaa0442837a5ca7ee9fe4dd6a659beb9f6fb9032f9cb9cddc8542c3cc069a9a72bf71727bcf9e038fbec53a64c99b8f537725f4bf3bd050b4da2a
+  data.tar.gz: 8cb798afdb4ca9f0501ef7af62be617f8c4f0b3b2d2890ef62c6226732288941f5aa54cffc17a29285ef38b41dcd3305aa756eb470895d4f4738cc9c3c533bba

data/lib/jekyll-paginate-categories.rb

@@ -0,0 +1,69 @@
+require 'jekyll'
+
+module Jekyll
+  module Paginate
+    module Categories
+
+      # Internal requires
+      autoload :CategoryPage, 'jekyll-paginate-categories/category-page'
+      autoload :Pager, 'jekyll-paginate-categories/pager'
+
+      # Per-category pagination.
+      # Based on jekyll-paginate.
+      # 
+      # paginate_category_basepath: category base path - eg, /category/:name/
+      # paginate_path: will be concatenated with paginate_category - eg /page/:num/
+      # paginate_category_layout: The layout name of the category layout (default: categories.html)
+      class CategoryPagination < Generator
+        safe true
+
+        # Generate paginated pages if necessary.
+        #
+        # site - The Site.
+        #
+        # Returns nothing.
+        def generate(site)
+          if site.config['paginate_category_basepath']
+            for category in site.categories.keys
+              paginate_category(site, category)
+            end
+          end
+        end
+
+        # Do the blog's posts pagination per category. Renders the index.html file into paginated 
+        # directories (see paginate_category_basepath and paginate_path config) for these categories, 
+        # e.g.: /categories/my-category/page2/index.html, /categories/my-category/page3/index.html, etc.
+        #
+        # site     - The Site.
+        # category - The category to paginate.
+        #
+        # Returns nothing.
+        def paginate_category(site, category)
+          # Retrieve posts from that specific category.
+          all_posts = site.site_payload['site']['categories'][category]
+
+          # Category base path
+          category_path = site.config['paginate_category_basepath']
+          category_path = category_path.sub(':name', category.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, ''))
+          
+          # Count pages
+          nb_pages = Pager.calculate_pages(all_posts, site.config['paginate'].to_i)
+
+          # Create pages
+          (1..nb_pages).each do |current_num_page|
+            # Split posts into pages
+            pager = Pager.new(site, current_num_page, all_posts, nb_pages)
+            pager.update_paginate_paths(site, category_path)
+
+            # Create new page, based on category layout
+            newpage = CategoryPage.new(site, site.source, category)
+            newpage.pager = pager
+            newpage.dir = Pager.paginate_path_category(site, current_num_page, category_path)
+            site.pages << newpage
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/{jekyll-paginate-cats/cat-page.rb → jekyll-paginate-categories/category-page.rb}

@@ -1,11 +1,11 @@
 module Jekyll
   module Paginate
-    module Cats
+    module Categories
 
-      class CatPage < Jekyll::Page
+      class CategoryPage < Jekyll::Page
         # Attributes for Liquid templates
         ATTRIBUTES_FOR_LIQUID = %w(
-          cat
+          category
           content
           dir
           name
@@ -19,22 +19,22 @@ module Jekyll
         # base - The String path to the source.
         # dir  - The String path between the source and the file.
         # name - The String filename of the file.
-        # cat  - The String cat
-        def initialize(site, base, cat)
-          layout = site.config['paginate_cat_layout'] || 'cat.html'
+        # category - The String category
+        def initialize(site, base, category)
+          layout = site.config['paginate_category_layout'] || 'category.html'
           super(site, base, '_layouts', layout)
           process('index.html')
 
-          # Get the cat into layout using page.cat
-          @cat = cat
+          # Get the category into layout using page.category
+          @category = category
         end
 
-        # Produce a cat object suitable for Liquid.
+        # Produce a category object suitable for Liquid.
         #
         # Returns a String
-        def cat
-          if @cat.is_a? String
-            @cat
+        def category
+          if @category.is_a? String
+            @category
           end
         end
       end
@@ -42,5 +42,3 @@ module Jekyll
     end
   end
 end
-
-

data/lib/{jekyll-paginate-cats → jekyll-paginate-categories}/pager.rb

@@ -1,20 +1,20 @@
 module Jekyll
   module Paginate
-    module Cats
+    module Categories
 
       class Pager < Jekyll::Paginate::Pager
-        # Update paginator.previous_page_path and next_page_path to add cat path
+        # Update paginator.previous_page_path and next_page_path to add category path
         #
-        # site       - the Jekyll::Site object
-        # cat_path   -    cat path, eg /cat/web/
+        # site            - the Jekyll::Site object
+        # category_path   - category path, eg /category/web/
         #
         # Returns nothing.
-        def update_paginate_paths(site, cat_path)
+        def update_paginate_paths(site, category_path)
           if @page > 1
-            @previous_page_path = cat_path.sub(/(\/)+$/,'') + @previous_page_path
+            @previous_page_path = category_path.sub(/(\/)+$/,'') + @previous_page_path
           end
           if @page < @total_pages
-            @next_page_path = cat_path.sub(/(\/)+$/,'') + @next_page_path
+            @next_page_path = category_path.sub(/(\/)+$/,'') + @next_page_path
           end
         end
 
@@ -25,10 +25,10 @@ module Jekyll
         # paginate_path - the explicit paginate path, if provided
         #
         # Returns the pagination path as a string
-        def self.paginate_path_cat(site, num_page, cat_path, paginate_path = site.config['paginate_cat_path'])
+        def self.paginate_path_category(site, num_page, category_path, paginate_path = site.config['paginate_category_path'])
           return nil if num_page.nil?
-          return cat_path if num_page <= 1
-          format = cat_path.sub(/(\/)+$/,'') + paginate_path
+          return category_path if num_page <= 1
+          format = category_path.sub(/(\/)+$/,'') + paginate_path
           format = format.sub(':num', num_page.to_s)
           ensure_leading_slash(format)
         end
@@ -36,4 +36,4 @@ module Jekyll
 
     end
   end
-end
+end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-paginate-cats
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
-- Kenta Ng
+- Aweseome Kenta
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -59,9 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/jekyll-paginate-cats.rb
-- lib/jekyll-paginate-cats/cat-page.rb
-- lib/jekyll-paginate-cats/pager.rb
+- lib/jekyll-paginate-categories.rb
+- lib/jekyll-paginate-categories/category-page.rb
+- lib/jekyll-paginate-categories/pager.rb
 homepage: https://github.com/kentaccn/jekyll-paginate-cats
 licenses:
 - MIT
@@ -85,5 +85,5 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: Generate Pagination for Jekyll Categories.
+summary: Generate Pagination for Jekyll Categories with custom categories path.
 test_files: []

data/lib/jekyll-paginate-cats.rb

@@ -1,69 +0,0 @@
-require 'jekyll'
-
-module Jekyll
-  module Paginate
-    module Cats
-
-      # Internal requires
-      autoload :CatPage, 'jekyll-paginate-cats/cat-page'
-      autoload :Pager, 'jekyll-paginate-cats/pager'
-
-      # Per-cat pagination.
-      # Based on jekyll-paginate.
-      # 
-      # paginate_cat_basepath: cat base path - eg, /cat/:name/
-      # paginate_path: will be concatenated with paginate_cat - eg /page/:num/
-      # paginate_cat_layout: The layout name of the cat layout (default: cats.html)
-      class CatPagination < Generator
-        safe true
-
-        # Generate paginated pages if necessary.
-        #
-        # site - The Site.
-        #
-        # Returns nothing.
-        def generate(site)
-          if site.config['paginate_cat_basepath']
-            for cat in site.cats.keys
-              paginate_cat(site, cat)
-            end
-          end
-        end
-
-        # Do the blog's posts pagination per cat. Renders the index.html file into paginated 
-        # directories (see paginate_cat_basepath and paginate_path config) for these cats, 
-        # e.g.: /cats/my-cat/page2/index.html, /cats/my-cat/page3/index.html, etc.
-        #
-        # site     - The Site.
-        # cat - The cat to paginate.
-        #
-        # Returns nothing.
-        def paginate_cat(site, cat)
-          # Retrieve posts from that specific cat.
-          all_posts = site.site_payload['site']['cats'][cat]
-
-          # cat base path
-          cat_path = site.config['paginate_cat_basepath']
-          cat_path = cat_path.sub(':name', cat.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, ''))
-          
-          # Count pages
-          nb_pages = Pager.calculate_pages(all_posts, site.config['paginate'].to_i)
-
-          # Create pages
-          (1..nb_pages).each do |current_num_page|
-            # Split posts into pages
-            pager = Pager.new(site, current_num_page, all_posts, nb_pages)
-            pager.update_paginate_paths(site, cat_path)
-
-            # Create new page, based on cat layout
-            newpage = CatPage.new(site, site.source, cat)
-            newpage.pager = pager
-            newpage.dir = Pager.paginate_path_cat(site, current_num_page, cat_path)
-            site.pages << newpage
-          end
-        end
-      end
-
-    end
-  end
-end