baccigalupi-aqua 0.1.4 → 0.1.5

data/lib/aqua/store/couch_db/http_client/adapter/rest_client.rb

@@ -4,7 +4,7 @@ module RestClientAdapter
   def self.convert_exception(&blk)
     begin
       yield
-    rescue Exception => e
+    rescue Exception => e 
       ending = e.class.to_s.match(/[a-z0-9_]*\z/i)
       if e.message.match(/409\z/)
         raise Aqua::Store::CouchDB::Conflict, e.message

data/lib/aqua/store/couch_db/http_client/rest_api.rb

@@ -25,8 +25,8 @@ module RestAPI
   end     
   
   def put(uri, doc = nil)
-    hash = doc.to_json if doc
-    response = RestAPI.adapter.put( uri, hash )
+    hash = doc.to_json if doc 
+    response = RestAPI.adapter.put( uri, hash ) 
     JSON.parse( response )
   end
 

data/lib/aqua/store/couch_db/storage_methods.rb

@@ -342,10 +342,20 @@ module Aqua
           # Escapes a string for id usage
           # @api private
           def escape_for_id( str )
-            str.match(/^_design\/(.*)/) ? "_design/#{CGI.escape($1)}" : CGI.escape(str)
+            CGI.escape(str)
           end    
           
-
+          # Attachments ----------------
+          # maybe this should be it's own class?? 
+          
+          # Hash of attachments, keyed by name
+          # @return [Hash] Attachments keyed by name
+          # 
+          # @api public
+          def attachments
+            @attachments ||= Attachments.new( self )
+          end  
+          
           # TODO: Attachments
           # def encode_attachments(attachments)
           #   attachments.each do |key, value|

data/lib/aqua/support/initializers.rb

@@ -1,7 +1,10 @@
 # AQUA INITIALIZATION
 # Some object store state in a fundamental way, not in instance variables, that needs to be initialized.
 # Examples: Array, Numeric types, Hashes, Time ...
-# You can make any object requiring this initialization savable to aqua by adding the following methods:
+# You can make any object requiring this initialization savable to aqua by
+#  * including the Aqua::To module and extending the Aqua::From module
+#  * building your own methods for #to_aqua, #to_aqua_init, MyClass.aqua_init
+# See set.rb in this file for more an example
 module Aqua
   module To
     def to_aqua( base_object )
@@ -27,7 +30,7 @@ module Aqua
   end # From       
 end  
 
-[ TrueClass, FalseClass, Time, Date, Fixnum, Bignum, Float, Rational, Hash, Array, OpenStruct].each do |klass|
+[ TrueClass, FalseClass, Time, Date, Fixnum, Bignum, Float, Rational, Hash, Array, OpenStruct, Range].each do |klass|
   klass.class_eval do 
     include Aqua::To
     extend Aqua::From
@@ -74,7 +77,13 @@ class Float
   def self.aqua_init( init )
     init.to_f
   end
-end  
+end 
+
+class Range
+  def self.aqua_init( init ) 
+    eval( init )
+  end
+end     
 
 class Rational
   def to_aqua_init( base_object ) 

data/lib/aqua/support/set.rb

@@ -0,0 +1,27 @@
+# require this file if you want to use sets with your Aquatic objects
+require 'set'
+
+class Set 
+  # implements initialization in a way that works provided that init is an array 
+  extend Aqua::From
+  
+  # implements #to_aqua correctly, we will have to rewrite #to_aqua_init to return an array
+  include Aqua::From 
+  
+  def to_aqua( base_object )
+    hash = { 
+      'class' => self.class.to_s, 
+      'init' => to_aqua_init( base_object ) 
+    }
+    if instance_variables.size > 0 
+      hash.merge!({ 'ivars' => base_object._pack_ivars( self ) })
+    end
+    hash
+  end
+
+  def to_aqua_init( base_object )
+    # keys returns an array
+    # to_aqua_init will ensure that each of the objects is unpacked to aqua 
+    instance_variable_get("@hash").keys.to_aqua_init( base_object )
+  end    
+end  

data/spec/object/object_fixtures/sugar.rb

@@ -0,0 +1,4 @@
+class Sugar
+  aquatic # configured to :emded => false by default
+  attr_accessor :sweetness
+end

data/spec/object/pack_spec.rb

