jekyll-paginate-categories 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23890de65d6e4a988c7dc70001ab5277dd7d40b9
+  data.tar.gz: 75bfb2d0f0108eb8686611bb1d926adf94907415
+SHA512:
+  metadata.gz: bb2a7fe8e5fc8f61001a74d9efc5453fee7d5a2bebb73149343a89b985f92c33ee386d725561daf322b068dd7c4900838f18d01c9bf8f8e9b23647bb5facca4c
+  data.tar.gz: f5616d9ac28b96e997e8c9f979a89c68f82a4eda8534aefc9407a89a2088af78bef7d3f421c079f8ebe2f5a80285812cd5f957b603a983cd496414c50c44cb9a

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)
+          
+          # 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-categories/category-page.rb

@@ -0,0 +1,44 @@
+module Jekyll
+  module Paginate
+    module Categories
+
+      class CategoryPage < Jekyll::Page
+        # Attributes for Liquid templates
+        ATTRIBUTES_FOR_LIQUID = %w(
+          category
+          content
+          dir
+          name
+          path
+          url
+        )
+
+        # Initialize a new Page.
+        #
+        # site - The Site object.
+        # base - The String path to the source.
+        # dir  - The String path between the source and the file.
+        # name - The String filename of the file.
+        # 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 category into layout using page.category
+          @category = category
+        end
+
+        # Produce a category object suitable for Liquid.
+        #
+        # Returns a String
+        def category
+          if @category.is_a? String
+            @category
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/jekyll-paginate-categories/pager.rb

@@ -0,0 +1,39 @@
+module Jekyll
+  module Paginate
+    module Categories
+
+      class Pager < Jekyll::Paginate::Pager
+        # Update paginator.previous_page_path and next_page_path to add category path
+        #
+        # site            - the Jekyll::Site object
+        # category_path   - category path, eg /category/web/
+        #
+        # Returns nothing.
+        def update_paginate_paths(site, category_path)
+          if @page > 1
+            @previous_page_path = category_path.sub(/(\/)+$/,'') + @previous_page_path
+          end
+          if @page < @total_pages
+            @next_page_path = category_path.sub(/(\/)+$/,'') + @next_page_path
+          end
+        end
+
+        # Static: Return the pagination path of the page
+        #
+        # site     - the Jekyll::Site object
+        # num_page - the pagination page number
+        # paginate_path - the explicit paginate path, if provided
+        #
+        # Returns the pagination path as a string
+        def self.paginate_path_category(site, num_page, category_path, paginate_path = site.config['paginate_path'])
+          return nil if num_page.nil?
+          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
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-paginate-categories
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Julien Guyomard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: jekyll-paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Automatically generate pagination for each category
+email:
+- julien@mangue.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-paginate-categories.rb
+- lib/jekyll-paginate-categories/category-page.rb
+- lib/jekyll-paginate-categories/pager.rb
+homepage: https://github.com/jguyomard/jekyll-paginate-categories
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.3
+signing_key: 
+specification_version: 4
+summary: Generate Pagination for Jekyll Categories.
+test_files: []