paulcarey-relaxdb 0.2.3 → 0.2.4

data/README.textile

@@ -1,5 +1,9 @@
 h3. What's New?
 
+* Semantic consistency for load, load!, save and save!. The bang versions raise an exception when their more relaxed siblings would simply return nil.
+
+* Minimal support for CouchDB validation 
+
 * Time storage changes. All Time objects are now converted to UTC and formatted as %Y/%m/%d %H:%M:%S +0000. Storing all Times as UTC should have been happening anyway. Formatting Times as above (as opposed to ISO 8601 as was done prior to 0.2.3) allows the Time strings to be passed directly to Date.new in a JavaScript interpreter. 
 
 * Pagination! CouchDB offers great support for retrieving a subset of data, but the housekeeping is tricky. RelaxDB takes care of it.

data/Rakefile

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

data/lib/relaxdb.rb

@@ -13,6 +13,8 @@ require 'tempfile'
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
+require 'relaxdb/validators'
+
 require 'relaxdb/all_delegator'
 require 'relaxdb/belongs_to_proxy'
 require 'relaxdb/design_doc'

data/lib/relaxdb/all_delegator.rb

@@ -6,6 +6,7 @@ module RelaxDB
   #   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
   #
   class AllDelegator < Delegator
     
@@ -15,10 +16,10 @@ module RelaxDB
     end
     
     def __getobj__
-      view_path = "_view/#{@class_name}/all"
-      map_function = ViewCreator.all(@class_name)
+      view_path = "_view/#{@class_name}/all?reduce=false"
+      map, reduce = ViewCreator.all(@class_name)
       
-      @all = RelaxDB.retrieve(view_path, @class_name, "all", map_function)      
+      RelaxDB.retrieve(view_path, @class_name, "all", map, reduce)
     end
 
     def sorted_by(*atts)
@@ -42,6 +43,25 @@ module RelaxDB
         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
   

data/lib/relaxdb/design_doc.rb

@@ -15,6 +15,11 @@ module RelaxDB
       add_view(view_name, "reduce", function)
     end
     
+    def add_validation_func(function)
+      @data["validate_doc_update"] = function
+      self
+    end
+    
     def add_view(view_name, type, function)
       @data["views"] ||= {}
       @data["views"][view_name] ||= {}

data/lib/relaxdb/document.rb

@@ -2,6 +2,8 @@ module RelaxDB
     
   class Document
     
+    include RelaxDB::Validators
+    
     # Used to store validation messages
     attr_accessor :errors
     
@@ -29,11 +31,7 @@ module RelaxDB
         end
       end
       
-      if opts[:validator]
-        define_method("validate_#{prop}") do |prop_val|
-          opts[:validator].call(prop_val)
-        end
-      end
+      create_validator(prop, opts[:validator]) if opts[:validator]
       
       if opts[:validation_msg]
         define_method("#{prop}_validation_msg") do
@@ -47,6 +45,18 @@ module RelaxDB
       # Ensure that classes that don't define their own properties still function as CouchDB objects
       @properties ||= [:_id, :_rev]
     end
+    
+    def self.create_validator(att, v)
+      define_method("validate_#{att}") do |att_val|
+        if v.is_a? Proc
+          v.call(att_val)
+        elsif respond_to? "validator_#{v}"
+          send("validator_#{v}", att_val)
+        else
+          send(v, att_val)
+        end          
+      end
+    end
 
     def properties
       self.class.properties
@@ -100,7 +110,7 @@ module RelaxDB
         prop_val = instance_variable_get("@#{prop}".to_sym)
         s << ", #{prop}: #{prop_val.inspect}" if prop_val
       end
-      self.class.belongs_to_rels.each do |relationship|
+      self.class.belongs_to_rels.each do |relationship, opts|
         id = instance_variable_get("@#{relationship}_id".to_sym)
         s << ", #{relationship}_id: #{id}" if id
       end
@@ -142,7 +152,7 @@ module RelaxDB
       return false unless validates?
       return false unless before_save
             
