couchrest 0.35 → 0.36

data/Rakefile

@@ -20,7 +20,7 @@ begin
     gemspec.description = "CouchRest provides a simple interface on top of CouchDB's RESTful HTTP API, as well as including some utility scripts for managing views and attachments."
     gemspec.email = "jchris@apache.org"
     gemspec.homepage = "http://github.com/couchrest/couchrest"
-    gemspec.authors = ["J. Chris Anderson", "Matt Aimonetti", "Marcos Tapajos"]
+    gemspec.authors = ["J. Chris Anderson", "Matt Aimonetti", "Marcos Tapajos", "Will Leinweber"]
     gemspec.extra_rdoc_files = %w( README.md LICENSE THANKS.md )
     gemspec.files = %w( LICENSE README.md Rakefile THANKS.md history.txt) + Dir["{examples,lib,spec,utils}/**/*"] - Dir["spec/tmp"]
     gemspec.has_rdoc = true
@@ -64,4 +64,4 @@ module Rake
 end
 
 Rake.remove_task("github:release")
-Rake.remove_task("release")
+Rake.remove_task("release")

data/history.txt

@@ -4,6 +4,16 @@
 
 * Minor enhancements
 
+== 0.36
+
+* Major enhancements
+  * Adds support for continuous replication (sauy7)
+  * Automatic Type Casting (Alexander Uvarov, Sam Lown, Tim Heighes, Will Leinweber)
+  * Added a search method to CouchRest:Database to search the documents in a given database. (Dave Farkas, Arnaud Berthomier, John Wood)
+  
+* Minor enhancements
+  * Provide a description of the timeout error (John Wood)
+
 == 0.35
 
 * Major enhancements

data/lib/couchrest.rb

@@ -28,7 +28,7 @@ require 'couchrest/monkeypatches'
 
 # = CouchDB, close to the metal
 module CouchRest
-  VERSION    = '0.35' unless self.const_defined?("VERSION")
+  VERSION    = '0.36' unless self.const_defined?("VERSION")
   
   autoload :Server,       'couchrest/core/server'
   autoload :Database,     'couchrest/core/database'
@@ -96,15 +96,18 @@ module CouchRest
     
     def parse url
       case url
-      when /^https?:\/\/(.*)\/(.*)\/(.*)/
-        host = $1
-        db = $2
-        docid = $3
-      when /^https?:\/\/(.*)\/(.*)/
-        host = $1
-        db = $2
-      when /^https?:\/\/(.*)/
-        host = $1
+      when /^(https?:\/\/)(.*)\/(.*)\/(.*)/
+        scheme = $1
+        host = $2
+        db = $3
+        docid = $4
+      when /^(https?:\/\/)(.*)\/(.*)/
+        scheme = $1
+        host = $2
+        db = $3
+      when /^(https?:\/\/)(.*)/
+        scheme = $1
+        host = $2
       when /(.*)\/(.*)\/(.*)/
         host = $1
         db = $2
@@ -117,9 +120,9 @@ module CouchRest
       end
 
       db = nil if db && db.empty?
-
+      
       {
-        :host => host || "127.0.0.1:5984",
+        :host => (scheme || "http://") + (host || "127.0.0.1:5984"),
         :database => db,
         :doc => docid
       }

data/lib/couchrest/core/database.rb

@@ -44,7 +44,14 @@ module CouchRest
         CouchRest.get url
       end
     end
-  
+
+    # Query a CouchDB-Lucene search view
+    def search(name, params={})
+      # -> http://localhost:5984/yourdb/_fti/YourDesign/by_name?include_docs=true&q=plop*'
+      url = CouchRest.paramify_url "#{root}/_fti/#{name}", params
+      CouchRest.get url
+    end
+
     # load a set of documents by passing an array of ids
     def get_bulk(ids)
       documents(:keys => ids, :include_docs => true)
@@ -297,15 +304,13 @@ module CouchRest
     end
     
     # Replicates via "pulling" from another database to this database. Makes no attempt to deal with conflicts.
