og 0.10.0 → 0.11.0

data/lib/og/adapter.rb

@@ -1,13 +1,13 @@
 # * George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: adapter.rb 255 2005-02-10 12:45:32Z gmosx $
+# $Id: adapter.rb 266 2005-02-28 14:50:48Z gmosx $
 
 require 'yaml'
 require 'singleton'
 
 require 'og/connection'
 
-class Og
+module Og
 
 # An adapter communicates with the backend datastore. 
 # The adapters for all supported datastores extend this 
@@ -74,6 +74,7 @@ class Adapter
 	# TODO: Optimize this
 	
 	def self.parse_timestamp(str)
+		return nil unless str
 		return Time.parse(str)		
 	end
 	
@@ -108,7 +109,7 @@ class Adapter
 	end
 
 	# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
-	# :section: OR mapping methods and utilities. 
+	# :section: O->R mapping methods and utilities. 
 	# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 
 	# Encode the name of the klass as an sql safe string.
@@ -121,24 +122,40 @@ class Adapter
 	end
 
 	# The name of the SQL table where objects of this class 
-	# are stored.
+	# are stored. A prefix is needed to avoid colision with
+	# reserved prefices (for example User maps to user which
+	# is reserved in postgresql). The prefix should start
+	# with an alphanumeric character to be compatible with
+	# all RDBMS (most notable Oracle).
+	#
+	# You may want to override this method to map an existing
+	# database schema using Og.
 	
 	def self.table(klass)
-		"_#{Og.table_prefix}#{encode(klass)}"
+		"og_#{Og.table_prefix}#{encode(klass)}"
 	end
 
 	# The name of the join table for the two given classes.
+	# A prefix is needed to avoid colision with reserved 
+	# prefices (for example User maps to user which
+	# is reserved in postgresql). The prefix should start
+	# with an alphanumeric character to be compatible with
+	# all RDBMS (most notable Oracle).
+	#
+	# You may want to override this method to map an existing
+	# database schema using Og.
 	
 	def self.join_table(klass1, klass2)
-		"_#{Og.table_prefix}j_#{encode(klass1)}_#{encode(klass2)}"
+		"og_#{Og.table_prefix}j_#{encode(klass1)}_#{encode(klass2)}"
 	end
-	
+
 	# Return an sql string evaluator for the property.
 	# No need to optimize this, used only to precalculate code.
 	# YAML is used to store general Ruby objects to be more 
 	# portable.
-	#
+	#--
 	# FIXME: add extra handling for float.
+	#++
 	
 	def write_prop(p)
 		if p.klass.ancestors.include?(Integer)
@@ -146,7 +163,7 @@ class Adapter
 		elsif p.klass.ancestors.include?(Float)
 			return "#\{@#{p.symbol} || 'NULL'\}"		
 		elsif p.klass.ancestors.include?(String)
-			return "'#\{#{self.class}.escape(@#{p.symbol})\}'"
+			return %|#\{@#{p.symbol} ? "'#\{#{self.class}.escape(@#{p.symbol})\}'" : 'NULL'\}|
 		elsif p.klass.ancestors.include?(Time)
 			return %|#\{@#{p.symbol} ? "'#\{#{self.class}.timestamp(@#{p.symbol})\}'" : 'NULL'\}|
 		elsif p.klass.ancestors.include?(Date)
@@ -154,6 +171,7 @@ class Adapter
 		elsif p.klass.ancestors.include?(TrueClass)
 			return "#\{@#{p.symbol} ? \"'t'\" : 'NULL' \}"
 		else 
+			# gmosx: keep the '' for nil symbols.
 			return %|#\{@#{p.symbol} ? "'#\{#{self.class}.escape(@#{p.symbol}.to_yaml)\}'" : "''"\}|
 		end
 	end		
@@ -197,9 +215,18 @@ class Adapter
 				field << " #{p.meta[:sql]}"
 			else
 				field << " #{@typemap[p.klass]}"
