couchrest_model-radiant 1.0.0

data/lib/couchrest/model/document_queries.rb

@@ -0,0 +1,83 @@
+module CouchRest
+  module Model
+    module DocumentQueries
+      
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+      
+      module ClassMethods
+        
+        # Load all documents that have the model_type_key's field equal to the
+        # name of the current class. Take the standard set of
+        # CouchRest::Database#view options.
+        def all(opts = {}, &block)
+          view(:all, opts, &block)
+        end
+        
+        # Returns the number of documents that have the model_type_key's field
+        # equal to the name of the current class. Takes the standard set of 
+        # CouchRest::Database#view options
+        def count(opts = {}, &block)
+          all({:raw => true, :limit => 0}.merge(opts), &block)['total_rows']
+        end
+        
+        # Load the first document that have the model_type_key's field equal to
+        # the name of the current class.
+        #
+        # ==== Returns
+        # Object:: The first object instance available
+        # or
+        # Nil:: if no instances available
+        #
+        # ==== Parameters
+        # opts<Hash>::
+        # View options, see <tt>CouchRest::Database#view</tt> options for more info.
+        def first(opts = {})
+          first_instance = self.all(opts.merge!(:limit => 1))
+          first_instance.empty? ? nil : first_instance.first
+        end
+        
+        # Load a document from the database by id
+        # No exceptions will be raised if the document isn't found
+        #
+        # ==== Returns
+        # Object:: if the document was found
+        # or
+        # Nil::
+        # 
+        # === Parameters
+        # id<String, Integer>:: Document ID
+        # db<Database>:: optional option to pass a custom database to use
+        def get(id, db = database)
+          begin
+            get!(id, db)
+          rescue
+            nil
+          end
+        end
+        alias :find :get
+        
+        # Load a document from the database by id
+        # An exception will be raised if the document isn't found
+        #
+        # ==== Returns
+        # Object:: if the document was found
+        # or
+        # Exception
+        # 
+        # === Parameters
+        # id<String, Integer>:: Document ID
+        # db<Database>:: optional option to pass a custom database to use
+        def get!(id, db = database)
+          raise "Missing or empty document ID" if id.to_s.empty?
+          doc = db.get id
+          create_from_database(doc)
+        end
+        alias :find! :get!
+        
+      end
+      
+    end
+  end
+end

data/lib/couchrest/model/errors.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+module CouchRest
+  module Model
+    module Errors
+
+      class CouchRestModelError < StandardError; end
+
+      # Raised when a persisence method ending in ! fails validation. The message
+      # will contain the full error messages from the +Document+ in question.
+      #
+      # Example:
+      #
+      # <tt>Validations.new(person.errors)</tt>
+      class Validations < CouchRestModelError
+        attr_reader :document
+        def initialize(document)
+          @document = document
+          super("Validation Failed: #{@document.errors.full_messages.join(", ")}")
+        end
+      end
+    end
+  end
+end

data/lib/couchrest/model/extended_attachments.rb

