will-couchrest 0.32.1
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +176 -0
- data/README.md +165 -0
- data/Rakefile +74 -0
- data/THANKS.md +18 -0
- data/examples/model/example.rb +144 -0
- data/examples/word_count/markov +38 -0
- data/examples/word_count/views/books/chunked-map.js +3 -0
- data/examples/word_count/views/books/united-map.js +1 -0
- data/examples/word_count/views/markov/chain-map.js +6 -0
- data/examples/word_count/views/markov/chain-reduce.js +7 -0
- data/examples/word_count/views/word_count/count-map.js +6 -0
- data/examples/word_count/views/word_count/count-reduce.js +3 -0
- data/examples/word_count/word_count.rb +46 -0
- data/examples/word_count/word_count_query.rb +40 -0
- data/examples/word_count/word_count_views.rb +26 -0
- data/history.txt +65 -0
- data/lib/couchrest.rb +199 -0
- data/lib/couchrest/commands/generate.rb +71 -0
- data/lib/couchrest/commands/push.rb +103 -0
- data/lib/couchrest/core/adapters/restclient.rb +35 -0
- data/lib/couchrest/core/database.rb +317 -0
- data/lib/couchrest/core/design.rb +79 -0
- data/lib/couchrest/core/document.rb +83 -0
- data/lib/couchrest/core/http_abstraction.rb +48 -0
- data/lib/couchrest/core/response.rb +16 -0
- data/lib/couchrest/core/server.rb +88 -0
- data/lib/couchrest/core/view.rb +4 -0
- data/lib/couchrest/helper/pager.rb +103 -0
- data/lib/couchrest/helper/streamer.rb +44 -0
- data/lib/couchrest/helper/upgrade.rb +51 -0
- data/lib/couchrest/mixins.rb +4 -0
- data/lib/couchrest/mixins/attachments.rb +31 -0
- data/lib/couchrest/mixins/callbacks.rb +483 -0
- data/lib/couchrest/mixins/class_proxy.rb +116 -0
- data/lib/couchrest/mixins/collection.rb +225 -0
- data/lib/couchrest/mixins/design_doc.rb +103 -0
- data/lib/couchrest/mixins/document_queries.rb +82 -0
- data/lib/couchrest/mixins/extended_attachments.rb +74 -0
- data/lib/couchrest/mixins/extended_document_mixins.rb +8 -0
- data/lib/couchrest/mixins/properties.rb +158 -0
- data/lib/couchrest/mixins/validation.rb +257 -0
- data/lib/couchrest/mixins/views.rb +173 -0
- data/lib/couchrest/monkeypatches.rb +113 -0
- data/lib/couchrest/more/casted_model.rb +29 -0
- data/lib/couchrest/more/extended_document.rb +246 -0
- data/lib/couchrest/more/property.rb +40 -0
- data/lib/couchrest/support/blank.rb +42 -0
- data/lib/couchrest/support/class.rb +176 -0
- data/lib/couchrest/support/rails.rb +35 -0
- data/lib/couchrest/validation/auto_validate.rb +161 -0
- data/lib/couchrest/validation/contextual_validators.rb +78 -0
- data/lib/couchrest/validation/validation_errors.rb +125 -0
- data/lib/couchrest/validation/validators/absent_field_validator.rb +74 -0
- data/lib/couchrest/validation/validators/confirmation_validator.rb +99 -0
- data/lib/couchrest/validation/validators/format_validator.rb +117 -0
- data/lib/couchrest/validation/validators/formats/email.rb +66 -0
- data/lib/couchrest/validation/validators/formats/url.rb +43 -0
- data/lib/couchrest/validation/validators/generic_validator.rb +120 -0
- data/lib/couchrest/validation/validators/length_validator.rb +134 -0
- data/lib/couchrest/validation/validators/method_validator.rb +89 -0
- data/lib/couchrest/validation/validators/numeric_validator.rb +104 -0
- data/lib/couchrest/validation/validators/required_field_validator.rb +109 -0
- data/spec/couchrest/core/couchrest_spec.rb +201 -0
- data/spec/couchrest/core/database_spec.rb +700 -0
- data/spec/couchrest/core/design_spec.rb +138 -0
- data/spec/couchrest/core/document_spec.rb +267 -0
- data/spec/couchrest/core/server_spec.rb +35 -0
- data/spec/couchrest/helpers/pager_spec.rb +122 -0
- data/spec/couchrest/helpers/streamer_spec.rb +23 -0
- data/spec/couchrest/more/casted_extended_doc_spec.rb +75 -0
- data/spec/couchrest/more/casted_model_spec.rb +177 -0
- data/spec/couchrest/more/extended_doc_attachment_spec.rb +135 -0
- data/spec/couchrest/more/extended_doc_spec.rb +588 -0
- data/spec/couchrest/more/extended_doc_subclass_spec.rb +98 -0
- data/spec/couchrest/more/extended_doc_view_spec.rb +426 -0
- data/spec/couchrest/more/property_spec.rb +169 -0
- data/spec/fixtures/attachments/README +3 -0
- data/spec/fixtures/attachments/couchdb.png +0 -0
- data/spec/fixtures/attachments/test.html +11 -0
- data/spec/fixtures/more/article.rb +34 -0
- data/spec/fixtures/more/card.rb +22 -0
- data/spec/fixtures/more/cat.rb +18 -0
- data/spec/fixtures/more/course.rb +14 -0
- data/spec/fixtures/more/event.rb +6 -0
- data/spec/fixtures/more/invoice.rb +17 -0
- data/spec/fixtures/more/person.rb +8 -0
- data/spec/fixtures/more/question.rb +6 -0
- data/spec/fixtures/more/service.rb +12 -0
- data/spec/fixtures/views/lib.js +3 -0
- data/spec/fixtures/views/test_view/lib.js +3 -0
- data/spec/fixtures/views/test_view/only-map.js +4 -0
- data/spec/fixtures/views/test_view/test-map.js +3 -0
- data/spec/fixtures/views/test_view/test-reduce.js +3 -0
- data/spec/spec.opts +6 -0
- data/spec/spec_helper.rb +37 -0
- data/utils/remap.rb +27 -0
- data/utils/subset.rb +30 -0
- metadata +198 -0
@@ -0,0 +1,116 @@
|
|
1
|
+
module CouchRest
|
2
|
+
module Mixins
|
3
|
+
module ClassProxy
|
4
|
+
|
5
|
+
def self.included(base)
|
6
|
+
base.extend(ClassMethods)
|
7
|
+
end
|
8
|
+
|
9
|
+
module ClassMethods
|
10
|
+
|
11
|
+
# Return a proxy object which represents a model class on a
|
12
|
+
# chosen database instance. This allows you to DRY operations
|
13
|
+
# where a database is chosen dynamically.
|
14
|
+
#
|
15
|
+
# ==== Example:
|
16
|
+
#
|
17
|
+
# db = CouchRest::Database.new(...)
|
18
|
+
# articles = Article.on(db)
|
19
|
+
#
|
20
|
+
# articles.all { ... }
|
21
|
+
# articles.by_title { ... }
|
22
|
+
#
|
23
|
+
# u = articles.get("someid")
|
24
|
+
#
|
25
|
+
# u = articles.new(:title => "I like plankton")
|
26
|
+
# u.save # saved on the correct database
|
27
|
+
|
28
|
+
def on(database)
|
29
|
+
Proxy.new(self, database)
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
class Proxy #:nodoc:
|
34
|
+
def initialize(klass, database)
|
35
|
+
@klass = klass
|
36
|
+
@database = database
|
37
|
+
end
|
38
|
+
|
39
|
+
# ExtendedDocument
|
40
|
+
|
41
|
+
def new(*args)
|
42
|
+
doc = @klass.new(*args)
|
43
|
+
doc.database = @database
|
44
|
+
doc
|
45
|
+
end
|
46
|
+
|
47
|
+
def method_missing(m, *args, &block)
|
48
|
+
if has_view?(m)
|
49
|
+
query = args.shift || {}
|
50
|
+
view(m, query, *args, &block)
|
51
|
+
else
|
52
|
+
super
|
53
|
+
end
|
54
|
+
end
|
55
|
+
|
56
|
+
# Mixins::DocumentQueries
|
57
|
+
|
58
|
+
def all(opts = {}, &block)
|
59
|
+
@klass.all({:database => @database}.merge(opts), &block)
|
60
|
+
end
|
61
|
+
|
62
|
+
def count(opts = {}, &block)
|
63
|
+
@klass.all({:database => @database, :raw => true, :limit => 0}.merge(opts), &block)['total_rows']
|
64
|
+
end
|
65
|
+
|
66
|
+
def first(opts = {})
|
67
|
+
@klass.first({:database => @database}.merge(opts))
|
68
|
+
end
|
69
|
+
|
70
|
+
def get(id)
|
71
|
+
@klass.get(id, @database)
|
72
|
+
end
|
73
|
+
|
74
|
+
# Mixins::Views
|
75
|
+
|
76
|
+
def has_view?(view)
|
77
|
+
@klass.has_view?(view)
|
78
|
+
end
|
79
|
+
|
80
|
+
def view(name, query={}, &block)
|
81
|
+
@klass.view(name, {:database => @database}.merge(query), &block)
|
82
|
+
end
|
83
|
+
|
84
|
+
def all_design_doc_versions
|
85
|
+
@klass.all_design_doc_versions(@database)
|
86
|
+
end
|
87
|
+
|
88
|
+
def model_design_doc
|
89
|
+
@klass.model_design_doc(@database)
|
90
|
+
end
|
91
|
+
|
92
|
+
def cleanup_design_docs!
|
93
|
+
@klass.cleanup_design_docs!(@database)
|
94
|
+
end
|
95
|
+
|
96
|
+
# Mixins::DesignDoc
|
97
|
+
|
98
|
+
def design_doc
|
99
|
+
@klass.design_doc
|
100
|
+
end
|
101
|
+
|
102
|
+
def design_doc_fresh
|
103
|
+
@klass.design_doc_fresh
|
104
|
+
end
|
105
|
+
|
106
|
+
def refresh_design_doc
|
107
|
+
@klass.refresh_design_doc_on(@database)
|
108
|
+
end
|
109
|
+
|
110
|
+
def save_design_doc
|
111
|
+
@klass.save_design_doc_on(@database)
|
112
|
+
end
|
113
|
+
end
|
114
|
+
end
|
115
|
+
end
|
116
|
+
end
|
@@ -0,0 +1,225 @@
|
|
1
|
+
module CouchRest
|
2
|
+
module Mixins
|
3
|
+
module Collection
|
4
|
+
|
5
|
+
def self.included(base)
|
6
|
+
base.extend(ClassMethods)
|
7
|
+
end
|
8
|
+
|
9
|
+
module ClassMethods
|
10
|
+
|
11
|
+
# Creates a new class method, find_all_<collection_name>, that will
|
12
|
+
# execute the view specified with the design_doc and view_name
|
13
|
+
# parameters, along with the specified view_options. This method will
|
14
|
+
# return the results of the view as an Array of objects which are
|
15
|
+
# instances of the class.
|
16
|
+
#
|
17
|
+
# This method is handy for objects that do not use the view_by method
|
18
|
+
# to declare their views.
|
19
|
+
def provides_collection(collection_name, design_doc, view_name, view_options)
|
20
|
+
class_eval <<-END, __FILE__, __LINE__ + 1
|
21
|
+
def self.find_all_#{collection_name}(options = {})
|
22
|
+
view_options = #{view_options.inspect} || {}
|
23
|
+
CollectionProxy.new(@database, "#{design_doc}", "#{view_name}", view_options.merge(options), Kernel.const_get('#{self}'))
|
24
|
+
end
|
25
|
+
END
|
26
|
+
end
|
27
|
+
|
28
|
+
# Fetch a group of objects from CouchDB. Options can include:
|
29
|
+
# :page - Specifies the page to load (starting at 1)
|
30
|
+
# :per_page - Specifies the number of objects to load per page
|
31
|
+
#
|
32
|
+
# Defaults are used if these options are not specified.
|
33
|
+
def paginate(options)
|
34
|
+
proxy = create_collection_proxy(options)
|
35
|
+
proxy.paginate(options)
|
36
|
+
end
|
37
|
+
|
38
|
+
# Iterate over the objects in a collection, fetching them from CouchDB
|
39
|
+
# in groups. Options can include:
|
40
|
+
# :page - Specifies the page to load
|
41
|
+
# :per_page - Specifies the number of objects to load per page
|
42
|
+
#
|
43
|
+
# Defaults are used if these options are not specified.
|
44
|
+
def paginated_each(options, &block)
|
45
|
+
proxy = create_collection_proxy(options)
|
46
|
+
proxy.paginated_each(options, &block)
|
47
|
+
end
|
48
|
+
|
49
|
+
# Create a CollectionProxy for the specified view and options.
|
50
|
+
# CollectionProxy behaves just like an Array, but offers support for
|
51
|
+
# pagination.
|
52
|
+
def collection_proxy_for(design_doc, view_name, view_options = {})
|
53
|
+
options = view_options.merge(:design_doc => design_doc, :view_name => view_name)
|
54
|
+
create_collection_proxy(options)
|
55
|
+
end
|
56
|
+
|
57
|
+
private
|
58
|
+
|
59
|
+
def create_collection_proxy(options)
|
60
|
+
design_doc, view_name, view_options = parse_view_options(options)
|
61
|
+
CollectionProxy.new(@database, design_doc, view_name, view_options, self)
|
62
|
+
end
|
63
|
+
|
64
|
+
def parse_view_options(options)
|
65
|
+
design_doc = options.delete(:design_doc)
|
66
|
+
raise ArgumentError, 'design_doc is required' if design_doc.nil?
|
67
|
+
|
68
|
+
view_name = options.delete(:view_name)
|
69
|
+
raise ArgumentError, 'view_name is required' if view_name.nil?
|
70
|
+
|
71
|
+
default_view_options = (design_doc.class == Design &&
|
72
|
+
design_doc['views'][view_name.to_s] &&
|
73
|
+
design_doc['views'][view_name.to_s]["couchrest-defaults"]) || {}
|
74
|
+
view_options = default_view_options.merge(options)
|
75
|
+
|
76
|
+
[design_doc, view_name, view_options]
|
77
|
+
end
|
78
|
+
end
|
79
|
+
|
80
|
+
class CollectionProxy
|
81
|
+
alias_method :proxy_respond_to?, :respond_to?
|
82
|
+
instance_methods.each { |m| undef_method m unless m =~ /(^__|^nil\?$|^send$|proxy_|^object_id$)/ }
|
83
|
+
|
84
|
+
DEFAULT_PAGE = 1
|
85
|
+
DEFAULT_PER_PAGE = 30
|
86
|
+
|
87
|
+
attr_accessor :amount_pages
|
88
|
+
|
89
|
+
# Create a new CollectionProxy to represent the specified view. If a
|
90
|
+
# container class is specified, the proxy will create an object of the
|
91
|
+
# given type for each row that comes back from the view. If no
|
92
|
+
# container class is specified, the raw results are returned.
|
93
|
+
#
|
94
|
+
# The CollectionProxy provides support for paginating over a collection
|
95
|
+
# via the paginate, and paginated_each methods.
|
96
|
+
def initialize(database, design_doc, view_name, view_options = {}, container_class = nil)
|
97
|
+
raise ArgumentError, "database is a required parameter" if database.nil?
|
98
|
+
|
99
|
+
@database = database
|
100
|
+
@container_class = container_class
|
101
|
+
|
102
|
+
strip_pagination_options(view_options)
|
103
|
+
@view_options = view_options
|
104
|
+
|
105
|
+
if design_doc.class == Design
|
106
|
+
@view_name = "#{design_doc.name}/#{view_name}"
|
107
|
+
else
|
108
|
+
@view_name = "#{design_doc}/#{view_name}"
|
109
|
+
end
|
110
|
+
end
|
111
|
+
|
112
|
+
# See Collection.paginate
|
113
|
+
def paginate(options = {})
|
114
|
+
page, per_page = parse_options(options)
|
115
|
+
results = @database.view(@view_name, pagination_options(page, per_page))
|
116
|
+
@amount_pages ||= (results['total_rows'].to_f / per_page.to_f).ceil
|
117
|
+
remember_where_we_left_off(results, page)
|
118
|
+
convert_to_container_array(results)
|
119
|
+
end
|
120
|
+
|
121
|
+
# See Collection.paginated_each
|
122
|
+
def paginated_each(options = {}, &block)
|
123
|
+
page, per_page = parse_options(options)
|
124
|
+
|
125
|
+
begin
|
126
|
+
collection = paginate({:page => page, :per_page => per_page})
|
127
|
+
collection.each(&block)
|
128
|
+
page += 1
|
129
|
+
end until collection.size < per_page
|
130
|
+
end
|
131
|
+
|
132
|
+
def respond_to?(*args)
|
133
|
+
proxy_respond_to?(*args) || (load_target && @target.respond_to?(*args))
|
134
|
+
end
|
135
|
+
|
136
|
+
# Explicitly proxy === because the instance method removal above
|
137
|
+
# doesn't catch it.
|
138
|
+
def ===(other)
|
139
|
+
load_target
|
140
|
+
other === @target
|
141
|
+
end
|
142
|
+
|
143
|
+
private
|
144
|
+
|
145
|
+
def method_missing(method, *args)
|
146
|
+
if load_target
|
147
|
+
if block_given?
|
148
|
+
@target.send(method, *args) { |*block_args| yield(*block_args) }
|
149
|
+
else
|
150
|
+
@target.send(method, *args)
|
151
|
+
end
|
152
|
+
end
|
153
|
+
end
|
154
|
+
|
155
|
+
def load_target
|
156
|
+
unless loaded?
|
157
|
+
results = @database.view(@view_name, @view_options)
|
158
|
+
@target = convert_to_container_array(results)
|
159
|
+
end
|
160
|
+
@loaded = true
|
161
|
+
@target
|
162
|
+
end
|
163
|
+
|
164
|
+
def loaded?
|
165
|
+
@loaded
|
166
|
+
end
|
167
|
+
|
168
|
+
def reload
|
169
|
+
reset
|
170
|
+
load_target
|
171
|
+
self unless @target.nil?
|
172
|
+
end
|
173
|
+
|
174
|
+
def reset
|
175
|
+
@loaded = false
|
176
|
+
@target = nil
|
177
|
+
end
|
178
|
+
|
179
|
+
def inspect
|
180
|
+
load_target
|
181
|
+
@target.inspect
|
182
|
+
end
|
183
|
+
|
184
|
+
def convert_to_container_array(results)
|
185
|
+
if @container_class.nil?
|
186
|
+
results
|
187
|
+
else
|
188
|
+
results['rows'].collect { |row| @container_class.new(row['doc']) } unless results['rows'].nil?
|
189
|
+
end
|
190
|
+
end
|
191
|
+
|
192
|
+
def pagination_options(page, per_page)
|
193
|
+
view_options = @view_options.clone
|
194
|
+
if @last_key && @last_docid && @last_page == page - 1
|
195
|
+
view_options.delete(:key)
|
196
|
+
options = { :startkey => @last_key, :startkey_docid => @last_docid, :limit => per_page, :skip => 1 }
|
197
|
+
else
|
198
|
+
options = { :limit => per_page, :skip => per_page * (page - 1) }
|
199
|
+
end
|
200
|
+
view_options.merge(options)
|
201
|
+
end
|
202
|
+
|
203
|
+
def parse_options(options)
|
204
|
+
page = options.delete(:page) || DEFAULT_PAGE
|
205
|
+
per_page = options.delete(:per_page) || DEFAULT_PER_PAGE
|
206
|
+
[page.to_i, per_page.to_i]
|
207
|
+
end
|
208
|
+
|
209
|
+
def strip_pagination_options(options)
|
210
|
+
parse_options(options)
|
211
|
+
end
|
212
|
+
|
213
|
+
def remember_where_we_left_off(results, page)
|
214
|
+
last_row = results['rows'].last
|
215
|
+
if last_row
|
216
|
+
@last_key = last_row['key']
|
217
|
+
@last_docid = last_row['id']
|
218
|
+
end
|
219
|
+
@last_page = page
|
220
|
+
end
|
221
|
+
end
|
222
|
+
|
223
|
+
end
|
224
|
+
end
|
225
|
+
end
|
@@ -0,0 +1,103 @@
|
|
1
|
+
require 'digest/md5'
|
2
|
+
|
3
|
+
module CouchRest
|
4
|
+
module Mixins
|
5
|
+
module DesignDoc
|
6
|
+
|
7
|
+
def self.included(base)
|
8
|
+
base.extend(ClassMethods)
|
9
|
+
end
|
10
|
+
|
11
|
+
module ClassMethods
|
12
|
+
attr_accessor :design_doc, :design_doc_slug_cache, :design_doc_fresh
|
13
|
+
|
14
|
+
def design_doc
|
15
|
+
@design_doc ||= Design.new(default_design_doc)
|
16
|
+
end
|
17
|
+
|
18
|
+
def design_doc_id
|
19
|
+
"_design/#{design_doc_slug}"
|
20
|
+
end
|
21
|
+
|
22
|
+
def design_doc_slug
|
23
|
+
return design_doc_slug_cache if (design_doc_slug_cache && design_doc_fresh)
|
24
|
+
funcs = []
|
25
|
+
design_doc['views'].each do |name, view|
|
26
|
+
funcs << "#{name}/#{view['map']}#{view['reduce']}"
|
27
|
+
end
|
28
|
+
self.design_doc_slug_cache = self.to_s
|
29
|
+
end
|
30
|
+
|
31
|
+
def default_design_doc
|
32
|
+
{
|
33
|
+
"language" => "javascript",
|
34
|
+
"views" => {
|
35
|
+
'all' => {
|
36
|
+
'map' => "function(doc) {
|
37
|
+
if (doc['couchrest-type'] == '#{self.to_s}') {
|
38
|
+
emit(doc['_id'],1);
|
39
|
+
}
|
40
|
+
}"
|
41
|
+
}
|
42
|
+
}
|
43
|
+
}
|
44
|
+
end
|
45
|
+
|
46
|
+
def refresh_design_doc
|
47
|
+
reset_design_doc
|
48
|
+
save_design_doc
|
49
|
+
end
|
50
|
+
|
51
|
+
def refresh_design_doc_on(db)
|
52
|
+
reset_design_doc
|
53
|
+
save_design_doc_on(db)
|
54
|
+
end
|
55
|
+
|
56
|
+
# Save the design doc onto the default database, and update the
|
57
|
+
# design_doc attribute
|
58
|
+
def save_design_doc
|
59
|
+
reset_design_doc unless design_doc_fresh
|
60
|
+
self.design_doc = update_design_doc(design_doc)
|
61
|
+
end
|
62
|
+
|
63
|
+
# Save the design doc onto a target database in a thread-safe way,
|
64
|
+
# not modifying the model's design_doc
|
65
|
+
def save_design_doc_on(db)
|
66
|
+
update_design_doc(Design.new(design_doc), db)
|
67
|
+
end
|
68
|
+
|
69
|
+
private
|
70
|
+
|
71
|
+
def reset_design_doc
|
72
|
+
current = self.database.get(design_doc_id) rescue nil
|
73
|
+
design_doc['_id'] = design_doc_id
|
74
|
+
if current.nil?
|
75
|
+
design_doc.delete('_rev')
|
76
|
+
else
|
77
|
+
design_doc['_rev'] = current['_rev']
|
78
|
+
end
|
79
|
+
self.design_doc_fresh = true
|
80
|
+
end
|
81
|
+
|
82
|
+
# Writes out a design_doc to a given database, returning the
|
83
|
+
# updated design doc
|
84
|
+
def update_design_doc(design_doc, db = database)
|
85
|
+
saved = db.get(design_doc['_id']) rescue nil
|
86
|
+
if saved
|
87
|
+
design_doc['views'].each do |name, view|
|
88
|
+
saved['views'][name] = view
|
89
|
+
end
|
90
|
+
db.save_doc(saved)
|
91
|
+
saved
|
92
|
+
else
|
93
|
+
design_doc.database = db
|
94
|
+
design_doc.save
|
95
|
+
design_doc
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
end # module ClassMethods
|
100
|
+
|
101
|
+
end
|
102
|
+
end
|
103
|
+
end
|
@@ -0,0 +1,82 @@
|
|
1
|
+
module CouchRest
|
2
|
+
module Mixins
|
3
|
+
module DocumentQueries
|
4
|
+
|
5
|
+
def self.included(base)
|
6
|
+
base.extend(ClassMethods)
|
7
|
+
end
|
8
|
+
|
9
|
+
module ClassMethods
|
10
|
+
|
11
|
+
# Load all documents that have the "couchrest-type" field equal to the
|
12
|
+
# name of the current class. Take the standard set of
|
13
|
+
# CouchRest::Database#view options.
|
14
|
+
def all(opts = {}, &block)
|
15
|
+
view(:all, opts, &block)
|
16
|
+
end
|
17
|
+
|
18
|
+
# Returns the number of documents that have the "couchrest-type" field
|
19
|
+
# equal to the name of the current class. Takes the standard set of
|
20
|
+
# CouchRest::Database#view options
|
21
|
+
def count(opts = {}, &block)
|
22
|
+
all({:raw => true, :limit => 0}.merge(opts), &block)['total_rows']
|
23
|
+
end
|
24
|
+
|
25
|
+
# Load the first document that have the "couchrest-type" field equal to
|
26
|
+
# the name of the current class.
|
27
|
+
#
|
28
|
+
# ==== Returns
|
29
|
+
# Object:: The first object instance available
|
30
|
+
# or
|
31
|
+
# Nil:: if no instances available
|
32
|
+
#
|
33
|
+
# ==== Parameters
|
34
|
+
# opts<Hash>::
|
35
|
+
# View options, see <tt>CouchRest::Database#view</tt> options for more info.
|
36
|
+
def first(opts = {})
|
37
|
+
first_instance = self.all(opts.merge!(:limit => 1))
|
38
|
+
first_instance.empty? ? nil : first_instance.first
|
39
|
+
end
|
40
|
+
|
41
|
+
# Load a document from the database by id
|
42
|
+
# No exceptions will be raised if the document isn't found
|
43
|
+
#
|
44
|
+
# ==== Returns
|
45
|
+
# Object:: if the document was found
|
46
|
+
# or
|
47
|
+
# Nil::
|
48
|
+
#
|
49
|
+
# === Parameters
|
50
|
+
# id<String, Integer>:: Document ID
|
51
|
+
# db<Database>:: optional option to pass a custom database to use
|
52
|
+
def get(id, db = database)
|
53
|
+
begin
|
54
|
+
doc = db.get id
|
55
|
+
rescue
|
56
|
+
nil
|
57
|
+
else
|
58
|
+
new(doc)
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
62
|
+
# Load a document from the database by id
|
63
|
+
# An exception will be raised if the document isn't found
|
64
|
+
#
|
65
|
+
# ==== Returns
|
66
|
+
# Object:: if the document was found
|
67
|
+
# or
|
68
|
+
# Exception
|
69
|
+
#
|
70
|
+
# === Parameters
|
71
|
+
# id<String, Integer>:: Document ID
|
72
|
+
# db<Database>:: optional option to pass a custom database to use
|
73
|
+
def get!(id, db = database)
|
74
|
+
doc = db.get id
|
75
|
+
new(doc)
|
76
|
+
end
|
77
|
+
|
78
|
+
end
|
79
|
+
|
80
|
+
end
|
81
|
+
end
|
82
|
+
end
|