nitro 0.11.0 → 0.12.0

data/lib/nitro/dispatcher.rb

@@ -3,14 +3,16 @@
 # $Id$
 
 module N
-	
+
 require 'nitro/controller'
+require 'nitro/routing'
 require 'nitro/simple'
 
 # The Dispatcher manages a set of controllers.
 
 class Dispatcher 
-
+	include Router
+	
 	# The root directory.
 
 	attr_accessor :root
@@ -34,15 +36,17 @@ class Dispatcher
 	# [+apis+]
 	# 	A hash of apis supported by the Dispatcher.
 	
-	def initialize(controllers = nil, apis = nil)
+	def initialize(controllers = nil, apis = nil, routes = nil)
 		@root = 'root'
 		
 		if controllers and controllers.is_a?(Class) and controllers.ancestors.include?(Controller)
-			@controllers = { :root => controllers }
+			controllers = { :root => controllers }
 		else
-			@controllers = controllers || { :root => SimpleController }
+			controllers ||= { :root => SimpleController }
 		end
 
+		mount(controllers)
+
 		@apis = apis || {}
 	end
 
@@ -62,9 +66,11 @@ class Dispatcher
 	#		'users' => UsersController # mounts /users
 	#	}
 	
-	def mount(controllers)
+	def add_controller(controllers)
 		(@controllers ||= {}).update(controllers)
+		update_routes
 	end
+	alias_method :mount, :add_controller
 
 	# Add a new api to the dispatcher
 	#
@@ -81,6 +87,21 @@ class Dispatcher
 		(@apis ||= {})[api] = data
 	end
 
+	# Update the routes. Typically called after a new
+	# Controller is mounted.
+
+	def update_routes
+		@routes = []
+		@controllers.each do |base, c|
+			base = (base == :root ? '' : "/#{base}")
+			c.action_metadata.each do |action, meta|
+				if route = meta[:route]
+					@routes << [route, "#{base}/#{action}", *meta.params.keys]
+				end
+			end
+		end
+	end
+	
 	# Processes the path and dispatches to the corresponding
 	# controller/action pair.
 	# The base returned contains a trailing '/'.
@@ -94,7 +115,10 @@ class Dispatcher
 	def dispatch(path, context = nil)
 		api = :xhtml
 
+		path = route(path, context)
+
 		if @apis
