module Apes::Concerns::Pagination

Pagination handling module.

Public Instance Methods

paginate(collection, sort_field: :id, sort_order: :desc) click to toggle source

Paginates a collection according to the current cursor.

@param collection [ActiveRecord::Relation] The collection to paginate. @param sort_field [Symbol] The field to use for pagination. @param sort_order [Symbol] The order to use for pagination. @return [ActiveRecord::Relation] The paginated collection.

# File lib/apes/concerns/pagination.rb, line 16
def paginate(collection, sort_field: :id, sort_order: :desc)
  direction = @cursor.direction
  value = @cursor.value

  # Apply the query
  collection = apply_value(collection, value, sort_field, sort_order)
  collection = collection.limit(@cursor.size).order(sprintf("%s %s", sort_field, sort_order.upcase))

  # If we're fetching previous we reverse the order to make sure we fetch the results adiacents to the previous request,
  # then we reverse results to ensure the order requested
  if direction != "next"
    collection = collection.reverse_order
    collection = collection.reverse
  end

  collection
end
pagination_field() click to toggle source

The field to use for pagination.

@return [Symbol] The field to use for pagination.

# File lib/apes/concerns/pagination.rb, line 37
def pagination_field
  @pagination_field ||= :handle
end
pagination_skip?() click to toggle source

Whether to skip pagination. This is used by template generation.

@return [Boolean] `true` if pagination must be skipped in template, `false` otherwise.

# File lib/apes/concerns/pagination.rb, line 44
def pagination_skip?
  @skip_pagination
end
pagination_supported?() click to toggle source

Checks if current collection supports pagination. This is used by template generation.

@return [Boolean] `true` if pagination is supported, `false` otherwise.

# File lib/apes/concerns/pagination.rb, line 51
def pagination_supported?
  @objects.respond_to?(:first) && @objects.respond_to?(:last)
end
pagination_url(page = nil) click to toggle source

Returns the URL a specific page of the current collection.

@param page [Symbol] The page to return. @return [String] The URL for a page of the current collection.

# File lib/apes/concerns/pagination.rb, line 59
def pagination_url(page = nil)
  exist = @cursor.might_exist?(page, @objects)
  exist ? url_for(request.params.merge(page: @cursor.save(@objects, page, field: pagination_field)).merge(only_path: false)) : nil
end