nitro 0.1.2 → 0.2.0

data/examples/simple/README

@@ -1,5 +1,32 @@
 = A Simple Web Application
 
+This simple application demonstrates various Nitro features.
+
+
+== Description of contents
+
+conf/apache.conf
+	apache configuration
+
+conf/config.rb
+	application configuration
+
+root/
+	the public web directory
+
+logs/
+	logfiles come here
+
+lib/n/
+	application specific ruby code
+
+lib/p/ 
+	application specific Nitro parts
+
+test/
+	unit tests
+
+
 == Setup
 
 To setup this example web application run the follwing script:

data/examples/simple/app.rb

@@ -5,10 +5,10 @@
 # A simple Web Application to demonstrate the Engine. 
 #
 # code: 
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: app.rb 87 2004-10-19 17:27:45Z gmosx $
+# $Id: app.rb 101 2004-10-22 12:35:39Z gmosx $
 
 $:.unshift "simple/lib"
 $:.unshift "../lib"

data/examples/simple/conf/config.rb

@@ -1,17 +1,14 @@
 # = Configuration
 #
-# === Design:
-#
 # Use a separate file for configuration, makes the
 # main file more readable, and allows for reconfiguring
 # (reload) the webapp without restarting the server.
 #
-# FIXME: redesign this!
-#
-# code: gmosx
+# code:
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: config.rb 89 2004-10-20 12:55:58Z gmosx $
+# $Id: config.rb 106 2004-10-25 11:31:11Z gmosx $
 
 require "n/std"
 require "n/properties"
@@ -31,10 +28,8 @@ $elog = Logger.new("simple/logs/events.log", "weekly");
 
 require "n/db"
 require "n/app/cluster"
-require "n/config"
 
 require "simple/conf/requires"
