couchrest_model 1.0.0.beta7

data/Rakefile

@@ -0,0 +1,71 @@
+require 'rake'
+require "rake/rdoctask"
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'couchrest_model'
+
+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 = "couchrest_model"
+    gemspec.summary = "Extends the CouchRest Document for advanced modelling."
+    gemspec.description = "CouchRest Model provides aditional features to the standard CouchRest Document class such as properties, view designs, associations, callbacks, typecasting and validations."
+    gemspec.email = "jchris@apache.org"
+    gemspec.homepage = "http://github.com/couchrest/couchrest_model"
+    gemspec.authors = ["J. Chris Anderson", "Matt Aimonetti", "Marcos Tapajos", "Will Leinweber", "Sam Lown"]
+    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("couchrest", ">= 1.0.0.beta")
+    gemspec.add_dependency("mime-types", ">= 1.15")
+    gemspec.add_dependency("activesupport", ">= 2.3.5")
+    gemspec.add_dependency("activemodel", ">= 3.0.0.beta4")
+    gemspec.version = CouchRest::Model::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."

data/history.txt

@@ -0,0 +1,180 @@
+== Next Version
+
+* Major enhancements
+
+* Minor enhancements
+
+== 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
+
+
+== 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/lib/couchrest/model.rb

@@ -0,0 +1,10 @@
+
+module CouchRest
+
+  module Model
+
+    VERSION = "1.0.0.beta7"
+
+  end
+
+end

data/lib/couchrest/model/associations.rb

@@ -0,0 +1,207 @@
+module CouchRest
+  module Model
+    module Associations
+
+      # Basic support for relationships between ExtendedDocuments
+      
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+
+        # Define an association that this object belongs to.
+        # 
+        def belongs_to(attrib, *options)
+          opts = {
+            :foreign_key => attrib.to_s + '_id',
+            :class_name => attrib.to_s.camelcase,
+            :proxy => nil
+          }
+          case options.first
+          when Hash
+            opts.merge!(options.first)
+          end
+
+          begin
+            opts[:class] = opts[:class_name].constantize
+          rescue
+            raise "Unable to convert class name into Constant for #{self.name}##{attrib}"
+          end
+
+          prop = property(opts[:foreign_key], opts)
+
+          create_belongs_to_getter(attrib, prop, opts)
+          create_belongs_to_setter(attrib, prop, opts)
+
+          prop
+        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 = {
+            :foreign_key => attrib.to_s.singularize + '_ids',
+            :class_name => attrib.to_s.singularize.camelcase,
+            :proxy => nil
+          }
+          case options.first
+          when Hash
+            opts.merge!(options.first)
+          end
+          begin
+            opts[:class] = opts[:class_name].constantize
+          rescue
+            raise "Unable to convert class name into Constant for #{self.name}##{attrib}"
+          end
+          opts[:readonly] = true
+
+          prop = property(opts[:foreign_key], [], opts)
+
+          create_collection_of_property_setter(attrib, prop, opts)
+          create_collection_of_getter(attrib, prop, opts)
+          create_collection_of_setter(attrib, prop, opts)
+
+          prop
+        end
+
+
+        private
+
+        def create_belongs_to_getter(attrib, property, options)
+          base = options[:proxy] || options[:class_name]
+          class_eval <<-EOS, __FILE__, __LINE__ + 1
+            def #{attrib}
+              @#{attrib} ||= #{options[:foreign_key]}.nil? ? nil : #{base}.get(self.#{options[:foreign_key]})
+            end
+          EOS
+        end
+
+        def create_belongs_to_setter(attrib, property, 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, property, 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, property, options)
+          base = options[:proxy] || options[:class_name]
+          class_eval <<-EOS, __FILE__, __LINE__ + 1
+            def #{attrib}(reload = false)
+              return @#{attrib} unless @#{attrib}.nil? or reload
+              ary = self.#{options[:foreign_key]}.collect{|i| #{base}.get(i)}
+              @#{attrib} = ::CouchRest::CollectionOfProxy.new(ary, self, '#{options[:foreign_key]}')
+            end
+          EOS
+        end
+
+        def create_collection_of_setter(attrib, property, options)
+          class_eval <<-EOS, __FILE__, __LINE__ + 1
+            def #{attrib}=(value)
+              @#{attrib} = ::CouchRest::CollectionOfProxy.new(value, self, '#{options[:foreign_key]}')
+            end
+          EOS
+        end
+
+      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 < Array
+    attr_accessor :property
+    attr_accessor :casted_by
+
+    def initialize(array, casted_by, property)
+      self.property = property
+      self.casted_by = casted_by
+      (array ||= []).compact!
+      casted_by[property.to_s] = [] # replace the original array!
+      array.compact.each do |obj|
+        casted_by[property.to_s] << obj.id
+      end
+      super(array)
+    end
+    def << obj
+      casted_by[property.to_s] << obj.id
+      super(obj)
+    end
+    def push(obj)
+      casted_by[property.to_s].push obj.id
+      super(obj)
+    end
+    def unshift(obj)
+      casted_by[property.to_s].unshift obj.id
+      super(obj)
+    end
+
+    def []= index, obj
+      casted_by[property.to_s][index] = obj.id
+      super(index, obj)
+    end
+
+    def pop
+      casted_by[property.to_s].pop
+      super
+    end
+    def shift
+      casted_by[property.to_s].shift
+      super
+    end
+  end
+
+
+end