nitro 0.1.2 → 0.2.0

data/lib/n/sitemap.rb

@@ -2,27 +2,11 @@
 #
 # Encapsulates the page structure and additional metadata.
 #
-# === TODO:
-#
-# move out of the UI namespace.
-# include url remapping functionality.
-# 
-# === Design
-# 
-# Unlike the original version, this is presentation agnostic, and 
-# greatly simplified.
-#
-# === Todo:
-#
-# - support strings as titles.
-# - add support to read the map from a config file.
-# - rename to appmap ? 
-#
 # code: 
 # George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: sitemap.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: sitemap.rb 98 2004-10-22 07:36:20Z gmosx $
 
 require "n/utils/hash"
 
@@ -30,11 +14,14 @@ module N
 
 # = SitePage
 #
+# A single page in the page map.
+#
 class SitePage
 	# the uri for this page
 	attr_accessor :uri
 	# the real uri to this page calculated by the page overloader)
 	attr_accessor :real_uri
+	# the realm this page belongs to
 	attr_accessor :realm
 	# the shader for this page, overrided the shader calculated
 	# by the engine
@@ -77,10 +64,26 @@ class SitePage
 end
 
 # = SiteMap
-# 
+#
+# Encapsulates the page structure and additional metadata.
+#
 # === TODO:
-# Use a second class in the UI namespace for rendering 
-# related stuff?
+#
+# move out of the UI namespace.
+# include url remapping functionality.
+# 
+# === Design
+# 
+# Unlike the original version, this is presentation agnostic, and 
+# greatly simplified.
+#
+# === Todo:
+#
+# - support strings as titles.
+# - add support to read the map from a config file.
+# - rename to appmap ? 
+# - Use a second class in the UI namespace for rendering 
+# 	related stuff?
 #
 class SiteMap < N::SafeHash
 

data/lib/n/std.rb

@@ -1,9 +1,12 @@
-# = Navel Software Technology
+# = Nitro standard require
 #
-# code: gmosx, drak, ekarak
+# General utilities. Typically included in all Nitro applications.
 #
-# (c) 2001-2004 Navel, all rights reserved.
-# $Id: std.rb 71 2004-10-18 10:50:22Z gmosx $
+# code: 
+# * George Moschovitis  <gm@navel.gr>
+#
+# (c) 2004 Navel, all rights reserved.
+# $Id: std.rb 99 2004-10-22 09:50:28Z gmosx $
 
 # we want readable code
 
@@ -59,6 +62,14 @@ end
 
 EMPTY_STRING = ""
 
+# = N
+#
+# This module is used as a namespace that encapsulates 
+# engine objects.
+#
+module N
+end # module
+
 # This the default 72 chars separator, copy paste to use it
 # in your source file. Btw all lines in your source file should 
 # be less than 72 chars. So you can use this as a ruler if your 

data/lib/n/sync/clc.rb

@@ -2,10 +2,12 @@
 
 # = A Command Line Client (clc) for the Sync Server
 #
-# code: tml, drak
+# code: 
+#	* Anastasios Koutoumanos  <ak@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: clc.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: clc.rb 101 2004-10-22 12:35:39Z gmosx $
 
 require "logger"
 require "socket"

data/lib/n/sync/handler.rb

@@ -1,14 +1,9 @@
-# = Synchronous Handler
-#
-# === Design:
-#
-# A handler can act as a multiplexer to implement multiple services
-# per server.
-#
-# code: tml, drak
+# code:
+# * George Moschovitis  <gm@navel.gr>
+# * Anastasios Koutoumanos  <ak@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: handler.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: handler.rb 101 2004-10-22 12:35:39Z gmosx $
 
 require "timeout"
 require "n/server"
@@ -17,9 +12,14 @@ module N; module Sync
 
 class HandlerExitException < Exception; end
 
-# = Worker
+# = Handler 
+#
+# Sync Server Handler
+#
+# === Design:
 #
-# Override this to create your worker.
+# Override this to create your handler. A handler can 
+# act as a multiplexer to implement multiple services per server.
 #
 class Handler
 	SEPARATOR = "\000"
@@ -45,11 +45,15 @@ class Handler
 		@server, @socket = server, socket
 	end
 