+			# OPTIMIZE: check only if lookup fails.
 			@apis.each { |k, v| api = k if path.slice!(/#{k}\//) }
 		end
 

data/lib/nitro/markup.rb

@@ -52,8 +52,6 @@ module PropertyUtils
 	end
 end
 
-# = Markup
-#
 # Generalised Markup transformations.
 #
 # The expand methods evaluate (expand) the markup
@@ -76,6 +74,8 @@ module Markup
 		return unless str
 		str.gsub!(/"/, '"')		
 		str.gsub!(/'/, ''')		
+		str.gsub!(/</, '&lt;')		
+		str.gsub!(/>/, '&gt;')		
 		str.gsub!(/\r\n/, ' <br />')
 		return str
 	end
@@ -84,6 +84,8 @@ module Markup
 		return unless str
 		str.gsub!(/&quot;/, '"')		
 		str.gsub!(/&#39;/, "'")
+		str.gsub!(/&lt;/, '<')
+		str.gsub!(/&gt;/, '>')
 		# gmosx: SOS! double quotes ARE needed for \r\n!!
 		str.gsub!(/\s<br \/>/, "\r\n")
 		return str

data/lib/nitro/render.rb

@@ -4,8 +4,6 @@
 
 require 'sync'
 
-require 'nitro'
-
 require 'glue/attribute'
 require 'glue/misc'
 require 'glue/object'
@@ -118,10 +116,14 @@ module Rendering
 			if klass.action_methods.include?(action)
 				valid = true
 
-				args = klass.action_method_arguments(action).map { |a| "@#{a} = @context['#{a}']" }
+				if meta = klass.action_metadata[action.intern]
+					params = meta.params.keys
+					params = params.collect { |p| "@#{p} = @context['#{p}']" }
+					code << "#{params.join(';')}"
+				end
 				
 				code << %{
-					#{action}(#{args.join(',')});
+					#{action}
 				}
 			end
 
@@ -166,7 +168,9 @@ module Rendering
 					end
 				}
 			end
-		
+	
+			#	puts '---', code, '---'
+
 			klass.class_eval(code)
 		end
 
@@ -235,9 +239,8 @@ module Render
 		# For example called by redirects.
 		
 	rescue Exception, StandardError => e
-		log_error "Error while handling '#{path}'."
-		log_error pp_exception(e)
-		
+		log_error(e, path)
+
 		# More fault tolerant, only flags the erroneous box with 
 		# error not the full page.
 		
@@ -264,14 +267,15 @@ private
 
 	# Log a rendering error.
 
-	def log_error(str)
+	def log_error(error, path)
 		@rendering_errors ||= []
-		@rendering_errors << str
+		@rendering_errors << [error, path]
 
 		# gmosx: Hmm perhaps this should not be logged 
 		# to avoid DOS attacks.
 
-		Logger.error str
+		Logger.error "Error while handling '#{path}'."
+		Logger.error pp_exception(error)
 	end
 
 	# Convenience method to lookup the session.

data/lib/nitro/routing.rb

@@ -0,0 +1,33 @@
+# * George Moschovitis  <gm@navel.gr>
+# (c) 2004-2005 Navel, all rights reserved.
+# $Id: routing.rb 271 2005-03-07 17:56:45Z gmosx $
+
+module N
+
+# Router mixin.
+	
+module Router
+	
+	# The route table maps 'nice URLs' to real URLs that
+	# can be handled by the Dispatcher.
+
+	attr_accessor :routes
+
+	# Apply routing rules to the path.
+
+	def route(path, context)
+		for rule, real_path, *params in @routes
+			if md = path.match(rule)
+				params.each_with_index do |p, idx|
+					context[p] = md.captures[idx]
+				end
+				return real_path
+			end
+		end
+
+		return path
+	end
+
+end
+
+end

data/lib/nitro/runner.rb

@@ -44,19 +44,28 @@ class Runner
 	#
 	# The default mode is :debug
 
-	attr_accessor :mode
+	attr :mode
 	
 	# :start, :stop, :restart
 
-	attr_accessor :action
+	attr :action
 	
 	# The server used to run this web application.
 	# :webrick, :nitro, :lhttp, :apache, :mod_apache 
 	#
 	# At the moment only :webrick and :lhttp are available.
 	
-	attr_accessor :server
+	attr :server
 
+	# Run as daemon.
+
+	attr :daemon
+
+	# Spidering mode. Acceptable values are :crawl, :render
+	# and false.
+
+	attr :spider 
+	
 	# Parse the command line arguments and the environment 
 	# parameters to setup the application.
 	
@@ -66,6 +75,7 @@ class Runner
 		@action = :start
 		@server = :webrick
 		@daemon = false
+		@spider = false
 
 		parser = OptionParser.new do |opts|
 
@@ -127,6 +137,16 @@ class Runner
 				exit
 			end
 
+			opts.on('--crawl', 'Crawl the application.') do
+				@server = :webrick
+				@spider = :crawl
+			end
+
+			opts.on('--render', 'Crawl the application and render all pages as static html files.') do
+				@server = :webrick
+				@spider = :render
+			end
+
 			opts.on_tail('-v', '--version', 'Show version.') do 
 				puts "Nitro #{Nitro::Version}"
 				exit
@@ -202,9 +222,24 @@ class Runner
 	end
 
 	def invoke_server(conf)
+		spider_thread = nil
+		
 		case @action
 		when :start
 			
+			case @spider
+				when :render
+					spider_thread = Thread.new do
+						sleep(6)
+						`wget -k -m -p #{conf.host}:#{conf.port} -directory-prefix=rendered`
+					end 
+				when :crawl
+					spider_thread = Thread.new do
+						sleep(6)
+						`wget -m --spider #{conf.host}:#{conf.port}`
+					end 
+			end
+
 			puts "\n==> Application listening at #{conf.host}:#{conf.port}.\n\n"
 
 			case @server

data/lib/nitro/scaffold.rb

@@ -1,6 +1,6 @@
 # * George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: scaffold.rb 248 2005-01-31 13:38:34Z gmosx $
+# $Id: scaffold.rb 270 2005-03-07 17:52:16Z gmosx $
 
 require 'glue/inflector'
 
@@ -26,14 +26,15 @@ module Scaffolding
 			oid = options[:oid] || 'oid'
 			name = options[:name] || N::Inflector.name(klass.name)
 			list_name = options[:list_name] || N::Inflector.plural_name(name)
-			suffix = "_#{name}"
+			options[:nosuffix] ? suffix = nil : suffix = "_#{name}"
 
 			# Add methods to the scaffolded class.
 			
 			klass.module_eval <<-"end_eval", __FILE__, __LINE__
 				
 				def view_uri
-					"view#{suffix}?oid=\#\{@oid\}"
+					# "view#{suffix}?oid=\#\{@oid\}"
+					"view#{suffix}/\#\{@oid\}"
 				end
 				
 			end_eval
@@ -59,8 +60,10 @@ module Scaffolding
 				end
 				
 				def view#{suffix}
-					@#{name} = #{klass}[@context['#{oid}']]
+					# @#{name} = #{klass}[@context['#{oid}']]
+					@#{name} = #{klass}[@#{oid}]
 				end
+				action :view#{suffix}, :route => \%r\{view#{suffix}/(.*)\}, 'oid' => 1
 				
 				def save#{suffix}
 				end

data/lib/nitro/shaders.rb

@@ -1,8 +1,8 @@
-#--
 # George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
 # $Id: shaders.rb 202 2005-01-17 10:44:13Z gmosx $
-#++
+
+require 'nitro/template'
 
 module N
 
@@ -56,6 +56,7 @@ end
 # evaluated.
 
 class RubyShader < Shader
+	include TemplateMixin
 
 	# Convert the xhtml script to actual Ruby code, ready to be 
 	# evaluated.
@@ -65,10 +66,16 @@ class RubyShader < Shader
 	# perhaps xl:href should be used to be XLink compatible?
 	#++
 	
+	def process(hash, text)
+		text = compile_template(text) 
+		process_next(hash, text)
+	end
+
+=begin
 	def process(hash, text)
 		# strip the xml header! (interracts with the following gsub!)
 		text.gsub!(/<\?xml.*\?>/, "")
-
+		
 		# Statically include sub script files.
 		# The target file is included at compile time.
 		#
@@ -134,6 +141,7 @@ class RubyShader < Shader
 
 		process_next(hash, text)
 	end
+=end
 
 	# Loads and statically includes a file.
 	
@@ -223,4 +231,3 @@ class CompressShader < Shader
 end
 
 end
-

data/lib/nitro/template.rb

@@ -0,0 +1,140 @@
+# * George Moschovitis  <gm@navel.gr>
+# (c) 2004-2005 Navel, all rights reserved.
+# $Id: template.rb 271 2005-03-07 17:56:45Z gmosx $
+
+module N
+
+# A template is a text file with embeded Ruby code. The template
+# processor converts the original text file to ruby code and
+# then evaluates this code to produce the result of the 
+# template transformation.
+
+module TemplateMixin
+
+	# Convert a template to actual Ruby code, ready to be 
+	# evaluated.
+	#
+	# [+template+] 
+	#		The template as a String.
+	#
+	# [+buffer+]
+	#		The variable to act as a buffer where the ruby code
+	# 	for this template will be generated. Passed as a|
+	#		String.
+	#
+	#	[+base_dir+]
+	#		The base directory where the templates reside.
+	
+	def compile_template(template, buffer = '@out', base_dir = Dir.pwd)
+		text = template.dup
+
+		# Strip the xml header! (interracts with the following gsub!)
+		text.gsub!(/<\?xml.*\?>/, "")
+
+		# Statically include sub-template files.
+		# The target file is included at compile time.
+		#
+		# gmosx: must be xformed before the <?r pi.
+		#
+		# Example:		
+		# <?include href="root/myfile.sx" ?>
+		
+		text.gsub!(/<\?include href="(.*?)"(.*)\?>/) do |match|
+			text = File.read("#{base_dir}/#$1")
+			text.gsub!(/<\?xml.*\?>/, '')
+			text.gsub!(/<\/?root(.*?)>/m, ' ');
+			text
+		end
+
+		# Transform include instructions <include href="xxx" />
+		# must be transformed before the processinc instructions.
+		# Useful to include fragments cached on disk
+	  #
+		# gmosx, FIXME: NOT TESTED! test and add caching.
+		# add load_statically_included fixes.
+
+		text.gsub!(/<include href="(.*?)"(.*)(.?)\/>/) do |match|
+			"<?r File.read( '\#\{@dispatcher.root\}/#$1' ?>"
+		end
+		
+		# xform render/inject instructions <render href="xxx" />
+		# must be transformed before the processinc instructions.
+
+		text.gsub!(/<inject href="(.*?)"(.*)(.?)\/>/) do |match|
+			"<?r render '/#$1' ?>"
+		end
+		
+		text.gsub!(/<render href="(.*?)"(.*)(.?)\/>/) do |match|
+			"<?r render '/#$1' ?>"
+		end
+
+		# Remove <root> elements. typically removed by xslt but lets
+		# play it safe. The <root> element is typically added to
+		# template files to make them XHTML valid.
+		
+		text.gsub!(/<(\/)?root>/, '')
+		
+		# Transform the processing instructions, use <?r as
+		# a marker.
+		
+		text.gsub!(/\?>/, "\n#{buffer} << %^")
+		text.gsub!(/<\?r(\s?)/, "^\n")
+		
+		# Transform alternative code tags. 
+		# (very useful in xsl stylesheets)
+		
+		text.gsub!(/<\/ruby>/, "\n#{buffer} << %^")
+		text.gsub!(/<ruby>/, "^\n")
+	
+		# Alterative versions of interpolation.
+		# (very useful in xsl stylesheets)
+		
+		text.gsub!(/\#\((.*?)\)/, '#{\1}')
+
+		# Compile time ruby code. This code is evaluated when
+		# compiling the template and the result injected directly
+		# into the result. Usefull for example to prevaluate
+		# localization.
+		
+		text.gsub!(/\#\[(.*?)\]/) do |match|
+			eval($1)
+		end
+		
+		text =  "#{buffer} << %^" + text + "^"
+
+		return text
+	end
+
+	# Render the template.
+	#
+	# [+ruby+]
+	#		A String containing the compiled template
+	#		code.
+	#
+	#	[+binding+]
+	#		The evaluation binding for the rendering.
+
+	def render_template(ruby, the_binding = nil)
+		eval(ruby, the_binding)
+	end
+
+	# Compile and render the template.
+	
+	def process_template(template, buffer = '@out', the_binding = nil)
+		render_template(compile_template(template, buffer), the_binding)
+	end
+
+end
+
+# A template class implementing the Template mixin.
+
+class Template
+	class << self
+		include TemplateMixin
+		alias_method :compile, :compile_template
+		alias_method :render, :render_template
+		alias_method :process, :process_template
+	end
+end
+
+end