-    def replicate_from other_db
-      raise ArgumentError, "must provide a CouchReset::Database" unless other_db.kind_of?(CouchRest::Database)
-      CouchRest.post "#{@host}/_replicate", :source => other_db.root, :target => name
+    def replicate_from other_db, continuous=false
+      replicate other_db, continuous, :target => name
     end
     
     # Replicates via "pushing" to another database. Makes no attempt to deal with conflicts.
-    def replicate_to other_db
-      raise ArgumentError, "must provide a CouchReset::Database" unless other_db.kind_of?(CouchRest::Database)
-      CouchRest.post "#{@host}/_replicate", :target => other_db.root, :source => name
+    def replicate_to other_db, continuous=false
+      replicate other_db, continuous, :source => name
     end
     
     # DELETE the database itself. This is not undoable and could be rather
@@ -317,6 +322,19 @@ module CouchRest
 
     private
     
+    def replicate other_db, continuous, options
+      raise ArgumentError, "must provide a CouchReset::Database" unless other_db.kind_of?(CouchRest::Database)
+      raise ArgumentError, "must provide a target or source option" unless (options.key?(:target) || options.key?(:source))
+      payload = options
+      if options.has_key?(:target)
+        payload[:source] = other_db.root
+      else
+        payload[:target] = other_db.root
+      end
+      payload[:continuous] = continuous
+      CouchRest.post "#{@host}/_replicate", payload
+    end
+    
     def clear_extended_doc_fresh_cache
       ::CouchRest::ExtendedDocument.subclasses.each{|klass| klass.design_doc_fresh = false if klass.respond_to?(:design_doc_fresh=) }
     end

data/lib/couchrest/mixins/collection.rb

@@ -20,7 +20,7 @@ module CouchRest
           class_eval <<-END, __FILE__, __LINE__ + 1
             def self.find_all_#{collection_name}(options = {})
               view_options = #{view_options.inspect} || {}
-              CollectionProxy.new(@database, "#{design_doc}", "#{view_name}", view_options.merge(options), Kernel.const_get('#{self}'))
+              CollectionProxy.new(database, "#{design_doc}", "#{view_name}", view_options.merge(options), Kernel.const_get('#{self}'))
             end
           END
         end
@@ -42,7 +42,12 @@ module CouchRest
         #
         # Defaults are used if these options are not specified.
         def paginated_each(options, &block)
-          proxy = create_collection_proxy(options)
+          search = options.delete(:search)
+          unless search == true
+            proxy = create_collection_proxy(options)
+          else
+            proxy = create_search_collection_proxy(options)
+          end
           proxy.paginated_each(options, &block)
         end
 
@@ -58,7 +63,12 @@ module CouchRest
 
         def create_collection_proxy(options)
           design_doc, view_name, view_options = parse_view_options(options)
-          CollectionProxy.new(@database, design_doc, view_name, view_options, self)
+          CollectionProxy.new(database, design_doc, view_name, view_options, self)
+        end
+
+        def create_search_collection_proxy(options)
+          design_doc, search_name, search_options = parse_search_options(options)
+          CollectionProxy.new(@database, design_doc, search_name, search_options, self, :search)
         end
 
         def parse_view_options(options)
@@ -75,6 +85,18 @@ module CouchRest
 
           [design_doc, view_name, view_options]
         end
+
+        def parse_search_options(options)
+          design_doc = options.delete(:design_doc)
+          raise ArgumentError, 'design_doc is required' if design_doc.nil?
+
+          search_name = options.delete(:view_name)
+          raise ArgumentError, 'search_name is required' if search_name.nil?
+
+          search_options = options.clone
+          [design_doc, search_name, search_options]
+        end
+
       end
 
       class CollectionProxy
@@ -91,11 +113,12 @@ module CouchRest
         #
         # The CollectionProxy provides support for paginating over a collection
         # via the paginate, and paginated_each methods.
