nitro 0.30.0 → 0.31.0

data/lib/nitro/helper/pager.rb

@@ -24,6 +24,10 @@ class Pager
   
   setting :key, :default => '_page', :doc => 'The request key'
 
+  # The nav link titles
+  
+  setting :link_titles, :default => {:first => 'First', :previous => 'Previous', :last => 'Last', :next => 'Next'}, :doc =>  "Titles of pager links"
+  
   # The current page.
   
   attr_accessor :page
@@ -40,10 +44,10 @@ class Pager
   
   attr_accessor :total_count
     
-  def initialize(request, per_page, total_count, key = Pager.key)
+  def initialize(request, per_page, total_count, key = Pager.key, link_titles = Pager.link_titles)
     raise 'per_page should be > 0' unless per_page > 0
   
-    @request, @key = request, key
+    @request, @key, @link_titles = request, key, link_titles
     @page = request.query.fetch(key, 1).to_i
     @per_page = per_page
     set_count(total_count)
@@ -55,6 +59,10 @@ class Pager
     @page_count = (@total_count.to_f / @per_page).ceil
   end
 
+  def has_pages?
+    return @page_count > 1
+  end
+  
   # Return the first page index.
   
   def first_page
@@ -188,17 +196,18 @@ class Pager
   def navigation
     nav = ""
     
+    return nav unless has_pages?
     unless first_page?
       nav << %{
-        <div class="first"><a href="#{first_page_href}">First</a></div>
-        <div class="previous"><a href="#{previous_page_href}">Previous</a></div>
+        <div class="first"><a href="#{first_page_href}">#{CGI.escapeHTML(@link_titles[:first])}</a></div>
+        <div class="previous"><a href="#{previous_page_href}">#{CGI.escapeHTML(@link_titles[:previous])}</a></div>
       }
     end
     
     unless last_page?
       nav << %{
-        <div class="last"><a href="#{last_page_href}">Last</a></div>
-        <div class="next"><a href="#{next_page_href}">Next</a></div>
+        <div class="last"><a href="#{last_page_href}">#{CGI.escapeHTML(@link_titles[:last])}</a></div>
+        <div class="next"><a href="#{next_page_href}">#{CGI.escapeHTML(@link_titles[:next])}</a></div>
       }
     end
 
@@ -270,24 +279,24 @@ private
   def paginate(items, options = {})
     per_page = options.delete(:per_page) || Pager.per_page
     pager_key = options.delete(:pager_key) || Pager.key
-    
+    pager_link_titles = Pager.link_titles.merge(options.delete(:pager_link_titles) || Pager.link_titles) 
     case items
       when Array
         items = items.dup
-        pager = Pager.new(request, per_page, items.size, pager_key)
+        pager = Pager.new(request, per_page, items.size, pager_key, pager_link_titles)
         items = items.slice(pager.offset, pager.per_page) || []
         return items, pager      
       
       when Og::Collection
         collection = items
-        pager = Pager.new(request, per_page, collection.count, pager_key)
+        pager = Pager.new(request, per_page, collection.count, pager_key, pager_link_titles)
         options.update(pager.limit)
         items = collection.reload(options)
         return items, pager
       
       when Class
         klass = items
-        pager = Pager.new(request, per_page, klass.count(options), pager_key)
+        pager = Pager.new(request, per_page, klass.count(options), pager_key, pager_link_titles)
         options.update(pager.limit)
         items = klass.all(options)
         return items, pager

data/lib/nitro/helper/table.rb

@@ -111,7 +111,7 @@ module TableHelper
           str << '>'
           
           for value in row
-            str << %|<td>#{value}</td>|
+            str << %|<td>#{process(value)}</td>|
           end
           
           str << '</tr>'
@@ -131,7 +131,7 @@ module TableHelper
         str << '>'
         
         for value in row
-          str << %|<td>#{value}</td>|
+          str << %|<td>#{process(value)}</td>|
         end
         
         str << '</tr>'
@@ -159,6 +159,7 @@ module TableHelper
     str << '<tr>'
     
     options[:headers].each_with_index do |header, index|
+      header = process(header)
       if (options[:order] && options[:order][:values] &&
                             options[:order][:values][index])
         order_by = options[:order][:values][index]
@@ -233,7 +234,31 @@ module TableHelper
   end
   
   def create_tbody?(options)
-    options[:values][0][0].respond_to?(:to_ary)
+    options[:values][0].respond_to?(:to_ary) && options[:values][0][0].respond_to?(:to_ary)
+  end
+
+  # A simple hack to allow Localization-processing in the table-helper
+  # overwrite this method to make this happen
+  # Now you can just pass [[somestring]] to the tablehelper and it will
+  # be localized like the rest of the page.
+  # ATM it's only kicking in when the @lc is set.
+  #
+  # Example for the method:
+  # module Nitro
+  #   module TableHelper
+  #     def process(value)
+  #       val = value.to_s.gsub(/\[\[(.*?)\]\]/){ @lc[$1] }
+  #       return val == "" ? value : val
+  #     end
+  #   end
+  # end
+
+  def process(value)
+    if @lc
+      val = value.to_s.gsub(/\[\[(.*?)\]\]/){ @lc[$1] }
+      return val == "" ? value : val
+    end
+    return value
   end
 
 end

