sbellity-couchrest 0.23
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +176 -0
- data/README.md +95 -0
- data/Rakefile +75 -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/lib/couchrest.rb +198 -0
- data/lib/couchrest/commands/generate.rb +71 -0
- data/lib/couchrest/commands/push.rb +103 -0
- data/lib/couchrest/core/database.rb +298 -0
- data/lib/couchrest/core/design.rb +79 -0
- data/lib/couchrest/core/document.rb +87 -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 +108 -0
- data/lib/couchrest/mixins/design_doc.rb +90 -0
- data/lib/couchrest/mixins/document_queries.rb +44 -0
- data/lib/couchrest/mixins/extended_attachments.rb +68 -0
- data/lib/couchrest/mixins/extended_document_mixins.rb +7 -0
- data/lib/couchrest/mixins/properties.rb +129 -0
- data/lib/couchrest/mixins/validation.rb +242 -0
- data/lib/couchrest/mixins/views.rb +169 -0
- data/lib/couchrest/monkeypatches.rb +113 -0
- data/lib/couchrest/more/casted_model.rb +28 -0
- data/lib/couchrest/more/extended_document.rb +215 -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/validation/auto_validate.rb +163 -0
- data/lib/couchrest/validation/contextual_validators.rb +78 -0
- data/lib/couchrest/validation/validation_errors.rb +118 -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 +694 -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 +40 -0
- data/spec/couchrest/more/casted_model_spec.rb +98 -0
- data/spec/couchrest/more/extended_doc_attachment_spec.rb +130 -0
- data/spec/couchrest/more/extended_doc_spec.rb +509 -0
- data/spec/couchrest/more/extended_doc_subclass_spec.rb +98 -0
- data/spec/couchrest/more/extended_doc_view_spec.rb +355 -0
- data/spec/couchrest/more/property_spec.rb +136 -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 +20 -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 +26 -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,95 @@
|
|
1
|
+
# CouchRest: CouchDB, close to the metal
|
2
|
+
|
3
|
+
CouchRest is based on [CouchDB's couch.js test
|
4
|
+
library](http://svn.apache.org/repos/asf/incubator/couchdb/trunk/share/www/script/couch.js),
|
5
|
+
which I find to be concise, clear, and well designed. CouchRest lightly wraps
|
6
|
+
CouchDB's HTTP API, managing JSON serialization, and remembering the URI-paths
|
7
|
+
to CouchDB's API endpoints so you don't have to.
|
8
|
+
|
9
|
+
CouchRest is designed to make a simple base for application and framework-specific object oriented APIs. CouchRest is Object-Mapper agnostic, the parsed JSON it returns from CouchDB shows up as subclasses of Ruby's Hash. Naked JSON, just as it was mean to be.
|
10
|
+
|
11
|
+
Note: CouchRest only support CouchDB 0.9.0 or newer.
|
12
|
+
|
13
|
+
## Easy Install
|
14
|
+
|
15
|
+
Easy Install is moving to RubyForge, heads up for the gem.
|
16
|
+
|
17
|
+
### Relax, it's RESTful
|
18
|
+
|
19
|
+
The core of Couchrest is Heroku’s excellent REST Client Ruby HTTP wrapper.
|
20
|
+
REST Client takes all the nastyness of Net::HTTP and gives is a pretty face,
|
21
|
+
while still giving you more control than Open-URI. I recommend it anytime
|
22
|
+
you’re interfacing with a well-defined web service.
|
23
|
+
|
24
|
+
### Running the Specs
|
25
|
+
|
26
|
+
The most complete documentation is the spec/ directory. To validate your
|
27
|
+
CouchRest install, from the project root directory run `rake`, or `autotest`
|
28
|
+
(requires RSpec and optionally ZenTest for autotest support).
|
29
|
+
|
30
|
+
## Examples
|
31
|
+
|
32
|
+
Quick Start:
|
33
|
+
|
34
|
+
# with !, it creates the database if it doesn't already exist
|
35
|
+
@db = CouchRest.database!("http://127.0.0.1:5984/couchrest-test")
|
36
|
+
response = @db.save_doc({:key => 'value', 'another key' => 'another value'})
|
37
|
+
doc = @db.get(response['id'])
|
38
|
+
puts doc.inspect
|
39
|
+
|
40
|
+
Bulk Save:
|
41
|
+
|
42
|
+
@db.bulk_save([
|
43
|
+
{"wild" => "and random"},
|
44
|
+
{"mild" => "yet local"},
|
45
|
+
{"another" => ["set","of","keys"]}
|
46
|
+
])
|
47
|
+
# returns ids and revs of the current docs
|
48
|
+
puts @db.documents.inspect
|
49
|
+
|
50
|
+
Creating and Querying Views:
|
51
|
+
|
52
|
+
@db.save_doc({
|
53
|
+
"_id" => "_design/first",
|
54
|
+
:views => {
|
55
|
+
:test => {
|
56
|
+
:map => "function(doc){for(var w in doc){ if(!w.match(/^_/))emit(w,doc[w])}}"
|
57
|
+
}
|
58
|
+
}
|
59
|
+
})
|
60
|
+
puts @db.view('first/test')['rows'].inspect
|
61
|
+
|
62
|
+
## CouchRest::Model
|
63
|
+
|
64
|
+
CouchRest::Model has been deprecated and replaced by CouchRest::ExtendedDocument
|
65
|
+
|
66
|
+
|
67
|
+
## CouchRest::ExtendedDocument
|
68
|
+
|
69
|
+
### Callbacks
|
70
|
+
|
71
|
+
`CouchRest::ExtendedDocuments` instances have 2 callbacks already defined for you:
|
72
|
+
`create_callback`, `save_callback`, `update_callback` and `destroy_callback`
|
73
|
+
|
74
|
+
In your document inherits from `CouchRest::ExtendedDocument`, define your callback as follows:
|
75
|
+
|
76
|
+
save_callback :before, :generate_slug_from_name
|
77
|
+
|
78
|
+
CouchRest uses a mixin you can find in lib/mixins/callbacks which is extracted from Rails 3, here are some simple usage examples:
|
79
|
+
|
80
|
+
save_callback :before, :before_method
|
81
|
+
save_callback :after, :after_method, :if => :condition
|
82
|
+
save_callback :around {|r| stuff; yield; stuff }
|
83
|
+
|
84
|
+
Check the mixin or the ExtendedDocument class to see how to implement your own callbacks.
|
85
|
+
|
86
|
+
### Casting
|
87
|
+
|
88
|
+
Often, you will want to store multiple objects within a document, to be able to retrieve your objects when you load the document,
|
89
|
+
you can define some casting rules.
|
90
|
+
|
91
|
+
property :casted_attribute, :cast_as => 'WithCastedModelMixin'
|
92
|
+
property :keywords, :cast_as => ["String"]
|
93
|
+
|
94
|
+
If you want to cast an array of instances from a specific Class, use the trick shown above ["ClassName"]
|
95
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,75 @@
|
|
1
|
+
require 'rake'
|
2
|
+
require "rake/rdoctask"
|
3
|
+
require 'rake/gempackagetask'
|
4
|
+
require File.join(File.expand_path(File.dirname(__FILE__)),'lib','couchrest')
|
5
|
+
|
6
|
+
|
7
|
+
begin
|
8
|
+
require 'spec/rake/spectask'
|
9
|
+
rescue LoadError
|
10
|
+
puts <<-EOS
|
11
|
+
To use rspec for testing you must install rspec gem:
|
12
|
+
gem install rspec
|
13
|
+
EOS
|
14
|
+
exit(0)
|
15
|
+
end
|
16
|
+
|
17
|
+
spec = Gem::Specification.new do |s|
|
18
|
+
s.name = "couchrest"
|
19
|
+
s.version = CouchRest::VERSION
|
20
|
+
s.date = "2008-11-22"
|
21
|
+
s.summary = "Lean and RESTful interface to CouchDB."
|
22
|
+
s.email = "jchris@apache.org"
|
23
|
+
s.homepage = "http://github.com/jchris/couchrest"
|
24
|
+
s.description = "CouchRest provides a simple interface on top of CouchDB's RESTful HTTP API, as well as including some utility scripts for managing views and attachments."
|
25
|
+
s.has_rdoc = true
|
26
|
+
s.authors = ["J. Chris Anderson", "Matt Aimonetti"]
|
27
|
+
s.files = %w( LICENSE README.md Rakefile THANKS.md ) +
|
28
|
+
Dir["{examples,lib,spec,utils}/**/*"] -
|
29
|
+
Dir["spec/tmp"]
|
30
|
+
s.extra_rdoc_files = %w( README.md LICENSE THANKS.md )
|
31
|
+
s.require_path = "lib"
|
32
|
+
s.add_dependency("json_pure", ">= 1.1.2")
|
33
|
+
s.add_dependency("rest-client", ">= 0.5")
|
34
|
+
s.add_dependency("mime-types", ">= 1.15")
|
35
|
+
end
|
36
|
+
|
37
|
+
|
38
|
+
desc "Create .gemspec file (useful for github)"
|
39
|
+
task :gemspec do
|
40
|
+
filename = "#{spec.name}.gemspec"
|
41
|
+
File.open(filename, "w") do |f|
|
42
|
+
f.puts spec.to_ruby
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
Rake::GemPackageTask.new(spec) do |pkg|
|
47
|
+
pkg.gem_spec = spec
|
48
|
+
end
|
49
|
+
|
50
|
+
desc "Install the gem locally"
|
51
|
+
task :install => [:package] do
|
52
|
+
sh %{sudo gem install pkg/couchrest-#{CouchRest::VERSION}}
|
53
|
+
end
|
54
|
+
|
55
|
+
desc "Run all specs"
|
56
|
+
Spec::Rake::SpecTask.new('spec') do |t|
|
57
|
+
t.spec_files = FileList['spec/**/*_spec.rb']
|
58
|
+
end
|
59
|
+
|
60
|
+
desc "Print specdocs"
|
61
|
+
Spec::Rake::SpecTask.new(:doc) do |t|
|
62
|
+
t.spec_opts = ["--format", "specdoc"]
|
63
|
+
t.spec_files = FileList['spec/*_spec.rb']
|
64
|
+
end
|
65
|
+
|
66
|
+
desc "Generate the rdoc"
|
67
|
+
Rake::RDocTask.new do |rdoc|
|
68
|
+
files = ["README.rdoc", "LICENSE", "lib/**/*.rb"]
|
69
|
+
rdoc.rdoc_files.add(files)
|
70
|
+
rdoc.main = "README.rdoc"
|
71
|
+
rdoc.title = "CouchRest: Ruby CouchDB, close to the metal"
|
72
|
+
end
|
73
|
+
|
74
|
+
desc "Run the rspec"
|
75
|
+
task :default => :spec
|
data/THANKS.md
ADDED
@@ -0,0 +1,18 @@
|
|
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
|
+
|
16
|
+
Patches are welcome. The primary source for this software project is [on Github](http://github.com/jchris/couchrest/tree/master)
|
17
|
+
|
18
|
+
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."
|