davber_couchrest_extended_document 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. data/LICENSE +176 -0
  2. data/README.md +250 -0
  3. data/Rakefile +69 -0
  4. data/THANKS.md +22 -0
  5. data/examples/model/example.rb +144 -0
  6. data/history.txt +165 -0
  7. data/lib/couchrest/casted_array.rb +39 -0
  8. data/lib/couchrest/casted_model.rb +53 -0
  9. data/lib/couchrest/extended_document.rb +262 -0
  10. data/lib/couchrest/mixins.rb +12 -0
  11. data/lib/couchrest/mixins/attribute_protection.rb +74 -0
  12. data/lib/couchrest/mixins/attributes.rb +75 -0
  13. data/lib/couchrest/mixins/callbacks.rb +534 -0
  14. data/lib/couchrest/mixins/class_proxy.rb +120 -0
  15. data/lib/couchrest/mixins/collection.rb +260 -0
  16. data/lib/couchrest/mixins/design_doc.rb +159 -0
  17. data/lib/couchrest/mixins/document_queries.rb +82 -0
  18. data/lib/couchrest/mixins/extended_attachments.rb +73 -0
  19. data/lib/couchrest/mixins/properties.rb +130 -0
  20. data/lib/couchrest/mixins/typecast.rb +174 -0
  21. data/lib/couchrest/mixins/views.rb +148 -0
  22. data/lib/couchrest/property.rb +96 -0
  23. data/lib/couchrest/support/couchrest.rb +19 -0
  24. data/lib/couchrest/support/rails.rb +42 -0
  25. data/lib/couchrest/validation.rb +246 -0
  26. data/lib/couchrest/validation/auto_validate.rb +156 -0
  27. data/lib/couchrest/validation/contextual_validators.rb +78 -0
  28. data/lib/couchrest/validation/validation_errors.rb +125 -0
  29. data/lib/couchrest/validation/validators/absent_field_validator.rb +74 -0
  30. data/lib/couchrest/validation/validators/confirmation_validator.rb +107 -0
  31. data/lib/couchrest/validation/validators/format_validator.rb +122 -0
  32. data/lib/couchrest/validation/validators/formats/email.rb +66 -0
  33. data/lib/couchrest/validation/validators/formats/url.rb +43 -0
  34. data/lib/couchrest/validation/validators/generic_validator.rb +120 -0
  35. data/lib/couchrest/validation/validators/length_validator.rb +139 -0
  36. data/lib/couchrest/validation/validators/method_validator.rb +89 -0
  37. data/lib/couchrest/validation/validators/numeric_validator.rb +109 -0
  38. data/lib/couchrest/validation/validators/required_field_validator.rb +114 -0
  39. data/lib/couchrest_extended_document.rb +23 -0
  40. data/spec/couchrest/attribute_protection_spec.rb +150 -0
  41. data/spec/couchrest/casted_extended_doc_spec.rb +79 -0
  42. data/spec/couchrest/casted_model_spec.rb +424 -0
  43. data/spec/couchrest/extended_doc_attachment_spec.rb +148 -0
  44. data/spec/couchrest/extended_doc_inherited_spec.rb +40 -0
  45. data/spec/couchrest/extended_doc_spec.rb +869 -0
  46. data/spec/couchrest/extended_doc_subclass_spec.rb +101 -0
  47. data/spec/couchrest/extended_doc_view_spec.rb +529 -0
  48. data/spec/couchrest/property_spec.rb +790 -0
  49. data/spec/fixtures/attachments/README +3 -0
  50. data/spec/fixtures/attachments/couchdb.png +0 -0
  51. data/spec/fixtures/attachments/test.html +11 -0
  52. data/spec/fixtures/more/article.rb +35 -0
  53. data/spec/fixtures/more/card.rb +22 -0
  54. data/spec/fixtures/more/cat.rb +22 -0
  55. data/spec/fixtures/more/course.rb +25 -0
  56. data/spec/fixtures/more/event.rb +8 -0
  57. data/spec/fixtures/more/invoice.rb +17 -0
  58. data/spec/fixtures/more/person.rb +9 -0
  59. data/spec/fixtures/more/question.rb +7 -0
  60. data/spec/fixtures/more/service.rb +12 -0
  61. data/spec/fixtures/more/user.rb +22 -0
  62. data/spec/fixtures/views/lib.js +3 -0
  63. data/spec/fixtures/views/test_view/lib.js +3 -0
  64. data/spec/fixtures/views/test_view/only-map.js +4 -0
  65. data/spec/fixtures/views/test_view/test-map.js +3 -0
  66. data/spec/fixtures/views/test_view/test-reduce.js +3 -0
  67. data/spec/spec.opts +5 -0
  68. data/spec/spec_helper.rb +49 -0
  69. data/utils/remap.rb +27 -0
  70. data/utils/subset.rb +30 -0
  71. metadata +225 -0