-      set_created_at if unsaved? 
+      set_created_at if new_document? 
       
       resp = RelaxDB.db.put("#{_id}", to_json)
       self._rev = JSON.parse(resp.body)["rev"]
@@ -152,6 +162,10 @@ module RelaxDB
       self
     end  
     
+    def save!
+      save || raise(DocumentNotSaved)
+    end
+    
     def validates?
       total_success = true
       properties.each do |prop|
@@ -166,20 +180,24 @@ module RelaxDB
           total_success &= success          
         end
       end
-      total_success &= validate
+      
+      # Unsure whether to pass the id or the doc itself - id is all I need right now 
+      self.class.belongs_to_rels.each do |rel, opts|
+        if methods.include? "validate_#{rel}"
+          rel_val = instance_variable_get("@#{rel}_id")
+          success = send("validate_#{rel}", rel_val) rescue false
+          total_success &= success
+        end
+      end
+      
       total_success
     end
-    
-    def validate
-      true
-    end
-        
-    # Hmm. Rename... never_saved? newnew?
-    def unsaved?
+            
+    def new_document?
       @_rev.nil?
     end
-    alias_method :new_record?, :unsaved?
-    alias_method :new_document?, :unsaved?
+    alias_method :new_record?, :new_document?
+    alias_method :unsaved?, :new_document?
     
     def to_param
       self._id
@@ -198,8 +216,8 @@ module RelaxDB
       proxy = instance_variable_get(proxy_sym)
       unless proxy
         proxy = opts ? klass.new(self, relationship, opts) : klass.new(self, relationship)
+        instance_variable_set(proxy_sym, proxy)
       end
-      instance_variable_set(proxy_sym, proxy)
       proxy     
     end
     
@@ -208,8 +226,8 @@ module RelaxDB
       other && _id == other._id
     end
    
-    # Deprecated. This method was experimental and will be removed
-    # once multi key GETs are available in CouchDB.
+    # If you're using this method, read the specs and make sure you understand
+    # how it can be used and how it shouldn't be used
     def self.references_many(relationship, opts={})
       # Treat the representation as a standard property 
       properties << relationship
@@ -293,6 +311,7 @@ module RelaxDB
         instance_variable_get("@#{relationship}_id")
       end
       
+      create_validator(relationship, opts[:validator]) if opts[:validator]
     end
     
     def self.belongs_to_rels

data/lib/relaxdb/paginator.rb

@@ -15,7 +15,7 @@ module RelaxDB
 
     def total_doc_count(design_doc, view_name)
       result = RelaxDB.view(design_doc, view_name) do |q|
-        q.group(true).group_level(0).reduce(true)
+        q.reduce(true)
         q.startkey(@orig_paginate_params.startkey).endkey(@orig_paginate_params.endkey).descending(@orig_paginate_params.descending)  
       end
       

data/lib/relaxdb/query.rb

@@ -42,6 +42,7 @@ module RelaxDB
         @keys
       else 
         @keys = { :keys => keys }.to_json
+        self
       end
     end
     

data/lib/relaxdb/references_many_proxy.rb

@@ -78,12 +78,14 @@ module RelaxDB
     def inspect
       @client.instance_variable_get("@#{@relationship}".to_sym).inspect
     end
-  
-    private
-  
+      
     def peer_ids
       @client.instance_variable_get("@#{@relationship}".to_sym)
     end
+  
+    alias to_id_a peer_ids
+  
+    private
     
     # Resolves the actual ids into real objects via a single GET to CouchDB. Called internally by each
     def resolve

data/lib/relaxdb/relaxdb.rb

@@ -1,4 +1,7 @@
 module RelaxDB
+
+  class NotFound < StandardError; end
+  class DocumentNotSaved < StandardError; end
   
   @@db = nil
   
@@ -49,22 +52,37 @@ module RelaxDB
   
     def load(*ids)
       if ids.size == 1
