nitro 0.1.2 → 0.2.0

data/AUTHORS

@@ -6,3 +6,6 @@
 
 * Elias Athanasopoulos  <elathan@navel.gr>
 	Additional coding.
+
+* Elias Karakoulakis  <ekarak@navel.gr>
+	Additional design.

data/ChangeLog

@@ -1,5 +1,88 @@
+25-10-2004  George Moschovitis  <gm@navel.gr>
+
+	* test cases pass again.
+	
+	* lib/n/app/webrick-servlet.rb: fixed bug with default index,
+	better handler selection.
+	
+	* lib/n/db/utils.rb: prepend _ before tables. it was dangerous!
+	
+	* lib/n/db.rb: wrap drop table.
+	
+	* lib/n/db/psql.rb: use Base64.decode64.
+	
+	* examples/ndb/rub.rb: implemented.
+
+23-10-2004  George Moschovitis  <gm@navel.gr>
+
+	* examples/ndb/*: introduced.
+	
+	* lib/n/app/webrick-servlet.rb (#create_request): enforce default 
+	index if missing.
+	
+	* lib/n/config.rb: index_filename renamed from $srv_default_file.
+	
+	* lib/n/utils/string.rb (#extension_from_path): returns nil if no
+	exception.
+	
+	* lib/n/app/server.rb: info msg on start to let the admin know,
+	the server has started.
+	
+	* lib/n/app/webrick.rb: extend from App::Server.
+	
+	* examples/tiny/ctl: run without apache.
+	* examples/tiny/conf/config.rb: run without apache.
+	
+	* examples/simple/README: improved.
+
+22-10-2004  George Moschovitis  <gm@navel.gr>
+
+	* README: updated.
+
+	* fixed many file permissions.
+
+	* examples/simple/conf/config.rb: fixes.
+
+	* examples/simple/app.rb: fixes.
+
+	* test/*: copied all tests here,
+	too many fixes to list to make all tests pass again.
+	
+	* Rakefile: fixed :install,
+	TestTask.
+	
+	* lib/n/tools: removed.
+	
+	* lib/n/app/request.rb: params alias for parameters. 
+	
+	* lib/xsl/ce.xsl: removed, not ready.
+
+	* lib/xsl/localization.xsl: deprecated.
+
+	* no need for action=#{request.uri} in forms.
+
+	* improved RDoc documentation to many, many souce files.
+
 21-10-2004  George Moschovitis  <gm@navel.gr>
 
+	* lib/n/db/make-release.sh: removed.
+	
+	* improved RDoc documentation to many, many, many source files.
+	
+	* lib/n/app/user.rb (AnonymousUser#role?): introduced.
+	
+	* lib/n/db/utils.rb (#write_prop): use base64 encoding.
+	
+	* lib/n/db/psql.rb (#read_prop): use base64 encoding.
+	
+	* Rakefile: added dependency for postgres-0.7.1 
+	
+	* doc/*: moved many txt files to the gen/doc directory.
+
+21-10-2004  George Moschovitis  <gm@navel.gr>
+
+	* --- VERSION 0.1.2 ---
+
 	* README: final changes before the release.
 	
 20-10-2004  George Moschovitis  <gm@navel.gr>

data/LICENCE

@@ -7,16 +7,16 @@ Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are 
 met:
 
-	* Redistributions of source code must retain the above copyright 
-		notice, this list of conditions and the following disclaimer.
+* Redistributions of source code must retain the above copyright 
+notice, this list of conditions and the following disclaimer.
 	
-	* Redistributions in binary form must reproduce the above copyright 
-		notice, this list of conditions and the following disclaimer in the 
-		documentation and/or other materials provided with the distribution.
+* Redistributions in binary form must reproduce the above copyright 
+notice, this list of conditions and the following disclaimer in the 
+documentation and/or other materials provided with the distribution.
 	
-	* Neither the name of Navel nor the names of its contributors may be 
-		used to endorse or promote products derived from this software 
-		without specific prior written permission.
+* Neither the name of Navel nor the names of its contributors may be 
+used to endorse or promote products derived from this software 
+without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 

data/README

@@ -108,7 +108,11 @@ A short summary of the major features:
 
 * Support for 'nice' urls.
 	
-	Experimental
+	Experimental.
+
+* Simple events manager.
+
+	Experimental.
 
 * Advanced debuging features
 

data/RELEASES

@@ -1,4 +1,13 @@
 
+== Version 0.2.0 was released on 25/10/2004.
+
+Greatly improved RDoc documentation. Cleaned up many source files,
+and improved the directory structure to be more compatible with
+other Ruby projects. Introduced a test suite. Important bug fixes
+in NDB. Tiny example no longer requires apache so sholud run out
+of the box.
+
+
 == Version 0.1.2 was released on 21/10/2004.
 
 The first public version. Features 2 examples and limited

data/Rakefile

@@ -8,8 +8,9 @@
 
 require "rake"
 require "rake/rdoctask"
-require "rubygems"
 require "rake/gempackagetask"
+require "rake/testtask"
+require "rubygems"
 
 require "lib/n/config"
 
@@ -20,9 +21,28 @@ task :default => :package
 
 # ----------------------------------------------------------------------
 
-desc "Run unit tests"
-task :test do
-  # Might wait until I"ve got some...
+# Run the tests
+
+Rake::TestTask.new do |t|
+	t.libs << "test"
+	t.test_files = FileList["test/**/tc*.rb"].exclude("**/tc*db*.rb")
+	t.verbose = true
+end
+
+# Run all tests
+
+Rake::TestTask.new(:test_all) do |t|
+	t.libs << "test"
+	t.test_files = FileList["test/**/tc*.rb"].exclude("**/tc*mysql*.rb")
+	t.verbose = true
+end
+
+# Run experimental tests
+
+Rake::TestTask.new(:test_exp) do |t|
+	t.libs << "test"
+	t.test_files = FileList["test/**/tc*.rb"]
+	t.verbose = true
 end
 
 # ----------------------------------------------------------------------
