jekyll-paginate_command 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0279e4179a95bae6fa7ee29e0b75544202fa523
+  data.tar.gz: 05d48f8e7492a533a117a4ce193f18097efce2ff
+SHA512:
+  metadata.gz: 151892c55657ef18148511352d1b5c04edc5e24fea17449a01992bd6c22b7a307e94ac34fb12a185aba482dcb47d98c99807542ea4953c035376f6aede805450
+  data.tar.gz: b362727f29f12b7c23908683bb34953b9211df3f3ee84797cb47a09f0f7e1aef719c3edce82505dfaab3208e7a3ddec7bae29b5110cd526974e2f3fd6af466c4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.7
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-paginate_command.gemspec
+gemspec
+
+gem "jekyll", ENV["JEKYLL_VERSION"] ? "~> #{ENV["JEKYLL_VERSION"]}" : ">= 2.5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Takuya Tsuchida
+
+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,247 @@
+# Jekyll::PaginateCommand
+
+The paginate command for Jekyll generates pagination templates. Generated templates work well on GitHub Pages.
+
+[![Build Status](https://travis-ci.org/omoshetech/jekyll-paginate_command.svg?branch=master)](https://travis-ci.org/omoshetech/jekyll-paginate_command)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll-paginate_command'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Install `jekyll-paginate_command` and run `jekyll help`.
+
+You will see a new command:
+
+```
+  paginate              Generate pagination templates
+```
+
+To enable the pagination of your posts, add a line to the front matter in the `index.html` file:
+
+```yaml
+paginate: true
+```
+
+And then execute:
+
+    $ jekyll paginate
+
+This command generates a `paginator` variable like the `jekyll-paginate` plugin.
+The difference of this command is a `paginator` variable is directly written in the front matter.
+Therefore, you need to access the `paginator` variable as `page.paginator`.
+You can see the generated front matter in the `index.html` file:
+
+```yaml
+---
+layout: default
+paginate: true
+paginator:
+  per_page: 10
+  total_posts: 26
+  total_pages: 3
+  page: 1
+  next_page: 2
+  next_page_path: "/page2/"
+---
+```
+
+This command also generates pagination templates in the `paginations` directory.
+These pages have same content of first page except front matter variables.
+
+When you write a new post, you need to run `jekyll paginate` before previewing your site.
+
+## Examples
+
+Here is examples of a paginated page.
+
+### Posts
+
+/index.html
+
+```html
+---
+layout: default
+paginate: true
+paginator:
+  per_page: 10
+  total_posts: 26
+  total_pages: 3
+  page: 1
+  next_page: 2
+  next_page_path: "/page2/"
+---
+{% assign paginator = page.paginator %}
+
+<div class="home">
+
+  <h1 class="page-heading">Posts</h1>
+
+  <ul class="post-list">
+    {% assign offset = paginator.page | minus: 1 | times: paginator.per_page %}
+    {% for post in site.posts limit: paginator.per_page offset: offset %}
+      <li>
+        <span class="post-meta">{{ post.date | date: "%b %-d, %Y" }}</span>
+
+        <h2>
+          <a class="post-link" href="{{ post.url | prepend: site.baseurl }}">{{ post.title }}</a>
+        </h2>
+      </li>
+    {% endfor %}
+  </ul>
+
+  {% if paginator.total_pages > 1 %}
+    <div class="pagination">
+      {% if paginator.previous_page %}
+        <a href="{{ paginator.previous_page_path | prepend: site.baseurl | replace: '//', '/' }}">&laquo; Prev</a>
+      {% else %}
+        <span>&laquo; Prev</span>
+      {% endif %}
+
+      {% assign paginate_relative_path = site.paginate_relative_path | default: '/page:num/' %}
+      {% assign relative_path = paginate_relative_path | replace: ':num', paginator.page %}
+      {% assign url = page.url | replace: relative_path, '/' %}
+
+      {% for page in (1..paginator.total_pages) %}
+        {% if page == paginator.page %}
+          <em>{{ page }}</em>
+        {% elsif page == 1 %}
+          <a href="{{ url | append: '/' | prepend: site.baseurl | replace: '//', '/' }}">{{ page }}</a>
+        {% else %}
+          <a href="{{ url | append: paginate_relative_path | prepend: site.baseurl | replace: '//', '/' | replace: ':num', page }}">{{ page }}</a>
+        {% endif %}
+      {% endfor %}
+
+      {% if paginator.next_page %}
+        <a href="{{ paginator.next_page_path | prepend: site.baseurl | replace: '//', '/' }}">Next &raquo;</a>
+      {% else %}
+        <span>Next &raquo;</span>
+      {% endif %}
+    </div>
+  {% endif %}
+
+  <p class="rss-subscribe">subscribe <a href="{{ "/feed.xml" | prepend: site.baseurl }}">via RSS</a></p>
+
+</div>
+```
+
+### Category
+
+/categories/jekyll/index.html
+
+```html
+---
+layout: default
+category: jekyll
+paginate: true
+paginator:
+  per_page: 10
+  total_posts: 26
+  total_pages: 3
+  page: 1
+  next_page: 2
+  next_page_path: "/categories/jekyll/page2/"
+---
+{% assign paginator = page.paginator %}
+
+<div class="home">
+
+  <h1 class="page-heading">Posts</h1>
+
+  <ul class="post-list">
+    {% assign offset = paginator.page | minus: 1 | times: paginator.per_page %}
+    {% for post in site.categories[page.category] limit: paginator.per_page offset: offset %}
+      <li>
+        <span class="post-meta">{{ post.date | date: "%b %-d, %Y" }}</span>
+
+        <h2>
+          <a class="post-link" href="{{ post.url | prepend: site.baseurl }}">{{ post.title }}</a>
+        </h2>
+      </li>
+    {% endfor %}
+  </ul>
+
+  {% if paginator.total_pages > 1 %}
+    <div class="pagination">
+      {% if paginator.previous_page %}
+        <a href="{{ paginator.previous_page_path | prepend: site.baseurl | replace: '//', '/' }}">&laquo; Prev</a>
+      {% else %}
+        <span>&laquo; Prev</span>
+      {% endif %}
+
+      {% assign paginate_relative_path = site.paginate_relative_path | default: '/page:num/' %}
+      {% assign relative_path = paginate_relative_path | replace: ':num', paginator.page %}
+      {% assign url = page.url | replace: relative_path, '/' %}
+
+      {% for page in (1..paginator.total_pages) %}
+        {% if page == paginator.page %}
+          <em>{{ page }}</em>
+        {% elsif page == 1 %}
+          <a href="{{ url | append: '/' | prepend: site.baseurl | replace: '//', '/' }}">{{ page }}</a>
+        {% else %}
+          <a href="{{ url | append: paginate_relative_path | prepend: site.baseurl | replace: '//', '/' | replace: ':num', page }}">{{ page }}</a>
+        {% endif %}
+      {% endfor %}
+
+      {% if paginator.next_page %}
+        <a href="{{ paginator.next_page_path | prepend: site.baseurl | replace: '//', '/' }}">Next &raquo;</a>
+      {% else %}
+        <span>Next &raquo;</span>
+      {% endif %}
+    </div>
+  {% endif %}
+
+  <p class="rss-subscribe">subscribe <a href="{{ "/feed.xml" | prepend: site.baseurl }}">via RSS</a></p>
+
+</div>
+```
+
+## Configurations
+
+### Global Configurations
+
+|Configuration         |Type   |Default    |Description                                                            |
+|----------------------|-------|-----------|-----------------------------------------------------------------------|
+|paginate_per_page     |Integer|10         |Set the number of posts per page.                                      |
+|paginate_relative_path|String |/page:num/ |Set the relative path of paginated pages from the first page directory.|
+|paginate_destination  |String |paginations|Set the destination of pagination templates.                           |
+
+### Front Matter Variables
+
+|Variable|Type   |Description                        |
+|--------|-------|-----------------------------------|
+|paginate|Boolean|Enable the pagination.             |
+|category|String |Set a category for filtering posts.|
+|tag     |String |Set a tag for filtering posts.     |
+
+### Generated Variables for Liquid
+
+|Variable                         |Description                                                         |
+|---------------------------------|--------------------------------------------------------------------|
+|page.paginator.per_page          |The number of Posts per page.                                       |
+|page.paginator.total_posts       |The total number of Posts.                                          |
+|page.paginator.total_pages       |The total number of Pages.                                          |
+|page.paginator.page              |The number of the current page.                                     |
+|page.paginator.previous_page     |The number of the previous page, or `nil` if no previous page exist.|
+|page.paginator.previous_page_path|The path to the previous page, or `nil` if no previous page exist.  |
+|page.paginator.next_page         |The number of the next page, or `nil` if no next page exist.        |
+|page.paginator.next_page_path    |The path to the next page, or `nil` if no next page exist.          |
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/omoshetech/jekyll-paginate_command.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll"
+require "jekyll-paginate_command"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jekyll-paginate_command.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-paginate_command/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-paginate_command"
+  spec.version       = Jekyll::PaginateCommand::VERSION
+  spec.authors       = ["Takuya Tsuchida"]
+  spec.email         = ["omoshetech.t+git@gmail.com"]
+
+  spec.summary       = %q{The paginate command for Jekyll generates pagination templates}
+  spec.description   = %q{The paginate command for Jekyll generates pagination templates}
+  spec.homepage      = "https://github.com/omoshetech/jekyll-paginate_command"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jekyll", ">= 2.5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", ">= 0.5.0"
+end

data/lib/jekyll-paginate_command.rb

@@ -0,0 +1,13 @@
+require "jekyll-paginate_command/version"
+require "jekyll-paginate_command/pagination"
+require "jekyll/commands/paginate"
+
+module Jekyll
+  module PaginateCommand
+    DEFAULTS = {
+      'paginate_per_page'      => 10,
+      'paginate_relative_path' => '/page:num/',
+      'paginate_destination'   => File.join(Dir.pwd, 'paginations')
+    }
+  end
+end

data/lib/jekyll-paginate_command/pagination.rb

@@ -0,0 +1,120 @@
+module Jekyll
+  module PaginateCommand
+    class Pagination
+      def initialize(base, site)
+        @base = base
+        @site = site
+        @config = site.config
+      end
+
+      def generate
+        (1..total_pages).each do |page|
+          @page = page
+          generate_current_page
+        end
+      end
+
+      private
+
+      def generate_current_page
+        Jekyll.logger.debug "Writing:", file_path
+        FileUtils.mkpath(dir_path)
+        File.write(file_path, file_content)
+      end
+
+      def dir_path
+        File.dirname(file_path)
+      end
+
+      def file_path
+        if 1 < page
+          File.join(@config['paginate_destination'], @base.dir, "#{page}.html")
+        else
+          File.join(@config['source'], @base.path)
+        end
+      end
+
+      def file_content
+        front_matter.concat(@base.content)
+      end
+
+      def front_matter
+        @base.data.merge(data).to_yaml.concat("---\n")
+      end
+
+      def data
+        {
+          'paginate'  => paginate,
+          'paginator' => paginator,
+          'permalink' => permalink
+        }.select { |_, value| !value.nil? }
+      end
+
+      def paginate
+        1 < page ? false : true
+      end
+
+      def paginator
+        {
+          'per_page'           => per_page,
+          'total_posts'        => total_posts,
+          'total_pages'        => total_pages,
+          'page'               => page,
+          'previous_page'      => previous_page,
+          'previous_page_path' => previous_page_path,
+          'next_page'          => next_page,
+          'next_page_path'     => next_page_path
+        }.select { |_, value| !value.nil? }
+      end
+
+      def per_page
+        @per_page ||= @config['paginate_per_page']
+      end
+
+      def total_posts
+        @total_posts ||= count_posts
+      end
+
+      def count_posts
+        case
+        when @base['category'] then @site.categories[@base['category']].length
+        when @base['tag']      then @site.tags[@base['tag']].length
+        else                        @site.posts.docs.length
+        end
+      end
+
+      def total_pages
+        @total_pages ||= total_posts.fdiv(per_page).ceil
+      end
+
+      def page
+        @page
+      end
+
+      def previous_page
+        1 < page ? page - 1 : nil
+      end
+
+      def previous_page_path
+        return @base.url if previous_page == 1
+        previous_page ? paginate_path.sub(':num', previous_page.to_s) : nil
+      end
+
+      def next_page
+        page < total_pages ? page + 1 : nil
+      end
+
+      def next_page_path
+        next_page ? paginate_path.sub(':num', next_page.to_s) : nil
+      end
+
+      def paginate_path
+        @paginate_path ||= File.join(@base.dir, @config['paginate_relative_path'])
+      end
+
+      def permalink
+        1 < page ? paginate_path.sub(':num', page.to_s) : nil
+      end
+    end
+  end
+end

data/lib/jekyll-paginate_command/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module PaginateCommand
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll/commands/paginate.rb

@@ -0,0 +1,54 @@
+module Jekyll
+  module Commands
+    class Paginate < Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:paginate) do |c|
+            c.version Jekyll::PaginateCommand::VERSION
+            c.syntax 'paginate [options]'
+            c.description 'Generate pagination templates'
+
+            c.option 'quiet',   '-q', '--quiet', 'Silence output.'
+            c.option 'verbose', '-V', '--verbose', 'Print verbose output.'
+
+            c.action do |_, options|
+              process(options)
+            end
+          end
+        end
+
+        def process(options)
+          config = config(options)
+          site = site(config)
+          pages = target_pages(site)
+          paginate(pages, site)
+        end
+
+        def config(options)
+          defaults = Configuration[PaginateCommand::DEFAULTS]
+          config = configuration_from_options(options)
+          Utils.deep_merge_hashes(defaults, config)
+        end
+
+        def site(config)
+          site = Site.new(config)
+          site.read
+          site
+        end
+
+        def target_pages(site)
+          site.pages.select { |page| page['paginate'] }
+        end
+
+        def paginate(pages, site)
+          t = Time.now
+          Jekyll.logger.info "Source:", site.config['source']
+          Jekyll.logger.info "Destination:", site.config['paginate_destination']
+          Jekyll.logger.info "Paginating..."
+          pages.each { |page| PaginateCommand::Pagination.new(page, site).generate }
+          Jekyll.logger.info "", "done in #{(Time.now - t).round(3)} seconds."
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-paginate_command
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takuya Tsuchida
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-18 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: The paginate command for Jekyll generates pagination templates
+email:
+- omoshetech.t+git@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll-paginate_command.gemspec
+- lib/jekyll-paginate_command.rb
+- lib/jekyll-paginate_command/pagination.rb
+- lib/jekyll-paginate_command/version.rb
+- lib/jekyll/commands/paginate.rb
+homepage: https://github.com/omoshetech/jekyll-paginate_command
+licenses: []
+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.1
+signing_key: 
+specification_version: 4
+summary: The paginate command for Jekyll generates pagination templates
+test_files: []