relaxdb 0.3.5 → 0.5

data/lib/relaxdb/extlib.rb

@@ -16,9 +16,15 @@ class Time
   # Ensure that all Times are stored as UTC
   # Times in the following format may be passed directly to
   # Date.new in a JavaScript runtime
-  def to_json
+  def to_json(options={})
     utc
     %Q("#{strftime "%Y/%m/%d %H:%M:%S +0000"}")
   end
 
 end
+
+class Hash
+  def to_obj
+    RelaxDB.create_obj_from_doc(self)
+  end
+end

data/lib/relaxdb/migration.rb

@@ -1,18 +1,21 @@
 module RelaxDB
   
   class Migration
+    
+    def self.load_batch klass, startkey, limit
+      skip = startkey.nil? ? 0 : 1
+      result = RelaxDB.rf_view "#{klass}_all", :startkey => startkey, 
+        :raw => true, :limit => limit, :skip => skip
+      ids = result["rows"].map { |h| h["id"] }
+      RelaxDB.load! ids      
+    end
                 
     def self.run klass, limit = 1000
-      query = lambda do |page_params|
-        RelaxDB.paginate_view "#{klass}_all", :startkey => nil, :endkey => {}, :attributes => [:_id],
-          :page_params => page_params, :limit => limit
-      end
-      
-      objs = query.call({})
+      objs = load_batch klass, nil, limit
       until objs.empty?
-        migrated = objs.map { |o| yield o }.flatten.reject { |o| o.nil? }
+        migrated = objs.map { |o| yield o }.flatten.compact
         RelaxDB.bulk_save! *migrated
-        objs = objs.next_params ? query.call(objs.next_params) : []
+        objs = load_batch klass, objs[-1]._id, limit
       end
     end
     

data/lib/relaxdb/net_http_server.rb

@@ -5,6 +5,7 @@ module RelaxDB
     def initialize(host, port)
       @host = host
       @port = port
+      @cx = Net::HTTP.start(@host, @port)
     end
 
     def delete(uri)
@@ -30,9 +31,26 @@ module RelaxDB
     end
 
     def request(req)
