WillPaginate::ActiveRecord::RelationMethods

makes a Relation look like WillPaginate::Collection

Attributes

current_page[RW]
total_entries[W]
wp_count_options[W]

Public Instance Methods

clone() click to toggle source
# File lib/will_paginate/active_record.rb, line 94
def clone
  copy_will_paginate_data super
end
count() click to toggle source
# File lib/will_paginate/active_record.rb, line 61
def count
  if limit_value
    excluded = [:order, :limit, :offset]
    excluded << :includes unless eager_loading?
    rel = self.except(*excluded)
    # TODO: hack. decide whether to keep
    rel = rel.apply_finder_options(@wp_count_options) if defined? @wp_count_options
    rel.count
  else
    super
  end
end
empty?() click to toggle source

overloaded to be pagination-aware

# File lib/will_paginate/active_record.rb, line 84
def empty?
  if !loaded? and offset_value
    result = count
    result = result.size if result.respond_to?(:size) and !result.is_a?(Integer)
    result <= offset_value
  else
    super
  end
end
limit(num) click to toggle source

TODO: solve with less relation clones and code dups

# File lib/will_paginate/active_record.rb, line 33
def limit(num)
  rel = super
  if rel.current_page
    rel.offset rel.current_page.to_offset(rel.limit_value).to_i
  else
    rel
  end
end
offset(value = nil) click to toggle source
# File lib/will_paginate/active_record.rb, line 42
def offset(value = nil)
  if value.nil? then offset_value
  else super(value)
  end
end
per_page(value = nil) click to toggle source
# File lib/will_paginate/active_record.rb, line 26
def per_page(value = nil)
  if value.nil? then limit_value
  else limit(value)
  end
end
scoped(options = nil) click to toggle source

workaround for Active Record 3.0

# File lib/will_paginate/active_record.rb, line 99
def scoped(options = nil)
  copy_will_paginate_data super
end
size() click to toggle source

workaround for Active Record 3.0

# File lib/will_paginate/active_record.rb, line 75
def size
  if !loaded? and limit_value and group_values.empty?
    [super, limit_value].min
  else
    super
  end
end
to_a() click to toggle source
# File lib/will_paginate/active_record.rb, line 103
def to_a
  if current_page.nil? then super # workaround for Active Record 3.0
  else
    ::WillPaginate::Collection.create(current_page, limit_value) do |col|
      col.replace super
      col.total_entries ||= total_entries
    end
  end
end
total_entries() click to toggle source
# File lib/will_paginate/active_record.rb, line 48
def total_entries
  @total_entries ||= begin
    if loaded? and size < limit_value and (current_page == 1 or size > 0)
      offset_value + size
    else
      @total_entries_queried = true
      result = count
      result = result.size if result.respond_to?(:size) and !result.is_a?(Integer)
      result
    end
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.