nitro 0.8.0 → 0.9.3

data/lib/nitro/dispatcher.rb

@@ -0,0 +1,105 @@
+#--
+# George Moschovitis  <gm@navel.gr>
+# (c) 2004-2005 Navel, all rights reserved.
+# $Id$
+#++
+
+module N
+	
+require 'nitro/controller'
+
+# The Dispatcher manages a set of controllers.
+
+class Dispatcher 
+
+	# The root directory.
+
+	attr_accessor :root
+
+	# The controllers map.
+
+	attr_accessor :controllers
+
+	# APIs map.
+
+	attr_accessor :apis
+
+	def initialize(controllers = nil, apis = nil)
+		@root = 'root'
+		@controllers = controllers || { :index => Controller }
+		@apis = apis
+	end
+
+	# Process the given hash and mount the 
+	# defined controllers.
+	#
+	# [+controllers+]
+	#		A hash representing the mapping of
+	#		mount points to controllers.
+	#
+	# === Examples
+	#
+	# dispatcher.mount {
+	#		:index => MainController # mounts /
+	#		'users' => UsersController # mounts /users
+	#	}
+	
+	def mount(controllers)
+		(@controllers ||= {}).update(controllers)
+	end
+
+	# Add a new api to the dispatcher
+	#
+	# [+api+]
+	#		API symbol
+	# [+data+]
+	#		Data for this API [content_type, ..]
+	
+	def add_api(api, data)
+		(@apis ||= {})[api] = data
+	end
+
+	# Processes the path and dispatches to the corresponding
+	# controller/action pair.
+	# The base returned contains a trailing '/'.
+
+	def dispatch(path)
+		api = :xhtml
+
+		if @apis
+			@apis.each { |k, v| api = k if path.slice!(/#{k}\//) }
+		end
+
+		parts = path.split('/')
+
+		case parts.size
+			when 0
+				base = @root 
+				controller_class = @controllers[:index]
+				action = 'index'
+				
+			when 2
+				if controller_class = @controllers[parts[1]]
+					base = "#{@root}/#{parts[1]}"
+					action = 'index'
+				else
+					base = @root
+					controller_class = @controllers[:index]
+					action = parts[1]
+				end
+				
+			when 3
+				base = "#{@root}/#{parts[1]}"
+				controller_class = @controllers[parts[1]]
+				action = parts[2]
+		end
+	
+		content_type = @apis ? @apis[:api] : 'text/html'
+
+		return controller_class, "__#{api}__#{action}", base, content_type 
+	end
+	alias_method :split_path, :dispatch
+	
+end
+
+end

data/lib/nitro/filters.rb

@@ -1,17 +1,15 @@
-# code: 
-# * George Moschovitis  <gm@navel.gr>
-#
+#-- 
+# George Moschovitis  <gm@navel.gr>
 # (c) 2004 Navel, all rights reserved.
-# $Id: filters.rb 184 2004-12-07 14:42:22Z gmosx $
+# $Id: filters.rb 215 2005-01-24 10:44:05Z gmosx $
+#++
 
 module N
 
-# = Filtering
-#
 # Filtering functionality for renders/services. The design 
 # and implementation is HEAVILY influenced by Rails.
 #
-# Examples:
+# == Examples
 #
 # Filter as class:
 #
@@ -22,10 +20,11 @@ module N
 # 	before
 #		filter
 #		after
-#
+#--
 # TODO: 
 # implement inheritable filters.
-#
+#++
+
 module Filtering
 
 	# Ruby is sometimes VERY surprising, the following trick is needed
@@ -154,4 +153,4 @@ module Filtering
 	
 end
 
-end # module
+end 

data/lib/nitro/localization.rb

@@ -0,0 +1,42 @@
+# * George Moschovitis  <gm@navel.gr>
+# (c) 2004-2005 Navel, all rights reserved.
+# $Id: l10n.rb 185 2004-12-10 13:29:09Z gmosx $
+
+require 'nitro/filters'
+
+module N
+
+# Localization support.
+#--
+# TODO: use inflector to convert symbols to strings.
+#++
+
+class Localization
+
+	# This map gives the correct localization hash
+	# for the given locale.
+
+	attr_accessor :map
+
+	def initialize(map = {})
+		@map = map
+	end
+
+	# Return the localization hash for the given
+	# locale.
+
+	def get(locale = 'en')
+		locale || = 'en'
+		@map[locale]
+	end
+end
+
+# Localization filter
+
+module LocalizationFilter
+	def localize
+		@lc = @context.conf.lc.get(@session[:LC])
+	end
+end
+	
+end

data/lib/nitro/mail.rb

@@ -1,28 +1,25 @@
-# code:
 # * George Moschovitis  <gm@navel.gr>
-#
-# (c) 2004 Navel, all rights reserved.
-# $Id: mail.rb 164 2004-11-18 11:47:50Z gmosx $
+# (c) 2004-2005 Navel, all rights reserved.
+# $Id: mail.rb 248 2005-01-31 13:38:34Z gmosx $
 
-require "net/smtp"
+require 'net/smtp'
 
 module N
 
-# = Mail
-#
 # A thin wrapper arround net/smtp
-#
+
 module Mail
-	
+
+	mattr_accessor :smtp_server, 'localhost'
+
 	# Send an email
-	#
-	#
+
 	def self.send(from, to, body)
-		Net::SMTP.start($smtp_server, 25) { |smtp|
+		Net::SMTP.start(N::Mail.smtp_server, 25) do |smtp|
       smtp.send_message(body, from, to)
-		}
+		end
 	end
 	
 end
 
-end # module
+end

data/lib/nitro/render.rb

@@ -0,0 +1,275 @@
+# * George Moschovitis  <gm@navel.gr>
+# (c) 2004-2005 Navel, all rights reserved.
+# $Id$
+
+require 'glue/attribute'
+require 'glue/misc'
+require 'glue/object'
+
+require 'nitro/shaders'
+require 'nitro/buffering'
+
+module N
+	
+# Raise this exception to stop rendering.
+
+class RenderExit < Exception; end
+
+# Rendering utility methods
+
+module Rendering
+
+	# The default template name (no extension).
+
+	mattr_accessor :default_template, 'index'
+
+	# The shader used for transforming templates.
+	# The default shader is very simple, here is a 
+	# typical example of a production shader pipeline:
+	#
+	# <tt>
+	#	Rendering.shader = 
+	#		XSLTShader.new("xsl/style.xsl",
+	#			RubyShader.new(
+	#				CompressShader.new
+	#			)
+	#		)
+	# </tt>
+
+	mattr_accessor :shader; @@shader = RubyShader.new
+
+	# If true, reloads all controllers. Useful in 
+	# development.
+
+	mattr_accessor :reload, :partial 
+	
+	# Given the action try find the matching template.
+	# Can search for xhtml or xml templates.
+	# Returns nil if no template file is found.
+	
+	def self.template_for_action(base, action, ext = :xhtml)
+		
+		# attempt to find a template of the form
+		# base/action.xhtml
+
+		path = "#{base}/#{action}.#{ext}".squeeze('/')
+		
+		unless File.exist?(path)
+
+			# attempt to find a template of the form
+			# base/action/index.xhtml
+
+			path = "#{base}/#{action}/#{Rendering.default_template}.#{ext}".squeeze('/')
+			
+			unless File.exist?(path)
+				# No template found!
+				path = nil
+			end
+		end
+		
+		return path
+	end
+	
+	# Transform a template to ruby rendering code.
+	
+	def self.transform_template(path, shader)
+		Logger.debug "Transforming '#{path}'" if $DBG
+
+		text = File.read(path)
+		hash, text = shader.process(path, text)
+		
+		return text
+	end
+	
+	# Compile a controller action.
+	
+	def self.compile_action(klass, action, base)
+		dummy, api, action = action.to_s.split('__')
+
+		# This is not a controller action.
+
+		return false unless action
+
+		Logger.debug "Compiling action '#{base}/#{action}'" if $DBG
+
+		valid = false
+		
+		code = %{
+			def __#{api}__#{action}
+		}
+		
+		# call 'before' filter chain.
+		
+		if klass.respond_to?(:before_filters)
+			code << %{
+				#{klass.gen_filters_call_code(klass.before_filters)}
+			}
+		end
+
+		# call the action
+		
+		if klass.instance_methods.include?(action)
+			valid = true
+			code << %{
+				#{action}();
+			}
+		end
+
+		# call the programmatically generated template if exists.
+
+		if klass.instance_methods.include?("#{action}__#{api}")
+			valid = true
+			code << %{
+				return unless #{action}__#{api}();
+			}
+		end
+		
+		# call the template if exists.
+		
+		if template = template_for_action(base, action)
+			valid = true
+			code << %{
+				return unless __#{api}__#{action}__template();
+			}
+		end
+
+		# raise "Invalid action '#{action}' for '#{klass}'!" unless valid
+		return false unless valid
+
+		# call 'after' filter chain.
+
+		if klass.respond_to?(:after_filters)
+			code << %{
+				#{klass.gen_filters_call_code(klass.after_filters)}
+			}
+		end
+		
+		code << %{
+				redirect_referer if @out.empty?
+			end
+		}
+		
+		if template
+			code << %{
+				def __#{api}__#{action}__template
+					#{transform_template(template, Rendering.shader)}
+				end
+			}
+		end
+		
+		klass.class_eval(code)
+
+		return true
+	end
+
+end
+
+# The rendering mixin. 
+
+module Render
+
+	# The outbut buffer. The output of a script/action is accumulated
+	# in this buffer.
+	
+	attr_accessor :out	
+	
+	# The context.
+	
+	attr_accessor :context
+	alias_method :ctx, :context
+	alias_method :ctx=, :context=
+	alias_method :request, :context
+	
+	# An array holding the rendering errors for this
+	# request.
+	
+	attr_accessor :rendering_errors
+
+	# Initialize the render.
+	#
+	# [+context+]
+	#		A parent render/controller acts as the context.
+
+	def initialize(context, base)
+		@context = context
+		@out = context.out
+		@base = base
+	end
+	
+	# Renders the action denoted by path. The path
+	# is resolved by the dispatcher to get the correct
+	# controller.
+	
+	def render(path)
+		Logger.debug "Rendering '#{path}'." if $DBG
+		
+		klass, action, base, ctype = @context.dispatcher.dispatch(path)
+
+		if :full == Rendering.reload
+			def_file = klass::DEF_FILE
+			Controller.remove_subclasses
+			load(def_file)
+		end
+			
+		@context.content_type = ctype
+
+		raise 'No controller for action' unless klass
+		
+		if self.class == klass 
+			self.send(action)
+		else
+			klass.new(self, base).send(action)
+		end
+
+	rescue RenderExit => e
+
+		# Just stop rendering.
+		# For example called by redirects.
+		
+	rescue Exception, StandardError => e
+		log_error "Error while handling '#{path}'."
+		log_error pp_exception(e)
+		
+		# More fault tolerant, only flags the erroneous box with 
+		# error not the full page.
+		
+		@out << '(error)'
+	end
+
+	# Send a redirect response.
+	
+	def redirect(url, status = 303)
+		@context.status = status
+		@context.out = "<html><a href=\"#{url.to_s}\">#{url.to_s}</a>.</html>\n"
+		@context.response_headers['location'] = url.to_s
+
+		raise RenderExit
+	end
+	
+	# Redirect to the referer of this method.
+	
+	def redirect_referer(postfix = nil, status = 303)
+		redirect("#{@context.referer}#{postfix}", status)
+	end
+
+	# Log a rendering error.
+
+	def log_error(str)
+		@rendering_errors ||= []
+		@rendering_errors << str
+
+		# gmosx: Hmm perhaps this should not be logged 
+		# to avoid DOS attacks.
+
+		Logger.error str
+	end
+
+	# Convenience method to lookup the session.
+
+	def session
+		@context.session
+	end
+	
+end
+
+end