paulcarey-relaxdb 0.2.7 → 0.2.8

data/README.textile

@@ -1,5 +1,7 @@
 h3. What's New?
 
+* 02/02/09 - mostly fixes and tweaks for CouchDB trunk (tested against revision 0.9.0a740000). This includes a couple of breaking API changes - count became limit, 409 rather than 412 is returned on document update conflict, and '/' in design docs is treated differently.
+
 * Potentially breaking change. Skipping validations is now done by adding attribute symbols to an object's list rather than passing them to @save@. For example @my_obj.validation_skip_list << :foo@. This offers per object granularity over validations when working with bulk_save.
 
 * Potentially breaking change. @load@ now returns an array if passed an array of size one. Previously it would have returned a single object.
@@ -96,7 +98,7 @@ h3. Exploring models
   paul.ratings.size                                           # 0
 
   # Simple views are auto created
-  Rating.all.sorted_by(:thumbs_up) { |q| q.key(2).count(1) }  # query params map directly to CouchDB
+  Rating.all.sorted_by(:thumbs_up) { |q| q.key(2).limit(1) }  # query params map directly to CouchDB
 </code>
 </pre>
 
@@ -110,7 +112,7 @@ h3. Paginating models
     u_id = @user._id
 
     @posts = Post.paginate_by(page_params, :writer_id, :created_at) do |p|
-      p.startkey([u_id, {}]).endkey([u_id]).descending(true).count(5)
+      p.startkey([u_id, {}]).endkey([u_id]).descending(true).limit(5)
     end
     render
   end
@@ -132,7 +134,7 @@ h3. Paginating over your own views
 <code>
 
 RelaxDB.paginate_view(page_params, "Letter", "by_letter_and_number", :letter, :number) do |p|
-  p.startkey(["b"]).endkey(["b", {}]).count(2)
+  p.startkey(["b"]).endkey(["b", {}]).limit(2)
 end
 
 </code>

data/Rakefile

@@ -4,7 +4,7 @@ require 'spec/rake/spectask'
 
 PLUGIN = "relaxdb"
 NAME = "relaxdb"
-GEM_VERSION = "0.2.7"
+GEM_VERSION = "0.2.8"
 AUTHOR = "Paul Carey"
 EMAIL = "paul.p.carey@gmail.com"
 HOMEPAGE = "http://github.com/paulcarey/relaxdb/"

data/lib/relaxdb/design_doc.rb

@@ -29,7 +29,7 @@ module RelaxDB
   
     def save
       database = RelaxDB.db    
-      resp = database.put(::CGI::escape(@data["_id"]), @data.to_json)
+      resp = database.put(@data["_id"], @data.to_json)
       @data["_rev"] = JSON.parse(resp.body)["rev"]
       self
     end
@@ -37,16 +37,16 @@ module RelaxDB
     def self.get(client_class)
       begin
         database = RelaxDB.db
-        resp = database.get(::CGI::escape("_design/#{client_class}"))
+        resp = database.get("_design/#{client_class}")
         DesignDocument.new(client_class, JSON.parse(resp.body))
-      rescue => e
+      rescue HTTP_404
         DesignDocument.new(client_class, {"_id" => "_design/#{client_class}"} )
       end
     end  
     
     def destroy!
       # Implicitly prevent the object from being resaved by failing to update its revision
-      RelaxDB.db.delete("#{::CGI::escape(@data["_id"])}?rev=#{@data["_rev"]}")
+      RelaxDB.db.delete("#{@data["_id"]}?rev=#{@data["_rev"]}")
       self      
     end
   

data/lib/relaxdb/document.rb

@@ -116,16 +116,15 @@ module RelaxDB
     property :_id 
     property :_rev    
     
-    def initialize(set_via_writers={}, hash=nil)
-      hash, set_via_writers = set_via_writers, true if set_via_writers.is_a?(Hash)
-      
-      # The default _id will be overwritten if loaded from CouchDB
-      self._id = UuidGenerator.uuid 
+    def initialize(hash={})
+      unless hash["_id"]
+        self._id = UuidGenerator.uuid 
+      end
       
       @errors = Errors.new
       @validation_skip_list = []
 
-      # Set default properties if this object has not known CouchDB
+      # Set default properties if this object isn't being loaded from CouchDB
       unless hash["_rev"]
         properties.each do |prop|
          if methods.include?("set_default_#{prop}")
