Contents

# frozen_string_literal: true
module Might
  # Paginates ActiveRecord scopes
  # @example
  #
  #   Paginator.new(limit: 10, offset: 100).paginate(Movie.all)
  #
  # As a side effect of pagination it defines the following methods on collection:
  #   collection#limit
  #   collection#offset
  #   collection#count
  #   collection#total_count
  #
  class Paginator
    InvalidLimitOrOffset = Class.new(StandardError)

    attr_reader :limit, :offset

    # @param [{Symbol => Integer}] params
    # @option params [Integer] :limit
    # @option params [Integer] :offset
    #
    def initialize(options = {})
      @limit = Integer(options.fetch(:limit))
      @offset = Integer(options.fetch(:offset))

      fail InvalidLimitOrOffset if @limit < 0 || @offset < 0
    end

    # Paginate given collection
    # @param [ActiveRecord::CollectionProxy, ActiveRecord::Base] collection
    # @return [ActiveRecord::CollectionProxy]
    #
    def paginate(collection)
      collection.offset(offset).limit(limit)
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
might-0.7.6	lib/might/paginator.rb
might-0.7.5	lib/might/paginator.rb
might-0.7.4	lib/might/paginator.rb
might-0.7.3	lib/might/paginator.rb
might-0.7.2	lib/might/paginator.rb