nitro 0.20.0 → 0.21.0

data/lib/nitro/controller.rb

@@ -6,71 +6,72 @@ require 'nitro/render'
 require 'nitro/scaffold'
 require 'nitro/caching'
 require 'nitro/flash'
+require 'nitro/mixin/markup'
 
 module Nitro
 
 # Encapsulates metadata that describe an action 
 # parameter. 
 # 
-#	[+default+]
-#		The default value.
+#  [+default+]
+#    The default value.
 #
-#	[+format+]
-#		The expected format.
+#  [+format+]
+#    The expected format.
 #
-#	[+required+]
-#		Is this parameter required?
+#  [+required+]
+#    Is this parameter required?
 
 unless const_defined? :ActionParam
-	ActionParam = Struct.new(:default, :format, :required)
+  ActionParam = Struct.new(:default, :format, :required)
 end
 
 # Encapsulates metadata that describe an action.
 
 class ActionMeta < Hash
 
-	# The arguments of the given method.
-	
-	attr_accessor :params
-
-	# Initialize the metadata.
-
-	def initialize(options)
-		@params = {}
-		update(options)
-	end
-
-	# Update the metadata.
-	# 
-	# [+options+]
-	#		A hash containing the metadata. Options with Symbol
-	#		keys are considered metadata, options with
-	#		String keys are the named parameters for the action.
-	
-	def update(options)
-		options.each do |k, v|
-			case k
-				when String
-					# A key of type String denotes a parameter.
-					case v
-						when Regexp
-							@params[k] = ActionParam.new(nil, v, nil)
-						when ActionParam
-							@params[k] = v
-						else	
-							if v == :required
-								@params[k] = ActionParam.new(nil, nil, true)
-							else
-								@params[k] = ActionParam.new(v, nil, nil)
-							end
-					end
-				when Symbol
-					self[k] = v
-				else
-					raise TypeError.new('The keys must be either Symbols or Strings.')
-			end
-		end
-	end
+  # The arguments of the given method.
+  
+  attr_accessor :params
+
+  # Initialize the metadata.
+
+  def initialize(options)
+    @params = {}
+    update(options)
+  end
+
+  # Update the metadata.
+  # 
+  # [+options+]
+  #    A hash containing the metadata. Options with Symbol
+  #    keys are considered metadata, options with
+  #    String keys are the named parameters for the action.
+  
+  def update(options)
+    options.each do |k, v|
+      case k
+        when String
+          # A key of type String denotes a parameter.
+          case v
+            when Regexp
+              @params[k] = ActionParam.new(nil, v, nil)
+            when ActionParam
+              @params[k] = v
+            else  
+              if v == :required
+                @params[k] = ActionParam.new(nil, nil, true)
+              else
+                @params[k] = ActionParam.new(v, nil, nil)
+              end
+          end
+        when Symbol
+          self[k] = v
+        else
+          raise TypeError.new('The keys must be either Symbols or Strings.')
+      end
+    end
+  end
 
 end
 
@@ -79,103 +80,94 @@ end
 # interface.
 
 module Publishable