@@ -133,10 +132,10 @@ module RelaxDB
          end
         end
       end
-      
-      # Maybe use the presence of _rev in hash to determine this rather than 
-      # exposing the implementation detail to clients that choose to override?
-      set_via_writers ? set_attributes(hash) : set_raw_attributes(hash)
+            
+      @set_derived_props = hash["_rev"] ? false : true
+      set_attributes(hash)
+      @set_derived_props = true
     end
     
     def set_attributes(data)
@@ -154,37 +153,7 @@ module RelaxDB
         send("#{key}=".to_sym, val) if methods.include? "#{key}="
       end
     end  
-    
-    # Set the raw attribute values rather than setting via the associated writers
-    # The associated writers may invoke validation functions or set derived values
-    # Such behaviour is unwanted when loading from CouchDB and potentially under
-    # other circumstances
-    def set_raw_attributes(data)
-      data.each do |key, val|
-        if [/_at$/, /_on$/, /_date$/].inject(nil) { |i, r| i ||= (key =~ r) }
-            val = Time.parse(val).utc rescue val
-        end
-        
-        if methods.include? "#{key}="
-          key = key.to_sym
-          if properties.include? key
-            instance_variable_set("@#{key}".to_sym, val)
-          elsif self.class.has_one_rels.include? key
-            create_or_get_proxy(HasOneProxy, key).target = val
-          else 
-            # belongs_to
-            if key.to_s =~ /_id$/                                            
-              instance_variable_set("@#{key}".to_sym, val)                   
-            else                                                             
-              create_or_get_proxy(BelongsToProxy, key).target = val          
-            end                                                              
-          end                                                                
-        end
-                
-      end
-      
-    end
-        
+            
     def inspect
       s = "#<#{self.class}:#{self.object_id}"
       properties.each do |prop|
@@ -229,7 +198,7 @@ module RelaxDB
       begin
         resp = RelaxDB.db.put(_id, to_json)
         self._rev = JSON.parse(resp.body)["rev"]
-      rescue HTTP_412
+      rescue HTTP_409
         on_update_conflict
         @update_conflict = true
         return false
@@ -367,16 +336,21 @@ module RelaxDB
       @references_many_rels ||= []
       @references_many_rels << relationship
      
+      id_arr_sym = "@#{relationship}".to_sym
+     
       define_method(relationship) do
-        array_sym = "@#{relationship}".to_sym
-        instance_variable_set(array_sym, []) unless instance_variable_defined? array_sym
-
-        create_or_get_proxy(RelaxDB::ReferencesManyProxy, relationship, opts)
+        instance_variable_set(id_arr_sym, []) unless instance_variable_defined? id_arr_sym
+        create_or_get_proxy(ReferencesManyProxy, relationship, opts)
+      end
+      
+      define_method("#{relationship}_ids") do
+        instance_variable_set(id_arr_sym, []) unless instance_variable_defined? id_arr_sym
+        instance_variable_get(id_arr_sym)
       end
     
       define_method("#{relationship}=") do |val|
-        # Sharp edge - do not invoke this method
-        instance_variable_set("@#{relationship}".to_sym, val)
+        # Don't invoke this method unless you know what you're doing
+        instance_variable_set(id_arr_sym, val)
       end           
     end
    
@@ -394,7 +368,7 @@ module RelaxDB
       
       define_method("#{relationship}=") do |children|
         create_or_get_proxy(HasManyProxy, relationship, opts).children = children
-        write_derived_props(relationship)
+        write_derived_props(relationship) if @set_derived_props
         children
       end      
     end
@@ -414,7 +388,7 @@ module RelaxDB
       
       define_method("#{relationship}=") do |new_target|
         create_or_get_proxy(HasOneProxy, relationship).target = new_target
-        write_derived_props(relationship)
+        write_derived_props(relationship) if @set_derived_props
         new_target
       end
     end
@@ -433,13 +407,13 @@ module RelaxDB
       
       define_method("#{relationship}=") do |new_target|
         create_or_get_proxy(BelongsToProxy, relationship).target = new_target
-        write_derived_props(relationship)
+        write_derived_props(relationship) if @set_derived_props
       end
       
       # Allows all writers to be invoked from the hash passed to initialize 
       define_method("#{relationship}_id=") do |id|
         instance_variable_set("@#{relationship}_id".to_sym, id)
