couchrest_model-radiant 1.0.0

data/lib/couchrest/model.rb

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

data/lib/couchrest/model/associations.rb

@@ -0,0 +1,223 @@
+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.
+        # 
+        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|
+        check_obj(obj)
+        casted_by[property.to_s] << obj.id
+      end
+      super(array)
+    end
+    
+    def << obj
+      check_obj(obj)
+      casted_by[property.to_s] << obj.id
+      super(obj)
+    end
+    
+    def push(obj)
+      check_obj(obj)
+      casted_by[property.to_s].push obj.id
+      super(obj)
+    end
+    
+    def unshift(obj)
+      check_obj(obj)
+      casted_by[property.to_s].unshift obj.id
+      super(obj)
+    end
+
+    def []= index, obj
+      check_obj(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
+
+    protected
+
+    def check_obj(obj)
+      raise "Object cannot be added to #{casted_by.class.to_s}##{property.to_s} collection unless saved" if obj.new?
+    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::Configuration
+      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::PropertyProtection
+      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 CouchRest::Model::Base 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 = {})
+        doc = prepare_all_attributes(doc, options)
+        super(doc)
+        unless self['_id'] && self['_rev']
+          self[self.model_type_key] = 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::Configuration
+      include CouchRest::Model::Callbacks
+      include CouchRest::Model::Properties
+      include CouchRest::Model::PropertyProtection
+      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