@@ -37,30 +57,30 @@ end
 
 PKG_VERSION = $srv_version
 PKG_FILES = FileList[
-	"[A-Z]*", "{bin,etc,examples,doc,lib,test}/**/*" 
+	"[A-Z]*", "{bin,etc,ext,examples,doc,lib,test}/**/*" 
 #	"examples/*.rb"
 ].exclude(".svn/**/*")
 
 spec = Gem::Specification.new do |s|
-  s.name = "nitro"
-  s.version = PKG_VERSION
-  s.summary = "Web Engine"
-  s.description = "An efficient, yet simple engine for Web Applications"
-# s.add_dependency("extensions", ">= 0.5")
-  s.required_ruby_version = ">= 1.8.1"
-  s.files = PKG_FILES.to_a 
-  s.require_path = "lib"
-  s.autorequire = "n/std"
-  s.has_rdoc = true
-  s.extra_rdoc_files = FileList["[A-Z]*"].to_a
-  s.rdoc_options << "--main" << "README" << "--title" << 
-			"Nitro Documentation"
-  s.test_files = []
+	s.name = "nitro"
+	s.version = PKG_VERSION
+	s.summary = "Web Engine"
+	s.description = "An efficient, yet simple engine for Web Applications"
+	s.add_dependency("postgres", ">= 0.7.1")
+	s.add_dependency("extensions", ">= 0.5")
+	s.required_ruby_version = ">= 1.8.1"
+	s.files = PKG_FILES.to_a 
+	s.require_path = "lib"
+	s.autorequire = "n/std"
+	s.has_rdoc = true
+	s.extra_rdoc_files = FileList["[A-Z]*"].to_a
+	s.rdoc_options << "--main" << "README" << "--title" << "Nitro Documentation"
+	s.test_files = []
 	s.bindir = "bin"
-  s.author = "George Moschovitis"
-  s.email = "gm@navel.gr"
-  s.homepage = "http://www.navel.gr/nitro"
-  s.rubyforge_project = "nitro"
+	s.author = "George Moschovitis"
+	s.email = "gm@navel.gr"
+	s.homepage = "http://www.navel.gr/nitro"
+	s.rubyforge_project = "nitro"
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|

data/bin/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/examples/ndb/README

@@ -0,0 +1,5 @@
+= NDB Example
+
+A simple example that demonstrates various NDB features. Before
+runing this example, create a database named test.
+

data/examples/ndb/run.rb

