nitro 0.1.2 → 0.2.0

data/lib/n/db/managed.rb

@@ -1,14 +1,8 @@
-# = Database Managed Objects
-#
-# Base Mixin for Managed Objects (Entities)
-#
-# === Design
-#
 # code:
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: managed.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: managed.rb 99 2004-10-22 09:50:28Z gmosx $
 
 
 # Extend the base Module class
@@ -53,6 +47,10 @@ require "n/properties"
 require "n/utils/array"
 require "n/utils/time"
 
+# = Managed
+#
+# Base Mixin for Managed Objects (Entities)
+#
 # The database interfaces automatically manages classes that 
 # include this interface.
 #

data/lib/n/db/mixins.rb

@@ -1,16 +1,13 @@
 # = Database Managed Mixins
 #
-# Useful mixins for managed objects.
-#
-# === Design
-#
-# All mixins should have at least initialize(*args) to be more chainable?
+# Useful mixins for synthesizing managed objects. All mixins should 
+# have at least initialize(*args) to be more chainable?
 #
 # code:
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: mixins.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: mixins.rb 99 2004-10-22 09:50:28Z gmosx $
 
 module N; 
 

data/lib/n/db/mysql.rb

@@ -7,11 +7,11 @@
 # EXPERIMENTAL: NOT WORKING YET
 #
 # code:
-# George Moschovitis  <gm@navel.gr>
 # Elias Athanasopoulos  <elathan@navel.gr>
+# George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: mysql.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: mysql.rb 98 2004-10-22 07:36:20Z gmosx $
 
 require "mysql"
 require "time.rb"
@@ -19,7 +19,10 @@ require "date.rb"
 
 module N;
 
-# Backend specific utils
+# = DbUtils
+#
+# Backend specific utils. Extend the base utils
+# collection.
 #
 module DbUtils
 	

data/lib/n/db/psql.rb

@@ -1,21 +1,18 @@
-# = PostgreSQL backend 
-#
-# Implement the Db backend using the PostgreSQL RDBMS. 
-# Include the Psql backend to the standard DbConnection
-# object to synthesize a PsqlConnection at runtime. 
-#
 # code:
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
 # $Id$
 
+require "base64"
 require "postgres"
 require "time.rb"
 require "date.rb"
 
 module N;
 
+# = DbUtils 
+#
 # Backend specific utils
 #
 module DbUtils
@@ -74,6 +71,10 @@ module DbUtils
 
 	# Return an evaluator for reading the property
 	# No need to optimize this, used only to precalculate code.
+	#--
+	# gmosx: base64 encoding is used because the unencode_bytea 
+	# method of postgres is not implemented
+	#++
 	#
 	def self.read_prop(p, idx)
 		case p.klass.to_s
@@ -88,11 +89,12 @@ module DbUtils
 			when TrueClass.name
 				return "('true' == rows.getvalue(tuple, #{idx}))"
 			when Object.name
-				return "Marshal.load(N::DbUtils.unescape_bytes(rows.getvalue(tuple, #{idx})))"
+				return "Marshal.load(Base64.decode64(rows.getvalue(tuple, #{idx}).gsub(/\\\\012/, '\n')))"
 			when Array.name
-				return "Marshal.load(N::DbUtils.unescape_bytes(rows.getvalue(tuple, #{idx})))"
+				return "Marshal.load(Base64.decode64(rows.getvalue(tuple, #{idx}).gsub(/\\\\012/, '\n')))"
+#				return "Marshal.load(N::DbUtils.unescape_bytes(rows.getvalue(tuple, #{idx})))"
 			when Hash.name
-				return "Marshal.load(N::DbUtils.unescape_bytes(rows.getvalue(tuple, #{idx})))"
+				return "Marshal.load(Base64.decode64(rows.getvalue(tuple, #{idx}).gsub(/\\\\012/, '\n')))"
 			else # String 
 				return "rows.getvalue(tuple, #{idx})"
 		end		
@@ -103,6 +105,9 @@ end
 #
 # Implement the Db backend using the PostgreSQL RDBMS. 
 #
+# Include the Psql backend to the standard DbConnection
+# object to synthesize a PsqlConnection at runtime. 
+#
 module PsqlBackend
 
 	# map between Ruby and SQL types

data/lib/n/db/tools.rb

