nitro 0.19.0 → 0.20.0

data/lib/nitro/cookie.rb

@@ -1,7 +1,3 @@
-# * George Moschovitis  <gm@navel.gr>
-# (c) 2004-2005 Navel, all rights reserved.
-# $Id: cookie.rb 1 2005-04-11 11:04:30Z gmosx $
-
 module Nitro
 
 # Encapsulates a HTTP Cookie.
@@ -15,8 +11,9 @@ class Cookie
 	def initialize(name, value)
 		@name = name
 		@value = value
-		@version = 0     # Netscape Cookie
-		@domain = @path = @secure = @comment = @max_age =
+		@version = 0		# Netscape Cookie
+		@path = '/'			# gmosx: KEEP this!
+		@domain = @secure = @comment = @max_age =
 		@expires = @comment_url = @discard = @port = nil
 	end
 
@@ -44,3 +41,6 @@ class Cookie
 end
 
 end
+
+# * George Moschovitis <gm@navel.gr>
+

data/lib/nitro/dispatcher.rb

@@ -1,14 +1,20 @@
-module Nitro
+require 'facet/object/special_class'
 
 require 'nitro/controller'
 require 'nitro/routing'
-require 'nitro/simple'
+require 'nitro/mixin/helper'
+
+module Nitro
 
 # The Dispatcher manages a set of controllers.
 
 class Dispatcher 
 
 	include Router
+
+	unless const_defined?('ROOT')
+		ROOT = '/'
+	end
 	
 	# The public root directory. The files in this
 	# directory are published by the web server.
@@ -40,16 +46,21 @@ class Dispatcher
 		@template_root = @public_root
 		
 		if controllers and controllers.is_a?(Class) and controllers.ancestors.include?(Controller)
-			controllers = { :root => controllers }
+			controllers = { '/' => controllers }
 		else
-			controllers ||= { :root => SimpleController }
+			controllers ||= { '/' => SimpleController }
 		end
 
 		mount(controllers)
 	end
 
+	# A published object is exposed through a REST interface.
+	# Only the public non standard methods of the object are
+	# accessible. Published objects implement the Controller
+	# part of MVC.
+	#
 	# Process the given hash and mount the 
-	# defined controllers.
+	# defined classes (controllers).
 	#
 	# Input:
 	#
@@ -59,16 +70,44 @@ class Dispatcher
 	#
 	# === Examples
 	#
-	# dispatcher.mount(
-	#		:root => MainController, # mounts /
-	#		'users' => UsersController # mounts /users
+	# disp.mount(
+	#		'/' => MainController, # mounts /
+	#		'/users' => UsersController # mounts /users
 	#	)
+	# disp.publish '/' => MainController
 	
 	def add_controller(controllers)
+		for c in controllers.values
+			unless (c.ancestors.include?(Controller) or c.ancestors.include?(Publishable))
+				c.send :include, Publishable
+			end
+
+			auto_mixin(c)			
+		end
+
 		(@controllers ||= {}).update(controllers)
-		update_routes
+		
+		update_routes()
 	end
 	alias_method :mount, :add_controller
+	alias_method :publish, :add_controller
+
+	# Call this method to automatically include helpers in the
+	# Controllers. For each Controller 'XxxController' the
+	# default helper 'Helper' and the auto mixin
+	# 'XxxControllerMixin' (if it exists) are included.
+	
+	def auto_mixin(c)
+			c.helper(Helper)			
+			
+			begin
+				if helper = Module.by_name("#{c}Mixin")
+					c.helper(helper)
+				end
+			rescue NameError
+				# The auto helper is not defined.
+			end
+	end
 
 	# Update the routes. Typically called after a new
 	# Controller is mounted.
@@ -76,7 +115,7 @@ class Dispatcher
 	def update_routes
 		@routes = []
 		@controllers.each do |base, c|
-			base = (base == :root ? '' : "/#{base}")
+			base = '' if base == '/'
 			c.action_metadata.each do |action, meta|
 				if route = meta[:route]
 					@routes << [route, "#{base}/#{action}", *meta.params.keys]
@@ -94,6 +133,11 @@ class Dispatcher
 	#
 	# [:context]
 	#		The dispatching context.
+	#
+	#--
+	# FIXME: this is a critical method that should be optimized
+	# watch out for excessive String creation.
+	#++
 
 	def dispatch(path, context = nil)
 		path = route(path, context)
@@ -105,31 +149,31 @@ class Dispatcher
 			when 0
 				# / -> root.index
 				base = '/' 
