Rubernate 0.1.1 → 0.1.2

data/lib/rubernate/impl/dbigeneric.rb

@@ -23,11 +23,11 @@ module DBI
   
   TimeType = ::DBI::Timestamp
   
-  # Represents factory for +Runtime+ implementors.
-  class RuntimeFactory
-    # Accepts Runtime impl. class, database url, user name, and user password
-    def initialize klass, db_url, db_user, db_password
-      @klass, @db_url, @db_user, @db_password = klass, db_url, db_user, db_password
+  # Holds configuration information and serves as factory for Runtime objects.
+  class Configuration
+    # Accepts Runtime impl class,  db initializer class, database url, user name, and user password
+    def initialize klass, init, db_url, db_user, db_password
+      @klass, @init, @db_url, @db_user, @db_password = klass, init, db_url, db_user, db_password
       # @params = {'AutoCommit' => false} #TODO: refine  
     end
         
@@ -43,6 +43,11 @@ module DBI
       ::DBI.connect(@db_url, @db_user, @db_password, @params) { |dbh| yield dbh }
     end
     
+    # Intialize databae.
+    def init_db
+      connect {|dbh| @init.init_db dbh}
+    end
+    
     def to_s
       "runtime impl: #{@klass}, db_url: #{@db_url}, db_user: #{@db_user}, db_password: #{@db_password}"
     end    
@@ -54,10 +59,10 @@ module DBI
   class Runtime < Rubernate::Runtime
     include DBI
     
-    # Parameters are deleted automatically with corresponding r_object records    
-    #DELETE_PARAMS = <<-SQL    
-    #    DELETE FROM R_PARAMS WHERE OBJECT_PK = ? 
-    #    SQL
+    # In some implementations parameters are deleted automatically with corresponding r_object records    
+    DELETE_PARAMS = <<-SQL    
+        DELETE FROM R_PARAMS WHERE OBJECT_PK = ? 
+        SQL
     DELETE_PARAMS_FOR = <<-SQL    
         DELETE FROM R_PARAMS WHERE OBJECT_PK IN 
         SQL

data/lib/rubernate/impl/dbimysql.rb

@@ -23,6 +23,6 @@ module DBI
       object.peer.dirty = true
       object.primary_key
     end            
-  end  
+  end
 end
 end

data/lib/rubernate/impl/dbioracle.rb

@@ -9,13 +9,7 @@ module DBI
     CREATE_PEER = <<-SQL
         INSERT INTO R_OBJECTS (OBJECT_PK, OBJECT_CLASS) values (?, ?)
         SQL
-  
-    # TODO: make it work
-    def initialize dbh
-      super
-      dbh.do "ALTER session SET nls_date_format = 'YYYY/MM/DD HH24:MI:SS'"
-    end
-        
+          
     # Creates record in r_objects for specified object
     def create object
       object.peer = Rubernate::Peer.new

data/lib/rubernate/impl/memory.rb

@@ -31,7 +31,7 @@ module Memory
     end
   end
   
-  class RuntimeFactory
+  class Configuration
     attr_accessor :database
     def initialize
       @pk, @database = 1001, {}

data/lib/rubernate/init/init_mysql.rb

