Rubernate 0.1.0

data/lib/rubernate.rb

@@ -0,0 +1,127 @@
+#--
+# Rubernate is an object-oriented storage for Ruby objects based
+# on relational database model.
+#
+# Copyright (C) 2006 Andrey Ryabov <andrey_ryabov@bk.ru>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+
+$:.unshift File.dirname(__FILE__) unless 
+  $:.include? File.dirname(__FILE__)
+
+require 'log4r'
+require 'rubernate/mixins'
+require 'rubernate/callbacks'
+require 'rubernate/entity'
+require 'rubernate/peer'
+require 'rubernate/runtime'
+require 'rubernate/impl/dbigeneric'
+require 'rubernate/queries'
+require 'rubernate/impl/memory'
+require 'rubernate/impl/dbimysql' 
+require 'rubernate/impl/dbioracle'
+
+
+module Rubernate
+  # Common Rubernate Log instance
+  Log = Log4r::Logger.new self.name
+
+  # Rubernate core singelton methods.
+  class << self
+    # Allows you setup Rubernate by yours implementaion of RuntimeFactory.
+    # See also method configure
+    def runtime_factory= factory
+      Log.info "Rubernate configured by #{factory}"
+      @runtime_factory = factory
+    end
+  
+    # Performs configuration of Rubernate.
+    #   * db  - database type (:mysql, :oracle).
+    #   * url - url of database.    
+    #   * user - databases user name
+    #   * password - databases users password
+    def config db, url, user, password
+      impl = case db
+        when :mysql: DBI::MySqlRuntime
+        when :oracle: DBI::OracleRuntime
+        else raise "Database #{db} not supported" 
+      end     
+      self.runtime_factory = DBI::RuntimeFactory.new impl, url, user, password
+    end
+    
+    # Returns Runtime object associated with current session 
+    # or nil if session does not excists
+    def runtime
+      Thread.current[:Rubernate]
+    end
+    
+    # Checks if session exists
+    def session?
+      Thread.current[:Rubernate] != nil
+    end
+    
+    # Begins new Rubernate session
+    def session
+      runtime = @runtime_factory.create
+      Thread.current[:Rubernate] = runtime
+      runtime.begin
+      return runtime unless block_given?
+      begin
+        result = yield runtime
+        runtime.commit
+      rescue Exception => e
+        runtime.rollback e
+        raise
+      ensure
+        Thread.current[:Rubernate] = nil
+      end
+      result
+    end 
+  end
+
+  # Shortcut method can be used instead of Rubernate.runtime.find_by_pk
+  def find_by_pk pk
+    Rubernate.runtime.find_by_pk pk
+  end
+
+  # Shortcut method can be used instead of Rubernate.runtime.find_by_query
+  def find_by_query query, params={}
+    Rubernate.runtime.find_by_query query, params
+  end
+  
+  # Shortcut method can be used instead of Rubernate.runtime
+  def runtime
+    Rubernate.runtime
+  end
+  
+  # Shortcut method can be used instead of Rubernate.runtime.dbh
+  # Retruns DBI::DatabaseHandle bound to current transaction.
+  # This method is optional, some implementation may not implement this method.
+  def dbh
+    Rubernate.runtime.dbh
+  end
+  module_function :find_by_pk, :find_by_query, :dbh
+
+  # Signals that object wasn't found
+  class ObjectNotFoundException < RuntimeError
+    def initialize msg
+      @msg = msg.is_a?(String) ? msg : "object not found: #{msg}"
+    end    
+    def to_s
+      @msg
+    end
+  end
+end

data/tests/README

@@ -0,0 +1,16 @@
+== Configuration
+
+Before you start testing edit config.rb to setup 
+appropriate database configuration. It is encouraged
+to use one database dedicated to tests since all its
+content will be deleted during the tests.
+
+== Running
+You can run all tests by:
+
+    test>ruby all_tests.rb
+
+Or you can run each test by hand:
+  
+    test\rubernate>ruby queries_test.rb
+

data/tests/all_tests.rb

@@ -0,0 +1,12 @@
+#
+#  Edit to setup database connection
+#
+require 'rubernate/fixtures'
+require 'config'
+require 'rubernate/rubernate_test'
+require 'rubernate/utils_test'
+require 'rubernate/queries_test'
+require 'rubernate/impl/memory_test'
+require 'rubernate/callbacks_test'
+require 'rubernate/impl/dbioracle_test' if $run_oracle_tests
+require 'rubernate/impl/dbimysql_test'  if $run_mysql_tests

data/tests/config.rb

@@ -0,0 +1,34 @@
+# Set to true to run tests or Oracle
+$run_oracle_tests  = true
+
+ORA_RUNTIME_CLASS = Rubernate::DBI::OracleRuntime
+ORA_DB_URL        = 'dbi:OCI8:dbg91'
+ORA_DB_USER       = 'netcracker65'
+ORA_DB_PWD        = 'netcracker65'
+
+# Set to true to run tests on MySQL
+$run_mysql_tests     = true
+
+MYSQL_RUNTIME_CLASS = Rubernate::DBI::MySqlRuntime
+MYSQL_DB_URL        = 'dbi:Mysql:rubernate_db:localhost'
+MYSQL_DB_USER       = nil
+MYSQL_DB_PWD        = nil
+
+# Log4r configuration
+$level = Log4r::DEBUG
+$outputter = Log4r::FileOutputter.new 'file', 
+    :filename => File.dirname(__FILE__) + "/../logs/#{$0}.log",
+    :trunc => true
+
+# TODO: make external log configuration
+# Update level for all logs needed
+module Rubernate
+  Log.add $outputter
+  Log.level = $level
+  class Runtime
+    Log.level = $level
+  end
+  module Queries
+    Log.level = $level
+  end
+end