@@ -55,6 +55,12 @@ describe Aqua::Pack do
         other_user_pack[:methods][:username].should == 'graeme'
       end 
       
+      it "should pack a stub of an object with embed=>false" do
+        sugar = Sugar.new
+        sugar.sweetness = Sugar.new
+        lambda {sugar._pack}.should_not raise_error
+      end
+      
       it 'should pack an array of stubbed methods' do 
         User.configure_aqua( :embed => {:stub =>  [:username, :name] } )
         @user = User.new(

data/spec/object/unpack_spec.rb

@@ -2,7 +2,9 @@ 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 )
+CouchDB = Aqua::Store::CouchDB unless defined?( CouchDB )  
+
+require File.dirname(__FILE__) + "/../../lib/aqua/support/set"
 
 describe Aqua::Unpack do
   before(:each) do
@@ -261,6 +263,21 @@ describe Aqua::Unpack do
         user = User.load(@user.id)
         user.grab_bag.should == @user.grab_bag 
       end
+      
+      it 'should unpack a Range' do
+        @user.grab_bag = 1..3
+        @user.commit!
+        user = User.load(@user.id)
+        user.grab_bag.should == (1..3)
+      end
+      
+      it 'should unpack a Set' do
+        set = Set.new([1,2,3])
+        @user.grab_bag = set
+        @user.commit!
+        user = User.load(@user.id)
+        user.grab_bag.should == set
+      end  
          
       
       it 'should unpack an aquatic object' do 

data/spec/store/couchdb/attachments_spec.rb

@@ -0,0 +1,127 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+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 ) 
+Attachments =   CouchDB::Attachments unless defined?( Attachments )
+
+describe CouchDB::Attachments do
+  before(:each) do
+    CouchDB.server.delete_all! 
+    @doc = Document.new(:id => 'attachments_doc')
+    @attachments = Attachments.new( @doc )
+    @file = File.new( File.dirname( __FILE__ ) + '/fixtures_and_data/image_attach.png' )
+  end
+   
+  describe 'initialization' do
+    it 'should initialize with a document uri' do
+      lambda{ Attachments.new }.should raise_error( ArgumentError )
+      lambda{ Attachments.new( @doc )}.should_not raise_error( ArgumentError )
+    end
+  
+    it 'should initialize with an optional hash' do
+      lambda{ Attachments.new( @doc, {:my_file => @file})}.should_not raise_error( ArgumentError )
+    end
+    
+    it 'when initializing with a hash, it should check that each key is a string and each value is a file' do
+      lambda{ Attachments.new( @doc, { 1 => @file }) }.should raise_error( ArgumentError  )
+      lambda{ Attachments.new( @doc, {:my_file => 1}) }.should raise_error( ArgumentError )
+    end     
+  end     
+  
+  describe 'attachment_uri' do 
+    it 'should raise an error if the document has no id' do
+      attachments = Attachments.new( Document.new )
+      attachments.add( :my_file, @file )
+      lambda{ attachments.uri_for( :my_file ) }.should raise_error( ArgumentError )
+    end 
+    
+    it 'should not include revision information if the document is new' do
+      @attachments.add( :my_file, @file )
+      @attachments.uri_for( :my_file ).should_not include( '?rev=')
+    end
+      
+    it 'should include revision information if the document has been saved' do 
+      @doc.save!
+      @attachments.add( :my_file, @file )
+      @attachments.uri_for( :my_file ).should include( '?rev=')
+    end
+    
+    it 'should construct a valid attachment uri' do
+      @attachments.add(:my_file, @file )
+      @attachments.uri_for( :my_file ).should == "http://127.0.0.1:5984/aqua/attachments_doc/my_file"
+    end
+    
+    it 'should construct a get attachment uri without the revision information' do 
+      @doc.save!
+      @attachments.add( :my_file, @file )
+      @attachments.uri_for( :my_file, false ).should_not include( '?rev=')
+    end      
+  end   
+  
+  describe 'adding attachments' do 
+    it 'should have a method #add that takes a name and a file' do 
+      @attachments.should respond_to( :add )
+      lambda{ @attachments.add }.should raise_error( ArgumentError )
+      lambda{ @attachments.add( :my_file ) }.should raise_error( ArgumentError )
+      lambda{ @attachments.add( :my_file, :not_a_file ) }.should raise_error( ArgumentError )
+      lambda{ @attachments.add( [], @file ) }.should raise_error( ArgumentError )
+      lambda{ @attachments.add( :my_file, @file ) }.should_not raise_error( ArgumentError )
+    end 
+  
+    it 'should add a valid hash to the attachments container' do
+      @attachments.add( :my_file, @file )
+      @attachments[:my_file].should == @file
+    end
+    
+    it 'should save the attachment to the database' do
+      lambda{ @attachments.add!( :my_file, @file ) }.should_not raise_error
+      lambda{ CouchDB.get( @attachments.uri_for(:my_file) ) }.should_not raise_error 
+    end  
+  end
+  
+  describe 'removing attachments' do
+    it '#delete should delete an attachment from the collection' do 
+      @attachments.add( :my_file, @file )
+      @attachments.delete( :my_file ).should == @file
+      @attachments[:my_file].should be_nil
+    end
+    
+    it '#delete! should remove an attachment from the collection and database' do 
+      @attachments.add!( :my_file, @file )
+      @attachments.delete!( :my_file )
+      lambda{ CouchDB.get( @attachments.uri_for(:my_file) ) }.should raise_error #( Aqua::ObjectNotFound )
+    end   
+  end
+  
+  describe 'retrieving attachments' do
+    it 'should return a file if found locally' do
+      @attachments.add!( :my_file, @file )
+      @attachments.should_not_receive(:get!)
+      @attachments.get(:my_file).should == @file
+    end
+    
+    it 'should request a file from the database when not found locally' do 
+      @attachments.add!( :my_file, @file )
+      @attachments.delete( :my_file ) # just deletes the local reference
+      @attachments.should_receive(:get!)
+      @attachments.get(:my_file) 
+    end 
+    
+    it 'should return a Tempfile from the database' do
+      @attachments.add!( :my_file, @file )
+      @attachments.delete( :my_file ) # just deletes the local reference
+      @attachments.get(:my_file).class.should == Tempfile
+    end
+    
+    it 'should have the same data as the original file' do 
+      @attachments.add!( :my_file, @file )
+      file = @attachments.get!(:my_file)
+      @file.rewind
+      file.read.should == @file.read
+    end       
+  end     
+    
+end

