nitro 0.1.2

data/lib/n/db/tools.rb

@@ -0,0 +1,110 @@
+# = Database Tools
+#
+# Useful methods wor working with the Db BAckend
+#
+# code: 
+# 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 $
+
+module N; 
+
+require "n/db"
+
+# = DbConnection
+#
+# A Connection to the Database.
+#
+module DbTools
+
+	# Lets say you have changed the definition of a managed object
+	# (for example you have added a new prop_accessor, and want to 
+	# automatically update the database schema. 
+	# Compares the given class to the actual db schema and
+	# automatically alters the backend table if needed.
+	# No need to optimize this method.
+	#
+	def self.alter_table(klass)
+		#
+		# Use the following query to see the fields in system level:
+		#
+		# sql  = "SELECT attname, attnum FROM pg_attribute, pg_class "
+		# sql << "WHERE attrelid = pg_class.oid " 
+		# sql << "AND relname = '#{klass::DBTABLE}' AND attnum > 0;"
+		#
+		# In orer to test alter_table() use the following tests:
+		#
+		# klass.__props << N::Property.new("new_field", String)
+		# klass.__props.delete_if{ |member| member.name == "new_field" }
+		#
+		# Remember you must not uncomment both of the above statements.
+		# Uncomment the first one, use alter_table(), the uncomment the
+		# seconde one and re-use alter_table().
+		#
+		$db.open { |db|
+			
+			sql = "SELECT * FROM #{klass::DBTABLE} LIMIT 1;"			
+			table_fields = db.exec(sql).fields
+	
+			# find fields to be added.
+			properties_to_add = []
+			klass.__props.each { |klass_member|
+				properties_to_add << klass_member unless table_fields.include? klass_member.name	
+			}
+	
+			# find fields to be removed.
+			properties_to_remove = []
+			table_fields.each { |field|
+				properties_to_remove << field unless klass.__props.map{ |member| member.name }.include? field
+			}
+	
+			# Add new fields
+			fields = []
+			properties_to_add.each { |p|
+				field = "#{p.symbol}"
+				if p.sql
+					field << " #{p.sql}"
+				else
+					field << " #{db.class::TYPEMAP[p.klass]}"
+				end
+				field << " #{p.sql}" if p.sql
+			
+				fields << field 
+			}
+		
+			for field in fields
+				sql = "ALTER TABLE #{klass::DBTABLE} ADD COLUMN #{field}"
+				db.exec_clear(sql)
+			end
+			
+			removed = nil
+			properties_to_remove.each { |p|
+				sql = "ALTER TABLE #{klass::DBTABLE} DROP COLUMN #{p} RESTRICT"
+				db.exec_clear(sql)
+				removed = true
+			}
+	
+			if removed
+				sql = "UPDATE #{klass::DBTABLE}; VACUUM FULL #{klass::DBTABLE};"
+				db.exec_clear(sql)
+			end
+			
+		}
+	end
+	
+	# NOT IMPLEMENTED
+	#
+	def self.alter_column(klass, old_field, new_field)
+	end
+	 
+	# NOT IMPLEMENTED
+	#
+	def self.rename_table(old_klass, new_klass)
+	end
+
+end
+
+end # module
+ 

data/lib/n/db/utils.rb

