paulcarey-relaxdb 0.2.1 → 0.2.2

data/README.textile

@@ -2,6 +2,8 @@ h3. What's New?
 
 * Pagination! CouchDB offers great support for retrieving a subset of data, but the housekeeping is tricky. RelaxDB takes care of it.
 ** Note that if you invoke paginate_by on an already created view, the necessary reduce function won't be automatically created. Take a look at SortedByView and create the reduce func by hand.
+* Support for multi key post
+** For example, @ Numbers.all.sorted_by(:val) { |q| q.keys([1,2,3,5]) } @
 * Works with CouchDB 0.9 trunk as of 2008/10/08. Note that pagination won't work correctly on trunk until issue "COUCHDB-135":http://issues.apache.org/jira/browse/COUCHDB-135 is fixed.
 
 *Note*: 0.2.1 requires CouchDB 0.9 trunk. 0.2.0 works with CouchDB 0.8 onwards.
@@ -78,10 +80,10 @@ h3. Paginating models
 <code>
   # Controller (merb-action-args used for extracting view_params)
 
-  def action(view_params={})
+  def action(page_params={})
     u_id = @user._id
 
-    @posts = Post.paginate_by(view_params, :writer_id, :created_at) do |p|
+    @posts = Post.paginate_by(page_params, :writer_id, :created_at) do |p|
       p.startkey([u_id, {}]).endkey([u_id]).descending(true).count(5)
     end
     render

data/Rakefile

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

data/lib/relaxdb/document.rb

@@ -136,9 +136,11 @@ module RelaxDB
       end
     end
     
+    # Order changed as of 30/10/2008 to be consistent with ActiveRecord
+    # Not yet sure of final implemention for hooks - may lean more towards DM than AR
     def save
-      return false unless before_save
       return false unless validates?
+      return false unless before_save
             
       set_created_at if unsaved? 
       
@@ -151,7 +153,7 @@ module RelaxDB
     end  
     
     def validates?
-      success = true
+      total_success = true
       properties.each do |prop|
         if methods.include? "validate_#{prop}"
           prop_val = instance_variable_get("@#{prop}")
@@ -161,9 +163,15 @@ module RelaxDB
               @errors["#{prop}".to_sym] = send("#{prop}_validation_msg")
             end
           end
+          total_success &= success          
         end
       end
-      success
+      total_success &= validate
+      total_success
+    end
+    
+    def validate
+      true
     end
         
     # Hmm. Rename... never_saved? newnew?
@@ -171,6 +179,7 @@ module RelaxDB
       @_rev.nil?
     end
     alias_method :new_record?, :unsaved?
+    alias_method :new_document?, :unsaved?
     
     def to_param
       self._id
@@ -352,16 +361,6 @@ module RelaxDB
       end
     end
     
-    #
-    # Document views are generated on demand if they don't exist when queried. 
-    # The paginator is used with both document generated views, and user defined views.
-    # Auto generating document views on demand in the paginator makes it significantly
-    # more complex and less amendable to use by user defined views. For these reasons,
-    # the first call to paginate_by for a particular list of attributes for a particular 
-    # Document class will update the corresponding design doc, even if it already contains
-    # the required view. This should not incur a penalty with CouchDB as it uses the 
-    # same index for byte identical views.
-    #
     def self.paginate_by(page_params, *view_keys)
       paginate_params = PaginateParams.new
       yield paginate_params

data/lib/relaxdb/has_one_proxy.rb

@@ -37,7 +37,7 @@ module RelaxDB
       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)[0]
+      RelaxDB.retrieve(view_path, design_doc, view_name, map_function).first
     end
         
   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)
+    @@params = %w(key startkey startkey_docid endkey endkey_docid count update descending group reduce include_docs)
   
     @@params.each do |param|
       define_method(param.to_sym) do |*val|

data/lib/relaxdb/paginator.rb

