nitro 0.31.0 → 0.40.0

data/lib/nitro/dispatcher.rb

@@ -8,7 +8,7 @@ module Nitro
 # Raised when an action can not be found for a path
 # check for this in your error action to catch as if 404
 
-class NoActionError < NoMethodError; end
+class ActionError < NoMethodError; end
 
 # The Dispatcher manages a set of controllers. It maps
 # a request uri to a [controller, action] pair.
@@ -17,7 +17,11 @@ class Dispatcher
   include Router
 
   ROOT = '/'
+
+  # The server.
   
+  attr_accessor :server
+    
   # The controllers map.
 
   attr_accessor :controllers
@@ -69,7 +73,7 @@ class Dispatcher
       end
 
       # Automatically mixin controller helpers.
-      
+
       mixin_auto_helpers(klass)      
 
       # Customize the class for mounting at the given path.
@@ -80,8 +84,12 @@ class Dispatcher
       # paths, plus simplifying the code. This instance will
       # be dup-ed for each request.
       #++
-      
+
       klass.mount_at(path)
+      
+      # Call the mounted callback to allow for post mount
+      # initialization.
+      
       klass.mounted(path) if klass.respond_to?(:mounted)
     end
 
@@ -100,7 +108,9 @@ class Dispatcher
   
   def mixin_auto_helpers(klass)
       klass.helper(Nitro::DefaultHelper)      
-      
+
+      return # FIXME: make the following work again!            
+            
       begin
         if helper = Module.by_name("#{klass}Helper")
           klass.helper(helper)
@@ -128,7 +138,7 @@ class Dispatcher
       for m in c.action_methods
         m = m.to_sym
         if route = c.ann(m).route and (!route.nil?)
-          add_rule(route.first, :controller => c, :action => m, :params => route.last)
+          add_rule(:match => route.first, :controller => c, :action => m, :params => route.last)
         end
       end
     end
@@ -136,7 +146,6 @@ class Dispatcher
   
   # Processes the path and dispatches to the corresponding
   # controller/action pair.
-  # The base returned contains a trailing '/'.
   #
   # [+path+]
   #    The path to dispatch.
@@ -149,9 +158,9 @@ class Dispatcher
   # Action containing '/' separators look for templates 
   # in subdirectories. The '/' char is converted to '__' 
   # to find the actual action.
+  # The dispatcher also handles nested controllers.
   # 
-  # Returns the dispatcher class, the action name and the
-  # base url. For the root path, the base url is nil.
+  # Returns the dispatcher class and the action name.
   #--
   # FIXME: this is a critical method that should be optimized
   # watch out for excessive String creation.
@@ -163,33 +172,44 @@ class Dispatcher
     
     klass, action, params = decode_route(path)
     if klass
-      context.params.update(params) if params
+      # This adds parameter values from the setup from the route to the normal
+      # query strings.
+      context.headers['QUERY_STRING'] ||= ''
+      extra = params.map { |k, v| "#{k}=#{v}"}.join(';') if params
+      if context.headers['QUERY_STRING'].empty?
+        context.headers['QUERY_STRING'] = extra
+      else
+        context.headers['QUERY_STRING'] << ';' << extra
+      end
+      
+      context.headers['ACTION_PARAMS'] = params.values
+      
+      # context.params.update(params) if params
       # gmosx, FIXME/OPTIMIZE: no annotation for mount point!! 
       return klass, "#{action}_action", klass.mount_path
     end