data/lib/nitro/helper/xhtml.rb

@@ -13,7 +13,7 @@ module XhtmlHelper
     elsif obj.respond_to? :to_href
       href = obj.to_href
     else
-      href = "#{obj.class.name.pluralize.undescore}/#{obj.oid}"
+      href = "#{obj.class.name.pluralize.underscore}/#{obj.oid}"
     end
     
     if base
@@ -63,7 +63,8 @@ module XhtmlHelper
       
       values = options[:values] || options[:labels_values] || (0...labels.size).to_a
       
-      selected = (options[:selected] || -1).to_i
+      selected = options[:selected]
+      selected = selected.to_s if selected
       
       labels.each_with_index do |label, idx|
         value = values[idx]
@@ -75,7 +76,7 @@ module XhtmlHelper
           end
           style = %{ style="#{style}"}
         end
-        if value == selected
+        if value.to_s == selected
           str << %|<option value="#{value}" selected="selected"#{style}>#{label}</option>|
         else
           str << %|<option value="#{value}"#{style}>#{label}</option>|

data/lib/nitro/part.rb

@@ -3,12 +3,67 @@ module Nitro
 # A part is a module of reusable functionality encapsulated as 
 # a mini site/app. You can require (include) multiple parts in 
 # your application. A part is in essence a high level component.
-
+#
+# The directory structure of a part mirrors the structure 
+# of a typicall web application. By conventions we put the
+# main directories of parts in a root directory called 'part'.
+#
+# Let's demonstrate the above with an example. Two parts are
+# defined here. A user management part (users) and a CMS 
+# (content). A typical dir structure goes like this ($ is a 
+# directory in the load path, this means you can put parts in 
+# multiple places as long as the are in the load path):
+#
+# $/part # parts will be stored here.
+#
+# $/part/users.rb # helper file used to 'require' the part.
+# $/part/users/public/
+# $/part/users/controller.rb
+# $/part/users/controller/xml.rb
+# $/part/users/model/user.rb
+# $/part/users/model/acl.rb
+# $/part/users/template/login.xhtml
+# $/part/users/template/form.xinc
+# $/part/users/run.rb # starts an 'example' application for this part.
+#
+# $/part/content.rb
+# $/part/content/controller.rb
+# $/part/content/model.rb
+# ...
+#
+# Given this direcotry structure you can 'require' a part 
+# like this:
+#
+# require 'part/users'
+# require 'part/content'
+#
+# The helper files (for example the file part/users.rb) typically
+# require the part files needed by default.
+#
+# The 'example' application start files (for example part/users/run.rb)
+# are optional. If present, they start a small application that
+# demonstrates the usage of the part. In the example app, the main
+# part controller is mounted at the root ('/'). Typically, in
+# your own applications, you will mount the controller as needed,
+# (for example: 'users' => UsersController, 
+# 'blog' => 'ContentController') 
+#
+# The files that reside in the public directory are typically
+# copied by a code generator to your application public dir.
+#
+# Part controllers setup the template root stack to lookup 
+# templates in their local template dir (for example part/users/template)
+# if a template is not found in the applications normal template
+# root. In essence, by requiring a part a target application,
+# 'inherits' its templates. If you want to customize (override)
+# one template, just place a template with the same name in the
+# respective directory in the application template root.
+ 
 class Part
 
   # Require (include) a part in the current application.
 
-  def self.require(name)
+  def self.require name
     Logger.debug "Requiring part '#{name}'." if $DBG
     Kernel.require 'part/' + name + '/run.rb'
   end

data/lib/nitro/render.rb

@@ -4,7 +4,6 @@ require 'stringio'
 
 require 'facet/string/blank'
 
-require 'glue/attribute'
 require 'glue/settings'
 require 'glue/template'
 require 'glue/builder/xml'
@@ -16,24 +15,32 @@ require 'nitro/helper/buffer'
 
 module Nitro
 
+#--
 # Raise or Throw this exception to stop the current action.
-# Typically called to skip the template.
+# Typically called to skip the template. This is considerered
+# a low level tactic. Prefer to use the exit method.
+#++
 
-class ActionExit < Exception; end
+class ActionExit < Exception # :nodoc: all
+end 
   
+#--
 # Raise or Throw this exception to stop rendering altogether.
 # Typically called by redirects.
+#++
 
-class RenderExit < Exception; end
+class RenderExit < Exception # :nodoc: all
+end
 
+#--
 # The output buffer. The output of a contoller action is
 # accumulated in this buffer before sending this to the client
 # as a HTTP Response.