data/tests/rubernate/callbacks_test.rb

@@ -0,0 +1,120 @@
+$:.unshift(File.expand_path('../..', __FILE__)) unless 
+  $:.include?(File.expand_path('../..', __FILE__))
+
+require 'rubernate/fixtures'
+
+module Rubernate
+  module Callbacks
+    Event = Struct.new :object, :property, :old_value, :new_value
+    class << self
+      attr_accessor :handlers, :events
+      def clear
+        self.handlers, self.events = [], []         
+      end
+    end
+    clear
+    
+    # This module contains callback methods and included in module Rubernate::Entity
+    module Entity
+      def on_create
+        Callbacks.handlers << :on_create
+        Callbacks.events << Event.new(self)
+      end
+      
+      def on_remove
+        Callbacks.handlers << :on_remove
+        Callbacks.events << Event.new(self)
+      end
+      
+      def on_save
+        Callbacks.handlers << :on_save
+        Callbacks.events << Event.new(self)
+      end
+      
+      def on_load
+        Callbacks.handlers << :on_load
+        Callbacks.events << Event.new(self)
+      end
+      
+      def on_change property, old_value, new_value
+        Callbacks.handlers << :on_change
+        Callbacks.events << Event.new(self, property, old_value, new_value)
+      end
+      
+      def on_modify property, old_value, new_value
+        Callbacks.handlers << :on_modify
+        Callbacks.events << Event.new(self, property, old_value, new_value)
+      end
+    end
+    
+    # This module contains callback method and included in module Rubernate::Runtime
+    module Runtime
+      def self.def_callback name
+        module_eval %{
+          def #{name} *params
+            Callbacks.handlers << :#{name}
+          end
+        }
+      end
+      %w{on_begin on_rollback 
+        before_commit after_commit
+        before_flush  after_flush
+      }.each {|name| def_callback name}
+    end
+  end
+
+  class CallbacksTest < Test::Unit::TestCase
+    include Rubernate
+    include FixtureClasses
+
+    def setup
+      @factory = Rubernate::Memory::RuntimeFactory.new
+      @runtime = @factory.create
+      Rubernate.runtime_factory = @factory
+      Callbacks.clear
+    end
+    
+    def teardown
+      Callbacks.clear
+    end
+    
+    def test_create_callbacks
+      o = nil
+      Rubernate.session {o = C1.new.attach}
+      assert_equal [:on_begin, :on_create, :before_commit, :before_flush, :after_commit], Callbacks.handlers
+      assert_equal o, Callbacks.events[0].object
+    end
+    
+    def test_remove_callbacks
+      Rubernate.session {o = C3.new.attach; o.remove!}
+      assert_equal [:on_begin, :on_create, :on_remove, :before_commit, :before_flush, :after_commit], Callbacks.handlers
+    end
+    
+    def test_load_callbacks
+      pk = nil
+      Rubernate.session {o = C1.new.attach; pk = o.primary_key}
+      Callbacks.handlers.clear
+      Rubernate.session {o = find_by_pk pk}
+      assert_equal [:on_begin, :on_load, :before_commit, :before_flush, :after_commit],  Callbacks.handlers
+    end
+    
+    def test_save_change_callback
+      Rubernate.session {o = C1.new.attach; o.p1 = 'v1'}
+      assert_equal [:on_begin,  :on_create, :on_change, 
+        :before_commit, :before_flush,  :on_save, :after_flush, :after_commit], Callbacks.handlers
+      assert_equal :p1, Callbacks.events[1].property
+      assert_nil Callbacks.events[1].old_value
+      assert_equal 'v1', Callbacks.events[1].new_value
+    end
+    
+    def test_modify_callbacks
+      pk = nil
+      Rubernate.session {o = C1.new.attach; o.p1 = [o]; pk = o.primary_key}
+      Callbacks.clear
+      Rubernate.session {o = find_by_pk pk; o.p1 << o}
+      assert_equal [:on_begin, :on_load, :before_commit,
+        :on_modify, :on_modify, :before_flush, :on_save,
+        :after_flush, :after_commit], Callbacks.handlers
+    end
+  end
+end

data/tests/rubernate/fixtures.rb

@@ -0,0 +1,27 @@
+$:.unshift(File.expand_path('../..', __FILE__)) unless 
+  $:.include?(File.expand_path('../..', __FILE__))
+$:.unshift File.dirname(__FILE__) + '/../../lib'
+
+require 'rubernate'
+require 'rubernate/impl/memory'
+require 'test/unit'
+
+module FixtureClasses
+  class C0; attr :p0, false end
+  class C1; persistent :p1; end
+  class C2 < C1; persistent :p2; end
+  class C3 < C0; 
+    persistent :p0
+    def on_load
+      Thread.current[:on_load] = self
+    end
+    def on_save
+      Thread.current[:on_save] = self
+    end        
+  end
+  class C4 < C2
+    def initialize pk = nil 
+      @primary_key = pk
+    end
+  end 
+end