-	def self.append_features(base)
-
-		base.module_eval do
-			include Render
-			include Glue::Aspects
-			include Flashing
-			include Glue::Helpers
-		
-			class << self
-				attr_accessor :template_root
-			end
-			
-			@template_root = 'public'	
-		end
-
-		# Define metadata for an action. This is a helper
-		# macro.
-
-		base.module_eval do
-			def self.action(name, options)
-				if meta = action_metadata[name]
-					meta.update(options)
-				else
-					action_metadata[name] = ActionMeta.new(options)
-				end
-			end
-		end
-
-		# Aliases an action
-		#--
-		# gmosx, FIXME: better implementation needed.
-		#++
-
-		base.module_eval do
-			def self.alias_action(new, old)
-				alias_method new, old
-				md = action_metadata[old] || ActionMetadata.new
-				md[:view] = old
-				action_metadata[new] = md
-			end
-		end
-
-		# Return the 'action' methods for this Controller.
-		# Some dangerous methods from ancestors are removed.
-		# All private methods are ignored.
-		
-		base.module_eval do
-			def self.action_methods
-				classes = self.ancestors.reject do |a| 
-					[Object, Kernel, Render, Controller, Caching].include?(a) 
-				end
-
-				classes.delete(PP::ObjectMixin) if defined?(PP::ObjectMixin)
-				
-				methods =  classes.inject([]) do |action_methods, klass| 
-					action_methods + klass.public_instance_methods(false) 
-				end
-
-				# gmosx: add the default action (leave this?)
-				# methods << 'index'
-								
-				return methods
-			end
-		end
-		
-		# A hash containing metadata for the action
-		# methods.
-
-		base.module_eval do
-			def self.action_metadata
-				# FIXME: improve this.
-				@action_metadata ||= {}
-				@action_metadata
-			end
-		end		
-		
-		base.module_eval do
-			def initialize(context, base = nil)
-				super
-				self.class.template_root ||= 'public'
-			end
-		end		
-		
-		# Use the method_missing hook to compile the actions
-		# for this controller.
-	
-		base.module_eval do
-			def method_missing(action, *args)
-				if Rendering.compile_action(self.class, action)
-					send(action, *args)
-				else
-					super
-				end
-			end
-		end		
-		
-	end
+  def self.append_features(base)
+
+    base.module_eval do
+      include Render
+      include Glue::Aspects
+      include Flashing
+      include Glue::Helpers
+    
+      class << self
+        attr_accessor :template_root
+      end      
+    end
+
+    # Define metadata for an action. This is a helper
+    # macro.
+
+    base.module_eval do
+      def self.action(name, options)
+        if meta = action_metadata[name]
+          meta.update(options)
+        else
+          action_metadata[name] = ActionMeta.new(options)
+        end
+      end
+    end
+
+    # Aliases an action
+    #--
+    # gmosx, FIXME: better implementation needed.
+    #++
+
+    base.module_eval do
+      def self.alias_action(new, old)
+        alias_method new, old
+        md = action_metadata[old] || ActionMetadata.new
+        md[:view] = old
+        action_metadata[new] = md
+      end
+    end
+
+    # Return the 'action' methods for this Controller.
+    # Some dangerous methods from ancestors are removed.
+    # All private methods are ignored.
+    
+    base.module_eval do
+      def self.action_methods
+        classes = self.ancestors.reject do |a| 
+          [Object, Kernel, Render, Controller, Caching].include?(a) 
+        end
+
+        classes.delete(PP::ObjectMixin) if defined?(PP::ObjectMixin)
+        
+        methods =  classes.inject([]) do |action_methods, klass| 
+          action_methods + klass.public_instance_methods(false) 
+        end
+
+        # gmosx: add the default action (leave this?)
+        # methods << 'index'
+                
+        return methods
+      end
+    end
+    
+    # A hash containing metadata for the action
+    # methods.
+
+    base.module_eval do
+      def self.action_metadata
+        # FIXME: improve this.
+        @action_metadata ||= {}
+        @action_metadata
+      end
+    end    
+        
+    # Use the method_missing hook to compile the actions
+    # for this controller.
+  
+    base.module_eval do
+      def method_missing(action, *args)
+        if Compiler.new.compile(self.class, action)
+          send(action, *args)
+        else
+          super
+        end
+      end
+    end    
+    
+  end
 end
 
 # The Controller part in the MVC paradigm. The controller's 
@@ -183,18 +175,19 @@ end
 # contains the Publishable mixin and additional helper mixins.
 
 class Controller 
-	include Publishable
-	include Scaffolding
-	include Caching
-	
-	# The default action.
-=begin	
-	def index
-		print %{
-			This is the placeholder action is provided as a default for #{self.class.name}.<br />
-			You probably want to <b>implement your custom action</b> here.
-		}
-	end
+  include Publishable
+  include Scaffolding
+  include Caching
+  include Markup
+  
+  # The default action.
+=begin  
+  def index
+    print %{
+      This is the placeholder action is provided as a default for #{self.class.name}.<br />
+      You probably want to <b>implement your custom action</b> here.
+    }
+  end
 =end
 end
 

data/lib/nitro/cookie.rb

@@ -3,40 +3,40 @@ module Nitro
 # Encapsulates a HTTP Cookie.
 
 class Cookie
