paulcarey-relaxdb 0.2.8 → 0.3.0

data/lib/more/atomic_bulk_save_support.rb

@@ -0,0 +1,18 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'relaxdb'
+require File.dirname(__FILE__) + '/../../spec/spec_models.rb'
+
+RelaxDB.configure :host => "localhost", :port => 5984
+RelaxDB.delete_db "relaxdb_spec" rescue :ok
+RelaxDB.use_db "relaxdb_spec"
+
+a1 = Atom.new.save!
+a1_dup = a1.dup
+a1.save!
+begin
+  RelaxDB.bulk_save! a1_dup
+  puts "Atomic bulk_save _not_ supported"
+rescue RelaxDB::UpdateConflict
+  puts "Atomic bulk_save supported"
+end
+  

data/lib/relaxdb/all_delegator.rb

@@ -3,65 +3,41 @@ module RelaxDB
   #
   # The AllDelegator allows clients to query CouchDB in a natural way
   #   FooDoc.all - returns all docs in CouchDB of type FooDoc
-  #   FooDoc.all.sorted_by(:att1, :att2) - returns all docs in CouchDB of type FooDoc sorted by att1, then att2
-  #   FooDoc.all.sorted_by(:att1) { |q| q.key("bar") } - returns all docs of type FooDoc where att1 equals "bar"
-  #   FooDoc.all.destroy! - does what it says on the tin
   #   FooDoc.all.size - issues a query to a reduce function that returns the total number of docs for that class
+  #   FooDoc.all.destroy! - TODO - better description
   #
   class AllDelegator < Delegator
     
-    def initialize(class_name)
+    def initialize(class_name, params)
       super([])
       @class_name = class_name
+      @params = params
     end
     
     def __getobj__
-      view_path = "_view/#{@class_name}/all?reduce=false"
-      map, reduce = ViewCreator.all(@class_name)
-      
-      RelaxDB.retrieve(view_path, @class_name, "all", map, reduce)
+      unless @objs
+        @objs = RelaxDB.view "#{@class_name}_all", @params
+      end
+      @objs
     end
 
-    def sorted_by(*atts)
-      view = SortedByView.new(@class_name, *atts)
-
-      query = Query.new(@class_name, view.view_name)
-      yield query if block_given?
-      
-      view.query(query)
+    def size
+      size = RelaxDB.view "#{@class_name}_all", :reduce => true
+      size || 0
     end
     
-    # Note that this method leaves the corresponding DesignDoc for the associated class intact
+    # TODO: destroy in a bulk_save if feasible
     def destroy!
-      each do |o| 
+      __getobj__
+      @objs.each do |o| 
         # A reload is required for deleting objects with a self referential references_many relationship
-        # This makes all.destroy! very slow. Given that references_many is now deprecated and will
-        # soon be removed, the required reload is no longer performed.
+        # This makes all.destroy! very slow. Change if needed
         # obj = RelaxDB.load(o._id)
         # obj.destroy!
         
         o.destroy!
       end
-    end
-    
-    # This is pretty ugly - this pattern is now spread over three 
-    # places (sorted_by_view, relaxdb and here)
-    # Consolidation needed
-    def size
-      view_path = "_view/#{@class_name}/all"
-      map, reduce = ViewCreator.all(@class_name)
-      
-      begin
-        resp = RelaxDB.db.get(view_path)
-      rescue => e
-        DesignDocument.get(@class_name).add_map_view("all", map).
-          add_reduce_view("all", reduce).save
-        resp = RelaxDB.db.get(view_path)
-      end
-      
-      data = JSON.parse(resp.body)
-      data["rows"][0] ? data["rows"][0]["value"] : 0
-    end
+    end    
             
   end
   

data/lib/relaxdb/design_doc.rb

@@ -1,9 +1,11 @@
 module RelaxDB
 
   class DesignDocument
+    
+    attr_reader :data
   
-    def initialize(client_class, data)
-      @client_class = client_class
+    def initialize(design_doc_name, data)
+      @design_doc_name = design_doc_name
       @data = data
     end
       
@@ -34,13 +36,13 @@ module RelaxDB
       self
     end
   
-    def self.get(client_class)
+    def self.get(design_doc_name)
       begin
         database = RelaxDB.db
-        resp = database.get("_design/#{client_class}")
-        DesignDocument.new(client_class, JSON.parse(resp.body))
+        resp = database.get("_design/#{design_doc_name}")
+        DesignDocument.new(design_doc_name, JSON.parse(resp.body))
       rescue HTTP_404
-        DesignDocument.new(client_class, {"_id" => "_design/#{client_class}"} )
+        DesignDocument.new(design_doc_name, {"_id" => "_design/#{design_doc_name}"} )
       end
     end  
     