-        resp = db.get(ids[0])
-        data = JSON.parse(resp.body)
-        create_object(data)
+        begin
+          resp = db.get(ids[0])
+          data = JSON.parse(resp.body)
+          create_object(data)
+        rescue HTTP_404
+          nil
+        end
       else
         resp = db.post("_all_docs?include_docs=true", {:keys => ids}.to_json)
         data = JSON.parse(resp.body)
-        data["rows"].map { |row| create_object(row["doc"]) }
+        data["rows"].map { |row| row["doc"] ? create_object(row["doc"]) : nil }
       end
     end
     
+    def load!(*ids)
+      res = load(*ids)
+      
+      raise NotFound if res == nil
+      raise NotFound if res.respond_to?(:include?) && res.include?(nil)
+      
+      res
+    end
+    
     # Used internally by RelaxDB
-    def retrieve(view_path, design_doc=nil, view_name=nil, map_function=nil)
+    def retrieve(view_path, design_doc=nil, view_name=nil, map_func=nil, reduce_func=nil)
       begin
         resp = db.get(view_path)
       rescue => e
-        DesignDocument.get(design_doc).add_map_view(view_name, map_function).save
+        dd = DesignDocument.get(design_doc).add_map_view(view_name, map_func)
+        dd.add_reduce_view(view_name, reduce_func) if reduce_func
+        dd.save
         resp = db.get(view_path)
       end
       

data/lib/relaxdb/server.rb

@@ -1,4 +1,7 @@
 module RelaxDB
+  
+  class HTTP_404 < StandardError; end
+  class HTTP_409 < StandardError; end
 
   class Server
         
@@ -46,7 +49,14 @@ module RelaxDB
     private
 
     def handle_error(req, res)
-      e = RuntimeError.new("#{res.code}:#{res.message}\nMETHOD:#{req.method}\nURI:#{req.path}\n#{res.body}")
+      msg = "#{res.code}:#{res.message}\nMETHOD:#{req.method}\nURI:#{req.path}\n#{res.body}"
+      begin
+        klass = RelaxDB.const_get("HTTP_#{res.code}")
+        e = klass.new(msg)
+      rescue
+        e = RuntimeError.new(msg)
+      end
+
       raise e
     end
   end

data/lib/relaxdb/sorted_by_view.rb

@@ -25,7 +25,11 @@ module RelaxDB
     def reduce_function
       <<-QUERY
       function(keys, values, rereduce) {
-        return values.length;
+        if (rereduce) {
+          return sum(values);
+        } else {
+          return values.length;
+        }
       }
       QUERY
     end
@@ -42,8 +46,7 @@ module RelaxDB
       # to false if it hasn't already been set.
       query.reduce(false) if query.reduce.nil?
       
-      # I hope the query.group(true) should be temporary only (given that reduce has been set to false)
-      method = query.keys ? (query.group(true) && :post) : :get
+      method = query.keys ? :post : :get
       
       begin
         resp = RelaxDB.db.send(method, query.view_path, query.keys)

data/lib/relaxdb/views.rb

@@ -3,13 +3,25 @@ module RelaxDB
   class ViewCreator
     
     def self.all(target_class)
-      template = <<-QUERY
+      map = <<-QUERY
       function(doc) {
         if(doc.class == "${target_class}")
           emit(null, doc);
       }
       QUERY
-      template.sub!("${target_class}", target_class.to_s)
+      map.sub!("${target_class}", target_class.to_s)
+      
+      reduce = <<-QUERY
+      function(keys, values, rereduce) {
+        if (rereduce) {
+          return sum(values);
+        } else {
+          return values.length;
+        }
+      }
+      QUERY
+      
+      [map, reduce]  
     end
   
     def self.has_n(target_class, relationship_to_client)

data/spec/belongs_to_spec.rb

@@ -74,6 +74,13 @@ describe RelaxDB::BelongsToProxy do
       r = RelaxDB.load r._id
       r.photo.rating.should == r
     end    
