jekyll-paginate-multiple 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3d9fd0b4566f022d7a5e5a5138cce27c1a148ca
+  data.tar.gz: 9ccb849fd24b2a02940f76bb5d3cdaf7eccec743
+SHA512:
+  metadata.gz: f017a811d0b8545f38425c6ba3c59641af381049b199e44ac6d8e9636b00142e3ed42691b075b12067b0fc8b87c23ddc413a200ed52c5be50e4f162616b5abfd
+  data.tar.gz: 59764311eb294112aae03aa8c552f2232d151f519832df0af14703db33f46d9c4acba5ce4aa9125649ef355a834c4684f2899c008768b5eb0520daabf04a223c

data/lib/jekyll-paginate-multiple.rb

@@ -0,0 +1,155 @@
+require 'jekyll'
+
+module Jekyll
+  module Paginate
+    module Multiple
+
+      class MultiplePagination < Jekyll::Paginate::Pagination
+        safe true
+        priority :lowest
+
+        # Generate paginated pages for multiple sub directories.
+        #
+        # Example config:
+        #
+        #   paginate_multiple:
+        #     - paginate: 10
+        #       paginate_path: '/blog/page:num/'
+        #       sub_dir: '/en'
+        #     - paginate: 10
+        #       paginate_path: '/blog/de/page:num/'
+        #       sub_dir: '/de'
+        #
+        # site - The Site.
+        #
+        # Returns nothing
+        def generate(site)
+          paginate_multiple = site.config['paginate_multiple']
+
+          unless paginate_multiple.nil?
+            if paginate_multiple.kind_of?(Array)
+
+              # save original paginate and paginate_path so they can be restored
+              original_paginate = site.config['paginate']
+              original_paginate_path = site.config['paginate_path']
+
+              paginate_multiple.each_with_index do |pagination, index|
+                paginate = pagination['paginate']
+                paginate_path = pagination['paginate_path']
+                sub_dir = pagination['sub_dir']
+                
+                if paginate && paginate_path && sub_dir
+                  # set paginate and paginate_path for each entry for the Jekyll::Paginate::Pager
+                  site.config['paginate'] = paginate
+                  site.config['paginate_path'] = paginate_path
+
+                  template = template_page(site)
+
+                  if template
+                    posts = posts_for_sub_dir(site, sub_dir)
+                    paginate(site, template, posts, paginate)
+                  else
+                    Jekyll.logger.warn 'Pagination Multiple:', "Cannot find an index.html to use as the" +
+                        "pagination template for pagination path: '#{pagination['paginate_path']}'. "
+                        "Skipping pagination for entry #{index}."
+                  end
+                else
+                  Jekyll.logger.warn 'Pagination Multiple:', "For each 'pagination_multiple' entry, 'paginate', " +
+                      "'paginate_path' and 'sub_dir' must be set. Skipping pagination for entry #{index}."
+                end
+              end
+
+              # restore original paginate and paginate_path
+              site.config['paginate_path'] = original_paginate_path
+              site.config['paginate'] = original_paginate
+
+            else
+              Jekyll.logger.warn 'Pagination Multiple:', "Config parameter 'pagination_multiple' must be an array. " +
+                  "Skipping pagination."
+            end
+
+          end
+        end
+
+        # Returns all the posts in a given sub directory.
+        #
+        # site - The Site.
+        # sub_dir - The sub directory of the posts.
+        #
+        # Returns the posts in the sub directory
+        def posts_for_sub_dir(site, sub_dir)
+          site.site_payload['site']['posts'].reject{ |post| !post_is_in_sub_dir(post, sub_dir) || post['hidden'] }
+        end
+
+        # Paginates blog posts with a given page template.
+        #
+        # site - The Site.
+        # template - The template page for the pagination.
+        # posts - All the posts that should be paginated for the template.
+        # posts_per_page - Number of posts a page should have.
+        #
+        # Returns nothing
+        def paginate(site, template, posts, posts_per_page)
+          total_pages = Pager.calculate_pages(posts, posts_per_page.to_i)
+          (1..total_pages).each do |page_num|
+            current_page = page_num > 1 ? create_page(site, template, page_num) : template
+            pager = Pager.new(site, page_num, posts, total_pages)
+            current_page.pager = pager
+          end
+        end
+
+        # Creates a paginated page from a given template.
+        #
+        # site - The Site.
+        # template - The template page.
+        # page_num - The page number.
+        #
+        # Returns the created page
+        def create_page(site, template, page_num)
+          page = Page.new(site, site.source, template.dir, template.name)
+          page.dir = Pager.paginate_path(site, page_num)
+          site.pages << page
+          page
+        end
+
+        # Checks whether a post is in a given sub directory in '_posts'.
+        #
+        # post - The post.
+        # sub_dir - The sub directory
+        #
+        # Returns true if the post is in the sub directory, false otherwise
+        def post_is_in_sub_dir(post, sub_dir)
+          sub_dir = ensure_leading_slash(sub_dir)
+          sub_dir = ensure_no_trailing_slash(sub_dir)
+
+          posts_dir = '_posts'
+          post_path = post.relative_path
+
+          post_sub_dir = post_path[posts_dir.length..post.relative_path.rindex('/')-1]
+
+          sub_dir == post_sub_dir
+        end
+
+        # Ensures a directory has a leading slash.
+        #
+        # dir - The directory.
+        #
+        # Returns the directory with a leading slash
+        def ensure_leading_slash(dir)
+          dir[0] == '/' ? dir : '/' + dir
+        end
+
+        # Ensures a directory has no trailing slash.
+        #
+        # dir - The directory.
+        #
+        # Returns the directory with no trailing slash
+        def ensure_no_trailing_slash(dir)
+          dir[-1] != '/' ? dir : dir[0..-2]
+        end
+
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-paginate-multiple
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Georg Schmidl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-06 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: Jekyll pagination generator for multiple paths
+email:
+- georg.schmidl@scandio.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-paginate-multiple.rb
+homepage: https://github.com/scandio/jekyll-paginate-multiple
+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.5.0
+signing_key: 
+specification_version: 4
+summary: Jekyll pagination generator for multiple paths
+test_files: []