data/lib/relaxdb/document.rb

@@ -7,16 +7,28 @@ module RelaxDB
     # Used to store validation messages
     attr_accessor :errors
     
+    # A call issued to save_all will save this object and the
+    # contents of the save_list. This allows secondary object to
+    # be saved at the same time as this object.
+    attr_accessor :save_list
+    
     # Attribute symbols added to this list won't be validated on save
     attr_accessor :validation_skip_list
     
-    # Define properties and property methods
+    class_inheritable_accessor :properties, :reader => true
+    self.properties = []
+
+    class_inheritable_accessor :derived_prop_writers
+    self.derived_prop_writers = {}
+    
+    class_inheritable_accessor :__view_by_list__
+    self.__view_by_list__ = []
     
+    class_inheritable_accessor :belongs_to_rels, :reder => true
+    self.belongs_to_rels = {}
+            
     def self.property(prop, opts={})
-      # Class instance varibles are not inherited, so the default properties must be explicitly listed 
-      # Perhaps a better solution exists. Revise. I think extlib contains a solution for this...
-      @properties ||= [:_id, :_rev]
-      @properties << prop
+      properties << prop
 
       define_method(prop) do
         instance_variable_get("@#{prop}".to_sym)        
@@ -45,12 +57,10 @@ module RelaxDB
       if opts[:derived]
         add_derived_prop(prop, opts[:derived])
       end
-    end
-
-    def self.properties
-      # Ensure that classes that don't define their own properties still function as CouchDB objects
-      @properties ||= [:_id, :_rev]
-    end
+    end    
+  
+    property :_id 
+    property :_rev        
     
     def self.create_validator(att, v)
       method_name = "validate_#{att}"
@@ -78,15 +88,10 @@ module RelaxDB
     # See derived_properties_spec.rb for usage
     def self.add_derived_prop(prop, deriver)
         source, writer = deriver[0], deriver[1]
-        @derived_prop_writers ||= {}
-        @derived_prop_writers[source] ||= {}
-        @derived_prop_writers[source][prop] = writer
-    end
-    
-    def self.derived_prop_writers
-      @derived_prop_writers ||= {}
+        derived_prop_writers[source] ||= {}
+        derived_prop_writers[source][prop] = writer
     end
-    
+        
     #
     # The rationale for rescuing the send below is that the lambda for a derived 
     # property shouldn't need to concern itself with checking the validity of
@@ -94,27 +99,19 @@ module RelaxDB
     # possibility of a writer raising an exception.
     #
     def write_derived_props(source)
-      writers = self.class.derived_prop_writers[source]
+      writers = self.class.derived_prop_writers
+      writers = writers && writers[source]
       if writers 
         writers.each do |prop, writer|
           current_val = send(prop)
           begin
             send("#{prop}=", writer.call(current_val, self)) 
           rescue => e
-            RelaxDB.logger.warn "Deriving #{prop} from #{source} raised #{e}"
+            RelaxDB.logger.error "Deriving #{prop} from #{source} raised #{e}"
           end
         end
       end
     end
-
-    def properties
-      self.class.properties
-    end
-    
-    # Specifying these properties here (after property method has been defined) 
-    # is kinda ugly. Consider a better solution.
-    property :_id 
-    property :_rev    
     
     def initialize(hash={})
       unless hash["_id"]
@@ -122,6 +119,7 @@ module RelaxDB
       end
       
       @errors = Errors.new
+      @save_list = []
       @validation_skip_list = []
 
       # Set default properties if this object isn't being loaded from CouchDB
@@ -165,6 +163,7 @@ module RelaxDB
         s << ", #{relationship}_id: #{id}" if id
       end
       s << ", errors: #{errors.inspect}" unless errors.empty?
+      s << ", save_list: #{save_list.map { |o| o.inspect }.join ", " }" unless save_list.empty?
       s << ">"
     end
     
@@ -180,7 +179,7 @@ module RelaxDB
         prop_val = instance_variable_get("@#{prop}".to_sym)
         data["#{prop}"] = prop_val if prop_val
       end
-      data["class"] = self.class.name
+      data["relaxdb_class"] = self.class.name
       data.to_json      
     end
             
@@ -211,9 +210,9 @@ module RelaxDB
     end
     
     def pre_save
+      set_created_at if new_document?
       return false unless validates?
       return false unless before_save            
-      set_created_at if new_document?
       true 
     end  
     
@@ -221,6 +220,15 @@ module RelaxDB
       after_save
     end
     
