nitro 0.26.0 → 0.27.0

data/lib/nitro/context.rb

@@ -8,13 +8,13 @@ require 'nitro/session'
 
 module Nitro
   
-# Encapsulates an HTTP processing cycle context.
-# Integrates the HTTP Request, the HTTP Response
-# and the Render used to generate the response
-# body.
-# The Context object can be accessed by the
-# context, request or response aliases. You can
-# use the alias that makes sense every time.
+# Encapsulates an HTTP processing cycle context. Integrates the 
+# HTTP Request, the HTTP Response and the Render used to 
+# generate the response body.
+# 
+# The Context object can be accessed by the context, request or 
+# response aliases. You can use the alias that makes sense 
+# every time.
 
 class Context
   include Request
@@ -64,9 +64,9 @@ class Context
   #++
 
   def out
-    return @out if @out == ""
+    return @out if @out == ''
     if @rendering_errors
-      @out = String.new
+      @out = ''
       render '/error'
     end
     @out
@@ -88,7 +88,7 @@ class Context
     @dispatcher.controllers[@base || '/'] 
   end
 
-  # Populate an object from request parameters.
+  # Automagically populate an object from request parameters.
   # This is a truly dangerous method.
   #
   # === Options

data/lib/nitro/dispatcher.rb

@@ -1,6 +1,7 @@
 require 'nano/kernel/singleton'
 
 require 'nitro/controller'
+require 'nitro/compiler'
 require 'nitro/routing'
 require 'nitro/helper/default'
 
@@ -199,7 +200,7 @@ class Dispatcher
       #--
       # FIXME: no raise to make testable.
       #++
-      raise NoActionError, "No action to dispatch to on #{klass}"
+      raise NoActionError, "No action for path '#{path}' on '#{klass}'"
     end
     
     # push any remaining parts of the url onto the query 
@@ -223,7 +224,8 @@ private
   def controller_class_for(key)
     klass = @controllers[key]
 
-    if klass and Compiler.reload
+    if $autoreload_dirty and klass and Compiler.reload
+      Logger.info "Reloading controller '#{klass}'"
       klass.instance_methods.grep(/(_action$)|(_template$)/).each do |m|
         klass.send(:remove_method, m) rescue nil
       end

data/lib/nitro/element.rb

@@ -1,16 +1,34 @@
 require 'nano/string/capitalized'
 require 'nano/string/camelize'
+require 'nano/string/underscore'
+require 'nano/dir/self/recurse'
 require 'mega/annotation'
 
 require 'glue/flexob'
 require 'glue/configuration'
-
-# load the element compiler here for compatibility?
-#require 'nitro/compiler/elements'
+require 'glue/template'
 
 module Nitro
 
-# A programmatically generated element.
+# A programmatically generated element. Elements are a form
+# of macros to allow for cleaner templates. They are evaluated
+# at compile time, so there is no performance hit when you use
+# them (at the expense of slightly reduced functionality).
+#
+# Nitro provides an additional method of defining elements.
+# Instead of creating a lot of small classes, you can put
+# .xhtml templates in the Element template_root. These templates
+# are automatically converted into Element classes.
+#
+# For extra safety, you are advised to place your classes in the
+# Nitro::Element namespace. If your classes do not extend
+# Nitro::Element, the Nitro::ElementMixin is automatically
+# injected in the class.
+#
+# An element can have and access a hierarchy of sub-elements.
+# use #{content :sub_element_name} to access the render output
+# of the subelement. Additionaly you can access the whole 
+# subelement object: _children[:sub_element_name]
 # 
 # === Design
 #
@@ -21,11 +39,7 @@ module Nitro
 # * separate 'view' template files.
 #++
 
-class Element
-  # The prefix for element tags (in xhtml compatibility mode)
-  
-  setting :prefix, :default => 'x', :doc => 'The prefix for element tags'
-
+module ElementMixin
   # The parent of this element.
   
   attr_accessor :_parent
@@ -33,11 +47,8 @@ class Element
   # The children of this element.
   
   attr_accessor :_children
-  
-  # The named children of this element.
-  
-  attr_accessor :_named
-  
+  alias_method :children, :_children
+    
   # The text of this element.
   
   attr_accessor :_text
