samlown-couchrest 0.35

data/lib/couchrest/mixins/validation.rb

@@ -0,0 +1,246 @@
+# 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'
+require File.join(File.dirname(__FILE__), '..', 'support', 'class')
+
+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

data/lib/couchrest/mixins/views.rb

@@ -0,0 +1,173 @@
+module CouchRest
+  module Mixins
+    module Views
+      
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+      
+      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
+          self.design_doc.view_by(*keys)
+          self.design_doc_fresh = false
+        end
+
+        # returns stored defaults if the 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)
+          db = query.delete(:database) || database
+          unless design_doc_fresh            
+            refresh_design_doc_on(db)
+          end
+          query[:raw] = true if query[:reduce]        
+          raw = query.delete(:raw)
+          fetch_view_with_docs(db, name, query, raw, &block)
+        end
+
+        # DEPRECATED
+        # user model_design_doc to retrieve the current design doc
+        def all_design_doc_versions(db = database)
+          db.documents :startkey => "_design/#{self.to_s}", 
+            :endkey => "_design/#{self.to_s}-\u9999"
+        end
+        
+        def model_design_doc(db = database)
+          begin
+            @model_design_doc = db.get("_design/#{self.to_s}")
+          rescue
+            nil
+          end
+        end
+
+        # Deletes the current design doc for the current class.
+        # Running it to early could mean that live code has to regenerate
+        # potentially large indexes.
+        def cleanup_design_docs!(db = database)
+          save_design_doc_on(db)
+        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 HttpAbstraction::ResourceNotFound => e
+            if retryable
+              save_design_doc_on(db)
+              retryable = false
+              retry
+            else
+              raise e
+            end
+          end
+        end
+        
+      end # module ClassMethods
+      
+      
+    end
+  end
+end

data/lib/couchrest/mixins.rb

@@ -0,0 +1,4 @@
+mixins_dir = File.join(File.dirname(__FILE__), 'mixins')
+
+require File.join(mixins_dir, 'attachments')
+require File.join(mixins_dir, 'callbacks')

data/lib/couchrest/monkeypatches.rb

@@ -0,0 +1,113 @@
+require File.join(File.dirname(__FILE__), 'support', 'class')
+require File.join(File.dirname(__FILE__), 'support', 'blank')
+require 'timeout'
+
+# This file must be loaded after the JSON gem and any other library that beats up the Time class.
+class Time
+  # This date format sorts lexicographically
+  # and is compatible with Javascript's <tt>new Date(time_string)</tt> constructor.
+  # Note this this format stores all dates in UTC so that collation 
+  # order is preserved. (There's no longer a need to set <tt>ENV['TZ'] = 'UTC'</tt>
+  # in your application.)
+
+  def to_json(options = nil)
+    u = self.getutc
+    %("#{u.strftime("%Y/%m/%d %H:%M:%S +0000")}")
+  end
+
+  # Decodes the JSON time format to a UTC time.
+  # Based on Time.parse from ActiveSupport. ActiveSupport's version
+  # is more complete, returning a time in your current timezone, 
+  # rather than keeping the time in UTC. YMMV.
+  # def self.parse string, fallback=nil
+  #   d = DateTime.parse(string).new_offset
+  #   self.utc(d.year, d.month, d.day, d.hour, d.min, d.sec)
+  # rescue
+  #   fallback
+  # end
+end
+
+# Monkey patch for faster net/http io
+if RUBY_VERSION.to_f < 1.9
+  class Net::BufferedIO #:nodoc:
+    alias :old_rbuf_fill :rbuf_fill
+    def rbuf_fill
+      if @io.respond_to?(:read_nonblock)
+        begin
+          @rbuf << @io.read_nonblock(65536)
+        rescue Errno::EWOULDBLOCK
+          if IO.select([@io], nil, nil, @read_timeout)
+            retry
+          else
+            raise Timeout::Error, "IO timeout"
+          end
+        end
+      else
+        timeout(@read_timeout) do
+          @rbuf << @io.sysread(65536)
+        end
+      end
+    end
+  end
+end
+
+# module RestClient
+#   # def self.copy(url, headers={})
+#   #   Request.execute(:method => :copy,
+#   #     :url => url,
+#   #     :headers => headers)
+#   # end  
+# 
+# #   class Request
+# #     
+# #     def establish_connection(uri)
+# #       Thread.current[:connection].finish if (Thread.current[:connection] && Thread.current[:connection].started?)
+# #       p net_http_class
+# #       net = net_http_class.new(uri.host, uri.port)
+# #       net.use_ssl = uri.is_a?(URI::HTTPS)
+# #       net.verify_mode = OpenSSL::SSL::VERIFY_NONE
+# #       Thread.current[:connection] = net
+# #       Thread.current[:connection].start
+# #       Thread.current[:connection]
+# #     end
+# #     
+# #     def transmit(uri, req, payload)
+# #       setup_credentials(req)
+# #       
+# #       Thread.current[:host] ||= uri.host
+# #       Thread.current[:port] ||= uri.port
+# #       
+# #       if (Thread.current[:connection].nil? || (Thread.current[:host] != uri.host))
+# #         p "establishing a connection"
+# #         establish_connection(uri)
+# #       end
+# # 
+# #       display_log request_log
+# #       http = Thread.current[:connection]
+# #       http.read_timeout = @timeout if @timeout
+# #       
+# #       begin
+# #         res = http.request(req, payload)
+# #       rescue
+# #         p "Net::HTTP connection failed, reconnecting"
+# #         establish_connection(uri)
+# #         http = Thread.current[:connection]
+# #         require 'ruby-debug'
+# #         req.body_stream = nil
+# #         
+# #         res = http.request(req, payload)
+# #         display_log response_log(res)
+# #         result res
+# #       else
+# #         display_log response_log(res)
+# #         process_result res
+# #       end
+# #       
+# #     rescue EOFError
+# #       raise RestClient::ServerBrokeConnection
+# #     rescue Timeout::Error
+# #       raise RestClient::RequestTimeout
+# #     end
+# #   end
+#   
+# end 

data/lib/couchrest/more/casted_model.rb

@@ -0,0 +1,58 @@
+require File.expand_path('../../mixins/properties', __FILE__)
+
+
+module CouchRest
+  module CastedModel
+    
+    def self.included(base)
+      base.send(:include, ::CouchRest::Callbacks)
+      base.send(:include, ::CouchRest::Mixins::Properties)
+      base.send(:attr_accessor, :casted_by)
+      base.send(:attr_accessor, :document_saved)
+    end
+    
+    def initialize(keys={})
+      raise StandardError unless self.is_a? Hash
+      apply_defaults # defined in CouchRest::Mixins::Properties
+      super()
+      keys.each do |k,v|
+        self[k.to_s] = v
+      end if keys
+      cast_keys      # defined in CouchRest::Mixins::Properties
+    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?
+      !@document_saved
+    end
+    alias :new_record? :new?
+    
+    # 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