@@ -0,0 +1,120 @@
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
+ docs = @klass.all({:database => @database}.merge(opts), &block)
60
+ docs.each { |doc| doc.database = @database if doc.respond_to?(:database) } if docs
61
+ docs
62
+ end
63
+
64
+ def count(opts = {}, &block)
65
+ @klass.all({:database => @database, :raw => true, :limit => 0}.merge(opts), &block)['total_rows']
66
+ end
67
+
68
+ def first(opts = {})
69
+ doc = @klass.first({:database => @database}.merge(opts))
70
+ doc.database = @database if doc && doc.respond_to?(:database)
71
+ doc
72
+ end
73
+
74
+ def get(id)
75
+ doc = @klass.get(id, @database)
76
+ doc.database = @database if doc && doc.respond_to?(:database)
77
+ doc
78
+ end
79
+
80
+ # Mixins::Views
81
+
82
+ def has_view?(view)
83
+ @klass.has_view?(view)
84
+ end
85
+
86
+ def view(name, query={}, &block)
87
+ docs = @klass.view(name, {:database => @database}.merge(query), &block)
88
+ docs.each { |doc| doc.database = @database if doc.respond_to?(:database) } if docs
89
+ docs
90
+ end
91
+
92
+
93
+ # Mixins::DesignDoc
94
+
95
+ def design_doc
96
+ @klass.design_doc
97
+ end
98
+
99
+ def refresh_design_doc
100
+ @klass.refresh_design_doc(@database)
101
+ end
102
+
103
+ def save_design_doc
104
+ @klass.save_design_doc(@database)
105
+ end
106
+
107
+ # DEPRICATED
108
+ def all_design_doc_versions
109
+ @klass.all_design_doc_versions(@database)
110
+ end
111
+
112
+ def stored_design_doc
113
+ @klass.stored_design_doc(@database)
114
+ end
115
+ alias :model_design_doc :stored_design_doc
116
+
117
+ end
118
+ end
119
+ end
120
+ end
@@ -0,0 +1,260 @@
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(options[:database] || 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
+ search = options.delete(:search)
46
+ unless search == true
47
+ proxy = create_collection_proxy(options)
48
+ else
49
+ proxy = create_search_collection_proxy(options)
50
+ end
51
+ proxy.paginated_each(options, &block)
52
+ end
53
+
54
+ # Create a CollectionProxy for the specified view and options.
55
+ # CollectionProxy behaves just like an Array, but offers support for
56
+ # pagination.
57
+ def collection_proxy_for(design_doc, view_name, view_options = {})
58
+ options = view_options.merge(:design_doc => design_doc, :view_name => view_name)
59
+ create_collection_proxy(options)
60
+ end
61
+
62
+ private
63
+
64
+ def create_collection_proxy(options)
65
+ design_doc, view_name, view_options = parse_view_options(options)
66
+ CollectionProxy.new(options[:database] || database, design_doc, view_name, view_options, self)
67
+ end
68
+
69
+ def create_search_collection_proxy(options)
70
+ design_doc, search_name, search_options = parse_search_options(options)
71
+ CollectionProxy.new(options[:database] || database, design_doc, search_name, search_options, self, :search)
72
+ end
73
+
74
+ def parse_view_options(options)
75
+ design_doc = options.delete(:design_doc)
76
+ raise ArgumentError, 'design_doc is required' if design_doc.nil?
77
+
78
+ view_name = options.delete(:view_name)
79
+ raise ArgumentError, 'view_name is required' if view_name.nil?
80
+
81
+ default_view_options = (design_doc.class == Design &&
82
+ design_doc['views'][view_name.to_s] &&
83
+ design_doc['views'][view_name.to_s]["couchrest-defaults"]) || {}
84
+ view_options = default_view_options.merge(options)
85
+
86
+ [design_doc, view_name, view_options]
87
+ end
88
+
89
+ def parse_search_options(options)
90
+ design_doc = options.delete(:design_doc)
91
+ raise ArgumentError, 'design_doc is required' if design_doc.nil?
92
+
93
+ search_name = options.delete(:view_name)
94
+ raise ArgumentError, 'search_name is required' if search_name.nil?
95
+
96
+ search_options = options.clone
97
+ [design_doc, search_name, search_options]
98
+ end
99
+
100
+ end
101
+
102
+ class CollectionProxy
103
+ alias_method :proxy_respond_to?, :respond_to?
104
+ instance_methods.each { |m| undef_method m unless m =~ /(^__|^nil\?$|^send$|proxy_|^object_id$)/ }
105
+
106
+ DEFAULT_PAGE = 1
107
+ DEFAULT_PER_PAGE = 30
108
+
109
+ # Create a new CollectionProxy to represent the specified view. If a
110
+ # container class is specified, the proxy will create an object of the
111
+ # given type for each row that comes back from the view. If no
112
+ # container class is specified, the raw results are returned.
113
+ #
114
+ # The CollectionProxy provides support for paginating over a collection
115
+ # via the paginate, and paginated_each methods.
116
+ def initialize(database, design_doc, view_name, view_options = {}, container_class = nil, query_type = :view)
117
+ raise ArgumentError, "database is a required parameter" if database.nil?
118
+
119
+ @database = database
120
+ @container_class = container_class
121
+ @query_type = query_type
122
+
123
+ strip_pagination_options(view_options)
124
+ @view_options = view_options
125
+
126
+ if design_doc.class == Design
127
+ @view_name = "#{design_doc.name}/#{view_name}"
128
+ else
129
+ @view_name = "#{design_doc}/#{view_name}"
130
+ end
131
+ end
132
+
133
+ # See Collection.paginate
134
+ def paginate(options = {})
135
+ page, per_page = parse_options(options)
136
+ results = @database.send(@query_type, @view_name, pagination_options(page, per_page))
137
+ remember_where_we_left_off(results, page)
138
+ instances = convert_to_container_array(results)
139
+
140
+ begin
141
+ if Kernel.const_get('WillPaginate')
142
+ total_rows = results['total_rows'].to_i
143
+ paginated = WillPaginate::Collection.create(page, per_page, total_rows) do |pager|
144
+ pager.replace(instances)
145
+ end
146
+ return paginated
147
+ end
148
+ rescue NameError
149
+ # When not using will_paginate, not much we could do about this. :x
150
+ end
151
+ return instances
152
+ end
153
+
154
+ # See Collection.paginated_each
155
+ def paginated_each(options = {}, &block)
156
+ page, per_page = parse_options(options)
157
+
158
+ begin
159
+ collection = paginate({:page => page, :per_page => per_page})
160
+ collection.each(&block)
161
+ page += 1
162
+ end until collection.size < per_page
163
+ end
164
+
165
+ def respond_to?(*args)
166
+ proxy_respond_to?(*args) || (load_target && @target.respond_to?(*args))
167
+ end
168
+
169
+ # Explicitly proxy === because the instance method removal above
170
+ # doesn't catch it.
171
+ def ===(other)
172
+ load_target
173
+ other === @target
174
+ end
175
+
176
+ private
177
+
178
+ def method_missing(method, *args)
179
+ if load_target
180
+ if block_given?
181
+ @target.send(method, *args) { |*block_args| yield(*block_args) }
182
+ else
183
+ @target.send(method, *args)
184
+ end
185
+ end
186
+ end
187
+
188
+ def load_target
189
+ unless loaded?
190
+ @view_options.merge!({:include_docs => true}) if @query_type == :search
191
+ results = @database.send(@query_type, @view_name, @view_options)
192
+ @target = convert_to_container_array(results)
193
+ end
194
+ @loaded = true
195
+ @target
196
+ end
197
+
198
+ def loaded?
199
+ @loaded
200
+ end
201
+
202
+ def reload
203
+ reset
204
+ load_target
205
+ self unless @target.nil?
206
+ end
207
+
208
+ def reset
209
+ @loaded = false
210
+ @target = nil
211
+ end
212
+
213
+ def inspect
214
+ load_target
215
+ @target.inspect
216
+ end
217
+
218
+ def convert_to_container_array(results)
219
+ if @container_class.nil?
220
+ results
221
+ else
222
+ results['rows'].collect { |row| @container_class.create_from_database(row['doc']) } unless results['rows'].nil?
223
+ end
224
+ end
225
+
226
+ def pagination_options(page, per_page)
227
+ view_options = @view_options.clone
228
+ if @query_type == :view && @last_key && @last_docid && @last_page == page - 1
229
+ key = view_options.delete(:key)
230
+ end_key = view_options[:endkey] || key
231
+ options = { :startkey => @last_key, :endkey => end_key, :startkey_docid => @last_docid, :limit => per_page, :skip => 1 }
232
+ else
233
+ options = { :limit => per_page, :skip => per_page * (page - 1) }
234
+ end
235
+ view_options.merge(options)
236
+ end
237
+
238
+ def parse_options(options)
239
+ page = options.delete(:page) || DEFAULT_PAGE
240
+ per_page = options.delete(:per_page) || DEFAULT_PER_PAGE
241
+ [page.to_i, per_page.to_i]
242
+ end
243
+
244
+ def strip_pagination_options(options)
245
+ parse_options(options)
246
+ end
247
+
248
+ def remember_where_we_left_off(results, page)
249
+ last_row = results['rows'].last
250
+ if last_row
251
+ @last_key = last_row['key']
252
+ @last_docid = last_row['id']
253
+ end
254
+ @last_page = page
255
+ end
256
+ end
257
+
258
+ end
259
+ end
260
+ end
@@ -0,0 +1,159 @@
1
+ require 'digest/md5'
2
+
3
+ module CouchRest
4
+
5
+ # The default design document name generator is simple, but you can override it
6
+ # by setting CouchRest.design_name_fun
7
+ DEFAULT_DESIGN_NAME_FUN = lambda { |klass| klass.to_s }
8
+
9
+ # The default type field, which can be chanegd by setting CouchRest.type_field
10
+ DEFAULT_TYPE_FIELD = 'couchrest-type'
11
+
12
+ @@design_name_fun = DEFAULT_DESIGN_NAME_FUN
13
+ @@type_field = DEFAULT_TYPE_FIELD
14
+
15
+ # Get current design document name generator Proc
16
+ def self.design_name_fun
17
+ @@design_name_fun
18
+ end
19
+
20
+ # Set the design name generator Proc
21
+ def self.design_name_fun= fun
22
+ @@design_name_fun = fun
23
+ end
24
+
25
+ # Get the current type field name
26
+ def self.type_field
27
+ @@type_field
28
+ end
29
+
30
+ # Set the type field name
31
+ def self.type_field= type_field
32
+ @@type_field = type_field
33
+ end
34
+
35
+ module Mixins
36
+ module DesignDoc
37
+
38
+ def self.included(base)
39
+ base.extend(ClassMethods)
40
+ end
41
+
42
+ module ClassMethods
43
+
44
+ def design_doc
45
+ @design_doc ||= Design.new(default_design_doc)
46
+ end
47
+
48
+ # Use when something has been changed, like a view, so that on the next request
49
+ # the design docs will be updated (if changed!)
50
+ def req_design_doc_refresh
51
+ @design_doc_fresh = { }
52
+ end
53
+
54
+ def design_doc_id
55
+ "_design/#{design_doc_slug}"
56
+ end
57
+
58
+ def design_doc_slug
59
+ CouchRest.design_name_fun.call self
60
+ end
61
+
62
+ def default_design_doc
63
+ type_field = CouchRest.type_field
64
+ {
65
+ "_id" => design_doc_id,
66
+ "language" => "javascript",
67
+ "views" => {
68
+ 'all' => {
69
+ 'map' => "function(doc) {
70
+ if (doc['#{type_field}'] == '#{self.to_s}') {
71
+ emit(doc['_id'],1);
72
+ }
73
+ }"
74
+ }
75
+ }
76
+ }
77
+ end
78
+
79
+ # DEPRECATED
80
+ # use stored_design_doc to retrieve the current design doc
81
+ def all_design_doc_versions(db = database)
82
+ db.documents :startkey => "#{design_doc_id}",
83
+ :endkey => "#{design_doc_id}-\u9999"
84
+ end
85
+
86
+ # Retreive the latest version of the design document directly
87
+ # from the database.
88
+ def stored_design_doc(db = database)
89
+ db.get(design_doc_id) rescue nil
90
+ end
91
+ alias :model_design_doc :stored_design_doc
92
+
93
+ def refresh_design_doc(db = database)
94
+ raise "Database missing for design document refresh" if db.nil?
95
+ unless design_doc_fresh(db)
96
+ save_design_doc(db)
97
+ design_doc_fresh(db, true)
98
+ end
99
+ end
100
+
101
+ # Save the design doc onto a target database in a thread-safe way,
102
+ # not modifying the model's design_doc
103
+ #
104
+ # See also save_design_doc! to always save the design doc even if there
105
+ # are no changes.
106
+ def save_design_doc(db = database, force = false)
107
+ update_design_doc(Design.new(design_doc), db, force)
108
+ end
109
+
110
+ # Force the update of the model's design_doc even if it hasn't changed.
111
+ def save_design_doc!(db = database)
112
+ save_design_doc(db, true)
113
+ end
114
+
115
+ protected
116
+
117
+ def design_doc_fresh(db, fresh = nil)
118
+ @design_doc_fresh ||= {}
119
+ if fresh.nil?
120
+ @design_doc_fresh[db.uri] || false
121
+ else
122
+ @design_doc_fresh[db.uri] = fresh
123
+ end
124
+ end
125
+
126
+ # Writes out a design_doc to a given database, returning the
127
+ # updated design doc
128
+ def update_design_doc(design_doc, db, force = false)
129
+ saved = stored_design_doc(db)
130
+ if saved
131
+ changes = force
132
+ design_doc['views'].each do |name, view|
133
+ if !compare_views(saved['views'][name], view)
134
+ changes = true
135
+ saved['views'][name] = view
136
+ end
137
+ end
138
+ if changes
139
+ db.save_doc(saved)
140
+ end
141
+ design_doc
142
+ else
143
+ design_doc.database = db
144
+ design_doc.save
145
+ design_doc
146
+ end
147
+ end
148
+
149
+ # Return true if the two views match
150
+ def compare_views(orig, repl)
151
+ return false if orig.nil? or repl.nil?
152
+ (orig['map'].to_s.strip == repl['map'].to_s.strip) && (orig['reduce'].to_s.strip == repl['reduce'].to_s.strip)
153
+ end
154
+
155
+ end # module ClassMethods
156
+
157
+ end
158
+ end
159
+ end