+    # save_all and save_all! are untested
+    def save_all
+      RelaxDB.bulk_save self, *save_list
+    end
+    
+    def save_all!
+      RelaxDB.bulk_save! self, *save_list
+    end
+    
     def save!
       if save
         self
@@ -230,21 +238,7 @@ module RelaxDB
         raise ValidationFailure, self.errors.to_json
       end
     end
-    
-    def save_all
-      RelaxDB.bulk_save(self, *all_children)
-    end
-
-    def save_all!
-      RelaxDB.bulk_save!(self, *all_children)
-    end
-    
-    def all_children      
-      ho = self.class.has_one_rels.map { |r| send(r) }
-      hm = self.class.has_many_rels.inject([]) { |m,r| m += send(r).children }
-      ho + hm
-    end
-    
+        
     def update_conflict?
       @update_conflict
     end
@@ -269,6 +263,7 @@ module RelaxDB
             
       total_success
     end
+    alias_method :validate, :validates?
     
     def validate_att(att_name, att_val)
       begin
@@ -286,7 +281,8 @@ module RelaxDB
             RelaxDB.logger.warn "Validation_msg for #{att_name} with #{att_val} raised #{e}"
             @errors[att_name] = "validation_msg_exception:invalid:#{att_val}"
           end
-        else
+        elsif @errors[att_name].nil?
+          # Only set a validation message if a validator hasn't already set one
           @errors[att_name] = "invalid:#{att_val}"
         end
       end
@@ -337,6 +333,12 @@ module RelaxDB
       @references_many_rels << relationship
      
       id_arr_sym = "@#{relationship}".to_sym
+      
+      if RelaxDB.create_views?
+        target_class = opts[:class]
+        relationship_as_viewed_by_target = opts[:known_as].to_s
+        ViewCreator.references_many(self.name, relationship, target_class, relationship_as_viewed_by_target).save
+      end            
      
       define_method(relationship) do
         instance_variable_set(id_arr_sym, []) unless instance_variable_defined? id_arr_sym
@@ -362,6 +364,12 @@ module RelaxDB
       @has_many_rels ||= []
       @has_many_rels << relationship
       
+      if RelaxDB.create_views?
+        target_class = opts[:class]
+        relationship_as_viewed_by_target = (opts[:known_as] || self.name.snake_case).to_s
+        ViewCreator.has_n(self.name, relationship, target_class, relationship_as_viewed_by_target).save
+      end      
+      
       define_method(relationship) do
         create_or_get_proxy(HasManyProxy, relationship, opts)
       end
@@ -382,6 +390,12 @@ module RelaxDB
       @has_one_rels ||= []
       @has_one_rels << relationship
       
+      if RelaxDB.create_views?
+        target_class = relationship.to_s.camel_case      
+        relationship_as_viewed_by_target = self.name.snake_case      
+        ViewCreator.has_n(self.name, relationship, target_class, relationship_as_viewed_by_target).save
+      end
+      
       define_method(relationship) do      
         create_or_get_proxy(HasOneProxy, relationship).target
       end
@@ -398,8 +412,7 @@ module RelaxDB
     end
             
     def self.belongs_to(relationship, opts={})
-      @belongs_to_rels ||= {}
-      @belongs_to_rels[relationship] = opts
+      belongs_to_rels[relationship] = opts
 
       define_method(relationship) do
         create_or_get_proxy(BelongsToProxy, relationship).target
@@ -417,7 +430,6 @@ module RelaxDB
         id
       end
 
-      # Allows belongs_to relationships to be used by the paginator
       define_method("#{relationship}_id") do
         instance_variable_get("@#{relationship}_id")
       end
@@ -432,16 +444,14 @@ module RelaxDB
       alias_method :references, :belongs_to
     end
     
-    def self.belongs_to_rels
-      @belongs_to_rels ||= {}
-    end
+    self.belongs_to_rels = {}
     
     def self.all_relationships
       belongs_to_rels + has_one_rels + has_many_rels + references_many_rels
     end
         
-    def self.all
-      @all_delegator ||= AllDelegator.new(self.name)
+    def self.all params = {}
+      AllDelegator.new self.name, params
     end
                     
     # destroy! nullifies all relationships with peers and children before deleting 
@@ -482,7 +492,10 @@ module RelaxDB
     def before_save
       self.class.before_save_callbacks.each do |callback|
         resp = callback.is_a?(Proc) ? callback.call(self) : send(callback)
-        return false unless resp
+        if resp == false
+          errors[:before_save] = :failed
+          return false
+        end
       end
     end
     
@@ -499,27 +512,80 @@ module RelaxDB
         callback.is_a?(Proc) ? callback.call(self) : send(callback)
       end
     end