@@ -47,8 +58,7 @@ class Element
   attr_accessor :_view
 
   def initialize(*args)
-    @_children = []
-    @_named = Flexob.new
+    @_children = {}
     @_text = ''
   end
     
@@ -60,7 +70,7 @@ class Element
   
   def content(cname = nil)
     if cname
-      @_named[cname].content
+      @_children[cname].content
     else
       @_text
     end
@@ -69,35 +79,106 @@ class Element
   def close
   end  
 
+  # Renders the actual content of this Element.
+  
   def render
     "#{open}#{content}#{close}"
   end
 
   def render_children
     str = ''
-    for c in @_children
+    for c in @_children.values
       str << c.render
     end
     
     return str
   end  
-  
+
   def add_child(child)
     child._parent = self  
-    @_children << child
-    if cname = child.class.ann.self[:name]
-      @_named[cname] = child
-    end
+    @_children[Element.class_to_name(child.class)] = child
   end
   
-  alias_method :children, :_children
+  alias_method :children, :_children  
+end
+
+# A programmatically generated element.
+# 
+# === Design
+#
+# An underscore is used for the standard attibutes to
+# avoid name clashes.
+#--
+# TODO: 
+# * separate 'view' template files.
+#++
+
+class Element
+  include ElementMixin
+  
+  # The prefix for element tags (in xhtml compatibility mode)
+  
+  setting :prefix, :default => 'x', :doc => 'The prefix for element tags'
+
+  # Allow auto extension of element classes?
+  
+  setting :auto_extend, :default => true, :doc => 'Allow auto extension of element classes?'
+
+  # The directory where element templates reside. The default
+  # dir is #{Template.root}/element
+
+  if File.exist?(File.join(Template.root, 'element'))
+    default_root = File.join(Template.root, 'element')
+  else
+    default_root = 'element'
+  end
+
+  if File.exist?('src/element')
+    default_root = 'src/element'
+  elsif File.exist?('src/template/element')
+    default_root = 'src/template/element'
+  else
+    default_root = 'element'
+  end
   
+  setting :template_root, :default => default_root, :doc => 'The directory where element templates reside'
+
   class << self
-    def name(sym)
-      ann self, :name => sym.to_sym
+    #  Return the name for an Element class.
+  
+    def class_to_name(klass)
+      klass.to_s.underscore.to_sym
     end
+
+    # Compile the element templates into element classes. 
+    # Typically called at startup.
+
+    def compile_template_elements
+      if File.exist? Element.template_root
+        Dir.recurse(Element.template_root) do |filename| 
+          if filename =~ /\.#{Template.extension}$/
+            name = File.basename(filename).split('.').first.camelize
+            Nitro::Element.module_eval %{
+              class #{name} < Nitro::Element
+                def render
+                  <<-END_OF_TEMPLATE
+                  #{File.read(filename)}
+                  END_OF_TEMPLATE
+                end
+              end
+            }
+          end
+        end         
+      end
+    end    
+    
   end
 end
 
+# Compile the element templates into element classes.
+
+Element.compile_template_elements
+
 end
+
 # * George Moschovitis <gm@navel.gr>

data/lib/nitro/element/{java_script.rb → javascript.rb}

@@ -1,6 +1,10 @@
 require 'nitro/element'
 
-class JavaScript < Nitro::Element
+class Nitro::Element
+
+# A javescript helper.
+
+class Javascript
   def render
     %~
     <script type="text/javascript" language="javascript">
@@ -12,4 +16,6 @@ class JavaScript < Nitro::Element
   end
 end
 
+end
+
 # * George Moschovitis <gm@navel.gr>

data/lib/nitro/flash.rb

@@ -1,6 +1,8 @@
 module Nitro
 
+  #--
   # This module adds flashing support to the Controllers. 
+  #++
   
   module Flashing
   
@@ -12,7 +14,8 @@ module Nitro
     
     # A Flash is a special hash object that lives in the session. 
     # The values stored in the Flash are typically maintained 
-    # for the duration of one request. 
+    # for the duration of one request. After the request is over,
+    # the Hash is cleared.
     # 
     # You may want to use the Flash to pass error messages or 
     # other short lived objects.

data/lib/nitro/helper.rb

@@ -10,6 +10,8 @@ module Nitro
 # macro provided by Helpers, the utility methods are
 # included as private methods.
 #
