Parent

Files

Jekyll::Pager

Attributes

next_page[R]
next_page_path[R]
page[R]
per_page[R]
posts[R]
previous_page[R]
previous_page_path[R]
total_pages[R]
total_posts[R]

Public Class Methods

calculate_pages(all_posts, per_page) click to toggle source

Calculate the number of pages.

all_posts - The Array of all Posts. per_page - The Integer of entries per page.

Returns the Integer number of pages.

# File lib/jekyll/generators/pagination.rb, line 61
def self.calculate_pages(all_posts, per_page)
  (all_posts.size.to_f / per_page.to_i).ceil
end
new(config, page, all_posts, num_pages = nil) click to toggle source

Initialize a new Pager.

config - The Hash configuration of the site. page - The Integer page number. all_posts - The Array of all the site's Posts. num_pages - The Integer number of pages or nil if you'd like the number

of pages calculated.
# File lib/jekyll/generators/pagination.rb, line 107
def initialize(config, page, all_posts, num_pages = nil)
  @page = page
  @per_page = config['paginate'].to_i
  @total_pages = num_pages || Pager.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 = Pager.paginate_path(config, @previous_page)
  @next_page = @page != @total_pages ? @page + 1 : nil
  @next_page_path = Pager.paginate_path(config, @next_page)
end
paginate_path(site_config, num_page) click to toggle source

Static: Return the pagination path of the page

site_config - the site config num_page - the pagination page number

Returns the pagination path as a string

# File lib/jekyll/generators/pagination.rb, line 93
def self.paginate_path(site_config, num_page)
  return nil if num_page.nil? || num_page <= 1
  format = site_config['paginate_path']
  format = format.sub(':num', num_page.to_s)
  File.basename(format)
end
pagination_enabled?(config, page) click to toggle source

Determine if pagination is enabled for a given file.

config - The configuration Hash. page - The Jekyll::Page with which to paginate

Returns true if pagination is enabled, false otherwise.

# File lib/jekyll/generators/pagination.rb, line 71
def self.pagination_enabled?(config, page)
 !config['paginate'].nil? &&
    page.name == 'index.html' &&
    subdirectories_identical(config['paginate_path'], page.dir)
end
subdirectories_identical(paginate_path, page_dir) click to toggle source

Determine if the subdirectories of the two paths are the same relative to source

paginate_path - the paginate_path configuration setting page_dir - the directory of the Jekyll::Page

Returns whether the subdirectories are the same relative to source

# File lib/jekyll/generators/pagination.rb, line 83
def self.subdirectories_identical(paginate_path, page_dir)
  File.dirname(paginate_path).gsub(/\A\./, '') == page_dir.gsub(/\/\z/, '')
end

Public Instance Methods

to_liquid() click to toggle source

Convert this Pager's data to a Hash suitable for use by Liquid.

Returns the Hash representation of this Pager.

# File lib/jekyll/generators/pagination.rb, line 130
def to_liquid
  {
    'page' => page,
    'per_page' => per_page,
    'posts' => posts,
    'total_posts' => total_posts,
    'total_pages' => total_pages,
    'previous_page' => previous_page,
    'previous_page_path' => previous_page_path,
    'next_page' => next_page,
    'next_page_path' => next_page_path
  }
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.