jekyll-paginate-simplecategory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e454db7d9b8186e90b186d30d660ce2f3ecbfdd1
+  data.tar.gz: 68ca3397250de25afdd81f27c5a6080d61aa538b
+SHA512:
+  metadata.gz: faa31784bc9dbaa4e50c622e24de5eb326354adcfaca67e7d493f92aecfc637620eb2495e9e5a19dc7fb3487205ce6066dadf5d9fd690bb4a0b212fa22d194d6
+  data.tar.gz: e8873e9cff056f3cf1b32ef4ce62c9c5534cbe125aa1a985d800f024be9009f7e85271d2ce7ce007aa9ac152b0fd1b49be82e84704cc8c737979945618773b39

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+Gemfile.lock
+.bundle

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Santosh Kumar Gupta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# Jekyll::Paginate::Simplecategory
+
+Simple Pagination Generator for Jekyll Posts Categories
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-paginate-simplecategory'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-paginate-simplecategory
+
+
+## Usage
+
+### Config Example
+
+Example of `_config.yml` file:
+
+```yaml
+# Plugins
+gems:
+  - jekyll-paginate
+  - jekyll-paginate-simplecategory
+
+# Pagination
+paginate: 5
+paginate_path: "/blog/page:num"
+
+category_paginate_path: "/blog/:categories/page:num"
+```
+
+### Customization
+
+#### Layout
+
+Simplecategory uses the default layout template set for pagination configured in the `paginate_path` parameter. To change the default layout add the `category_layout` parameter in `_config.yml` file:
+
+```yaml
+# Pagination
+category_layout: "category.html"
+```
+
+Create the layout file `category.html` in `_layout` directory. If you are placing the layout file in any other directory than put the relative path of the file as below.
+
+```yaml
+# Pagination
+category_layout: "/my_layouts/category.html"
+```
+
+#### Other
+
+You can set a custom title for each pages by adding the `category_page_title` parameter in `_config.yml` file:
+
+```yaml
+# Pagination
+category_page_title: "My Blog - :categories - Page:num"
+```
+
+
+## Contributing
+
+Feel free to report any bug and/or submit any improvement pull requests.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/jekyll-paginate-simplecategory.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-paginate-simplecategory/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'jekyll-paginate-simplecategory'
+  s.version       = Jekyll::Paginate::Simplecategory::VERSION
+  s.authors       = ['Santosh Kumar Gupta']
+  s.email         = ['santosh0705@gmail.com']
+  s.summary       = 'Simple Pagination Generator for Jekyll Posts Categories'
+  s.description   = 'Automatically Generate Pagination for Jekyll Posts Categories'
+  s.homepage      = 'https://github.com/santosh0705/jekyll-paginate-simplecategory'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'jekyll', '~> 2.0', '>=2.0'
+  s.add_development_dependency 'jekyll-paginate', '~> 1.1'
+  s.add_development_dependency 'rake', '~> 0'
+end

data/lib/jekyll-paginate-simplecategory.rb

