paulcarey-relaxdb 0.1.2 → 0.1.3

data/README.textile

@@ -1,5 +1,3 @@
-*Note:* For a correctly formatted version of this page, take a look at the "wiki":http://github.com/paulcarey/relaxdb/wikis
-
 h2. Overview
 
 RelaxDB provides a Ruby interface to CouchDB. It offers a simple idiom for specifying object relationships. The underlying objects are persisted to the mighty CouchDB. Combined with the schema free nature of CouchDB, RelaxDB's current strength lies in quick prototyping of object models.

data/Rakefile

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

data/lib/more/grapher.rb

@@ -0,0 +1,42 @@
+module RelaxDB
+  
+  class GraphCreator
+    
+    def self.create
+      system "mkdir -p graphs"
+      
+      data = JSON.parse(RelaxDB.db.get("_all_docs").body)
+      all_ids = data["rows"].map { |r| r["id"] }
+      all_ids = all_ids.reject { |id| id =~ /_/ }
+      
+      dot = "digraph G { \nrankdir=LR;\nnode [shape=record];\n"
+      all_ids.each do |id|
+        doc = RelaxDB.load(id)
+        atts = "#{doc.class}\\l|"
+        doc.properties.each do |prop|
+          # we don't care about the revision
+          next if prop == :_rev 
+          
+          prop_val = doc.instance_variable_get("@#{prop}".to_sym)
+          atts << "#{prop}\\l#{prop_val}|" if prop_val
+        end
+        atts = atts[0, atts.length-1]
+        
+        dot << %Q%#{doc._id} [ label ="#{atts}"];\n%
+        
+        doc.class.belongs_to_rels.each do |relationship, opts|
+          id = doc.instance_variable_get("@#{relationship}_id".to_sym)
+          dot << %Q%#{id} -> #{doc._id} [ label = "#{relationship}"];\n% if id
+        end
+                  
+      end
+      dot << "}"
+      
+      File.open("graphs/data.dot", "w") { |f| f.write(dot) }
+      
+      system "dot -Tpng -o graphs/all_docs.png graphs/data.dot"
+    end
+    
+  end
+  
+end

data/lib/relaxdb/all_delegator.rb

@@ -18,7 +18,7 @@ module RelaxDB
       view_path = "_view/#{@klass}/all"
       map_function = ViewCreator.all(@klass)
       
-      @all = RelaxDB::retrieve(view_path, @klass, "all", map_function)      
+      @all = RelaxDB.retrieve(view_path, @klass, "all", map_function)      
     end
 
     def sorted_by(*atts)
@@ -27,7 +27,7 @@ module RelaxDB
       q = Query.new(@klass.name, v.view_name)
       yield q if block_given?
       
-      RelaxDB::retrieve(q.view_path, @klass, v.view_name, v.map_function)      
+      RelaxDB.retrieve(q.view_path, @klass, v.view_name, v.map_function)      
     end
     
     # Note that this method leaves the corresponding DesignDoc for the associated class intact

data/lib/relaxdb/document.rb

@@ -61,7 +61,7 @@ module RelaxDB
       # The default _id will be overwritten if loaded from CouchDB
       self._id = UuidGenerator.uuid 
       
-      @errors = {}
+      @errors = Errors.new
 
       # Set default properties if this object has not known CouchDB
       unless hash["_rev"]
@@ -109,9 +109,12 @@ module RelaxDB
             
     def to_json
       data = {}
-      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)
         data["#{relationship}_id"] = id if id
+        if opts[:denormalise]
+          add_denormalised_data(data, relationship, opts)
+        end
       end
       properties.each do |prop|
         prop_val = instance_variable_get("@#{prop}".to_sym)
@@ -121,16 +124,30 @@ module RelaxDB
       data.to_json      
     end
     
+    # quick n' dirty denormalisation - explicit denormalisation will probably become a 
+    # permanent fixture of RelaxDB, but quite likely in a different form to this one
+    def add_denormalised_data(data, relationship, opts)
+      obj = send(relationship)
+      if obj
+        opts[:denormalise].each do |prop_name|
+          val = obj.send(prop_name)
+          data["#{relationship}_#{prop_name}"] = val
+        end
+      end
+    end
+    
     def save
-      set_created_at_if_new
+      return false unless before_save
+      return false unless validates?
+            
+      set_created_at if unsaved? 
       
