couchrest_model 1.0.0.beta7

data/lib/couchrest/model/support/couchrest.rb

@@ -0,0 +1,19 @@
+
+module CouchRest
+
+  class Database
+
+    alias :delete_orig! :delete!
+    def delete!
+      clear_model_fresh_cache
+      delete_orig!
+    end
+
+    # If the database is deleted, ensure that the design docs will be refreshed.
+    def clear_model_fresh_cache
+      ::CouchRest::Model::Base.subclasses.each{|klass| klass.req_design_doc_refresh if klass.respond_to?(:req_design_doc_refresh)}
+    end
+
+  end
+
+end

data/lib/couchrest/model/support/hash.rb

@@ -0,0 +1,9 @@
+# This file contains various hacks for Rails compatibility.
+class Hash
+  # Hack so that CouchRest::Document, which descends from Hash,
+  # doesn't appear to Rails routing as a Hash of options
+  def self.===(other)
+    return false if self == Hash && other.is_a?(CouchRest::Document)
+    super
+  end
+end

data/lib/couchrest/model/typecast.rb

@@ -0,0 +1,170 @@
+class Time                       
+  # returns a local time value much faster than Time.parse
+  def self.mktime_with_offset(string)
+    string =~ /(\d{4})[\-|\/](\d{2})[\-|\/](\d{2})[T|\s](\d{2}):(\d{2}):(\d{2})([\+|\s|\-])*(\d{2}):?(\d{2})/
+    # $1 = year
+    # $2 = month
+    # $3 = day
+    # $4 = hours
+    # $5 = minutes
+    # $6 = seconds
+    # $7 = time zone direction
+    # $8 = tz difference
+    # utc time with wrong TZ info: 
+    time = mktime($1, RFC2822_MONTH_NAME[$2.to_i - 1], $3, $4, $5, $6, $7)
+    tz_difference = ("#{$7 == '-' ? '+' : '-'}#{$8}".to_i * 3600)
+    time + tz_difference + zone_offset(time.zone) 
+  end 
+end
+
+module CouchRest
+  module Model
+    module Typecast
+
+      def typecast_value(value, property) # klass, init_method)
+        return nil if value.nil?
+        klass = property.type_class
+        if value.instance_of?(klass) || klass == Object
+          value
+        elsif [String, TrueClass, Integer, Float, BigDecimal, DateTime, Time, Date, Class].include?(klass)
+          send('typecast_to_'+klass.to_s.downcase, value)
+        else
+          # Allow the init_method to be defined as a Proc for advanced conversion
+          property.init_method.is_a?(Proc) ? property.init_method.call(value) : klass.send(property.init_method, value)
+        end
+      end
+
+      protected
+
+        # Typecast a value to an Integer
+        def typecast_to_integer(value)
+          typecast_to_numeric(value, :to_i)
+        end
+
+        # Typecast a value to a String
+        def typecast_to_string(value)
+          value.to_s
+        end
+
+        # Typecast a value to a true or false
+        def typecast_to_trueclass(value)
+          if value.kind_of?(Integer)
+            return true  if value == 1
+            return false if value == 0
+          elsif value.respond_to?(:to_s)
+            return true  if %w[ true  1 t ].include?(value.to_s.downcase)
+            return false if %w[ false 0 f ].include?(value.to_s.downcase)
+          end
+          value
+        end
+
+        # Typecast a value to a BigDecimal
+        def typecast_to_bigdecimal(value)
+          if value.kind_of?(Integer)
+            value.to_s.to_d
+          else
+            typecast_to_numeric(value, :to_d)
+          end
+        end
+
+        # Typecast a value to a Float
+        def typecast_to_float(value)
+          typecast_to_numeric(value, :to_f)
+        end
+
+        # Match numeric string
+        def typecast_to_numeric(value, method)
+          if value.respond_to?(:to_str)
+            if value.to_str =~ /\A(-?(?:0|[1-9]\d*)(?:\.\d+)?|(?:\.\d+))\z/
+              $1.send(method)
+            else
+              value
+            end
+          elsif value.respond_to?(method)
+            value.send(method)
+          else
+            value
+          end
+        end
+
+        # Typecasts an arbitrary value to a DateTime.
+        # Handles both Hashes and DateTime instances.
+        # This is slow!! Use Time instead.
+        def typecast_to_datetime(value)
+          if value.is_a?(Hash)
+            typecast_hash_to_datetime(value)
+          else
+            DateTime.parse(value.to_s)
+          end
+        rescue ArgumentError
+          value
+        end
+
+        # Typecasts an arbitrary value to a Date
+        # Handles both Hashes and Date instances.
+        def typecast_to_date(value)
+          if value.is_a?(Hash)
+            typecast_hash_to_date(value)
+          elsif value.is_a?(Time) # sometimes people think date is time!
+            value.to_date
+          elsif value.to_s =~ /(\d{4})[\-|\/](\d{2})[\-|\/](\d{2})/
+            # Faster than parsing the date
+            Date.new($1.to_i, $2.to_i, $3.to_i)
+          else
+            Date.parse(value)
+          end
+        rescue ArgumentError
+          value
+        end
+
+        # Typecasts an arbitrary value to a Time
+        # Handles both Hashes and Time instances.
+        def typecast_to_time(value)
+          if value.is_a?(Hash)
+            typecast_hash_to_time(value)
+          else
+            Time.mktime_with_offset(value.to_s)
+          end
+        rescue ArgumentError
+          value
+        rescue TypeError
+          value
+        end
+
+        # Creates a DateTime instance from a Hash with keys :year, :month, :day,
+        # :hour, :min, :sec
+        def typecast_hash_to_datetime(value)
+          DateTime.new(*extract_time(value))
+        end
+
+        # Creates a Date instance from a Hash with keys :year, :month, :day
+        def typecast_hash_to_date(value)
+          Date.new(*extract_time(value)[0, 3])
+        end
+
+        # Creates a Time instance from a Hash with keys :year, :month, :day,
+        # :hour, :min, :sec
+        def typecast_hash_to_time(value)
+          Time.local(*extract_time(value))
+        end
+
+        # Extracts the given args from the hash. If a value does not exist, it
+        # uses the value of Time.now.
+        def extract_time(value)
+          now  = Time.now
+          [:year, :month, :day, :hour, :min, :sec].map do |segment|
+            typecast_to_numeric(value.fetch(segment, now.send(segment)), :to_i)
+          end
+        end
+
+        # Typecast a value to a Class
+        def typecast_to_class(value)
+          value.to_s.constantize
+        rescue NameError
+          value
+        end
+
+    end
+  end
+end
+