@@ -0,0 +1,71 @@
+require 'erb'
+
+module Rubernate
+module DBI
+  class MySqlInit
+    CREATE_R_OBJECTS = %q{
+        CREATE TABLE R_OBJECTS (
+          OBJECT_PK       INTEGER(20)     PRIMARY KEY AUTO_INCREMENT,
+          OBJECT_CLASS    VARCHAR(100)    NOT NULL) ENGINE=InnoDB;
+        }.gsub(/^        /, '')
+    
+    CREATE_R_PARAMS = %q{
+        CREATE TABLE R_PARAMS (
+            OBJECT_PK       INTEGER(20)     NOT NULL,
+            NAME            VARCHAR(100)    NOT NULL,
+            FLAGS           INTEGER(5)      NOT NULL,
+            INT_VALUE       INTEGER(20),
+            FLT_VALUE       FLOAT,
+            STR_VALUE       VARCHAR(255),
+            DAT_VALUE       DATETIME,
+            REF_VALUE       INTEGER(20),
+          CONSTRAINT R_PARAM_FK FOREIGN KEY (OBJECT_PK) REFERENCES R_OBJECTS(OBJECT_PK) ON DELETE CASCADE,
+          CONSTRAINT R_REF_FK   FOREIGN KEY (REF_VALUE) REFERENCES R_OBJECTS(OBJECT_PK) ON DELETE CASCADE)  ENGINE=InnoDB;
+        }.gsub(/^        /, '')
+    CREATE_INDEX_O_PK_CLASS = %q{
+        CREATE INDEX R_O_PK_CLASS ON R_OBJECTS (OBJECT_PK   ASC, OBJECT_CLASS);
+        }.gsub(/^        /, '')
+    CREATE_INDEX_P_PK_NAME  = %q{
+        CREATE INDEX R_P_PK_NAME ON R_PARAMS (OBJECT_PK   ASC, NAME);
+        }.gsub(/^        /, '')
+        
+    TEMPLATE = %q{
+        #
+        # Creates Rubernate tables for MySQL database.
+        # Copyright (C) 2006 Andrey Ryabov <andrey_ryabov@bk.ru>
+        #
+        
+        # Uncomment following if you want to create database named rubernate_db
+        # CREATE DATABASE RUBERNATE_DB;
+        #   USE RUBERNATE_DB;
+
+        # Create r_objects table <%= CREATE_R_OBJECTS %>
+        # Create r_params table  <%= CREATE_R_PARAMS %>
+        # Create index on r_objects <%= CREATE_INDEX_O_PK_CLASS %>
+        # Create index on r_params  <%= CREATE_INDEX_P_PK_NAME %>
+        #
+        # End        
+        #         
+        }.gsub(/^        /, '')
+    
+    # Prints initialization script and tryes to initialize databaes database if dbh is given.
+    def self.init_db dbh=nil
+      puts ERB.new(TEMPLATE).result(binding)
+      if dbh
+        puts "\nInitializing database ... "
+        puts "Creation of r_objects          - #{exec_ddl dbh, CREATE_R_OBJECTS}"
+        puts "Creation of r_params           - #{exec_ddl dbh, CREATE_R_PARAMS}"
+        puts "Creation of index on r_objects - #{exec_ddl dbh, CREATE_INDEX_O_PK_CLASS}"
+        puts "Creation of index on r_params  - #{exec_ddl dbh, CREATE_INDEX_P_PK_NAME}"           
+      end
+    end
+    
+    def self.exec_ddl dbh, stat
+      dbh.do stat
+      'done'
+      rescue Exception => e
+        "failed: #{e}"
+    end    
+  end
+end
+end

data/lib/rubernate/init/init_oracle.rb

