Module: SearchObject::Base

Defined in:
lib/search_object/base.rb

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object



3
4
5
6
7
8
9
10
11
12
# File 'lib/search_object/base.rb', line 3

def self.included(base)
  base.extend ClassMethods
  base.instance_eval do
    @config = {
      defaults:  {},
      actions:   {},
      scope:     nil
    }
  end
end

Instance Method Details

#countObject



33
34
35
# File 'lib/search_object/base.rb', line 33

def count
  @count ||= @search.count self
end

#initialize(options = {}) ⇒ Object

Raises:



14
15
16
17
18
19
20
21
22
23
# File 'lib/search_object/base.rb', line 14

def initialize(options = {})
  config = self.class.config
  scope  = options[:scope] || (config[:scope] && instance_eval(&config[:scope]))
  actions = config[:actions] || {}
  params  = Helper.normalize_params(config[:defaults], options[:filters], actions.keys)

  raise MissingScopeError unless scope

  @search = Search.new(scope, params, actions)
end

#params(additions = {}) ⇒ Object



37
38
39
40
41
42
43
# File 'lib/search_object/base.rb', line 37

def params(additions = {})
  if additions.empty?
    @search.params
  else
    @search.params.merge Helper.stringify_keys(additions)
  end
end

#resultsObject



25
26
27
# File 'lib/search_object/base.rb', line 25

def results
  @results ||= fetch_results
end

#results?Boolean

Returns:

  • (Boolean)


29
30
31
# File 'lib/search_object/base.rb', line 29

def results?
  results.any?
end