-        def initialize(database, design_doc, view_name, view_options = {}, container_class = nil)
+        def initialize(database, design_doc, view_name, view_options = {}, container_class = nil, query_type = :view)
           raise ArgumentError, "database is a required parameter" if database.nil?
 
           @database = database
           @container_class = container_class
+          @query_type = query_type
 
           strip_pagination_options(view_options)
           @view_options = view_options
@@ -110,10 +133,22 @@ module CouchRest
         # See Collection.paginate
         def paginate(options = {})
           page, per_page = parse_options(options)
-          results = @database.view(@view_name, pagination_options(page, per_page)) 
+          results = @database.send(@query_type, @view_name, pagination_options(page, per_page))
           remember_where_we_left_off(results, page)
-          results = convert_to_container_array(results)
-          results
+          instances = convert_to_container_array(results)
+
+          begin
+            if Kernel.const_get('WillPaginate')
+              total_rows = results['total_rows'].to_i
+              paginated = WillPaginate::Collection.create(page, per_page, total_rows) do |pager|
+                pager.replace(instances)
+              end
+              return paginated
+            end
+          rescue NameError
+            # When not using will_paginate, not much we could do about this. :x
+          end
+          return instances
         end
 
         # See Collection.paginated_each
@@ -152,7 +187,8 @@ module CouchRest
 
         def load_target
           unless loaded?
-            results = @database.view(@view_name, @view_options)
+            @view_options.merge!({:include_docs => true}) if @query_type == :search
+            results = @database.send(@query_type, @view_name, @view_options)
             @target = convert_to_container_array(results)
           end
           @loaded = true
@@ -189,7 +225,7 @@ module CouchRest
 
         def pagination_options(page, per_page)
           view_options = @view_options.clone
-          if @last_key && @last_docid && @last_page == page - 1
+          if @query_type == :view && @last_key && @last_docid && @last_page == page - 1
             key = view_options.delete(:key)
             end_key = view_options[:endkey] || key
             options = { :startkey => @last_key, :endkey => end_key, :startkey_docid => @last_docid, :limit => per_page, :skip => 1 }

data/lib/couchrest/mixins/properties.rb

@@ -1,24 +1,6 @@
 require 'time'
 require File.join(File.dirname(__FILE__), '..', 'more', 'property')
-
-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
+require File.join(File.dirname(__FILE__), '..', 'more', 'typecast')
 
 module CouchRest
   module Mixins
@@ -26,6 +8,8 @@ module CouchRest
       
       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)
@@ -67,28 +51,24 @@ module CouchRest
         return unless self[key]
         if property.type.is_a?(Array)
           klass = ::CouchRest.constantize(property.type[0])
-          arr = self[key].dup.collect do |value|
-            unless value.instance_of?(klass)
-              value = convert_property_value(property, klass, value)
-            end
+          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
           self[key] = klass != String ? CastedArray.new(arr) : arr
           self[key].casted_by = self if self[key].respond_to?(:casted_by)
         else
-          if property.type == 'boolean'
+          if property.type.downcase == 'boolean'
             klass = TrueClass
           else
             klass = ::CouchRest.constantize(property.type)
           end
           
-          unless self[key].instance_of?(klass)
-            self[key] = convert_property_value(property, klass, self[property.name])
-          end
-          associate_casted_to_parent(self[property.name], assigned)
+          self[key] = typecast_value(self[key], klass, property.init_method)
+          associate_casted_to_parent(self[key], assigned)
         end
-        
       end
       
       def associate_casted_to_parent(casted, assigned)
@@ -96,21 +76,6 @@ module CouchRest
         casted.document_saved = true if !assigned && casted.respond_to?(:document_saved)
       end
       