data/lib/couchrest/model/validations.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+require "couchrest/model/validations/casted_model"
+require "couchrest/model/validations/uniqueness"
+
+I18n.load_path << File.join(
+  File.dirname(__FILE__), "validations", "locale", "en.yml"
+)
+
+module CouchRest
+  module Model
+
+    # Validations may be applied to both Model::Base and Model::CastedModel
+    module Validations
+      extend ActiveSupport::Concern
+      included do
+        include ActiveModel::Validations
+      end
+      
+
+      module ClassMethods
+        
+        # Validates the associated casted model. This method should not be 
+        # used within your code as it is automatically included when a CastedModel
+        # is used inside the model.
+        #
+        def validates_casted_model(*args)
+          validates_with(CastedModelValidator, _merge_attributes(args))
+        end
+        
+        # Validates if the field is unique for this type of document. Automatically creates
+        # a view if one does not already exist and performs a search for all matching
+        # documents.
+        #
+        # Example:
+        #
+        #   class Person < CouchRest::Model::Base
+        #     property :title, String
+        # 
+        #     validates_uniqueness_of :title
+        #   end
+        #
+        # Asside from the standard options, you can specify the name of the view you'd like
+        # to use for the search inside the +:view+ option. The following example would search
+        # for the code in side the +all+ view, useful for when +unique_id+ is used and you'd
+        # like to check before receiving a RestClient Conflict error:
+        #
+        #   validates_uniqueness_of :code, :view => 'all'
+        #
+        # A +:proxy+ parameter is also accepted if you would 
+        # like to call a method on the document on which the view should be performed.
+        #
+        # For Example:
+        #
+        #   # Same as not including proxy:
+        #   validates_uniqueness_of :title, :proxy => 'class'
+        #
+        #   # Person#company.people provides a proxy object for people
+        #   validates_uniqueness_of :title, :proxy => 'company.people'
+        #
+        def validates_uniqueness_of(*args)
+          validates_with(UniquenessValidator, _merge_attributes(args))
+        end
+      end
+
+    end
+  end
+end

