nitro 0.29.0 → 0.30.0

data/lib/nitro/caching/actions.rb

@@ -21,6 +21,8 @@ module Caching
 
     module ClassMethods
 
+      # Cache the given actions.
+      
       def cache_action(*actions)
         return unless caching_enabled?
         
@@ -49,7 +51,6 @@ module Caching
     private 
 
     # Expire the cached fragment of the given actions.
-    #
     #--
     # FIXME: not very good implementation?
     #++

data/lib/nitro/caching/fragments.rb

@@ -17,14 +17,7 @@ module Caching
 
     # The cache used to store the fragments.
     
-    setting :cache, :default => nil, :doc => 'The cache used to store the fragments'
-    
-    #--
-    # gmosx, FIXME: this is a hack, improve setting 
-    # implementation.
-    #++
-    
-    @@cache = Glue::MemoryCache.new
+    setting :cache, :default => Glue::MemoryCache.new, :doc => 'The cache used to store the fragments'
     
     def self.get(name, options = {})
       return @@cache.get(name, options)

data/lib/nitro/caching/output.rb

@@ -11,7 +11,8 @@ module Caching
   # (Lighttpd, Apache, etc) for optimal performance.
   #
   # Nitro promotes coding your application in such a way as to
-  # allow for output caching to the greatest extend.
+  # allow for output caching to the greatest extend. Output 
+  # caching *is your friend*.
   #--
   # gmosx, FIXME: Don't create excessive directories, use better
   # rewrite rules to handle xxx.html files.
@@ -66,6 +67,9 @@ module Caching
       end
     end
     
+    # Explicitly expire the output cached under the given
+    # cache key. The cache key is typically the name of the
+    # top level action responsible for generating the page.
     #--
     # If you change this method, don't forget the CacheSweeper
     # expire method.
@@ -73,14 +77,20 @@ module Caching
 
     def expire_output(name)
       begin
-        Logger.debug "Expirinig cache file '#{context.dispatcher.public_root}/#{name}'" if $DBG
-        FileUtils.rm_rf("#{context.dispatcher.public_root}/#{name}")
-      rescue Object
+        Logger.debug "Expirinig cache file '#{Server.public_root}/#{name}'" if $DBG
+        FileUtils.rm_rf("#{Server.public_root}/#{name}")
+      rescue Object => ex
         # gmosx: is this the right thing to do?
       end
     end
     alias_method :delete_output, :expire_output
     
+    # Is caching allowed for this action (page)? The default
+    # implementation does not cache post request or request 
+    # with query parameters. You can work arround the second
+    # 'limitation' by cleverly using Nitro's implicit support
+    # for 'nice' urls.
+    
     def caching_allowed?
       not (@request.post? or @request.uri =~ /\?/)
     end

data/lib/nitro/cgi.rb

@@ -31,30 +31,28 @@ class Cgi
     #--
     # gmosx: only handle nitro requests.
     #++
-    if context.path !~ /\./ 
-      # gmosx: QUERY_STRING is sometimes not populated.
+    # gmosx: QUERY_STRING is sometimes not populated.
 
-      if context.query_string.empty? and context.uri =~ /\?/
-        context.headers['QUERY_STRING'] = context.uri.split('?').last
-      end
+    if context.query_string.empty? and context.uri =~ /\?/
+      context.headers['QUERY_STRING'] = context.uri.split('?').last
+    end
 
-      Cgi.parse_params(context)
-      Cgi.parse_cookies(context)
-      context.render(context.path)
+    Cgi.parse_params(context)
+    Cgi.parse_cookies(context)
+    context.render(context.path)
 
-      out.print(Cgi.response_headers(context))
-      
-      if context.out.is_a?(IO)
-        begin
-          while buf = context.out.read(4096)
-            out.write(buf)
-          end
-  ensure
-          context.out.close
-  end
-      else
-        out.print(context.out)
+    out.print(Cgi.response_headers(context))
+    
+    if context.out.is_a?(IO)
+      begin
+        while buf = context.out.read(4096)
+          out.write(buf)
+        end
+      ensure
+        context.out.close
       end
+    else
+      out.print(context.out)
     end
 
     $autoreload_dirty = false
@@ -116,7 +114,7 @@ class Cgi
     if env['HTTP_COOKIE'] or env['COOKIE']
       (env['HTTP_COOKIE'] or env['COOKIE']).split(/; /).each do |c|
         key, val = c.split(/=/, 2)
-        
+        val ||= ""
         key = CGI.unescape(key)
         val = val.split(/&/).collect{|v| CGI::unescape(v)}.join("\0")
 

data/lib/nitro/cgi/cookie.rb

@@ -18,14 +18,18 @@ class Cookie
     @comment_url = @discard = @port = nil
   end
 
+  # Set the cookie expiration.
+  
   def expires=(t)
     @expires = t && (t.is_a?(Time) ? t.httpdate : t.to_s)
   end
 
+  # When the cookie expires.
+  
   def expires
     @expires && Time.parse(@expires)
   end