-    
-    def self.paginate_by(page_params, *view_keys)
-      paginate_params = PaginateParams.new
-      yield paginate_params
-      raise paginate_params.error_msg if paginate_params.invalid? 
-      
-      paginator = Paginator.new(paginate_params, page_params)
-                  
-      design_doc_name = self.name
-      view = SortedByView.new(design_doc_name, *view_keys)
-      query = Query.new(design_doc_name, view.view_name)
-      query.merge(paginate_params)
+                    
+    #
+    # Creates the corresponding view and stores it in CouchDB
+    # Adds by_ and paginate_by_ methods to the class
+    #
+    def self.view_by *atts
+      opts = atts.last.is_a?(Hash) ? atts.pop : {}
+      __view_by_list__ << atts
       
-      docs = view.query(query)
-      docs.reverse! if paginate_params.order_inverted?
+      if RelaxDB.create_views?
+        ViewCreator.by_att_list([self.name], *atts).save
+      end
       
-      paginator.add_next_and_prev(docs, design_doc_name, view.view_name, view_keys)
+      by_name = "by_#{atts.join "_and_"}"
+      meta_class.instance_eval do
+        define_method by_name do |*params|
+          view_name = "#{self.name}_#{by_name}"
+          if params.empty?
+            res = RelaxDB.view view_name, opts
+          elsif params[0].is_a? Hash
+            res = RelaxDB.view view_name, opts.merge(params[0])
+          else
+            res = RelaxDB.view(view_name, :key => params[0]).first
+          end            
+        end
+      end
       
-      docs
+      paginate_by_name = "paginate_by_#{atts.join "_and_"}"
+      meta_class.instance_eval do
+        define_method paginate_by_name do |params|
+          view_name = "#{self.name}_#{by_name}"
+          params[:attributes] = atts
+          params = opts.merge params
+          RelaxDB.paginate_view view_name, params
+        end    
+      end
+    end
+    
+    # Create a view allowing all instances of a particular class to be retreived    
+    def self.create_all_by_class_view
+      if RelaxDB.create_views?        
+        view = ViewCreator.all
+        view.save unless view.exists?
+      end        
+    end          
+    
+    def self.inherited subclass
+      chain = subclass.up_chain
+      while k = chain.pop
+        k.create_views chain
+      end      
+    end
+    
+    def self.up_chain
+      k = self
+      kls = [k]
+      kls << k while ((k = k.superclass) != RelaxDB::Document)
+      kls
+    end
+    
+    def self.create_views chain
+      # Capture the inheritance hierarchy of this class
+      @hierarchy ||= [self]
+      @hierarchy += chain
+      @hierarchy.uniq!
+
+      if RelaxDB.create_views?
+        ViewCreator.all(@hierarchy).save
+        __view_by_list__.each do |atts|
+          ViewCreator.by_att_list(@hierarchy, *atts).save
+        end
+      end
     end
-                
+                                            
   end
   
 end

data/lib/relaxdb/has_many_proxy.rb

@@ -77,11 +77,8 @@ module RelaxDB
     end
   
     def load_children
-      view_path = "_view/#{@client.class}/#{@relationship}?key=\"#{@client._id}\""
-      design_doc = @client.class
-      view_name = @relationship
-      map_function = ViewCreator.has_n(@target_class, @relationship_as_viewed_by_target)
-      @children = RelaxDB.retrieve(view_path, design_doc, view_name, map_function)
+      view_name = "#{@client.class}_#{@relationship}"
+      @children = RelaxDB.view(view_name, :key => @client._id)
     end
     
     def children=(children)
@@ -94,6 +91,10 @@ module RelaxDB
     def inspect
       @children.inspect
     end
+    
+    # Play nice with Merb partials - [ obj ].flatten invokes
+    # obj.to_ary if it responds to to_ary
+    alias_method :to_ary, :to_a
   
   end
 

data/lib/relaxdb/has_one_proxy.rb

@@ -33,11 +33,8 @@ module RelaxDB
     end
   
     def load_target
-      design_doc = @client.class
-      view_name = @relationship
-      view_path = "_view/#{design_doc}/#{view_name}?key=\"#{@client._id}\""
-      map_function = ViewCreator.has_n(@target_class, @relationship_as_viewed_by_target)
-      RelaxDB.retrieve(view_path, design_doc, view_name, map_function).first
+      view_name = "#{@client.class}_#{@relationship}"
+      RelaxDB.view(view_name, :key => @client._id).first
     end
         
   end

data/lib/relaxdb/paginate_params.rb

@@ -17,11 +17,11 @@ module RelaxDB
       end
     end
     
