aqua 0.1.6 → 0.2.0

data/spec/spec_helper.rb

@@ -9,6 +9,24 @@ def require_fixtures
   Dir[ File.dirname(__FILE__) + "/object/object_fixtures/**/*.rb" ].each do |file|
     require file
   end
+end
+
+def build_user_ivars 
+  @time = Time.now
+  @date = Date.parse('12/23/1969')
+  @message = "Hello World! This is a log entry"
+  @log = Log.new( :message => @message, :created_at => @time ) # embedded object
+  @other_user = User.new( :username => 'strictnine', :name => ['What', 'Ever'] ) # stubbed objects
+  @user = User.new(
+    :username => 'kane',
+    :name => ['Kane', 'Baccigalupi'],
+    :dob => @date,
+    :created_at => @time,
+    :log => @log,
+    :password => 'my secret!',
+    :other_user => @other_user 
+  )
+  @pack = @user._pack  
 end  
 
 

data/spec/store/couchdb/design_document_spec.rb

@@ -7,18 +7,18 @@ CouchDB =   Aqua::Store::CouchDB unless defined?( CouchDB )
 Database =  CouchDB::Database unless defined?( Database )
 Server =    CouchDB::Server unless defined?( Server )
 Design =    CouchDB::DesignDocument unless defined?( Design )
+ResultSet =    CouchDB::ResultSet unless defined?( ResultSet ) 
+
+require File.dirname(__FILE__) + '/fixtures_and_data/document_fixture' # Document ... a Mash with the collection of methods
 
 describe CouchDB::DesignDocument do 
   before(:each) do
     Aqua::Storage.database.delete_all
+    @name = 'User'
+    @design = Design.new(:name => @name)
   end  
     
   describe 'new and create' do
-    before(:each) do
-      @name = 'User'
-      @design = Design.new(:name => @name)
-    end
-      
     it 'should require a name to build the uri' do
       design = Design.new
       lambda{ design.uri }.should raise_error
@@ -35,9 +35,150 @@ describe CouchDB::DesignDocument do
     end  
   end
   
+  it 'should get a design document by name' do
+    @design.save!
+    lambda{ Design.get( @name ) }.should_not raise_error
+  end  
+  
   describe 'views' do
+    before(:each) do
+      ResultSet.document_class = Document
+    end
+      
+    it 'should be a Hash-like object' do 
+      @design.views.should == Mash.new
+    end
     
-  end    
-  
+    describe '<<, add, add!' do
+      describe 'string as argument' do
+        it 'should add a view with the right name' do
+          @design << 'my_attribute'
+          @design.views.keys.should == ['my_attribute']
+        end
+      
+        it 'should autogenerate a generic map' do
+          @design << 'my_attribute'
+          @design.views[:my_attribute][:map].should match(/function\(doc\)/)
+          @design.views[:my_attribute][:map].should match(/emit/)
+        end
+      
+        it 'should not autogenerate a reduce function' do
+          @design << 'my_attribute'
+          @design.views[:my_attribute][:reduce].should be_nil
+        end 
+      end
+      
+      describe 'hash options as argument' do 
+        it 'should add a view named with the options name key' do 
+          @design << {:name => 'my_attribute'}
+          @design.views.keys.should == ['my_attribute']
+        end
+        
+        it 'should autogenerate a generic map' do
+          @design << {:name => 'my_attribute'}
+          @design.views[:my_attribute][:map].should match(/function\(doc\)/)
+          @design.views[:my_attribute][:map].should match(/emit/)
+        end
+        
+        it 'should autogenerate a generic map with class constraints' do
+          @design << {:name => 'my_docs', :class_constraint => Document}
+          @design.views[:my_docs][:map].should match(/doc\['type'\] == 'Document'/)
+        end
+        
+        it 'should autogenerate a generic map and insert preformed class constraints' do
+          @design << {:name => 'user', :class_constraint => "doc['class'] == 'User'" }
+          @design.views[:user][:map].should match(/doc\['class'\] == 'User'/)
+        end  
+        
+        it 'should not autogenerate a reduce function' do
+          @design << {:name => 'my_attribute'}
+          @design.views[:my_attribute][:reduce].should be_nil
+        end
+        
+        it 'should apply a map option when provided' do
+          @design << {:name => 'my_attribute', :map => 'not the generic'}
+          @design.views[:my_attribute][:map].should == 'not the generic'
+        end
+        
+        it 'should apply a reduce option when provided' do
+          @design << {:name => 'my_attribute', :reduce => 'I exist!'}
+          @design.views[:my_attribute][:map].should match(/function\(doc\)/)
+          @design.views[:my_attribute][:map].should match(/emit/) 
+          @design.views[:my_attribute][:reduce].should == 'I exist!'
+        end      
+      end
+      
+      it 'add should act like <<' do
+        @design.add :name => 'my_attribute', :map => 'not the generic'
+        @design.views[:my_attribute][:map].should == 'not the generic'
+      end
+      
+      it 'add! should save after adding the view' do
+        @design.add! :name => 'my_attribute', :map => 'not the generic'
+        lambda{ Design.get( @design.name ) }.should_not raise_error
+        design = Design.get( @design.name )
+        design.views.keys.should include( 'my_attribute' )
+      end        
+    end 
   