+# The helper also requires the ruby file.
+#
 # === Examples
 #
 # class MyController < Nitro::Controller
@@ -36,6 +38,19 @@ module Helpers
     base.module_eval do
       def self.helper(*modules)
         for mod in modules
+          #--
+          # gmosx, FIXME: temp solution, will fix!
+          #++
+          
+          if mod.is_a? String
+            begin
+              # gmosx: dont interpolate (RDoc fix).
+              require('src/helper/' + mod)
+            rescue Object
+              require('nitro/helper/' + mod) rescue nil
+            end
+          end
+                    
           unless mod.is_a? Module
             mod = mod.to_s.camelize
             # gmosx: check xxxHelper before xxx.

data/lib/nitro/helper/benchmark.rb

@@ -2,10 +2,16 @@ require 'benchmark'
 
 module Nitro
   
+# This helper adds benchmarking support in your Controllers.
+# Useful for fine tuning and optimizing your actions.
+
 module BenchmarkHelper
 
-  # Log real time spent on a task. Example:
-  #  benchmark "Doing an operation" { operation }
+  # Log real time spent on a task. 
+  # 
+  # === Example
+  # 
+  # benchmark "Doing an operation" { operation }
   
   def benchmark(message = 'Benchmarking')
     real = Benchmark.realtime { yield }

data/lib/nitro/helper/form.rb

@@ -85,7 +85,7 @@ module FormHelper
         end
       end
     end
