nitro 0.25.0 → 0.26.0

data/lib/nitro/dispatcher.rb

@@ -6,32 +6,19 @@ require 'nitro/helper/default'
 
 module Nitro
 
-# The Dispatcher manages a set of controllers.
+# Raised when an action can not be found for a path
+# check for this in your error action to catch as if 404
 
-class Dispatcher 
-
-  include Router
+class NoActionError < NoMethodError; end
 
-  # The dispatcher specialization used.
+# The Dispatcher manages a set of controllers. It maps
+# a request uri to a [controller, action] pair.
 
-  setting :mode, :default => :nice, :doc => 'The dispatcher specialization used'
-
-  unless const_defined? :ROOT
-    ROOT = '/'
-  end
-  
-  # The public root directory. The files in this
-  # directory are published by the web server.
+class Dispatcher 
+  include Router
 
-  attr_accessor :public_root
+  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
@@ -45,9 +32,6 @@ class Dispatcher
   #    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
@@ -87,12 +71,6 @@ class Dispatcher
 
       auto_mixin(c)      
       
-      # Perform mount-time initialization of the controller.
-
-      if c.respond_to? :mounted
-        c.mounted(path)
-      end
-
       # Try to setup a template_root if none is defined:
       
       unless c.template_root
@@ -102,6 +80,12 @@ class Dispatcher
           end
         }
       end