-    def initialize
+    def initialize(params)
+      params.each { |k, v| send(k, v) }
+      
       # If a client hasn't explicitly set descending, set it to the CouchDB default
       @descending = false if @descending.nil?
-      # CouchDB defaults reduce to true when a reduce func is present
-      @reduce = false
     end
   
     def update(params)
@@ -44,7 +44,6 @@ module RelaxDB
     
     def invalid?
       # Simply because allowing either to be omitted increases the complexity of the paginator
-      # This constraint may be removed in future, but don't hold your breath
       @startkey_set && @endkey_set ? nil : "Both startkey and endkey must be set"
     end
     alias error_msg invalid?

data/lib/relaxdb/paginator.rb

@@ -13,21 +13,17 @@ module RelaxDB
       @paginate_params.update(page_params)
     end
 
-    def total_doc_count(design_doc, view_name)
-      result = RelaxDB.view(design_doc, view_name) do |q|
-        q.reduce(true)
-        q.startkey(@orig_paginate_params.startkey).endkey(@orig_paginate_params.endkey).descending(@orig_paginate_params.descending)  
-      end
-      
-      total_docs = RelaxDB.reduce_result(result)
+    def total_doc_count(view_name)
+      RelaxDB.view view_name, :startkey => @orig_paginate_params.startkey, :endkey => @orig_paginate_params.endkey,
+        :descending => @orig_paginate_params.descending, :reduce => true
     end
     
-    def add_next_and_prev(docs, design_doc, view_name, view_keys)
+    def add_next_and_prev(docs, view_name, view_keys)
       unless docs.empty?
         no_docs = docs.size
         offset = docs.offset
-        orig_offset = orig_offset(design_doc, view_name)
-        total_doc_count = total_doc_count(design_doc, view_name)      
+        orig_offset = orig_offset(view_name)
+        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
@@ -62,15 +58,15 @@ module RelaxDB
       prev_params = { :startkey => prev_key, :startkey_docid => prev_key_docid, :descending => !@orig_paginate_params.descending }
     end
     
-    def orig_offset(design_doc, view_name)
-      query = Query.new(design_doc, view_name)
+    def orig_offset(view_name)
       if @paginate_params.order_inverted?
-        query.startkey(@orig_paginate_params.endkey).descending(!@orig_paginate_params.descending)
+        params = {:startkey => @orig_paginate_params.endkey, :descending => !@orig_paginate_params.descending}
       else
-        query.startkey(@orig_paginate_params.startkey).descending(@orig_paginate_params.descending)
+        params = {:startkey => @orig_paginate_params.startkey, :descending => @orig_paginate_params.descending}
       end
-      query.reduce(false).limit(1)
-      RelaxDB.retrieve(query.view_path).offset
+      params[:limit] = 1
+            
+      RelaxDB.view(view_name, params).offset
     end
     
   end

data/lib/relaxdb/query.rb

@@ -3,17 +3,7 @@ module RelaxDB
   # A Query is used to build the query string made against a view
   # All parameter values are first JSON encoded and then URL encoded
   # Nil values are set to the empty string
-  # All parameter calls return self so calls may be chained => q.startkey("foo").endkey("bar").limit(2)
   
-  #
-  # The query object is currently inconsistent with the RelaxDB object idiom. Consider
-  #   paul = User.new(:name => "paul").save; Event.new(:host=>paul).save
-  # but an event query requires
-  #   Event.all.sorted_by(:host_id) { |q| q.key(paul._id) } 
-  # rather than
-  #   Event.all.sorted_by(:host) { |q| q.key(paul) }  
-  # I feel that both forms should be supported
-  #
   class Query
     
     # keys is not included in the standard param as it is significantly different from the others
@@ -32,9 +22,13 @@ module RelaxDB
       end
     end
         
-    def initialize(design_doc, view_name)
-      @design_doc = design_doc
+    def initialize(view_name, params = {})
+      # CouchDB defaults reduce to true when a reduce func is present
+      # but returning the map view is typically more useful
+      reduce(false)
+      
       @view_name = view_name
+      params.each { |k, v| send(k, v) }
     end
     
     def keys(keys=nil)
@@ -46,8 +40,18 @@ module RelaxDB
       end
     end
     
+    # If set to true RelaxDB.view will return unprocessed data
+    def raw(val = nil)
+      if val.nil?
+        @raw
+      else
+        @raw = val
+        self
+      end
+    end
+    
     def view_path
-      uri = "_view/#{@design_doc}/#{@view_name}"
+      uri = "_design/#{RelaxDB.dd}/_view/#{@view_name}"
       
       query = ""
       @@params.each do |param|