Class: CouchModel::View

Inherits:
Object
  • Object
show all
Defined in:
lib/couch_model/view.rb

Overview

The View class acts as a wrapper for the views that are in the CouchDB design document. It also provides methods to generate simple view javascript functions.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(design, attributes = { }) ⇒ View

Returns a new instance of View.



15
16
17
18
19
20
21
22
 
# File 'lib/couch_model/view.rb', line 15

def initialize(design, attributes = { })
  @design = design
  @name   = attributes[:name]

  generate_functions attributes
  @map    = attributes[:map]    if attributes.has_key?(:map)
  @reduce = attributes[:reduce] if attributes.has_key?(:reduce)
end

Instance Attribute Details

#design ⇒ Object (readonly)

Returns the value of attribute design.



10
11
12
 
# File 'lib/couch_model/view.rb', line 10

def design
  @design
end

#map ⇒ Object

Returns the value of attribute map.



12
13
14
 
# File 'lib/couch_model/view.rb', line 12

def map
  @map
end

#name ⇒ Object

Returns the value of attribute name.



11
12
13
 
# File 'lib/couch_model/view.rb', line 11

def name
  @name
end

#reduce ⇒ Object

Returns the value of attribute reduce.



13
14
15
 
# File 'lib/couch_model/view.rb', line 13

def reduce
  @reduce
end

Class Method Details

.generate_map_function(model_class, keys) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/couch_model/view.rb', line 42

def self.generate_map_function(model_class, keys)
  emit_values  = keys.map{ |key| "document['#{key}']" }
  check_values = emit_values.select{ |value| value != "document['_id']" }

"""function(document) {
  if (document['#{Configuration::CLASS_KEY}'] == '#{model_class.to_s}'#{check_values.empty? ? "" : " && " + check_values.join(" && ")}) {
emit(#{emit_values.size == 1 ? emit_values.first : "[ " + emit_values.join(", ") + " ]"}, null);
  }
}
"""
end

Instance Method Details

#collection(options = { }) ⇒ Object 



24
25
26
 
# File 'lib/couch_model/view.rb', line 24

def collection(options = { })
  Collection.new url, options
end

#generate_functions(options = { }) ⇒ Object 



36
37
38
39
40
 
# File 'lib/couch_model/view.rb', line 36

def generate_functions(options = { })
  keys = [ (options[:keys] || "_id") ].flatten
  @map = self.class.generate_map_function @design.model_class, keys
  @reduce = nil
end

#to_hash ⇒ Object 



28
29
30
 
# File 'lib/couch_model/view.rb', line 28

def to_hash
  { self.name => { "map" => self.map, "reduce" => self.reduce } }
end

#url ⇒ Object 



32
33
34
 
# File 'lib/couch_model/view.rb', line 32

def url
  "#{@design.url}/_view/#{@name}"
end