Module: Shamu::Entities::ListScope::Paging

Defined in:

lib/shamu/entities/list_scope/paging.rb

Overview

Include paging parsing and attributes. Adds the following attributes to the list scope:

class UsersListScope < Shamu::Entities::ListScope
  include Shamu::Entities::ListScope::Paging
end

scope = UsersListScope.coerce!( params )
scope.page      # => 1
scope.per_page # => 25

Attributes

• #default_per_page ⇒ Integer

  Default number of records per page if not provided.

• #page ⇒ Integer

  The current page number.

• #per_page ⇒ Integer

  Number of records per page.

Instance Method Summary

• #paged? ⇒ Boolean

  True if the scope is paged.

Instance Attribute Details

#default_per_page ⇒ Integer

# File 'lib/shamu/entities/list_scope/paging.rb', line 29

#page ⇒ Integer

# File 'lib/shamu/entities/list_scope/paging.rb', line 23

#per_page ⇒ Integer

# File 'lib/shamu/entities/list_scope/paging.rb', line 26

Instance Method Details

#paged? ⇒ Boolean

# File 'lib/shamu/entities/list_scope/paging.rb', line 44

def paged?
  !!page
end