@@ -0,0 +1,88 @@
+require 'erb'
+
+module Rubernate
+module DBI
+  class OracleInit
+  CREATE_R_OBJECTS = %q{
+        CREATE TABLE R_OBJECTS (
+          OBJECT_PK       NUMBER(20)      PRIMARY KEY,
+          OBJECT_CLASS    VARCHAR2(100)   NOT NULL) 
+        }.gsub(/^        /, '')
+    
+    CREATE_R_PARAMS = %q{
+        CREATE TABLE R_PARAMS (
+            OBJECT_PK       NUMBER(20)    NOT NULL,
+            NAME            VARCHAR2(100) NOT NULL,
+            FLAGS           NUMBER(5)     NOT NULL,
+            INT_VALUE       NUMBER(20),
+            FLT_VALUE       FLOAT,
+            STR_VALUE       VARCHAR2(1000),
+            DAT_VALUE       DATE,
+            REF_VALUE       NUMBER(20),
+          CONSTRAINT R_PARAM_FK FOREIGN KEY (OBJECT_PK) REFERENCES R_OBJECTS(OBJECT_PK) ON DELETE CASCADE,
+          CONSTRAINT R_REF_FK   FOREIGN KEY (REF_VALUE) REFERENCES R_OBJECTS(OBJECT_PK) ON DELETE CASCADE)    
+        }.gsub(/^        /, '')
+    CREATE_INDEX_O_PK_CLASS = %q{
+        CREATE INDEX R_O_PK_CLASS ON R_OBJECTS (OBJECT_PK   ASC, OBJECT_CLASS)
+        }.gsub(/^        /, '')
+    CREATE_INDEX_P_PK_NAME  = %q{
+        CREATE INDEX R_P_PK_NAME ON R_PARAMS (OBJECT_PK   ASC, NAME)
+        }.gsub(/^        /, '')
+    CREATE_R_PK_SEQUENCE = %q{
+        CREATE SEQUENCE R_PK_SEQUENCE START WITH 1001 INCREMENT BY 1
+        }.gsub(/^        /, '')
+        
+    TEMPLATE = %q{
+        /**
+         * Creates Rubernate tables for Oracle database.
+         * Copyright (C) 2006 Andrey Ryabov <andrey_ryabov@bk.ru>
+         */
+        
+        /**
+         * Create r_objects table 
+         */ <%= CREATE_R_OBJECTS %>/
+        
+        /**
+         * Create r_params table  
+         */ <%= CREATE_R_PARAMS %>/
+        
+        /**
+         * Create index on r_objects 
+         */ <%= CREATE_INDEX_O_PK_CLASS %>/
+        
+        /**
+         * Create index on r_params  
+         */ <%= CREATE_INDEX_P_PK_NAME %>/
+
+        /**
+         * Create primary key sequence
+         */ <%= CREATE_R_PK_SEQUENCE %>/
+
+         
+        /**
+         * End
+         */
+        }.gsub(/^        /, '')
+    
+    # Prints initialization script and tryes to initialize databaes database if dbh is given.
+    def self.init_db dbh=nil
+      puts ERB.new(TEMPLATE).result(binding)
+      if dbh
+        puts "\nInitializing database ... "
+        puts "Creation of r_objects          - #{exec_ddl dbh, CREATE_R_OBJECTS}"
+        puts "Creation of r_params           - #{exec_ddl dbh, CREATE_R_PARAMS}"
+        puts "Creation of index on r_objects - #{exec_ddl dbh, CREATE_INDEX_O_PK_CLASS}"
+        puts "Creation of index on r_params  - #{exec_ddl dbh, CREATE_INDEX_P_PK_NAME}"
+        puts "Creation of pk sequence        - #{exec_ddl dbh, CREATE_R_PK_SEQUENCE}"
+      end
+    end
+    
+    def self.exec_ddl dbh, stat
+      dbh.do stat
+      'done'
+      rescue Exception => e
+        "failed: #{e}"
+    end    
+  end
+end
+end

data/lib/rubernate.rb

@@ -33,6 +33,8 @@ require 'rubernate/queries'
 require 'rubernate/impl/memory'
 require 'rubernate/impl/dbimysql' 
 require 'rubernate/impl/dbioracle'
+require 'rubernate/init/init_mysql'
+require 'rubernate/init/init_oracle'
 
 
 
@@ -44,11 +46,11 @@ module Rubernate
 
   # Rubernate core singelton methods.
   class << self
-    # Allows you setup Rubernate by yours implementaion of RuntimeFactory.
+    # Allows you setup Rubernate by yours implementaion of Configuration.
     # See also method config
-    def runtime_factory= factory
-      Log.info "Rubernate configured by #{factory}"
-      @runtime_factory = factory
+    def configuration= config
+      Log.info "Rubernate configured by #{config}"
+      @factory = config
     end
   
     # Performs configuration of Rubernate.
@@ -57,12 +59,17 @@ module Rubernate
     #   * 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
+      impl, init = case db
+        when :mysql:  [DBI::MySqlRuntime, DBI::MySqlInit]
+        when :oracle: [DBI::OracleRuntime, DBI::OracleInit]
         else raise "Database #{db} not supported" 
       end     
-      self.runtime_factory = DBI::RuntimeFactory.new impl, url, user, password
+      self.configuration = DBI::Configuration.new impl, init, url, user, password
+    end
+    
+    # Intializes database - creates necessary tables, sequences and indices.
+    def init_db
+      @factory.init_db
     end
     
     # Returns Runtime object associated with current session 
@@ -78,7 +85,7 @@ module Rubernate
     
     # Begins new Rubernate session
     def session
-      runtime = @runtime_factory.create
+      runtime = @factory.create
       Thread.current[:Rubernate] = runtime
       runtime.begin
       return runtime unless block_given?

data/tests/config.rb

@@ -1,5 +1,5 @@
 # Set to true to run tests or Oracle