-      res = Net::HTTP.start(@host, @port) {|http|
+      res = Net::HTTP.start(@host, @port) { |http|
         http.request(req)
       }
+      
+      #
+      # When using this chunk of code, as opposed to the one above, CouchDB
+      # started throwing emfile errors. I can't imagine they're related,
+      # but worth noting nonetheless. On second thoughts, I think they are!
+      #
+      # The tests don't close the cx after they run - just open new ones, this
+      # could be causing CouchDB to run out of handles.
+      #
+      # begin
+      #   # @cx = Net::HTTP.start(@host, @port) unless @cx.active?
+      #   res = @cx.request(req)
+      # rescue
+      #   @cx = Net::HTTP.start(@host, @port)
+      #   res = @cx.request(req)
+      # end
+      
       if (not res.kind_of?(Net::HTTPSuccess))
         handle_error(req, res)
       end

data/lib/relaxdb/paginator.rb

@@ -8,9 +8,23 @@ module RelaxDB
       @paginate_params = paginate_params
       @orig_paginate_params = @paginate_params.clone
       
-      page_params = page_params.is_a?(String) ? JSON.parse(page_params).to_mash : page_params
+      @page_params = page_params.is_a?(String) ? JSON.parse(page_params).to_mash : page_params
       # Where the magic happens - the original params are updated with the page specific params
-      @paginate_params.update(page_params)
+      @paginate_params.update(@page_params)
+    end
+    
+    def add_q_next_and_prev docs, view_name, view_keys    
+      if docs.empty?        
+        next_exists = prev_exists = false
+      else
+        next_exists = docs.size >= @paginate_params.limit
+        next_params = next_exists ? create_next(docs.last, view_keys) : false
+      
+        prev_exists = !@page_params.empty?
+        prev_params = prev_exists ? create_prev(docs.first, view_keys) : false        
+      end
+            
+      add_next_and_prev_meths docs, next_params, prev_params
     end
 
     def total_doc_count(view_name)
@@ -31,22 +45,16 @@ module RelaxDB
         total_doc_count = total_doc_count(view_name)      
       
         next_exists = !@paginate_params.order_inverted? ? (offset - orig_offset + no_docs < total_doc_count) : true
-        next_params = create_next(docs.last, view_keys) if next_exists
+        next_params = next_exists ? create_next(docs.last, view_keys) : false
     
         prev_exists = @paginate_params.order_inverted? ? (offset - orig_offset + no_docs < total_doc_count) : 
           (offset - orig_offset == 0 ? false : true)
-        prev_params = create_prev(docs.first, view_keys) if prev_exists
+        prev_params = prev_exists ? create_prev(docs.first, view_keys) : false
       else
         next_exists = prev_exists = false
       end
       
-      docs.meta_class.instance_eval do        
-        define_method(:next_params) { next_exists ? next_params : false }
-        define_method(:next_query) { next_exists ? "page_params=#{::CGI::escape(next_params.to_json)}" : false }
-        
-        define_method(:prev_params) { prev_exists ? prev_params : false }
-        define_method(:prev_query) { prev_exists ? "page_params=#{::CGI::escape(prev_params.to_json)}" : false }
-      end      
+      add_next_and_prev_meths docs, next_params, prev_params      
     end
     
     def create_next(doc, view_keys)
@@ -83,6 +91,17 @@ module RelaxDB
       RelaxDB.rf_view(view_name, params).offset
     end
     
+    def add_next_and_prev_meths docs, next_params, prev_params
+      docs.meta_class.instance_eval do        
+        define_method(:next_params) { next_params }
+        define_method(:next_query) { next_params ? "page_params=#{::CGI::escape(next_params.to_json)}" : false }
+      
+        define_method(:prev_params) { prev_params }
+        define_method(:prev_query) { prev_params ? "page_params=#{::CGI::escape(prev_params.to_json)}" : false }
+      end      
+    end
+    
+    
   end
   
 end

data/lib/relaxdb/query.rb

@@ -67,7 +67,7 @@ module RelaxDB
       paginate_params.instance_variables.each do |pp|
         val = paginate_params.instance_variable_get(pp)
         method_name = pp[1, pp.length]
-        send(method_name, val) if methods.include? method_name
+        send(method_name, val) if @@params.include? method_name
       end
     end
         

data/lib/relaxdb/{belongs_to_proxy.rb → references_proxy.rb}

@@ -1,6 +1,6 @@
 module RelaxDB
 
-  class BelongsToProxy
+  class ReferencesProxy
 
     attr_reader :target
   
@@ -13,13 +13,13 @@ module RelaxDB
     def target
       return @target if @target
             
-      id = @client.instance_variable_get("@#{@relationship}_id")
+      id = @client.data["#{@relationship}_id"]
       @target = RelaxDB.load(id) if id
     end
   
     def target=(new_target)
       id = new_target ? new_target._id : nil
-      @client.instance_variable_set("@#{@relationship}_id", id) 
+      @client.data["#{@relationship}_id"] = id
       
       @target = new_target
     end

data/lib/relaxdb/relaxdb.rb

@@ -23,10 +23,11 @@ module RelaxDB
     end
     
     def enable_view_creation default=true
+      View.reset
       @create_views = default
     end
     
-    # Set in configuration and consulted by view_by, has_many, has_one, references_many and all
+    # Set in configuration and consulted by view_docs_by, has_many, has_one, references_many and all
     # Views will be added to CouchDB iff this is true
     def create_views?
       @create_views
@@ -121,16 +122,18 @@ module RelaxDB
       # RelaxDB.logger.debug(caller.inject("#{db.name}/#{ids}\n") { |a, i| a += "#{i}\n" })
       
       if ids.is_a? Array
+        return [] if ids.empty?
+        
         resp = db.post("_all_docs?include_docs=true", {:keys => ids}.to_json)
         data = JSON.parse(resp.body)
-        data["rows"].map { |row| row["doc"] ? create_object(row["doc"]) : nil }
+        data["rows"].map { |row| row["doc"] ? create_obj_from_doc(row["doc"]) : nil }
       else
         begin
           qs = atts.map{ |k, v| "#{k}=#{v}" }.join("&")
           qs = atts.empty? ? ids : "#{ids}?#{qs}"
           resp = db.get qs
           data = JSON.parse resp.body
-          create_object data
+          create_obj_from_doc data
         rescue HTTP_404
           nil
         end
@@ -146,6 +149,26 @@ module RelaxDB
       res
     end
     
+    #
+    # Queries a view that doesn't emit the underlying doc as a val.
+    #
+    def docs view_name, params
+      params[:raw] = true
+      params[:include_docs] = true
+      hash = view view_name, params
+      hash["rows"].map { |row| row["doc"] ? create_obj_from_doc(row["doc"]) : nil }
+    end
+    
+    def doc_ids view_name, params
+      params[:raw] = true
+      result = view view_name, params
+      ids_from_view result
+    end
+    
+    def ids_from_view raw_result
+      raw_result["rows"].map { |h| h["id"] }
+    end    
+    
     #
     # CouchDB defaults reduce to true when a reduce func is present.
     # RelaxDB used to indiscriminately set reduce=false, allowing clients to override
@@ -195,7 +218,8 @@ module RelaxDB
     
     def paginate_view(view_name, atts)      
       page_params = atts.delete :page_params
-      view_keys = atts.delete :attributes
+      view_keys = atts.delete :attributes      
+      qpaginate = atts.delete :qpaginate
       
       paginate_params = PaginateParams.new atts
       raise paginate_params.error_msg if paginate_params.invalid? 
@@ -209,17 +233,67 @@ module RelaxDB
       docs = ViewResult.new(JSON.parse(db.get(query.view_path).body))
       docs.reverse! if paginate_params.order_inverted?
       
-      paginator.add_next_and_prev(docs, view_name, view_keys)
+      if qpaginate
+        paginator.add_q_next_and_prev docs, view_name, view_keys
+      else
+        paginator.add_next_and_prev(docs, view_name, view_keys)
+      end
       
       docs
     end
-        
+    
+    #
+    # The paginate_view method only populates next and prev links if they exist.
+    # However, its implementation uses three queries to determine if the links
+    # should exist.
+    #
+    # It may be possible to determine if the links should exist with just
+    # a single query (by using a 1 doc offset on either side of the docs to be 
+    # displayed).
+    #
+    # This method makes a small change to paginate_view, dispensing with knowledge
+    # of when to create prev and next links but only requiring a single query.
+    #
+    # Indiscrimate display of prev links makes this method more suited
+    # to forward navigation only.
+    #
+    def qpaginate_view view_name, atts
+      atts[:qpaginate] = true
+      paginate_view view_name, atts
+    end
+    
+    #
+    # Paginates over views that don't emit the underlying doc as a val
+    # using the same idiom as qpaginate_view
+    #
+    def qpaginate_docs view_name, atts
+      page_params = atts.delete :page_params
+      view_keys = atts.delete :attributes      
+      
+      paginate_params = PaginateParams.new atts
+      raise paginate_params.error_msg if paginate_params.invalid?       
+      paginator = Paginator.new(paginate_params, page_params)
+
+      atts[:raw] = true
+      query = Query.new(view_name, atts)
+      query.merge(paginate_params)
+      
+      result = JSON.parse(db.get(query.view_path).body)
+      doc_ids = ids_from_view result
+      doc_ids.reverse! if paginate_params.order_inverted?
+      docs = RelaxDB.load! doc_ids
+      
+      paginator.add_q_next_and_prev docs, view_name, view_keys
+
+      docs      
+    end
+            
     def create_from_hash(data)
       data["rows"].map { |row| create_object(row["value"]) }
     end
   
     def create_object(data)
-      klass = data.is_a?(Hash) && data.delete("relaxdb_class")
+      klass = data.is_a?(Hash) && data["relaxdb_class"]
       if klass
         k = klass.split("::").inject(Object) { |x, y| x.const_get y }
         k.new data
@@ -228,6 +302,12 @@ module RelaxDB
         ViewObject.create data
       end
     end
+    
+    def create_obj_from_doc(data)
+      klass = data["relaxdb_class"]
+      k = klass.split("::").inject(Object) { |x, y| x.const_get y }
+      k.new data
+    end
         
     # Convenience methods - should be in a diffent module?
     

data/lib/relaxdb/server.rb

@@ -6,7 +6,7 @@ module RelaxDB
       
   class CouchDB
 
-    attr_reader :logger
+    attr_reader :logger, :server
         
     # Used for test instrumentation only i.e. to assert that 
     # an expected number of requests have been issued
@@ -66,7 +66,13 @@ module RelaxDB
       @put_count += 1
       @logger.info("PUT /#{@db}/#{unesc(path)} #{json}")
       @server.put("/#{@db}/#{path}", json)
-      # @server.put("/#{@db}/#{path}?batch=ok", json)
+    end
+    
+    def uuids(count=1)
+      @get_count += 1
+      uri = "/_uuids?count=#{count}"
+      @logger.info "GET #{uri}"
+      @server.get uri
     end
     
     def unesc(path)

data/lib/relaxdb/taf2_curb_server.rb

@@ -8,6 +8,8 @@ module RelaxDB
       end
     end
 
+    attr_reader :host, :port  
+    
     def initialize(host, port)
       @host, @port = host, port
     end
@@ -23,7 +25,6 @@ module RelaxDB
     def put(uri, json)
       request(uri, 'put') do |c|
         c.headers['content-type'] = 'application/json'
-        c.headers['X-Couch-Full-Commit'] = "true"
         c.http_put json
       end
     end

data/lib/relaxdb/uuid_generator.rb

@@ -1,20 +1,56 @@
 module RelaxDB
 
+  #
+  # UUIDs have a significant impact on CouchDB file size and performance
+  # See https://issues.apache.org/jira/browse/COUCHDB-465 and
+  # http://mail-archives.apache.org/mod_mbox/couchdb-dev/201001.mbox/%3chi57et$19n$1@ger.gmane.org%3e
+  #
+  # This approach uses the default CouchDB UUID generator (sequential) and 
+  # reduces its size by converting to base 36. Converting to base 36 results
+  # in a UUID 7 chars shorter than hex.
+  #
+  # The default size of 200 is arbitrary. Brian Candler's UUID generator in 
+  # couchtiny may also be of interest.
+  #
+  # 
   class UuidGenerator
+    
+    @uuids = []
+    @count = 200
   
     def self.uuid
       unless @length
-        @uuid ||= UUID.new 
-        @uuid.generate
+        uuid = @uuids.pop
+        if uuid.nil?
+          refill
+          uuid = @uuids.pop
+        end
+        uuid.hex.to_s(36)
       else
         rand.to_s[2, @length]
       end
     end
+    
+    def self.refill
+      resp = RelaxDB.db.uuids(@count)
+      @uuids = JSON.parse(resp.body)["uuids"]      
+    end
+    
+    def self.count=(c)
+      @count = c
+    end
   
     # Convenience that helps relationship debuggging and model exploration
     def self.id_length=(length)
       @length = length
     end
+    
+    # To be invoked by tests, or clients after temp changes
+    def self.reset
+      @uuids = []
+      @count = 200
+      @length = nil
+    end
   
   end
 

data/lib/relaxdb/view_by_delegator.rb

@@ -0,0 +1,34 @@
+module RelaxDB
+  
+  class ViewByDelegator < Delegator
+    
+    def initialize(view_name, opts)
+      super([])
+      @view_name = view_name
+      @opts = opts
+    end
+    
+    def __getobj__
+      unless @ids
+        @opts[:raw] = true
+        @ids = RelaxDB.doc_ids @view_name, @opts
+      end
+      @ids
+    end
+    
+    def __setobj__ obj
+      # Intentionally empty
+    end
+    
+    def load!
+      if @ids
+        RelaxDB.load! @ids
+      else
+        @opts[:include_docs] = true
+        RelaxDB.docs @view_name, @opts
+      end
+    end
+                
+  end
+  
+end