@@ -1,21 +1,17 @@
-# = Database Tools
-#
-# Useful methods wor working with the Db BAckend
-#
 # code: 
-# George Moschovitis  <gm@navel.gr>
-# Elias Athanasopoulos  <elathan@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
+# * Elias Athanasopoulos  <elathan@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: tools.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: tools.rb 99 2004-10-22 09:50:28Z gmosx $
 
 module N; 
 
 require "n/db"
 
-# = DbConnection
+# = DbTools
 #
-# A Connection to the Database.
+# Useful methods wor working with the Db BAckend
 #
 module DbTools
 

data/lib/n/db/utils.rb

@@ -1,15 +1,14 @@
-# = Database Utilities 
-#
-# A collection of database utilities.
-#
 # code: 
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
+# * Elias Athanasopoulos  <elathan@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
 # $Id$
 
 module N; 
 
+require "base64"
+
 require "n/properties"
 require "n/utils/array"
 require "n/utils/time"
@@ -39,7 +38,7 @@ module DbUtils
 	# that we can convert back to the original notation if needed.
 	#
 	def self.sql_table(klass)
-		return "#{klass}".gsub(/::/, "_").downcase
+		return "_#{klass}".gsub(/::/, "_").downcase
 	end
 	
 	# Convert a ruby time to an sql timestamp.
@@ -70,6 +69,10 @@ module DbUtils
 	# No need to optimize this, used only to precalculate code.
 	#
 	# FIXME: add extra handling for float.
+	#--
+	# gmosx: base64 encoding is used because the unencode_bytea 
+	# method of postgres is not implemented
+	#++
 	#
 	def self.write_prop(p)
 		if String == p.klass
@@ -80,7 +83,7 @@ module DbUtils
 			return %|#\{@#{p.symbol} ? "'#\{DbUtils.sql_date(@#{p.symbol})\}'" : 'NULL'\}|
 		elsif Object == p.klass or Array == p.klass or Hash == p.klass
 			#return "'#\{DbUtils.escape_bytes(Marshal.dump(@#{p.symbol}))\}'"
-			return "'#\{DbUtils.escape_bytes(Marshal.dump(@#{p.symbol}))\}'"
+			return "'#\{Base64.encode64(Marshal.dump(@#{p.symbol}))\}'"
 		else
 			# Fixnum, TrueClass
 			return "#\{@#{p.symbol} || 'NULL'\}"
@@ -95,5 +98,5 @@ module DbUtils
 	end
 end
 
-end # namespace
+end # module 
 

data/lib/n/events.rb

@@ -2,6 +2,18 @@
 #
 # A simple events mechanism.
 #
+# code: 
+# George Moschovitis  <gm@navel.gr>
+#
+# (c) 2002-2003 Navel, all rights reserved.
+# $Id: events.rb 98 2004-10-22 07:36:20Z gmosx $
+
+module N;
+
+# = EventManager
+#
+# A simple events mechanism.
+#
 # === Design:
 #
 # As always we try to keep the design simple:
@@ -15,15 +27,6 @@
 # Add a class of events to allow filtering of certain
 # events. Perhaps name can be used for this!
 #
-# code: tml
-#
-# (c) 2002-2003 Navel, all rights reserved.
-# $Id: events.rb 71 2004-10-18 10:50:22Z gmosx $
-
-module N;
-
-# = EventManager
-#
 # === Example:
 #
 # $ev.event("id/user/login", user)
@@ -101,8 +104,9 @@ class EventManager
 	alias_method :fire, :event
 end
 
+# = Event
 #
-#
+# Encapsulates an Event
 #
 class Event
 	@@manager = EventManager.new()

data/lib/n/logger.rb

@@ -3,13 +3,19 @@
 # A simple wrapper arround the Ruby logger. Mainly for compatibility
 # purposes.
 #
-# code: tml
+# code:
+# George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: logger.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: logger.rb 98 2004-10-22 07:36:20Z gmosx $
 
 require "logger"
 
+# = Logger
+#
+# A simple wrapper arround the Ruby logger. Mainly for compatibility
+# purposes.
+#
 class Logger
 	alias_method :devel, :debug
 	alias_method :fine, :debug

data/lib/n/macros.rb

@@ -3,10 +3,13 @@
 # A powerfull macro implementation for Ruby. Allows definition
 # of new macro.
 #