-
+  
   def to_s
     ret = ""
     ret << @name << "=" << @value

data/lib/nitro/cgi/request.rb

@@ -26,6 +26,7 @@ module Request
   # The request cookies.
 
   attr_accessor :cookies
+  alias_method :cookie, :cookies
 
   # The request protocol.
 
@@ -60,8 +61,8 @@ module Request
    #
    # === Examples
    #
-   # www.nitrohq.com: request.domain # => 'nitrohq.com'
-   # www.nitrohq.co.uk: request.domain(2) # => 'nitrohq.co.uk'
+   # www.nitroproject.org: request.domain # => 'nitroproject.org'
+   # www.nitroproject.co.uk: request.domain(2) # => 'nitroproject.co.uk'
   
   def domain(tld_length = 1)
     host.split('.').last(1 + tld_length).join('.')
@@ -71,7 +72,7 @@ module Request
   #
   # === Examples
   # 
-  # my.name.nitrohq.com: request.subdomains # => ['my', 'name']
+  # my.name.nitroproject.org: request.subdomains # => ['my', 'name']
   
   def subdomains(tld_length = 1)
     parts = host.split('.')
@@ -80,7 +81,7 @@ module Request
 
   # The request query string.
   #--
-  # gmosxi, FIXME: handles some fcgi problems.
+  # gmosx, FIXME: handles some fcgi problems.
   #++
 
   def query_string 
@@ -251,6 +252,20 @@ module Request
     @params[param] = value
   end
   
+  # Check if a boolean param (checkbox) is true.
+  
+  def true?(param)
+    @params[param] == 'on'
+  end
+  alias_method :enabled?, :true?
+  alias_method :boolean, :true?
+  
+  # Check if a boolean param (checkbox) is false.
+   
+  def false?(param)
+    !true?(param)
+  end
+  
   # Fetch a parameter with default value.
   
   def fetch(param, default = nil)
@@ -263,6 +278,7 @@ module Request
     @params.has_key?(key)
   end
   alias_method :has_param?, :has_key?
+  alias_method :param?, :has_key?
 end
 
 end

data/lib/nitro/compiler.rb

@@ -40,6 +40,27 @@ class Compiler
   
   setting :reload, :default => true, :doc => 'If true all code and templates are reloaded in each request'
 
+
+  # The default transformation pipeline. Nitro allows fine 
+  # grained customization pipelines per controller or even per 
+  # action. The Template transformation is added by default. 
+  # Here come examples of pipeline customization:
+  #
+  # class MyController
+  #   ann :self, :transformation_pipeline => [MyTransformer, AnotherXForm]
+  #
+  #   ...
+  #
+  #   def my_action
+  #     ...
+  #   end
+  #   ann :my_action, :transformation_pipeline => Compiler.transformation_pipeline.dup.shift(CustomXForm)
+  #  
+  #   ...
+  # end
+  
+  setting :transformation_pipeline, :default => [StaticInclude, Morphing, Elements, Markup, ScriptCompiler, Cleanup], :doc => 'The default transformation pipeline'
+
   def initialize(controller = nil)
     @controller = controller
     @shared = {}
@@ -86,15 +107,34 @@ class Compiler
   # The default transformation extracts the Ruby code from
   # processing instructions, and uses the StaticInclude,
   # Morphing, Elements and Markup compiler modules.
+  #
+  # The Template transformation stage is added by default.
+  #
+  # You can override this method or use aspects for really
+  # special transformation pipelines. Your imagination is the
+  # limit.
+  #--
+  # TODO: make Template stage pluggable.
+  # gmosx: This method is also called from the scaffolding 
+  # code.
+  #++
   
-  def transform_template(template)
-    template = StaticInclude.transform(template, self)
-    template = Morphing.transform(template, self)
-#   template = LayoutCompiler.transform(template, self)
-    template = Elements.transform(template, self)
-    template = Markup.transform(template)
-    template = ScriptCompiler.transform(template, self)
-    template = Cleanup.transform(template)
+  def transform_template(action, template)
+    # Check for an action specific transformation pipeline.
+    if (transformers = @controller.ann(action.to_sym).transformation_pipeline).nil?
+      # Check for a controller specific transformation pipeline.
+      if (transformers = @controller.ann.self.transformation_pipeline).nil?
+        # Use the default transformation pipeline.
+        transformers = Compiler.transformation_pipeline
+      end
+    end
+
+    transformers.each do |transformer|
+      template = transformer.transform(template, self)
+    end
+    
+    # Add Template transformation stage by default.
+    
     template = Template.transform(template)
   end
 
@@ -109,7 +149,7 @@ class Compiler
   
     code = %{
       def #{action}_template
-        #{transform_template(template)}
+        #{transform_template(action, template)}
       end
     }
     
@@ -155,14 +195,19 @@ class Compiler
   #++
   
   def compile_action(action)    
-    action = action.to_s.gsub(/_action$/, '')
+    action = @action = action.to_s.gsub(/_action$/, '')
 
     return false unless action
 
     Logger.debug "Compiling action '#@controller##{action}'" if $DBG
 
     valid = false