+
+      # Keep the mount point as an annotation.
+      
+      c.ann.self.mount_point = path.gsub(/^\//, '')
+      
+      c.mounted(path) if c.respond_to?(:mounted)
     end
 
     (@controllers ||= {}).update(controllers)
@@ -138,13 +122,14 @@ class Dispatcher
     @controllers.each do |base, c|
       base = '' if base == '/'
       for m in c.action_methods
-        if route = c.ann(:m).route and (!route.nil?)
-          unless c.ann(:m).params.nil?
-            keys = c.ann(:m).params.keys
+        m = m.to_sym
+        if route = c.ann(m).route and (!route.nil?)
+          unless c.ann(m).params.nil?
+            keys = c.ann(m).params.keys
           else
             keys = []
           end
-          @routes << [route, "#{base}/#{action}", *keys]
+          @routes << [route, "#{base}/#{m}", *keys]
         end
       end
     end
@@ -159,17 +144,79 @@ class Dispatcher
   #
   # [:context]
   #    The dispatching context.
+  #
+  # The dispatching algorithm handles implicit nice urls. 
+  # Subdirectories are also supported.
+  # Action containing '/' separators look for templates 
+  # in subdirectories. The '/' char is converted to '__' 
+  # to find the actual action.
+  # 
+  # Returns the dispatcher class, the action name and the
+  # base url. For the root path, the base url is nil.
   #--
   # FIXME: this is a critical method that should be optimized
   # watch out for excessive String creation.
+  # TODO: add caching.
   #++
-
+  
   def dispatch(path, context = nil)
-    # Specialize in your application or use the default 
-    # specializations in lib/nitro/dispatcher/*
+    path = route(path, context)
+    
+    parts = path.split('/')
+    parts.shift # get rid of the leading '/'.
+
+    if klass = controller_class_for("/#{parts.first}")
+      base = "/#{parts.shift}"
+    else
+      base = nil
+      klass = controller_class_for(ROOT)
+    end
+
+    idx = 0
+    found = false
+    
+    # default to index
+    
+    parts << 'index' if parts.empty?
+    
+    # Try to find the first valid action substring
+    
+    action = ''
+    
+    for part in parts
+      action << part
+      if klass.respond_to_action_or_template?(action)  
+        found = true
+        break
+      end
+      action << '__'
+      idx += 1
+    end
+      
+    if found
+      parts.slice!(0, idx + 1)
+    else
+      #--
+      # FIXME: no raise to make testable.
+      #++
+      raise NoActionError, "No action to dispatch to on #{klass}"
+    end
+    
+    # push any remaining parts of the url onto the query 
+    # string for use with request
+    
+    unless parts.empty?
+      context.headers['QUERY_STRING'] = "#{parts.join(';')};#{context.headers['QUERY_STRING']}"
+    end
+
+    base = nil if base == ROOT
+    
+    return klass, "#{action}_action", base
   end
   alias_method :split_path, :dispatch
 
+private
+
   # Get the controller for the given key.
   # Also handles reloading of controllers.
 
@@ -180,6 +227,7 @@ class Dispatcher
       klass.instance_methods.grep(/(_action$)|(_template$)/).each do |m|
         klass.send(:remove_method, m) rescue nil
       end
+      klass.compile_scaffolding_code if klass.respond_to?(:compile_scaffolding_code)
     end
     
     return klass    
@@ -190,3 +238,4 @@ end
 end
 
 # * George Moschovitis <gm@navel.gr>
+# * Chris Farmiloe <chris.farmiloe@farmiloe.com>

data/lib/nitro/element.rb

@@ -1,6 +1,3 @@
-require 'rexml/document'
-require 'rexml/streamlistener'
-
 require 'nano/string/capitalized'
 require 'nano/string/camelize'
 require 'mega/annotation'
@@ -8,6 +5,9 @@ require 'mega/annotation'
 require 'glue/flexob'
 require 'glue/configuration'
 
+# load the element compiler here for compatibility?
+#require 'nitro/compiler/elements'
+
 module Nitro
 
 # A programmatically generated element.
@@ -99,107 +99,5 @@ class Element
   end
 end
 
-# Processes a page containing elements.
-
-class ElementProcessor # :nodoc: all
-
-  class Listener # :nodoc: all
-    include REXML::StreamListener
-    
-    attr_accessor :buffer
-    attr_accessor :stack
-    
-    def initialize
-      super
-      @buffer = ''
-      @stack = []
-    end
-    
-    PREFIX_RE = /^#{Element.prefix}:/
-    CAPITALIZED_RE = /^[A-Z]/
-    
-    def tag_start(name, attributes)    
-      # check if the name starts with the element prefix, or
-      # is capitalized.
-      if name =~ PREFIX_RE or name =~ CAPITALIZED_RE    
-        name = name.split(':')[1].camelize if name =~ PREFIX_RE
-        
-        obj = Object.const_get(name).new
-        
-        attributes.each do | k, v | 
-          obj.instance_variable_set("@#{k}", v)
-        end        
-        
-        @stack.push [obj, @buffer, @parent]
-        
-        @buffer = obj._text
-        @parent.add_child(obj) if @parent
-        
-        @parent = obj
-      else # This is a static element.
-        attrs = []
-        
-        attributes.each do | k, v | 
-          attrs << %|#{k}="#{v}"|
-        end
-        
-        attrs = attrs.empty? ? nil : " #{attrs.join(' ')}"
-        
-        @buffer << "<#{name}#{attrs}>"
-      end
-    end
-
-    def tag_end(name)    
-      # check if the name starts with the element prefix, or
-      # is capitalized.
-      if name =~ PREFIX_RE or name =~ CAPITALIZED_RE    
-         name = name.split(':')[1].camelize if name =~ PREFIX_RE
-        obj, @buffer, @parent = @stack.pop
-        @buffer << obj.render
-      else
-        @buffer << "</#{name}>"
-      end
-    end
-    
-    def text(str)
-      @buffer << str
-    end
-    
-    def instruction(name, attributes)
-      @buffer << "<?#{name}#{attributes}?>"
-    end
-  end
-  
-  class << self
-    def parse(source)
-      self.new.parse(source)
-    end
-    
-    def transform(source)
-      self.new.transform(source)
-    end
-  end
-
-  # Expand the elemens found in source.
-    
-  def transform(source)
-    listener = Listener.new
-    REXML::Document.parse_stream(source, listener)
-    # gmosx, FIXME: optimize this, how?
-    # gmosx, FIXME: this is a hack fix, improve.
-    listener.buffer.gsub! /<textarea ([^>]*)><\/textarea>/, '<textarea \1>#{}</textarea>'
-    listener.buffer.gsub! /<(.*) ([^>]*)><\/\1>/, '<\1 \2 />'
-    listener.buffer.gsub! /<(.*)><\/\1>/, '<\1 />'
-    return listener.buffer
-  end
-end
-
-# An alias.
-
-unless const_defined? :Elements
-  Elements = ElementProcessor
-end
-
 end
-
 # * George Moschovitis <gm@navel.gr>

data/lib/nitro/helper/benchmark.rb

@@ -4,6 +4,9 @@ module Nitro
   
 module BenchmarkHelper
 
+  # Log real time spent on a task. Example:
+  #  benchmark "Doing an operation" { operation }
+  
   def benchmark(message = 'Benchmarking')
     real = Benchmark.realtime { yield }
     Logger.info "#{message}: time = #{'%.5f' % real} ms."

data/lib/nitro/helper/form.rb

@@ -1,42 +1,75 @@
 require 'nano/inflect'
 
-require 'nitro/helper/xhtml'
-require 'og/relation/all'
+require 'nitro/helper/form/controls'
 
 module Nitro
 
 # A collection of useful helpers for creating and manipulating
 # Forms.
 #--
-# FIXME: cleanup this file, move stuff to scaffold, allow
-# overrides.
+# This helper may by applied at run time so try to optimize 
+# this.
 #++
 
 module FormHelper
-  
+
   def self.included(base)
     super
     base.send :include, XhtmlHelper
   end
 
-private
-  
-  # Propagate the given parameter by using a form hidden field. The
-  # parameter value is tus passed to the next request.
-  
-  def propagate_param(param)
-    %|<input type="hidden" name="#{param}" value="#{request[param.to_s]}" />|
+  # Override these methods to customize the rendering.
+  #
+  # An alternative schema could be:
+  # 
+  # <dl>
+  #   <dt class="#{prop.symbol}">#{label(prop)}</dt>
+  #   <dd class="#{prop.symbol}">#{html}</dd>
+  # </dl>
+  
+  module FormBuilder
+    class << self
+      # Emit form prologue.
+      
+      def prologue
+        ''
+      end
+      
+      # Emit form epilogue.
+      
+      def epilogue
+        ''
+      end
+
+      # Emit a label.
+            
+      def label(prop)
+        %{<label for="#{prop.name}">#{prop[:title] || prop.name.to_s.humanize}</label>}
+      end
+      
+      # Emit a form element.
+      
+      def element(prop, html)
+        %{
+          <p class="form_#{prop.symbol}">
+            <div>#{label(prop)}</div>
+            #{html}
+          </p>
+        }        
+      end
+    end
   end
-  alias_method :keep_param, :propagate_param
-  
-  # Render a standard form for the given Object. The object 
-  # should include attribute annotations.
+
+  # Render a standard form for the given object.
   #--
-  # TODO: get info, for example localization mode from session,
-  # if this module is mixed in a Render.
+  # RETHINK this method.
   #++
-  
+    
   def form_for(obj, options = {})
+    str = ''
+    
+    name = obj.class.name.underscore
+  
     method = options.fetch(:method, 'post')
     action = options.fetch(:action, "save_#{obj.class.name.underscore}")
     submit = options.fetch(:submit, 'Save')
@@ -46,8 +79,8 @@ private
       enctype_attribute = " enctype=\"#{enctype}\""
     else
       enctype_attribute = ''
-      for pr in obj.class.properties.values
-        if pr.klass.ancestors.include? Og::Blob                
+      for prop in obj.class.properties.values
+        if prop.klass.ancestors.include? Og::Blob                
           enctype_attribute = ' enctype="multipart/form-data"'
         end
       end
@@ -55,261 +88,58 @@ private
 
     action = "#{@base}/#{action}" unless action =~ /\//
     
-    str = %{<form action="#{action}" method="post">}
-    
-    str = ''
-
     str << %{<form action="#{action}" method="post"#{enctype_attribute}>}    
     str << %{<input type="hidden" name="oid" value="#{obj.oid}" />} if obj.oid
-    str << tags_for(obj, options)
+    str << controls_for(obj, options)
     str << %{<input type="submit" value="#{submit}" />}
     str << %{ or <a href="#{cancel}">Cancel</a>} if cancel
     str << %{</form>}
     
-    return str
+    return str  
   end
-      
-  # Render a standard form tags for the given Object. The object 
-  # should include attribute annotations.
-  #
-  # If show_all is false then apply field filtering.
-  #
-  # For extra flexibility and to keep semantics this helper
-  # emits a <dl> structure. You can use CSS to style the
-  # list to fit your overal design.
-  #
-  # Example:
-  #
-  #  <p>
-  #    <form name="test">
-  #      #{tags_for entry}
-  #    </form>
-  #  </p>
-  
-  def tags_for(obj, options = {})
-    str = prologue()
-    
-    for p in obj.class.properties.values
-      unless options[:all]
-        next if :oid == p.symbol or p.editor == :none #TODO check for real key
-      end
-      
-      ancestors = p.klass.ancestors
-      
-      tag = if p.editor and obj.respond_to?(p.editor.to_sym)
-        obj.send(p.editor.to_sym, p, options) #farms: send to custom _instance_ method
-      elsif ancestors.include? Numeric and !p.relation      
-        field_tag(obj, p, options)
-      elsif ancestors.include? String
-        if p.editor == :textarea 
-          textarea_tag(obj, p, options)
-        else
-          field_tag(obj, p, options)
-        end
-      elsif ancestors.include? TrueClass
-        checkbox_tag(obj, p, options)
-      elsif ancestors.include? Date
-        date_tag(obj, p, options)
-      elsif ancestors.include? Time
-        datetime_tag(obj, p, options)
-      elsif ancestors.include? Og::Blob
-        file_tag(obj, p, options)
-      elsif ancestors.include? Hash
-        hash_tag(obj, p, options)
-      else
-        nil #no tag
-      end
-      
-      unless tag.nil?
-        #farms: TODO. way to override the general 'element' and disable per prop
-        str << element(p.symbol, tag)
-      end
-    end
 
-    if obj.class.relations and not options[:skip_relations]
-      for rel in obj.class.relations        
-        next if rel.options[:editor] == :none unless options[:all]
-        
-        tag = if rel.options[:editor] && obj.respond_to?(rel.options[:editor].to_sym)
-          obj.send(rel.options[:editor].to_sym, rel, options) #farms: allow custom relation editors
-        elsif rel.kind_of? Og::RefersTo
-          refers_to_control(obj, rel, options)
-        elsif rel.kind_of? Og::JoinsMany or rel.kind_of? Og::HasMany
-          if rel.options[:editor] == :twin_select or rel.options[:editor] == :twin
-            many_select_control(obj, rel, options)
-          else
-            many_list_control(obj, rel, options)
-          end
-        else
-          nil #no tag
-        end
-        
-        unless tag.nil?
-          #farms: TODO. way to override the general 'element' and disable per rel
-          str << element(rel.name, tag)
-        end
-      end
-    end
+  # Render the controls for the given object.
+    
+  def controls_for(obj, options = {})
+    str = FormBuilder.prologue
         
-    str << epilogue()
+    controls_for_properties(str, obj, options)
+    controls_for_relations(str, obj, options)
     
-    return str    
-  end
-
-  def hash_tag(obj, p, options)
-    str = %{
-      <input type="text" id="#{p.symbol}_key" /> =&gt; <input type="text" id="#{p.symbol}_value" /> 
-      <input id="#{p.symbol}" class="naction_add_hash" type="button" value=" + " />
-      <ul id="#{p.symbol}_list">
-    }
-    obj.send(p.symbol).each do |k,v|
-      str << hash_tag_item(p.symbol, k, v)
-    end
-    str << %{</ul>}
-  end
-  
-  def hash_tag_item(name, key='', value='')
-    %{
-      <li>
-        <input type="text" value="#{key}" disabled="disabled" class="hash_item_key" /> =&gt; <input type="text" name="#{name}[#{key}]" id="#{name}_value" value="#{value}" class="hash_item_value" />
-        <span class="remove"><a href="#" class="naction_remove_hash" id="#{name}_remove">remove</a></span>
-      </li>
-    }
-  end
-  public :hash_tag_item # Allow ajax access
-  
-  def file_tag(obj, p, options)
-     %{<input type="file" id="#{p.symbol}" name="#{p.symbol}" style="width: 250px" />}
-  end
-
-  def field_tag(obj, p, options) 
-    %{<input type="text" id="#{p.symbol}" name="#{p.symbol}" value="#{obj.send(p.symbol)}" style="width: 250px" /> }
-  end
-
-  def textarea_tag(obj, p, options)
-    %{<textarea id="#{p.symbol}" name="#{p.symbol}">#{obj.send(p.symbol)}</textarea> }    
-  end
-
-  def checkbox_tag(obj, p, options)
-    checked_flag = obj.send(p.symbol) ? 'checked="checked" ' : ''
-    %{<input type="checkbox" id="#{p.symbol}" name="#{p.symbol}"  #{checked_flag}/>&nbsp; }    
-  end
-
-  def date_tag(obj, p, options)
-    date_select(obj.send(p.symbol), :name => p.symbol.to_s)
-  end
-
-  def datetime_tag(obj, p, options)
-    datetime_select(obj.send(p.symbol), :name => p.symbol.to_s)
-  end
-  
-  def label(sym)
-    %{<label for="#{sym}">#{sym.to_s.humanize}</label>}
+    str << FormBuilder.epilogue
+    
+    return str
   end
 
-  # :section: Relations.
+  # Render the controls for the properties of the given object.
   
-  def refers_to_control(obj, rel, options)
-    entities = rel.target_class.all
-    selected = obj.send(rel.name)
-    selected = selected.pk if selected
-    unless entities.empty?
-      str = %{<select id="#{rel.name}" name="#{rel.name}">}
-      str << %{<option value="null">None</option>} if rel.options[:allow_none]
-      str << %{#{options(:labels => entities.map{|e| e.to_s}, :values => entities.map{|e| e.oid}, :selected => selected)}</select>}
-    else
-      'No entities found.<br /><br />'
-    end
-  end
-
-  def many_list_control(obj, rel, options)
-    entities = rel.target_class.all
-
-    unless entities.empty? 
-      selected_entities = obj.send(rel.name)
-      selector_entities = entities.delete_if {|e| obj.saved? && selected_entities.include?(e)}
-      
-      str = %{
-        <select id="#{rel.name}_selector">
-          #{options(:labels => selector_entities.map{|e| e.to_s}, :values => selector_entities.map{|e| e.oid})}
-        </select>
-        <input id="#{rel.name}" type="button" value=" + " class="naction_add_rel" />
-        <ul class="relation_list" id="#{rel.name}_list">
-      }
-      selected_entities.each do |e|
-        str << relation_item(rel.name, e.to_s, e.oid)
-      end
-      str << %{</ul>}
-    else 
-      'No entities found.<br /><br />'
-    end
-  end
-
-  def relation_item(name, display, oid) 
-    %{
-      <li>
-        <input type="hidden" name="#{name}[]" value="#{oid}" />
-        <span class="display">#{display}</span>
-        <span class="remove"><a href="#" id="#{name}_remove" class="naction_remove_rel">remove</a></span>
-      </li>
-    }
-  end
-  public :relation_item # Allow ajax access.
-
-  def many_select_control(obj, rel, options)
-    entities = rel.target_class.all
-    
-    unless entities.empty?
-      selected_entities = obj.send(rel.name)
-      selector_entities = entities.delete_if {|e| obj.saved? && selected_entities.include?(e)}
-      str = %{
-        <div id="#{rel.name}" class="has_many_control">
-        <select id="#{rel.name}_selector" multiple="multiple">
-          #{options(:labels => selector_entities.map{|e| e.to_s}, :values => selector_entities.map{|e| e.oid})}
-        </select>
-
-        <a href="javascript:multiSelectorMove('#{rel.name}','add');">add &gt;&gt;</a>
-        <a href="javascript:multiSelectorMove('#{rel.name}','remove');">&lt;&lt; remove</a>
-
-        <select id="#{rel.name}_selected" multiple="multiple">
-          #{options(:labels => selected_entities.map{|e| e.to_s}, :values => selected_entities.map{|e| e.oid})}
-        </select>
-      }
-      selected_entities.each do |e|
-        str << %{<input type="hidden" name="#{rel.name}[]" id="#{rel.name}_#{e.oid}" value="#{e.oid}" />}
+  def controls_for_properties(str, obj, options = {})
+    for prop in obj.class.properties.values
+      unless options[:all]
+        next if prop.symbol == obj.class.primary_key.symbol or prop[:control] == :none or prop[:relation]
       end
-      str << %{</div>}
-    else
-      'No entities found.<br /><br />'
+      control = Control.fetch(obj,prop).render
+      str << FormBuilder.element(prop, control)
     end
   end
   
-  # :section: General formating methods. Override to customize.
+  # Render the controls for the relations of the given object.
   
-  # Emit form prologue.
-  
-  def prologue
-    '<dl>'
-  end
-  
-  # Emit form epilogue.
-  
-  def epilogue
-    '</dl>'
-  end
-  
-  # Emit a form element.
-  
-  def element(name, tag)    
-    %{
-    <dt class="#{name}">#{label(name)}</dt>
-    <dd class="#{name}">#{tag}</dd>
-    }
+  def controls_for_relations(str, obj, options = {})
+    for rel in obj.class.relations        
+      unless options[:all]
+        next if rel[:control] == :none
+      end
+      control = Control.fetch(obj,rel).render
+      str << FormBuilder.element(rel, control)      
+    end  
   end
+
 end
 
-end 
+end
 
 # * George Moschovitis <gm@navel.gr>
 # * Chris Farmiloe <chris.farmiloe@farmiloe.com>
-# * Rob Pitt <rob@motionpath.co.uk>
+# * Rob Pitt <rob@motionpath.co.uk>
+