openlogic-couchrest_model 1.0.0

data/couchrest_model.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{openlogic-couchrest_model}
+  s.version = `cat VERSION`.strip
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["J. Chris Anderson", "Matt Aimonetti", "Marcos Tapajos", "Will Leinweber", "Sam Lown"]
+  s.date = File.mtime('VERSION')
+  s.description = %q{CouchRest Model provides aditional features to the standard CouchRest Document class such as properties, view designs, associations, callbacks, typecasting and validations.}
+  s.email = %q{jchris@apache.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md",
+    "THANKS.md"
+  ]
+  s.homepage = %q{http://github.com/couchrest/couchrest_model}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Extends the CouchRest Document for advanced modelling.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency(%q<couchrest>, "~> 1.1.2")
+  s.add_dependency(%q<mime-types>, "~> 1.15")
+  s.add_dependency(%q<activemodel>, "~> 3.0")
+  s.add_dependency(%q<tzinfo>, "~> 0.3.22")
+  s.add_development_dependency(%q<rspec>, "~> 2.6.0")
+  s.add_development_dependency(%q<json>, ["~> 1.5.1"])
+  s.add_development_dependency(%q<rack-test>, ">= 0.5.7")
+  s.add_development_dependency("rake", ">= 0.8.0")
+  # s.add_development_dependency("jruby-openssl", ">= 0.7.3")
+end
+

data/history.md

@@ -0,0 +1,309 @@
+# CouchRest Model Change History
+
+## 1.1.3
+	
+	* CouchRest::Model::Base.respond_to_missing? and respond_to? (Kim Burgestrand)
+
+## 1.1.2 - 2011-07-23
+
+* Minor fixes
+  * Upgrade to couchrest 1.1.2
+  * Override as_couch_json to ensure nil values not stored
+  * Removing restriction that prohibited objects that cast as an array to be loaded.
+
+## 1.1.1 - 2011-07-04
+
+* Minor fix
+  * Bumping CouchRest version dependency for important initialize method fix.
+  * Ensuring super on Embeddable#initialize can be called.
+
+## 1.1.0 - 2011-06-25
+
+* Major Alterations
+  * CastedModel no longer requires a Hash. Automatically includes all required methods.
+  * CastedModel module renamed to Embeddable (old still works!)
+
+* Minor Fixes
+  * Validation callbacks now support context (thanks kostia)
+  * Document comparisons now performed using database and document ID (pointer by neocsr)
+  * Automatic config generation now supported (thanks lucasrenan)
+  * Comparing documents resorts to Hash comparison if both IDs are nil. (pointer by kostia)
+
+## 1.1.0.rc1 - 2011-06-08
+
+* New Features
+  * Properties with a nil value are now no longer sent to the database.
+  * Now possible to build new objects via CastedArray#build
+  * Implement #get! and #find! class methods
+  * Now is possible delete particular elements in casted array(Kostiantyn Kahanskyi)
+
+* Minor fixes
+  * #as_json now correctly uses ActiveSupports methods.
+  * Rails 3.1 support (Peter Williams)
+  * Initialization blocks when creating new models (Peter Williams)
+  * Removed railties dependency (DAddYE)
+  * DesignDoc cache refreshed if a database is deleted.
+  * Fixing dirty tracking on collection_of association.
+  * Uniqueness Validation views created on initialization, not on demand!
+  * #destroy freezes object instead of removing _id and _rev, better for callbacks (pointer by karmi)
+  * #destroyed? method now available
+  * #reload no longer uses Hash#merge! which was causing issues with dirty tracking on casted models. (pointer by kostia)
+  * Non-property mass assignment on #new no longer possible without :directly_set_attributes option.
+  * Using CouchRest 1.1.0.pre3. (No more Hashes!)
+  * Fixing problem assigning a CastedHash to a property declared as a Hash (Kostiantyn Kahanskyi, gfmtim)
+
+## 1.1.0.beta5 - 2011-04-30
+
+* Major changes:
+  * Database auto configuration, with connection options!
+  * Changed default CouchRest Model type to 'type' to be more consistent with ActiveRecord's reserverd words we're all used to (sorry for the change again!!)
+
+* Minor changes
+  * Added filter option to designs (Used with CouchDB _changes feeds)
+
+## 1.1.0.beta4
+
+* Major changes:
+  * Fast Dirty Tracking! Many thanks to @sobakasu (Andrew Williams)
+  * Default CouchRest Model type field now set to 'model' instead of 'couchrest-type'.
+
+* Minor enhancements:
+  * Adding "couchrest-hash" to Design Docs with aim to improve view update handling.
+  * Major changes to the way design document updates are handled internally.
+  * Added "auto_update_design_doc" configuration option.
+  * Using #descending on View object will automatically swap startkey with endkey.
+
+## 1.1.0.beta3
+
+* Removed
+
+## 1.1.0.beta2
+
+* Minor enhancements:
+  * Time handling improved in accordance with CouchRest 1.1.0. Always set to UTC.
+  * Refinements to associations and uniqueness validation for proxy (based on issue found by Gleb Kanterov)
+  * Added :allow_nil and :allow_blank options when creating a new view
+  * Unique Validation now supports scopes!
+  * Added support for #keys with list on Design View.
+
+## 1.1.0.beta
+
+* Epic enhancements:
+  * Added "View" object for dynamic view queries
+  * Added easy to use proxy_for and proxied_by class methods for proxying data
+
+* Minor enhancements:
+  * A yield parameter in an anonymous casted model property block is no longer required (@samlown)
+  * Narrow the rescued exception to avoid catching class evaluation errors that has nothing to to with the association (thanks Simone Carletti)
+  * Fix validate uniqueness test that was never executed (thanks Simone Carletti)
+  * Adds a #reload method to reload document attributes (thanks Simone Carletti)
+  * Numeric types can be casted from strings with leading or trailing whitespace (thanks chrisdurtschi)
+  * CollectionProxy no longer provided by default with simple views (pending deprication)
+
+## CouchRest Model 1.0.0
+
+* Major enhancements
+  * Support for configuration module and "model_type_key" option for overriding model's type key
+  * Added "mass_assign_any_attribute" configuration option to allow setting anything via the attribute= method.
+
+* Minor enhancements
+  * Fixing find("") issue (thanks epochwolf)
+  * Altered protected attributes so that hash provided to #attributes= is not modified
+  * Altering typecasting for floats to better handle commas and points
+  * Fixing the lame pagination bug where database url (and pass!!) were included in view requests (Thanks James Hayton)
+
+Notes:
+
+* 2010-10-22 @samlown:
+  * ActiveModel Attribute support was added but has now been removed due to major performance issues.
+  Until these have been resolved (if possible?!) they should not be included. See the
+  'active_model_attrs' if you'd like to test.
+
+## CouchRest Model 1.0.0.beta8
+
+* Major enhancements
+	* Added model generator
+
+* Minor enhancements
+  * Raise error on adding objects to "collection_of" without an id
+  * Allow mixing of protected and accessible properties. Any unspecified properties are now assumed to be protected by default
+  * Parsing times without zone
+  * Using latest rspec (2.0.0.beta.19)
+
+## CouchRest Model 1.0.0.beta7
+
+* Major enhancements
+  * Renamed ExtendedDocument to CouchRest::Model
+  * Added initial support for simple belongs_to associations
+  * Added support for basic collection_of association (unique to document databases!)
+  * Moved Validation to ActiveModel
+  * Moved Callbacks to ActiveModel
+  * Removed support for properties defined using a string for the type instead of a class
+  * Validation always included
+  * Uniqueness validation now available
+
+* Minor enhancements
+  * Removed support for auto_validate! and :length on properties
+
+
+## 1.0.0.beta6
+
+* Major enhancements
+  * Added support for anonymous CastedModels defined in Documents
+
+* Minor enhancements
+  * Added 'find_by_*' alias for finding first item in view with matching key.
+  * Fixed issue with active_support in Rails3 and text in README for JSON.
+  * Refactoring of properties, added read_attribute and write_attribute methods.
+  * Now possible to send anything to update_attribtues method. Invalid or readonly attributes will be ignored.
+  * Attributes with arrays are *always* instantiated as a CastedArray.
+  * Setting a property of type Array (or keyed hash) must be an array or an error will be raised.
+  * Now possible to set Array attribute from hash where keys determine order.
+
+## 1.0.0.beta5
+
+* Minor enhancements
+  * Added 'find' alias for 'get' for easier rails transition
+
+## 1.0.0.beta3
+
+* Minor enhancements
+  * Removed Validation by default, requires too many structure changes (FAIL)
+  * Added support for instantiation of documents read from database as couchrest-type provided (Sam Lown)
+  * Improved attachment handling for detecting file type (Sam Lown)
+  * Removing some monkey patches and relying on active_support for constantize and humanize (Sam Lown)
+  * Added support for setting type directly on property (Sam Lown)
+
+
+## 1.0.0.beta2
+
+* Minor enhancements
+  * Enable Validation by default and refactored location (Sam Lown)
+
+## 1.0.0.beta
+
+* Major enhancements
+  * Separated ExtendedDocument from main CouchRest gem (Sam Lown)
+
+* Minor enhancements
+  * active_support included by default
+
+## 0.37
+
+* Minor enhancements
+  * Added gemspec (needed for Bundler install) (Tapajós)
+
+## 0.36
+
+* Major enhancements
+  * Adds support for continuous replication (sauy7)
+  * Automatic Type Casting (Alexander Uvarov, Sam Lown, Tim Heighes, Will Leinweber)
+  * Added a search method to CouchRest:Database to search the documents in a given database. (Dave Farkas, Arnaud Berthomier, John Wood)
+
+* Minor enhancements
+  * Provide a description of the timeout error (John Wood)
+
+## 0.35
+
+* Major enhancements
+  * CouchRest::ExtendedDocument allow chaining the inherit class callback (Kenneth Kalmer) - http://github.com/couchrest/couchrest/issues#issue/8
+
+* Minor enhancements
+  * Fix attachment bug (Johannes Jörg Schmidt)
+  * Fix create database exception bug (Damien Mathieu)
+  * Compatible with restclient >= 1.4.0 new responses (Julien Kirch)
+  * Bug fix: Attribute protection no longer strips attributes coming from the database (Will Leinweber)
+  * Bug fix: Remove double CGI escape when PUTting an attachment (nzoschke)
+  * Bug fix: Changing Class proxy to set database on result sets (Peter Gumeson)
+  * Bug fix: Updated time regexp (Nolan Darilek)
+  * Added an update_doc method to database to handle conflicts during atomic updates. (Pierre Larochelle)
+  * Bug fix: http://github.com/couchrest/couchrest/issues/#issue/2 (Luke Burton)
+
+## 0.34
+
+* Major enhancements
+
+  * Added support for https database URIs. (Mathias Meyer)
+  * Changing some validations to be compatible with activemodel. (Marcos Tapajós)
+  * Adds attribute protection to properties. (Will Leinweber)
+  * Improved CouchRest::Database#save_doc, added "batch" mode to significantly speed up saves at cost of lower durability gurantees. (Igal Koshevoy)
+  * Added CouchRest::Database#bulk_save_doc and #batch_save_doc as human-friendlier wrappers around #save_doc. (Igal Koshevoy)
+
+* Minor enhancements
+
+  * Fix content_type handling for attachments
+  * Fixed a bug in the pagination code that caused it to paginate over records outside of the scope of the view parameters.(John Wood)
+  * Removed amount_pages calculation for the pagination collection, since it cannot be reliably calculated without a view.(John Wood)
+  * Bug fix: http://github.com/couchrest/couchrest/issues/#issue/2 (Luke Burton)
+  * Bug fix: http://github.com/couchrest/couchrest/issues/#issue/1 (Marcos Tapajós)
+  * Removed the Database class deprecation notices (Matt Aimonetti)
+  * Adding support to :cast_as => 'Date'.  (Marcos Tapajós)
+  * Improve documentation  (Marcos Tapajós)
+  * Streamer fixes (Julien Sanchez)
+  * Fix Save on Document & ExtendedDocument crashed if bulk (Julien Sanchez)
+  * Fix Initialization of ExtendentDocument model shouldn't failed on a nil value in argument (deepj)
+  * Change to use Jeweler and Gemcutter (Marcos Tapajós)
+
+## 0.33
+
+* Major enhancements
+
+  * Added a new Rack logger middleware letting you log/save requests/queries (Matt Aimonetti)
+
+* Minor enhancements
+
+  * Added #amount_pages to a paginated result array (Matt Aimonetti)
+  * Ruby 1.9.2 compatible (Matt Aimonetti)
+  * Added a property? method for property cast as :boolean (John Wood)
+  * Added an option to force the deletion of a attachments (bypass 409s) (Matt Aimonetti)
+  * Created a new abstraction layer for the REST API (Matt Aimonetti)
+  * Bug fix: made ExtendedDocument#all compatible with Couch 0.10 (tc)
+
+## 0.32
+
+* Major enhancements
+
+  * ExtendedDocument.get doesn't raise an exception anymore. If no documents are found nil is returned.
+  * ExtendedDocument.get! works the say #get used to work and will raise an exception if a document isn't found.
+
+* Minor enhancements
+
+  * Bug fix: Model.all(:keys => [1,2]) was not working (Matt Aimonetti)
+  * Added ValidationErrors#count in order to play nicely with Rails (Peter Wagenet)
+  * Bug fix: class proxy design doc refresh (Daniel Kirsh)
+  * Bug fix: the count method on the proxy collection was missing (Daniel Kirsch)
+  * Added #amount_pages to a paginated collection. (Matt Aimonetti)
+
+## 0.31
+
+* Major enhancements
+
+  * Created an abstraction HTTP layer to support different http adapters (Matt Aimonetti)
+  * Added ExtendedDocument.create({}) and #create!({}) so you don't have to do Model.new.create (Matt Aimonetti)
+
+* Minor enhancements
+
+  * Added an init.rb file for easy usage as a Rails plugin (Aaron Quint)
+  * Bug fix: pagination shouldn't die on empty results (Arnaud Berthomier)
+  * Optimized ExtendedDocument.count to run about 3x faster (Matt Aimonetti)
+  * Added Float casting (Ryan Felton & Matt Aimonetti)
+
+## 0.30
+
+* Major enhancements
+
+  * Added support for pagination (John Wood)
+  * Improved performance when initializing documents with timestamps (Matt Aimonetti)
+
+* Minor enhancements
+
+  * Extended the API to retrieve an attachment URI (Matt Aimonetti)
+  * Bug fix: default value should be able to be set as false (Alexander Uvarov)
+  * Bug fix: validates_is_numeric should be able to properly validate a Float instance (Rob Kaufman)
+  * Bug fix: fixed the Timeout implementation (Seth Falcon)
+
+
+---
+
+Unfortunately, before 0.30 we did not keep a track of the modifications made to CouchRest.
+You can see the full commit history on GitHub: http://github.com/couchrest/couchrest/commits/master/

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__),'lib', 'couchrest', 'model')