-      def convert_property_value(property, klass, value)
-        if ((property.init_method == 'new') && klass == Time)
-          # Using custom time parsing method because Ruby's default method is toooo slow
-          value.is_a?(String) ? Time.mktime_with_offset(value.dup) : value
-        # Float instances don't get initialized with #new
-        elsif ((property.init_method == 'new') && klass == Float)
-          cast_float(value)
-          # 'boolean' type is simply used to generate a property? accessor method
-        elsif ((property.init_method == 'new') && klass == TrueClass)
-          value
-        else
-          klass.send(property.init_method, value.dup)
-        end
-      end
-      
       def cast_property_by_name(property_name)
         return unless self.class.properties
         property = self.class.properties.detect{|property| property.name == property_name}
@@ -118,14 +83,7 @@ module CouchRest
         cast_property(property, true)
       end
       
-      def cast_float(value)
-        begin 
-          Float(value)
-        rescue
-          value
-        end
-      end
-      
+     
       module ClassMethods
         
         def property(name, options={})
@@ -141,7 +99,7 @@ module CouchRest
           # 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[:cast_as] : false
+            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

data/lib/couchrest/monkeypatches.rb

@@ -39,7 +39,7 @@ if RUBY_VERSION.to_f < 1.9
           if IO.select([@io], nil, nil, @read_timeout)
             retry
           else
-            raise Timeout::Error
+            raise Timeout::Error, "IO timeout"
           end
         end
       else

data/lib/couchrest/more/extended_document.rb

@@ -14,7 +14,7 @@ module CouchRest
     include CouchRest::Mixins::ExtendedAttachments
     include CouchRest::Mixins::ClassProxy
     include CouchRest::Mixins::Collection
-		include CouchRest::Mixins::AttributeProtection
+    include CouchRest::Mixins::AttributeProtection
 
     def self.subclasses
       @subclasses ||= []
@@ -58,6 +58,7 @@ module CouchRest
       unless self['_id'] && self['_rev']
         self['couchrest-type'] = self.class.to_s
       end
+      after_initialize if respond_to?(:after_initialize)
     end
     
     # Defines an instance and save it directly to the database 
@@ -84,9 +85,9 @@ module CouchRest
     # on the document whenever saving occurs. CouchRest uses a pretty
     # decent time format by default. See Time#to_json
     def self.timestamps!
-      class_eval <<-EOS, __FILE__, __LINE__ + 1
-        property(:updated_at, :read_only => true, :cast_as => 'Time', :auto_validation => false)
-        property(:created_at, :read_only => true, :cast_as => 'Time', :auto_validation => false)
+      class_eval <<-EOS, __FILE__, __LINE__
+        property(:updated_at, :read_only => true, :type => 'Time', :auto_validation => false)
+        property(:created_at, :read_only => true, :type => 'Time', :auto_validation => false)
         
         set_callback :save, :before do |object|
           object['updated_at'] = Time.now

data/lib/couchrest/more/property.rb

@@ -1,9 +1,9 @@
 module CouchRest
-  
+
   # Basic attribute support for adding getter/setter + validation
   class Property
     attr_reader :name, :type, :read_only, :alias, :default, :casted, :init_method, :options
-    
+
     # attribute to define
     def initialize(name, type = nil, options = {})
       @name = name.to_s
@@ -11,20 +11,19 @@ module CouchRest
       parse_options(options)
       self
     end
-    
-    
+
     private
-    
+
       def parse_type(type)
         if type.nil?
           @type = 'String'
         elsif type.is_a?(Array) && type.empty?
-          @type = 'Array'
+          @type = ['Object']
         else
           @type = type.is_a?(Array) ? [type.first.to_s] : type.to_s
         end
       end
-      
+
       def parse_options(options)
         return if options.empty?
         @validation_format  = options.delete(:format)     if options[:format]
@@ -35,7 +34,7 @@ module CouchRest
         @init_method        = options[:init_method] ? options.delete(:init_method) : 'new'
         @options            = options
       end
-    
+
   end
 end
 
@@ -56,4 +55,4 @@ class CastedArray < Array
     obj.casted_by = self.casted_by if obj.respond_to?(:casted_by)
     super(index, obj)
   end
-end
+end