data/spec/store/couchdb/design_document_spec.rb

@@ -0,0 +1,43 @@
+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 )
+Server =    CouchDB::Server unless defined?( Server )
+Design =    CouchDB::DesignDocument unless defined?( Design )
+
+describe CouchDB::DesignDocument do 
+  before(:each) do
+    CouchDB.server.delete_all  
+  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
+      lambda{ @design.uri }.should_not raise_error
+    end
+      
+    it 'should build the correct uri' do
+      @design.uri.should == 'http://127.0.0.1:5984/aqua/_design/User'
+    end
+      
+    it 'should save' do 
+      lambda{ @design.save! }.should_not raise_error
+      lambda{ CouchDB.get( @design.uri ) }.should_not raise_error
+    end  
+  end
+  
+  describe 'views' do
+    
+  end    
+  
+  
+end  

data/spec/store/couchdb/storage_methods_spec.rb

@@ -1,12 +1,13 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 Aqua.set_storage_engine('CouchDB') # to initialize the Aqua::Store namespace
-require File.dirname(__FILE__) + '/document_fixture' # Document ... a Mash with the collection of methods
+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)
+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
@@ -261,5 +262,12 @@ describe 'CouchDB::StorageMethods' do
       @doc.retrieve['more'].should == 'less ... really'
     end  
   end
+  
+  describe 'attachments' do 
+    it 'should have an Attachment accessor for storing attachments' do 
+      @doc.attachments.should == Attachments.new( @doc )
+    end
+      
+  end  
 
 end

data/utils/custom.css

