samlown-couchrest_extended_document 1.0.0

data/lib/couchrest/mixins/document_queries.rb

@@ -0,0 +1,80 @@
+module CouchRest
+  module Mixins
+    module DocumentQueries
+      
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+      
+      module ClassMethods
+        
+        # Load all documents that have the "couchrest-type" 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 "couchrest-type" 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 "couchrest-type" 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
+        
+        # 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)
+          doc = db.get id
+          create_from_database(doc)
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/couchrest/mixins/extended_attachments.rb

@@ -0,0 +1,70 @@
+module CouchRest
+  module Mixins
+    module ExtendedAttachments
+
+      # creates a file attachment to the current doc
+      def create_attachment(args={})
+        raise ArgumentError unless args[:file] && args[:name]
+        return if has_attachment?(args[:name])
+        self['_attachments'] ||= {}
+        set_attachment_attr(args)
+      rescue ArgumentError => e
+        raise ArgumentError, 'You must specify :file and :name'
+      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 self['_attachments']
+        self['_attachments'].delete attachment_name
+      end
+
+      # returns true if attachment_name exists
+      def has_attachment?(attachment_name)
+        !!(self['_attachments'] && self['_attachments'][attachment_name] && !self['_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(file)
+          ::MIME::Types.type_for(file.path).empty? ? 
+            'text\/plain' : MIME::Types.type_for(file.path).first.content_type.gsub(/\//,'\/')
+        end
+
+        def set_attachment_attr(args)
+          content_type = args[:content_type] ? args[:content_type] : get_mime_type(args[:file])
+          self['_attachments'][args[:name]] = {
+            'content_type' => content_type,
+            'data'         => args[:file].read
+          }
+        end
+      
+    end # module ExtendedAttachments
+  end
+end

data/lib/couchrest/mixins/properties.rb

@@ -0,0 +1,154 @@
+require 'time'
+require File.join(File.dirname(__FILE__), '..', 'property')
+require File.join(File.dirname(__FILE__), '..', 'casted_array')
+require File.join(File.dirname(__FILE__), '..', 'typecast')
+
+module CouchRest
+  module Mixins
+    module Properties
+      
+      class IncludeError < StandardError; end
+      
+      include ::CouchRest::More::Typecast
+
+      def self.included(base)
+        base.class_eval <<-EOS, __FILE__, __LINE__ + 1
+            extlib_inheritable_accessor(:properties) unless self.respond_to?(:properties)
+            self.properties ||= []
+        EOS
+        base.extend(ClassMethods)
+        raise CouchRest::Mixins::Properties::IncludeError, "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 (base.new.respond_to?(:[]) && base.new.respond_to?(:[]=))
+      end
+      
+      def apply_defaults
+        return if self.respond_to?(:new?) && (new? == false)
+        return unless self.class.respond_to?(:properties) 
+        return if self.class.properties.empty?
+        # TODO: cache the default object
+        self.class.properties.each do |property|
+          key = property.name.to_s
+          # let's make sure we have a default
+          unless property.default.nil?
+              if property.default.class == Proc
+                self[key] = property.default.call
+              else
+                self[key] = Marshal.load(Marshal.dump(property.default))
+              end
+            end
+        end
+      end
+      
+      def cast_keys
+        return unless self.class.properties
+        self.class.properties.each do |property|
+          cast_property(property)
+        end
+      end
+      
+      def cast_property(property, assigned=false)
+        return unless property.casted
+        key = self.has_key?(property.name) ? property.name : property.name.to_sym
+        # Don't cast the property unless it has a value
+        return unless self[key]
+        if property.type.is_a?(Array)
+          klass = property.type[0]
+          self[key] = [self[key]] unless self[key].is_a?(Array)
+          arr = self[key].collect do |value|
+            value = typecast_value(value, klass, property.init_method)
+            associate_casted_to_parent(value, assigned)
+            value
+          end
+          # allow casted_by calls to be passed up chain by wrapping in CastedArray
+          self[key] = klass != String ? ::CouchRest::CastedArray.new(arr) : arr
+          self[key].casted_by = self if self[key].respond_to?(:casted_by)
+        else
+          self[key] = typecast_value(self[key], property.type, property.init_method)
+          associate_casted_to_parent(self[key], assigned)
+        end
+      end
+      
+      def associate_casted_to_parent(casted, assigned)
+        casted.casted_by = self if casted.respond_to?(:casted_by)
+        casted.document_saved = true if !assigned && casted.respond_to?(:document_saved)
+      end
+      
+      def cast_property_by_name(property_name)
+        return unless self.class.properties
+        property = self.class.properties.detect{|property| property.name == property_name}
+        return unless property
+        cast_property(property, true)
+      end
+      
+     
+      module ClassMethods
+        
+        def property(name, options={})
+          existing_property = self.properties.find{|p| p.name == name.to_s}
+          if existing_property.nil? || (existing_property.default != options[:default])
+            define_property(name, options)
+          end
+        end
+        
+        protected
+        
+          # This is not a thread safe operation, if you have to set new properties at runtime
+          # make sure to use a mutex.
+          def define_property(name, options={})
+            # check if this property is going to casted
+            options[:casted] = !!(options[:cast_as] || options[:type])
+            property = CouchRest::Property.new(name, (options.delete(:cast_as) || options.delete(:type)), options)
+            create_property_getter(property) 
+            create_property_setter(property) unless property.read_only == true
+            properties << 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}
+                self['#{property.name}']
+              end
+            EOS
+
+            if property.type == 'boolean'
+              class_eval <<-EOS, __FILE__, __LINE__
+                def #{property.name}?
+                  if self['#{property.name}'].nil? || self['#{property.name}'] == false || self['#{property.name}'].to_s.downcase == 'false'
+                    false
+                  else
+                    true
+                  end
+                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)
+                self['#{property_name}'] = value
+                cast_property_by_name('#{property_name}')
+              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

data/lib/couchrest/mixins/validation.rb

@@ -0,0 +1,245 @@
+# Extracted from dm-validations 0.9.10
+#
+# Copyright (c) 2007 Guy van den Berg
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+class Object
+  def validatable?
+    false
+  end
+end
+
+require 'pathname'
+
+dir = File.join(Pathname(__FILE__).dirname.expand_path, '..', 'validation')
+
+require File.join(dir, 'validation_errors')
+require File.join(dir, 'contextual_validators')
+require File.join(dir, 'auto_validate')
+
+require File.join(dir, 'validators', 'generic_validator')
+require File.join(dir, 'validators', 'required_field_validator')
+require File.join(dir, 'validators', 'absent_field_validator')
+require File.join(dir, 'validators', 'format_validator')
+require File.join(dir, 'validators', 'length_validator')
+require File.join(dir, 'validators', 'numeric_validator')
+require File.join(dir, 'validators', 'method_validator')
+require File.join(dir, 'validators', 'confirmation_validator')
+
+module CouchRest
+  module Validation
+    
+    def self.included(base)
+      base.extlib_inheritable_accessor(:auto_validation)
+      base.class_eval <<-EOS, __FILE__, __LINE__ + 1
+          # Callbacks
+          define_callbacks :validate
+          
+          # Turn off auto validation by default
+          self.auto_validation ||= false
+          
+          # Force the auto validation for the class properties
+          # This feature is still not fully ported over,
+          # test are lacking, so please use with caution
+          def self.auto_validate!
+            self.auto_validation = true
+          end
+          
+          # share the validations with subclasses
+          def self.inherited(subklass)
+            self.validators.contexts.each do |k, v|
+              subklass.validators.contexts[k] = v.dup
+            end
+            super
+          end
+      EOS
+      
+      base.extend(ClassMethods)
+      base.class_eval <<-EOS, __FILE__, __LINE__ + 1
+        define_callbacks :validate
+        if method_defined?(:_run_save_callbacks)
+          set_callback :save, :before, :check_validations
+        end
+      EOS
+      base.class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+        def self.define_property(name, options={})
+          super
+          auto_generate_validations(properties.last) if properties && properties.size > 0
+          autovalidation_check = true
+        end
+      RUBY_EVAL
+    end
+
+    # Ensures the object is valid for the context provided, and otherwise
+    # throws :halt and returns false.
+    #
+    def check_validations(context = :default)
+      throw(:halt, false) unless context.nil? || valid?(context)
+    end
+    
+    # Return the ValidationErrors
+    #
+    def errors
+      @errors ||= ValidationErrors.new
+    end
+
+    # Mark this resource as validatable. When we validate associations of a
+    # resource we can check if they respond to validatable? before trying to
+    # recursivly validate them
+    #
+    def validatable?
+      true
+    end
+
+    # Alias for valid?(:default)
+    #
+    def valid_for_default?
+      valid?(:default)
+    end
+
+    # Check if a resource is valid in a given context
+    #
+    def valid?(context = :default)
+      recursive_valid?(self, context, true)
+    end
+    
+    # checking on casted objects
+    def validate_casted_arrays
+      result = true
+      array_casted_properties = self.class.properties.select { |property| property.casted && property.type.instance_of?(Array) }
+      array_casted_properties.each do |property|
+        casted_values = self.send(property.name)
+        next unless casted_values.is_a?(Array) && casted_values.first.respond_to?(:valid?)
+        casted_values.each do |value|
+          result = (result && value.valid?) if value.respond_to?(:valid?)
+        end
+      end
+      result
+    end
+
+    # Do recursive validity checking
+    #
+    def recursive_valid?(target, context, state)
+      valid = state
+      target.each do |key, prop|
+        if prop.is_a?(Array)
+          prop.each do |item|
+            if item.validatable?
+              valid = recursive_valid?(item, context, valid) && valid
+            end
+          end
+        elsif prop.validatable?
+          valid = recursive_valid?(prop, context, valid) && valid
+        end
+      end
+      target._run_validate_callbacks do
+        target.class.validators.execute(context, target) && valid
+      end
+    end
+
+
+    def validation_property_value(name)
+      self.respond_to?(name, true) ? self.send(name) : nil
+    end
+
+    # Get the corresponding Object property, if it exists.
+    def validation_property(field_name)
+      properties.find{|p| p.name == field_name}
+    end
+
+    module ClassMethods
+      include CouchRest::Validation::ValidatesPresent
+      include CouchRest::Validation::ValidatesAbsent
+      include CouchRest::Validation::ValidatesIsConfirmed
+      # include CouchRest::Validation::ValidatesIsPrimitive
+      # include CouchRest::Validation::ValidatesIsAccepted
+      include CouchRest::Validation::ValidatesFormat
+      include CouchRest::Validation::ValidatesLength
+      # include CouchRest::Validation::ValidatesWithin
+      include CouchRest::Validation::ValidatesIsNumber
+      include CouchRest::Validation::ValidatesWithMethod
+      # include CouchRest::Validation::ValidatesWithBlock
+      # include CouchRest::Validation::ValidatesIsUnique
+      include CouchRest::Validation::AutoValidate
+      
+      # Return the set of contextual validators or create a new one
+      #
+      def validators
+        @validations ||= ContextualValidators.new
+      end
+      
+      # Clean up the argument list and return a opts hash, including the
+      # merging of any default opts. Set the context to default if none is
+      # provided. Also allow :context to be aliased to :on, :when & group
+      #
+      def opts_from_validator_args(args, defaults = nil)
+        opts = args.last.kind_of?(Hash) ? args.pop : {}
+        context = :default
+        context = opts[:context] if opts.has_key?(:context)
+        context = opts.delete(:on) if opts.has_key?(:on)
+        context = opts.delete(:when) if opts.has_key?(:when)
+        context = opts.delete(:group) if opts.has_key?(:group)
+        opts[:context] = context
+        opts.merge!(defaults) unless defaults.nil?
+        opts
+      end
+      
+      # Given a new context create an instance method of
+      # valid_for_<context>? which simply calls valid?(context)
+      # if it does not already exist
+      #
+      def create_context_instance_methods(context)
+        name = "valid_for_#{context.to_s}?"           # valid_for_signup?
+        if !self.instance_methods.include?(name)
+          class_eval <<-EOS, __FILE__, __LINE__ + 1
+            def #{name}                               # def valid_for_signup?
+              valid?('#{context.to_s}'.to_sym)        #   valid?('signup'.to_sym)
+            end                                       # end
+          EOS
+        end
+      end
+
+      # Create a new validator of the given klazz and push it onto the
+      # requested context for each of the attributes in the fields list
+      #
+      def add_validator_to_context(opts, fields, klazz)
+        fields.each do |field|
+          validator = klazz.new(field.to_sym, opts)
+          if opts[:context].is_a?(Symbol)
+            unless validators.context(opts[:context]).include?(validator)
+              validators.context(opts[:context]) << validator
+              create_context_instance_methods(opts[:context])
+            end
+          elsif opts[:context].is_a?(Array)
+            opts[:context].each do |c|
+              unless validators.context(c).include?(validator)
+                validators.context(c) << validator
+                create_context_instance_methods(c)
+              end
+            end
+          end
+        end
+      end
+      
+    end # module ClassMethods
+  end # module Validation
+
+end # module CouchRest