aqua 0.1.6 → 0.2.0

data/.gitignore

@@ -4,4 +4,5 @@ coverage
 rdoc
 pkg
 .yardoc
-doc/*
+doc/*
+aqua-*.gem

data/Aqua.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{aqua}
-  s.version = "0.1.6"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kane Baccigalupi"]
-  s.date = %q{2009-10-08}
-  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.date = %q{2009-11-18}
+  s.description = %q{A Ruby Object Database ... just add water (and CouchDB). 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 = [
     "LICENSE",
@@ -31,10 +31,12 @@ Gem::Specification.new do |s|
      "lib/aqua/object/extensions/ar_style.rb",
      "lib/aqua/object/extensions/property.rb",
      "lib/aqua/object/extensions/validation.rb",
+     "lib/aqua/object/initializers.rb",
      "lib/aqua/object/pack.rb",
      "lib/aqua/object/query.rb",
      "lib/aqua/object/stub.rb",
      "lib/aqua/object/tank.rb",
+     "lib/aqua/object/translator.rb",
      "lib/aqua/object/unpack.rb",
      "lib/aqua/store/couch_db/attachments.rb",
      "lib/aqua/store/couch_db/couch_db.rb",
@@ -42,10 +44,10 @@ Gem::Specification.new do |s|
      "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/result_set.rb",
      "lib/aqua/store/couch_db/server.rb",
      "lib/aqua/store/couch_db/storage_methods.rb",
      "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",
@@ -54,15 +56,15 @@ Gem::Specification.new do |s|
      "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/sugar.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/translator_packing_spec.rb",
+     "spec/object/translator_unpacking_spec.rb",
      "spec/object/unpack_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
@@ -72,16 +74,16 @@ Gem::Specification.new do |s|
      "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/result_set_spec.rb",
      "spec/store/couchdb/server_spec.rb",
      "spec/store/couchdb/storage_methods_spec.rb",
      "utils/code_statistics.rb",
      "utils/console"
   ]
-  s.has_rdoc = true
   s.homepage = %q{http://github.com/baccigalupi/aqua}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{Aqua: A Ruby Object Database ... just add water (and CouchDB)}
   s.test_files = [
     "spec/aqua_spec.rb",
@@ -89,15 +91,15 @@ Gem::Specification.new do |s|
      "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/sugar.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/translator_packing_spec.rb",
+     "spec/object/translator_unpacking_spec.rb",
      "spec/object/unpack_spec.rb",
      "spec/spec_helper.rb",
      "spec/store/couchdb/attachments_spec.rb",
@@ -105,13 +107,14 @@ Gem::Specification.new do |s|
      "spec/store/couchdb/database_spec.rb",
      "spec/store/couchdb/design_document_spec.rb",
      "spec/store/couchdb/fixtures_and_data/document_fixture.rb",
+     "spec/store/couchdb/result_set_spec.rb",
      "spec/store/couchdb/server_spec.rb",
      "spec/store/couchdb/storage_methods_spec.rb"
   ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
     else

data/Rakefile

@@ -7,7 +7,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "aqua"
     gem.summary = %Q{Aqua: A Ruby Object Database ... just add water (and CouchDB)}
-    gem.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. }
+    gem.description = %Q{A Ruby Object Database ... just add water (and CouchDB). 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. }
     gem.email = "baccigalupi@gmail.com"
     gem.homepage = "http://github.com/baccigalupi/aqua"
     gem.authors = ["Kane Baccigalupi"]

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.2.0

data/lib/aqua.rb

@@ -1,8 +1,8 @@
 # DEPENDENCIES -------------------------------------
 # require gems
 require 'rubygems' 
-require 'ruby2ruby'
 require 'mime/types'
+
 # Pick your json poison. Just make sure that in adds the JSON constant
 unless defined?(JSON)
   begin
@@ -11,10 +11,9 @@ unless defined?(JSON)
     raise LoadError, "JSON constant not found. Please install a JSON library"
   end  
 end
-# There is also a dependency on the http_client of your choosing. Currently only ...
-# require 'rest_client'
-# It is required when a libarary is configured. If the library is not configured then it will 
-# automatically load the default: rest_client
+
+# This is temporary until someone comes along creating another http_client library adapter. 
+require 'rest_client'
 
 # standard libraries
 require 'cgi'
@@ -31,8 +30,7 @@ require 'aqua/support/string_extensions'
 require 'aqua/store/storage' 
   # object methods
 require 'aqua/object/tank'
-  # a little more monkey patching for object packaging
-require 'aqua/support/initializers'
+require 'aqua/object/initializers'
 
 
 # LIBRARY SETUP -----------------------------------

data/lib/aqua/object/config.rb

@@ -5,10 +5,9 @@ module Aqua::Config
     # for class methods will loose database and other class specific storage options
     klass.class_eval "
       class Storage < Aqua::Storage
-        def self.parent_class
-          '#{klass}'
-        end  
       end
+      
+      Storage.parent_class = '#{klass}'
     "
     
     klass.class_eval do

data/lib/aqua/object/initializers.rb

@@ -0,0 +1,309 @@
+# 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
+#  * 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 Initializers 
+    def self.included( klass ) 
+      klass.class_eval do
+        include InstanceMethods
+        extend ClassMethods
+        
+        unless methods.include?( :hide_attributes )
+          include Aqua::Pack::HiddenAttributes
+        end
+      end
+    end
+    
+    module InstanceMethods 
+      def to_aqua( path = '' )
+        rat = Aqua::Translator::Rat.new( { 'class' => to_aqua_class } ) 
+        
+        init_rat = to_aqua_init( path )
+        rat.hord(init_rat, 'init')  
+        
+        ivar_rat = _pack_instance_vars( path )
+        rat.eat( ivar_rat ) if ivar_rat && ivar_rat.pack['ivars'] && !ivar_rat.pack['ivars'].empty?
+          
+        rat
+      end
+      
+      def to_aqua_class
+        self.class.to_s
+      end  
+      
+      def _pack_instance_vars( path )
+        rat = Aqua::Translator::Rat.new
+        ivar_rat = Translator.pack_ivars( self )
+        ivar_rat.pack.empty? ? rat : rat.hord( ivar_rat, 'ivars' ) 
+      end  
+  
+      def to_aqua_init( path )
+        Aqua::Translator::Rat.new( self.to_s ) 
+      end 
+    end # InstanceMethods
+    
+    module ClassMethods 
+    end # ClassMethods   
+    
+  end # Initializers
+         
+end  
+
+[ TrueClass, FalseClass, Symbol, Time, Date, Fixnum, Bignum, Float, Rational, Hash, Array, OpenStruct, Range, File, Tempfile, String, NilClass].each do |klass|
+  klass.class_eval { include Aqua::Initializers }
+end 
+
+class String
+  def from_aqua( path='')
+    self
+  end  
+  
+  def to_aqua( path='' )
+    Aqua::Translator::Rat.new( self )
+  end 
+end 
+
+class TrueClass 
+  def from_aqua( path='')
+    true
+  end  
+  
+  def to_aqua( path='')
+    Aqua::Translator::Rat.new( true )
+  end 
+end  
+
+class FalseClass
+  def from_aqua( path='')
+    false
+  end  
+  
+  def to_aqua( path='' )
+    Aqua::Translator::Rat.new( false )
+  end
+end   
+
+class NilClass
+  def self.aqua_init( init, opts=Aqua::Translator::Opts.new     )
+    nil
+  end
+end  
+
+class Symbol 
+  def self.aqua_init( init, opts=Aqua::Translator::Opts.new     )
+    init.to_sym
+  end
+  
+  def _pack_instance_vars( path='')
+    nil
+  end 
+end  
+
+class Date
+  hide_attributes :sg, :of, :ajd
+  
+  def self.aqua_init( init, opts=Aqua::Translator::Opts.new     )
+    parse( init )
+  end 
+  
+  def _pack_instance_vars( path='')
+    nil
+  end       
+end 
+
+class Time 
+  def self.aqua_init( init, opts=Aqua::Translator::Opts.new     )
+    parse( init )
+  end
+end
+
+class Fixnum
+  def self.aqua_init( init, opts=Aqua::Translator::Opts.new     )
+    init.to_i
+  end
+end
+
+class Bignum
+  def self.aqua_init( init, opts=Aqua::Translator::Opts.new     )
+    init.to_i
+  end
+end  
+   
+class Float
+  def self.aqua_init( init, opts=Aqua::Translator::Opts.new     )
+    init.to_f
+  end
+end 
+
+class Rational
+  def to_aqua_init( path='') 
+    Aqua::Translator::Rat.new( self.to_s.match(/(\d*)\/(\d*)/).to_a.slice(1,2) )
+  end 
+  
+  def self.aqua_init( init, opts=Aqua::Translator::Opts.new     )
+    Rational( init[0].to_i, init[1].to_i )
+  end
+  
+  def _pack_instance_vars( path='')
+    nil
+  end       
+end
+
+class Range
+  # todo: make this work for non int objects, time, date, etc ...
+  def self.aqua_init( init, opts=Aqua::Translator::Opts.new ) 
+    eval( init )
+  end
+end     
+
+class Array
+  def to_aqua_init( path = '' )
+    rat = Aqua::Translator::Rat.new([])
+    self.each_with_index do |obj, index|
+      local_path = path + "[#{index}]" 
+      obj_rat = Aqua::Translator.pack_object( obj, local_path )
+      rat.eat( obj_rat )  
+    end
+    rat   
+  end
+  
+  def self.aqua_init( init, opts=Aqua::Translator::Opts.new ) 
+    # todo: make opts opts.path follow the path through the base object
+    array_init = init.map{ |obj| Aqua::Translator.unpack_object(obj, opts) } 
+    # new is neccessary to make sure array derivatives maintain their class
+    # without having to override aqua_init! 
+    self == Array ? array_init : new( array_init ) 
+  end 
+end
+
+
+class Hash
+  def to_aqua_init( path='')
+    rat = Aqua::Translator::Rat.new
+    self.each do |raw_key, value|
+      key_class = raw_key.class
+      if key_class == String
+        key = raw_key
+      else # key is an object 
+        index = aqua_next_object_index( rat.pack )  
+        key = self.class.aqua_object_key_index( index )
+        key_rat = Aqua::Translator.pack_object( raw_key, path+"['#{self.class.aqua_key_register}'][#{index}]")
+        rat.hord( key_rat, [self.class.aqua_key_register, index] )
+      end
+      obj_rat = Aqua::Translator.pack_object( value, path+"['#{key}']" )
+      rat.hord( obj_rat, key )
+    end
+    rat 
+  end
+  
+  def self.aqua_key_register
+    "#{aqua_key_register_prefix}KEYS".freeze
+  end
+  
+  def self.aqua_key_register_prefix
+    "/_OBJECT_"
+  end  
+  
+  def self.aqua_object_key_index( index ) 
+    "#{aqua_key_register_prefix}#{index}"
+  end    
+  
+  def aqua_next_object_index( hash )
+    hash[self.class.aqua_key_register] ||= []
+    hash[self.class.aqua_key_register].size
+  end  
+  
+  def self.aqua_init( init, opts=Aqua::Translator::Opts.new )
+    unpacked = {}
+    init.each do |key, value|
+      unless key == aqua_key_register
+        if key.match(/^#{aqua_key_register_prefix}(\d*)$/)
+          index = $1.to_i
+          key = Aqua::Translator.unpack_object( init[aqua_key_register][index], opts )
+        end 
+        opts.path += "[#{key}]" 
+        value = Aqua::Translator.unpack_object( value, opts )
+        unpacked[ key ] = value 
+      end  
+    end
+    self == Hash ? unpacked : new( unpacked )  
+  end 
+end
+
+class OpenStruct
+  hide_attributes :table
+  
+  def to_aqua_init( path='' ) 
+    instance_variable_get("@table").to_aqua_init( path )
+  end
+  
+  def self.aqua_init( init, opts=Aqua::Translator::Opts.new )
+    init = Hash.aqua_init( init, opts )
+    new( init )
+  end
+end 
+
+module Aqua
+  module FileInitializations 
+    def to_aqua( opts=Aqua::Translator::Opts.new )
+      rat = Aqua::Translator::Rat.new(
+        { 
+          'class' => to_aqua_class,
+          'init' => {
+            'id' => filename,
+            'methods' => {
+              'content_type' => content_type,
+              'content_length' => content_length 
+            }
+          }  
+        }, {}, [self]
+      )
+        
+      ivar_rat = _pack_instance_vars( path )
+      rat.eat( ivar_rat ) if ivar_rat && ivar_rat.pack['ivars'] && !ivar_rat.pack['ivars'].empty?
+          
+      rat 
+    end
+    
+    def content_length 
+      if len = stat.size
+        rat = Aqua::Translator.pack_object( len )
+        rat.pack
+      else
+        ''
+      end  
+    end 
+    
+    def content_type 
+      mime = MIME::Types.type_for( self.path )
+      mime && mime.first ? mime.first.to_s : ''
+    end     
+    
+    def to_aqua_class
+      'Aqua::FileStub'
+    end   
+       
+    def filename
+      path.match(/([^\/]*)\z/).to_s
+    end
+      
+  end # FileInitializations
+end # Aqua
+   
+class File
+  include Aqua::FileInitializations        
+end
+
+class Tempfile
+  include Aqua::FileInitializations
+  
+  hide_attributes :clean_proc, :data, :tmpname, :tmpfile, :_dc_obj
+  
+  def filename
+    path.match(/([^\/]*)\.\d*\.\d*\z/).captures.first
+  end
+end