-				klass = controller_class_for(:root, context)
+				klass = controller_class_for(base)
 				action = 'index'
 			
 			when 1 
-				if klass = controller_class_for(parts[0], context)
+				base = "/#{parts[0]}"
+				if klass = controller_class_for(base)
 					# controller/ -> controller.index
-					base = "/#{parts[0]}"
 					action = 'index'
 				else
 					# action/ -> root.action
 					base = '/'
-					klass = controller_class_for(:root, context)
+					klass = controller_class_for(base)
 					action = parts[0]
 				end
 				
 			else
-				if klass = controller_class_for(parts[0], context)
+				base = "/#{parts[0]}"
+				if klass = controller_class_for(base)
 					# controller/action -> controller.action
-					base = "/#{parts[0]}"
 					parts.shift
 					action = parts.join('__')
 				else
 					# action/ -> root.action
 					base = '/'
-					klass = controller_class_for(:root, context)
+					klass = controller_class_for(base)
 					action = parts.join('__')
 				end
 		end
@@ -141,7 +185,7 @@ class Dispatcher
 	# Get the controller for the given key.
 	# Also handles reloading of controllers.
 
-	def controller_class_for(key, context)
+	def controller_class_for(key)
 		klass = @controllers[key]
 
 		if klass and (:full == Rendering.reload)

data/lib/nitro/element.rb

@@ -144,10 +144,13 @@ class ElementProcessor # :nodoc: all
 	def render(source)
 		listener = Listener.new
 		REXML::Document.parse_stream(source, listener)
-		# gmosx, FIXME: optimize this, how?
+		# gmosx, FIXME: optimize this, how?
 		listener.buffer.gsub! /<(.*) ([^>]*)><\/\1>/, '<\1 \2 />'
+		listener.buffer.gsub! /<(.*)><\/\1>/, '<\1 />'
 		return listener.buffer
 	end
 end
 
 end
+
+# * George Moschovitis <gm@navel.gr>

data/lib/nitro/element/java_script.rb

@@ -0,0 +1,15 @@
+require 'nitro/element'
+
+class JavaScript < Nitro::Element
+	def render
+		%~
+	  <script type="text/javascript" language="javascript">
+    // <![CDATA[
+    	#{content}
+    // ]]>
+    </script> 
+    ~    	
+	end
+end
+
+# * George Moschovitis <gm@navel.gr>

data/lib/nitro/localization.rb

@@ -1,7 +1,3 @@
-# * George Moschovitis  <gm@navel.gr>
-# (c) 2004-2005 Navel, all rights reserved.
-# $Id: localization.rb 17 2005-04-14 16:03:40Z gmosx $
-
 require 'yaml'
 
 require 'glue/aspects'
@@ -152,3 +148,6 @@ class LocalizationShader < Shader
 end
 
 end
+
+# * George Moschovitis <gm@navel.gr>
+

data/lib/nitro/markup.rb

@@ -70,11 +70,11 @@ end
 module Markup
 	def self.expand_html!(str)
 		return unless str