-require "simple/conf/overrides"
 
 $srv_extension_map = {
 	"sx" => ["text/html",

data/examples/simple/conf/debug-config.rb

@@ -1,13 +1,12 @@
 # = Debug Configuration
 #
 # Configuration to use while debugging, this is slow.
-#--
+#
 # code:
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: debug-config.rb 84 2004-10-19 13:57:01Z gmosx $
-#++
+# $Id: debug-config.rb 106 2004-10-25 11:31:11Z gmosx $
 
 require "simple/conf/config"
 
@@ -43,10 +42,10 @@ $db = N::Db.new(
 	:connection_count => 5
 )
 
-$appsrv_address = "127.0.0.1"
+$srv_address = $appsrv_address = "127.0.0.1"
+$srv_port = 8080
 $appsrv_port = 9090
-$srv_url = "http://127.0.0.1:8080"
-#$srv_url = "http://192.168.0.3:8080"
+$srv_url = "http://#$srv_address:#$srv_port"
 
 # gmosx: no error page in debug mode to avoid loops when there
 # is a bug in the handler code or the shader.

data/examples/simple/conf/live-config.rb

@@ -2,13 +2,11 @@
 #
 # Configuration to use in the live server, optimized for speed.
 #
-#--
 # code:
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: live-config.rb 87 2004-10-19 17:27:45Z gmosx $
-#++
+# $Id: live-config.rb 101 2004-10-22 12:35:39Z gmosx $
 
 require "simple/conf/config"
 

data/examples/simple/conf/requires.rb

@@ -1,22 +1,14 @@
 # = Requires all needed files
 #
-# === Design:
-#
 # Collect all requires in one file includable
 # in multiple executable scripts. Moreover, it
 # makes the main script file more readable.
 #
-# === Ideas:
-#
-# - use load instead of require to make reloadable?
-#
-#--
 # code: 
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: requires.rb 84 2004-10-19 13:57:01Z gmosx $
-#++
+# $Id: requires.rb 101 2004-10-22 12:35:39Z gmosx $
 
 require "n/std"
 require "n/properties"

data/examples/simple/ctl

@@ -5,7 +5,7 @@ ARGV="$@"
 case $ARGV in
 start)
   /usr/sbin/httpd -d `pwd` -f conf/apache.conf
-	ruby -C../../.. nitro/bin/cluster.rb --daemon
+	ruby -C../.. bin/cluster.rb --daemon
   ruby -C.. simple/app.rb --start # --daemon
   ERROR=$?
   ;;

data/examples/simple/env.rb

@@ -4,10 +4,10 @@
 # AppServer environment.
 #
 # code: 
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: env.rb 69 2004-10-18 09:33:17Z gmosx $
+# $Id: env.rb 101 2004-10-22 12:35:39Z gmosx $
 
 $:.unshift ".."
 $:.unshift "simple/lib"

data/examples/simple/root/article-form.ss

@@ -3,7 +3,7 @@
 	P::Articles.add_article(request)
 ?>
 
-<form id="add_article" method="post" action="#{request.uri}">
+<form id="add_article" method="post">
 	<input type="hidden" name="add_article" value="*" />	
 	
 	<p>

data/examples/simple/root/comments-form.ss

@@ -2,7 +2,7 @@
 
 <!-- the <?xml declaration is optional, but lets be strict. -->
 
-<form id="comments_form" method="post" action="#{request.uri}">
+<form id="comments_form" method="post">
 	<input type="hidden" name="add_comment_pid" value="#{request[:comments_parent].oid}" />
 	<input type="hidden" name="oid" value="#{request[:comments_parent].oid}" />
  	

data/examples/tiny/README

@@ -0,0 +1,15 @@
+= A Tiny web application
+
+An example to test Nitro.
+
+
+=== Run the example
+
+$ cd examples/tiny
+
+$ ./ctl
+
+to stop the example press Ctrl+C or execute the
+following command:
+
+$ ./ctl stop

data/examples/tiny/app.rb

@@ -5,10 +5,10 @@
 # A simple Web Application to demonstrate the Engine. 
 #
 # code: 
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: app.rb 90 2004-10-20 12:56:43Z gmosx $
+# $Id: app.rb 101 2004-10-22 12:35:39Z gmosx $
 
 $:.unshift "../lib"
 

data/examples/tiny/conf/config.rb

@@ -1,20 +1,15 @@
 # = Configuration
 #
-# === Design:
-#
 # Use a separate file for configuration, makes the
 # main file more readable, and allows for reconfiguring
 # (reload) the webapp without restarting the server.
 #
-# FIXME: redesign this!
-#
-# code: gmosx
+# code: 
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: config.rb 90 2004-10-20 12:56:43Z gmosx $
+# $Id: config.rb 106 2004-10-25 11:31:11Z gmosx $
 
-require "n/std"
-require "n/properties"
 require "n/logger"
 require "n/config"
 
@@ -26,8 +21,8 @@ $log = Logger.new(STDERR, 10);
 
 $reload_scripts = $DBG
 
-require "n/config"
-
+require "n/std"
+require "n/properties"
 require "tiny/conf/requires"
 
 $srv_extension_map = {
@@ -42,9 +37,9 @@ $srv_extension_map = {
 	]
 }
 
-$appsrv_address = "127.0.0.1"
-$appsrv_port = 9090
-$srv_url = "http://127.0.0.1:8080"
+$srv_address = $appsrv_address = "127.0.0.1"
+$srv_port = $appsrv_port = 8080
+$srv_url = "http://#$srv_address:#$srv_port"
 
 module App
 

data/examples/tiny/conf/requires.rb

@@ -1,20 +1,14 @@
 # = Requires all needed files
 #
-# === Design:
-#
 # Collect all requires in one file includable
 # in multiple executable scripts. Moreover, it
 # makes the main script file more readable.
 #
-# === Ideas:
-#
-# - use load instead of require to make reloadable?
-#
 # code: 
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: requires.rb 90 2004-10-20 12:56:43Z gmosx $
+# $Id: requires.rb 101 2004-10-22 12:35:39Z gmosx $
 
 require "n/std"
 require "n/properties"

data/examples/tiny/ctl

@@ -3,27 +3,12 @@
 ARGV="$@"
 
 case $ARGV in
-start)
-  /usr/sbin/httpd -d `pwd` -f conf/apache.conf
-  ruby -C.. tiny/app.rb --start # --daemon
-  ERROR=$?
-  ;;
-restart)
-  # restart appserver only!
-  export ASPID= `ps ax | grep app.rb | grep ruby | cut -d" " -f1`
-  if [ -n "$ASPID" ]; then   
-    echo $ASPID
-    kill -9 $ASPID
-  fi 
-  ruby -C.. tiny/app.rb --restart # --daemon
-  ERROR=$?
-  ;;
 stop)
