couchrest_model_thought 1.0.0.beta8

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/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

data/lib/couchrest/model/attribute_protection.rb

@@ -0,0 +1,74 @@
+module CouchRest
+  module Model
+    module AttributeProtection
+      # Attribute protection from mass assignment to CouchRest properties
+      # 
+      # Protected methods will be removed from
+      #  * new 
+      #  * update_attributes
+      #  * upate_attributes_without_saving
+      #  * attributes=
+      #  
+      # There are two modes of protection
+      #  1) Declare accessible poperties, assume all the rest are protected 
+      #    property :name, :accessible => true
+      #    property :admin                     # this will be automatically protected
+      #
+      #  2) Declare protected properties, assume all the rest are accessible
+      #    property :name                      # this will not be protected
+      #    property :admin, :protected => true
+      #
+      # Note: you cannot set both flags in a single class
+      
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def accessible_properties
+          properties.select { |prop| prop.options[:accessible] }
+        end
+
+        def protected_properties
+          properties.select { |prop| prop.options[:protected] }
+        end
+      end
+
+      def accessible_properties
+        self.class.accessible_properties
+      end
+
+      def protected_properties
+        self.class.protected_properties
+      end
+
+      def remove_protected_attributes(attributes)
+        protected_names = properties_to_remove_from_mass_assignment.map { |prop| prop.name }
+        return attributes if protected_names.empty?
+
+        attributes.reject! do |property_name, property_value|
+          protected_names.include?(property_name.to_s)
+        end
+
+        attributes || {}
+      end
+
+      private
+
+      def properties_to_remove_from_mass_assignment
+        has_protected = !protected_properties.empty?
+        has_accessible = !accessible_properties.empty?
+
+        if !has_protected && !has_accessible
+          []
+        elsif has_protected && !has_accessible
+          protected_properties
+        elsif has_accessible && !has_protected
+          properties.reject { |prop| prop.options[:accessible] }
+        else
+          raise "Set either :accessible or :protected for #{self.class}, but not both"
+        end
+      end
+    end
+  end
+end

data/lib/couchrest/model/attributes.rb

@@ -0,0 +1,91 @@
+module CouchRest
+  module Model
+    module Attributes
+
+      ## Support for handling attributes
+      # 
+      # This would be better in the properties file, but due to scoping issues
+      # this is not yet possible.
+      #
+
+      def prepare_all_attributes(doc = {}, options = {})
+        apply_all_property_defaults
+        if options[:directly_set_attributes]
+          directly_set_read_only_attributes(doc)          
+        else
+          remove_protected_attributes(doc)
+        end
+        directly_set_attributes(doc) unless doc.nil?
+      end
+
+      # Takes a hash as argument, and applies the values by using writer methods
+      # for each key. It doesn't save the document at the end. Raises a NoMethodError if the corresponding methods are
+      # missing. In case of error, no attributes are changed.    
+      def update_attributes_without_saving(hash)
+        # Remove any protected and update all the rest. Any attributes
+        # which do not have a property will simply be ignored.
+        attrs = remove_protected_attributes(hash)
+        directly_set_attributes(attrs)
+      end
+      alias :attributes= :update_attributes_without_saving
+
+      # Takes a hash as argument, and applies the values by using writer methods
+      # for each key. Raises a NoMethodError if the corresponding methods are
+      # missing. In case of error, no attributes are changed.
+      def update_attributes(hash)
+        update_attributes_without_saving hash
+        save
+      end
+
+      private
+
+      def directly_set_attributes(hash)
+        hash = merge_multiparameter_attributes hash
+        hash.each do |attribute_name, attribute_value|
+          if self.respond_to?("#{attribute_name}=")
+            self.send("#{attribute_name}=", hash.delete(attribute_name))
+          end
+        end
+      end
+
+      def directly_set_read_only_attributes(hash)
+        property_list = self.properties.map{|p| p.name}
+        hash.each do |attribute_name, attribute_value|
+          next if self.respond_to?("#{attribute_name}=")
+          if property_list.include?(attribute_name)
+            write_attribute(attribute_name, hash.delete(attribute_name))
+          end
+        end
+      end
+      
+      def set_attributes(hash)
+        attrs = remove_protected_attributes(hash)
+        directly_set_attributes(attrs)
+      end
+
+      def check_properties_exist(attrs)
+        property_list = self.properties.map{|p| p.name}
+        attrs.each do |attribute_name, attribute_value|
+          raise NoMethodError, "Property #{attribute_name} not created" unless respond_to?("#{attribute_name}=") or property_list.include?(attribute_name)
+        end      
+      end
+
+      def merge_multiparameter_attributes(attributes)
+        self.properties.each do |property|
+          case property.type.to_s
+          when Date.to_s
+            parameters = attributes.values_at(*(1..3).map{ |index| "#{property.name}(#{index}i)" }).map(&:to_i)
+            attributes.values_at(*(1..3).map { |index| attributes.delete("#{property.name}(#{index}i)") })
+            attributes[property.name] = Date.civil *parameters rescue nil unless attributes[property.name].is_a?(Date)
+          when Time.to_s
+            parameters = attributes.values_at(*(1..6).map{ |index| "#{property.name}(#{index}i)" }).map(&:to_i)
+            attributes.values_at(*(1..3).map{ |index| attributes.delete("#{property.name}(#{index}i)") })
+            attributes[property.name] = Time.mktime *parameters rescue nil unless attributes[property.name].is_a?(Time)
+          end
+        end
+        attributes
+      end
+      
+    end
+  end
+end