-      if validates?
-        resp = RelaxDB.db.put("#{_id}", to_json)
-        self._rev = JSON.parse(resp.body)["rev"]
-        self
-      else
-        false
-      end
+      resp = RelaxDB.db.put("#{_id}", to_json)
+      self._rev = JSON.parse(resp.body)["rev"]
+
+      after_save
+
+      self
     end  
     
     def validates?
@@ -149,16 +166,21 @@ module RelaxDB
       success
     end
         
+    # Hmm. Rename... never_saved? newnew?
     def unsaved?
-      instance_variable_get(:@_rev).nil?
+      @_rev.nil?
     end
+    alias_method :new_record?, :unsaved?
     
-    def set_created_at_if_new
-      if unsaved? and methods.include? "created_at"
+    def to_param
+      self._id
+    end
+    alias_method :id, :to_param
+    
+    def set_created_at
+      if methods.include? "created_at"
         # Don't override it if it's already been set
-        unless instance_variable_get(:@created_at)
-          instance_variable_set(:@created_at, Time.now)
-        end
+        @created_at = Time.now if @created_at.nil?
       end
     end
        
@@ -240,9 +262,9 @@ module RelaxDB
       @has_one_rels ||= []      
     end
             
-    def self.belongs_to(relationship)
-      @belongs_to_rels ||= []
-      @belongs_to_rels << relationship
+    def self.belongs_to(relationship, opts={})
+      @belongs_to_rels ||= {}
+      @belongs_to_rels[relationship] = opts
 
       define_method(relationship) do
         create_or_get_proxy(BelongsToProxy, relationship).target
@@ -261,7 +283,7 @@ module RelaxDB
     
     def self.belongs_to_rels
       # Don't force clients to check that it's instantiated
-      @belongs_to_rels ||= []
+      @belongs_to_rels ||= {}
     end
     
     def self.all_relationships
@@ -271,7 +293,7 @@ module RelaxDB
     def self.all
       @all_delegator ||= AllDelegator.new(self)      
     end
-                
+                    
     # destroy! nullifies all relationships with peers and children before deleting 
     # itself in CouchDB
     # The nullification and deletion are not performed in a transaction
@@ -292,6 +314,38 @@ module RelaxDB
       RelaxDB.db.delete("#{_id}?rev=#{_rev}")
       self
     end
+    
+    #
+    # Callbacks - define these in a module and mix'em'in ?
+    #
+    def self.before_save(callback)
+      before_save_callbacks << callback
+    end 
+    
+    def self.before_save_callbacks
+      @before_save ||= []
+    end       
+    
+    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
+      end
+    end
+    
+    def self.after_save(callback)
+      after_save_callbacks << callback
+    end
+    
+    def self.after_save_callbacks
+      @after_save_callbacks ||= []
+    end
+    
+    def after_save
+      self.class.after_save_callbacks.each do |callback|
+        callback.is_a?(Proc) ? callback.call(self) : send(callback)
+      end
+    end
             
   end
   

data/lib/relaxdb/extlib.rb

@@ -0,0 +1,3 @@
+class Errors < Hash
+  alias_method :on, :[]
+end

data/lib/relaxdb/has_many_proxy.rb

@@ -10,7 +10,7 @@ module RelaxDB
       @opts = opts
 
       @target_class = opts[:class] 
-      @relationship_as_viewed_by_target = (opts[:known_as] || client.class.name.downcase).to_s
+      @relationship_as_viewed_by_target = (opts[:known_as] || client.class.name.snake_case).to_s
 
       @children = load_children
     end

data/lib/relaxdb/has_one_proxy.rb

@@ -5,8 +5,8 @@ module RelaxDB
     def initialize(client, relationship)
       @client = client
       @relationship = relationship
-      @target_class = @relationship.to_s.capitalize      
-      @relationship_as_viewed_by_target = client.class.to_s.downcase
+      @target_class = @relationship.to_s.camel_case      
+      @relationship_as_viewed_by_target = client.class.name.snake_case
       
       @target = nil
     end

data/lib/relaxdb/relaxdb.rb

@@ -25,6 +25,10 @@ module RelaxDB
       db.list_dbs
     end
     
+    def replicate_db(source, target)
+      db.replicate_db source, target
+    end
+    
     def bulk_save(*objs)
       docs = {}
       objs.each { |o| docs[o._id] = o }
@@ -45,6 +49,7 @@ module RelaxDB
       create_object(data)
     end
     