-  killall -9 ruby httpd
+  killall -9 ruby
   ERROR=$?
   ;;
 *)
-  echo "NOP"
+  ruby -C.. tiny/app.rb --start # --daemon
   ERROR=$?
 esac
 

data/examples/tiny/root/index.sx

@@ -21,7 +21,7 @@
 <h1>Hello #{name}</h1>
 
 <p>
-<form id="my_form" action="#{request.uri}">
+<form id="my_form">
 	<b>Enter your name:</b>
 	<input type="text" name="name" />
 	<br />

data/lib/n/app/cluster.rb

@@ -1,13 +1,10 @@
-# = Cluster
-#
-# TODO: use Sync instead of Monitor
-#
-# code:: gmosx
+# code:
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: cluster.rb 74 2004-10-18 11:30:20Z gmosx $
+# $Id: cluster.rb 104 2004-10-22 13:35:03Z gmosx $
 
-$:.unshift "nitro/lib"
+$:.unshift "lib"
 
 require "drb"
 require "monitor"
@@ -21,16 +18,20 @@ module N
 
 # = Cluster
 #
-# A Cluster is a collection of servers. The cluster synchronizes the
-# servers and distributes the state. An older version used a polling
-# system, ie: the servers polled the cluster to obtain the state. This
-# version uses a push system, ie when the state is changed a delta
-# is pushed to the clients.
+# A Cluster manages the state of a collection of servers. The cluster 
+# synchronizes the servers and distributes the state. An older version 
+# used a polling system, ie: the servers polled the cluster to 
+# obtain the state. This version uses a push system, ie when the 
+# state is changed a delta is pushed to the clients.
+#
+# TODO: use Sync instead of Monitor
 #
 class Cluster < N::Application
 
 	# = CHash ClusterHash
 	#
+	# The CHash 'endpoint' resides in the Cluster server
+	#
 	class CHash < Hash
 		attr :mon
 		
@@ -111,6 +112,8 @@ class Cluster < N::Application
 	
 	# = SHash ServerHash
 	#
+	# The SHash 'endpoint' resides in the App server
+	#
 	class SHash < Hash
 		attr :mon
 	

data/lib/n/app/cookie.rb

@@ -1,9 +1,8 @@
-# = Http Cookie
-#
-# code:: gmosx
+# code:
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: cookie.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: cookie.rb 99 2004-10-22 09:50:28Z gmosx $
 
 require "cgi"
 
@@ -34,9 +33,11 @@ end # class CGI
 
 module N; module App
 
-# Cookie
+# = Cookie
+#
+# An encapsulation of the standard HTTP Cookie.
 #
-# === Design:
+# === Design
 #
 # Ruby's default cgi library implements the functionality,
 # so we reuse it here!
@@ -44,14 +45,14 @@ module N; module App
 # The http request contains only key/values pairs so we
 # dont keep a full object.
 #
-# === Todo:
+# === Future
 #
 # - switch to libapreq!
 #
 class Cookie < CGI::Cookie
 
 	# Override default implementation
-
+	#
 	def initialize(name, *value)
 		super
 
@@ -83,4 +84,4 @@ class Cookie < CGI::Cookie
 
 end
 
-end; end # module
+end; end # module

data/lib/n/app/filters/autologin.rb

@@ -1,9 +1,8 @@
-# = AutoLogin filter
-#
-# code:: gmosx
+# code:
+# * George Moschovitis
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: autologin.rb 79 2004-10-18 16:38:19Z gmosx $
+# $Id: autologin.rb 99 2004-10-22 09:50:28Z gmosx $
 
 require "n/utils/string"
 require "n/server/filter"
@@ -19,6 +18,8 @@ module N; module App
 #
 class AutoLoginFilter < N::ServerFilter
 
+	# Perform the actual work of auto logging in the user
+	#
 	def process(request)
 		if request.is_top?
 			# only try to autologin for top level requests