-				# attach extra sql
-				if p.meta and extra_sql = p.meta[:extra_sql]
-					field << " #{extra_sql}"
+				
+				if p.meta
+					# set default value (gmosx: not that useful in the
+					# current implementation).
+					if default = p.meta[:default]
+						field << " DEFAULT #{default.inspect} NOT NULL"
+					end
+					
+					# attach extra sql
+					if extra_sql = p.meta[:extra_sql]
+						field << " #{extra_sql}"
+					end
 				end
 			end
 			
@@ -235,7 +262,7 @@ class Adapter
 	# object properties.
 	
 	def calc_field_index(klass, og)
-		raise 'Not implemented!'
+		# Implement if needed.
 	end
 
 	# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 

data/lib/og/adapters/filesys.rb

@@ -0,0 +1,121 @@
+# * George Moschovitis  <gm@navel.gr>
+# (c) 2004-2005 Navel, all rights reserved.
+# $Id: filesys.rb 264 2005-02-23 13:46:55Z gmosx $
+
+require 'fileutils'
+
+require 'og/adapter'
+require 'og/connection'
+require 'glue/attribute'
+
+module Og
+
+# The Filesys adapter. This adapter stores Og objectes in
+# the filesystem. This adapter is a proof of concept and
+# at the moment severely limited. For extra documentation 
+# see lib/og/adapter.rb
+
+class FilesysAdapter < Adapter
+
+	# Creates the name of the database root dir.
+
+	def self.dir(database)
+		"#{database}_db"
+	end
+
+	def create_db(database, user = nil, password = nil)
+		begin
+			FileUtils.mkdir_p(self.class.dir(database))
+		rescue
+			Logger.error "Cannot create '#{database}'!"
+		end
+	end
+
+	def drop_db(database, user = nil, password = nil)
+		begin
+			FileUtils.rmdir(self.class.dir(database))	
+			super
+		rescue
+			Logger.error "Cannot drop '#{database}'!"
+		end
+	end
+
+	def insert_code(klass, db, pre_cb, post_cb)
+		props = props_for_insert(klass)
+		values = props.collect { |p| write_prop(p) }.join(',') 
+		
+		sql = "INSERT INTO #{klass::DBTABLE} (#{props.collect {|p| p.name}.join(',')}) VALUES (#{values})"
+
+		%{
+			#{pre_cb}
+			conn.store.query("#{sql}").close
+			@oid = conn.store.last_insert_row_id
+			#{post_cb}
+		}
+	end
+
+	def new_connection(db)
+		return FilesysConnection.new(db)
+	end
+
+	# A 'table' is emulated by using a directory to store
+	# one file per table row. Each file contains an object
+	# marshaled in YAML format. A special file called
+	# '_sequence' stores the sequence for this 'table'.
+	
+	def create_table(klass, db)
+		class_dir = File.join(self.class.dir(db.config[:database]), klass::DBTABLE)
+		FileUtils.mkdir_p(class_dir)
+		
+		seq_file = File.join(class_dir, 'seq')
+		File.open(seq_file, 'w') { |f| f << '1' }
+	rescue => ex
+		Logger.error "Cannot create directory to store '#{klass}' classes!"
+	end
+
+end
+
+# The Filesys adapter connection.
+
+class FilesysConnection < Connection
+
+	def initialize(db)
+		super
+		config = db.config
+
+		begin
+			raise unless File.directory?(FilesysAdapter.dir(config[:database]))
+		rescue => ex 
+			if true # ex.to_s =~ /database .* does not exist/i
+				Logger.info "Database '#{config[:database]}' not found!"
+				@db.adapter.create_db(config[:database], config[:user])
+				retry
+			end
+			raise
+		end
+	end
+
+	def save(obj)
+		seq = nil
+		class_dir = File.join(FilesysAdapter.dir(@db.config[:database]), obj.class::DBTABLE)
+		File.open(File.join(class_dir, 'seq'), 'r') { |f| seq = f.read.to_i }
+		obj.oid = seq
+		File.open(File.join(class_dir, "#{seq}.yml"), 'w') { |f| f << obj.to_yaml }
+		seq += 1
+		File.open(File.join(class_dir, 'seq'), 'w') { |f| f << seq }
+	end
+
+	def load(oid, klass)
+		obj = nil
+		class_dir = File.join(FilesysAdapter.dir(@db.config[:database]), klass::DBTABLE)
+		File.open(File.join(class_dir, "#{oid}.yml"), 'r') { |f| obj = YAML::load(f.read) }
+		return obj
+	end
+
+	def close
+		Logger.debug "Closed DB connection." if $DBG
+	end
+
+end
+
+end 

