baccigalupi-aqua 0.1.2 → 0.1.3

data/Aqua.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{aqua}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kane Baccigalupi"]
-  s.date = %q{2009-08-25}
+  s.date = %q{2009-08-27}
   s.description = %q{Even with ORMs like ActiveRecord, DataMapper which ease the pain of relational data storage, considerable developer effort goes into wrangling Ruby objects into their databases. Document-oriented databases have made it possible to store nested data structures that easily map to Ruby objects. Aqua (http://github.com/baccigalupi/aqua) is a new Ruby library that aims to painlessly persists objects, allowing developers to focus more on object oriented code and less on storage. Currently Aqua is in pre-alpha testing, with the following big things left to implement: A data query DSL and implementation; Support of all objects in the Standard Library; Class and code storage to allow the sharing and persistence of classes with their data.}
   s.email = %q{baccigalupi@gmail.com}
   s.extra_rdoc_files = [
@@ -74,6 +74,7 @@ Gem::Specification.new do |s|
      "lib/aqua/object/extensions/validation.rb",
      "lib/aqua/object/pack.rb",
      "lib/aqua/object/query.rb",
+     "lib/aqua/object/stub.rb",
      "lib/aqua/object/tank.rb",
      "lib/aqua/object/unpack.rb",
      "lib/aqua/store/couch_db/couch_db.rb",
@@ -89,12 +90,14 @@ Gem::Specification.new do |s|
      "spec/object/config_spec.rb",
      "spec/object/object_fixtures/array_udder.rb",
      "spec/object/object_fixtures/canned_hash.rb",
+     "spec/object/object_fixtures/gerbilmiester.rb",
      "spec/object/object_fixtures/grounded.rb",
      "spec/object/object_fixtures/log.rb",
      "spec/object/object_fixtures/persistent.rb",
      "spec/object/object_fixtures/user.rb",
      "spec/object/pack_spec.rb",
      "spec/object/query_spec.rb",
+     "spec/object/stub_spec.rb",
      "spec/object/tank_spec.rb",
      "spec/object/unpack_spec.rb",
      "spec/spec.opts",
@@ -118,12 +121,14 @@ Gem::Specification.new do |s|
      "spec/object/config_spec.rb",
      "spec/object/object_fixtures/array_udder.rb",
      "spec/object/object_fixtures/canned_hash.rb",
+     "spec/object/object_fixtures/gerbilmiester.rb",
      "spec/object/object_fixtures/grounded.rb",
      "spec/object/object_fixtures/log.rb",
      "spec/object/object_fixtures/persistent.rb",
      "spec/object/object_fixtures/user.rb",
      "spec/object/pack_spec.rb",
      "spec/object/query_spec.rb",
+     "spec/object/stub_spec.rb",
      "spec/object/tank_spec.rb",
      "spec/object/unpack_spec.rb",
      "spec/spec_helper.rb",

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/lib/aqua/object/pack.rb

@@ -69,6 +69,7 @@ module Aqua::Pack
       self.__pack[:_rev] = _rev if _rev 
       self.__pack[:class] = class_name
       self.__pack[:keys] = []
+      self.__pack[:stubs] = []
       _pack_properties
       _pack_singletons
       __pack
@@ -91,7 +92,9 @@ module Aqua::Pack
     # @api private
     def _storable_attributes
       (instance_variables||[]) - self.class._hidden_attributes
-    end  
+    end
+    
+    attr_accessor :_warnings  
        
     # Private/protected methods are all prefaced by an underscore to prevent
     # clogging the object instance space. Some of the public ones above are too!
@@ -193,19 +196,33 @@ module Aqua::Pack
         else # a more complex object, including an array or a hash like thing 
           return_hash = {}
           if obj.aquatic? 
-            # TODO distinguish between internal storage, stubbing and external (obj.aquatic? && obj._embed_me == true)
-            return_hash = obj._pack    
+            if obj._embed_me == true
+              return_hash = obj._pack
+            else
+              return_hash['class'] = 'Aqua::Stub'
+              index = self.__pack[:keys].length 
+              stub = { :class => klass.to_s, :id => obj } 
+              if obj._embed_me.keys && stub_methods = obj._embed_me[:stub]
+                stub[:methods] = {}
+                if stub_methods.class == Symbol || stub_methods.class == String
+                  stub_method = stub_methods.to_sym 
+                  stub[:methods][stub_method] = obj.send( stub_method )
+                else # is an array of values
+                  stub_methods.each do |meth|
+                    stub_method = meth.to_sym
+                    stub[:methods][stub_method] = obj.send( stub_method )
+                  end  
+                end    
+              end  
+              self.__pack[:stubs] << stub
+              return_hash['init'] = "/STUB_#{index}"
+            end        
           elsif !obj.aquatic?
             initialization = _pack_initializations( obj )
             return_hash['init'] = initialization unless initialization.empty?
             data = _pack_ivars( obj )
             return_hash['ivars'] = data unless data.empty?
             return_hash['class'] = klass.to_s  
-          # TODO: distinguish between internal storage, stubbing and external (obj.aquatic? && obj._embed_me == true) 
-          # elsif obj._embed_me.class == Hash
-          #   return_hash = _stub( obj )
-          # else
-          #   return_hash = _pack_to_external(obj)
           end
           return_hash        
         end           
@@ -257,10 +274,28 @@ module Aqua::Pack
         # Also learn the library usage, without any docs :(
       end    
       
-      def _save_to_store 
+      def _save_to_store
+        self._warnings = []
+        _commit_externals 
         __pack.commit
       end
       
+      def _commit_externals 
+        __pack[:stubs].each_with_index do |obj_hash, index|
+          obj = obj_hash[:id]
+          if obj.commit
+            obj_hash[:id] = obj.id
+          else
+            if obj.id
+              self._warnings << "Unable to save latest version of #{obj.inspect}, stubbed at index #{index}"
+              obj_hash[:id] = obj.id if obj.id 
+            else  
+              self._warnings << "Unable to save #{obj.inspect}, stubbed at index #{index}" 
+            end  
+          end    
+        end  
+      end 
+      
       def _clear_accessors
         self.__pack = nil
         self._store = nil

data/lib/aqua/object/stub.rb

@@ -0,0 +1,68 @@
+# NOTES: I just checked and Delegator does all its delegation through method missing, so 
+# it probably makes sense to make this all one class, with method_missing doing the work. 
+
+module Aqua 
+  class TempStub
+    def initialize( method_hash ) 
+      method_hash.each do |method_name, value|
+        self.class.class_eval("
+          def #{method_name}
+            #{value.inspect}
+          end  
+        ")  
+      end  
+    end   
+  end
+    
+  class Stub < Delegator
+    
+    # Builds a new stub object which returns cached/stubbed methods until such a time as a non-cached method 
+    # is requested.
+    #
+    # @param [Hash]
+    # @option opts [Array] :methods A hash of method names and values
+    # @option opts [String] :class The class of the object being stubbed
+    # @option opts [String] :id The id of the object being stubbed
+    #
+    # @api semi-public
+    def initialize( opts )
+      meths = opts[:methods] || {}
+      temp_stub = TempStub.new( meths )
+      super( temp_stub )
+      @_sd_obj = temp_stub
+      self.delegate_class = opts[:class]
+      self.delegate_id = opts[:id]
+    end
+      
+    protected 
+      attr_accessor :delegate_class, :delegate_id
+    
+      def method_missing( method, *args )
+        if __getobj__.class.to_s != delegate_class.to_s
+          load_delegate
+          # resend! 
+          if (args.size == 1 && !args.first.nil?) 
+            __getobj__.send( method.to_sym, eval(args.map{|value| "'#{value}'"}.join(', ')) )
+          else
+            __getobj__.send( method.to_sym )
+          end    
+        else
+          raise NoMethodError
+        end
+      end
+      
+      def __getobj__
+         @_sd_obj          # return object we are delegating to, required
+       end
+
+       def __setobj__(obj)
+         @_sd_obj = obj    # change delegation object, a feature we're providing
+       end
+      
+      def load_delegate
+        __setobj__( delegate_class.constantize.load( delegate_id ) )
+      end   
+    public
+        
+  end  
+end  

data/lib/aqua/object/tank.rb

@@ -3,6 +3,7 @@ require dir + '/pack'
 require dir + '/query'
 require dir + '/unpack'
 require dir + '/config'
+require dir + '/stub'
 
 module Aqua::Tank
   def self.included( klass )

data/lib/aqua/object/unpack.rb

@@ -74,7 +74,7 @@ module Aqua::Unpack
             data_package
           else
             _unpack_object( data_package )
-          end    
+          end
           obj.instance_variable_set( ivar_name, unpacked )
         end  
       end    
@@ -82,15 +82,24 @@ module Aqua::Unpack
       def _unpack_initialization( obj )
         if init = obj[:init] 
           init_class = init.class
-          if init_class == String
-            init
+          if init_class == String 
+            if init.match(/\A\/STUB_(\d*)\z/)
+              _unpack_stub( $1.to_i )
+            else  
+              init
+            end  
           elsif init.class == Array 
             _unpack_array( init )
           else
             _unpack_hash( init )
           end    
         end 
-      end  
+      end
+      
+      def _unpack_stub( index ) 
+        hash = _store[:stubs][index] 
+        Aqua::Stub.new( hash ) 
+      end    
       
       def _unpack_array( obj ) 
         arr = [] 
@@ -144,7 +153,6 @@ module Aqua::Unpack
                 elsif obj_class && obj_class != Array
                   obj_class.new.replace( init )
                 else
-                  # should log an error internally
                   init
                 end
               elsif init_class.ancestors.include?( Hash )
@@ -156,7 +164,7 @@ module Aqua::Unpack
                   # should log an error internally
                   init
                 end
-              else # is a string 
+              else # is a string
                 if obj_class == Date || obj_class == Time 
                   obj_class.parse( init )
                 elsif [Fixnum, Bignum].include?( obj_class )
@@ -167,7 +175,9 @@ module Aqua::Unpack
                   true
                 elsif obj_class == FalseClass 
                   false
-                else
+                elsif obj_class == Aqua::Stub
+                  init
+                else  
                   nil
                 end            
               end       

data/spec/object/config_spec.rb

@@ -7,7 +7,7 @@ describe Aqua::Config do
   end
   
   it 'should set default configuration options on module load' do 
-    opts = User.aquatic_options
+    opts = Persistent.aquatic_options
     opts.should_not be_nil
     opts[:database].should be_nil
     opts[:embed].should be_false

data/spec/object/object_fixtures/gerbilmiester.rb

@@ -0,0 +1,18 @@
+class Gerbilmiester
+  aquatic :embed => [:gerbil, :bacon]
+  
+  # saved state instance variable
+  def gerbil
+    @gerbil ||= true
+  end
+  
+  # not an instance method with saved state, 
+  # but we should be able to stub this.
+  def bacon
+    'chunky' 
+  end 
+  
+  def herd
+    gerbil ? 'Yah, yah, little gerbil' : 'Nothing to herd here, move along!'
+  end     
+end 

data/spec/object/object_fixtures/persistent.rb

@@ -1,4 +1,12 @@
 class Persistent 
-  include Aqua::Pack
+  include Aqua::Tank
+  
+  # for testing class level configuration options
+  def self.aquatic_options
+    _aqua_opts
+  end
+  
+  
+  
 end  
   

data/spec/object/object_fixtures/user.rb

@@ -1,5 +1,5 @@
 class User
-  include Aqua::Tank
+  aquatic :embed => { :stub => :username }
   
   attr_accessor :name, # An array of strings or a hash of strings 
     :created_at,# Time
@@ -7,7 +7,8 @@ class User
     :username,  # simple string 
     :log,       # an Aquatic Object 
     :password,  # hidden value
-    :grab_bag   # non Aquatic Object
+    :grab_bag,   # non Aquatic Object
+    :other_user # a non-embeddable Aquatic Object
   hide_attributes :password
   
   def initialize( hash={} )

data/spec/object/pack_spec.rb

@@ -33,12 +33,93 @@ describe Aqua::Pack do
     it 'should be saved into the design document' 
   end 
   
-  describe 'stubing objects' do 
-    it 'should save as a stub any aquatic object declared as unembeddable'
-    it 'should have class "stub"'
-    it 'should have an object id'
-    it 'should cache any methods declared in the class opts for that class'
-  end  
+  describe 'external saves and stubs' do
+    before(:each) do
+      CouchDB.server.delete_all
+      @graeme = User.new(:username => 'graeme', :name => ['Graeme', 'Nelson'])
+      @user.other_user = @graeme
+      @pack = @user._pack
+    end
+      
+    describe 'packing' do
+      it 'should pack a stubbed object representation under __pack[:stubs]' do 
+        @pack[:stubs].size.should == 1
+        other_user_pack = @pack[:stubs].first 
+        other_user_pack[:class].should == "User"
+        other_user_pack[:id].should == @graeme
+      end  
+      
+      it 'should pack the values of a stubbed methods' do
+        other_user_pack = @pack[:stubs].first  
+        other_user_pack[:methods].size.should == 1
+        other_user_pack[:methods][:username].should == 'graeme'
+      end 
+      
+      it 'should pack an array of stubbed methods' do 
+        User.configure_aqua( :embed => {:stub =>  [:username, :name] } )
+        @user = User.new(
+          :username => 'kane',
+          :name => ['Kane', 'Baccigalupi'],
+          :dob => @date,
+          :created_at => @time,
+          :log => @log,
+          :password => 'my secret!',
+          :other_user => @graeme 
+        ) 
+        
+        @pack = @user._pack
+        other_user_pack = @pack[:stubs].first  
+        other_user_pack[:methods].size.should == 2
+        other_user_pack[:methods][:username].should == 'graeme'
+        other_user_pack[:methods][:name].should == ['Graeme', 'Nelson']
+        
+        # reseting the User model, and @user instance
+        User.configure_aqua( :embed => {:stub =>  :username } )
+      end   
+      
+      it 'should pack the object itself with the class "Aqua::Stub"' do 
+        @pack[:ivars][:@other_user][:class].should == "Aqua::Stub"
+      end  
+        
+      it 'should pack the object itself with a reference to the __pack[:stubs] object' do 
+        @pack[:ivars][:@other_user][:init].should == "/STUB_0"
+      end  
+    end
+    
+    describe 'commiting' do
+      it 'should commit external objects' do 
+        @user.commit!
+        db_docs = CouchDB::Database.new.documents
+        db_docs['total_rows'].should == 2
+      end
+        
+      it 'should save the id to the stub after commiting' do
+        @user.commit!
+        doc = CouchDB.get( "http://127.0.0.1:5984/aqua/#{@user.id}" )
+        doc["stubs"].first["id"].class.should == String 
+      end
+        
+      it 'should log a warning if an external object doesn\'t commit' do
+        @graeme.should_receive(:commit).and_return(false)
+        @user.commit!
+        @user._warnings.size.should == 1
+        @user._warnings.first.should match(/unable to save/i)
+      end
+      
+      it 'should log a warning and save the id if an object has an id' do
+        @graeme.commit!
+        @graeme.should_receive(:commit).and_return(false)
+        @user.commit!
+        @user._warnings.size.should == 1
+        @user._warnings.first.should match(/unable to save latest/i) 
+        doc = CouchDB.get( "http://127.0.0.1:5984/aqua/#{@user.id}" )
+        doc["stubs"].first["id"].class.should == String
+      end  
+        
+      it 'should rollback external commits if the parent object doesn\'t save'
+    end
+    
+  end     
   
   describe 'hiding attributes' do
     it 'should add a class method for designating hidden instance variables' do
@@ -211,16 +292,16 @@ describe Aqua::Pack do
          
         describe 'embeddable aquatic' do
           it 'aquatic objects should have packing instructions in the form of #_embed_me' do
-            @user._embed_me.should == false
+            @user._embed_me.should == {'stub' => :username }
             Log.new._embed_me.should == true
             User.configure_aqua( :embed => {:stub =>  [:username, :name] } ) 
             @user._embed_me.should == { 'stub' => [:username, :name] }
             # reset for future tests
-            User.configure_aqua( :embed => false )
+            User.configure_aqua( :embed => {:stub => :username } )
           end   
   
           it 'should save their ivars correctly' do
-            @pack[:ivars][:@log].keys.sort.should == ['class', 'ivars', 'keys']
+            @pack[:ivars][:@log].keys.should include('ivars')
             @pack[:ivars][:@log]['ivars'].keys.should == ['@created_at', '@message'] 
             @pack[:ivars][:@log]['ivars']['@message'].should == "Hello World! This is a log entry"
           end 
@@ -233,7 +314,7 @@ describe Aqua::Pack do
             arrayish = Arrayed['a', 'b', 'c', 'd']
             arrayish.my_accessor = 'Newt'
             pack = arrayish._pack
-            pack.keys.sort.should == ['class', 'init', 'ivars', 'keys']
+            pack.keys.should include('class', 'init', 'ivars')
             pack['init'].class.should == Array
             pack['init'].should == ['a', 'b', 'c', 'd']
             pack['ivars']['@my_accessor'].should == 'Newt'   
@@ -248,7 +329,7 @@ describe Aqua::Pack do
             hashish['1'] = '2'
             hashish.my_accessor = 'Newt'
             pack = hashish._pack
-            pack.keys.sort.should == ['class', 'init', 'ivars', 'keys']
+            pack.keys.should include('class', 'init', 'ivars')
             pack['init'].class.should == HashWithIndifferentAccess
             pack['init'].should == {'1' => '2'}
             pack['ivars']['@my_accessor'].should == 'Newt'

data/spec/object/stub_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require_fixtures
+ 
+Aqua.set_storage_engine('CouchDB') # to initialize CouchDB
+CouchDB = Aqua::Store::CouchDB unless defined?( CouchDB )
+
+describe Aqua::Stub do
+  before(:each) do 
+    @params = {
+      :id => 'my_great_id',
+      :class => 'Gerbilmiester',
+      :methods => {
+        :gerbil => true,
+        :bacon => 'chunky'
+      }
+    }
+    @stub = Aqua::Stub.new( @params )
+  end  
+    
+  describe 'initialization' do
+    it 'should initialize delegate with a TempStub' do
+      delegate = @stub.instance_eval( "__getobj__" )
+      delegate.class.should == Aqua::TempStub
+    end
+    
+    it 'should initialize the delegate_id' do
+      @stub.instance_eval('delegate_id').should == 'my_great_id'
+    end
+      
+    it 'should initialize the delegate_class' do  
+      @stub.instance_eval('delegate_class').should == 'Gerbilmiester'
+    end   
+  end
+  
+  describe 'delegation' do 
+    it 'should return correct values for initialized methods' do 
+      @stub.gerbil.should == true
+      @stub.bacon.should == 'chunky'
+    end
+    
+    it 'should try to retrieve an object if an unspecified method is called' do 
+      Gerbilmiester.should_receive(:load).and_return( Gerbilmiester.new )
+      @stub.herd
+    end 
+    
+    it 'should return correct values for new delegate' do 
+      Gerbilmiester.should_receive(:load).and_return( Gerbilmiester.new )
+      @stub.herd.should == 'Yah, yah, little gerbil'
+    end   
+  end     
+
+end

data/spec/object/tank_spec.rb

@@ -27,7 +27,10 @@ describe Aqua::Tank do
       Log.new.should respond_to(:commit)
     end
       
-    it 'should add unpack methods to the class and its instances'
+    it 'should add unpack methods to the class and its instances' do 
+      Log.should respond_to( :load )
+      Log.new.should respond_to( :reload )
+    end  
     
     it 'should add configuration methods to the class' do
       Log.should respond_to(:configure_aqua)
@@ -38,14 +41,17 @@ describe Aqua::Tank do
   
   describe 'including Aqua::Pack on the class' do 
     it 'should add pack methods to the class and its instances' do 
-      User.should respond_to(:hide_attributes)
-      User.new.should respond_to(:commit)
+      Persistent.should respond_to(:hide_attributes)
+      Persistent.new.should respond_to(:commit)
     end
       
-    it 'should add unpack methods to the class and its instances'
+    it 'should add unpack methods to the class and its instances' do 
+      Persistent.should respond_to( :load )
+      Persistent.new.should respond_to( :reload )
+    end  
     
     it 'should add configuration methods to the class' do
-      User.should respond_to(:configure_aqua)
+      Persistent.should respond_to( :configure_aqua )
     end  
     
     it 'should add query methods to the class and its instances' 

data/spec/object/unpack_spec.rb

@@ -266,13 +266,51 @@ describe Aqua::Unpack do
       it 'should unpack an aquatic object' do 
         @user.commit!
         @user.log.should == @log
-      end  
+      end
+      
+      describe 'externally saved aquatic objects' do
+        before(:all) do
+          User.configure_aqua( :embed => {:stub =>  [:username, :name] } )
+        end
+        
+        after(:all) do
+          User.configure_aqua( :embed => {:stub =>  :username } )
+        end  
+          
+        before(:each) do
+          @time2 = Time.now - 3600 
+          @graeme = User.new(:username => 'graeme', :name => ['Graeme', 'Nelson'], :created_at => @time2 )
+          @user = User.new(
+            :username => 'kane',
+            :name => ['Kane', 'Baccigalupi'],
+            :dob => @date,
+            :created_at => @time,
+            :log => @log,
+            :password => 'my secret!',
+            :other_user => @graeme 
+          )
+          @user.commit!  
+        end
+           
+        it 'should load a Stub' do 
+          user = User.load(@user.id)
+          user.other_user.class.should == Aqua::Stub
+        end
+          
+        it 'should retrieve cached methods' do
+          user = User.load(@user.id)
+          User.should_not_receive(:load)
+          user.other_user.username.should == 'graeme'
+          user.other_user.name.should == ['Graeme', 'Nelson']
+        end
+          
+        it 'should retrieve the stubbed object when an additional method is required' do
+          user = User.load(@user.id)
+          user.other_user.created_at.to_s.should == @time2.to_s
+        end  
+      end    
       
     end  
   end
-  
-  # object.reload is used by Object.load(id), so there isn't any need right now to test both since
-  # Object.load tests both at once.
-      
 end  
    

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: baccigalupi-aqua
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Kane Baccigalupi
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-25 00:00:00 -07:00
+date: 2009-08-27 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -80,6 +80,7 @@ files:
 - lib/aqua/object/extensions/validation.rb
 - lib/aqua/object/pack.rb
 - lib/aqua/object/query.rb
+- lib/aqua/object/stub.rb
 - lib/aqua/object/tank.rb
 - lib/aqua/object/unpack.rb
 - lib/aqua/store/couch_db/couch_db.rb
@@ -95,12 +96,14 @@ files:
 - spec/object/config_spec.rb
 - spec/object/object_fixtures/array_udder.rb
 - spec/object/object_fixtures/canned_hash.rb
+- spec/object/object_fixtures/gerbilmiester.rb
 - spec/object/object_fixtures/grounded.rb
 - spec/object/object_fixtures/log.rb
 - spec/object/object_fixtures/persistent.rb
 - spec/object/object_fixtures/user.rb
 - spec/object/pack_spec.rb
 - spec/object/query_spec.rb
+- spec/object/stub_spec.rb
 - spec/object/tank_spec.rb
 - spec/object/unpack_spec.rb
 - spec/spec.opts
@@ -143,12 +146,14 @@ test_files:
 - spec/object/config_spec.rb
 - spec/object/object_fixtures/array_udder.rb
 - spec/object/object_fixtures/canned_hash.rb
+- spec/object/object_fixtures/gerbilmiester.rb
 - spec/object/object_fixtures/grounded.rb
 - spec/object/object_fixtures/log.rb
 - spec/object/object_fixtures/persistent.rb
 - spec/object/object_fixtures/user.rb
 - spec/object/pack_spec.rb
 - spec/object/query_spec.rb
+- spec/object/stub_spec.rb
 - spec/object/tank_spec.rb
 - spec/object/unpack_spec.rb
 - spec/spec_helper.rb