-# code: gmosx
+# EXPERIMENTAL, not fully working yet
+#
+# code: 
+# George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: macros.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: macros.rb 98 2004-10-22 07:36:20Z gmosx $
 
 $__macros__ = {}
 $__required__ = {}

data/lib/n/parts.rb

@@ -1,12 +1,8 @@
-# = Part
-#
-# A part encapsulates a service in the Framework. 
-#
 # code: 
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: parts.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: parts.rb 99 2004-10-22 09:50:28Z gmosx $
 
 require "singleton"
 
@@ -108,12 +104,14 @@ class Part
 	def unistall
 	end
 
-	#
+	# This method is called when the application
+	# is started.
 	#	
 	def start
 	end
 	
-	#
+	# This method is called when the application
+	# is stopped.
 	#
 	def stop
 	end
@@ -139,7 +137,7 @@ class Part
 	def prepared_statements
 	end
 
-	#
+	# Dump this part as s String.
 	#
 	def to_s
 		@name
@@ -148,7 +146,12 @@ end
 
 end # module
 
-# Namespace for parts.
+# = P
+#
+# This module is used as a namespace that encapsulates
+# the Application Parts defined on top of the engine. 
 #
 module P
 end # module
+
+

data/lib/n/properties.rb

@@ -1,5 +1,21 @@
 # = Properties support
 #
+# code:
+# George Moschovitis  <gm@navel.gr>
+# design:
+# Anastastios Koutoumanos  <ak@navel.gr>
+# Elias Karakoulakis  <ekarak@ktismata.com>
+#
+# (c) 2004 Navel, all rights reserved.
+# $Id: properties.rb 98 2004-10-22 07:36:20Z gmosx $
+
+require "n/utils/array"
+require "n/utils/hash"
+
+module N
+
+# Property Metadata
+#
 # Ruby attributes are typeless and generally this is good. Some times
 # we need extra metadata though, for example in relational mapping, or
 # web form population.
@@ -12,19 +28,8 @@
 # TODO:
 # Perhaps a sync is needed in evals (!!!!)
 #
-# code: gmosx, drak, ekarak
-#
-# (c) 2004 Navel, all rights reserved.
-# $Id: properties.rb 71 2004-10-18 10:50:22Z gmosx $
-
-require "n/utils/array"
-require "n/utils/hash"
-
-module N
-
-# Property Metadata
-#
 # === Design:
+#
 # - add default value in the extra sql
 #
 class Property

data/lib/n/server.rb

@@ -2,10 +2,11 @@
 #
 # Generic server infrastructure
 #
-# code:: gmosx
+# code:
+# George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: server.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: server.rb 98 2004-10-22 07:36:20Z gmosx $
 
 require "n/application"
 

data/lib/n/server/filter.rb

@@ -1,10 +1,8 @@
-# = Server filter
-#
 # code:
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 20024 Navel, all rights reserved.
-# $Id: filter.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: filter.rb 99 2004-10-22 09:50:28Z gmosx $
 
 require "socket"
 require "thread"

data/lib/n/shaders.rb

@@ -1,3 +1,11 @@
+# code:
+# * George Moschovitis  <gm@navel.gr>
+#
+# (c) 2004 Navel, all rights reserved.
+# $Id: shaders.rb 99 2004-10-22 09:50:28Z gmosx $
+
+module N;
+
 # = Shader
 #
 # The equivalent of a 3d engine shader. Converts the page representation 
@@ -32,16 +40,6 @@
 #
 # - add monitoring support for xsl's.
 #
-# code:
-# George Moschovitis  <gm@navel.gr>
-#
-# (c) 2004 Navel, all rights reserved.
-# $Id: shaders.rb 89 2004-10-20 12:55:58Z gmosx $
-
-module N;
-
-# = Shader
-#
 # One shader can utilize several xsls to render different pages.
 # the shader selection may be time consuming but is performed once
 # when transforming the script, so its essentially for free (and
@@ -99,9 +97,9 @@ end
 
 # = NilShader
 #
-# A shader that does absolutely nothing.
-#
-# === WARNING: not tested.
+# A shader that does absolutely nothing. Typically
+# used when you want to avoid XSLT in simple 
+# applications.
 #
 class NilShader < Shader
 	def initialize