-#--
+#
 # TODO: Implement a FAST string (maybe in C)
 #++
 
-class OutputBuffer < String
+class OutputBuffer < String # :nodoc: all
 end
 
 # The rendering mixin. This module is typically included in
@@ -81,12 +88,9 @@ module Render
   
   attr_accessor :base
   
-  # The name of the current controller.
-  #--
-  # gmosx: Needed for WEE. Will be deprecated.
-  #++
+  # The current controller class.
   
-  attr_accessor :controller_name
+  attr_accessor :controller
   
   # Initialize the render.
   #
@@ -94,9 +98,8 @@ module Render
   #    A parent render/controller acts as the context.
 
   def initialize(context, base = nil)
-    @rendering_context = 0
     @request = @response = @context = context
-    @controller_name = @base = base
+    @base = base
     @out = context.out
   end
 
@@ -114,21 +117,23 @@ module Render
       
     Logger.debug "Rendering '#{path}'." if $DBG
   
-    klass, action, base = @context.dispatcher.dispatch(path, @context)
+    @controller, action, base = @context.dispatcher.dispatch(path, @context)
 
-    # FIXME: 
-    @context.content_type = klass.instance_variable_get('@content_type') || 'text/html'
+    raise 'No controller for action' unless @controller
 
-    raise 'No controller for action' unless klass
+    # FIXME: 
+    @context.content_type = @controller.instance_variable_get('@content_type') || 'text/html'
 
     @context.level += 1
-        
-    if self.class == klass 
+    old_controller = Controller.replace_current(@controller)
+    
+    if self.class == @controller 
       self.send(action)
     else
-      klass.new(@context, base).send(action)
+      @controller.new(@context, base).send(action)
     end
 
+    Controller.replace_current(old_controller)
     @context.level -= 1
     
   rescue NoActionError => e1
@@ -142,6 +147,7 @@ module Render
   rescue Exception, StandardError => e3
     # More fault tolerant, only flags the erroneous box with 
     # error not the full page.    
+
     log_error(e3, path)
     print '(error)'
   end
@@ -149,13 +155,21 @@ module Render
 private
 
   # Helper method to exit the current action, typically used
-  # to skip the template.
+  # to skip the template rendering.
+  # 
+  # === Example
+  #
+  # def my_action
+  #   ...
+  #   exit unless user.admin?
+  # end
   
   def exit
     raise ActionExit.new
   end
 
-  # Flush the IO object if we are in streaming mode.
+  # Flush the IO object (OutputBuffer) if we are in streaming 
+  # mode.
   
   def flush
     @out.flush if @out.is_a?(IO)
@@ -168,9 +182,34 @@ private
   # If the url starts with '/' it is considered absolute, else
   # the url is considered relative to the current controller and
   # the controller base is prepended.
+  #
+  # The parameters are passed to the R operator (encode_url)
+  # to actually build the url. So the following forms (among
+  # others) are allowed:
+  #
+  # redirect 'home/login'
+  # redirect ForaController, :post, :title, 'The title'
+  # redirect :welcome
+  # redirect article # => article.to_href
+  #
+  # You can also pass optional hash parameters at the end,
+  # for example:
+  #
+  # redirect :welcome, :status => 307
+  #
+  # The default redirect status is 303.
   
-  def redirect(url, status = 303)
-    url = url.to_s
+  def redirect(*args)
+    if args.last.is_a? Hash
+      status = args.last.fetch(:status, 303)
+    else
+      status = 303
+    end
+    
+    url = encode_url(*args)
+
+    # gmosx, THINK: this may be unnecessary!
+        
     unless url =~ /^http/
       url = "#@base/#{url}" unless url =~ /^\//
       url = "#{@context.host_url}/#{url.gsub(/^\//, '')}"
@@ -187,7 +226,7 @@ private
   # Redirect to the referer.
   
   def redirect_referer(postfix = nil, status = 303)
-    redirect("#{@context.referer}#{postfix}", status)
+    redirect "#{@context.referer}#{postfix}", :status => status
   end
   alias_method :redirect_to_referer, :redirect_referer
   alias_method :redirect_referrer, :redirect_referer
@@ -196,7 +235,7 @@ private
   # Redirect to home.
   
   def redirect_home(status = 303)
-    redirect('/', status)
+    redirect '/', :status => status
   end
   alias_method :redirect_to_home, :redirect_home
 
@@ -209,10 +248,10 @@ private
   # === Example
   #
   # caller:
-  # color, type = call('utils/select_color')
+  # color, type = call 'utils/select_color'
   #
   # target:
-  # answer(color, type)
+  # answer color, type
   #--
   # FIXME: dont use yet, you have to encode the branch to 
   # make this safe for use.

data/lib/nitro/router.rb

@@ -94,6 +94,7 @@ module Router
       
       return url
     end
+    
     return false
   end