@@ -0,0 +1,77 @@
+module CouchRest
+  module Model
+    module ExtendedAttachments
+
+      # Add a file attachment to the current document. Expects
+      # :file and :name to be included in the arguments.
+      def create_attachment(args={})
+        raise ArgumentError unless args[:file] && args[:name]
+        return if has_attachment?(args[:name])
+        set_attachment_attr(args)
+      rescue ArgumentError => e
+        raise ArgumentError, 'You must specify :file and :name'
+      end
+      
+      # return all attachments
+      def attachments
+        self['_attachments'] ||= {}
+      end
+
+      # reads the data from an attachment
+      def read_attachment(attachment_name)
+        database.fetch_attachment(self, attachment_name)
+      end
+
+      # modifies a file attachment on the current doc
+      def update_attachment(args={})
+        raise ArgumentError unless args[:file] && args[:name]
+        return unless has_attachment?(args[:name])
+        delete_attachment(args[:name])
+        set_attachment_attr(args)
+      rescue ArgumentError => e
+        raise ArgumentError, 'You must specify :file and :name'
+      end
+
+      # deletes a file attachment from the current doc
+      def delete_attachment(attachment_name)
+        return unless attachments
+        attachments.delete attachment_name
+      end
+
+      # returns true if attachment_name exists
+      def has_attachment?(attachment_name)
+        !!(attachments && attachments[attachment_name] && !attachments[attachment_name].empty?)
+      end
+
+      # returns URL to fetch the attachment from
+      def attachment_url(attachment_name)
+        return unless has_attachment?(attachment_name)
+        "#{database.root}/#{self.id}/#{attachment_name}"
+      end
+      
+      # returns URI to fetch the attachment from
+      def attachment_uri(attachment_name)
+        return unless has_attachment?(attachment_name)
+        "#{database.uri}/#{self.id}/#{attachment_name}"
+      end
+      
+      private
+      
+        def get_mime_type(path)
+          return nil if path.nil?
+          type = ::MIME::Types.type_for(path)
+          type.empty? ? nil : type.first.content_type
+        end
+
+        def set_attachment_attr(args)
+          content_type = args[:content_type] ? args[:content_type] : get_mime_type(args[:file].path)
+          content_type ||= (get_mime_type(args[:name]) || 'text/plain')
+          attachments[args[:name]] = {
+            'content_type' => content_type,
+            'data'         => args[:file].read
+          }
+        end
+      
+    end # module ExtendedAttachments
+  end
+end

data/lib/couchrest/model/persistence.rb

@@ -0,0 +1,155 @@
+module CouchRest
+  module Model
+    module Persistence
+      extend ActiveSupport::Concern
+
+      # Create the document. Validation is enabled by default and will return 
+      # false if the document is not valid. If all goes well, the document will
+      # be returned.
+      def create(options = {})
+        return false unless perform_validations(options)
+        _run_create_callbacks do
+          _run_save_callbacks do
+            set_unique_id if new? && self.respond_to?(:set_unique_id)
+            result = database.save_doc(self)
+            (result["ok"] == true) ? self : false
+          end
+        end
+      end
+     
+      # Creates the document in the db. Raises an exception
+      # if the document is not created properly.
+      def create!
+        self.class.fail_validate!(self) unless self.create
+      end
+      
+      # Trigger the callbacks (before, after, around)
+      # only if the document isn't new
+      def update(options = {})
+        raise "Calling #{self.class.name}#update on document that has not been created!" if self.new?
+        return false unless perform_validations(options)
+        _run_update_callbacks do
+          _run_save_callbacks do
+            result = database.save_doc(self)
+            result["ok"] == true
+          end
+        end
+      end
+      
+      # Trigger the callbacks (before, after, around) and save the document
+      def save(options = {})
+        self.new? ? create(options) : update(options)
+      end
+      
+      # Saves the document to the db using save. Raises an exception
+      # if the document is not saved properly.
+      def save!
+        self.class.fail_validate!(self) unless self.save
+        true
+      end
+
+      # Deletes the document from the database. Runs the :destroy callbacks.
+      # Removes the <tt>_id</tt> and <tt>_rev</tt> fields, preparing the
+      # document to be saved to a new <tt>_id</tt> if required.
+      def destroy
+        _run_destroy_callbacks do
+          result = database.delete_doc(self)
+          if result['ok']
+            self.delete('_rev')
+            self.delete('_id')
+          end
+          result['ok']
+        end
+      end
+
+      # Update the document's attributes and save. For example:
+      #
+      #   doc.update_attributes :name => "Fred"
+      # 
+      # Is the equivilent of doing the following:
+      #
+      #   doc.attributes = { :name => "Fred" }
+      #   doc.save
+      #
+      def update_attributes(hash)
+        update_attributes_without_saving hash
+        save
+      end
+
+    protected
+
+      def perform_validations(options = {})
+        perform_validation = case options
+        when Hash
+          options[:validate] != false
+        else
+          options
+        end
+        perform_validation ? valid? : true
+      end
+
+
+      module ClassMethods
+
+        # Creates a new instance, bypassing attribute protection
+        #
+        #
+        # ==== Returns
+        #  a document instance
+        def create_from_database(doc = {})
+          base = (doc[model_type_key].blank? || doc[model_type_key] == self.to_s) ? self : doc[model_type_key].constantize
+          base.new(doc, :directly_set_attributes => true)      
+        end
+
+        # Defines an instance and save it directly to the database 
+        # 
+        # ==== Returns
+        #  returns the reloaded document
+        def create(attributes = {})
+          instance = new(attributes)
+          instance.create
+          instance
+        end
+        
+        # Defines an instance and save it directly to the database 
+        # 
+        # ==== Returns
+        #  returns the reloaded document or raises an exception
+        def create!(attributes = {})
+          instance = new(attributes)
+          instance.create!
+          instance
+        end
+
+        # Name a method that will be called before the document is first saved,
+        # which returns a string to be used for the document's <tt>_id</tt>.
+        #
+        # Because CouchDB enforces a constraint that each id must be unique,
+        # this can be used to enforce eg: uniq usernames. Note that this id
+        # must be globally unique across all document types which share a
+        # database, so if you'd like to scope uniqueness to this class, you
+        # should use the class name as part of the unique id.
+        def unique_id method = nil, &block
+          if method
+            define_method :set_unique_id do
+              self['_id'] ||= self.send(method)
+            end
+          elsif block
+            define_method :set_unique_id do
+              uniqid = block.call(self)
+              raise ArgumentError, "unique_id block must not return nil" if uniqid.nil?
+              self['_id'] ||= uniqid
+            end
+          end
+        end
+
+        # Raise an error if validation failed.
+        def fail_validate!(document)
+          raise Errors::Validations.new(document)
+        end
+      end
+      
+
+    end
+  end
+end