-
+    
     action = "#{@base}/#{action}" unless action =~ /\//
     
     str << %{<form action="#{action}" method="post"#{enctype_attribute}>}    
@@ -118,7 +118,7 @@ module FormHelper
       unless options[:all]
         next if prop.symbol == obj.class.primary_key.symbol or prop[:control] == :none or prop[:relation]
       end
-      control = Control.fetch(obj,prop).render
+      control = Control.fetch(obj, prop, options).render
       str << FormBuilder.element(prop, control)
     end
   end
@@ -130,7 +130,7 @@ module FormHelper
       unless options[:all]
         next if rel[:control] == :none
       end
-      control = Control.fetch(obj,rel).render
+      control = Control.fetch(obj, rel, options).render
       str << FormBuilder.element(rel, control)      
     end  
   end

data/lib/nitro/helper/form/controls.rb

@@ -25,10 +25,11 @@ class Control
   
   # setup instance vars to use in methods
 
-  def initialize(obj, key, value=nil)
+  def initialize(obj, key, options = {})
     @obj = obj
     @prop = key
-    @value = value || obj.send(key.name.to_sym)
+    @value = options[:value] || obj.send(key.name.to_sym)
+    @options = options
   end
   
   # Main bulk of the control. Overide to customise
@@ -55,7 +56,6 @@ class Control
   # to the incoming values
   
   def on_populate(val)
-    puts "PREPROCESSING !"
     return val
   end
   
@@ -72,6 +72,18 @@ private
     style ? %{ style="#{style}"} : ''
   end
   
+  # add support to your controls for being disabled
+  # by including an emit_disabled on form items
+  # or testing for is_disabled? on more complex controls
+  
+  def emit_disabled
+    is_disabled? ? %{ disabled="disabled"} : ''
+  end
+  
+  def is_disabled?
+    return false if @options[:all]
+    @options[:disable_controls] || @prop.disable_control
+  end
 end
 
 # Fixnum
@@ -81,18 +93,32 @@ class FixnumControl < Control
 
   def render
     style = prop.control_style ||self.class.style 
-    %{<input type="text" id="#{prop.symbol}_ctl" name="#{prop.symbol}" value="#{value}"#{emit_style} /> + -}
+    %{
+      <div class="numeric_ctl_container">
+        <span class="numeric_ctl_input">
+          <input type="text" id="#{prop.symbol}_ctl" name="#{prop.symbol}" value="#{value}"#{emit_style}#{emit_disabled} />
+        </span>
+        <span class="numeric_ctl_buttons">
+          <a href="#" onclick="el=document.getElementById('#{prop.symbol}_ctl'); el.value=(parseInt(el.value) || 0)+#{step}; return false;">+</a>
+          <a href="#" onclick="el=document.getElementById('#{prop.symbol}_ctl'); el.value=(parseInt(el.value) || 0)-#{step}; return false;">-</a>
+        </span>
+      </div>
+    }
+  end
+  
+  def step
+    1
   end
+  
 end
 
 # Float
 
-class FloatControl < Control
+class FloatControl < FixnumControl
   setting :style, :default => 'width: 100px', :doc => 'The default style'
 
-  def render
-    style = prop.control_style ||self.class.style 
-    %{<input type="text" id="#{prop.symbol}_ctl" name="#{prop.symbol}" value="#{value}"#{emit_style} /> + -}
+  def step
+    0.1
   end
 end
 
@@ -102,7 +128,17 @@ class TextControl < Control
   setting :style, :default => 'width: 250px', :doc => 'The default style'
 
   def render
-    %{<input type="text" id="#{prop.symbol}_ctl" name="#{prop.symbol}" value="#{value}"#{emit_style} />}
+    %{<input type="text" id="#{prop.symbol}_ctl" name="#{prop.symbol}" value="#{value}"#{emit_style}#{emit_disabled} />}
+  end
+end
+
+# Password
+
+class PasswordControl < Control
+  setting :style, :default => 'width: 250px', :doc => 'The default style'
+
+  def render
+    %{<input type="password" id="#{prop.symbol}_ctl" name="#{prop.symbol}" value="#{value}"#{emit_style} />}
   end
 end
 
@@ -112,7 +148,7 @@ class TextareaControl < Control
   setting :style, :default => 'width: 500px; height: 100px', :doc => 'The default style'
   
   def render
-    %{<textarea id="#{prop.symbol}_ctl" name="#{prop.symbol}"#{emit_style}>#{value}</textarea>}        
+    %{<textarea id="#{prop.symbol}_ctl" name="#{prop.symbol}"#{emit_style}#{emit_disabled}>#{value}</textarea>}        
   end
 end
 
@@ -123,7 +159,61 @@ class CheckboxControl < Control
 
   def render
     checked = value == true ? ' checked="checked"':''
-    %{<input type="checkbox" id="#{prop.symbol}_ctl" name="#{prop.symbol}" value="true"#{emit_style}#{checked} />}
+    %{<input type="checkbox" id="#{prop.symbol}_ctl" name="#{prop.symbol}" value="true"#{emit_style}#{checked}#{emit_disabled} />}
+  end
+end
+
+# ArrayControl
+
+class ArrayControl < Control
+  def render
+    str = emit_container_start
+    str << emit_js
+    if values.empty?
+      str << emit_array_element(:removable => false)
+    else
+      removable = values.size != 1 ? true : false
+      values.each do |item|
+        str << emit_array_element(:selected => item.pk)
+      end
+    end
+    str << emit_container_end
+  end
+  
+  def emit_array_element(options={})
+    removable = options.fetch(:removable, true)
+    selected = options.fetch(:selected, nil)
+    %{
+      <div>
+        <input type="text" id="#{prop.symbol}_ctl" name="#{prop.symbol}[]" value="#{value}"#{emit_style}#{emit_disabled} />
+        <input type="button" class="#{prop.symbol}_remove_btn" value=" - " onclick="rm_#{prop.symbol}_rel(this);" #{'disabled="disabled"' unless removable} />
+        <input type="button" class="#{prop.symbol}_add_btn" value=" + " onclick="add_#{prop.symbol}_rel(this);"#{emit_disabled} />
+      </div>
+    }
+  end
+  
+  def emit_js
+    %{
+      <script type="text/javascript">
+        rm_#{prop.symbol}_rel = function(el){
+          ctl=el.parentNode; 
+          container=ctl.parentNode; 
+          container.removeChild(ctl); 
+          inputTags = container.getElementsByTagName('input');
+          if(inputTags.length==2) 
+            inputTags[0].disabled='disabled';
+        }
+        add_#{prop.symbol}_rel = function(el){
+          ctl=el.parentNode; 
+          container=ctl.parentNode; 
+          node=ctl.cloneNode(true); 
+          node.getElementsByTagName('input')[0].removeAttribute('disabled'); 
+          if(container.lastChild==ctl) container.appendChild(node);
+          else container.insertBefore(node, ctl.nextSibling);
+          if(container.childNodes.length>1) container.getElementsByTagName('input')[0].disabled='';
+        }
+      </script>
+    }
   end
 end
 
@@ -133,16 +223,20 @@ end
 
 class RefersToControl < Control
   def render
-    objs = rel.target_class.all    
-    if selected = value
-      selected = selected.pk
-    end
-    
-    str = %{<select id="#{rel.name}_ctl" name="#{rel.name}">}
-    str << %{<option value="nil">None</option>}
-    str << %{#{options(:labels => objs.map{|o| o.to_s}, :values => objs.map{|o| o.pk}, :selected => selected)}</select>}
-    
-    return str
+    %{
+      <select id="#{rel.name}_ctl" name="#{rel.name}"#{emit_disabled}>
+      #{emit_options}
+      </select>
+    }
+  end
+  
+  def emit_options
+    objs = rel.target_class.all
+    selected = selected.pk if selected = value
+    %{
+      <option value="nil">None</option>
+      #{options(:labels => objs.map{|o| o.to_s}, :values => objs.map{|o| o.pk}, :selected => selected)}
+    }
   end
 end
 
@@ -156,11 +250,11 @@ class HasManyControl < Control
     str = emit_container_start
     str << emit_js
     if selected_items.empty?
-      str << emit_selector(all_items, :removable => false)
+      str << emit_selector(:removable => false)
     else
       removable = selected_items.size != 1 ? true : false
       selected_items.each do |item|
-        str << emit_selector(all_items, :selected => item.pk)
+        str << emit_selector(:selected => item.pk)
       end
     end
     str << emit_container_end
@@ -190,16 +284,17 @@ class HasManyControl < Control
   # :removable controls wether the minus button is active
   # :selected denotes the oid to flag as selected in the list
   
-  def emit_selector(items, options={})
+  def emit_selector(options={})
     removable = options.fetch(:removable, true)
+    selected = options.fetch(:selected, nil)
     %{
       <div>
-        <select class="has_many_ctl" name="#{rel.name}[]" #{emit_style}>
+        <select class="has_many_ctl" name="#{rel.name}[]" #{emit_style}#{emit_disabled}>
           <option value="nil">None</option>
-          #{options(:labels => items.map{|o| o.to_s}, :values => items.map{|o| o.pk}, :selected => options[:selected])}
+          #{options(:labels => all_items.map{|o| o.to_s}, :values => all_items.map{|o| o.pk}, :selected => selected)}
         </select>
         <input type="button" class="#{rel.name}_remove_btn" value=" - " onclick="rm_#{rel.name}_rel(this);" #{'disabled="disabled"' unless removable} />
-        <input type="button" class="#{rel.name}_add_btn" value=" + " onclick="add_#{rel.name}_rel(this);" />
+        <input type="button" class="#{rel.name}_add_btn" value=" + " onclick="add_#{rel.name}_rel(this);"#{emit_disabled} />
       </div>
     }
   end
@@ -239,13 +334,17 @@ class Control
   
   setting :map, :doc => 'Mappings of control names => classes', :default => {
     :fixnum => FixnumControl,
+    :integer => FixnumControl,
     :float => FloatControl,
     :boolean => CheckboxControl,
     :checkbox => CheckboxControl,
     :string => TextControl,
+    :password => PasswordControl,
     :textarea => TextareaControl,
     :true_class => CheckboxControl,
+    :array => ArrayControl,
     :refers_to => RefersToControl,
+    :has_one => RefersToControl,
     :belongs_to => RefersToControl,
     :has_many => HasManyControl,
     :many_to_many => HasManyControl,
@@ -255,7 +354,8 @@ class Control
   # Fetch a control, setup for 'obj' for a property, or relation 
   # or :symbol defaults to Control if not found
   
-  def self.fetch(obj, key, missing=self)
+  def self.fetch(obj, key, options={})
+
     if key.kind_of? Og::Relation
       control_sym = key[:control] || key.class.to_s.demodulize.underscore.to_sym
     elsif key.kind_of? Property
@@ -263,7 +363,9 @@ class Control
     else
       control_sym = key.to_sym
     end
-    self.map.fetch(control_sym, missing).new(obj, key)
+    
+    default_to = options.fetch(:default, Control)
+    self.map.fetch(control_sym, Control).new(obj, key, options)
   end
   
 end