Sha256: 98dcc02602f91023761c23b88c4d83c3d06df142c46575063385a0f1cf088c60

Contents?: true

Size: 1.68 KB

Versions: 13

Compression:

Stored size: 1.68 KB

Contents

# See Pagy::Backend API documentation: https://ddnexus.github.io/pagy/docs/api/backend
# frozen_string_literal: true

class Pagy
  # Define a few generic methods to paginate a collection out of the box,
  # or any collection by overriding pagy_get_items and/or pagy_get_vars in your controller
  # See also the extras if you need specialized methods to paginate Arrays or other collections
  module Backend
    private

    # Return Pagy object and paginated items/results
    def pagy(collection, vars = {})
      pagy = Pagy.new(pagy_get_vars(collection, vars))
      [pagy, pagy_get_items(collection, pagy)]
    end

    # Sub-method called only by #pagy: here for easy customization of variables by overriding
    # You may need to override the count call for non AR collections
    def pagy_get_vars(collection, vars)
      pagy_set_items_from_params(vars) if defined?(ItemsExtra)
      vars[:count] ||= pagy_get_count(collection, vars)
      vars[:page]  ||= pagy_get_page(vars)
      vars
    end

    # Get the count from the collection
    def pagy_get_count(collection, vars)
      count_args = vars[:count_args] || DEFAULT[:count_args]
      (count     = collection.count(*count_args)).is_a?(Hash) ? count.size : count
    end

    # Get the page integer from the params
    # Overridable by the jsonapi extra
    def pagy_get_page(vars)
      [params[vars[:page_param] || DEFAULT[:page_param]].to_i, 1].max
    end

    # Sub-method called only by #pagy: here for easy customization of record-extraction by overriding
    # You may need to override this method for collections without offset|limit
    def pagy_get_items(collection, pagy)
      collection.offset(pagy.offset).limit(pagy.items)
    end
  end
end

Version data entries

13 entries across 13 versions & 1 rubygems

Version Path
pagy-8.6.3 lib/pagy/backend.rb
pagy-8.6.2 lib/pagy/backend.rb
pagy-8.6.1 lib/pagy/backend.rb
pagy-8.6.0 lib/pagy/backend.rb
pagy-8.5.0 lib/pagy/backend.rb
pagy-8.4.5 lib/pagy/backend.rb
pagy-8.4.4 lib/pagy/backend.rb
pagy-8.4.3 lib/pagy/backend.rb
pagy-8.4.2 lib/pagy/backend.rb
pagy-8.4.1 lib/pagy/backend.rb
pagy-8.3.0 lib/pagy/backend.rb
pagy-8.2.2 lib/pagy/backend.rb
pagy-8.2.1 lib/pagy/backend.rb