public
Description: Build common named scopes automatically, and provide a simple way to merge them with a single #search call.
Homepage:
Clone URL: git://github.com/technoweenie/can_search.git
Click here to lend your support to: can_search and make a donation at www.pledgie.com !
can_search / init.rb
100644 39 lines (39 sloc) 1.335 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class << ActiveRecord::Base
  # Allows you create common named_scopes and chain them together with #search and
  # #search_for.
  #
  # class Topic
  # belongs_to :forum
  #
  # can_search do
  # scoped_by :forums
  # scoped_by :created, :scope => :date_range
  # end
  #
  # # creates these two named scopes
  # # named_scope :by_forums, lambda { |f| {:conditions => {:forum_id => f}} }
  # # named_scope :created, lambda { |range| {:conditions => ...} }
  # end
  #
  # Topic.search(:forum => 1) # Topic.by_forums(1)
  # Topic.search(:forums => [1,2]) # Topic.by_forums([1,2])
  # Topic.search(:created => (time1..time2)) # Topic.created(time1..time2)
  # Topic.search(:created => \
  # {:period => :daily, :start => Time.now}) # Topic.created(Time.now, Time.now + 1.day)
  #
  # You can automatically paginate:
  #
  # Topic.search :forum => 1, :page => params[:page]
  #
  # You can also access the named_scope directly for custom #find or #calculate calls.
  #
  # Topic.search_for(:forum => 1).sum(:hits)
  #
  # Oh, and you can combine scopes:
  #
  # Topic.search :forum => 1, :forums => [2, 3], :created => (time1..time2)
  #
  def can_search(&block)
    self.search_scopes = CanSearch::SearchScopes.new(self, &block)
  end
end