+	# Called when the handler starts.
+	#
 	def start
 		touch!
 		@thread = Thread.new(&method("run").to_proc)
 	end
 
+	# Called when the handler stops.
+	#
 	def stop
 		unless STATUS_STOPPED == @status
 			@status = STATUS_STOPPED
@@ -75,6 +79,8 @@ class Handler
 		@thread.raise HandlerExitException.new()
 	end
 	
+	# Perform the handler's action.
+	#
 	def run
 		@status = STATUS_RUNNING
 		
@@ -207,7 +213,9 @@ class Handler
 	
 	# ------------------------------------------------------------------
 	# Commands
-	
+
+	# A sample command
+	#
 	def cmd_ping(args)
 		cmd = %{<pong time="#{Time.now}"}
 		cmd += %{ challenge="#{args[:challenge]}"} if args

data/lib/n/sync/server.rb

@@ -1,23 +1,9 @@
-# = Syncrhronous Server
-#
-# === Design:
-# 
-# Should support clustered operation: A cluster of servers is spawned.
-# The client connects to one of the servers at random. The client sticks 
-# to the server. Each server considers the others as clients and 
-# rebroadcasts all the events.
-#
-# We keep one service per server for simplicity, if we need multiple
-# services we can implement a multiplexer service (handler).
-#
-# === TODO:
-#
-# - Investigate if this server can be done with select.
-#
-# code: gmosx, drak
+# code: 
+# * George Moschovitis  <gm@navel.gr>
+# * Anastasios Koutoumanos  <ak@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: server.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: server.rb 101 2004-10-22 12:35:39Z gmosx $
 
 require "thread"
 require "socket"
@@ -41,6 +27,20 @@ module N; module Sync
 # marker. NO: the XML protocol is not really appropriate, better use
 # a space optimized delimited ASCII protocol.
 #
+# === Design:
+# 
+# Should support clustered operation: A cluster of servers is spawned.
+# The client connects to one of the servers at random. The client sticks 
+# to the server. Each server considers the others as clients and 
+# rebroadcasts all the events.
+#
+# We keep one service per server for simplicity, if we need multiple
+# services we can implement a multiplexer service (handler).
+#
+# === TODO:
+#
+# - Investigate if this server can be done with select.
+#
 class Server < N::Application
 	MONITOR_INTERVAL = 2 * 60
 	
@@ -78,6 +78,8 @@ class Server < N::Application
 		super()		
 	end
 
+	# Start the server.
+	#
 	def start()
 		# a single tcp server accepts all tcp requests
 		@tcp_server = TCPServer.new(address, port)
@@ -86,10 +88,14 @@ class Server < N::Application
 		run()
 	end
 
+	# Stop the server.
+	#
 	def stop()
 		@status = STATUS_STOPED
 	end
 	
+	# Run the main loop of the server.
+	#
 	def run() 
 		@status = STATUS_RUNNING
 		$log.info "Server is running."

data/lib/n/ui/date-select.rb

@@ -1,7 +1,5 @@
-# = Date Select
-#
 # code: 
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
 # $Id: select.rb 39 2004-09-29 12:40:53Z elathan $
@@ -11,7 +9,7 @@ module N; module UI
 	MONTHS_EN = %w{ - January February March April May June July August September October November December }
 	MONTHS_EL = %w{ - ���������� ����������� ������� �������� ����� ������� ������� ��������� ����������� ��������� ��������� ���������� }	
 
-	# Date select. 
+	# Generate a component that allows the user to select a day. 
 	#
 	def self.date_select(prefix, day, month, year, yorder = 0, locale = "en")
 		str = ""

data/lib/n/ui/pager.rb

@@ -1,19 +1,21 @@
-# = Pager
-#
-# code: gmosx
+# code:
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: pager.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: pager.rb 99 2004-10-22 09:50:28Z gmosx $
 
 module N; module UI
 
+# = Pager
+#
+# Displays a collection of entitities in multiple pages.
+#
 # === Design:
 #
 # The new version is carefully designed for scaleability. It stores 