data/lib/couchrest/model/validations/casted_model.rb

@@ -0,0 +1,14 @@
+module CouchRest
+  module Model
+    module Validations
+      class CastedModelValidator < ActiveModel::EachValidator
+        
+        def validate_each(document, attribute, value)
+          values = value.is_a?(Array) ? value : [value]
+          return if values.collect {|doc| doc.nil? || doc.valid? }.all?
+          document.errors.add(attribute, :invalid, :default => options[:message], :value => value)
+        end
+      end
+    end
+  end
+end

data/lib/couchrest/model/validations/locale/en.yml

@@ -0,0 +1,5 @@
+en:
+  errors:
+    messages:
+      taken: "is already taken"
+

data/lib/couchrest/model/validations/uniqueness.rb

@@ -0,0 +1,45 @@
+# encoding: urf-8
+
+module CouchRest
+  module Model
+    module Validations
+      
+      # Validates if a field is unique 
+      class UniquenessValidator < ActiveModel::EachValidator
+
+        # Ensure we have a class available so we can check for a usable view
+        # or add one if necessary.
+        def setup(klass)
+          @klass = klass
+        end
+
+
+        def validate_each(document, attribute, value)
+          view_name = options[:view].nil? ? "by_#{attribute}" : options[:view]
+
+          unless @klass.has_view?(view_name)
+            raise "View #{document.class.name}.#{options[:view]} does not exist!" unless options[:view].nil?
+            @klass.view_by attribute
+          end
+
+          # Determine the base of the search
+          base = options[:proxy].nil? ? @klass : document.instance_eval(options[:proxy])
+
+          docs = base.view(view_name, :key => value, :limit => 2, :include_docs => false)['rows']
+          return if docs.empty?
+
+          unless document.new?
+            return if docs.find{|doc| doc['id'] == document.id}
+          end
+          
+          if docs.length > 0
+            document.errors.add(attribute, :taken, :default => options[:message], :value => value)
+          end
+        end
+
+
+      end
+
+    end
+  end
+end

data/lib/couchrest/model/views.rb