-    
+
+    #--
+    # FIXME: parent_action_name does not work as expected, 
+    # if you include actions from other controllers!!
+    #++
+        
     code = %{
       def #{action}_action
         @parent_action_name = @action_name 
@@ -171,7 +216,7 @@ class Compiler
   
     # Inject the pre advices.
 
-    code << Glue::Aspects.gen_advice_code(action, @controller.advices, :pre) 
+    code << ::Aspects.gen_advice_code(action, @controller.advices, :pre) 
 
     # Call the action
     
@@ -187,16 +232,16 @@ class Compiler
                                                                 
       # Try to resolve action parameters. Returns negative
       # numbers for arbitrary parameters.
+      #--
+      # gmosx: This needs a better implementation. Better means
+      # cleaner and more optimized code.
+      #++
 
       param_count = @controller.instance_method(action.to_sym).arity 
       
       if param_count != 0
-        if param_count > 0 
-          code << "params = Array.new(#{param_count}, nil);"
-        else
-          code << "params = [];"
-        end
         code << %{
+          params = []
           unless context.query_string.blank?
             all_params = context.query_string.split(/[&;]/)
             is_hash = all_params.first.index('=')
@@ -208,9 +253,16 @@ class Compiler
         end
         code << %{
             break if qs.index('=') and not is_hash
-              params[i] = CGI.unescape(qs.split(/=/).last || "")
+              params << CGI.unescape(qs.split(/=/).last || "")
             end            
           end          
+          
+          # Concatenate some extracted parameters.
+          params.concat(context.params.values)
+          
+          # Fill the array with nils for the missing params.
+          (#{param_count} - params.size).times { params << nil }
+          
           action_return_value = #{action}(*params)
         }
       else
@@ -267,7 +319,7 @@ class Compiler
 
     # Inject the post advices.
 
-    code << Glue::Aspects.gen_advice_code(action, @controller.advices, :post) 
+    code << ::Aspects.gen_advice_code(action, @controller.advices, :post) 
 
     code << %{
         @action_name = @parent_action_name
@@ -279,6 +331,8 @@ class Compiler
     @controller.class_eval(code)
 
     unless @controller.respond_to?("#{action}_template")
+      # If there is not method {action}_template in the controller
+      # search for a file template.
       if template_path 
         compile_template(action, template_path)
       end
@@ -297,15 +351,6 @@ class Compiler
   # :section: Helper methods.
 
   class << self
-    # Helper method for manipulating the template transformation
-    # pipeline.
-    
-    def setup_transform_template(&block)
-      send :define_method, :transform_template, block
-    end
-    alias_method :setup_template_transform, :setup_transform_template
-    alias_method :setup_template_transformation, :setup_transform_template
-    
     # Typically used to precompile css templates.
     
     def precompile(filename)
@@ -330,3 +375,4 @@ end
 # * George Moschovitis <gm@navel.gr>
 # * Chris Farmiloe <chris.farmiloe@farmiloe.com>
 # * Rob Pitt <rob@motionpath.co.uk>
+# * Jonas Pfenniger <zimba.tm@gmail.com>

data/lib/nitro/compiler/cleanup.rb

@@ -4,7 +4,7 @@ module Nitro
 
 module Cleanup
   
-  def self.transform(text)
+  def self.transform(text, compiler = nil)
     Glue::Html.cleanup(text)
   end
   

data/lib/nitro/compiler/elements.rb

@@ -80,7 +80,7 @@ class Elements # :nodoc: all
 #      name = name.demodulize
       return false unless name =~ PREFIX_RE or name =~ CAPITALIZED_RE
 
-      name = name.gsub(/#{PREFIX_RE}:/,'').camelize if name =~ PREFIX_RE
+      name = name.gsub(PREFIX_RE,'').camelize if name =~ PREFIX_RE
 
       # First try to use Nitro::Element::xxx then ::xxx
       
@@ -95,7 +95,6 @@ class Elements # :nodoc: all
         namespace = @compiler.controller.name
         if /::/ =~ namespace
           namespace = namespace.gsub( /::[a-zA-Z]+$/, "::#{name}" )
-          pp namespace
           klass = Class.by_name(namespace)
         end
       rescue

data/lib/nitro/compiler/localization.rb

@@ -8,7 +8,7 @@ class Localization
 
     # Transform localization macros.
     
-    def transform(text)
+    def transform(text, compiler = nil)
       # handle symbols
       text.gsub!(/\[\[\:(.*?)\]\]/, '#{@lc[\1]}')
 

data/lib/nitro/compiler/markup.rb

@@ -10,7 +10,7 @@ module Markup
   # Maps #(..) to :sanitize.
   # Maps #|..| to :markup.
   
-  def self.transform(text)
+  def self.transform(text, compiler = nil)
     text.gsub!(/\#\((.*?)\)/, '#{sanitize(\1)}')
     text.gsub!(/\#\|(.*?)\|/, '#{markup(\1)}')
     return text