-	attr_reader :name
-	attr_accessor :value, :version
-	attr_accessor :domain, :path, :secure
-	attr_accessor :comment, :max_age
-
-	def initialize(name, value)
-		@name = name
-		@value = value
-		@version = 0		# Netscape Cookie
-		@path = '/'			# gmosx: KEEP this!
-		@domain = @secure = @comment = @max_age =
-		@expires = @comment_url = @discard = @port = nil
-	end
-
-	def expires=(t)
-		@expires = t && (t.is_a?(Time) ? t.httpdate : t.to_s)
-	end
-
-	def expires
-		@expires && Time.parse(@expires)
-	end
-
-	def to_s
-		ret = ""
-		ret << @name << "=" << @value
-		ret << "; " << "Version=" << @version.to_s if @version > 0
-		ret << "; " << "Domain="  << @domain  if @domain
-		ret << "; " << "Expires=" << @expires if @expires
-		ret << "; " << "Max-Age=" << @max_age.to_s if @max_age
-		ret << "; " << "Comment=" << @comment if @comment
-		ret << "; " << "Path="    << @path if @path
-		ret << "; " << "Secure"   if @secure
-		ret
-	end
+  attr_reader :name
+  attr_accessor :value, :version
+  attr_accessor :domain, :path, :secure
+  attr_accessor :comment, :max_age
+
+  def initialize(name, value)
+    @name = name
+    @value = value
+    @version = 0    # Netscape Cookie
+    @path = '/'      # gmosx: KEEP this!
+    @domain = @secure = @comment = @max_age =
+    @expires = @comment_url = @discard = @port = nil
+  end
+
+  def expires=(t)
+    @expires = t && (t.is_a?(Time) ? t.httpdate : t.to_s)
+  end
+
+  def expires
+    @expires && Time.parse(@expires)
+  end
+
+  def to_s
+    ret = ""
+    ret << @name << "=" << @value
+    ret << "; " << "Version=" << @version.to_s if @version > 0
+    ret << "; " << "Domain="  << @domain  if @domain
+    ret << "; " << "Expires=" << @expires if @expires
+    ret << "; " << "Max-Age=" << @max_age.to_s if @max_age
+    ret << "; " << "Comment=" << @comment if @comment
+    ret << "; " << "Path="    << @path if @path
+    ret << "; " << "Secure"   if @secure
+    ret
+  end
 
 end
 

data/lib/nitro/dispatcher.rb

@@ -10,192 +10,201 @@ module Nitro
 
 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.