data/lib/couchrest/model/base.rb

@@ -0,0 +1,111 @@
+module CouchRest
+  module Model
+    class Base < Document
+
+      extend ActiveModel::Naming
+
+      include CouchRest::Model::Persistence
+      include CouchRest::Model::Callbacks
+      include CouchRest::Model::DocumentQueries    
+      include CouchRest::Model::Views
+      include CouchRest::Model::DesignDoc
+      include CouchRest::Model::ExtendedAttachments
+      include CouchRest::Model::ClassProxy
+      include CouchRest::Model::Collection
+      include CouchRest::Model::AttributeProtection
+      include CouchRest::Model::Attributes
+      include CouchRest::Model::Associations
+      include CouchRest::Model::Validations
+
+      def self.subclasses
+        @subclasses ||= []
+      end
+      
+      def self.inherited(subklass)
+        super
+        subklass.send(:include, CouchRest::Model::Properties)
+        subklass.class_eval <<-EOS, __FILE__, __LINE__ + 1
+          def self.inherited(subklass)
+            super
+            subklass.properties = self.properties.dup
+            # This is nasty:
+            subklass._validators = self._validators.dup
+          end
+        EOS
+        subclasses << subklass
+      end
+      
+      # Accessors
+      attr_accessor :casted_by
+      
+
+      # Instantiate a new ExtendedDocument by preparing all properties
+      # using the provided document hash.
+      #
+      # Options supported:
+      # 
+      # * :directly_set_attributes: true when data comes directly from database
+      #
+      def initialize(doc = {}, options = {})
+        prepare_all_attributes(doc, options)
+        super(doc)
+        unless self['_id'] && self['_rev']
+          self['couchrest-type'] = self.class.to_s
+        end
+        after_initialize if respond_to?(:after_initialize)
+      end
+     
+      
+      # Temp solution to make the view_by methods available
+      def self.method_missing(m, *args, &block)
+        if has_view?(m)
+          query = args.shift || {}
+          return view(m, query, *args, &block)
+        elsif m.to_s =~ /^find_(by_.+)/
+          view_name = $1
+          if has_view?(view_name)
+            return first_from_view(view_name, *args)
+          end
+        end
+        super
+      end
+      
+      ### instance methods
+      
+      # Gets a reference to the actual document in the DB
+      # Calls up to the next document if there is one,
+      # Otherwise we're at the top and we return self
+      def base_doc
+        return self if base_doc?
+        @casted_by.base_doc
+      end
+      
+      # Checks if we're the top document
+      def base_doc?
+        !@casted_by
+      end
+      
+      ## Compatibility with ActiveSupport and older frameworks
+  
+      # Hack so that CouchRest::Document, which descends from Hash,
+      # doesn't appear to Rails routing as a Hash of options
+      def is_a?(klass)
+        return false if klass == Hash
+        super
+      end
+      alias :kind_of? :is_a?
+
+      def persisted?
+        !new?
+      end
+      
+      def to_key
+        new? ? nil : [id] 
+      end
+
+      alias :to_param :id
+      alias :new_record? :new?
+      alias :new_document? :new?
+    end    
+  end
+end

data/lib/couchrest/model/callbacks.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+module CouchRest #:nodoc:
+  module Model #:nodoc:
+
+    module Callbacks
+      extend ActiveSupport::Concern
+      included do
+        extend ActiveModel::Callbacks
+
+        define_model_callbacks \
+          :create,
+          :destroy,
+          :save,
+          :update,
+          :validate
+
+      end
+
+      def valid?(*) #nodoc
+        _run_validation_callbacks { super }
+      end
+
+    end
+
+  end
+end

data/lib/couchrest/model/casted_array.rb

@@ -0,0 +1,39 @@
+#
+# Wrapper around Array so that the casted_by attribute is set in all
+# elements of the array.
+#
+
+module CouchRest::Model
+  class CastedArray < Array
+    attr_accessor :casted_by
+    attr_accessor :property
+
+    def initialize(array, property)
+      self.property = property
+      super(array)
+    end
+    
+    def << obj
+      super(instantiate_and_cast(obj))
+    end
+    
+    def push(obj)
+      super(instantiate_and_cast(obj))
+    end
+    
+    def []= index, obj
+      super(index, instantiate_and_cast(obj))
+    end
+
+    protected
+
+    def instantiate_and_cast(obj)
+      if self.casted_by && self.property && obj.class != self.property.type_class
+        self.property.cast_value(self.casted_by, obj)
+      else
+        obj.casted_by = self.casted_by if obj.respond_to?(:casted_by)
+        obj
+      end
+    end
+  end
+end