octopress-paginate 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: acab0386b92350ad9e120e5b4412dd80a53b4d36
+  data.tar.gz: a26a9217a701686b3fc3d4d9927a92c91e84774f
+SHA512:
+  metadata.gz: f835d5f0918a183738991b0b74be51f6e3ab57121557a8a70f3d4d0f0e30d9b8579d795da357460966f2c8e860a080a6e68c71ef75bb6b25dd5d589074297e43
+  data.tar.gz: fc3ace64ead955a8eba2b362d84cea5e36f24dd4d0afc1166a8bb2764b2cd9954cfc9f69d472ceac22687706d9eadad65c8b1b6f7614687f4e48fbb09e370508

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+### 1.0.0 (2015-02-10)
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brandon Mathis
+
+MIT License
+
+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,128 @@
+# Octopress Paginate
+
+Simple and flexible pagination for Jekyll sites featuring:
+
+- Simple configuration
+- Paginate posts and collections
+- Page limits (Because who's reading page 35?)
+- Filter by categories or tags
+- Multi-language support (with [octopress-multilingual](https://github.com/octopress/multilingual))
+
+## Installation
+
+If you're using bundler add this gem to your site's Gemfile in the `:jekyll_plugins` group:
+
+    group :jekyll_plugins do
+      gem 'octopress-paginate'
+    end
+
+Then install the gem with Bundler
+
+    $ bundle
+
+To install manually without bundler:
+
+    $ gem install octopress-paginate
+
+Then add the gem to your Jekyll configuration.
+
+    gems:
+      - octopress-paginate
+
+## Usage
+
+### To paginate posts
+
+Create a page to be used as the pagination template.
+
+```
+---
+title: Post Index
+paginate: true
+---
+
+{% for post in paginator.posts %}
+/ do stuff /
+{% endfor %}
+```
+
+### To paginate collections
+
+This is basically the same as paginating posts, except you have to configure the paginate collection and set up the paginator to
+use the collection name.
+
+```
+---
+title: Penguin Index
+paginate:
+  collection: penguins
+---
+
+{% for penguin in paginator.penguins %}
+/ do stuff /
+{% endfor %}
+```
+
+### Template variables
+
+Just like Jekyll's paginator, your pagination pages will have access to the following liquid variables.
+
+
+```yaml
+{{ paginator.total_pages }}          # Number of paginated pages
+{{ paginator.total_posts }}          # Total number of posts being paginated
+{{ paginator.per_page }}             # Posts per page
+{{ paginator.limit }}                # Maximum number of paginated pages
+{{ paginator.page }}                 # Current page number
+{{ paginator.previous_page }}        # Previous page number (nil if first page)
+{{ paginator.previous_page_path }}   # Url for previous page (nil if first page)
+{{ paginator.next_page }}            # Next page number (nil if last page)
+{{ paginator.next_page_path }}       # Next page URL (nil if last page)
+
+# If you're pagination through a collection named `penguins`
+{{ pagination.total_penguins }}      # Total number of peguins being paginated
+```
+
+## Configuration
+
+In a page's YAML front-matter, setting `paginate: true` turns that page into a template for pagination. To configure pagination,
+set the options for the `paginate` key. Here are the defaults.
+
+```yaml
+paginate:
+  collection:   posts
+  per_page:     10             # maximum number of posts per page 
+  limit:        5              # Maximum number of pages to paginate (0 for unlimited)
+  permalink:    /page:num/     # pagination path (relative to template page)
+  title_suffix: " - page :num" # Append to template's page title
+  category:     ''             # Paginate posts in this category
+  categories:   []             # Paginate posts in any of these categories
+  tag:          ''             # Paginate posts tagged with this tag
+  tags:         []             # Paginate posts tagged with any of these tags
+```
+
+### Pagination permalinks
+
+Assume your pagination template page was at `/index.html`. The second pagination page would be 
+published to `/page2/index.html` by default. If your template page was at `/posts/index.html` or if was configured
+with `permalink: /posts/` the second pagination page would be published to `/posts/page2/index.html`.
+
+
+Here are some examples:
+
+```
+paginate:
+  permalink /page-:num/  # => /page-2/index.html
+  permalink /page/:num/  # => /page/2/index.html
+  permalink /:num/       # => /2/index.html
+```
+
+You get the idea.
+
+## Contributing
+
+1. Fork it ( https://github.com/octopress/paginate/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/octopress-paginate.rb

@@ -0,0 +1,133 @@
+require "octopress-hooks"
+require "octopress-paginate/version"
+require "octopress-paginate/hooks"
+require "octopress-paginate/page"
+
+module Octopress
+  module Paginate
+    extend self
+
+    DEFAULT = {
+      'collection'   => 'posts',
+      'per_page'     => 10,
+      'limit'        => 5,
+      'permalink'    => '/page:num/',
+      'title_suffix' => ' - page :num',
+      'page_num'     => 1
+    }
+
+    LOOP = /(paginate.+\s+in)\s+(site\.(.+?))(.+)%}/
+
+    def paginate(page)
+      if page.data['paginate'].is_a? Hash
+        page.data['paginate'] = DEFAULT.merge(page.data['paginate'])
+      else
+        page.data['paginate'] = DEFAULT
+      end
+
+      if tag = page.data['paginate']['tag']
+        page.data['paginate']['tags'] = Array(tag)
+      end
+
+      if category = page.data['paginate']['category']
+        page.data['paginate']['categories'] = Array(category)
+      end
+
+      add_pages(page)
+    end
+
+    def add_pages(page)
+      config = page.data['paginate']
+      pages = (collection(page).size.to_f / config['per_page']).ceil - 1
+
+      if config['limit'] > 0
+        pages = [pages, config['limit'] - 1].min
+      end
+
+      page.data['paginate']['pages'] = pages + 1
+
+      new_pages = []
+
+      pages.times do |i|
+        new_pages << PaginationPage.new(page.site, page.site.source, i+2, page)
+      end
+
+      all_pages = [page].concat(new_pages)
+
+      all_pages.each_with_index do |p, index|
+
+        if index > 0
+          prev_page = all_pages[index - 1]
+          p.data['paginate']['previous_page'] = index
+          p.data['paginate']['previous_page_path'] = prev_page.url
+        end
+
+        if next_page = all_pages[index + 1]
+          p.data['paginate']['next_page'] = index + 2
+          p.data['paginate']['next_page_path'] = next_page.url
+        end
+      end
+
+      page.site.pages.concat new_pages
+    end
+
+    def collection(page)
+      collection = if page['paginate']['collection'] == 'posts'
+        if defined?(Octopress::Multilingual) && page.lang
+          page.site.posts_by_language[page.lang]
+        else
+          page.site.posts.reverse
+        end
+      else
+        page.site.collections[page['paginate']['collection']].docs
+      end
+
+      if categories = page.data['paginate']['categories']
+        collection = collection.reject{|p| (p.categories & categories).empty?}
+      end
+
+      if tags = page.data['paginate']['tags']
+        collection = collection.reject{|p| (p.tags & tags).empty?}
+      end
+
+      collection
+    end
+
+    def page_payload(payload, page)
+      config = page.data['paginate']
+      collection = collection(page)
+      { 'paginator' => {
+        "#{config['collection']}"       => items(payload, collection),
+        "page"                          => config['page_num'],
+        "per_page"                      => config['per_page'],
+        "limit"                         => config['limit'],
+        "total_#{config['collection']}" => collection.size,
+        "total_pages"                   => config['pages'],
+        'previous_page'                 => config['previous_page'],
+        'previous_page_path'            => config['previous_page_path'],
+        'next_page'                     => config['next_page'],
+        'next_page_path'                => config['next_page_path']
+      }}
+    end
+
+    def items(payload, collection)
+      config = payload['page']['paginate']
+
+      n = (config['page_num'] - 1) * config['per_page']
+      max = n + (config['per_page'] - 1)
+
+      collection[n..max]
+    end
+  end
+end
+
+if defined? Octopress::Docs
+  Octopress::Docs.add({
+    name:        "Octopress Paginate",
+    gem:         "octopress-paginate",
+    version:     Octopress::Paginate::VERSION,
+    description: "Simple and flexible pagination for Jekyll posts and collections",
+    path:        File.expand_path(File.join(File.dirname(__FILE__), "../")),
+    source_url:  "https://github.com/octopress/paginate"
+  })
+end

data/lib/octopress-paginate/hooks.rb

@@ -0,0 +1,19 @@
+module Octopress
+  module Paginate
+    class SiteHook < Hooks::Site
+      def post_read(site)
+        site.pages.select {|p| p.data['paginate'] }.each do |page|
+          Octopress::Paginate.paginate(page)
+        end
+      end
+    end
+
+    class PageHook < Hooks::Page
+      def merge_payload(payload, page)
+        if page.data['paginate']
+          Octopress::Paginate.page_payload(payload, page)
+        end
+      end
+    end
+  end
+end

data/lib/octopress-paginate/page.rb

@@ -0,0 +1,21 @@
+module Octopress
+  module Paginate
+    class PaginationPage < Jekyll::Page
+      def initialize(site, base, index, template)
+        @site = site
+        @base = base
+        @dir  = File.join(template.dir, template.data['paginate']['permalink'].clone.sub(':num', index.to_s))
+        @name = 'index.html'
+        process(name)
+        read_yaml(File.join(base, File.dirname(template.path)), File.basename(template.path))
+
+        self.data.delete('permalink')
+        self.data.merge!({ 'paginate' => template.data['paginate'].clone })
+        self.data['paginate']['page_num'] = index
+
+        self.data['title'] ||= self.data['paginate']['collection'].capitlaize
+        self.data['title'] << data['paginate']['title_suffix'].sub(/:num/, data['paginate']['page_num'].to_s)
+      end
+    end
+  end
+end

data/lib/octopress-paginate/version.rb

@@ -0,0 +1,5 @@
+module Octopress
+  module Paginate
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: octopress-paginate
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brandon Mathis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octopress-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: clash
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: octopress-multilingual
+  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'
+- !ruby/object:Gem::Dependency
+  name: octopress
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: 
+email:
+- brandon@imathis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/octopress-paginate.rb
+- lib/octopress-paginate/hooks.rb
+- lib/octopress-paginate/page.rb
+- lib/octopress-paginate/version.rb
+homepage: https://github.com/octopress/paginate
+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: A nice and simple paginator for Jekyll sites.
+test_files: []