-$run_oracle_tests  = false
+$run_oracle_tests  = true
 
 ORA_RUNTIME_CLASS = Rubernate::DBI::OracleRuntime
 ORA_DB_URL        = 'dbi:OCI8:dbg91'
@@ -7,7 +7,7 @@ ORA_DB_USER       = 'netcracker65'
 ORA_DB_PWD        = 'netcracker65'
 
 # Set to true to run tests on MySQL
-$run_mysql_tests     = false
+$run_mysql_tests     = true
 
 MYSQL_RUNTIME_CLASS = Rubernate::DBI::MySqlRuntime
 MYSQL_DB_URL        = 'dbi:Mysql:rubernate_db:localhost'

data/tests/rubernate/callbacks_test.rb

@@ -68,9 +68,9 @@ module Rubernate
     include FixtureClasses
 
     def setup
-      @factory = Rubernate::Memory::RuntimeFactory.new
+      @factory = Rubernate::Memory::Configuration.new
       @runtime = @factory.create
-      Rubernate.runtime_factory = @factory
+      Rubernate.configuration = @factory
       Callbacks.clear
     end
     

data/tests/rubernate/impl/dbigeneric_stub.rb

@@ -13,7 +13,7 @@ module DBI::GenericTests
   include FixtureClasses
   
   def init rt_class, db_url, db_user, db_password