+    # Used internally by RelaxDB
     def retrieve(view_path, design_doc, view_name, map_function)
       begin
         resp = db.get(view_path)
@@ -57,29 +62,42 @@ module RelaxDB
       create_from_hash(data)      
     end
       
-    def view(design_doc, view_name, default_ret_val=[])
+    # Requests the given view from CouchDB and returns a hash.
+    # This method should typically be wrapped in one of merge, instantiate, or reduce_result.
+    def view(design_doc, view_name)
       q = Query.new(design_doc, view_name)
       yield q if block_given?
       
       resp = db.get(q.view_path)
-      data = JSON.parse(resp.body)
-
-      # presence of total_rows tells us a map function was invoked
-      # if it's absent a map reduce invocation occured
-      if data["total_rows"]
-        create_from_hash(data)
-      else
-        obj = data["rows"][0] && data["rows"][0]["value"]
-        obj ? ViewObject.create(obj) : default_ret_val
+      JSON.parse(resp.body)      
+    end
+    
+    # Should be invoked on the result of a join view
+    # Merges all rows based on merge_key and returns an array of ViewOject
+    def merge(data, merge_key)
+      merged = {}
+      data["rows"].each do |row|
+        value = row["value"]
+        merged[value[merge_key]] ||= {}
+        merged[value[merge_key]].merge!(value)
       end
+      
+      merged.values.map { |v| ViewObject.create(v) }
+    end
+    
+    # Creates RelaxDB::Document objects from the result
+    def instantiate(data)
+      create_from_hash(data)
+    end
+    
+    # Returns a scalar, an object, or an Array of objects
+    def reduce_result(data)
+      obj = data["rows"][0] && data["rows"][0]["value"]
+      ViewObject.create(obj)      
     end
         
     def create_from_hash(data)
-      @objects = []
-      data["rows"].each do |row|
-        @objects << create_object(row["value"])
-      end
-      @objects      
+      data["rows"].map { |row| create_object(row["value"]) }
     end
   
     def create_object(data)

data/lib/relaxdb/server.rb

@@ -59,15 +59,12 @@ module RelaxDB
     end
     
     def use_db(name)
-      begin
-        @server.get("/#{name}")
-      rescue
-        @server.put("/#{name}", "")
-      end
+      create_db_if_non_existant(name)
       @db = name
     end
     
     def delete_db(name)
+      @logger.info("Deleting database #{name}")
       @server.delete("/#{name}")
     end
     
@@ -75,6 +72,13 @@ module RelaxDB
       JSON.parse(@server.get("/_all_dbs").body)
     end
     
+    def replicate_db(source, target)
+      @logger.info("Replicating from #{source} to #{target}")
+      create_db_if_non_existant target      
+      data = { "source" => source, "target" => target}
+      @server.post("/_replicate", data.to_json)
+    end
+
     def delete(path=nil)
       @logger.info("DELETE /#{@db}/#{unesc(path)}")
       @server.delete("/#{@db}/#{path}")
@@ -107,6 +111,16 @@ module RelaxDB
       @db
     end
     
+    private
+    
+    def create_db_if_non_existant(name)
+      begin
+        @server.get("/#{name}")
+      rescue
+        @server.put("/#{name}", "")
+      end
+    end
+    
   end
         
 end

data/lib/relaxdb.rb

@@ -17,6 +17,7 @@ require 'relaxdb/all_delegator'
 require 'relaxdb/belongs_to_proxy'
 require 'relaxdb/design_doc'
 require 'relaxdb/document'
+require 'relaxdb/extlib'
 require 'relaxdb/has_many_proxy'
 require 'relaxdb/has_one_proxy'
 require 'relaxdb/query'
@@ -28,6 +29,7 @@ require 'relaxdb/uuid_generator'
 require 'relaxdb/view_object'
 require 'relaxdb/view_uploader'
 require 'relaxdb/views'
+require 'more/grapher.rb'
 
 module RelaxDB
 end