+    describe 'query' do
+      before(:each) do
+        (1..10).each do |num| 
+          Document.create!( :index => num )
+        end
+        @design << :index
+        @design.save!  
+      end
+         
+      it 'should query by saved view' do
+        lambda{ @design.query( :index ) }.should_not raise_error
+      end 
+      
+      it 'should return a number of rows corresponding to all the documents in the query' do
+        @docs = @design.query( :index )
+        @docs.size.should == 10
+      end
+      
+      it 'should return the documents themselves by default' do
+        @docs = @design.query( :index )
+        @docs.first.keys.should include( 'index' )
+        @docs.first.class.should == Document
+      end
+      
+      it 'should limit query results' do
+        @docs = @design.query( :index, :limit => 2 )
+        @docs.size.should == 2
+      end
+      
+      it 'should offset query results' do
+        @docs = @design.query( :index, :limit => 2, :offset => 2)
+        @docs.size.should == 2
+        @docs.first[:index].should == 3
+      end
+      
+      it 'should put in descending order' do
+        @docs = @design.query( :index, :order => :desc )
+        @docs.first[:index].should == 10
+      end
+      
+      it 'should select a range' do
+        @docs = @design.query( :index, :range => [2,4])
+        @docs.size.should == 3
+        @docs.first[:index].should == 2
+      end
+      
+      it 'should select a range with descending order' do
+        @docs = @design.query( :index, :range => [2,4], :order => :descending )
+        @docs.size.should == 3
+        @docs.first[:index].should == 4
+        @docs[2][:index].should == 2 
+      end
+      
+      it 'should select by exact key' do 
+        @docs = @design.query( :index, :equals => 3 )
+        @docs.size.should == 1
+        @docs.first[:index].should == 3
+      end                 
+    end  
+  end     
 end  

data/spec/store/couchdb/result_set_spec.rb