-    @factory = RuntimeFactory.new rt_class, db_url, db_user, db_password
+    @factory = Configuration.new rt_class, nil, db_url, db_user, db_password
     @factory.connect {|dbh| 
       dbh.do 'delete from r_params'
       dbh.do 'delete from r_objects'
@@ -403,13 +403,13 @@ module GenericRuntimeTests
   include FixtureClasses
   
   def init rt_class, db_url, db_user, db_password
-    @factory = RuntimeFactory.new rt_class, db_url, db_user, db_password
+    @factory = Configuration.new rt_class, nil, db_url, db_user, db_password
     @factory.connect {|dbh| 
       dbh.do 'delete from r_params'
       dbh.do 'delete from r_objects'
       dbh.commit
     }
-    Rubernate.runtime_factory = @factory
+    Rubernate.configuration = @factory
     Thread.current[:on_save] = Thread.current[:on_load] = nil
   end
   

data/tests/rubernate/impl/memory_test.rb

@@ -9,9 +9,9 @@ class Rubernate::Memory::RuntimeTest < Test::Unit::TestCase
   include FixtureClasses
   
   def setup
-    @factory = RuntimeFactory.new
+    @factory = Configuration.new
     @runtime = @factory.create
-    Rubernate.runtime_factory = @factory
+    Rubernate.configuration = @factory
   end
   
   # Runtime Interface Tests

data/tests/rubernate/rubernate_test.rb

@@ -14,9 +14,9 @@ class Rubernate::RubernateTest < Test::Unit::TestCase
   include Rubernate::DBI
   
   def setup
-    @factory = Rubernate::Memory::RuntimeFactory.new
+    @factory = Rubernate::Memory::Configuration.new
     @runtime = @factory.create
-    Rubernate.runtime_factory = @factory
+    Rubernate.configuration = @factory
     Thread.current[:on_save] = Thread.current[:on_load] = nil
   end
   
@@ -244,9 +244,9 @@ class Rubernate::BaseRuntimeTest < Test::Unit::TestCase
   include FixtureClasses
   
   def setup
-    @factory = Rubernate::Memory::RuntimeFactory.new
+    @factory = Rubernate::Memory::Configuration.new
     @runtime = @factory.create
-    Rubernate.runtime_factory = @factory
+    Rubernate.configuration = @factory
     Thread.current[:on_save] = Thread.current[:on_load] = nil
   end    
   

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: Rubernate
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2006-03-07 00:00:00 +03:00
+  version: 0.1.2
+date: 2006-03-10 00:00:00 +03:00
 summary: Object-oriented storage for Ruby objects based on relational database model
 require_paths: 
 - lib
@@ -28,13 +28,12 @@ cert_chain:
 authors: 
 - Andrey Ryabov
 files: 
-- db/mysql.sql
-- db/oracle.sql
 - lib/rubernate
 - lib/rubernate.rb
 - lib/rubernate/callbacks.rb
 - lib/rubernate/entity.rb
 - lib/rubernate/impl
+- lib/rubernate/init
 - lib/rubernate/mixins.rb
 - lib/rubernate/peer.rb
 - lib/rubernate/queries.rb
@@ -43,6 +42,8 @@ files:
 - lib/rubernate/impl/dbimysql.rb
 - lib/rubernate/impl/dbioracle.rb
 - lib/rubernate/impl/memory.rb
+- lib/rubernate/init/init_mysql.rb
+- lib/rubernate/init/init_oracle.rb
 - tests/all_tests.rb
 - tests/config.rb
 - tests/README

data/db/mysql.sql

@@ -1,36 +0,0 @@
-/**
- * Creates Rubernate tables for MySQL database.
- * Copyright (C) 2006 Andrey Ryabov <andrey_ryabov@bk.ru>
- */
-
-# Creates database named rubernate_db change name and uncomment if necessary
-#   CREATE DATABASE RUBERNATE_DB;
-#   USE RUBERNATE_DB;
-
-
-DROP TABLE IF EXISTS R_PARAMS;
-DROP TABLE IF EXISTS R_OBJECTS;
-
-CREATE TABLE R_OBJECTS (
-    OBJECT_PK       INTEGER(20)     PRIMARY KEY AUTO_INCREMENT,
-    OBJECT_CLASS    VARCHAR(100)    NOT NULL) ENGINE=InnoDB;
-
-CREATE TABLE R_PARAMS (
-    OBJECT_PK       INTEGER(20)     NOT NULL,
-    NAME            VARCHAR(100)    NOT NULL,
-    FLAGS           INTEGER(5)      NOT NULL,
-    INT_VALUE       INTEGER(20),
-    FLT_VALUE       FLOAT,
-    STR_VALUE       VARCHAR(255),
-    DAT_VALUE       DATETIME,
-    REF_VALUE       INTEGER(20),
-  CONSTRAINT R_PARAM_FK FOREIGN KEY (OBJECT_PK) REFERENCES R_OBJECTS(OBJECT_PK) ON DELETE CASCADE,
-  CONSTRAINT R_REF_FK   FOREIGN KEY (REF_VALUE) REFERENCES R_OBJECTS(OBJECT_PK) ON DELETE CASCADE)  ENGINE=InnoDB;
-
-CREATE INDEX R_O_PK_CLASS ON R_OBJECTS (OBJECT_PK   ASC, OBJECT_CLASS);
-CREATE INDEX R_P_PK_NAME ON R_PARAMS (OBJECT_PK   ASC, NAME);
-
-
-/**
- * End
- */

data/db/oracle.sql

@@ -1,30 +0,0 @@
-/**
- * Creates Rubernate tables for Oracle database.
- * Copyright (C) 2006 Andrey Ryabov <andrey_ryabov@bk.ru>
- */
-
-CREATE TABLE R_OBJECTS (
-    OBJECT_PK       NUMBER(20)      PRIMARY KEY,
-    OBJECT_CLASS    VARCHAR2(100)   NOT NULL) 
-/
-CREATE TABLE R_PARAMS (
-    OBJECT_PK       NUMBER(20)    NOT NULL,
-    NAME            VARCHAR2(100) NOT NULL,
-    FLAGS           NUMBER(5)     NOT NULL,
-    INT_VALUE       NUMBER(20),
-    FLT_VALUE       FLOAT,
-    STR_VALUE       VARCHAR2(1000),
-    DAT_VALUE       DATE,
-    REF_VALUE       NUMBER(20),
-  CONSTRAINT R_PARAM_FK FOREIGN KEY (OBJECT_PK) REFERENCES R_OBJECTS(OBJECT_PK) ON DELETE CASCADE,
-  CONSTRAINT R_REF_FK   FOREIGN KEY (REF_VALUE) REFERENCES R_OBJECTS(OBJECT_PK) ON DELETE CASCADE)
-/
-CREATE INDEX R_O_PK_CLASS ON R_OBJECTS (OBJECT_PK   ASC, OBJECT_CLASS)
-/
-CREATE INDEX R_P_PK_NAME ON R_PARAMS (OBJECT_PK   ASC, NAME)
-/
-CREATE SEQUENCE R_PK_SEQUENCE START WITH 1001 INCREMENT BY 1
-/
-/**
- * End
- */