couchrest_extended_document 1.0.0.beta5
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.
- data/LICENSE +176 -0
- data/README.md +68 -0
- data/Rakefile +68 -0
- data/THANKS.md +19 -0
- data/examples/model/example.rb +144 -0
- data/history.txt +159 -0
- data/lib/couchrest/casted_array.rb +25 -0
- data/lib/couchrest/casted_model.rb +55 -0
- data/lib/couchrest/extended_document.rb +323 -0
- data/lib/couchrest/mixins/attribute_protection.rb +74 -0
- data/lib/couchrest/mixins/callbacks.rb +532 -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 +127 -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 +162 -0
- data/lib/couchrest/mixins/validation.rb +245 -0
- data/lib/couchrest/mixins/views.rb +148 -0
- data/lib/couchrest/mixins.rb +11 -0
- data/lib/couchrest/property.rb +50 -0
- data/lib/couchrest/support/couchrest.rb +19 -0
- data/lib/couchrest/support/rails.rb +42 -0
- data/lib/couchrest/typecast.rb +175 -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/validation.rb +245 -0
- data/lib/couchrest_extended_document.rb +21 -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 +406 -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 +868 -0
- data/spec/couchrest/extended_doc_subclass_spec.rb +99 -0
- data/spec/couchrest/extended_doc_view_spec.rb +529 -0
- data/spec/couchrest/property_spec.rb +648 -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 +6 -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 +200 -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,68 @@
|
|
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
|
+
Note: CouchRest::ExtendedDocument only supports CouchDB 0.10.0 or newer.
|
7
|
+
|
8
|
+
## Install
|
9
|
+
|
10
|
+
$ sudo gem install couchrest_extended_document
|
11
|
+
|
12
|
+
## Usage
|
13
|
+
|
14
|
+
### General
|
15
|
+
|
16
|
+
require 'couchrest_extended_document'
|
17
|
+
|
18
|
+
class Cat < CouchRest::ExtendedDocument
|
19
|
+
|
20
|
+
property :name, String
|
21
|
+
property :lives, Integer, :default => 9
|
22
|
+
|
23
|
+
property :nicknames, [String]
|
24
|
+
|
25
|
+
timestamps!
|
26
|
+
|
27
|
+
view_by :name
|
28
|
+
|
29
|
+
end
|
30
|
+
|
31
|
+
### Ruby on Rails
|
32
|
+
|
33
|
+
CouchRest::ExtendedDocument is compatible with rails and provides some ActiveRecord-like methods.
|
34
|
+
You might also be interested in the CouchRest companion rails project:
|
35
|
+
[http://github.com/hpoydar/couchrest-rails](http://github.com/hpoydar/couchrest-rails)
|
36
|
+
|
37
|
+
#### Rails 2.X
|
38
|
+
|
39
|
+
In your environment.rb file require the gem as follows:
|
40
|
+
|
41
|
+
Rails::Initializer.run do |config|
|
42
|
+
....
|
43
|
+
config.gem "couchrest_extended_document"
|
44
|
+
....
|
45
|
+
end
|
46
|
+
|
47
|
+
## Testing
|
48
|
+
|
49
|
+
The most complete documentation is the spec/ directory. To validate your
|
50
|
+
CouchRest install, from the project root directory run `rake`, or `autotest`
|
51
|
+
(requires RSpec and optionally ZenTest for autotest support).
|
52
|
+
|
53
|
+
## Docs
|
54
|
+
|
55
|
+
API: [http://rdoc.info/projects/couchrest/couchrest_extended_document](http://rdoc.info/projects/couchrest/couchrest_extended_document)
|
56
|
+
|
57
|
+
Check the wiki for documentation and examples [http://wiki.github.com/couchrest/couchrest](http://wiki.github.com/couchrest/couchrest)
|
58
|
+
|
59
|
+
|
60
|
+
|
61
|
+
## Contact
|
62
|
+
|
63
|
+
Please post bugs, suggestions and patches to the bug tracker at [http://github.com/couchrest/couchrest/issues](http://github.com/couchrest/couchrest/issues).
|
64
|
+
|
65
|
+
Follow us on Twitter: [http://twitter.com/couchrest](http://twitter.com/couchrest)
|
66
|
+
|
67
|
+
Also, check [http://twitter.com/#search?q=%23couchrest](http://twitter.com/#search?q=%23couchrest)
|
68
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,68 @@
|
|
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 = "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 = "jchris@apache.org"
|
22
|
+
gemspec.homepage = "http://github.com/couchrest/couchrest_extended_document"
|
23
|
+
gemspec.authors = ["J. Chris Anderson", "Matt Aimonetti", "Marcos Tapajos", "Will Leinweber"]
|
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.beta")
|
28
|
+
gemspec.add_dependency("mime-types", ">= 1.15")
|
29
|
+
gemspec.add_dependency("activesupport", ">= 2.3.0")
|
30
|
+
gemspec.version = CouchRest::ExtendedDocument::VERSION
|
31
|
+
gemspec.date = "2008-11-22"
|
32
|
+
gemspec.require_path = "lib"
|
33
|
+
end
|
34
|
+
rescue LoadError
|
35
|
+
puts "Jeweler not available. Install it with: gem install jeweler"
|
36
|
+
end
|
37
|
+
|
38
|
+
desc "Run all specs"
|
39
|
+
Spec::Rake::SpecTask.new('spec') do |t|
|
40
|
+
t.spec_opts = ["--color"]
|
41
|
+
t.spec_files = FileList['spec/**/*_spec.rb']
|
42
|
+
end
|
43
|
+
|
44
|
+
desc "Print specdocs"
|
45
|
+
Spec::Rake::SpecTask.new(:doc) do |t|
|
46
|
+
t.spec_opts = ["--format", "specdoc"]
|
47
|
+
t.spec_files = FileList['spec/*_spec.rb']
|
48
|
+
end
|
49
|
+
|
50
|
+
desc "Generate the rdoc"
|
51
|
+
Rake::RDocTask.new do |rdoc|
|
52
|
+
files = ["README.rdoc", "LICENSE", "lib/**/*.rb"]
|
53
|
+
rdoc.rdoc_files.add(files)
|
54
|
+
rdoc.main = "README.rdoc"
|
55
|
+
rdoc.title = "CouchRest: Ruby CouchDB, close to the metal"
|
56
|
+
end
|
57
|
+
|
58
|
+
desc "Run the rspec"
|
59
|
+
task :default => :spec
|
60
|
+
|
61
|
+
module Rake
|
62
|
+
def self.remove_task(task_name)
|
63
|
+
Rake.application.instance_variable_get('@tasks').delete(task_name.to_s)
|
64
|
+
end
|
65
|
+
end
|
66
|
+
|
67
|
+
Rake.remove_task("github:release")
|
68
|
+
Rake.remove_task("release")
|
data/THANKS.md
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
CouchRest THANKS
|
2
|
+
=====================
|
3
|
+
|
4
|
+
CouchRest was originally developed by J. Chris Anderson <jchris@grabb.it>
|
5
|
+
and a number of other contributors. Many people further contributed to
|
6
|
+
CouchRest by reporting problems, suggesting various improvements or submitting
|
7
|
+
changes. A list of these people is included below.
|
8
|
+
|
9
|
+
* [Matt Aimonetti](http://merbist.com/about/)
|
10
|
+
* [Greg Borenstein](http://ideasfordozens.com)
|
11
|
+
* [Geoffrey Grosenbach](http://nubyonrails.com/)
|
12
|
+
* [Jonathan S. Katz](http://github.com/jkatz)
|
13
|
+
* [Matt Lyon](http://mattly.tumblr.com/)
|
14
|
+
* Simon Rozet (simon /at/ rozet /dot/ name)
|
15
|
+
* [Marcos Tapajós](http://tapajos.me)
|
16
|
+
|
17
|
+
Patches are welcome. The primary source for this software project is [on Github](http://github.com/couchrest/couchrest)
|
18
|
+
|
19
|
+
A lot of people have active forks - thank you all - even the patches I don't end up using are helpful.
|
@@ -0,0 +1,144 @@
|
|
1
|
+
require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'couchrest')
|
2
|
+
|
3
|
+
def show obj
|
4
|
+
puts obj.inspect
|
5
|
+
puts
|
6
|
+
end
|
7
|
+
|
8
|
+
SERVER = CouchRest.new
|
9
|
+
SERVER.default_database = 'couchrest-extendeddoc-example'
|
10
|
+
|
11
|
+
class Author < CouchRest::ExtendedDocument
|
12
|
+
use_database SERVER.default_database
|
13
|
+
property :name
|
14
|
+
|
15
|
+
def drink_scotch
|
16
|
+
puts "... glug type glug ... I'm #{name} ... type glug glug ..."
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
class Post < CouchRest::ExtendedDocument
|
21
|
+
use_database SERVER.default_database
|
22
|
+
|
23
|
+
property :title
|
24
|
+
property :body
|
25
|
+
property :author, :cast_as => 'Author'
|
26
|
+
|
27
|
+
timestamps!
|
28
|
+
end
|
29
|
+
|
30
|
+
class Comment < CouchRest::ExtendedDocument
|
31
|
+
use_database SERVER.default_database
|
32
|
+
|
33
|
+
property :commenter, :cast_as => 'Author'
|
34
|
+
timestamps!
|
35
|
+
|
36
|
+
def post= post
|
37
|
+
self["post_id"] = post.id
|
38
|
+
end
|
39
|
+
def post
|
40
|
+
Post.get(self['post_id']) if self['post_id']
|
41
|
+
end
|
42
|
+
|
43
|
+
end
|
44
|
+
|
45
|
+
puts "Act I: CRUD"
|
46
|
+
puts
|
47
|
+
puts "(pause for dramatic effect)"
|
48
|
+
puts
|
49
|
+
sleep 2
|
50
|
+
|
51
|
+
puts "Create an author."
|
52
|
+
quentin = Author.new("name" => "Quentin Hazel")
|
53
|
+
show quentin
|
54
|
+
|
55
|
+
puts "Create a new post."
|
56
|
+
post = Post.new(:title => "First Post", :body => "Lorem ipsum dolor sit amet, consectetur adipisicing elit...")
|
57
|
+
show post
|
58
|
+
|
59
|
+
puts "Add the author to the post."
|
60
|
+
post.author = quentin
|
61
|
+
show post
|
62
|
+
|
63
|
+
puts "Save the post."
|
64
|
+
post.save
|
65
|
+
show post
|
66
|
+
|
67
|
+
puts "Load the post."
|
68
|
+
reloaded = Post.get(post.id)
|
69
|
+
show reloaded
|
70
|
+
|
71
|
+
puts "The author of the post is an instance of Author."
|
72
|
+
reloaded.author.drink_scotch
|
73
|
+
|
74
|
+
puts "\nAdd some comments to the post."
|
75
|
+
comment_one = Comment.new :text => "Blah blah blah", :commenter => {:name => "Joe Sixpack"}
|
76
|
+
comment_two = Comment.new :text => "Yeah yeah yeah", :commenter => {:name => "Jane Doe"}
|
77
|
+
comment_three = Comment.new :text => "Whatever...", :commenter => {:name => "John Stewart"}
|
78
|
+
|
79
|
+
# TODO - maybe add some magic here?
|
80
|
+
comment_one.post = post
|
81
|
+
comment_two.post = post
|
82
|
+
comment_three.post = post
|
83
|
+
comment_one.save
|
84
|
+
comment_two.save
|
85
|
+
comment_three.save
|
86
|
+
|
87
|
+
show comment_one
|
88
|
+
show comment_two
|
89
|
+
show comment_three
|
90
|
+
|
91
|
+
puts "We can load a post through its comment (no magic here)."
|
92
|
+
show post = comment_one.post
|
93
|
+
|
94
|
+
puts "Commenters are also authors."
|
95
|
+
comment_two['commenter'].drink_scotch
|
96
|
+
comment_one['commenter'].drink_scotch
|
97
|
+
comment_three['commenter'].drink_scotch
|
98
|
+
|
99
|
+
puts "\nLet's save an author to her own document."
|
100
|
+
jane = comment_two['commenter']
|
101
|
+
jane.save
|
102
|
+
show jane
|
103
|
+
|
104
|
+
puts "Oh, that's neat! Because Ruby passes hash valuee by reference, Jane's new id has been added to the comment she left."
|
105
|
+
show comment_two
|
106
|
+
|
107
|
+
puts "Of course, we'd better remember to save it."
|
108
|
+
comment_two.save
|
109
|
+
show comment_two
|
110
|
+
|
111
|
+
puts "Oooh, denormalized... feel the burn!"
|
112
|
+
puts
|
113
|
+
puts
|
114
|
+
puts
|
115
|
+
puts "Act II: Views"
|
116
|
+
puts
|
117
|
+
puts
|
118
|
+
sleep 2
|
119
|
+
|
120
|
+
puts "Let's find all the comments that go with our post."
|
121
|
+
puts "Our post has id #{post.id}, so lets find all the comments with that post_id."
|
122
|
+
puts
|
123
|
+
|
124
|
+
class Comment
|
125
|
+
view_by :post_id
|
126
|
+
end
|
127
|
+
|
128
|
+
comments = Comment.by_post_id :key => post.id
|
129
|
+
show comments
|
130
|
+
|
131
|
+
puts "That was too easy."
|
132
|
+
puts "We can even wrap it up in a finder on the Post class."
|
133
|
+
puts
|
134
|
+
|
135
|
+
class Post
|
136
|
+
def comments
|
137
|
+
Comment.by_post_id :key => id
|
138
|
+
end
|
139
|
+
end
|
140
|
+
|
141
|
+
show post.comments
|
142
|
+
puts "Gimme 5 minutes and I'll roll this into the framework. ;)"
|
143
|
+
puts
|
144
|
+
puts "There is a lot more that can be done with views, but a lot of the interesting stuff is joins, which of course range across types. We'll pick up where we left off, next time."
|
data/history.txt
ADDED
@@ -0,0 +1,159 @@
|
|
1
|
+
== Next Version
|
2
|
+
|
3
|
+
* Major enhancements
|
4
|
+
|
5
|
+
* Minor enhancements
|
6
|
+
|
7
|
+
== 1.0.0.beta6
|
8
|
+
|
9
|
+
* Minor enhancements
|
10
|
+
* Added 'find_by_*' alias for finding first item in view with matching key.
|
11
|
+
* Fixed issue with active_support in Rails3.
|
12
|
+
|
13
|
+
== 1.0.0.beta5
|
14
|
+
|
15
|
+
* Minor enhancements
|
16
|
+
* Added 'find' alias for 'get' for easier rails transition
|
17
|
+
|
18
|
+
== 1.0.0.beta3
|
19
|
+
|
20
|
+
* Minor enhancements
|
21
|
+
* Removed Validation by default, requires too many structure changes (FAIL)
|
22
|
+
* Added support for instantiation of documents read from database as couchrest-type provided (Sam Lown)
|
23
|
+
* Improved attachment handling for detecting file type (Sam Lown)
|
24
|
+
* Removing some monkey patches and relying on active_support for constantize and humanize (Sam Lown)
|
25
|
+
* Added support for setting type directly on property (Sam Lown)
|
26
|
+
|
27
|
+
|
28
|
+
== 1.0.0.beta2
|
29
|
+
|
30
|
+
* Minor enhancements
|
31
|
+
* Enable Validation by default and refactored location (Sam Lown)
|
32
|
+
|
33
|
+
== 1.0.0.beta
|
34
|
+
|
35
|
+
* Major enhancements
|
36
|
+
* Separated ExtendedDocument from main CouchRest gem (Sam Lown)
|
37
|
+
|
38
|
+
* Minor enhancements
|
39
|
+
* active_support included by default
|
40
|
+
|
41
|
+
== 0.37
|
42
|
+
|
43
|
+
* Minor enhancements
|
44
|
+
* Added gemspec (needed for Bundler install) (Tapajós)
|
45
|
+
|
46
|
+
== 0.36
|
47
|
+
|
48
|
+
* Major enhancements
|
49
|
+
* Adds support for continuous replication (sauy7)
|
50
|
+
* Automatic Type Casting (Alexander Uvarov, Sam Lown, Tim Heighes, Will Leinweber)
|
51
|
+
* Added a search method to CouchRest:Database to search the documents in a given database. (Dave Farkas, Arnaud Berthomier, John Wood)
|
52
|
+
|
53
|
+
* Minor enhancements
|
54
|
+
* Provide a description of the timeout error (John Wood)
|
55
|
+
|
56
|
+
== 0.35
|
57
|
+
|
58
|
+
* Major enhancements
|
59
|
+
* CouchRest::ExtendedDocument allow chaining the inherit class callback (Kenneth Kalmer) - http://github.com/couchrest/couchrest/issues#issue/8
|
60
|
+
|
61
|
+
* Minor enhancements
|
62
|
+
* Fix attachment bug (Johannes Jörg Schmidt)
|
63
|
+
* Fix create database exception bug (Damien Mathieu)
|
64
|
+
* Compatible with restclient >= 1.4.0 new responses (Julien Kirch)
|
65
|
+
* Bug fix: Attribute protection no longer strips attributes coming from the database (Will Leinweber)
|
66
|
+
* Bug fix: Remove double CGI escape when PUTting an attachment (nzoschke)
|
67
|
+
* Bug fix: Changing Class proxy to set database on result sets (Peter Gumeson)
|
68
|
+
* Bug fix: Updated time regexp (Nolan Darilek)
|
69
|
+
* Added an update_doc method to database to handle conflicts during atomic updates. (Pierre Larochelle)
|
70
|
+
* Bug fix: http://github.com/couchrest/couchrest/issues/#issue/2 (Luke Burton)
|
71
|
+
|
72
|
+
== 0.34
|
73
|
+
|
74
|
+
* Major enhancements
|
75
|
+
|
76
|
+
* Added support for https database URIs. (Mathias Meyer)
|
77
|
+
* Changing some validations to be compatible with activemodel. (Marcos Tapajós)
|
78
|
+
* Adds attribute protection to properties. (Will Leinweber)
|
79
|
+
* Improved CouchRest::Database#save_doc, added "batch" mode to significantly speed up saves at cost of lower durability gurantees. (Igal Koshevoy)
|
80
|
+
* Added CouchRest::Database#bulk_save_doc and #batch_save_doc as human-friendlier wrappers around #save_doc. (Igal Koshevoy)
|
81
|
+
|
82
|
+
* Minor enhancements
|
83
|
+
|
84
|
+
* Fix content_type handling for attachments
|
85
|
+
* Fixed a bug in the pagination code that caused it to paginate over records outside of the scope of the view parameters.(John Wood)
|
86
|
+
* Removed amount_pages calculation for the pagination collection, since it cannot be reliably calculated without a view.(John Wood)
|
87
|
+
* Bug fix: http://github.com/couchrest/couchrest/issues/#issue/2 (Luke Burton)
|
88
|
+
* Bug fix: http://github.com/couchrest/couchrest/issues/#issue/1 (Marcos Tapajós)
|
89
|
+
* Removed the Database class deprecation notices (Matt Aimonetti)
|
90
|
+
* Adding support to :cast_as => 'Date'. (Marcos Tapajós)
|
91
|
+
* Improve documentation (Marcos Tapajós)
|
92
|
+
* Streamer fixes (Julien Sanchez)
|
93
|
+
* Fix Save on Document & ExtendedDocument crashed if bulk (Julien Sanchez)
|
94
|
+
* Fix Initialization of ExtendentDocument model shouldn't failed on a nil value in argument (deepj)
|
95
|
+
* Change to use Jeweler and Gemcutter (Marcos Tapajós)
|
96
|
+
|
97
|
+
== 0.33
|
98
|
+
|
99
|
+
* Major enhancements
|
100
|
+
|
101
|
+
* Added a new Rack logger middleware letting you log/save requests/queries (Matt Aimonetti)
|
102
|
+
|
103
|
+
* Minor enhancements
|
104
|
+
|
105
|
+
* Added #amount_pages to a paginated result array (Matt Aimonetti)
|
106
|
+
* Ruby 1.9.2 compatible (Matt Aimonetti)
|
107
|
+
* Added a property? method for property cast as :boolean (John Wood)
|
108
|
+
* Added an option to force the deletion of a attachments (bypass 409s) (Matt Aimonetti)
|
109
|
+
* Created a new abstraction layer for the REST API (Matt Aimonetti)
|
110
|
+
* Bug fix: made ExtendedDocument#all compatible with Couch 0.10 (tc)
|
111
|
+
|
112
|
+
== 0.32
|
113
|
+
|
114
|
+
* Major enhancements
|
115
|
+
|
116
|
+
* ExtendedDocument.get doesn't raise an exception anymore. If no documents are found nil is returned.
|
117
|
+
* ExtendedDocument.get! works the say #get used to work and will raise an exception if a document isn't found.
|
118
|
+
|
119
|
+
* Minor enhancements
|
120
|
+
|
121
|
+
* Bug fix: Model.all(:keys => [1,2]) was not working (Matt Aimonetti)
|
122
|
+
* Added ValidationErrors#count in order to play nicely with Rails (Peter Wagenet)
|
123
|
+
* Bug fix: class proxy design doc refresh (Daniel Kirsh)
|
124
|
+
* Bug fix: the count method on the proxy collection was missing (Daniel Kirsch)
|
125
|
+
* Added #amount_pages to a paginated collection. (Matt Aimonetti)
|
126
|
+
|
127
|
+
== 0.31
|
128
|
+
|
129
|
+
* Major enhancements
|
130
|
+
|
131
|
+
* Created an abstraction HTTP layer to support different http adapters (Matt Aimonetti)
|
132
|
+
* Added ExtendedDocument.create({}) and #create!({}) so you don't have to do Model.new.create (Matt Aimonetti)
|
133
|
+
|
134
|
+
* Minor enhancements
|
135
|
+
|
136
|
+
* Added an init.rb file for easy usage as a Rails plugin (Aaron Quint)
|
137
|
+
* Bug fix: pagination shouldn't die on empty results (Arnaud Berthomier)
|
138
|
+
* Optimized ExtendedDocument.count to run about 3x faster (Matt Aimonetti)
|
139
|
+
* Added Float casting (Ryan Felton & Matt Aimonetti)
|
140
|
+
|
141
|
+
== 0.30
|
142
|
+
|
143
|
+
* Major enhancements
|
144
|
+
|
145
|
+
* Added support for pagination (John Wood)
|
146
|
+
* Improved performance when initializing documents with timestamps (Matt Aimonetti)
|
147
|
+
|
148
|
+
* Minor enhancements
|
149
|
+
|
150
|
+
* Extended the API to retrieve an attachment URI (Matt Aimonetti)
|
151
|
+
* Bug fix: default value should be able to be set as false (Alexander Uvarov)
|
152
|
+
* Bug fix: validates_is_numeric should be able to properly validate a Float instance (Rob Kaufman)
|
153
|
+
* Bug fix: fixed the Timeout implementation (Seth Falcon)
|
154
|
+
|
155
|
+
|
156
|
+
---
|
157
|
+
|
158
|
+
Unfortunately, before 0.30 we did not keep a track of the modifications made to CouchRest.
|
159
|
+
You can see the full commit history on GitHub: http://github.com/couchrest/couchrest/commits/master/
|
@@ -0,0 +1,25 @@
|
|
1
|
+
#
|
2
|
+
# Wrapper around Array so that the casted_by attribute is set in all
|
3
|
+
# elements of the array.
|
4
|
+
#
|
5
|
+
|
6
|
+
module CouchRest
|
7
|
+
class CastedArray < Array
|
8
|
+
attr_accessor :casted_by
|
9
|
+
|
10
|
+
def << obj
|
11
|
+
obj.casted_by = self.casted_by if obj.respond_to?(:casted_by)
|
12
|
+
super(obj)
|
13
|
+
end
|
14
|
+
|
15
|
+
def push(obj)
|
16
|
+
obj.casted_by = self.casted_by if obj.respond_to?(:casted_by)
|
17
|
+
super(obj)
|
18
|
+
end
|
19
|
+
|
20
|
+
def []= index, obj
|
21
|
+
obj.casted_by = self.casted_by if obj.respond_to?(:casted_by)
|
22
|
+
super(index, obj)
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|