-        write_derived_props(relationship)
+        write_derived_props(relationship) if @set_derived_props
         id
       end
 

data/lib/relaxdb/paginate_params.rb

@@ -2,7 +2,7 @@ module RelaxDB
 
   class PaginateParams
         
-    @@params = %w(key startkey startkey_docid endkey endkey_docid count update descending group reduce include_docs)
+    @@params = %w(key startkey startkey_docid endkey endkey_docid limit update descending group reduce include_docs)
   
     @@params.each do |param|
       define_method(param.to_sym) do |*val|

data/lib/relaxdb/paginator.rb

@@ -69,7 +69,7 @@ module RelaxDB
       else
         query.startkey(@orig_paginate_params.startkey).descending(@orig_paginate_params.descending)
       end
-      query.reduce(false).count(1)
+      query.reduce(false).limit(1)
       RelaxDB.retrieve(query.view_path).offset
     end
     

data/lib/relaxdb/query.rb

@@ -3,7 +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").count(2)
+  # 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
@@ -17,7 +17,7 @@ module RelaxDB
   class Query
     
     # keys is not included in the standard param as it is significantly different from the others
-    @@params = %w(key startkey startkey_docid endkey endkey_docid count update descending skip group group_level reduce include_docs)
+    @@params = %w(key startkey startkey_docid endkey endkey_docid limit update descending skip group group_level reduce include_docs)
     
     @@params.each do |param|
       define_method(param.to_sym) do |*val|

data/lib/relaxdb/references_many_proxy.rb

@@ -10,6 +10,8 @@ module RelaxDB
     
       @target_class = opts[:class]
       @relationship_as_viewed_by_target = opts[:known_as].to_s
+      
+      @peers = resolve
     end
   
     def <<(obj, reciprocal_invocation=false)
@@ -30,7 +32,6 @@ module RelaxDB
     end
   
     def clear
-      resolve
       @peers.each do |peer|
         peer.send(@relationship_as_viewed_by_target).send(:delete_from_self, @client)
       end
@@ -53,7 +54,7 @@ module RelaxDB
     end
   
     def delete_from_self(obj)
-      @peers.delete(obj) if @peers
+      @peers.delete(obj)
       peer_ids.delete(obj._id)
     end
         
@@ -66,12 +67,10 @@ module RelaxDB
     end
   
     def [](*args)
-      resolve
       @peers[*args]
     end
   
     def each(&blk)
-      resolve
       @peers.each(&blk)    
     end
       
@@ -87,7 +86,7 @@ module RelaxDB
   
     private
     
-    # Resolves the actual ids into real objects via a single GET to CouchDB. Called internally by each
+    # Resolves the actual ids into real objects via a single GET to CouchDB
     def resolve
       design_doc = @client.class
       view_name = @relationship

data/lib/relaxdb/relaxdb.rb

@@ -58,7 +58,7 @@ module RelaxDB
           obj._rev = new_rev["rev"]
           obj.post_save
         end
-      rescue HTTP_412
+      rescue HTTP_409
         raise UpdateConflict, objs
       end
     
@@ -74,6 +74,8 @@ module RelaxDB
     end
   
     def load(ids)
+      # RelaxDB.logger.debug(caller.inject("#{db.name}/#{ids}\n") { |a, i| a += "#{i}\n" })
+      
       if ids.is_a? Array
         resp = db.post("_all_docs?include_docs=true", {:keys => ids}.to_json)
         data = JSON.parse(resp.body)
@@ -174,7 +176,7 @@ module RelaxDB
       klass = data.delete("class")
       if klass
         k = Module.const_get(klass)
-        k.new(false, data)
+        k.new(data)
       else 
         # data is not of a known class
         ViewObject.create(data)

data/lib/relaxdb/validators.rb

@@ -0,0 +1,11 @@
+module RelaxDB
+  
+  module Validators
+   
+    def validator_required(att, o)
+      !att.blank?
+    end
+    
+  end
+  
+end

data/lib/relaxdb/views.rb

@@ -27,12 +27,12 @@ module RelaxDB
     def self.has_n(target_class, relationship_to_client)
       template = <<-MAP_FUNC
       function(doc) {
-        if(doc.class == "${target_class}")
+        if(doc.class == "${target_class}" && doc.${relationship_to_client}_id)
           emit(doc.${relationship_to_client}_id, doc);
       }
       MAP_FUNC
       template.sub!("${target_class}", target_class)