+    
+    it "should function with the required validator" do
+      c = Class.new(RelaxDB::Document) do
+        belongs_to :foo, :validator => :required
+      end
+      c.new.save.should be_false
+    end
 
   end
 

data/spec/design_doc_spec.rb

@@ -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!
-      lambda { RelaxDB.load("_design%2Ffoo") }.should raise_error
+      RelaxDB.load("_design%2Ffoo").should be_nil
     end
     
   end

data/spec/document_spec.rb

@@ -37,6 +37,17 @@ describe RelaxDB::Document do
     end  
     
   end
+  
+  describe "#initialize" do
+    
+    it "may be overridden by inheriting classes" do
+      i = Initiative.new(:x => "y").save
+      i = RelaxDB.load(i._id)
+      i.x.should == "y"
+      i.foo.should == :bar
+    end
+    
+  end
       
   describe "#to_json" do
     
@@ -84,6 +95,24 @@ describe RelaxDB::Document do
         
   end
   
+  describe "#save!" do
+    
+    it "should save objects" do
+      a = Atom.new.save
+      RelaxDB.load(a._id).should == a
+    end
+    
+    it "should throw an exception when an object is not saved" do
+      r = Class.new(RelaxDB::Document) do
+        property :thumbs_up, :validator => lambda { false }
+      end
+      lambda do
+        r.new.save!
+      end.should raise_error(RelaxDB::DocumentNotSaved)
+    end   
+    
+  end
+  
   describe "user defined property reader" do
     
     it "should not effect normal operation" do
@@ -119,7 +148,8 @@ describe RelaxDB::Document do
       p.str.should == "foo"
       p.num.should == 19.30
       p.true_bool.should be_true
-      p.false_bool.should_not be_true
+      # p.false_bool.should be_false
+      p.false_bool.should_not be
       p.created_at.should be_close(now, 1)
       p.empty.should be_nil
     end
@@ -136,7 +166,7 @@ describe RelaxDB::Document do
     
     it "should delete the corresponding document from CouchDB" do
       p = Atom.new.save.destroy!
-      lambda { RelaxDB.load(p._id) }.should raise_error
+      RelaxDB.load(p._id).should be_nil
     end
 
     it "should prevent the object from being resaved" do
@@ -195,6 +225,21 @@ describe RelaxDB::Document do
     
   end
   
+  describe ".all.size" do
+    
+    it "should return the total number of docs" do
+      docs = []
+      100.times { docs << Atom.new }
+      RelaxDB.bulk_save(*docs)
+      Atom.all.size.should == 100
+    end
+    
+    it "should return 0 when no docs exist" do
+      Atom.all.size.should == 0
+    end
+    
+  end
+  
   describe ".all.sorted_by" do
   
     it "should sort ascending by default" do
@@ -222,6 +267,17 @@ describe RelaxDB::Document do
       posts[1].content.should == "late"
     end
     
+    it "should return the count when queried with reduce=true" do
+      docs = []
+      100.times { |i| docs << Primitives.new(:num => i) }
+      RelaxDB.bulk_save(*docs)
+      # Create the view
+      Primitives.all.sorted_by(:num)
+      res = RelaxDB.view("Primitives", "all_sorted_by_num") { |q| q.reduce(true) }
+      count = RelaxDB.reduce_result(res)
+      count.should == 100
+    end
+    
     describe "results" do
 
       it "should be retrievable by exact criteria" do
@@ -307,7 +363,7 @@ describe RelaxDB::Document do
         
     it "should prevent an object from being saved if it throws an exception" do
       r = Class.new(RelaxDB::Document) do
-        property :thumbs_up, :validator => lambda { raise "foo" }
+        property :thumbs_up, :validator => lambda { raise }
       end
       r.new.save.should be_false
     end
@@ -331,8 +387,8 @@ describe RelaxDB::Document do
     
     it "should perform all validations" do
       r = Class.new(RelaxDB::Document) do