@@ -0,0 +1,129 @@
+require 'jekyll-paginate-simplecategory/version'
+
+module Jekyll
+  module Paginate
+    module Simplecategory
+      
+      class Pagination < Generator
+        safe true
+        priority :lowest
+
+        def generate(site)
+          if CategoryPager.pagination_enabled?(site)
+            paginate(site)
+          end
+        end
+
+        # Paginates the blog's posts. Renders the index.html file into paginated
+        # directories, e.g.: page2/index.html, page3/index.html, etc and adds more
+        # site-wide data.
+        #
+        # site          - The Site.
+        #
+        # {"paginator" => { "page" => <Number>,
+        #                   "per_page" => <Number>,
+        #                   "posts" => [<Post>],
+        #                   "total_posts" => <Number>,
+        #                   "total_pages" => <Number>,
+        #                   "previous_page" => <Number>,
+        #                   "next_page" => <Number> }}
+        def paginate(site)
+          if category_layout = site.config['category_layout']
+            template_name = File.basename(category_layout)
+            template_dir = File.dirname(category_layout)
+            template_dir = '/_layouts' if template_dir == '.'
+            template_dir.prepend('/') unless template_dir.start_with? '/'
+          else
+            if template = template_page(site)
+              template_name = template.name
+              template_dir = template.dir
+            else
+              Jekyll.logger.warn "Pagination:", "Pagination is enabled, but I couldn't find " +
+              "an index.html page to use as the pagination template. Skipping pagination."
+            end
+          end
+          site.categories.each do |category, all_posts|
+            all_posts = all_posts.reject { |p| p['hidden'] }
+            pages = CategoryPager.calculate_pages(all_posts, site.config['paginate'].to_i)
+            (1..pages).each do |num_page|
+              paginate_path = CategoryPager.paginate_path(site, num_page, category)
+              pager = CategoryPager.new(site, num_page, all_posts, pages, category)
+              if page_title = site.config['category_page_title']
+                page_title = page_title.sub(':categories', category.capitalize)
+                page_title = page_title.sub(':num', num_page.to_s)
+              end
+              site.pages << CategoryPage.new(site, site.source, paginate_path, 'index.html', template_dir, template_name, pager, page_title)
+            end
+          end
+        end
+
+        # Find the Jekyll::Page which will act as the pager template
+        #
+        # site - the Jekyll::Site object
+        #
+        # Returns the Jekyll::Page which will act as the pager template
+        def template_page(site)
+          site.pages.dup.select do |page|
+            CategoryPager.pagination_candidate?(site.config, page)
+          end.sort do |one, two|
+            two.path.size <=> one.path.size
+          end.first
+        end
+      end
+
+      class CategoryPage < Page
+        def initialize(site, base, dir, name, template_dir, template_name, pager, page_title)
+          @site = site
+          @base = base
+          @dir = dir
+          @name = name
+          @pager = pager
+
+          self.process(@name)
+          self.read_yaml(File.join(base, template_dir), template_name)
+          self.data['title'] = page_title if page_title
+        end
+      end
+
+      class CategoryPager < Paginate::Pager
+        def initialize(site, page, all_posts, num_pages = nil, category)
+          @page = page
+          @per_page = site.config['paginate'].to_i
+          @total_pages = num_pages || CategoryPager.calculate_pages(all_posts, @per_page)
+
+          if @page > @total_pages
+            raise RuntimeError, "page number can't be greater than total pages: #{@page} > #{@total_pages}"
+          end
+
+          init = (@page - 1) * @per_page
+          offset = (init + @per_page - 1) >= all_posts.size ? all_posts.size : (init + @per_page - 1)
+
+          @total_posts = all_posts.size
+          @posts = all_posts[init..offset]
+          @previous_page = @page != 1 ? @page - 1 : nil
+          @previous_page_path = CategoryPager.paginate_path(site, @previous_page, category)
+          @next_page = @page != @total_pages ? @page + 1 : nil
+          @next_page_path = CategoryPager.paginate_path(site, @next_page, category)
+        end
+
+        # Return the pagination path of the page
+        #
+        # site     - the Jekyll::Site object
+        # num_page - the pagination page number
+        # category - the category name
+        #
+        # Returns the pagination path as a string
+        def self.paginate_path(site, num_page, category)
+          return nil if num_page.nil?
+          path = site.config['category_paginate_path'] || '/blog/:categories/page:num'
+          path = path.sub(':categories', category)
+          path = path.sub(':num', num_page.to_s)
+          path.prepend('/') unless path.start_with? '/'
+          path_first = File.dirname(path)
+          num_page <= 1 ? path_first : path
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Jekyll
+  module Paginate
+    module Simplecategory
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-paginate-simplecategory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Santosh Kumar Gupta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll-paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  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 Jekyll Posts Categories
+email:
+- santosh0705@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- jekyll-paginate-simplecategory.gemspec
+- lib/jekyll-paginate-simplecategory.rb
+- lib/jekyll-paginate-simplecategory/version.rb
+homepage: https://github.com/santosh0705/jekyll-paginate-simplecategory
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Simple Pagination Generator for Jekyll Posts Categories
+test_files: []