class RedisPagination::Paginator::ListPaginator
Public Class Methods
new(key, options = {})
click to toggle source
Initialize a new instance with a given Redis key
and options.
@param key [String] Redis list key. @param options [Hash] Options for paginator.
# File lib/redis_pagination/paginator/list_paginator.rb, line 8 def initialize(key, options = {}) @key = key end
Public Instance Methods
all(options = {})
click to toggle source
Retrieve all items for key
.
@return a Hash
containing :current_page
, :total_pages
, :total_items
and :items
.
# File lib/redis_pagination/paginator/list_paginator.rb, line 53 def all(options = {}) { :current_page => 1, :total_pages => 1, :total_items => total_items, :items => RedisPagination.redis.lrange(@key, 0, -1) } end
page(page, options = {})
click to toggle source
Retrieve a page of items for key
.
@param page [int] Page of items to retrieve. @param options [Hash] Options. Valid options are :page_size.
:page_size controls the page size for the call. Default is +RedisPagination.page_size+.
@return a Hash
containing :current_page
, :total_pages
, :total_items
and :items
.
# File lib/redis_pagination/paginator/list_paginator.rb, line 35 def page(page, options = {}) current_page = page < 1 ? 1 : page index_for_redis = current_page - 1 page_size = options[:page_size] || RedisPagination.page_size starting_offset = index_for_redis * page_size ending_offset = (starting_offset + page_size) - 1 { :current_page => current_page, :total_pages => total_pages(page_size), :total_items => total_items, :items => RedisPagination.redis.lrange(@key, starting_offset, ending_offset) } end
total_items()
click to toggle source
Return the total number of items for key
.
@return the total number of items for key
.
# File lib/redis_pagination/paginator/list_paginator.rb, line 24 def total_items RedisPagination.redis.llen(@key) end
total_pages(page_size = RedisPagination.page_size)
click to toggle source
Return the total number of pages for key
.
@param page_size [int] Page size to calculate total number of pages.
@return the total number of pages for key
.
# File lib/redis_pagination/paginator/list_paginator.rb, line 17 def total_pages(page_size = RedisPagination.page_size) (RedisPagination.redis.llen(@key) / page_size.to_f).ceil end