@@ -0,0 +1,167 @@
+module CouchRest
+  module Model
+    module Views
+      extend ActiveSupport::Concern
+      
+      module ClassMethods
+        # Define a CouchDB view. The name of the view will be the concatenation
+        # of <tt>by</tt> and the keys joined by <tt>_and_</tt>
+        #  
+        # ==== Example views:
+        #  
+        #   class Post
+        #     # view with default options
+        #     # query with Post.by_date
+        #     view_by :date, :descending => true
+        #  
+        #     # view with compound sort-keys
+        #     # query with Post.by_user_id_and_date
+        #     view_by :user_id, :date
+        #  
+        #     # view with custom map/reduce functions
+        #     # query with Post.by_tags :reduce => true
+        #     view_by :tags,                                                
+        #       :map =>                                                     
+        #         "function(doc) {                                          
+        #           if (doc['couchrest-type'] == 'Post' && doc.tags) {                   
+        #             doc.tags.forEach(function(tag){                       
+        #               emit(doc.tag, 1);                                   
+        #             });                                                   
+        #           }                                                       
+        #         }",                                                       
+        #       :reduce =>                                                  
+        #         "function(keys, values, rereduce) {                       
+        #           return sum(values);                                     
+        #         }"                                                        
+        #   end
+        #  
+        # <tt>view_by :date</tt> will create a view defined by this Javascript
+        # function:
+        #  
+        #   function(doc) {
+        #     if (doc['couchrest-type'] == 'Post' && doc.date) {
+        #       emit(doc.date, null);
+        #     }
+        #   }
+        #  
+        # It can be queried by calling <tt>Post.by_date</tt> which accepts all
+        # valid options for CouchRest::Database#view. In addition, calling with
+        # the <tt>:raw => true</tt> option will return the view rows
+        # themselves. By default <tt>Post.by_date</tt> will return the
+        # documents included in the generated view.
+        #  
+        # Calling with :database => [instance of CouchRest::Database] will
+        # send the query to a specific database, otherwise it will go to
+        # the model's default database (use_database)
+        #  
+        # CouchRest::Database#view options can be applied at view definition
+        # time as defaults, and they will be curried and used at view query
+        # time. Or they can be overridden at query time.
+        #  
+        # Custom views can be queried with <tt>:reduce => true</tt> to return
+        # reduce results. The default for custom views is to query with
+        # <tt>:reduce => false</tt>.
+        #  
+        # Views are generated (on a per-model basis) lazily on first-access.
+        # This means that if you are deploying changes to a view, the views for
+        # that model won't be available until generation is complete. This can
+        # take some time with large databases. Strategies are in the works.
+        #  
+        # To understand the capabilities of this view system more completely,
+        # it is recommended that you read the RSpec file at
+        # <tt>spec/couchrest/more/extended_doc_spec.rb</tt>.
+
+        def view_by(*keys)
+          opts = keys.pop if keys.last.is_a?(Hash)
+          opts ||= {}
+          ducktype = opts.delete(:ducktype)
+          unless ducktype || opts[:map]
+            opts[:guards] ||= []
+            opts[:guards].push "(doc['couchrest-type'] == '#{self.to_s}')"
+          end
+          keys.push opts
+          design_doc.view_by(*keys)
+          req_design_doc_refresh
+        end
+
+        # returns stored defaults if there is a view named this in the design doc
+        def has_view?(view)
+          view = view.to_s
+          design_doc && design_doc['views'] && design_doc['views'][view]
+        end
+
+        # Dispatches to any named view.
+        def view(name, query={}, &block)
+          query = query.dup # Modifications made on copy!
+          db = query.delete(:database) || database
+          refresh_design_doc(db)
+          query[:raw] = true if query[:reduce]        
+          raw = query.delete(:raw)
+          fetch_view_with_docs(db, name, query, raw, &block)
+        end
+
+        # Find the first entry in the view. If the second parameter is a string
+        # it will be used as the key for the request, for example:
+        #
+        #     Course.first_from_view('by_teacher', 'Fred')
+        #
+        # More advanced requests can be performed by providing a hash:
+        #
+        #     Course.first_from_view('by_teacher', :startkey => 'bbb', :endkey => 'eee')
+        #
+        def first_from_view(name, *args)
+          query = {:limit => 1}
+          case args.first
+          when String, Array
+            query.update(args[1]) unless args[1].nil?
+            query[:key] = args.first
+          when Hash
+            query.update(args.first)
+          end
+          view(name, query).first
+        end
+
+        private
+
+        def fetch_view_with_docs(db, name, opts, raw=false, &block)
+          if raw || (opts.has_key?(:include_docs) && opts[:include_docs] == false)
+            fetch_view(db, name, opts, &block)
+          else
+            begin
+              if block.nil?
+                collection_proxy_for(design_doc, name, opts.merge({:include_docs => true}))
+              else
+                view = fetch_view db, name, opts.merge({:include_docs => true}), &block
+                view['rows'].collect{|r|create_from_database(r['doc'])} if view['rows']
+              end
+            rescue
+              # fallback for old versions of couchdb that don't 
+              # have include_docs support
+              view = fetch_view(db, name, opts, &block)
+              view['rows'].collect{|r|create_from_database(db.get(r['id']))} if view['rows']
+            end
+          end
+        end
+
+        def fetch_view(db, view_name, opts, &block)
+          raise "A view needs a database to operate on (specify :database option, or use_database in the #{self.class} class)" unless db
+          retryable = true
+          begin
+            design_doc.view_on(db, view_name, opts, &block)
+            # the design doc may not have been saved yet on this database
+          rescue RestClient::ResourceNotFound => e
+            if retryable
+              save_design_doc(db)
+              retryable = false
+              retry
+            else
+              raise e
+            end
+          end
+        end
+        
+      end # module ClassMethods
+      
+    end
+  end
+end