@@ -0,0 +1,99 @@
+# = Database Utilities 
+#
+# A collection of database utilities.
+#
+# code: 
+# George Moschovitis  <gm@navel.gr>
+#
+# (c) 2004 Navel, all rights reserved.
+# $Id$
+
+module N; 
+
+require "n/properties"
+require "n/utils/array"
+require "n/utils/time"
+
+# = DbUtils
+#	
+# A collection of Database utilities.
+# Additional backend specific utilities are defined in
+# the backend implementations.
+#
+module DbUtils
+
+	# Escape an sql string
+	#
+	def self.escape(str)
+		# defined in the backend
+	end
+	
+	# Escape bytes
+	#
+	def self.escape_bytes(bytes)
+		# defined in the backend
+	end
+	
+	# The name of the SQL table where entities of this class are stored.
+	# The Module separators are replaced with _ and NOT stripped out so 
+	# that we can convert back to the original notation if needed.
+	#
+	def self.sql_table(klass)
+		return "#{klass}".gsub(/::/, "_").downcase
+	end
+	
+	# Convert a ruby time to an sql timestamp.
+	# 
+	def self.sql_timestamp(time = Time.now)
+		# defined in the backend
+	end
+	
+	# Output YYY-mm-dd
+	#
+	def self.sql_date(date)
+		# defined in the backend
+	end
+	
+	# Parse sql datetime
+	#
+	def self.parse_sql_timestamp(str)
+		# defined in the backend
+	end
+	
+	# Input YYYY-mm-dd
+	#
+	def self.parse_sql_date(str)
+		# defined in the backend
+	end
+
+	# Return an sql string evaluator for the property.
+	# No need to optimize this, used only to precalculate code.
+	#
+	# FIXME: add extra handling for float.
+	#
+	def self.write_prop(p)
+		if String == p.klass
+			return "'#\{DbUtils.escape(@#{p.symbol})\}'"
+		elsif Time == p.klass
+			return %|#\{@#{p.symbol} ? "'#\{DbUtils.sql_timestamp(@#{p.symbol})\}'" : 'NULL'\}|
+		elsif Date == p.klass
+			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}))\}'"
+		else
+			# Fixnum, TrueClass
+			return "#\{@#{p.symbol} || 'NULL'\}"
+		end
+	end
+
+	# Return an evaluator for reading the property
+	# No need to optimize this, used only to precalculate code.
+	#
+	def self.read_prop(p)
+		# defined in the backend
+	end
+end
+
+end # namespace
+

data/lib/n/events.rb

@@ -0,0 +1,118 @@
+# = Events
+#
+# A simple events mechanism.
+#
+# === Design:
+#
+# As always we try to keep the design simple:
+# Events = strings (hiearchical notation)
+# Handlers = named Procs
+# The handlers are named so that we can remove them
+# by name. Also usefull for documentation purposes.
+#
+# === TODO:
+#
+# 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)
+# $ev.add_handler("id/user/login", "login-score", proc { |user|
+#	user["score"] += 1
+# })
+#
+class EventManager
+	attr :events
+	attr_accessor :logger
+
+	def initialize(logger = nil)
+		@events = Hash.new
+		@logger = logger
+	end
+
+	# Register an event handler.
+	#
+	# === Input:
+	# event = the event
+	# name = the name of the handler
+	# proc = the proc of the hadler
+	#
+	def add_handler(event, name, proc)
+		unless event_handlers = @events[event]
+			@events[event] = event_handlers = Hash.new
+		end
+		event_handlers[name] = proc
+	end
+
+	# Remove the named handler from the event.
+	#
+	def remove_handler(event, name)
+		if event_handlers = @events[event]
+			event_handlers.delete(name)
+		else
+			$log.debug "ev: cannot remove, handler #{name} not found for event #{event}" if $DBG
+		end
+	end
+
+	# Remove all handlers for the event.
+	#
+	# === Input:
+	# event = the event
+	# name = the name of the handler
+	#
+	def remove_all_handlers(event)
+		@events[event] = Hash.new
+	end
+
+	# Fire an event
+	#
+	# === Input:
+	# event = the event to fire
+	# param = parameters for the handler, use an array
+	# 		  for multiple parameters.
+	#
+	def event(event, params)
+		if event_handlers = @events[event]
+			# call all event handler procs
+			for handler in event_handlers.values
+				# call the handler with the params.
+				handler.call(params)
+			end
+		end
+		if @logger
+			if params.is_a?(Array)
+				pstr = params.collect{|i| i.to_s()}.join(", ")
+			else
+				pstr = params.to_s()
+			end
+			@logger.info("#{event}: #{pstr}")
+		end
+	end
+	alias_method :fire, :event
+end
+
+#
+#
+#
+class Event
+	@@manager = EventManager.new()
+	
+	def self.add_handler(event, name, proc)
+	end
+	
+	def self.fire(event, params)
+		@@manager.fire(event, params)
+	end
+end
+
+end # module 

