davber_couchrest_extended_document 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +176 -0
- data/README.md +250 -0
- data/Rakefile +69 -0
- data/THANKS.md +22 -0
- data/examples/model/example.rb +144 -0
- data/history.txt +165 -0
- data/lib/couchrest/casted_array.rb +39 -0
- data/lib/couchrest/casted_model.rb +53 -0
- data/lib/couchrest/extended_document.rb +262 -0
- data/lib/couchrest/mixins.rb +12 -0
- data/lib/couchrest/mixins/attribute_protection.rb +74 -0
- data/lib/couchrest/mixins/attributes.rb +75 -0
- data/lib/couchrest/mixins/callbacks.rb +534 -0
- data/lib/couchrest/mixins/class_proxy.rb +120 -0
- data/lib/couchrest/mixins/collection.rb +260 -0
- data/lib/couchrest/mixins/design_doc.rb +159 -0
- data/lib/couchrest/mixins/document_queries.rb +82 -0
- data/lib/couchrest/mixins/extended_attachments.rb +73 -0
- data/lib/couchrest/mixins/properties.rb +130 -0
- data/lib/couchrest/mixins/typecast.rb +174 -0
- data/lib/couchrest/mixins/views.rb +148 -0
- data/lib/couchrest/property.rb +96 -0
- data/lib/couchrest/support/couchrest.rb +19 -0
- data/lib/couchrest/support/rails.rb +42 -0
- data/lib/couchrest/validation.rb +246 -0
- data/lib/couchrest/validation/auto_validate.rb +156 -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 +107 -0
- data/lib/couchrest/validation/validators/format_validator.rb +122 -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 +139 -0
- data/lib/couchrest/validation/validators/method_validator.rb +89 -0
- data/lib/couchrest/validation/validators/numeric_validator.rb +109 -0
- data/lib/couchrest/validation/validators/required_field_validator.rb +114 -0
- data/lib/couchrest_extended_document.rb +23 -0
- data/spec/couchrest/attribute_protection_spec.rb +150 -0
- data/spec/couchrest/casted_extended_doc_spec.rb +79 -0
- data/spec/couchrest/casted_model_spec.rb +424 -0
- data/spec/couchrest/extended_doc_attachment_spec.rb +148 -0
- data/spec/couchrest/extended_doc_inherited_spec.rb +40 -0
- data/spec/couchrest/extended_doc_spec.rb +869 -0
- data/spec/couchrest/extended_doc_subclass_spec.rb +101 -0
- data/spec/couchrest/extended_doc_view_spec.rb +529 -0
- data/spec/couchrest/property_spec.rb +790 -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 +35 -0
- data/spec/fixtures/more/card.rb +22 -0
- data/spec/fixtures/more/cat.rb +22 -0
- data/spec/fixtures/more/course.rb +25 -0
- data/spec/fixtures/more/event.rb +8 -0
- data/spec/fixtures/more/invoice.rb +17 -0
- data/spec/fixtures/more/person.rb +9 -0
- data/spec/fixtures/more/question.rb +7 -0
- data/spec/fixtures/more/service.rb +12 -0
- data/spec/fixtures/more/user.rb +22 -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 +5 -0
- data/spec/spec_helper.rb +49 -0
- data/utils/remap.rb +27 -0
- data/utils/subset.rb +30 -0
- metadata +225 -0
data/LICENSE
ADDED
@@ -0,0 +1,176 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
data/README.md
ADDED
@@ -0,0 +1,250 @@
|
|
1
|
+
# CouchRest::ExtendedDocument: CouchDB, not too close to the metal
|
2
|
+
|
3
|
+
CouchRest::ExtendedDocument adds additional functionality to the standard CouchRest Document class such as
|
4
|
+
setting properties, callbacks, typecasting, and validations.
|
5
|
+
|
6
|
+
This gem, *davber_couchrest_extended_document*, is a revision of the original gem, allowing both the design document name and type fields to be configurable, instead of the defaults, which is the identity function and the string "couchrest-type", respectively.
|
7
|
+
|
8
|
+
The way to set the type field used is
|
9
|
+
|
10
|
+
CouchRest.type_field = 'my_type'
|
11
|
+
|
12
|
+
and the way to set the design document naming mapper is
|
13
|
+
|
14
|
+
CouchRest.design_name_fun = lambda { |klass| klas.to_s.downcase }
|
15
|
+
|
16
|
+
|
17
|
+
Note: CouchRest::ExtendedDocument only supports CouchDB 0.10.0 or newer.
|
18
|
+
|
19
|
+
## Install
|
20
|
+
|
21
|
+
$ sudo gem install couchrest_extended_document
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
### General
|
26
|
+
|
27
|
+
require 'couchrest_extended_document'
|
28
|
+
|
29
|
+
class Cat < CouchRest::ExtendedDocument
|
30
|
+
|
31
|
+
property :name, String
|
32
|
+
property :lives, Integer, :default => 9
|
33
|
+
|
34
|
+
property :nicknames, [String]
|
35
|
+
|
36
|
+
timestamps!
|
37
|
+
|
38
|
+
view_by :name
|
39
|
+
|
40
|
+
end
|
41
|
+
|
42
|
+
@cat = Cat.new(:name => 'Felix', :nicknames => ['so cute', 'sweet kitty'])
|
43
|
+
|
44
|
+
@cat.new? # true
|
45
|
+
@cat.save
|
46
|
+
|
47
|
+
@cat['name'] # "Felix"
|
48
|
+
|
49
|
+
@cat.nicknames << 'getoffdamntable'
|
50
|
+
|
51
|
+
@cat = Cat.new
|
52
|
+
@cat.update_attributes(:name => 'Felix', :random_text => 'feline')
|
53
|
+
@cat.new? # false
|
54
|
+
@cat.random_text # Raises error!
|
55
|
+
|
56
|
+
|
57
|
+
### Properties
|
58
|
+
|
59
|
+
Only attributes with a property definition will be stored be ExtendedDocument (as opposed
|
60
|
+
to a normal CouchRest Document which will store everything). To help prevent confusion,
|
61
|
+
a property should be considered as the definition of an attribute. An attribute must be associated
|
62
|
+
with a property, but a property may not have any attributes associated if none have been set.
|
63
|
+
|
64
|
+
|
65
|
+
In its simplest form, a property
|
66
|
+
will only create a getter and setter passing all attribute data directly to the database. Assuming the attribute
|
67
|
+
provided responds to +to_json+, there will not be any problems saving it, but when loading the
|
68
|
+
data back it will either be a string, number, array, or hash:
|
69
|
+
|
70
|
+
class Cat < CouchRest::ExtendedDocument
|
71
|
+
property :name
|
72
|
+
property :birthday
|
73
|
+
end
|
74
|
+
|
75
|
+
@cat = Cat.new(:name => 'Felix', :birthday => 2.years.ago)
|
76
|
+
@cat.name # 'Felix'
|
77
|
+
@cat.birthday.is_a?(Time) # True!
|
78
|
+
@cat.save
|
79
|
+
@cat = Cat.find(@cat.id)
|
80
|
+
@cat.name # 'Felix'
|
81
|
+
@cat.birthday.is_a?(Time) # False!
|
82
|
+
|
83
|
+
Properties create getters and setters similar to the following:
|
84
|
+
|
85
|
+
def name
|
86
|
+
read_attribute('name')
|
87
|
+
end
|
88
|
+
|
89
|
+
def name=(value)
|
90
|
+
write_attribute('name', value)
|
91
|
+
end
|
92
|
+
|
93
|
+
Properties can also have a type which
|
94
|
+
will be used for casting data retrieved from CouchDB when the attribute is set:
|
95
|
+
|
96
|
+
class Cat < CouchRest::ExtendedDocument
|
97
|
+
property :name, String
|
98
|
+
property :last_fed_at, Time
|
99
|
+
end
|
100
|
+
|
101
|
+
@cat = Cat.new(:name => 'Felix', :last_fed_at => 10.minutes.ago)
|
102
|
+
@cat.last_fed_at.is_a?(Time) # True!
|
103
|
+
@cat.save
|
104
|
+
@cat = Cat.find(@cat.id)
|
105
|
+
@cat.last_fed_at < 20.minutes.ago # True!
|
106
|
+
|
107
|
+
|
108
|
+
Booleans or TrueClass will also create a getter with question mark at the end:
|
109
|
+
|
110
|
+
class Cat < CouchRest::ExtendedDocument
|
111
|
+
property :awake, TrueClass, :default => true
|
112
|
+
end
|
113
|
+
|
114
|
+
@cat.awake? # true
|
115
|
+
|
116
|
+
Adding the +:default+ option will ensure the attribute always has a value.
|
117
|
+
|
118
|
+
Defining a property as read-only will mean that its value is set only when read from the
|
119
|
+
database and that it will not have a setter method. You can however update a read-only
|
120
|
+
attribute using the +write_attribute+ method:
|
121
|
+
|
122
|
+
class Cat < CouchRest::ExtendedDocument
|
123
|
+
property :name, String
|
124
|
+
property :lives, Integer, :default => 9, :readonly => true
|
125
|
+
|
126
|
+
def fall_off_balcony!
|
127
|
+
write_attribute(:lives, lives - 1)
|
128
|
+
save
|
129
|
+
end
|
130
|
+
end
|
131
|
+
|
132
|
+
@cat = Cat.new(:name => "Felix")
|
133
|
+
@cat.fall_off_balcony!
|
134
|
+
@cat.lives # Now 8!
|
135
|
+
|
136
|
+
|
137
|
+
### Property Arrays
|
138
|
+
|
139
|
+
An attribute may also contain an array of data. ExtendedDocument handles this, along
|
140
|
+
with casting, by defining the class of the child attributes inside an Array:
|
141
|
+
|
142
|
+
class Cat < CouchRest::ExtendedDocument
|
143
|
+
property :name, String
|
144
|
+
property :nicknames, [String]
|
145
|
+
end
|
146
|
+
|
147
|
+
By default, the array will be ready to use from the moment the object as been instantiated:
|
148
|
+
|
149
|
+
@cat = Cat.new(:name => 'Fluffy')
|
150
|
+
@cat.nicknames << 'Buffy'
|
151
|
+
|
152
|
+
@cat.nicknames == ['Buffy']
|
153
|
+
|
154
|
+
When anything other than a string is set as the class of a property, the array will be converted
|
155
|
+
into special wrapper called a CastedArray. If the child objects respond to the 'casted_by' method
|
156
|
+
(such as those created with CastedModel, below) it will contain a reference to the parent.
|
157
|
+
|
158
|
+
### Casted Models
|
159
|
+
|
160
|
+
ExtendedDocument allows you to take full advantage of CouchDB's ability to store complex
|
161
|
+
documents and retrieve them using the CastedModel module. Simply include the module in
|
162
|
+
a Hash (or other model that responds to the [] and []= methods) and set any properties
|
163
|
+
you'd like to use. For example:
|
164
|
+
|
165
|
+
class CatToy << Hash
|
166
|
+
include CouchRest::CastedModel
|
167
|
+
|
168
|
+
property :name, String
|
169
|
+
property :purchased, Date
|
170
|
+
end
|
171
|
+
|
172
|
+
class Cat << CouchRest::ExtendedDocument
|
173
|
+
property :name, String
|
174
|
+
property :toys, [CatToy]
|
175
|
+
end
|
176
|
+
|
177
|
+
@cat = Cat.new(:name => 'Felix', :toys => [{:name => 'mouse', :purchases => 1.month.ago}])
|
178
|
+
@cat.toys.first.class == CatToy
|
179
|
+
@cat.toys.first.name == 'mouse'
|
180
|
+
|
181
|
+
Additionally, any hashes sent to the property will automatically be converted:
|
182
|
+
|
183
|
+
@cat.toys << {:name => 'catnip ball'}
|
184
|
+
@cat.toys.last.is_a?(CatToy) # True!
|
185
|
+
|
186
|
+
Of course, to use your own classes they *must* be defined before the parent uses them otherwise
|
187
|
+
Ruby will bring up a missing constant error. To avoid this, or if you have a really simple array of data
|
188
|
+
you'd like to model, the latest version of ExtendedDocument (> 1.0.0) supports creating
|
189
|
+
anonymous classes:
|
190
|
+
|
191
|
+
class Cat << CouchRest::ExtendedDocument
|
192
|
+
property :name, String
|
193
|
+
|
194
|
+
property :toys do |toy|
|
195
|
+
toy.property :name, String
|
196
|
+
toy.property :rating, Integer
|
197
|
+
end
|
198
|
+
end
|
199
|
+
|
200
|
+
@cat = Cat.new(:name => 'Felix', :toys => [{:name => 'mouse', :rating => 3}, {:name => 'catnip ball', :rating => 5}])
|
201
|
+
@cat.toys.last.rating == 5
|
202
|
+
@cat.toys.last.name == 'catnip ball'
|
203
|
+
|
204
|
+
Using this method of anonymous classes will *only* create arrays of objects.
|
205
|
+
|
206
|
+
### Notable Issues
|
207
|
+
|
208
|
+
ExtendedDocument uses active_support for some of its internals. Ensure you have a stable active support gem installed
|
209
|
+
or at least 3.0.0.beta4.
|
210
|
+
|
211
|
+
JSON gem versions 1.4.X are kown to cause problems with stack overflows and general badness. Version 1.2.4 appears to work fine.
|
212
|
+
|
213
|
+
### Ruby on Rails
|
214
|
+
|
215
|
+
CouchRest::ExtendedDocument is compatible with rails and provides some ActiveRecord-like methods.
|
216
|
+
You might also be interested in the CouchRest companion rails project:
|
217
|
+
[http://github.com/hpoydar/couchrest-rails](http://github.com/hpoydar/couchrest-rails)
|
218
|
+
|
219
|
+
#### Rails 2.X
|
220
|
+
|
221
|
+
In your environment.rb file require the gem as follows:
|
222
|
+
|
223
|
+
Rails::Initializer.run do |config|
|
224
|
+
....
|
225
|
+
config.gem "couchrest_extended_document"
|
226
|
+
....
|
227
|
+
end
|
228
|
+
|
229
|
+
## Testing
|
230
|
+
|
231
|
+
The most complete documentation is the spec/ directory. To validate your
|
232
|
+
CouchRest install, from the project root directory run `rake`, or `autotest`
|
233
|
+
(requires RSpec and optionally ZenTest for autotest support).
|
234
|
+
|
235
|
+
## Docs
|
236
|
+
|
237
|
+
API: [http://rdoc.info/projects/couchrest/couchrest_extended_document](http://rdoc.info/projects/couchrest/couchrest_extended_document)
|
238
|
+
|
239
|
+
Check the wiki for documentation and examples [http://wiki.github.com/couchrest/couchrest_extended_document](http://wiki.github.com/couchrest/couchrest_extended_document)
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
## Contact
|
244
|
+
|
245
|
+
Please post bugs, suggestions and patches to the bug tracker at [http://github.com/couchrest/couchrest_extended_document/issues](http://github.com/couchrest/couchrest_extended_document/issues).
|
246
|
+
|
247
|
+
Follow us on Twitter: [http://twitter.com/couchrest](http://twitter.com/couchrest)
|
248
|
+
|
249
|
+
Also, check [http://twitter.com/#search?q=%23couchrest](http://twitter.com/#search?q=%23couchrest)
|
250
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,69 @@
|
|
1
|
+
require 'rake'
|
2
|
+
require "rake/rdoctask"
|
3
|
+
require File.join(File.expand_path(File.dirname(__FILE__)),'lib','couchrest_extended_document')
|
4
|
+
|
5
|
+
begin
|
6
|
+
require 'spec/rake/spectask'
|
7
|
+
rescue LoadError
|
8
|
+
puts <<-EOS
|
9
|
+
To use rspec for testing you must install rspec gem:
|
10
|
+
gem install rspec
|
11
|
+
EOS
|
12
|
+
exit(0)
|
13
|
+
end
|
14
|
+
|
15
|
+
begin
|
16
|
+
require 'jeweler'
|
17
|
+
Jeweler::Tasks.new do |gemspec|
|
18
|
+
gemspec.name = "davber_couchrest_extended_document"
|
19
|
+
gemspec.summary = "Extend CouchRest Document class with useful features."
|
20
|
+
gemspec.description = "CouchRest::ExtendedDocument provides aditional features to the standard CouchRest::Document class such as properties, view designs, callbacks, typecasting and validations."
|
21
|
+
gemspec.email = "davber@gmail.com"
|
22
|
+
gemspec.homepage = "http://github.com/couchrest/couchrest_extended_document"
|
23
|
+
gemspec.authors = ["J. Chris Anderson", "Matt Aimonetti", "Marcos Tapajos", "Will Leinweber", "Sam Lown", "David Bergman"]
|
24
|
+
gemspec.extra_rdoc_files = %w( README.md LICENSE THANKS.md )
|
25
|
+
gemspec.files = %w( LICENSE README.md Rakefile THANKS.md history.txt couchrest.gemspec) + Dir["{examples,lib,spec,utils}/**/*"] - Dir["spec/tmp"]
|
26
|
+
gemspec.has_rdoc = true
|
27
|
+
gemspec.add_dependency("couchrest", ">= 1.0.0")
|
28
|
+
gemspec.add_dependency("mime-types", ">= 1.15")
|
29
|
+
gemspec.add_dependency("activesupport", ">= 2.3.0")
|
30
|
+
gemspec.add_dependency("builder", ">=2.1.2")
|
31
|
+
gemspec.version = CouchRest::ExtendedDocument::VERSION
|
32
|
+
gemspec.date = Time.now.strftime("%Y-%m-%d")
|
33
|
+
gemspec.require_path = "lib"
|
34
|
+
end
|
35
|
+
rescue LoadError
|
36
|
+
puts "Jeweler not available. Install it with: gem install jeweler"
|
37
|
+
end
|
38
|
+
|
39
|
+
desc "Run all specs"
|
40
|
+
Spec::Rake::SpecTask.new('spec') do |t|
|
41
|
+
t.spec_opts = ["--color"]
|
42
|
+
t.spec_files = FileList['spec/**/*_spec.rb']
|
43
|
+
end
|
44
|
+
|
45
|
+
desc "Print specdocs"
|
46
|
+
Spec::Rake::SpecTask.new(:doc) do |t|
|
47
|
+
t.spec_opts = ["--format", "specdoc"]
|
48
|
+
t.spec_files = FileList['spec/*_spec.rb']
|
49
|
+
end
|
50
|
+
|
51
|
+
desc "Generate the rdoc"
|
52
|
+
Rake::RDocTask.new do |rdoc|
|
53
|
+
files = ["README.rdoc", "LICENSE", "lib/**/*.rb"]
|
54
|
+
rdoc.rdoc_files.add(files)
|
55
|
+
rdoc.main = "README.rdoc"
|
56
|
+
rdoc.title = "CouchRest: Ruby CouchDB, close to the metal"
|
57
|
+
end
|
58
|
+
|
59
|
+
desc "Run the rspec"
|
60
|
+
task :default => :spec
|
61
|
+
|
62
|
+
module Rake
|
63
|
+
def self.remove_task(task_name)
|
64
|
+
Rake.application.instance_variable_get('@tasks').delete(task_name.to_s)
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
Rake.remove_task("github:release")
|
69
|
+
Rake.remove_task("release")
|