# Paginator#to_sql to retrieve <tt>@people</tt> from the model.
#
module Pagination
- unless const_defined?(:OPTIONS)
+ if const_defined?(:OPTIONS)
+ DEFAULT_OPTIONS[:group] = nil
+ else
# A hash holding options for controllers using macro-style pagination
- OPTIONS = {}
+ OPTIONS = {}.freeze
# The default options for pagination
DEFAULT_OPTIONS = {
:class_name => nil,
:singular_name => nil,
- :per_page => 10,
+ :per_page => 10,
:conditions => nil,
- :order_by => nil,
- :order => nil,
- :join => nil,
- :joins => nil,
- :count => nil,
- :include => nil,
- :select => nil,
- :group => nil,
- :parameter => 'page'
- }
- else
- DEFAULT_OPTIONS[:group] = nil
+ :order_by => nil,
+ :order => nil,
+ :join => nil,
+ :joins => nil,
+ :count => nil,
+ :include => nil,
+ :select => nil,
+ :group => nil,
+ :parameter => "page"
+ }.freeze
end
- def self.included(base) #:nodoc:
+ def self.included(base) # :nodoc:
super
base.extend(ClassMethods)
end
- def self.validate_options!(collection_id, options, in_action) #:nodoc:
+ def self.validate_options!(collection_id, options, in_action) # :nodoc:
options.merge!(DEFAULT_OPTIONS) { |_key, old, _new| old }
valid_options = DEFAULT_OPTIONS.keys
valid_options << :actions unless in_action
unknown_option_keys = options.keys - valid_options
- fail ActionController::ActionControllerError,
- "Unknown options: #{unknown_option_keys.join(', ')}" unless
- unknown_option_keys.empty?
+ unless unknown_option_keys.empty?
+ raise ActionController::ActionControllerError,
+ "Unknown options: #{unknown_option_keys.join(', ')}"
+ end
options[:singular_name] ||= ActiveSupport::Inflector.singularize(collection_id.to_s)
- options[:class_name] ||= ActiveSupport::Inflector.camelize(options[:singular_name])
+ options[:class_name] ||= ActiveSupport::Inflector.camelize(options[:singular_name])
end
# Returns a paginator and a collection of Active Record model instances
# These methods become class methods on any controller
module ClassMethods
- # Creates a +before_filter+ which automatically paginates an Active
+ # Creates a +before_action+ which automatically paginates an Active
# Record model for all actions in a controller (or certain actions if
# specified with the <tt>:actions</tt> option).
#
def paginate(collection_id, options = {})
Pagination.validate_options!(collection_id, options, false)
module_eval do
- before_filter :create_paginators_and_retrieve_collections
+ before_action :create_paginators_and_retrieve_collections
OPTIONS[self] ||= {}
OPTIONS[self][collection_id] = options
end
end
end
- def create_paginators_and_retrieve_collections #:nodoc:
+ protected
+
+ def create_paginators_and_retrieve_collections # :nodoc:
Pagination::OPTIONS[self.class].each do |collection_id, options|
- next unless options[:actions].include? action_name if
- options[:actions]
+ next if options[:actions]&.exclude?(action_name)
paginator, collection =
paginator_and_collection_for(collection_id, options)
collection = collection.order(options[:order_by] || options[:order])
collection = collection.includes(options[:include])
collection = collection.group(options[:group])
-
- if options[:select]
- collection = collection.select(options[:select])
- end
+ collection = collection.select(options[:select]) if options[:select]
collection.offset(paginator.current.offset).limit(options[:per_page])
end
- protected :create_paginators_and_retrieve_collections,
- :count_collection_for_pagination,
- :find_collection_for_pagination
+ private
- def paginator_and_collection_for(_collection_id, options) #:nodoc:
+ def paginator_and_collection_for(_collection_id, options) # :nodoc:
klass = options[:class_name].constantize
page = params[options[:parameter]]
count = count_collection_for_pagination(klass, options)
[paginator, collection]
end
- private :paginator_and_collection_for
-
# A class representing a paginator for an Active Record collection.
class Paginator
include Enumerable
# than or equal to zero). The page CGI parameter for links defaults to
# "page" and can be overridden with +page_parameter+.
def initialize(controller, item_count, items_per_page, current_page = 1)
- fail ArgumentError, 'must have at least one item per page' if
+ raise ArgumentError, "must have at least one item per page" if
items_per_page <= 0
@controller = controller
# object, its +number+ attribute is used as the value; if the page does
# not belong to this Paginator, an ArgumentError is raised.
def current_page=(page)
- if page.is_a? Page
- fail ArgumentError, 'Page/Paginator mismatch' unless
- page.paginator == self
- end
+ raise ArgumentError, "Page/Paginator mismatch" if page.is_a?(Page) && page.paginator != self
+
page = page.to_i
- @current_page_number = has_page_number?(page) ? page : 1
+ @current_page_number = contains_page?(page) ? page : 1
end
# Returns a Page object representing this paginator's current page.
def current_page
@current_page ||= self[@current_page_number]
end
- alias_method :current, :current_page
+ alias current current_page
# Returns a new Page representing the first page in this paginator.
def first_page
@first_page ||= self[1]
end
- alias_method :first, :first_page
+ alias first first_page
# Returns a new Page representing the last page in this paginator.
def last_page
@last_page ||= self[page_count]
end
- alias_method :last, :last_page
+ alias last last_page
# Returns the number of pages in this paginator.
def page_count
- @page_count ||= @item_count.zero? ? 1 :
- (q, r = @item_count.divmod(@items_per_page); r == 0 ? q : q + 1)
+ @page_count ||= if @item_count.zero?
+ 1
+ else
+ q, r = @item_count.divmod(@items_per_page)
+ r.zero? ? q : q + 1
+ end
end
- alias_method :length, :page_count
+ alias length page_count
# Returns true if this paginator contains the page of index +number+.
- def has_page_number?(number)
+ def contains_page?(number)
number >= 1 && number <= page_count
end
def initialize(paginator, number)
@paginator = paginator
@number = number.to_i
- @number = 1 unless @paginator.has_page_number? @number
+ @number = 1 unless @paginator.contains_page? @number
end
attr_reader :paginator, :number
- alias_method :to_i, :number
+
+ alias to_i number
# Compares two Page objects and returns true when they represent the
# same page (i.e., their paginators are the same and they have the
# same page number).
- def ==(page)
- return false if page.nil?
- @paginator == page.paginator &&
- @number == page.number
+ def ==(other)
+ return false if other.nil?
+
+ @paginator == other.paginator &&
+ @number == other.number
end
# Compares two Page objects and returns -1 if the left-hand page comes
# before the right-hand page, 0 if the pages are equal, and 1 if the
# left-hand page comes after the right-hand page. Raises ArgumentError
# if the pages do not belong to the same Paginator object.
- def <=>(page)
- fail ArgumentError unless @paginator == page.paginator
- @number <=> page.number
+ def <=>(other)
+ raise ArgumentError unless @paginator == other.paginator
+
+ @number <=> other.number
end
# Returns the item offset for the first item in this page.
# Returns a new Page object representing the page just before this
# page, or nil if this is the first page.
def previous
- if first? then nil else @paginator[@number - 1] end
+ first? ? nil : @paginator[@number - 1]
end
# Returns a new Page object representing the page just after this
# page, or nil if this is the last page.
def next
- if last? then nil else @paginator[@number + 1] end
+ last? ? nil : @paginator[@number + 1]
end
# Returns a new Window object for this page with the specified
[@paginator.items_per_page, offset]
end
- def to_param #:nodoc:
+ def to_param # :nodoc:
@number.to_s
end
end
@page = page
self.padding = padding
end
- attr_reader :paginator, :page
+ attr_reader :paginator, :page, :padding, :first, :last
# Sets the window's padding (the number of pages on either side of the
# window page).
def padding=(padding)
- @padding = padding < 0 ? 0 : padding
+ @padding = padding.negative? ? 0 : padding
# Find the beginning and end pages of the window
- @first = @paginator.has_page_number?(@page.number - @padding) ?
- @paginator[@page.number - @padding] : @paginator.first
- @last = @paginator.has_page_number?(@page.number + @padding) ?
- @paginator[@page.number + @padding] : @paginator.last
+ @first = if @paginator.contains_page?(@page.number - @padding)
+ @paginator[@page.number - @padding]
+ else
+ @paginator.first
+ end
+ @last = if @paginator.contains_page?(@page.number + @padding)
+ @paginator[@page.number + @padding]
+ else
+ @paginator.last
+ end
end
- attr_reader :padding, :first, :last
# Returns an array of Page objects in the current window.
def pages
(@first.number..@last.number).to_a.collect! { |n| @paginator[n] }
end
- alias_method :to_a, :pages
+ alias to_a pages
end
end
end
projects / rails.git / blobdiff