-
-	attr_accessor :public_root
-	
-	# The template root directory. By default this
-	# points to the public root directory to allow
-	# for PHP/JSP/ASP style programming. But you should
-	# probably change this to another directory for
-	# extra security.
-
-	attr_accessor :template_root
-
-	# The controllers map.
-
-	attr_accessor :controllers
-
-	# Create a new Dispatcher.
-	#
-	# Input:
-	#
-	# [+controllers+]
-	#		Either a hash of controller mappings or a single
-	#		controller that gets mapped to :root.
-	
-	def initialize(controllers = nil)
-		@public_root = 'public'
-		@template_root = @public_root
-		
-		if controllers and controllers.is_a?(Class) and controllers.ancestors.include?(Controller)
-			controllers = { '/' => controllers }
-		else
-			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 classes (controllers).
-	#
-	# Input:
-	#
-	# [+controllers+]
-	#		A hash representing the mapping of
-	#		mount points to controllers.
-	#
-	# === Examples
-	#
-	# 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()
-	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.
-
-	def update_routes
-		@routes = []
-		@controllers.each do |base, c|
-			base = '' if 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 '/'.
-	#
-	# [+path+]
-	#		The path to dispatch.
-	#
-	# [: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)
-
-		parts = path.split('/')
-		parts.shift
-
-		case parts.size
-			when 0
-				# / -> root.index
-				base = '/' 
-				klass = controller_class_for(base)
-				action = 'index'
-			
-			when 1 
-				base = "/#{parts[0]}"
-				if klass = controller_class_for(base)
-					# controller/ -> controller.index
-					action = 'index'
-				else
-					# action/ -> root.action
-					base = '/'
-					klass = controller_class_for(base)
-					action = parts[0]
-				end
-				
-			else
-				base = "/#{parts[0]}"
-				if klass = controller_class_for(base)
-					# controller/action -> controller.action
-					parts.shift
-					action = parts.join('__')
-				else
-					# action/ -> root.action
-					base = '/'
-					klass = controller_class_for(base)
-					action = parts.join('__')
-				end
-		end
-
-		return klass, "#{action}_action", base
-	end
-	alias_method :split_path, :dispatch
-
-	# Get the controller for the given key.
-	# Also handles reloading of controllers.
-
-	def controller_class_for(key)
-		klass = @controllers[key]
-
-		if klass and (:full == Rendering.reload)
-			klass.instance_methods.grep(/(action$)|(template$)/).each do |m|
-				klass.send(:remove_method, m) rescue nil
-			end
-		end
-		
-		return klass		
-	end
+  include Router
+
+  # The map.
+  
+  setting :map, :default => { '/' => SimpleController }, :doc => 'The controller map'
+
+  unless const_defined? :ROOT
+    ROOT = '/'
+  end
+  
+  # The public root directory. The files in this
+  # directory are published by the web server.
+
+  attr_accessor :public_root
+  
+  # The template root directory. By default this points to the 
+  # public root directory to allow for PHP/JSP/ASP style 
+  # programming. But you should probably change this to 
+  # another directory for extra security.
+
+  attr_accessor :template_root
+
+  # The controllers map.
+
+  attr_accessor :controllers
+
+  # Create a new Dispatcher.
+  #
+  # Input:
+  #
+  # [+controllers+]
+  #    Either a hash of controller mappings or a single
+  #    controller that gets mapped to :root.
+  
+  def initialize(controllers = nil)
+    @public_root = 'public'
+    @template_root = @public_root
+    
+    if controllers and controllers.is_a?(Class) and controllers.ancestors.include?(Controller)
+      controllers = { '/' => controllers }
+    else
+      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 classes (controllers).
+  #
+  # Input:
+  #
+  # [+controllers+]
+  #    A hash representing the mapping of
+  #    mount points to controllers.
+  #
+  # === Examples
+  #
+  # disp.mount(
+  #    '/' => MainController, # mounts /
+  #    '/users' => UsersController # mounts /users
+  #  )
+  # disp.publish '/' => MainController
+  
+  def add_controller(controllers)
+    for path, c in controllers
+      unless (c.ancestors.include?(Controller) or c.ancestors.include?(Publishable))
+        c.send :include, Publishable
+      end
+
+      auto_mixin(c)      
+      
+      # Try to setup a template_root if none is defined:
+      
+      unless c.template_root
+        c.template_root = "#{Template.root}#{path}".gsub(/\/$/, '')
+      end
+    end
+
+    (@controllers ||= {}).update(controllers)
+    
+    update_routes()
+  end
+  alias_method :mount, :add_controller
+  alias_method :publish, :add_controller
+  alias_method :map=, :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.
+
+  def update_routes
+    @routes = []
+    @controllers.each do |base, c|
+      base = '' if 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 '/'.
+  #
+  # [+path+]
+  #    The path to dispatch.
+  #
+  # [: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)
+
+    parts = path.split('/')
+    parts.shift
+
+    case parts.size
+      when 0
+        # / -> root.index
+        base = '/' 
+        klass = controller_class_for(base)
+        action = 'index'
+      
+      when 1 
+        base = "/#{parts[0]}"
+        if klass = controller_class_for(base)
+          # controller/ -> controller.index
+          action = 'index'
+        else
+          # action/ -> root.action
+          base = '/'
+          klass = controller_class_for(base)
+          action = parts[0]
+        end
+        
+      else
+        base = "/#{parts[0]}"
+        if klass = controller_class_for(base)
+          # controller/action -> controller.action
+          parts.shift
+          action = parts.join('__')
+        else
+          # action/ -> root.action
+          base = '/'
+          klass = controller_class_for(base)
+          action = parts.join('__')
+        end
+    end
+
+    return klass, "#{action}_action", base
+  end
+  alias_method :split_path, :dispatch
+
+  # Get the controller for the given key.
+  # Also handles reloading of controllers.
+
+  def controller_class_for(key)
+    klass = @controllers[key]
+
+    if klass and Compiler.reload
+      klass.instance_methods.grep(/(action$)|(template$)/).each do |m|
+        klass.send(:remove_method, m) rescue nil
+      end
+    end
+    
+    return klass    
+  end
 
 end