X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/16f5a5ac0c674b258996fcbde1c3fda2e651906a..6bc81dc3e7f423a29003d12732599351a75d931a:/lib/classic_pagination/pagination.rb diff --git a/lib/classic_pagination/pagination.rb b/lib/classic_pagination/pagination.rb index 44366d552..c7022e0b0 100644 --- a/lib/classic_pagination/pagination.rb +++ b/lib/classic_pagination/pagination.rb @@ -67,35 +67,36 @@ module ActionController 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" + :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 - raise 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]) @@ -135,7 +136,7 @@ module ActionController # 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 :actions option). # @@ -146,16 +147,18 @@ module ActionController 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 if options[:actions] && !options[:actions].include?(action_name) + next if options[:actions]&.exclude?(action_name) paginator, collection = paginator_and_collection_for(collection_id, options) @@ -199,11 +202,9 @@ module ActionController 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) @@ -213,8 +214,6 @@ module ActionController [paginator, collection] end - private :paginator_and_collection_for - # A class representing a paginator for an Active Record collection. class Paginator include Enumerable @@ -241,12 +240,10 @@ module ActionController # 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 - raise 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. @@ -273,14 +270,14 @@ module ActionController 1 else q, r = @item_count.divmod(@items_per_page) - r == 0 ? q : q + 1 + r.zero? ? q : q + 1 end end 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 @@ -307,9 +304,10 @@ module ActionController 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 to_i number # Compares two Page objects and returns true when they represent the @@ -317,6 +315,7 @@ module ActionController # same page number). def ==(other) return false if other.nil? + @paginator == other.paginator && @number == other.number end @@ -327,6 +326,7 @@ module ActionController # if the pages do not belong to the same Paginator object. def <=>(other) raise ArgumentError unless @paginator == other.paginator + @number <=> other.number end @@ -378,7 +378,7 @@ module ActionController [@paginator.items_per_page, offset] end - def to_param #:nodoc: + def to_param # :nodoc: @number.to_s end end @@ -392,25 +392,24 @@ module ActionController @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 = if @paginator.has_page_number?(@page.number - @padding) + @first = if @paginator.contains_page?(@page.number - @padding) @paginator[@page.number - @padding] else @paginator.first end - @last = if @paginator.has_page_number?(@page.number + @padding) + @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