data/lib/couchrest/model.rb

@@ -0,0 +1,10 @@
+
+module CouchRest
+
+  module Model
+
+    VERSION = File.read(File.expand_path('../../../VERSION', __FILE__)).strip
+
+  end
+
+end

data/lib/couchrest/model/associations.rb

@@ -0,0 +1,231 @@
+module CouchRest
+  module Model
+    module Associations
+
+      # Basic support for relationships between CouchRest::Model::Base
+      
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+
+        # Define an association that this object belongs to.
+        #
+        # An attribute will be created matching the name of the attribute
+        # with '_id' on the end, or the foreign key (:foreign_key) provided.
+        #
+        # Searching for the assocated object is performed using a string 
+        # (:proxy) to be evaulated in the context of the owner. Typically
+        # this will be set to the class name (:class_name), or determined
+        # automatically if the owner belongs to a proxy object.
+        #
+        # If the association owner is proxied by another model, than an attempt will
+        # be made to automatically determine the correct place to request
+        # the documents. Typically, this is a method with the pluralized name of the 
+        # association inside owner's owner, or proxy.
+        #
+        # For example, imagine a company acts as a proxy for invoices and clients.
+        # If an invoice belongs to a client, the invoice will need to access the
+        # list of clients via the proxy. So a request to search for the associated
+        # client from an invoice would look like:
+        #
+        #    self.company.clients
+        #
+        # If the name of the collection proxy is not the pluralized assocation name, 
+        # it can be set with the :proxy_name option.
+        #
+        def belongs_to(attrib, *options)
+          opts = merge_belongs_to_association_options(attrib, options.first)
+
+          property(opts[:foreign_key], opts)
+
+          create_belongs_to_getter(attrib, opts)
+          create_belongs_to_setter(attrib, opts)
+        end
+
+        # Provide access to a collection of objects where the associated
+        # property contains a list of the collection item ids.
+        #
+        # The following:
+        #
+        #     collection_of :groups
+        #
+        # creates a pseudo property called "groups" which allows access
+        # to a CollectionOfProxy object. Adding, replacing or removing entries in this
+        # proxy will cause the matching property array, in this case "group_ids", to
+        # be kept in sync.
+        #
+        # Any manual changes made to the collection ids property (group_ids), unless replaced, will require
+        # a reload of the CollectionOfProxy for the two sets of data to be in sync:
+        #
+        #     group_ids = ['123']
+        #     groups == [Group.get('123')]
+        #     group_ids << '321'
+        #     groups == [Group.get('123')]
+        #     groups(true) == [Group.get('123'), Group.get('321')]
+        #
+        # Of course, saving the parent record will store the collection ids as they are
+        # found.
+        #
+        # The CollectionOfProxy supports the following array functions, anything else will cause
+        # a mismatch between the collection objects and collection ids:
+        #
+        #     groups << obj
+        #     groups.push obj
+        #     groups.unshift obj
+        #     groups[0] = obj
+        #     groups.pop == obj
+        #     groups.shift == obj
+        #
+        # Addtional options match those of the the belongs_to method.
+        #
+        # NOTE: This method is *not* recommended for large collections or collections that change
+        # frequently! Use with prudence.
+        #
+        def collection_of(attrib, *options)
+          opts = merge_belongs_to_association_options(attrib, options.first)
+          opts[:foreign_key] = opts[:foreign_key].pluralize
+          opts[:readonly] = true
+
+          property(opts[:foreign_key], [], opts)
+
+          create_collection_of_property_setter(attrib, opts)
+          create_collection_of_getter(attrib, opts)
+          create_collection_of_setter(attrib, opts)
+        end
+
+
+        private
+
+        def merge_belongs_to_association_options(attrib, options = nil)
+          opts = {
+            :foreign_key => attrib.to_s.singularize + '_id',
+            :class_name => attrib.to_s.singularize.camelcase,
+            :proxy_name => attrib.to_s.pluralize
+          }
+          opts.merge!(options) if options.is_a?(Hash)
+
+          # Generate a string for the proxy method call
+          # Assumes that the proxy_owner_method from "proxyable" is available.
+          if opts[:proxy].to_s.empty?
+            opts[:proxy] = if proxy_owner_method
+              "self.#{proxy_owner_method}.#{opts[:proxy_name]}"
+            else
+              opts[:class_name]
+            end
+          end
+
+          opts
+        end
+
+        def create_belongs_to_getter(attrib, options)
+          class_eval <<-EOS, __FILE__, __LINE__ + 1
+            def #{attrib}
+              @#{attrib} ||= #{options[:foreign_key]}.nil? ? nil : #{options[:proxy]}.get(self.#{options[:foreign_key]})
+            end
+          EOS
+        end
+
+        def create_belongs_to_setter(attrib, options)
+          class_eval <<-EOS, __FILE__, __LINE__ + 1
+            def #{attrib}=(value)
+              self.#{options[:foreign_key]} = value.nil? ? nil : value.id
+              @#{attrib} = value
+            end
+          EOS
+        end
+
+        ### collection_of support methods
+
+        def create_collection_of_property_setter(attrib, options)
+          # ensure CollectionOfProxy is nil, ready to be reloaded on request
+          class_eval <<-EOS, __FILE__, __LINE__ + 1
+            def #{options[:foreign_key]}=(value)
+              @#{attrib} = nil
+              write_attribute("#{options[:foreign_key]}", value)
+            end
+          EOS
+        end
+
+        def create_collection_of_getter(attrib, options)
+          class_eval <<-EOS, __FILE__, __LINE__ + 1
+            def #{attrib}(reload = false)
+              return @#{attrib} unless @#{attrib}.nil? or reload
+              ary = self.#{options[:foreign_key]}.collect{|i| #{options[:proxy]}.get(i)}
+              @#{attrib} = ::CouchRest::Model::CollectionOfProxy.new(ary, find_property('#{options[:foreign_key]}'), self)
+            end
+          EOS
+        end
+
+        def create_collection_of_setter(attrib, options)
+          class_eval <<-EOS, __FILE__, __LINE__ + 1
+            def #{attrib}=(value)
+              @#{attrib} = ::CouchRest::Model::CollectionOfProxy.new(value, find_property('#{options[:foreign_key]}'), self)
+            end
+          EOS
+        end
+
+      end
+
+    end
+
+    # Special proxy for a collection of items so that adding and removing
+    # to the list automatically updates the associated property.
+    class CollectionOfProxy < CastedArray
+
+      def initialize(array, property, parent)
+        (array ||= []).compact!
+        super(array, property, parent)
+        casted_by[casted_by_property.to_s] = [] # replace the original array!
+        array.compact.each do |obj|
+          check_obj(obj)
+          casted_by[casted_by_property.to_s] << obj.id
+        end
+      end
+
+      def << obj
+        check_obj(obj)
+        casted_by[casted_by_property.to_s] << obj.id
+        super(obj)
+      end
+
+      def push(obj)
+        check_obj(obj)
+        casted_by[casted_by_property.to_s].push obj.id
+        super(obj)
+      end
+
+      def unshift(obj)
+        check_obj(obj)
+        casted_by[casted_by_property.to_s].unshift obj.id
+        super(obj)
+      end
+
+      def []= index, obj
+        check_obj(obj)
+        casted_by[casted_by_property.to_s][index] = obj.id
+        super(index, obj)
+      end
+
+      def pop
+        casted_by[casted_by_property.to_s].pop
+        super
+      end
+
+      def shift
+        casted_by[casted_by_property.to_s].shift
+        super
+      end
+
+      protected
+
+      def check_obj(obj)
+        raise "Object cannot be added to #{casted_by.class.to_s}##{casted_by_property.to_s} collection unless saved" if obj.new?
+      end
+
+    end
+
+  end
+
+end