data/lib/couchrest/model/properties.rb

@@ -0,0 +1,208 @@
+# encoding: utf-8
+module CouchRest
+  module Model
+    module Properties
+      extend ActiveSupport::Concern
+
+      included do
+        extlib_inheritable_accessor(:properties) unless self.respond_to?(:properties)
+        self.properties ||= []
+        raise "You can only mixin Properties in a class responding to [] and []=, if you tried to mixin CastedModel, make sure your class inherits from Hash or responds to the proper methods" unless (method_defined?(:[]) && method_defined?(:[]=))
+      end
+
+      # Returns the Class properties
+      #
+      # ==== Returns
+      # Array:: the list of properties for model's class
+      def properties
+        self.class.properties
+      end
+
+      # Read the casted value of an attribute defined with a property.
+      #
+      # ==== Returns
+      # Object:: the casted attibutes value.
+      def read_attribute(property)
+        self[find_property!(property).to_s]
+      end
+
+      # Store a casted value in the current instance of an attribute defined
+      # with a property.
+      def write_attribute(property, value)
+        prop = find_property!(property)
+        self[prop.to_s] = prop.is_a?(String) ? value : prop.cast(self, value)
+      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
+
+
+      private
+      # The following methods should be accessable by the Model::Base Class, but not by anything else!
+      
+      def apply_all_property_defaults
+        return if self.respond_to?(:new?) && (new? == false)
+        # TODO: cache the default object
+        self.class.properties.each do |property|
+          write_attribute(property, property.default_value)
+        end
+      end
+
+      def prepare_all_attributes(doc = {}, options = {})
+        apply_all_property_defaults
+        if options[:directly_set_attributes]
+          directly_set_read_only_attributes(doc)          
+        else
+          doc = remove_protected_attributes(doc)
+        end
+        directly_set_attributes(doc) unless doc.nil?
+      end
+
+      def find_property!(property)
+        prop = property.is_a?(Property) ? property : self.class.properties.detect {|p| p.to_s == property.to_s}
+        raise ArgumentError, "Missing property definition for #{property.to_s}" if prop.nil?
+        prop
+      end
+
+      # Set all the attributes and return a hash with the attributes
+      # that have not been accepted.
+      def directly_set_attributes(hash)
+        hash.reject do |attribute_name, attribute_value|
+          if self.respond_to?("#{attribute_name}=")
+            self.send("#{attribute_name}=", attribute_value)
+            true
+          elsif mass_assign_any_attribute # config option
+            self[attribute_name] = attribute_value
+            true
+          else
+            false
+          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
+
+
+      module ClassMethods
+
+        def property(name, *options, &block)
+          opts = { }
+          type = options.shift
+          if type.class != Hash
+            opts[:type] = type
+            opts.merge!(options.shift || {})
+          else
+            opts.update(type)
+          end
+          existing_property = self.properties.find{|p| p.name == name.to_s}
+          if existing_property.nil? || (existing_property.default != opts[:default])
+            define_property(name, opts, &block)
+          end
+        end
+
+        # Automatically set <tt>updated_at</tt> and <tt>created_at</tt> fields
+        # on the document whenever saving occurs. CouchRest uses a pretty
+        # decent time format by default. See Time#to_json
+        def timestamps!
+          class_eval <<-EOS, __FILE__, __LINE__
+            property(:updated_at, Time, :read_only => true, :protected => true, :auto_validation => false)
+            property(:created_at, Time, :read_only => true, :protected => true, :auto_validation => false)
+
+            set_callback :save, :before do |object|
+              write_attribute('updated_at', Time.now)
+              write_attribute('created_at', Time.now) if object.new?
+            end
+          EOS
+        end
+
+        protected
+
+          # This is not a thread safe operation, if you have to set new properties at runtime
+          # make sure a mutex is used.
+          def define_property(name, options={}, &block)
+            # check if this property is going to casted
+            type = options.delete(:type) || options.delete(:cast_as)
+            if block_given?
+              type = Class.new(Hash) do
+                include CastedModel
+              end
+              type.class_eval { yield type }
+              type = [type] # inject as an array
+            end
+            property = Property.new(name, type, options)
+            create_property_getter(property)
+            create_property_setter(property) unless property.read_only == true
+            if property.type_class.respond_to?(:validates_casted_model)
+              validates_casted_model property.name
+            end
+            properties << property
+            property
+          end
+
+          # defines the getter for the property (and optional aliases)
+          def create_property_getter(property)
+            # meth = property.name
+            class_eval <<-EOS, __FILE__, __LINE__ + 1
+              def #{property.name}
+                read_attribute('#{property.name}')
+              end
+            EOS
+
+            if ['boolean', TrueClass.to_s.downcase].include?(property.type.to_s.downcase)
+              class_eval <<-EOS, __FILE__, __LINE__
+                def #{property.name}?
+                  value = read_attribute('#{property.name}')
+                  !(value.nil? || value == false)
+                end
+              EOS
+            end
+
+            if property.alias
+              class_eval <<-EOS, __FILE__, __LINE__ + 1
+                alias #{property.alias.to_sym} #{property.name.to_sym}
+              EOS
+            end
+          end
+
+          # defines the setter for the property (and optional aliases)
+          def create_property_setter(property)
+            property_name = property.name
+            class_eval <<-EOS
+              def #{property_name}=(value)
+                write_attribute('#{property_name}', value)
+              end
+            EOS
+
+            if property.alias
+              class_eval <<-EOS
+                alias #{property.alias.to_sym}= #{property_name.to_sym}=
+              EOS
+            end
+          end
+
+      end # module ClassMethods
+
+    end
+  end
+end