data/lib/n/l10n.rb

@@ -0,0 +1,22 @@
+# = L10N, Localization support
+#
+# code: tml
+#
+# (c) 2002-2003 Navel, all rights reserved.
+# $Id: l10n.rb 71 2004-10-18 10:50:22Z gmosx $
+
+$lc_en = {}
+$lc_el = {}
+
+# = Configuration
+#
+# Override as needed in your application.
+#
+
+$lc_map = {
+	"en" => $lc_en,
+	"el" => $lc_el
+}
+
+# The locales to use for this application.
+$lc_use = %w{lc-en lc-el}

data/lib/n/logger.rb

@@ -0,0 +1,33 @@
+# = Logger
+#
+# A simple wrapper arround the Ruby logger. Mainly for compatibility
+# purposes.
+#
+# code: tml
+#
+# (c) 2004 Navel, all rights reserved.
+# $Id: logger.rb 71 2004-10-18 10:50:22Z gmosx $
+
+require "logger"
+
+class Logger
+	alias_method :devel, :debug
+	alias_method :fine, :debug
+	
+	def detach
+	end
+	
+	# Used for debuging, remove this in release code.
+	#
+	def d(str)
+		self << "#{str}\n"
+	end
+
+	# Inspect an object. Used for debugging, remove this in release
+	# code.
+	#
+	def i(obj)
+		self << "Inspect #{obj.inspect()}\n"
+	end
+end
+

data/lib/n/macros.rb

@@ -0,0 +1,53 @@
+# = Macros
+#
+# A powerfull macro implementation for Ruby. Allows definition
+# of new macro.
+#
+# code: gmosx
+#
+# (c) 2004 Navel, all rights reserved.
+# $Id: macros.rb 71 2004-10-18 10:50:22Z gmosx $
+
+$__macros__ = {}
+$__required__ = {}
+
+module Kernel
+
+alias_method :old_require, :require
+def require(path)
+	return if $__required__[path]
+	
+	source = File.read(path)
+	
+	# parse macro
+	source.gsub!(/defmacro\s*\/(.*?)\/\s(.*?)endmacro/m) {
+		$__macros__[Regexp.new($1)] = $2 ; ""
+	}
+	
+	# expand macros	
+	$__macros__.each { |match, replace|
+		source.gsub!(match, replace)
+	}
+	
+	$__required__[path] = true
+
+	eval(source)
+end
+
+end
+
+require "n/test1.rb"
+require "n/test2.rb"
+
+__END__
+
+Examples:
+
+defmacro /my_macro\((.*)\)/
+	begin 
+		my_function(\1)
+	rescue => ex
+		puts ex
+	end 
+endmacro
+

data/lib/n/mixins.rb

@@ -0,0 +1,46 @@
+# = Mixins 
+#
+# A collection of useful mixins. Use these to synthesize your 
+# entities.
+#
+# code: 
+# George Moschovitis  <gm@navel.gr>
+#
+# (c) 2004 Navel, all rights reserved.
+# $Id$
+
+module N;
+
+# = Expirable
+#
+# Generic expiring functionality mixin. This is not exclusive
+# for entities.
+#
+module Expirable
+	attr_accessor :expires
+
+	# Set the expires timeout for this entry.
+
+	def expires_after(timeout = (60*60*24))
+		@expires = Time.now + timeout
+	end
+
+	# Set the expire timeout for this entry. The timeout happens
+	# after (base + rand(spread)) seconds.
+
+	def expires_spread(base, spread)
+		@expires = Time.now + base + rand(spread)
+	end
+
+	# Is this entry expired?
+
+	def expired?
+		if @expires.nil? or (Time.now > @expires)
+			return true
+		else
+			return false
+		end
+	end
+end
+	
+end # module