@@ -0,0 +1,14 @@
+body {
+  font-family: Trebuchet, 'Trebuchet MS', Verdana, Arial, sans-serif;
+  font-size: 11pt; line-height: 1.5;
+} 
+a { color: #069;}
+a:visited { color: #444;}
+ 
+.section.module h1.title, .section.class h1.title, .section.readme h1 {
+  background-color: #09C; color: white; border-width: 0px;
+}
+.section.readme h1 { margin:0 0 7px -7px;  }
+ 
+h2 { background-color: #a2e3f9; color:#000000; padding-left: 7px; }
+.readme h2 { margin:0 0 7px -7px; }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: baccigalupi-aqua
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Kane Baccigalupi
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-27 00:00:00 -07:00
+date: 2009-08-31 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -46,8 +46,10 @@ files:
 - doc/Aqua/Storage.html
 - doc/Aqua/Store.html
 - doc/Aqua/Store/CouchDB.html
+- doc/Aqua/Store/CouchDB/Attachments.html
 - doc/Aqua/Store/CouchDB/Conflict.html
 - doc/Aqua/Store/CouchDB/Database.html
+- doc/Aqua/Store/CouchDB/DesignDocument.html
 - doc/Aqua/Store/CouchDB/RequestFailed.html
 - doc/Aqua/Store/CouchDB/RequestTimeout.html
 - doc/Aqua/Store/CouchDB/ResourceNotFound.html
@@ -72,9 +74,11 @@ files:
 - doc/Hash.html
 - doc/OpenStruct.html
 - doc/README.rdoc.html
+- doc/Range.html
 - doc/Rational.html
 - doc/RestAPI.html
 - doc/RestClientAdapter.html
+- doc/Set.html
 - doc/Time.html
 - doc/TrueClass.html
 - doc/all-files.html
@@ -98,8 +102,10 @@ files:
 - lib/aqua/object/stub.rb
 - lib/aqua/object/tank.rb
 - lib/aqua/object/unpack.rb
+- lib/aqua/store/couch_db/attachments.rb
 - lib/aqua/store/couch_db/couch_db.rb
 - lib/aqua/store/couch_db/database.rb
+- lib/aqua/store/couch_db/design_document.rb
 - lib/aqua/store/couch_db/http_client/adapter/rest_client.rb
 - lib/aqua/store/couch_db/http_client/rest_api.rb
 - lib/aqua/store/couch_db/server.rb
@@ -107,6 +113,7 @@ files:
 - lib/aqua/store/storage.rb
 - lib/aqua/support/initializers.rb
 - lib/aqua/support/mash.rb
+- lib/aqua/support/set.rb
 - lib/aqua/support/string_extensions.rb
 - spec/aqua_spec.rb
 - spec/object/config_spec.rb
@@ -116,6 +123,7 @@ files:
 - spec/object/object_fixtures/grounded.rb
 - spec/object/object_fixtures/log.rb
 - spec/object/object_fixtures/persistent.rb
+- spec/object/object_fixtures/sugar.rb
 - spec/object/object_fixtures/user.rb
 - spec/object/pack_spec.rb
 - spec/object/query_spec.rb
@@ -124,13 +132,17 @@ files:
 - spec/object/unpack_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/store/couchdb/attachments_spec.rb
 - spec/store/couchdb/couch_db_spec.rb
 - spec/store/couchdb/database_spec.rb
-- spec/store/couchdb/document_fixture.rb
+- spec/store/couchdb/design_document_spec.rb
+- spec/store/couchdb/fixtures_and_data/document_fixture.rb
+- spec/store/couchdb/fixtures_and_data/image_attach.png
 - spec/store/couchdb/server_spec.rb
 - spec/store/couchdb/storage_methods_spec.rb
 - utils/code_statistics.rb
 - utils/console
+- utils/custom.css
 has_rdoc: true
 homepage: http://github.com/baccigalupi/aqua
 post_install_message: 
@@ -166,6 +178,7 @@ test_files:
 - spec/object/object_fixtures/grounded.rb
 - spec/object/object_fixtures/log.rb
 - spec/object/object_fixtures/persistent.rb
+- spec/object/object_fixtures/sugar.rb
 - spec/object/object_fixtures/user.rb
 - spec/object/pack_spec.rb
 - spec/object/query_spec.rb
@@ -173,8 +186,10 @@ test_files:
 - spec/object/tank_spec.rb
 - spec/object/unpack_spec.rb
 - spec/spec_helper.rb
+- spec/store/couchdb/attachments_spec.rb
 - spec/store/couchdb/couch_db_spec.rb
 - spec/store/couchdb/database_spec.rb
-- spec/store/couchdb/document_fixture.rb
+- spec/store/couchdb/design_document_spec.rb
+- spec/store/couchdb/fixtures_and_data/document_fixture.rb
 - spec/store/couchdb/server_spec.rb
 - spec/store/couchdb/storage_methods_spec.rb