-      template.sub("${relationship_to_client}", relationship_to_client)
+      template.gsub("${relationship_to_client}", relationship_to_client)
     end
   
     def self.has_many_through(target_class, peers)

data/spec/belongs_to_spec.rb

@@ -75,6 +75,27 @@ describe RelaxDB::BelongsToProxy do
       r.photo.rating.should == r
     end    
     
+    it "may be used reciprocally" do
+      C1 = Class.new(RelaxDB::Document) do
+        belongs_to :c2
+      end
+      C2 = Class.new(RelaxDB::Document) do
+        belongs_to :c1
+      end
+      i1, i2 = C1.new, C2.new
+
+      i1.c2 = i2
+      i1.save!
+      i2.c1 = i1
+      i2.save!
+      
+      i1 = RelaxDB.load i1._id
+      i1.c2.should == i2
+      
+      i2 = RelaxDB.load i2._id
+      i2.c1.should == i1
+    end
+    
     describe "validator" do
       
       it "should be passed the _id and object" do

data/spec/derived_properties_spec.rb

@@ -80,6 +80,18 @@ describe RelaxDB::Document, "derived properties" do
     i.event_name.should == "bar"
   end
   
+  it "should contintue to be derived post load" do
+    e = DpEvent.new(:name => "shindig").save!
+    i = DpInvite.new(:event => e).save!
+    
+    i = RelaxDB.load i._id
+    i.event_name.should == "shindig"
+    
+    e = DpEvent.new(:name => "gidnihs").save!
+    i.event = e
+    i.event_name.should == "gidnihs"
+  end    
+  
   describe "multiple properties" do
 
     it "should be derivable from the same source" do

data/spec/design_doc_spec.rb

@@ -16,7 +16,7 @@ describe RelaxDB::DesignDocument do
     
     it "should create a corresponding document in CouchDB" do
       RelaxDB::DesignDocument.get("foo").save      
-      RelaxDB.load("_design%2Ffoo").should_not be_nil
+      RelaxDB.load("_design/foo").should_not be_nil
     end
     
   end
@@ -26,7 +26,7 @@ describe RelaxDB::DesignDocument do
     it "should delete the corresponding document from CouchDB" do
       dd = RelaxDB::DesignDocument.get("foo").save
       dd.destroy!
-      RelaxDB.load("_design%2Ffoo").should be_nil
+      RelaxDB.load("_design/foo").should be_nil
     end
     
   end

data/spec/document_spec.rb

@@ -46,13 +46,13 @@ describe RelaxDB::Document do
     
     it "may be overridden by inheriting classes" do
       i = Initiative.new(:x => "y").save
-      i = RelaxDB.load(i._id)
+      i = RelaxDB.load("y")
       i.x.should == "y"
       i.foo.should == :bar
     end
     
   end
-      
+        
   describe "#to_json" do
     
     it "should not output nil attributes" do
@@ -139,7 +139,8 @@ describe RelaxDB::Document do
       User.new(:items => [], :invites_received => [], :invites_sent => [])
     end
     
-    it "should issue only a single PUT request" do
+    # it should issue a single POST
+    it "should issue no PUT requests" do
       RelaxDB.db.put_count = 0
       RelaxDB.db.get_count = 0
       
@@ -185,10 +186,10 @@ describe RelaxDB::Document do
 
   describe "user defined property writer" do
     
-    it "may be used with caution" do
+    it "should not be used" do
       o = BespokeWriter.new(:val => 101).save
       o = RelaxDB.load o._id
-      o.val.should == 91
+      o.val.should == 81
     end
         
   end
@@ -333,6 +334,10 @@ describe RelaxDB::Document do
     end
     
     describe "results" do
+      
+      it "should be an empty array when no docs match" do
+        Post.all.sorted_by(:subject).should == []
+      end
 
       it "should be retrievable by exact criteria" do
         Post.new(:subject => "foo").save

data/spec/query_spec.rb

@@ -29,10 +29,10 @@ describe RelaxDB::Query do
       q.view_path.should == "_view//?key=%22olympus%22"
     end
     