@@ -0,0 +1,95 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+Aqua.set_storage_engine('CouchDB') # to initialize the Aqua::Store namespace
+
+# Conveniences for typing with tests ... 
+CouchDB =   Aqua::Store::CouchDB unless defined?( CouchDB ) 
+Database =  CouchDB::Database unless defined?( Database )
+Design =    CouchDB::DesignDocument unless defined?( Design )
+ResultSet =    CouchDB::ResultSet unless defined?( ResultSet )
+
+require File.dirname(__FILE__) + '/fixtures_and_data/document_fixture' # Document ... a Mash with the collection of methods
+class Docintalk < Document 
+  def talk 
+    'Hello, I am a Docintalk'
+  end  
+end  
+
+describe ResultSet do
+  before(:each) do
+    ResultSet.document_class = nil # resets for all theses tests
+    # These are sample returns from couchdb for a view query
+    # the first is when the include_document=true is omitted
+    # the next is when it is included
+    @no_docs = {
+      "rows"=>[
+        {"id"=>"b7e4623f506c437bae2b517d169b3c88", "value"=>nil, "key"=>1}, 
+        {"id"=>"43d650760fdda785a3bd20056d53b3e0", "value"=>nil, "key"=>2}, 
+        {"id"=>"b638586d7d71267e54af9420ee803a7c", "value"=>nil, "key"=>3}, 
+        {"id"=>"c0f8a9d683fb1576dc1da943d9bf2251", "value"=>nil, "key"=>4}, 
+        {"id"=>"11d12976059170f360df222bc097834c", "value"=>nil, "key"=>5}, 
+        {"id"=>"d9270a9bdc7128f02c4b9ccdc10e6b18", "value"=>nil, "key"=>6}, 
+        {"id"=>"c85c7d08e240c1798a7db11b0756581c", "value"=>nil, "key"=>7}, 
+        {"id"=>"721ec0ec55c5d16719ae438855528575", "value"=>nil, "key"=>8}, 
+        {"id"=>"13d2140c707196af4b4e53fe73a0ab0b", "value"=>nil, "key"=>9}, 
+        {"id"=>"b139683cf575446edb4245eba245d907", "value"=>nil, "key"=>10}
+      ], 
+      "offset"=>0, 
+      "total_rows"=>10
+    }
+    @with_docs = {
+      "rows"=>[
+        {"doc"=>{"_id"=>"9d749a8a532294c22ccbf16873f50ead", "_rev"=>"1-567432465", "index"=>2}, "id"=>"9d749a8a532294c22ccbf16873f50ead", "value"=>nil, "key"=>1}, 
+        {"doc"=>{"_id"=>"b1394da1469eae862cca661da238b951", "_rev"=>"1-2128259075", "index"=>3}, "id"=>"b1394da1469eae862cca661da238b951", "value"=>nil, "key"=>2}, 
+        {"doc"=>{"_id"=>"a1b7b978b20649cb5fd648cd510e0243", "_rev"=>"1-3326711422", "index"=>4}, "id"=>"a1b7b978b20649cb5fd648cd510e0243", "value"=>nil, "key"=>3}, 
+        {"doc"=>{"_id"=>"92b69da432d658da6dc69a5c611065ca", "_rev"=>"1-2590331142", "index"=>5}, "id"=>"92b69da432d658da6dc69a5c611065ca", "value"=>nil, "key"=>4}, 
+        {"doc"=>{"_id"=>"f3b257b6d9bc60062147db98175a809b", "_rev"=>"1-2121844908", "index"=>6}, "id"=>"f3b257b6d9bc60062147db98175a809b", "value"=>nil, "key"=>5}, 
+       ], 
+       "offset"=>1, 
+       "total_rows"=>5
+     }
+     @docless = ResultSet.new( @no_docs )
+     @docfull = ResultSet.new( @with_docs )     
+  end
+  
+  it 'should have a default document class accessor' do
+    ResultSet.should respond_to(:document_class)
+    ResultSet.should respond_to(:document_class=)
+  end    
+  
+  it 'should have an offset' do
+    @docless.offset.should == 0
+    @docfull.offset.should == 1
+  end 
+   
+  it 'should have a total' do 
+    @docless.total.should == 10
+    @docfull.total.should == 5
+  end
+    
+  it 'should have rows' do
+    @docless.rows.should == @no_docs['rows']
+    @docfull.rows.should == @with_docs['rows']
+  end
+  
+  it 'keys should be the array accessible content of the set when docs are not included' do
+    @docless.first.should == @no_docs['rows'].first['key']
+  end  
+  
+  it 'docs should be the array accessible content of the set, when available' do
+    @docfull.first.should == @with_docs['rows'].first['doc']
+  end
+  
+  it 'it should convert docs to the default document class if no instance level document class is available' do 
+    ResultSet.document_class = Document
+    docs = ResultSet.new( @with_docs )
+    docs.first.class.should == Document
+  end
+  
+  it 'should use instance level document class when available' do
+    docs = ResultSet.new( @with_docs, Docintalk )
+    docs.document_class.should == Docintalk
+    docs.first.class.should == Docintalk
+  end      
+    
+end

data/spec/store/couchdb/storage_methods_spec.rb

@@ -4,10 +4,10 @@ Aqua.set_storage_engine('CouchDB') # to initialize the Aqua::Store namespace
 require File.dirname(__FILE__) + '/fixtures_and_data/document_fixture' # Document ... a Mash with the collection of methods
 
 # Conveniences for typing with tests ... 
-CouchDB =     Aqua::Store::CouchDB unless defined?( CouchDB ) 
-Database =    CouchDB::Database unless defined?( Database )
-Server =      CouchDB::Server unless defined?( Server)
-Attachments = CouchDB::Attachments unless defined?( Attachments )
+CouchDB =     Aqua::Store::CouchDB    unless defined?( CouchDB ) 
+Database =    CouchDB::Database       unless defined?( Database )
+Server =      CouchDB::Server         unless defined?( Server)
+Attachments = CouchDB::Attachments    unless defined?( Attachments )
 
 describe 'CouchDB::StorageMethods' do
   before(:each) do
@@ -17,6 +17,9 @@ describe 'CouchDB::StorageMethods' do
       :more => "my big stuff"
     }
     @doc = Document.new( @params )
+    # the line below is neccessary in the full suite, but not when the file is run on it's own ??
+    CouchDB.put( 'http://127.0.0.1:5984/aqua' ) unless @doc.class.database.exists?
+    @doc.class.database.delete_all
   end  
   
   describe 'initialization' do
@@ -148,10 +151,6 @@ describe 'CouchDB::StorageMethods' do
   end  
   
   describe 'save/create' do 
-    before(:each) do
-      @doc.delete if @doc.exists?  
-    end  
-    
     it 'saving should create a document in the database' do 
       @doc.save
       lambda{ Aqua::Store::CouchDB.get( @doc.uri ) }.should_not raise_error
@@ -213,9 +212,43 @@ describe 'CouchDB::StorageMethods' do
       @doc[:noodle] = 'spaghetti'
       @doc.reload
       @doc[:noodle].should be_nil
