couchrest_model 1.0.0.beta7

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,75 @@
+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.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
+
+    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

data/lib/couchrest/model/casted_model.rb

@@ -0,0 +1,68 @@
+module CouchRest::Model
+  module CastedModel
+   
+    extend ActiveSupport::Concern
+
+    included do
+      include CouchRest::Model::AttributeProtection
+      include CouchRest::Model::Attributes
+      include CouchRest::Model::Callbacks
+      include CouchRest::Model::Properties
+      include CouchRest::Model::Associations
+      include CouchRest::Model::Validations
+      attr_accessor :casted_by
+    end
+    
+    def initialize(keys = {})
+      raise StandardError unless self.is_a? Hash
+      prepare_all_attributes(keys)
+      super()
+    end
+    
+    def []= key, value
+      super(key.to_s, value)
+    end
+    
+    def [] key
+      super(key.to_s)
+    end
+    
+    # Gets a reference to the top level extended
+    # document that a model is saved inside of
+    def base_doc
+      return nil unless @casted_by
+      @casted_by.base_doc
+    end
+    
+    # False if the casted model has already
+    # been saved in the containing document
+    def new?
+      @casted_by.nil? ? true : @casted_by.new?
+    end
+    alias :new_record? :new?
+
+    def persisted?
+      !new?
+    end
+
+    # The to_param method is needed for rails to generate resourceful routes.
+    # In your controller, remember that it's actually the id of the document.
+    def id
+      return nil if base_doc.nil?
+      base_doc.id
+    end
+    alias :to_key :id
+    alias :to_param :id
+    
+    # Sets the attributes from a hash
+    def update_attributes_without_saving(hash)
+      hash.each do |k, v|
+        raise NoMethodError, "#{k}= method not available, use property :#{k}" unless self.respond_to?("#{k}=")
+      end      
+      hash.each do |k, v|
+        self.send("#{k}=",v)
+      end
+    end
+    alias :attributes= :update_attributes_without_saving
+  end
+end

data/lib/couchrest/model/class_proxy.rb

@@ -0,0 +1,122 @@
+module CouchRest
+  module Model
+    module ClassProxy
+      
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+      
+      module ClassMethods
+
+        # Return a proxy object which represents a model class on a
+        # chosen database instance. This allows you to DRY operations
+        # where a database is chosen dynamically.
+        #  
+        # ==== Example:
+        #  
+        #   db = CouchRest::Database.new(...)
+        #   articles = Article.on(db)
+        #
+        #   articles.all { ... }
+        #   articles.by_title { ... }
+        #
+        #   u = articles.get("someid")
+        #
+        #   u = articles.new(:title => "I like plankton")
+        #   u.save    # saved on the correct database
+
+        def on(database)
+          Proxy.new(self, database)
+        end
+      end
+
+      class Proxy #:nodoc:
+        def initialize(klass, database)
+          @klass = klass
+          @database = database
+        end
+        
+        # Base
+        
+        def new(*args)
+          doc = @klass.new(*args)
+          doc.database = @database
+          doc
+        end
+        
+        def 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
+        
+        # DocumentQueries
+        
+        def all(opts = {}, &block)
+          docs = @klass.all({:database => @database}.merge(opts), &block)
+          docs.each { |doc| doc.database = @database if doc.respond_to?(:database) } if docs
+          docs
+        end
+        
+        def count(opts = {}, &block)
+          @klass.all({:database => @database, :raw => true, :limit => 0}.merge(opts), &block)['total_rows']
+        end
+        
+        def first(opts = {})
+          doc = @klass.first({:database => @database}.merge(opts))
+          doc.database = @database if doc && doc.respond_to?(:database)
+          doc
+        end
+        
+        def get(id)
+          doc = @klass.get(id, @database)
+          doc.database = @database if doc && doc.respond_to?(:database)
+          doc
+        end
+        alias :find :get
+        
+        # Views
+        
+        def has_view?(view)
+          @klass.has_view?(view)
+        end
+        
+        def view(name, query={}, &block)
+          docs = @klass.view(name, {:database => @database}.merge(query), &block)
+          docs.each { |doc| doc.database = @database if doc.respond_to?(:database) } if docs
+          docs
+        end
+        
+        def first_from_view(name, *args)
+          # add to first hash available, or add to end
+          (args.last.is_a?(Hash) ? args.last : (args << {}).last)[:database] = @database
+          doc = @klass.first_from_view(name, *args)
+          doc.database = @database if doc && doc.respond_to?(:database)
+          doc
+        end
+       
+        # DesignDoc
+        
+        def design_doc
+          @klass.design_doc
+        end
+        
+        def refresh_design_doc
+          @klass.refresh_design_doc(@database)
+        end
+        
+        def save_design_doc
+          @klass.save_design_doc(@database)
+        end
+
+      end
+    end
+  end
+end