samlown-couchrest_extended_document 1.0.0

data/LICENSE

@@ -0,0 +1,176 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,46 @@
+# CouchRest::ExtendedDocument: CouchDB, not too close to the metal
+
+CouchRest::ExtendedDocument adds additional functionality to the standard CouchRest Document class such as
+setting properties, callbacks, typecasting, and validations.
+
+Note: CouchRest only supports CouchDB 0.9.0 or newer.
+
+## Install
+
+    $ sudo gem install couchrest_extended_document
+   
+## Usage
+
+    require 'couchrest/extended_document'
+
+    class Cat < CouchRest::ExtendedDocument
+
+      property :name, :type => String
+
+    end
+
+## Testing
+
+The most complete documentation is the spec/ directory. To validate your
+CouchRest install, from the project root directory run `rake`, or `autotest`
+(requires RSpec and optionally ZenTest for autotest support).
+
+## Docs
+
+API: [http://rdoc.info/projects/couchrest/couchrest_extended_document](http://rdoc.info/projects/couchrest/couchrest_extended_document)
+
+Check the wiki for documentation and examples [http://wiki.github.com/couchrest/couchrest](http://wiki.github.com/couchrest/couchrest)
+
+## Contact
+
+Please post bugs, suggestions and patches to the bug tracker at [http://github.com/couchrest/couchrest/issues](http://github.com/couchrest/couchrest/issues).
+
+Follow us on Twitter: [http://twitter.com/couchrest](http://twitter.com/couchrest)
+
+Also, check [http://twitter.com/#search?q=%23couchrest](http://twitter.com/#search?q=%23couchrest)
+      
+## Ruby on Rails
+
+CouchRest is compatible with rails and can even be used a Rails plugin.
+However, you might be interested in the CouchRest companion rails project:
+[http://github.com/hpoydar/couchrest-rails](http://github.com/hpoydar/couchrest-rails)      

data/Rakefile

@@ -0,0 +1,67 @@
+require 'rake'
+require "rake/rdoctask"
+require File.join(File.expand_path(File.dirname(__FILE__)),'lib','couchrest','extended_document')
+
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "samlown-couchrest_extended_document"
+    gemspec.summary = "Extend CouchRest Document class with useful features."
+    gemspec.description = "CouchRest::ExtendedDocument provides aditional features to the standard CouchRest::Document class such as properties, view designs, callbacks, typecasting and validations."
+    gemspec.email = "jchris@apache.org"
+    gemspec.homepage = "http://github.com/samlown/couchrest_extended_document"
+    gemspec.authors = ["J. Chris Anderson", "Matt Aimonetti", "Marcos Tapajos", "Will Leinweber"]
+    gemspec.extra_rdoc_files = %w( README.md LICENSE THANKS.md )
+    gemspec.files = %w( LICENSE README.md Rakefile THANKS.md history.txt couchrest.gemspec) + Dir["{examples,lib,spec,utils}/**/*"] - Dir["spec/tmp"]
+    gemspec.has_rdoc = true
+    gemspec.add_dependency("samlown-couchrest", ">= 1.0.0")
+    gemspec.add_dependency("mime-types", ">= 1.15")
+    gemspec.version = CouchRest::ExtendedDocument::VERSION
+    gemspec.date = "2008-11-22"
+    gemspec.require_path = "lib"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+	t.spec_opts = ["--color"]
+	t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Print specdocs"
+Spec::Rake::SpecTask.new(:doc) do |t|
+	t.spec_opts = ["--format", "specdoc"]
+	t.spec_files = FileList['spec/*_spec.rb']
+end
+
+desc "Generate the rdoc"
+Rake::RDocTask.new do |rdoc|
+  files = ["README.rdoc", "LICENSE", "lib/**/*.rb"]
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.rdoc"
+  rdoc.title = "CouchRest: Ruby CouchDB, close to the metal"
+end
+
+desc "Run the rspec"
+task :default => :spec
+
+module Rake
+  def self.remove_task(task_name)
+    Rake.application.instance_variable_get('@tasks').delete(task_name.to_s)
+  end
+end
+
+Rake.remove_task("github:release")
+Rake.remove_task("release")

data/THANKS.md

@@ -0,0 +1,19 @@
+CouchRest THANKS
+=====================
+
+CouchRest was originally developed by J. Chris Anderson <jchris@grabb.it>
+and a number of other contributors. Many people further contributed to 
+CouchRest by reporting problems, suggesting various improvements or submitting
+changes. A list of these people is included below.
+
+ * [Matt Aimonetti](http://merbist.com/about/)
+ * [Greg Borenstein](http://ideasfordozens.com)
+ * [Geoffrey Grosenbach](http://nubyonrails.com/)
+ * [Jonathan S. Katz](http://github.com/jkatz)
+ * [Matt Lyon](http://mattly.tumblr.com/)
+ * Simon Rozet (simon /at/ rozet /dot/ name)
+ * [Marcos Tapajós](http://tapajos.me)
+ 
+Patches are welcome. The primary source for this software project is [on Github](http://github.com/couchrest/couchrest)
+
+A lot of people have active forks - thank you all - even the patches I don't end up using are helpful.

data/examples/model/example.rb

@@ -0,0 +1,144 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'couchrest')
+
+def show obj
+  puts obj.inspect
+  puts
+end
+
+SERVER = CouchRest.new
+SERVER.default_database = 'couchrest-extendeddoc-example'
+
+class Author < CouchRest::ExtendedDocument
+  use_database SERVER.default_database
+  property :name
+  
+  def drink_scotch
+    puts "... glug type glug ... I'm #{name} ... type glug glug ..."
+  end
+end
+
+class Post < CouchRest::ExtendedDocument
+  use_database SERVER.default_database
+  
+  property :title
+  property :body
+  property :author, :cast_as => 'Author'
+
+  timestamps!
+end
+
+class Comment < CouchRest::ExtendedDocument
+  use_database SERVER.default_database
+  
+  property :commenter, :cast_as => 'Author'
+  timestamps!
+  
+  def post= post
+    self["post_id"] = post.id
+  end
+  def post
+    Post.get(self['post_id']) if self['post_id']
+  end
+  
+end
+
+puts "Act I: CRUD"
+puts
+puts "(pause for dramatic effect)"
+puts
+sleep 2
+
+puts "Create an author."
+quentin = Author.new("name" => "Quentin Hazel")
+show quentin
+
+puts "Create a new post."
+post = Post.new(:title => "First Post", :body => "Lorem ipsum dolor sit amet, consectetur adipisicing elit...")
+show post
+
+puts "Add the author to the post."
+post.author = quentin
+show post
+
+puts "Save the post."
+post.save
+show post
+
+puts "Load the post."
+reloaded = Post.get(post.id)
+show reloaded
+
+puts "The author of the post is an instance of Author."
+reloaded.author.drink_scotch
+
+puts "\nAdd some comments to the post."
+comment_one = Comment.new :text => "Blah blah blah", :commenter => {:name => "Joe Sixpack"}
+comment_two = Comment.new :text => "Yeah yeah yeah", :commenter => {:name => "Jane Doe"}
+comment_three = Comment.new :text => "Whatever...", :commenter => {:name => "John Stewart"}
+
+# TODO - maybe add some magic here?
+comment_one.post = post
+comment_two.post = post
+comment_three.post = post
+comment_one.save
+comment_two.save
+comment_three.save
+
+show comment_one
+show comment_two
+show comment_three
+
+puts "We can load a post through its comment (no magic here)."
+show post = comment_one.post
+
+puts "Commenters are also authors."
+comment_two['commenter'].drink_scotch
+comment_one['commenter'].drink_scotch
+comment_three['commenter'].drink_scotch
+
+puts "\nLet's save an author to her own document."
+jane = comment_two['commenter']
+jane.save
+show jane
+
+puts "Oh, that's neat! Because Ruby passes hash valuee by reference, Jane's new id has been added to the comment she left."
+show comment_two
+
+puts "Of course, we'd better remember to save it."
+comment_two.save
+show comment_two
+
+puts "Oooh, denormalized... feel the burn!"
+puts
+puts
+puts
+puts "Act II: Views"
+puts
+puts
+sleep 2
+
+puts "Let's find all the comments that go with our post."
+puts "Our post has id #{post.id}, so lets find all the comments with that post_id."
+puts
+
+class Comment
+  view_by :post_id
+end
+
+comments = Comment.by_post_id :key => post.id
+show comments
+
+puts "That was too easy."
+puts "We can even wrap it up in a finder on the Post class."
+puts
+
+class Post
+  def comments
+    Comment.by_post_id :key => id
+  end
+end
+
+show post.comments
+puts "Gimme 5 minutes and I'll roll this into the framework. ;)"
+puts
+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."