+    end
+    
+    it 'should create using find_or_create' do 
+      lambda{ Document.get( @params[:id] ) }.should raise_error
+      doc = Document.find_or_create( @params[:id] )
+      lambda{ Document.get( @params[:id] ) }.should_not raise_error
     end      
   end 
   
+  describe 'getting' do
+    it 'should get a document from its id' do 
+      @doc.save!
+      lambda{ Document.get( @doc.id ) }.should_not raise_error
+    end 
+    
+    it 'returned document should have an id' do
+      @doc.save!
+      document = Document.get( @doc.id )
+      document.id.should == @doc.id
+    end
+    
+    it 'returned document should have an id even if not explicitly set' do
+      doc = Document.new(:this => 'that')
+      doc.save!
+      retrieved = Document.get( doc.id )
+      retrieved.id.should_not be_nil
+      retrieved.id.should_not be_empty
+    end 
+    
+    it 'returned document should have a rev' do
+      @doc.save!
+      document = Document.get( @doc.id )
+      document.rev.should_not be_nil
+    end     
+    
+  end  
+  
   describe 'deleting' do
     before(:each) do
       @doc.delete if @doc.exists?  
@@ -401,8 +434,115 @@ describe 'CouchDB::StorageMethods' do
     
   end  
   
-  describe 'indexing/views' do
-    it 'should '
+  describe 'design document' do
+    it 'should not have a design document if there is no design_name' do
+      Document.design_name.should be_nil
+      Document.design_document.should be_nil
+    end  
+     
+    it 'should create a design document if there is a design_name but the design document exists' do
+      Document.design_name = 'User'
+      lambda{ CouchDB::DesignDocument.get( 'User' ) }.should raise_error
+      Document.design_document.should_not be_nil
+      lambda{ CouchDB::DesignDocument.get( 'User') }.should_not raise_error 
+    end
+      
+    it 'should retrieve a design document if there is a design_name and the design document exists' do
+      CouchDB::DesignDocument.create!( :name => 'User' )
+      # ensures that the record exists, before the real test
+      lambda{ CouchDB::DesignDocument.get( 'User') }.should_not raise_error 
+      Document.design_document.should_not be_nil
+    end  
+  end  
+  
+  describe 'indexing & queries' do
+    Document.class_eval { attr_accessor( :my_field ) }
+    
+    it 'should have a class method "indexes" that stores map names related to the class' do
+      Document.indexes.should == []
+    end
+    
+    describe 'index_on' do
+      before(:each) do
+        Document.index_on(:my_field)
+      end
+        
+      it 'should add text and symbol entries to indexes' do
+        Document.indexes.size.should == 2
+        Document.indexes.should include( :my_field )
+        Document.indexes.should include( 'my_field' )
+      end 
+      
+      it 'should not duplicate an index name' do
+        # previous tests have already added it to the array 
+        Document.indexes.size.should == 2 
+      end 
+      
+      it 'should add a view to the design document' do
+        design = Document.design_document(true)
+        design.views.should include( :my_field )
+      end  
+    end
+    
+    describe 'queries' do
+      before(:each) do
+        Document.parent_class = 'Document'
+        Document.index_on(:my_field)
+        Document.index_on_ivar( :my_ivar )
+        (1..5).each do |number|
+          Document.create!( 
+            :my_field => number * 5, 
+            :ivars => {
+              '@my_ivar' => number + 5
+            },
+            :class => 'Document' 
+          )
+        end  
+      end 
+       
+      it 'should query full documents for an index' do
+        docs = Document.query(:my_field) 
+        docs.each{ |r| r.class.should == Document }
+        docs.size.should == 5
+      end
+      
+      it 'should query ivar indexes correctly' do 
+        docs = Document.query(:my_ivar)
+        docs.each{ |r| r.class.should == Document }
+        docs.size.should == 5
+      end  
+      
+      it 'should query only the index value for an index' do 
+        docs = Document.query(:my_field, :select => 'index only')
+        docs.each{ |r| r.class.should == Fixnum }
+      end
+      
+      it 'should generate a calculated/reduced view for an index the first time it is called' do
+        Document.count(:my_field) 
+        Document.design_document.views.should include( :my_field_count )
+      end
+      
+      it 'should count an index' do 
+        Document.count(:my_field).should == 5
+      end 
+      
+      it 'should sum an index' do
+        Document.sum(:my_field).should == 75
+      end
+      
+      it 'should average an index' do 
+        Document.average(:my_field).should == 15
+      end 
+      
+      it 'should get the minimum of an index' do 
+        Document.min(:my_field).should == 5
+      end
+      
+      it 'should get the maximum of an index' do 
+        Document.max(:my_field).should == 25
+      end        
+    
+    end       
   end  
 
 end