-		str.gsub!(/"/, '"')		
-		str.gsub!(/'/, ''')		
+#		str.gsub!(/"/, '"')		
+#		str.gsub!(/'/, ''')		
 		str.gsub!(/</, '&lt;')		
 		str.gsub!(/>/, '&gt;')		
-		str.gsub!(/\r\n/, ' <br />')
+#		str.gsub!(/\r\n/, ' <br />')
 		return str
 	end
 
@@ -135,7 +135,7 @@ class MarkupShader < Shader
 	
 	def process(hash, text)
 		# handle strings 
-		text.gsub!(/\#\{\{(.*?)\}\}/, '#{RedCloth.new(\1).to_html}')
+		text.gsub!(/\#\{\{(.*?)\}\}/, '#{RedCloth.new(Markup.expand(\1)).to_html}')
 
 		process_next(hash, text)
 	end

data/lib/nitro/mixin/debug.rb

@@ -0,0 +1,30 @@
+module Nitro
+
+# A collection of useful debuging methods.
+
+module DebugMixin
+
+private
+
+	# Returns a <pre>-tag set with the +object+ dumped by YAML. 
+	# Very readable way to inspect an object.
+	#--
+	# TODO: make safe html.
+	#++
+	
+	def debug(object)
+	  begin
+	    Marshal::dump(object)
+	    "<pre class='debug_dump'>#{object.to_yaml.gsub("  ", "&nbsp; ")}</pre>"
+	  rescue Object
+	    # Object couldn't be dumped, perhaps because of singleton 
+	    # methods, this is the fallback.
+	    "<code class='debug_dump'>#{object.inspect}</code>"
+	  end
+	end
+
+end
+
+end
+
+# * George Moschovitis <gm@navel.gr>

data/lib/nitro/mixin/helper.rb

@@ -0,0 +1,14 @@
+require 'nitro/mixin/debug'
+
+module Nitro
+
+# This mixin is included by default in all Controllers.
+# This is the place to add general purpose utility methods to
+# be shared accross all Controllers.
+
+module Helper
+	include DebugMixin
+	# This is an open module, extend in your application.
+end
+
+end

data/lib/nitro/mixin/javascript.rb

@@ -0,0 +1,137 @@
+module Nitro
+
+# A collection of useful Javascript helpers. This modules
+# integrates helpers for the following javascript libraries:
+#
+# * behaviour.js
+# * prototype.js
+# * effects.js
+# * dragdrop.js
+# * controls.js
+
+module JavascriptMixin
+
+private
+
+	unless const_defined? :DEFAULT_JAVASCRIPT_FILES
+		DEFAULT_JAVASCRIPT_FILES = [
+			'js/behaviour.js', 
+			'js/prototype.js', 
+			'js/effects.js', 
+			'js/dragdrop.js', 
+			'js/controls.js'
+		]
+	end
+
+	# :section: behaviour.js
+	
+	def behaviour(id, js)
+		@_behaviours ||= []
+		@_behaviours << [id, js]
+	end
+	
+	# :section: prototype.js
+
+	def live_request(id, options = {})
+		if href = options.delete(:href)
+			behaviour "##{id}", %{
+				el.onclick = function() {
+					new Ajax.Request('#{href}', #{hash_to_js(options)});
+					return false;
+				}
+			}
+		else
+			behaviour "##{id}", %{
+				el.onclick = function() {
+					new Ajax.Request(el.href, #{hash_to_js(options)});
+					return false;
+				}
+			}
+		end
+	end
+	alias_method :live, :live_request
+	alias_method :async, :live_request
+	
+	# :section: script.aculo.us dragdrop.js
+	
+	# Make the element dragable.
+	
+	def draggable(id, options = {})
+		@_javascript ||= ''
+		@_javascript << "\nnew Draggable('#{id}', #{hash_to_js(options)});"
+	end
+	
+	# :section: script.aculo.us controls.js
+	
+	# Add autocomplete functionality to a text field.
+	
+	def auto_complete(id, options = {})
+		update = options[:update] || "#{id}_auto_complete"
+		url = options[:url] || "#{id}_auto_complete"
+		@_javascript ||= ''
+		@_javascript << "\nnew Ajax.Autocompleter('#{id}', '#{update}', '#{url}');"
+		
+		# Turn off the browser's autocomplete functionality to avoid
+		# interference.
+		
+		behaviour "##{id}", %{
+			el.autocomplete = 'off';
+		}
+	end
+	
+	# :section: general javascript helpers.
+	
+	# Include external javascript file.
+	
+	def include_script(files = DEFAULT_JAVASCRIPT_FILES)
+		code = ''
+		
+		for file in [files].flatten
+			code << %|<script src="#{file}" type="text/javascript">//</script>|
+		end
+		
+		return code
+	end
+	
+	# Escape carrier returns and single and double quotes for JavaScript segments.
+  
+  def escape_javascript(js)
+  	(js || '').gsub(/\r\n|\n|\r/, "\\n").gsub(/["']/) { |m| "\\#{m}" }
+  end
+
+	# Converts a Ruby hash to a Javascript hash.
+	
+	def hash_to_js(options)
+    '{' + options.map {|k, v| "#{k}:#{v}"}.join(', ') + '}'
+  end
+
+	# Emits the aggregated helper javascript.
+	#--
+	# FIXME: refactor this!
+	#++
+	
+	def helper_script
+		code = %|<script type="text/javascript">\n|
+		unless @_behaviours.empty?
+			code << %|var _behaviours = {\n|
+			compo = []
+			for id, js in @_behaviours
+				compo << %|'#{id}': function(el) { #{js} \n }|
+			end
+			code << compo.join(',')
+			code << %|
+			}
+			Behaviour.register(_behaviours);		
+			|
+		end
+		code << %|
+				#@_javascript
+			</script>
+		|
+	end
+	
+end
+
+end
+
+# * George Moschovitis <gm@navel.gr>