@@ -36,7 +36,7 @@ module RelaxDB
           (offset - orig_offset == 0 ? false : true)
         prev_params = create_prev(docs.first, view_keys) if prev_exists
       else
-        next_exists, prev_exists = false
+        next_exists = prev_exists = false
       end
       
       docs.meta_class.instance_eval do        

data/lib/relaxdb/query.rb

@@ -16,7 +16,8 @@ module RelaxDB
   #
   class Query
     
-    @@params = %w(key startkey startkey_docid endkey endkey_docid count update descending skip group group_level reduce)
+    # 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.each do |param|
       define_method(param.to_sym) do |*val|
@@ -36,6 +37,14 @@ module RelaxDB
       @view_name = view_name
     end
     
+    def keys(keys=nil)
+      if keys.nil?
+        @keys
+      else 
+        @keys = { :keys => keys }.to_json
+      end
+    end
+    
     def view_path
       uri = "_view/#{@design_doc}/#{@view_name}"
       

data/lib/relaxdb/relaxdb.rb

@@ -47,10 +47,16 @@ module RelaxDB
       data["ok"]
     end
   
-    def load(id)
-      resp = db.get("#{id}")
-      data = JSON.parse(resp.body)
-      create_object(data)
+    def load(*ids)
+      if ids.size == 1
+        resp = db.get(ids[0])
+        data = JSON.parse(resp.body)
+        create_object(data)
+      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"]) }
+      end
     end
     
     # Used internally by RelaxDB
@@ -72,7 +78,7 @@ module RelaxDB
       q = Query.new(design_doc, view_name)
       yield q if block_given?
       
-      resp = db.get(q.view_path)
+      resp = q.keys ? db.post(q.view_path, q.keys) : db.get(q.view_path)
       JSON.parse(resp.body)      
     end
     
@@ -136,10 +142,19 @@ module RelaxDB
         
     # Convenience methods - should be in a diffent module?
     
+    def get(uri=nil)
+      JSON.parse(db.get(uri).body)
+    end
+    
     def pp_get(uri=nil)
       resp = db.get(uri)
       pp(JSON.parse(resp.body))
     end
+
+    def pp_post(uri=nil, json=nil)
+      resp = db.post(uri, json)
+      pp(JSON.parse(resp.body))
+    end
   
   end
   

data/lib/relaxdb/server.rb

@@ -84,7 +84,8 @@ module RelaxDB
       @server.delete("/#{@db}/#{path}")
     end
     
-    def get(path=nil)
+    # *ignored allows methods to invoke get or post indifferently
+    def get(path=nil, *ignored)
       @logger.info("GET /#{@db}/#{unesc(path)}")
       @server.get("/#{@db}/#{path}")
     end

data/lib/relaxdb/sorted_by_view.rb

@@ -31,25 +31,26 @@ module RelaxDB
     end
     
     def view_name
-      s = @atts.inject("all_sorted_by") do |s, att|
-        s << "_#{att}_and"
-      end
-      s[0, s.size-4]
+      "all_sorted_by_" << @atts.join("_and_")
     end
         
     def query(query)
       # If a view contains both a map and reduce function, CouchDB will by default return 
       # the result of the reduce function when queried. 
       # This class automatically creates both map and reduce functions so it can be used by the paginator.
-      # In normal usage, this class will be used with map functions, hence reduce is explicitly set to false.
+      # In normal usage, this class will be used with map functions, hence reduce is explicitly set 
+      # 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
+      
       begin
-        resp = RelaxDB.db.get(query.view_path)
+        resp = RelaxDB.db.send(method, query.view_path, query.keys)
       rescue => e
         design_doc = DesignDocument.get(@class_name) 
         design_doc.add_map_view(view_name, map_function).add_reduce_view(view_name, reduce_function).save
-        resp = RelaxDB.db.get(query.view_path)
+        resp = RelaxDB.db.send(method, query.view_path, query.keys)        
       end
 
       data = JSON.parse(resp.body)

data/lib/relaxdb/view_result.rb

