og 0.14.0 → 0.15.0

data/CHANGELOG

@@ -1,5 +1,73 @@
+04-04-2005  George Moschovitis  <gm@navel.gr>
+
+	* examples/run.rb: small fix.
+
+	* test/og/mixins/tc_tree.rb: removed.
+
+	* test/og/mixins/tc_list.rb: removed.
+
+03-04-2005  George Moschovitis  <gm@navel.gr>
+
+	* doc/RELEASES: updated.
+
+	* lib/og/backend.rb: removed.
+
+	* test/og/mixins/tc_hierarchical: implemented,
+	dont use article.
+
+	* lib/og/mixins/orderable.rb: fixed 1=1 scope.
+
+	* lib/og/mixins/hierarchical.rb (Hierarchical): implemented,
+	(#add_child): implemented.
+	after some fixes, it works!!
+	fixed 1=1 scope.
+	added :root.
+	
+02-04-2005  George Moschovitis  <gm@navel.gr>
+	
+	* lib/og/typemacros.rb: small update.
+
+	* test/og/mixins/tc_hierarchical: introduced.
+
+	* lib/og/mixins/hierarchical.rb: introduced,
+	(Hierarchical): introduced,
+	(NestedSets): introduced, 
+	added enchant methods for nested sets.
+
+	* lib/og/mixins/tree.rb: deprecated.
+
+01-04-2005  George Moschovitis  <gm@navel.gr>
+
+	* lib/og/adapters/sqlserver.rb: small fixes.
+
+	* doc/README: updated.
+
+	* doc/RELEASES: updated.
+
+	* doc/AUTHORS: updated.
+
+01-04-2005  Anastasios Koutoumanos  <drak@navel.gr>
+
+	* lib/og/adapters/sqlserver.rb: implemented.
+
+	* test/og/tc_sqlserver.rb: implemented.
+
+31-03-2005  George Moschovitis  <gm@navel.gr>
+
+	* lib/og/mixins/orderable.rb: implemented using dynamic_include.
+
+	* lib/og/meta.rb: removed inclusion of Og::List.
+
+	* lib/og/mixins/list.rb: deprecated in favour of the superior implementation.
+
+31-03-2005  Anastasios Koutoumanos  <drak@navel.gr>
+
+	* lib/og/adapters/oracle.rb: removed duplicate eval_og_oid.
+
 28-03-2005  George Moschovitis  <gm@navel.gr>
 
+	* --- VERSION 0.14.0 ---
+
 	* test/og/mixins/tc_list.rb: implemented tests.
 
 	* lib/og/connection.rb (#delete): passs obj_or_oid to the callback.

data/README

@@ -1,4 +1,4 @@
-= Og 0.14.0
+= Og 0.15.0
 
 Og (ObjectGraph) is a powerfull object-relational mapping library. Og provides 
 transparent serialization of object graphs to a RDBMS 
@@ -27,10 +27,10 @@ The library provides the following features:
 
 + Object-Relational mapping.
 + Absolutely no configuration files.
-+ Multiple backend adapters (PostgreSQL, MySQL, SQLite).
++ Multiple backend adapters (PostgreSQL, MySQL, SQLite3, Oracle, SqlServer).
 + ActiveRecord-style meta language and db aware methods.
 + Automatially generates join-tables for many_to_many relations.
-+ Deserialize sql join queries to Ruby Objects.
++ Deserialize sql join queries to Ruby Objects (coming soon).
 + Serialize arbitrary ruby object graphs through YAML.
 + Connection pooling.
 + Thread safety.
@@ -38,18 +38,21 @@ The library provides the following features:
 + Lifecycle callbacks.
 + Lifecycle observers.
 + Transparent support for cascading deletes for all backends.
-+ Hierarchical structures (preorder traversal, materialized paths)
++ Dynamic db related mixins (Orderable, etc).
++ Hierarchical structures (nested sets, more coming soon).
 + Works safely as part of a distributed application.
 + Automatic Validation/Constraints.
 + Simple and clean implementation.
 
+
 == Download
 
 The latest version of Og can be found at
 
-* http://www.rubyforge.com/projects/nitro
+* http://nitro.rubyforge.org
 
-Documentation for Og can be found in the distribution.
+Documentation for Og can be found in the distribution. You can find
+a nice tutorial at www.rubygarden.com
 
 
 == Requirements
@@ -88,7 +91,7 @@ installed RubyGems on your system. Then run the following command:
 
 gem install og
 
-Then try to run the examples/og Example application.
+Then try to run the examples in the examples directory.
 
 A tar.gz distribution is also available on http://www.rubyforge.com/projects/nitro.
 
@@ -99,6 +102,12 @@ For any questions regarding Og, feel free to ask on the ruby-talk
 mailing list (which is mirrored to comp.lang.ruby) or contact 
 mailto:gm@navel.gr.
 
+An Og specific mailing list is also available. Please subscribe
+to nitro-general@rubyforge.com. The homepage for this list
+is available here:
+
+http://rubyforge.org/mailman/listinfo/nitro-general
+
 
 == Licence
 

data/doc/AUTHORS

@@ -6,17 +6,14 @@ MAIN DEVELOPER:
 	
 IDEAS, ADDITIONAL CODING, SUPPORT:
 
+* Anastasios Koutoumanos  <ak@navel.gr>
+	Design, additional coding.
+
 * Michael Neumann  <mneumann@ntecs.de>
 	Design, additional coding and bug reports.
 
 *	Matt Bowen  <matt.bowen@farweststeel.com>
 	Additional code and documentation.
 
-* Anastasios Koutoumanos  <ak@navel.gr>
-	Design, additional coding.
-
-* Elias Athanasopoulos  <elathan@navel.gr>
-	Additional coding.
-
 * Thomas Quas  <tquas@yahoo.com>
 	Ideas, bug reports, unit tests.

data/doc/RELEASES

@@ -1,10 +1,53 @@
+== Version 0.15.0 was released on 4/03/2005.
+
+A great release. Many cool new features and tons of subtle 
+improvements. We also welcome a new core developer, Anastastios 
+Koutoumanos, who started contributing with a new SqlServer adapter.
+
+Most notable additions:
+
+* NestedSets mixin:
+
+  class Comment
+		include NestedSets
+	end
+
+	or
+
+	class Comment
+		include Hierarchical, :method => :nested_sets
+	end
+
+	c.add_comment(child_comment)
+	c.full_children
+	c.direct_children
+	c.children
+ 
+	this is a reimplementation of the SqlTraversable mixin
+	available in older versions.
+ 
+* New implementation of Orderable mixin:
+
+  class Comment
+    property :body, String
+		belongs_to :article, Article
+    include Orderable, :scope => article
+  end
+
+  c.move_higher
+
+  The Orderable mixin uses the :scope parameter to dynamically alter
+  the methods appended to the Comment class. 
+ 
+* New SqlServer adapter.
+
 == Version 0.14.0 was released on 18/03/2005.
 
 Many many important fixes, and many small additions
 and improvements. Og mixins are introduced with
 an experimental List mixin implementation.
 
-Most notable addition:
+Most notable additions:
 
 * Support for objects that participate in list
  (ordering/removal etc)

data/examples/run.rb

@@ -221,7 +221,7 @@ Article.all.each { |a| puts a }
 # The previous command updates the whole object. It is used
 # when there are many updates or you dont care about speed. 
 # To update only specific fields use pupdate or properties_update
-a2.pupdate! "title='A specific title'"
+a2.pupdate "title='A specific title'"
 
 puts "\n\n"
 Article.all.each { |a| puts a }

data/lib/og.rb

@@ -1,6 +1,6 @@
 # * George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: og.rb 326 2005-03-28 11:07:17Z gmosx $
+# $Id: og.rb 340 2005-04-04 08:26:58Z gmosx $
 
 require 'glue'
 require 'glue/logger'
@@ -107,7 +107,7 @@ module Og
 
 	# The version.
 
-	Version = '0.14.0'
+	Version = '0.15.0'
 
 	# Library path.
 

data/lib/og/adapters/oracle.rb

@@ -1,7 +1,7 @@
 # * Matt Bowen  <matt.bowen@farweststeel.com>
 # * George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: oracle.rb 326 2005-03-28 11:07:17Z gmosx $
+# $Id: oracle.rb 337 2005-03-31 16:20:40Z gmosx $
 
 begin
 	require 'oracle'
@@ -123,12 +123,6 @@ class OracleAdapter < Adapter
     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
 

data/lib/og/adapters/sqlserver.rb

@@ -0,0 +1,360 @@
+# * Anastasios Koutoumanos  <ak@navel.gr>
+# (c) 2004-2005 Navel, all rights reserved.
+# $Id: sqlserver.rb 341 2005-04-04 08:28:54Z gmosx $
+
+begin
+	require 'dbi'
+rescue Object => ex
+	Logger.error 'Ruby-DBI bindings not present or ADO support not available.'
+	Logger.error ex
+end
+
+require 'glue/attribute'
+require 'og/adapter'
+require 'og/connection'
+
+module Og
+
+# The Microsoft SQL Server Sql Server adapter. This adapter 
+# communicates with a Microsoft SQL Server sql server rdbms. 
+# This adapter will ONLY work on Windows systems, since it 
+# relies on Win32OLE is apparently only available on Windows.
+# It relies on the ADO support in the DBI module. If you are using the
+# one-click installer of Ruby, then you already have DBI installed, but
+# the ADO module is *NOT* installed. You will need to get the latest
+# source distribution of Ruby-DBI from http://ruby-dbi.sourceforge.net/
+# unzip it, and copy the file <tt>src/lib/dbd_ado/ADO.rb</tt> to
+# <tt>X:/Ruby/lib/ruby/site_ruby/1.8/DBD/ADO/ADO.rb</tt> 
+# (you will need to create the ADO directory). Once you've installed 
+# that file, you are ready to go.
+# Originally based on the  sqlserver_adapter.rb -- the ActiveRecord 
+# adapter for Microsoft SQL Server by Joey Gibson and DeLynn Berry.
+# Information related to the SQL Server datatypes: 
+# http://msdn.microsoft.com/library/default.asp?url=/library/en-us/architec/8_ar_da_4ucz.asp
+# For extra documentation see lib/og/adapter.rb
+
+class SqlserverAdapter < Adapter
+
+	def initialize
+		super
+		@typemap.update(
+				Integer => 'int',           # drak: maybe smallint?
+				Fixnum => 'int', 
+				Float => 'float',
+				String => 'varchar(1024)',  # drak: maybe nvarchar for unicode
+				Time => 'datetime',         # drak: maybe smalldatime?
+				Date => 'smalldatetime',
+				TrueClass => 'bit'
+		)
+		
+		@typecast.update(TrueClass => "#\{:s: ? \'1\' : '0' \}")
+	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 read_prop(p, idx)			
+		if p.klass.ancestors.include?(Integer)
+			return "res[tuple][#{idx}].to_i"
+		elsif p.klass.ancestors.include?(Float)
+			return "res[tuple][#{idx}].to_f"
+		elsif p.klass.ancestors.include?(String)
+			return "res[tuple][#{idx}]"
+		elsif p.klass.ancestors.include?(Time)
+			return "#{self.class}.parse_timestamp(res[tuple][#{idx}])"
+		elsif p.klass.ancestors.include?(Date)
+			return "#{self.class}.parse_date(res[tuple][#{idx}])"
+		elsif p.klass.ancestors.include?(TrueClass)
+			return "('0' != res[tuple][#{idx}])"
+		else 
+			return "YAML::load(res[tuple][#{idx}])"
+		end				
+	end
+
+	def create_db(database, user = nil, password = nil)
+		raise 'Not implemented!'
+		
+		### how can we get a valid connection when the database does not already exist?
+		begin
+			conn = DBI.connect("DBI:ADO:Provider=SQLOLEDB;Data Source=localhost;Initial Catalog=master;User Id=sa;Password=sa;")
+			conn["AutoCommit"] = true
+			conn.execute("CREATE DATABASE #{database}")
+			conn.commit
+			Logger.warn "Ignoring credentials for database creation (not implemented)" if user
+			Logger.info "Created database '#{database}'."
+			super
+		rescue Exception => ex
+      # gmosx: any idea how to better test this?
+      if ex.to_s =~ /0x80020009/i
+				Logger.warn "Cannot drop database '#{database}', it does not exist!"
+				super
+      else
+        raise
+      end
+		end
+	end
+
+	def drop_db(database, user = nil, password = nil)
+		raise 'Not implemented!'
+
+		begin
+			conn = DBI.connect("DBI:ADO:Provider=SQLOLEDB;Data Source=localhost;Initial Catalog=master;User Id=sa;Password=sa;")
+			conn["AutoCommit"] = true
+# FIXME: why no drop?
+#			conn.execute("DROP DATABASE #{database}")
+			Logger.warn "Ignoring credentials for database drop (not implemented)" if user
+			Logger.info "Dropped database '#{database}'."
+			super
+		rescue Exception => ex
+      # gmosx: any idea how to better test this?
+      if ex.to_s =~ /0x80020009/i
+				Logger.warn "Cannot drop database '#{database}', it does not exist!"
+				super
+      else
+        raise
+      end
+		end
+	end
+
+	def props_for_insert(klass)
+		klass.__props.reject { |p| :oid == p.symbol }
+	end
+
+	def insert_code(klass, db, pre_cb, post_cb="123")
+		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.exec "#{sql}"
+			conn.commit
+			res = conn.query("SELECT IDENT_CURRENT('#{klass::DBTABLE}')")
+			@oid = res[0][0].to_i
+			#res.finish
+			#{post_cb}
+		}
+	end
+
+	def new_connection(db)
+		return SqlserverConnection.new(db)
+	end
+
+	def calc_field_index(klass, db)
+		res = db.get_connection.store.execute("SELECT TOP 1 * FROM #{klass::DBTABLE}")
+		meta = db.managed_classes[klass]
+		columns = res.column_names
+
+		for idx in (0...columns.size)
+			meta.field_index[columns[idx]] = idx
+		end
+  
+	ensure
+		res.finish
+	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
+		sql << ");"
+		
+		begin
+			conn.store.execute(sql)
+			conn.commit
+			Logger.info "Created table '#{klass::DBTABLE}'."
+		rescue => ex
+			if ex.to_s =~ /80040E14/i
+				Logger.debug 'Table already exists' if $DBG
+			else
+				raise
+			end
+		end
+		
+		# 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});"
+				begin
+					conn.store.execute(sql)
+					conn.commit
+				rescue => ex
+					if ex.to_s =~ /80040E14/i
+						Logger.debug 'Table already exists' if $DBG
+					else
+						raise
+					end
+				end
+			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_name, 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_name)}"
+				join_src = "#{self.class.encode(klass)}_oid"
+				join_dst = "#{self.class.encode(join_class)}_oid"
+				begin
+					conn.store.execute("CREATE TABLE #{join_table} ( key1 integer NOT NULL, key2 integer NOT NULL )").finish
+					conn.store.execute("CREATE INDEX #{join_table}_key1_idx ON #{join_table} (key1)").finish
+					conn.store.execute("CREATE INDEX #{join_table}_key2_idx ON #{join_table} (key2)").finish
+					conn.commit
+				rescue => ex
+					# gmosx: any idea how to better test this?
+					if ex.to_s =~ /80040E14/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 TABLE #{klass::DBTABLE}"		
+	end
+
+	# Generate the property for oid.
+
+	def eval_og_oid(klass)
+		klass.class_eval %{
+			prop_accessor :oid, Fixnum, :sql => 'int NOT NULL IDENTITY(1, 1) PRIMARY KEY'
+		}
+	end
+
+end
+
+# The SqlserverConnection connection.
+
+class SqlserverConnection < Connection
+
+	def initialize(db)
+		super
+		config = db.config
+
+		begin
+			@store = DBI.connect("DBI:ADO:Provider=SQLOLEDB;Data Source=#{config[:address]};Initial Catalog=#{config[:database]};User Id=#{config[:user].to_s};Password=#{config[:password].to_s};")
+		rescue => ex
+			# gmosx, FIXME: drak, fix this!
+			if 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 close
+		@store.disconnect
+		super
+	end
+
+	def prepare(sql)
+		@store.prepare(sql)
+	end
+
+	def query(sql)
+		Logger.debug sql if $DBG
+		begin
+			res = @store.select_all(sql)
+			return res
+		rescue => ex
+			handle_db_exception(ex, sql)
+		end
+	end
+
+	def exec(sql)
+		Logger.debug sql if $DBG
+		begin
+			@store.execute(sql).finish 
+		rescue => ex
+			handle_db_exception(ex, sql)
+		end
+	end
+
+	def start
+		# no need to do something.
+	end
+	
+	def commit
+		@store.commit
+	end
+
+	def rollback
+		@store.rollback
+	end
+
+	def valid_res?(res)
+		return !(res.nil?)
+	end
+
+	def read_one(res, klass)
+		return nil unless valid_res?(res)
+		return nil unless res
+
+		obj = klass.new
+		obj.og_read(res)
+	
+		return obj
+	end
+
+	def read_all(res, klass)
+		return [] unless valid_res?(res)
+		objects = []
+
+		for tuple in (0...res.size)
+			obj = klass.new
+			obj.og_read(res, tuple)
+			objects << obj
+		end
+
+		return objects
+	end
+
+	def read_int(res, idx = 0)
+		val = res.next[idx].to_i
+		res.finish
+		return val
+	end
+
+	def get_row(res)
+		res.next
+	end
+
+end
+
+end