data/lib/og/adapters/mysql.rb

@@ -1,6 +1,6 @@
 # * George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: mysql.rb 259 2005-02-15 08:54:54Z gmosx $
+# $Id: mysql.rb 266 2005-02-28 14:50:48Z gmosx $
 
 require 'mysql'
 
@@ -8,7 +8,7 @@ require 'og/adapter'
 require 'og/connection'
 require 'glue/attribute'
 
-class Og
+module Og
 
 # The MySQL adapter. This adapter communicates with 
 # an MySQL rdbms. For extra documentation see 
@@ -18,7 +18,7 @@ class MysqlAdapter < Adapter
 
 	def initialize
 		super
-		@typemap.update({TrueClass => 'tinyint'})
+		@typemap.update(TrueClass => 'tinyint')
 	end
 	
 	def self.escape(str)
@@ -42,7 +42,7 @@ class MysqlAdapter < Adapter
 		elsif p.klass.ancestors.include?(Float)
 			return "#\{@#{p.symbol} || 'NULL'\}"		
 		elsif p.klass.ancestors.include?(String)
-			return "'#\{#{self.class}.escape(@#{p.symbol})\}'"
+			return %|#\{@#{p.symbol} ? "'#\{#{self.class}.escape(@#{p.symbol})\}'" : 'NULL'\}|
 		elsif p.klass.ancestors.include?(Time)
 			return %|#\{@#{p.symbol} ? "'#\{#{self.class}.timestamp(@#{p.symbol})\}'" : 'NULL'\}|
 		elsif p.klass.ancestors.include?(Date)
@@ -50,6 +50,7 @@ class MysqlAdapter < Adapter
 		elsif p.klass.ancestors.include?(TrueClass)
 			return "#\{@#{p.symbol} ? 1 : 0 \}"
 		else 
+			# gmosx: keep the '' for nil symbols.
 			return %|#\{@#{p.symbol} ? "'#\{#{self.class}.escape(@#{p.symbol}.to_yaml)\}'" : "''"\}|
 		end
 	end		
@@ -82,6 +83,10 @@ class MysqlAdapter < Adapter
 		super
 	end
 
+	def props_for_insert(klass)
+		klass.__props.reject { |p| :oid == p.symbol }
+	end
+
 	def insert_code(klass, db, pre_cb, post_cb)
 		props = props_for_insert(klass)
 		values = props.collect { |p| write_prop(p) }.join(',') 
@@ -98,7 +103,7 @@ class MysqlAdapter < Adapter
 	end
 
 	def new_connection(db)
-		return Og::MysqlConnection.new(db)
+		return MysqlConnection.new(db)
 	end
 
 	def calc_field_index(klass, db)

data/lib/og/adapters/oracle.rb