@@ -0,0 +1,18 @@
+module RelaxDB
+
+  class ViewResult < DelegateClass(Array)
+    
+    attr_reader :offset, :total_rows
+  
+    def initialize(result_hash)
+      objs = RelaxDB.create_from_hash(result_hash)
+      
+      @offset = result_hash["offset"]
+      @total_rows = result_hash["total_rows"]
+      
+      super(objs)
+    end
+  
+  end
+
+end

data/spec/document_spec.rb

@@ -15,8 +15,7 @@ describe RelaxDB::Document do
   describe ".new" do 
     
     it "should create an object with an id" do
-      p = Atom.new
-      p._id.should_not be_nil
+      Atom.new._id.should_not be_nil
     end
     
     it "should create an object with a nil revision" do
@@ -244,6 +243,12 @@ describe RelaxDB::Document do
         User.new(:name => "atlas").save
         User.all.sorted_by(:name, :age) { |q| q.startkey(["paul",0 ]).endkey(["paul", 50]) }.size.should == 1
       end
+      
+      it "should be retrievable by a multi key post" do
+        5.times { |i| Primitives.new(:num => i).save }
+        ps = Primitives.all.sorted_by(:num) { |q| q.keys([0, 4]) }
+        ps.map { |p| p.num }.should == [0, 4]
+      end
 
     end
     
@@ -304,7 +309,7 @@ describe RelaxDB::Document do
       r = Class.new(RelaxDB::Document) do
         property :thumbs_up, :validator => lambda { |tu| tu >=0 && tu < 3 }
       end
-      r.new(:thumbs_up => 2).save.should_not be_false
+      r.new(:thumbs_up => 2).save.should be
       r.new(:thumbs_up => 3).save.should be_false
     end
 
@@ -328,6 +333,15 @@ describe RelaxDB::Document do
       x.errors[:bar].should == "rab"
     end
     
+    it "should prevent saving unless all validations pass" do
+      r = Class.new(RelaxDB::Document) do
+        property :foo, :validator => lambda { false }
+        property :bar, :validator => lambda { true }
+      end
+      x = r.new
+      x.save.should == false
+    end
+    
     it "may be a proc" do
       r = Class.new(RelaxDB::Document) do
         property :thumbs_up, :validator => lambda { false }

data/spec/query_spec.rb

@@ -66,5 +66,15 @@ describe RelaxDB::Query do
     end
     
   end  
+  
+  describe "#keys" do
+    
+    it "should return a JSON encoded hash" do
+      q = RelaxDB::Query.new("", "")
+      q.keys(["a", "b"])
+      q.keys.should == '{"keys":["a","b"]}'
+    end
+    
+  end
       
 end

data/spec/relaxdb_spec.rb

@@ -58,6 +58,23 @@ describe RelaxDB do
     
   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 an arbitrary number of 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
+    
+  end
+  
   describe ".view" do
     
     map_func = %Q<
@@ -80,6 +97,17 @@ describe RelaxDB do
       data["rows"].size.should == 1
     end
     
+    it "should be queryable with a multi key post" do
+      5.times { |i| Primitives.new(:num => i).save }
+      # Create the view
+      Primitives.all.sorted_by(:num) 
+      resp = RelaxDB.view("Primitives", "all_sorted_by_num") do |q| 
+        q.keys([0, 4])
+        q.reduce(false).group(true) # group invocation should hopefully be temporary
+      end
+      RelaxDB.instantiate(resp).map{ |p| p.num }.should == [0, 4]
+    end
+    
   end
   
   describe ".merge" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: paulcarey-relaxdb
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Paul Carey
@@ -69,6 +69,7 @@ files:
 - lib/relaxdb/sorted_by_view.rb
 - lib/relaxdb/uuid_generator.rb
 - lib/relaxdb/view_object.rb
+- lib/relaxdb/view_result.rb
 - lib/relaxdb/view_uploader.rb
 - lib/relaxdb/views.rb
 - lib/more/grapher.rb