-# only the items for one page.
-# The name parameter is needed, multiple pagers can coexist in
-# a single page. Unlike the v1/v2 pagers this pager leverages the 
-# SQL LIMIT option to optimize database interaction.
+# only the items for one page. The name parameter is needed, multiple 
+# pagers can coexist in a single page. Unlike the v1/v2 pagers this 
+# pager leverages the SQL LIMIT option to optimize database interaction.
 #
 # The pager does not extend Array (it includes an Array instead) to
 # avoid a concat() in the initialization step. 

data/lib/n/ui/popup.rb

@@ -1,14 +1,15 @@
-# = Popup
-#
-# code: gmosx
+# code: 
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: popup.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: popup.rb 99 2004-10-22 09:50:28Z gmosx $
 
 module N; module UI
 
 # = Popup
 #
+# Display a popup window.
+#
 class Popup
 
 	#  Emit the needed javascript.

data/lib/n/ui/select.rb

@@ -1,9 +1,8 @@
-# = Select
-#
-# code: gmosx
+# code: 
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: select.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: select.rb 99 2004-10-22 09:50:28Z gmosx $
 
 module N; module UI
 

data/lib/n/ui/tabs.rb

@@ -1,9 +1,8 @@
-# = Tabs
-#
-# code: gmosx
+# code: 
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: tabs.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: tabs.rb 101 2004-10-22 12:35:39Z gmosx $
 
 module N; module UI
 

data/lib/n/utils/array.rb

@@ -1,16 +1,8 @@
-# = General arrays utilities collection
-#
-# === Design:
-#
-# Implement as a module to avoid class polution. You can still Ruby's
-# advanced features to include the module in your class.
-# Passing the object to act upon allows to check for nil, which isn't
-# possible if you use self.
-#
-# code:: gmosx, ekarak
+# code:
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2002-2003 Navel, all rights reserved.
-# $Id: array.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: array.rb 101 2004-10-22 12:35:39Z gmosx $
 
 require "sync"
 
@@ -22,13 +14,13 @@ module N
 # because it is re-entrant.
 # An exclusive lock is needed when writing, a shared lock IS NEEDED
 # when reading
-
+#
 class SafeArray < Array
 	
 	attr :sync
 
 	# gmosx: delegator is not used.
-
+	#
 	def initialize(delegator = nil)
 		@sync = ::Sync.new()
 	end
@@ -87,6 +79,6 @@ class SafeArray < Array
 		}
 	end
 		
-end # SafeArray
+end
 
 end # module

data/lib/n/utils/cache.rb

@@ -1,13 +1,9 @@
-# = Cache
-#
-# Various caching mechanisms.
-#
 # code:
-# George Moschovitis  <gm@navel.gr>
-# Anastasios Koutoumanos  <ak@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
+# * Anastasios Koutoumanos  <ak@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: cache.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: cache.rb 101 2004-10-22 12:35:39Z gmosx $
 
 module N;
 

data/lib/n/utils/gfx.rb

@@ -1,16 +1,15 @@
-# = General graphics utilities collection
-#
 # code: 
-# George Moschovitis  <gm@navel.gr>
-# Elias Athanasopoulos  <elathan@navel.gr>
-# Asteraki  <stella@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
+# * Elias Athanasopoulos  <elathan@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: gfx.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: gfx.rb 101 2004-10-22 12:35:39Z gmosx $
 
 module N
 
 # = GfxUtils
+# 
+# General graphics utilities collection.
 #
 # === Design:
 #

data/lib/n/utils/hash.rb

@@ -1,15 +1,8 @@
-# = Hash
-#
-# various hash utilities.
-#
-# Design:
-# uses the delegator pattern to allow for multiple
-# implementations!
-#
-# *code: gmosx
+# code: 
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: hash.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: hash.rb 101 2004-10-22 12:35:39Z gmosx $
 
 require "sync"
 
@@ -21,12 +14,14 @@ module N;
 # because it is re-entrant.
 # An exclusive lock is needed when writing, a shared lock IS NEEDED
 # when reading
-
+# uses the delegator pattern to allow for multiple
+# implementations!
+#
 class SafeHash < Hash
 	attr :sync
 
 	# gmosx: delegator is not used.
-
+	#
 	def initialize(delegator = nil)
 		@sync = ::Sync.new
 	end