-        property :foo, :validator => lambda { false }, :validation_msg => "oof"
-        property :bar, :validator => lambda { false }, :validation_msg => "rab"
+        property :foo, :validator => lambda { raise }, :validation_msg => "oof"
+        property :bar, :validator => lambda { raise }, :validation_msg => "rab"
       end
       x = r.new
       x.save
@@ -359,13 +415,32 @@ describe RelaxDB::Document do
     it "may be a method" do
       r = Class.new(RelaxDB::Document) do
         property :thumbs_up, :validator => :count_em
-        def count_em
-          false
+        def count_em(tu)
+          tu >=0 && tu < 3
         end
       end
-      r.new.save.should be_false
+      r.new(:thumbs_up => 1).save.should be
     end
     
   end
   
+  describe "predefined validator" do
+    
+    it "should be invoked when a symbol clash exists" do
+      c = Class.new(RelaxDB::Document) do
+        property :foo, :validator => :required
+        def required; raise; end;
+      end
+      c.new(:foo => :bar).save.should be
+    end
+    
+    it "should prevent an object from being saved if validation fails" do
+      c = Class.new(RelaxDB::Document) do
+        property :foo, :validator => :required
+      end
+      c.new.save.should be_false
+    end    
+    
+  end
+  
 end

data/spec/references_many_spec.rb

@@ -13,10 +13,7 @@ describe RelaxDB::ReferencesManyProxy do
   end
 
   describe "references_many" do
-    
-    it "is now deprecated and will be removed in the near future" do
-    end
-    
+        
     it "should preserve the relationships across the save / load boundary" do
       p = Photo.new
       t = Tag.new

data/spec/relaxdb_spec.rb

@@ -73,6 +73,46 @@ describe RelaxDB do
       ar2.should == a2
     end
     
+    it "should return nil when given a id for a non existant doc" do
+      RelaxDB.load("nothere").should be_nil
+    end
+    
+    it "should return an array with correctly placed nils when given a list containing non existant doc ids" do
+      a1, a2 = Atom.new.save, Atom.new.save
+      res = RelaxDB.load nil, a1._id, nil, a2._id, nil
+      res.should == [nil, a1, nil, a2, nil]
+    end
+    
+  end
+  
+  describe ".load!" do
+    
+    it "should load a single document" do
+      a = Atom.new.save
+      ar = RelaxDB.load! a._id
+      ar.should == a      
+    end
+    
+    it "should load multiple documents" do
+      a1, a2 = Atom.new.save, Atom.new.save
+      ar1, ar2 = RelaxDB.load! a1._id, a2._id
+      ar1.should == a1
+      ar2.should == a2
+    end
+    
+    it "should throw an exception if given a single id for a non-existant doc" do
+      lambda do
+        RelaxDB.load! "nothere"
+      end.should raise_error(RelaxDB::NotFound)
+    end
+    
+    it "should throw an exception if any of a list of doc ids is for a non-existant doc" do
+      a = Atom.new.save
+      lambda do
+        RelaxDB.load! nil, a._id
+      end.should raise_error(RelaxDB::NotFound)
+    end
+    
   end
   
   describe ".view" do

data/spec/spec_models.rb

@@ -1,6 +1,15 @@
 class Atom < RelaxDB::Document
 end
 
+class Initiative < RelaxDB::Document
+  property :x
+  attr_reader :foo
+  def initialize(hash={})
+    super
+    @foo = :bar
+  end
+end
+
 class Primitives < RelaxDB::Document
   
   property :str

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: paulcarey-relaxdb
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors: 
 - Paul Carey
@@ -9,7 +9,7 @@ autorequire: relaxdb
 bindir: bin
 cert_chain: []
 
-date: 2008-08-25 00:00:00 -07:00
+date: 2008-12-26 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -68,6 +68,7 @@ files:
 - lib/relaxdb/server.rb
 - lib/relaxdb/sorted_by_view.rb
 - lib/relaxdb/uuid_generator.rb
+- lib/relaxdb/validators
 - lib/relaxdb/view_object.rb
 - lib/relaxdb/view_result.rb
 - lib/relaxdb/view_uploader.rb