-    
-    path = path.sub(/#{Router.strip_path}/, '') if Router.strip_path
-    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
+    key, * = path.split('?', 2)
+    key = key.split('/')
+    parts = []    
+    
+    while (not key.empty?) and (klass = controller_class_for("#{key.join('/')}")).nil?
+      parts.unshift(key.pop)
+    end  
+    
+    klass = controller_class_for(ROOT) unless klass
 
     idx = 0
     found = false
+
+    # gmosx, HACKFIX!
     
-    # default to index
-    
-    parts << 'index' if parts.empty?
-    
+    parts.shift if parts.first == ''   
+
     # Try to find the first valid action substring
     
     action = ''
-    
+
     for part in parts
       action << part
       if klass.respond_to_action_or_template?(action)  
@@ -199,26 +219,47 @@ class Dispatcher
       action << '__'
       idx += 1
     end
+
+    # Check the index action.
+    
+    unless found
+      action = :index
+      if klass.respond_to_action? action
+        a = klass.instance_method(action).arity
+        found = true if a < 0 || a >= parts.size
+      elsif klass.respond_to_template? action
+        found = true if parts.size == 0
+      end
+      idx = -1 if found      
+    end
       
     if found
       parts.slice!(0, idx + 1)
+=begin
+      if $DBG
+        # Some extra checking of the parameters. Only enabled
+        # on debug mode, because it slows down dispatching.
+        
+        a = klass.instance_method(action).arity
+        
+        if a > 0 and a != parts.size
+          raise ActionError, "Invalid parameters for action, expects #{a} parameters, received #{parts.size}"
+        end
+      end
+=end
     else
       #--
       # FIXME: no raise to make testable.
       #++
-      raise NoActionError, "No action for path '#{path}' on '#{klass}'"
+      raise ActionError, "No action for path '#{path}' 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
+    context.headers['ACTION_PARAMS'] = parts
 
-    base = nil if base == ROOT
-    
-    return klass, "#{action}_action", base
+    return klass, "#{action}_action"
   end
   alias_method :split_path, :dispatch
 
@@ -244,6 +285,3 @@ private
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>
-# * Chris Farmiloe <chris.farmiloe@farmiloe.com>

data/lib/nitro/element.rb

@@ -2,10 +2,9 @@ require 'facet/string/capitalized'
 require 'facet/string/camelize'
 require 'facet/class/method_name'
 require 'facet/dir/self/recurse'
-require 'facet/annotation'
 
 require 'glue/configuration'
-require 'glue/template'
+require 'nitro/template'
 
 module Nitro
 
@@ -75,13 +74,41 @@ module ElementMixin
   # the content of the named child element.
   #
   # eg. #{content :child_element_id}
+  #
+  # === Example
+  #
+  # <Page>
+  #   ..
+  #
+  #   <Box id="hello">
+  #     ..
+  #   </Box>
+  #
+  #   <Box id="world">
+  #     ..
+  #   </Box>
+  #
+  #   <Sidebar>
+  #     ..
+  #   </Sidebar>
+  #
+  #   ..
+  #
+  # </Page>
+  #
+  # Access children content from within the enclosing element
+  # (Page) like this:
+  #
+  # {content :hello}
+  # {content :world}
+  # {content :sidebar}  
   
   def content(cname = nil)
     if cname
       if c = @_children[cname.to_s]
         c.content
       else
-        Logger.error "Undefined sub-element '#{cname}' for element '#{self.class}'"
+        return nil
       end
     else
       @_text
@@ -110,10 +137,11 @@ module ElementMixin
 
   def add_child(child)
     child._parent = self
-    @_children[child.id] = child
+    @_children[child.instance_variable_get('@id')] = child
   end
   
   alias_method :children, :_children  
+  
 end
 
 # A programmatically generated element.
@@ -167,10 +195,10 @@ class Element
   setting :auto_extend, :default => true, :doc => 'Allow auto extension of element classes?'
 
   # The directory where element templates reside. The default
-  # dir is #{Glue::Template.root}/element
+  # dir is #{Nitro::Template.root}/element
 
-  if File.exist?(File.join(Glue::Template.root, 'element'))
-    default_root = File.join(Glue::Template.root, 'element')
+  if File.exist?(File.join(Nitro::Template.root, 'element'))
+    default_root = File.join(Nitro::Template.root, 'element')
   else
     default_root = 'element'
   end
@@ -193,7 +221,7 @@ class Element
     def compile_template_elements
       if File.exist? Element.template_root
         Dir.recurse(Element.template_root) do |filename| 
-          if filename =~ /\.#{Glue::Template.extension}$/
+          if filename =~ /\.#{Nitro::Template.extension}$/
             name = File.basename(filename).split('.').first.camelize
             Nitro::Element.module_eval %{
               class #{name} < Nitro::Element
@@ -217,5 +245,3 @@ end
 Element.compile_template_elements
 
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/nitro/element/javascript.rb

@@ -17,5 +17,3 @@ class Javascript
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/nitro/flash.rb

@@ -19,7 +19,10 @@ module Nitro
     # 
     # You may want to use the Flash to pass error messages or 
     # other short lived objects.
-    
+    #
+    # Use capitalized keys to denote system variables. Reserve
+    # lower case keys for user application variables.
+        
     class Flash < Hash
     
       def initialize
@@ -65,17 +68,20 @@ module Nitro
       #
       # === Example
       #
-      # flash.push :errors, 'This is the first error'
-      # flash.push :errors, 'This is the second error'
+      # flash.push :ERRORS, 'This is the first error'
+      # flash.push :ERRORS, 'This is the second error'
       #
-      # flash[:errors] # => []
+      # flash[:ERRORS] # => []
       
-      def push(key, value)
-        if value.is_a? Array
-          (self[key] ||= []).concat(value)
+      def push(key, *values)
+        val = self[key]
+        val ||= []
+        if values.size == 1
+          val << values[0]
         else
-          (self[key] ||= []) << value
+          val << values
         end
+        self[key] = val
       end
       
       # Pop a value from an array flash variable.
@@ -91,6 +97,15 @@ module Nitro
         return nil
       end
 
+      # Another helper, concats a whole array to the given flash
+      # key.
+      
+      def concat(key, arr)
+        for val in arr.to_a
+          push key, val
+        end
+      end      
+
       # Join helper
       
       def join(key, sep = ', ')
@@ -148,5 +163,3 @@ module Nitro
   end  
 
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/nitro/global.rb

@@ -1,22 +1,49 @@
-require 'glue/cache/memory'
-
 # Global scoped variables. This is backed by a Cache store.
+#--
+# TODO: implement as a refactoring of session?
+#++
 
 class Global
 
+  # The type of the global cache. The generalized caching 
+  # system in Glue is used. The following options are available:
+  #
+  # * :memory [default]
+  # * :drb
+  # * :og 
+  # * :file
+  # * :memcached
+
+  setting :cache_type, :default => :memory, :doc => 'The type of global cache'
+
   # The address of the store.
   
-  setting :cache_address, :default => '127.0.0.1', :doc => 'The address of the store'
+  setting :cache_address, :default => '127.0.0.1', :doc => 'The address of the global cache'
 
   # The port of the store.
   
-  setting :cache_port, :default => 9079, :doc => 'The port of the store'
-
-  # The cache store that backs global variables.
-  
-  setting :cache, :default => ::Glue::MemoryCache.new, :doc => 'The cache store that backs global variables'
+  setting :cache_port, :default => 9079, :doc => 'The port of the global cache'
   
   class << self
+    # The global cache (store). 
+
+    attr_accessor :cache
+  
+    # Init the correct Global cache.
+    
+    def setup(type = Global.cache_type)
+      return if Global.cache
+
+      case type
+        when :memory
+          require 'glue/cache/memory'
+          Global.cache = Glue::MemoryCache.new
+
+        when :drb
+          require 'glue/cache/drb'
+          Global.cache = DrbCache.new(Global.cache_address, Global.cache_port)          
+      end
+    end    
   
     # Initialize a global value once.
     
@@ -42,7 +69,7 @@ class Global
     # Global.update(:USERS) do |users|
     #   users << 'gmosx'
     # end
-         
+        
     def update(key)
       if block_given?
         # update, also handles distributed stores.
@@ -59,5 +86,3 @@ class Global
   end
   
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/nitro/helper.rb

@@ -36,27 +36,43 @@ module Helpers
     base.module_eval do
       def self.helper(*modules)
         for mod in modules
+          
+          # If the mod is a string or symbol, also try to 
+          # auto require the source file.
           #--
           # gmosx, FIXME: temp solution, will fix!
           #++
           
-          if mod.is_a? String
+          if mod.is_a?(String) or mod.is_a?(Symbol)
             begin
               # gmosx: dont interpolate (RDoc fix).
-              require('src/helper/' + mod)
-            rescue Object
-              require('nitro/helper/' + mod) rescue nil
+              require('src/helper/' + mod.to_s)
+            rescue LoadError #do not hide SyntaxError, NameError
+              
+              # you can do helper "foo" to load a module withouth requiring
+              begin
+                require('nitro/helper/' + mod.to_s) 
+              rescue LoadError 
+    # supress this error.
+              end
             end
           end
                     
           unless mod.is_a? Module
-            mod = mod.to_s.camelize
+            modname = mod.to_s.camelize
             # gmosx: check xxxHelper before xxx.
-            mod = Utils.const("#{mod}Helper") || Utils.const("Nitro::#{mod}Helper") || Utils.const(mod) 
+            mod = Utils.const("#{modname}Helper") || 
+                      Utils.const("Nitro::#{modname}Helper") || 
+                      Utils.const(modname) 
+          end
+          # name mismatch
+          unless mod
+            raise "helper #{modname} not found (module not defined), check name"
           end
           symbols = mod.instance_methods.collect { |m| m.to_sym }
           self.send(:include, mod)
           self.send(:private, *symbols)
+          self.send(:private, mod.to_s[/[^:]+$/].to_sym)
         end
       end
     end
@@ -65,5 +81,3 @@ module Helpers
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>