@@ -0,0 +1,374 @@
+# * Matt Bowen  <matt.bowen@farweststeel.com>
+# * George Moschovitis  <gm@navel.gr>
+# (c) 2004-2005 Navel, all rights reserved.
+# $Id: oracle.rb 266 2005-02-28 14:50:48Z gmosx $
+
+require 'oracle'
+
+require 'og/adapter'
+require 'og/connection'
+require 'glue/attribute'
+
+module Og
+
+# The Oracle adapter. This adapter communicates with 
+# an Oracle rdbms. For extra documentation see 
+# lib/og/adapter.rb
+
+class OracleAdapter < Adapter
+
+  def initialize
+    super
+    @typemap.update(
+      Integer => 'number',
+      Fixnum => 'number',
+      String => 'varchar2(512)',
+      TrueClass => 'number',
+      Object => 'varchar2(1024)',
+      Array => 'varchar2(1024)',
+      Hash => 'varchar2(1024)'
+    )
+  end
+
+  def self.timestamp(time = Time.now)
+    return nil unless time
+    return time.strftime("%Y-%m-%d %H:%M:%S")
+  end
+  
+  def self.date(date)
+    return nil unless date
+    return "#{date.year}-#{date.month}-#{date.mday}" 
+  end
+
+  def write_prop(p)
+    if p.klass.ancestors.include?(Integer)
+      return "#\{@#{p.symbol} || 'NULL'\}"
+    elsif p.klass.ancestors.include?(Float)
+      return "#\{@#{p.symbol} || 'NULL'\}"    
+    elsif p.klass.ancestors.include?(String)
+      return "'#\{#{self.class}.escape(@#{p.symbol})\}'"
+    elsif p.klass.ancestors.include?(Time)
+      return %|#\{@#{p.symbol} ? "'#\{#{self.class}.timestamp(@#{p.symbol})\}'" : 'NULL'\}|
+    elsif p.klass.ancestors.include?(Date)
+      return %|#\{@#{p.symbol} ? "'#\{#{self.class}.date(@#{p.symbol})\}'" : 'NULL'\}|
+    elsif p.klass.ancestors.include?(TrueClass)
+      return "#\{@#{p.symbol} ? \"1\" : 'NULL' \}"
+    else 
+      return %|#\{@#{p.symbol} ? "'#\{#{self.class}.escape(@#{p.symbol}.to_yaml)\}'" : "''"\}|
+    end
+  end   
+  
+	#--
+	# mcb:
+	# Unlike MySQL or Postgres, Oracle database/schema creation is a big deal. 
+	# I don't know how to do it from the command line. I use Oracle's Database 
+	# Configuration Assistant utility (dbca). I takes 30min - 1hr to create 
+	# a full blown schema. So, your FIXME comments are fine. I'm thinking you
+	# won't be able to do this via Og, but once created, Og will be able to create
+	# tables, indexes, and other objects.
+	#++
+
+  def create_db(database, user = nil, password = nil)
+    # FIXME: what is appropriate for oracle?
+    # `createdb #{database} -U #{user}`
+    super
+  end
+
+  def drop_db(database, user = nil, password = nil)
+    # FIXME: what is appropriate for oracle?
+    # `dropdb #{database} -U #{user}`
+    super
+  end
+
+  def insert_code(klass, db, pre_cb, post_cb)
+    props = props_for_insert(klass)
+    values = props.collect { |p| write_prop(p) }.join(',') 
+
+    sql = "INSERT INTO #{klass::DBTABLE} (#{props.collect {|p| p.name}.join(',')}) VALUES (#{values})"
+
+    %{
+      #{pre_cb}
+      res = conn.store.exec("SELECT #{klass::DBSEQ}.nextval FROM DUAL")
+      @oid = res.fetch[0].to_i
+      res.close
+      conn.exec "#{sql}"
+      #{post_cb}
+    }
+  end
+
+  def new_connection(db)
+    return OracleConnection.new(db)
+  end
+
+  def calc_field_index(klass, db)
+    # gmosx: This is incredible!!! argh!
+    # res = db.query "SELECT * FROM #{klass::DBTABLE} # LIMIT 1"
+    res = db.query "SELECT * FROM (SELECT * FROM #{klass::DBTABLE}) WHERE ROWNUM <= 1"
+    meta = db.managed_classes[klass]
+
+    columns = res.getColNames
+
+    for idx in (0...columns.size)
+      # mcb: Oracle will return column names in uppercase.
+      meta.field_index[columns[idx].downcase] = idx
+    end
+
+  ensure
+    res.close if res
+  end
+
+  def eval_og_oid(klass)
+    klass.class_eval %{
+      prop_accessor :oid, Fixnum, :sql => "number PRIMARY KEY"
+    }
+  end
+
+  def create_table(klass, db)
+    conn = db.get_connection
+
+    fields = create_fields(klass)
+
+    sql = "CREATE TABLE #{klass::DBTABLE} (#{fields.join(', ')}"
+    
+    # Create table constrains.
+    
+    if klass.__meta and constrains = klass.__meta[:sql_constrain]
+      sql << ", #{constrains.join(', ')}"
+    end
+
+		# mcb: Oracle driver chokes on semicolon.
+    sql << ")"
+
+  	# mcb:
+  	# Oracle driver appears to have problems executing multiple SQL 
+		# statements in single exec() call. Chokes with or without semicolon 
+		# delimiter. Solution: make separate calls for each statement.
+
+    begin
+      conn.store.exec(sql).close
+      Logger.info "Created table '#{klass::DBTABLE}'."
+      
+      # Create indices.
+
+      if klass.__meta and indices = klass.__meta[:sql_index]
+        for data in indices
+          idx, options = *data
+          idx = idx.to_s
+          pre_sql, post_sql = options[:pre], options[:post]
+          idxname = idx.gsub(/ /, "").gsub(/,/, "_").gsub(/\(.*\)/, "")
+          sql = " CREATE #{pre_sql} INDEX #{klass::DBTABLE}_#{idxname}_idx #{post_sql} ON #{klass::DBTABLE} (#{idx})"  
+          conn.store.exec(sql).close
+          Logger.info "Created index '#{klass::DBTABLE}_#{idxname}_idx'."          
+        end
+      end
+    rescue Exception => ex
+      # gmosx: any idea how to better test this?
+      if ex.to_s =~ /ORA-00955/i
+        Logger.debug 'Table or index already exists' if $DBG
+        return
+      else
+        raise
+      end
+    end
+
+    # Create the sequence for this table. 
+    begin
+      conn.store.exec("CREATE SEQUENCE #{klass::DBSEQ}").close
+      Logger.info "Created sequence '#{klass::DBSEQ}'."       
+    rescue Exception => ex
+      # gmosx: any idea how to better test this?
+      if ex.to_s =~ /ORA-00955/i
+        Logger.debug "Sequence already exists" if $DBG
+      else
+        raise
+      end
+    end
+
+    # Create join tables if needed. Join tables are used in
+    # 'many_to_many' relations.
+    
+    if klass.__meta and joins = klass.__meta[:sql_join] 
+      for data in joins
+        # the class to join to and some options.
+        join_class, options = *data
+        
+        # gmosx: dont use DBTABLE here, perhaps the join class
+        # is not managed yet.
+        join_table = "#{self.class.join_table(klass, join_class)}"
+        join_src = "#{self.class.encode(klass)}_oid"
+        join_dst = "#{self.class.encode(join_class)}_oid"
+        begin
+          conn.store.exec("CREATE TABLE #{join_table} ( key1 integer NOT NULL, key2 integer NOT NULL )").close
+          conn.store.exec("CREATE INDEX #{join_table}_key1_idx ON #{join_table} (key1)").close
+          conn.store.exec("CREATE INDEX #{join_table}_key2_idx ON #{join_table} (key2)").close
+        rescue Exception => ex
+          # gmosx: any idea how to better test this?
+          if ex.to_s =~ /ORA-00955/i
+            Logger.debug "Join table already exists" if $DBG
+          else
+            raise
+          end
+        end
+      end
+    end
+
+  ensure
+    db.put_connection
+  end
+
+  def drop_table(klass)
+    super
+    exec "DROP SEQUENCE #{klass::DBSEQ}"    
+  end
+
+  # Generate the property for oid.
+
+	#--
+	# mcb:
+	# Oracle doesn't have a "serial" datatype. Replace with 
+	# integer (which is probably just a synonym for NUMBER(38,0))
+	# A sequence is created automatically by Og.
+	#++
+
+  def eval_og_oid(klass)
+    klass.class_eval %{
+      prop_accessor :oid, Fixnum, :sql => 'integer PRIMARY KEY'
+    }
+  end
+end
+
+# The Oracle connection.
+
+class OracleConnection < Connection
+
+	# mcb:
+	# The database connection details are tucked away in a 
+	# TNS entry (Transparent Network Substrate) which specifies host, 
+	# port, protocol, and database instance. Here is a sample TNS 
+	# entry:
+	#
+	# File: tns_names.ora
+	#
+	# KBSID =
+	#  (DESCRIPTION =
+	#    (ADDRESS_LIST =
+	#      (ADDRESS = (PROTOCOL = TCP)(HOST = keebler.farweststeel.com)(PORT = 1521))
+	#    )
+	#    (CONNECT_DATA =
+	#      (SID = KBSID)
+	#    )
+	#  )
+
+  def initialize(db)
+    super
+    config = db.config
+
+    begin
+      # FIXME: how to pass address etc?
+      @store = Oracle.new(config[:user], config[:password], config[:database])
+			# gmosx: better use this???
+			# @store = Oracle.new(config[:tns])
+
+			# gmosx: does this work?
+			@store.autocommit = true
+    rescue Exception => ex
+  		# mcb:
+	 	 	# Oracle will raise a ORA-01017 if username, password, or 
+			# SID aren't valid. I verified this for all three.
+  		# irb(main):002:0> conn = Oracle.new('keebler', 'dfdfd', 'kbsid')
+  		# /usr/local/lib/ruby/site_ruby/1.8/oracle.rb:27:in `logon': ORA-01017: invalid username/password; logon denied (OCIError)
+      # gmosx:
+			# any idea how to better test this? an integer error id?
+      if ex.to_s =~ /ORA-01017/i     
+        Logger.info "Database '#{config[:database]}' not found!"
+        @db.adapter.create_db(config[:database], config[:user])
+        retry
+      end
+      raise
+    end
+  end
+
+  def close
+    @store.logoff
+    super
+  end
+
+  def query(sql)
+    Logger.debug sql if $DBG
+    begin
+      return @store.exec(sql)
+    rescue Exception => ex
+      Logger.error "DB error #{ex}, [#{sql}]"
+      Logger.error ex.backtrace.join("\n")
+      raise
+#      return nil
+    end
+  end
+
+  def exec(sql)
+    Logger.debug sql if $DBG
+    begin
+      @store.exec(sql)
+    rescue Exception => ex
+      Logger.error "DB error #{ex}, [#{sql}]"
+      Logger.error ex.backtrace.join("\n")
+      raise
+    end
+  end
+
+	def start
+		@store.autocommit = false
+	end
+	
+	def commit
+		@store.commit
+	ensure
+		@store.autocommit = true
+	end
+	
+	def rollback
+		@store.rollback
+	ensure
+		@store.autocommit = true
+	end
+
+  def valid_res?(res)
+    return !(res.nil?)
+  end
+
+  def read_one(res, klass)
+    return nil unless valid_res?(res)
+
+    row = res.fetch
+    return nil unless row
+
+    obj = klass.new
+    obj.og_read(row)
+
+    res.close
+    return obj
+  end
+
+  def read_all(res, klass)
+    return [] unless valid_res?(res)
+    objects = []
+
+    while row = res.fetch
+      obj = klass.new
+      obj.og_read(row)
+      objects << obj
+    end
+
+    res.close
+    return objects
+  end
+
+  def read_int(res, idx = 0)
+    val = res.fetch[idx].to_i
+    res.close
+    return val
+  end
+
+end
+
+end