@@ -0,0 +1,271 @@
+# = NDB Example 
+#
+# A simple example to demonstrate the NDB library.
+# Ignore the errors marked as surpressed.
+#
+# code: 
+# * George Moschovitis  <gm@navel.gr>
+#
+# (c) 2004 Navel, all rights reserved.
+# $Id: run.rb 106 2004-10-25 11:31:11Z gmosx $
+
+$:.unshift "../../lib"
+
+require "n/std"
+require "n/logger"
+require "n/db"
+
+# = A parent class
+#
+class Article
+	manage {
+		# include some Mixins to 'synthesize' the class.
+		include N::Entity
+		include N::CreateTime
+		
+		prop_accessor String, :title
+		prop_accessor String, :body
+		# override the default O->R mapping
+		prop_accessor Fixnum, "smallint DEFAULT 1", :level
+		# store a Ruby Hash in the Database. Marshal
+		# is used for serializing the attribute.
+		prop_accessor Hash, :options
+	}
+	# this attribute is NOT stored in the db.
+	attr_accessor :other_options
+	
+	# Managed object constructors with no args, take *args 
+	# as parameter to allow for Mixin chaining.
+	#
+	def initialize(title = nil, body = nil)
+		# call the constructors of the mixins
+		super
+		@title, @body = title, body
+		options = {}
+		other_options = {}
+	end
+	
+	def to_s
+		return "#@title: #@body"
+	end
+end
+
+# = Another Parent class
+#
+class User
+	manage {
+		include N::Entity
+		include N::Named
+	}
+
+	def initialize(name = nil)
+		@name = name
+		# can be called afterwards if you want.
+		super
+	end
+	
+	def to_s
+		return @name
+	end
+end
+
+# = A child class
+#
+class Comment
+	manage {
+		# include some Mixins to 'synthesize' the class.
+		# This way we get OO sql table definitions.
+		include N::Entity
+		include N::Child
+		# by including this mixin the object can be attached
+		# to different parents.
+		include N::ParentClass
+		include N::CreateTime
+		
+		prop_accessor String, :body
+	}
+	
+	def initialize(body = nil)
+		super
+		@body = body
+	end
+	
+	def to_s
+		return @body
+	end
+end
+
+# = Another child class
+#
+class DummyChild
+	manage {
+		include N::Entity
+		include N::Child
+		
+		prop_accessor String, :body
+	}
+	
+	def initialize(body = nil)
+		super
+		@body = body
+	end
+	
+	def to_s
+		return @body
+	end
+end
+
+# Initialize a logger.
+
+$log = Logger.new(STDERR); 
+
+# Intialize NDB
+
+begin
+	$db = N::Db.new(
+		:address => "localhost",
+		:database => "test",
+		:user => "postgres",
+		:password => "navelrulez",
+		:connection_count => 5
+	)
+rescue => ex
+	puts "Database 'test' does not exist"
+	puts "Create a new database with the following command: "
+	puts "$ createdb test -U postgres"	
+end
+
+# Cleanup the database for earlier executions
+
+$db.drop_table(Article)
+$db.drop_table(Comment)
+
+# Create some articles
+
+a1 = Article.new("Title1", "Body1")
+# by adding the managed object to the $db virtual array you denote
+# that this object should be managed.
+$db << a1
+
+a2 = Article.new("Title2", "Body2")
+$db << a2
+
+puts "\n\n"
+puts "Ignore the errors, NDB automatically initialized the schema"
+
+# Until now we use $db as a helper. From now on we 'll explicitly
+# require a connection to the db. The standard block idiom is used.
+# You can also use the $db.xxx helpers if you just want to execute
+# one command.
+
+$db.open { |db|
+	
+	puts "\n\n"
+	puts "* Get and print all articles:"
+	articles = db.get_all(Article)
+	articles.each { |a| puts a }
+
+	puts "\n\n"
+	puts "* Print all children of the root (oid = -1) of class Aritcle:"
+	articles = db.children(-1, Article)
+	articles.each { |a| puts a }
+	
+	# Create some comments
+	
+	c1 = Comment.new("Comment 1")
+	c1.set_parent(a1)
+	$db << c1
+
+	c2 = Comment.new("Comment 2")
+	# alternative way to set the parent.
+	c2.pid = a1.oid
+	$db << c2
+
+	c3 = Comment.new("Comment 3")
+	# alternative way to set the parent.
+	c3.pid = a1.oid
+	$db << c3
+	
+	puts "\n\n"
+	puts "* Print all all comments for article 1:"
+	comments = db.children(a1, Comment)
+	comments.each { |c| puts c }
+
+	# Most NDB commands allow you to fine-tune the low level
+	# SQL code by passing extra_sql parameters, here is an
+	# example
+	puts "\n\n"
+	puts "* comments with sql finetunings:"
+	# use a standard SQL limit clause
+	comments = db.children(a1, Comment, "LIMIT 2")
+	comments.each { |c| puts c }
+	
+
+	# Change a managed object
+	a1.title = "Changed Title"
+	# NDB knows that this is a managed object and executes
+	# an SQL UPDATE instead of an SQL INSERT
+	$db << a1
+	
+	puts "\n\n"
+	db.get_all(Article).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
+	db.pupdate("title='A specific title'", a2)
+
+	puts "\n\n"
+	db.get_all(Article).each { |a| puts a }
+
+	# delete an object
+	db.delete(c3)
+	
+	puts "\n\n"
+	db.get_all(Comment).each { |a| puts a }
+
+
+	# Serialize a hash
+	a1.options = { "k1" => "val1", "k2" => "val2" }
+	db << a1
+
+	# lookup an object
+	article = db.get(a1.oid, Article)
+
+	puts "\n\n"
+	puts article.options.inspect
+	
+	# attach another class of child objects to Article:
+	
+	d1 = DummyChild.new("hello")
+	d1.set_parent(a1)
+	db << d1
+
+	d1 = DummyChild.new("world")
+	d1.set_parent(a1)
+	db << d1
+	
+	# Show the dummy children and not the comments.
+	
+	dummies = db.children(a1, DummyChild)
+	dummies.each { |d| puts d }
+	
+	# And now something cool: We attach the Comment objects to different
+	# parents
+	
+	u = User.new("gmosx")
+	db << u
+
+	c4 = Comment.new("Comment 4")
+	c4.set_parent(u)
+	$db << c4
+
+	c5 = Comment.new("Comment 5")
+	c5.set_parent(u)
+	$db << c5
+	
+	comments = db.children(u, Comment)
+	comments.each { |c| puts c }
+}
+
+