data/spec/callbacks_spec.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# A little naiive, needs quite a bit more thought and work
+
+describe RelaxDB::Document, "callbacks" do
+  
+  before(:all) do
+    RelaxDB.configure(:host => "localhost", :port => 5984)  
+  end
+
+  before(:each) do
+    RelaxDB.delete_db "relaxdb_spec_db" rescue "ok"
+    RelaxDB.use_db "relaxdb_spec_db"
+  end
+  
+  describe "before_save" do
+  
+    it "should be run before the object is saved" do
+      c = Class.new(RelaxDB::Document) do
+        before_save lambda { |s| s.gem += 1 if s.unsaved? }
+        property :gem
+      end
+      p = c.new(:gem => 5).save
+      p.gem.should == 6
+    end
+    
+    it "should prevent the object from being saved if it returns false" do
+      c = Class.new(RelaxDB::Document) do
+        before_save lambda { false }
+      end
+      c.new.save.should == false
+    end
+    
+    it "may be a proc" do
+      c = Class.new(RelaxDB::Document) do
+        before_save lambda { false }
+      end
+      c.new.save.should == false      
+    end
+    
+    it "may be a method" do
+      c = Class.new(RelaxDB::Document) do
+        before_save :never
+        def never; false; end
+      end
+      c.new.save.should == false
+    end
+    
+  end
+  
+  describe "after_save" do
+    
+    it "should be run after the object is saved" do
+      c = Class.new(RelaxDB::Document) do
+        after_save lambda { |s| s.gem +=1 unless s.unsaved? }
+        property :gem
+      end
+      p = c.new(:gem => 5).save
+      p.gem.should == 6
+    end
+    
+  end
+
+end

data/spec/denormalisation_spec.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Experimental only for now
+
+class Tree < RelaxDB::Document
+  property :name
+  property :climate
+  has_one :leaf
+end
+
+class Leaf < RelaxDB::Document
+  belongs_to :tree, :denormalise => [:name]
+end
+
+describe RelaxDB::Document, "denormalisation" do
+
+  before(:all) do
+    RelaxDB.configure(:host => "localhost", :port => 5984)  
+  end
+
+  before(:each) do
+    RelaxDB.delete_db "relaxdb_spec_db" rescue "ok"
+    RelaxDB.use_db "relaxdb_spec_db"
+  end
+
+  describe "belongs_to" do
+        
+    it "should store denormalised options in its json representation" do
+      tree = Tree.new(:name => "sapling").save
+      leaf = Leaf.new(:tree => tree)
+      obj = JSON.parse(leaf.to_json)
+      obj["tree_name"].should == "sapling"
+    end
+
+    it "should ignore denormalised options for nil properties" do
+      Leaf.new.to_json
+    end
+    
+    it "should not interfere with normal belongs_to behaviour" do
+      tree = Tree.new(:name => "sapling", :climate => "tropical").save
+      leaf = Leaf.new(:tree => tree).save
+      leaf = RelaxDB.load(leaf._id)
+      leaf.tree.name.should == "sapling"
+      leaf.tree.climate.should == "tropical"
+    end
+    
+  end
+  
+end

data/spec/document_spec.rb

@@ -148,7 +148,7 @@ describe RelaxDB::Document do
     
   end
   
-  describe "#all" do
+  describe ".all" do
   
     it "should return all instances of that class" do
       Photo.new.save
@@ -164,7 +164,7 @@ describe RelaxDB::Document do
     
   end
   
-  describe "#all.sorted_by" do
+  describe ".all.sorted_by" do
   
     it "should sort ascending by default" do
       Post.new(:content => "b").save
@@ -267,7 +267,7 @@ describe RelaxDB::Document do
       end
       r.new.save.should be_false
     end
-    
+        
     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" }
@@ -303,6 +303,23 @@ describe RelaxDB::Document do
       x.errors[:bar].should == "rab"
     end
     
+    it "may be a proc" do
+      r = Class.new(RelaxDB::Document) do
+        property :thumbs_up, :validator => lambda { false }
+      end
+      r.new.save.should be_false      
+    end
+    
+    it "may be a method" do
+      r = Class.new(RelaxDB::Document) do
+        property :thumbs_up, :validator => :count_em
+        def count_em
+          false
+        end
+      end
+      r.new.save.should be_false
+    end
+    
   end
   
 end

data/spec/has_many_spec.rb

@@ -33,6 +33,14 @@ describe RelaxDB::HasManyProxy do
       u = RelaxDB.load u._id
       u.items.size.should == 1
     end    
+    
+    it "should work with MultiWordClassNames" do
+      c = MultiWordChild.new
+      m = MultiWordClass.new.save
+      m.multi_word_children << c
+      m = RelaxDB.load m._id
+      m.multi_word_children[0].should == c
+    end    
         
     describe "#<<" do
 

