couchrest_model 1.0.0.beta7

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,320 @@
+# CouchRest Model: CouchDB, close to shiny metal with rounded edges
+
+CouchRest Models adds additional functionality to the standard CouchRest Document class such as
+setting properties, callbacks, typecasting, and validations.
+
+Originally called ExtendedDocument, the new Model structure uses ActiveModel, part of Rails 3, 
+for validations and callbacks.
+
+If your project is still running Rails 2.3, you'll have to continue using ExtendedDocument as 
+it is not possible to load ActiveModel into programs that do not use ActiveSupport 3.0.
+
+CouchRest Model only supports CouchDB 0.10.0 or newer.
+
+## Install
+
+    $ sudo gem install couchrest_model
+   
+## General Usage 
+
+    require 'couchrest_model'
+
+    class Cat < CouchRest::Model::Base
+
+      property :name,      String
+      property :lives,     Integer, :default => 9
+
+      property :nicknames, [String]
+
+      timestamps!
+
+      view_by :name
+
+    end
+
+    @cat = Cat.new(:name => 'Felix', :nicknames => ['so cute', 'sweet kitty'])
+
+    @cat.new?   # true
+    @cat.save
+
+    @cat['name']   # "Felix"
+
+    @cat.nicknames << 'getoffdamntable'
+
+    @cat = Cat.new
+    @cat.update_attributes(:name => 'Felix', :random_text => 'feline')
+    @cat.new? # false
+    @cat.random_text  # Raises error!
+
+
+## Properties
+
+Only attributes with a property definition will be stored be CouchRest Model (as opposed
+to a normal CouchRest Document which will store everything). To help prevent confusion, 
+a property should be considered as the definition of an attribute. An attribute must be associated
+with a property, but a property may not have any attributes associated if none have been set.
+
+
+In its simplest form, a property
+will only create a getter and setter passing all attribute data directly to the database. Assuming the attribute
+provided responds to +to_json+, there will not be any problems saving it, but when loading the 
+data back it will either be a string, number, array, or hash:
+
+    class Cat < CouchRest::Model::Base
+      property :name
+      property :birthday
+    end
+
+    @cat = Cat.new(:name => 'Felix', :birthday => 2.years.ago)
+    @cat.name        # 'Felix'
+    @cat.birthday.is_a?(Time)  # True!
+    @cat.save
+    @cat = Cat.find(@cat.id)
+    @cat.name        # 'Felix'
+    @cat.birthday.is_a?(Time)  # False!
+
+Properties create getters and setters similar to the following:
+
+    def name
+      read_attribute('name')
+    end
+
+    def name=(value)
+      write_attribute('name', value)
+    end
+
+Properties can also have a type which 
+will be used for casting data retrieved from CouchDB when the attribute is set:
+
+    class Cat < CouchRest::Model::Base
+      property :name, String
+      property :last_fed_at, Time
+    end
+
+    @cat = Cat.new(:name => 'Felix', :last_fed_at => 10.minutes.ago)
+    @cat.last_fed_at.is_a?(Time)   # True!
+    @cat.save
+    @cat = Cat.find(@cat.id)
+    @cat.last_fed_at < 20.minutes.ago   # True!
+
+
+Booleans or TrueClass will also create a getter with question mark at the end:
+
+    class Cat < CouchRest::Model::Base
+      property :awake, TrueClass, :default => true
+    end
+
+    @cat.awake?   # true
+
+Adding the +:default+ option will ensure the attribute always has a value.
+
+Defining a property as read-only will mean that its value is set only when read from the
+database and that it will not have a setter method. You can however update a read-only
+attribute using the +write_attribute+ method:
+
+    class Cat < CouchRest::Model::Base
+      property :name, String
+      property :lives, Integer, :default => 9, :readonly => true  
+
+      def fall_off_balcony!
+        write_attribute(:lives, lives - 1)
+        save
+      end
+    end
+
+    @cat = Cat.new(:name => "Felix")
+    @cat.fall_off_balcony!
+    @cat.lives    # Now 8!
+
+
+## Property Arrays
+
+An attribute may also contain an array of data. CouchRest Model handles this, along
+with casting, by defining the class of the child attributes inside an Array:
+
+    class Cat < CouchRest::Model::Base
+      property :name, String
+      property :nicknames, [String]
+    end
+
+By default, the array will be ready to use from the moment the object as been instantiated:
+
+    @cat = Cat.new(:name => 'Fluffy')
+    @cat.nicknames << 'Buffy'
+
+    @cat.nicknames == ['Buffy']
+
+When anything other than a string is set as the class of a property, the array will be converted
+into special wrapper called a CastedArray. If the child objects respond to the 'casted_by' method
+(such as those created with CastedModel, below) it will contain a reference to the parent.
+
+## Casted Models
+
+CouchRest Model allows you to take full advantage of CouchDB's ability to store complex 
+documents and retrieve them using the CastedModel module. Simply include the module in
+a Hash (or other model that responds to the [] and []= methods) and set any properties
+you'd like to use. For example:
+
+    class CatToy << Hash
+      include CouchRest::Model::CastedModel
+
+      property :name, String
+      property :purchased, Date
+    end
+
+    class Cat << CouchRest::Model::Base
+      property :name, String
+      property :toys, [CatToy]
+    end
+
+    @cat = Cat.new(:name => 'Felix', :toys => [{:name => 'mouse', :purchases => 1.month.ago}])
+    @cat.toys.first.class == CatToy
+    @cat.toys.first.name == 'mouse'
+
+Additionally, any hashes sent to the property will automatically be converted:
+
+    @cat.toys << {:name => 'catnip ball'}
+    @cat.toys.last.is_a?(CatToy) # True!
+
+Of course, to use your own classes they *must* be defined before the parent uses them otherwise 
+Ruby will bring up a missing constant error. To avoid this, or if you have a really simple array of data
+you'd like to model, the latest version of CouchRest Model (> 1.0.0) supports creating
+anonymous classes:
+
+    class Cat << CouchRest::Model::Base
+      property :name, String
+
+      property :toys do |toy|
+        toy.property :name, String
+        toy.property :rating, Integer
+      end
+    end
+
+    @cat = Cat.new(:name => 'Felix', :toys => [{:name => 'mouse', :rating => 3}, {:name => 'catnip ball', :rating => 5}])
+    @cat.toys.last.rating == 5
+    @cat.toys.last.name == 'catnip ball'
+
+Using this method of anonymous classes will *only* create arrays of objects.
+
+
+## Assocations
+
+Two types at the moment:
+
+    belongs_to :person
+
+    collection_of :tags
+
+TODO: Document properly!
+
+
+
+## Validations
+
+CouchRest Model automatically includes the new ActiveModel validations, so they should work just as the traditional Rails
+validations. For more details, please see the ActiveModel::Validations documentation.
+
+CouchRest Model adds the possibility to check the uniqueness of attributes using the @validates_uniqueness_of@ class method, for example:
+
+    class Person < CouchRest::Model::Base
+      property :title, String
+     
+      validates_uniqueness_of :title
+    end
+
+The uniqueness validation creates a new view for the attribute or uses one that already exists. You can
+specify a different view using the +:view+ option, useful for when the @unique_id@ is specified and
+you'd like to avoid the typical RestClient Conflict error:
+
+    unique_id :code
+    validates_uniqueness_of :code, :view => 'all'
+
+Given that the uniqueness check performs a request to the database, it is also possible
+to include a @:proxy@ parameter. This allows you to
+call a method on the document and provide an alternate proxy object.
+
+Examples:
+
+    # Same as not including proxy:
+    validates_uniqueness_of :title, :proxy => 'class'
+    
+    # Person#company.people provides a proxy object for people
+    validates_uniqueness_of :title, :proxy => 'company.people'
+
+
+A really interesting use of +:proxy+ and +:view+ together could be where
+you'd like to ensure the ID is unique between several types of document. For example:
+
+    class Product < CouchRest::Model::Base
+      property :code
+
+      validates_uniqueness_of :code, :view => 'by_product_code'
+
+      view_by :product_code, :map => "
+        function(doc) {
+          if (doc['couchrest-type'] == 'Product' || doc['couchrest-type'] == 'Project') {
+            emit(doc['code']);
+          }
+        }
+      "
+    end
+
+    class Project < CouchRest::Model::Base
+      property :code
+
+      validates_uniqueness_of :code, :view => 'by_product_code', :proxy => 'Product'
+    end
+
+Pretty cool!
+
+
+
+## Notable Issues
+
+CouchRest Model uses active_support for some of its internals. Ensure you have a stable active support gem installed 
+or at least 3.0.0.beta4.
+
+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.
+
+## Ruby on Rails
+
+CouchRest Model is compatible with rails and provides some ActiveRecord-like methods.
+
+The CouchRest companion rails project 
+[http://github.com/hpoydar/couchrest-rails](http://github.com/hpoydar/couchrest-rails) is great
+for provided default connection details for your database. At the time of writting however it 
+does not provide explicit support for CouchRest Model.
+
+CouchRest Model and the original CouchRest ExtendedDocument do not share the same namespace, 
+as such you should not have any problems using them both at the same time. This might
+help with migrations.
+
+
+### Rails 3.0
+
+In your Gemfile require the gem with a simple line:
+
+    gem "couchrest_model"
+
+
+## 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_model](http://rdoc.info/projects/couchrest/couchrest_model)
+
+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)
+