-    it "should honour startkey, endkey and count" do
+    it "should honour startkey, endkey and limit" do
       q = RelaxDB::Query.new("", "")
-      q.startkey(["olympus"]).endkey(["vesuvius", 3600]).count(100)
-      q.view_path.should == "_view//?startkey=%5B%22olympus%22%5D&endkey=%5B%22vesuvius%22%2C3600%5D&count=100"
+      q.startkey(["olympus"]).endkey(["vesuvius", 3600]).limit(100)
+      q.view_path.should == "_view//?startkey=%5B%22olympus%22%5D&endkey=%5B%22vesuvius%22%2C3600%5D&limit=100"
     end
         
     it "should specify a null key if key was set to nil" do

data/spec/references_many_spec.rb

@@ -27,7 +27,37 @@ describe RelaxDB::ReferencesManyProxy do
       t.photos.size.should == 1
       t.photos[0].should == p
     end
-  
+    
+    it "should issue only a single request to resolve the relationship" do
+      p, t = Photo.new, Tag.new
+      p.tags << t
+      
+      # Create the views
+      p.tags.map { |t| t._id }
+      
+      p = RelaxDB.load p._id      
+      RelaxDB.db.get_count = 0
+      p.tags.map { |t| t._id }
+      p.tags.map { |t| t._id }
+      RelaxDB.db.get_count.should == 1
+    end
+    
+    it "should not resolve the relationship when an object is instantiated" do
+      p, t = Photo.new, Tag.new
+      p.tags << t
+
+      RelaxDB.db.get_count = 0
+      p = RelaxDB.load p._id      
+      RelaxDB.db.get_count.should == 1
+    end
+    
+    it "should make the ids available as a property" do
+      p, t = Photo.new, Tag.new
+      p.tags << t
+      
+      p.tags_ids.should == [t._id]
+    end
+      
     describe "#=" do
       it "should not be invoked" do
       end
@@ -62,6 +92,17 @@ describe RelaxDB::ReferencesManyProxy do
         p.tags.size.should == 1
         t.photos.size.should == 1
       end
+      
+      it "will resolve the reciprocal relationship" do
+        # Create the views
+        p, t = Photo.new, Tag.new
+        p.tags << t
+        
+        p, t = Photo.new, Tag.new
+        RelaxDB.db.get_count = 0
+        p.tags << t
+        RelaxDB.db.get_count.should == 2
+      end      
 
     end
 
@@ -81,14 +122,13 @@ describe RelaxDB::ReferencesManyProxy do
     
     describe "owner#destroy" do
       
-      it "will not remove its membership from its peers in memory" do
-        # Documentating behaviour, not stating that this behaviour is desired
+      it "should remove its membership from its peers in memory" do
         p = Photo.new
         t = Tag.new
         p.tags << t
 
         p.destroy!
-        t.photos.size.should == 1
+        t.photos.size.should == 0
       end
 
       it "should remove its membership from its peers in CouchDB" do
@@ -103,7 +143,7 @@ describe RelaxDB::ReferencesManyProxy do
     end  
     
     # Leaving this test as a reminder of problems with all.destroy and a self referential 
-    # references_many until references_many is removed
+    # references_many
     #
     # This test more complex than it needs to be to prove the point
     # It also serves as a proof of a self referential references_many, but there are better places for that

data/spec/spec_models.rb

@@ -11,8 +11,9 @@ unless @spec_models_loaded
   class Initiative < RelaxDB::Document
     property :x
     attr_reader :foo
-    def initialize(*data)
-      super *data
+    def initialize(data)
+      data[:_id] = data[:x]
+      super data
       @foo = :bar
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: paulcarey-relaxdb
 version: !ruby/object:Gem::Version 
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors: 
 - Paul Carey
@@ -9,7 +9,7 @@ autorequire: relaxdb
 bindir: bin
 cert_chain: []
 
-date: 2009-01-18 00:00:00 -08:00
+date: 2009-02-02 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -68,7 +68,7 @@ files:
 - lib/relaxdb/server.rb
 - lib/relaxdb/sorted_by_view.rb
 - lib/relaxdb/uuid_generator.rb
-- lib/relaxdb/validators
+- lib/relaxdb/validators.rb
 - lib/relaxdb/view_object.rb
 - lib/relaxdb/view_result.rb
 - lib/relaxdb/view_uploader.rb