data/spec/has_one_spec.rb

@@ -52,6 +52,13 @@ describe RelaxDB::HasOneProxy do
       p = RelaxDB.load p._id
       p.rating.photo.should == p
     end        
+    
+    it "should work with MultiWordClassNames" do
+      c = MultiWordChild.new
+      m = MultiWordClass.new(:multi_word_child => c).save
+      m = RelaxDB.load m._id
+      m.multi_word_child.should == c
+    end
            
     describe "#=" do
 

data/spec/relaxdb_spec.rb

@@ -44,7 +44,66 @@ describe RelaxDB do
     
   end
   
-  it "should offer an example where behaviour is different with caching enabled and caching disabled" do
+  describe ".replicate_db" do
+    
+    it "should replicate the named database" do
+      orig = "relaxdb_spec_db"
+      replica = "relaxdb_spec_db_replica"
+      RelaxDB.delete_db replica rescue "ok"
+      Atom.new.save # implicitly saved to orig
+      RelaxDB.replicate_db orig, replica
+      RelaxDB.use_db replica
+      Atom.all.size.should == 1
+    end
+    
+  end
+  
+  describe ".view" do
+    
+    map_func = %Q<
+      function (doc) {
+        emit(doc._id, doc);
+      }
+    >
+    
+    it "should request a view and return a hash" do
+      RelaxDB::DesignDocument.get("viewtest").add_view("simple", "map", map_func).save
+      data = RelaxDB.view("viewtest", "simple")
+      data.should be_instance_of(Hash)
+    end
+
+    it "may accept a block" do
+      RelaxDB::DesignDocument.get("viewtest").add_view("simple", "map", map_func).save
+      RelaxDB.db.put("x", {}.to_json)      
+      RelaxDB.db.put("y", {}.to_json)      
+      data = RelaxDB.view("viewtest", "simple") { |q| q.key("x") }
+      data["rows"].size.should == 1
+    end
+    
   end
+  
+  describe ".merge" do
+    
+    it "should merge rows sharing a common merge key into a single ViewObject" do
+      rows = [
+        {"value" => {"sculptor_id" => 1, "sculpture_name" => "strandbeesten"} },
+        {"value" => {"sculptor_id" => 1, "sculptor_name" => "hans"} },
+        {"value" => {"sculptor_id" => 2, "sculpture_name" => "parading dogs"} },
+        {"value" => {"sculptor_id" => 2, "sculptor_name" => "holmes"} }
+      ]
+      data = {"rows" => rows}
+      result = RelaxDB.merge(data, "sculptor_id")
+      result = result.sort { |a, b| a.sculptor_name <=> b.sculptor_name }      
+
+      result[0].sculptor_name.should == "hans"
+      result[0].sculpture_name.should == "strandbeesten"
+      result[1].sculptor_name.should == "holmes"
+      result[1].sculpture_name.should == "parading dogs"
+    end
+        
+  end
+  
+  # if caching is added
+  # it "should offer an example where behaviour is different with caching enabled and caching disabled"
             
 end

data/spec/spec_models.rb

@@ -85,6 +85,15 @@ class Tagging < RelaxDB::Document
 
 end
 
+class MultiWordClass < RelaxDB::Document
+  has_one :multi_word_child
+  has_many :multi_word_children, :class => "MultiWordChild"
+end
+
+class MultiWordChild < RelaxDB::Document
+  belongs_to :multi_word_class
+end
+
 class TwitterUser < RelaxDB::Document
   
   property :name

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: paulcarey-relaxdb
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Paul Carey
@@ -57,6 +57,7 @@ files:
 - lib/relaxdb/belongs_to_proxy.rb
 - lib/relaxdb/design_doc.rb
 - lib/relaxdb/document.rb
+- lib/relaxdb/extlib.rb
 - lib/relaxdb/has_many_proxy.rb
 - lib/relaxdb/has_one_proxy.rb
 - lib/relaxdb/query.rb
@@ -68,8 +69,11 @@ files:
 - lib/relaxdb/view_object.rb
 - lib/relaxdb/view_uploader.rb
 - lib/relaxdb/views.rb
+- lib/more/grapher.rb
 - lib/relaxdb.rb
 - spec/belongs_to_spec.rb
+- spec/callbacks_spec.rb
+- spec/denormalisation_spec.rb
 - spec/design_doc_spec.rb
 - spec/document_spec.rb
 - spec/has_many_spec.rb