nitro 0.31.0 → 0.40.0

data/lib/nitro/helper/javascript/morphing.rb

@@ -166,5 +166,3 @@ Morphing.add_morpher :auto_complete, AutoCompleteMorpher
 Morphing.add_morpher :draggable, DraggableMorpher
 
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/nitro/helper/javascript/prototype.rb

@@ -92,5 +92,3 @@ module ScriptGenerator
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/nitro/helper/javascript/scriptaculous.rb

@@ -15,4 +15,3 @@ end
 
 end
 
-# * George Moschovitis <gm@navel.gr>

data/lib/nitro/helper/layout.rb

@@ -38,5 +38,3 @@ module LayoutHelper
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/nitro/helper/navigation.rb

@@ -0,0 +1,87 @@
+module Nitro
+
+# A helper mixin for programmatically building Navigation Menus
+# through easy to style XHTML. 
+# The code resulting from these methods is in line with that found in most examples at 
+# listamatic, thus you can use prebuilt CSS and Javascript to create horizontal or vertical menus.
+# Basically it generates something like
+#  <div id="navcontainer">
+#   <ul id="navlist">
+#    <li id="active"> <a href="/foo" id="current"> Current Page </a></li>
+#    <li> <a href="/bar"> Other page </a> </li>
+#   </ul>
+#   </div> 
+#
+# This helper takes care of setting of putting the special CSS
+# identifiers for the current controller automatically.
+# You could override menuitem_active_on(path)
+# to change the behaviour that choose the active item, 
+# for example  to keep the item "Wiki" active both for 
+# /wiki/pageone and /wiki/pagetwo
+#
+# Example of horizontal bar at listamatic:
+# http://css.maxdesign.com.au/listamatic/horizontal26.htm
+# Vertical example 
+# http://css.maxdesign.com.au/listamatic/vertical09.htm
+# 
+# NOTE: No tests were made with Publishable objects which are not 
+# subclass of Nitro::Controller, but it _should_ work. 
+
+module NavigationHelper
+
+TEMPLATE=<<Eof
+<div id="navcontainer">
+ <ul id="navlist">
+LIST
+ </ul>
+</div> 
+Eof
+
+  # Takes a list of controllers and builds a menu 
+  # using #mount_path as the url and the controller name as text. 
+  # An eventual "Controller" suffix will be stripped, so i.e. for controllers 
+  # named +HomeController+, +Pages+, +FeedCtl+ it will use 
+  # +Home+, +Page+, +FeedCtl+.
+  # 
+  # For more finegrained control you can pass a block to this function, each 
+  # controller will be passed to it and the result will be used as the text 
+  # for the menu item.
+  # 
+  # 
+  # Otherwise you can specify pairs of path/text using #navigation_for_hash
+  
+  def menu_for(*controllers) #:yields:
+    hash= {}
+    controllers.each do |c|
+      hash[c.mount_path] = block_given? ? yield(c) : c.name.gsub(/Controller/,'')
+    end
+    menu_from_hash(hash)
+  end
+  
+  # The argument must be an hash of pairs {'path'=>'text for menu item'},
+  # no control will be applied on these values, they will be used directly.
+  # You can use the method like
+  #  navigation_for_hash '/foo/bar'=>'Page One', '/foo/baz'=>'Page Two'
+  #
+  # The method takes care of setting the CSS values as expected. 
+  #
+  # To avoid specifying everything the method #navigation_menu can be used. 
+  
+  def menu_from_hash(hash)
+    list=hash.map do |path,name|
+      if menuitem_active_on?(path)
+        %{<li id="active"><a href="#{path}" id="current"> #{name} </a></li>}
+      else
+        %{<li><a href="#{path}"> #{name} </a></li>}
+      end
+    end.join("\n")
+    TEMPLATE.gsub("LIST",list)
+  end
+
+  def menuitem_active_on?(path)
+    path == request.path
+  end
+
+end
+
+end

data/lib/nitro/helper/pager.rb

@@ -24,10 +24,6 @@ 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
@@ -44,10 +40,10 @@ class Pager
   
   attr_accessor :total_count
     
-  def initialize(request, per_page, total_count, key = Pager.key, link_titles = Pager.link_titles)
+  def initialize(request, per_page, total_count, key = Pager.key)
     raise 'per_page should be > 0' unless per_page > 0
   
-    @request, @key, @link_titles = request, key, link_titles
+    @request, @key = request, key
     @page = request.query.fetch(key, 1).to_i
     @per_page = per_page
     set_count(total_count)
@@ -59,10 +55,6 @@ 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
@@ -196,18 +188,17 @@ class Pager
   def navigation
     nav = ""
     
-    return nav unless has_pages?
     unless first_page?
       nav << %{
-        <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>
+        <div class="first"><a href="#{first_page_href}">First</a></div>
+        <div class="previous"><a href="#{previous_page_href}">Previous</a></div>
       }
     end
     
     unless last_page?
       nav << %{
-        <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>
+        <div class="last"><a href="#{last_page_href}">Last</a></div>
+        <div class="next"><a href="#{next_page_href}">Next</a></div>
       }
     end
 
@@ -277,26 +268,26 @@ private
   # #{pager.links}
   
   def paginate(items, options = {})
-    per_page = options.delete(:per_page) || Pager.per_page
+    per_page = options.delete(:per_page) || options[:limit] || 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_link_titles)
+        pager = Pager.new(request, per_page, items.size, pager_key)
         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_link_titles)
+        pager = Pager.new(request, per_page, collection.count, pager_key)
         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_link_titles)
+        pager = Pager.new(request, per_page, klass.count(options), pager_key)
         options.update(pager.limit)
         items = klass.all(options)
         return items, pager
@@ -306,5 +297,3 @@ private
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/nitro/helper/table.rb

@@ -37,6 +37,7 @@ module Nitro
 # 
 #--
 # TODO: legend, verbose... ?
+# TODO, gmosx: Remove crappy, bloatware additions.
 #++
 
 module TableHelper
@@ -84,7 +85,7 @@ module TableHelper
   def table_rows(options)
     # also accept :items, :rows
     options[:values] = options[:values] || options[:items] || options[:rows]
-    
+
     str = ''
     str << table_header(options) if options[:headers]
     str << table_footer(options) if options[:footers]
@@ -111,7 +112,7 @@ module TableHelper
           str << '>'
           
           for value in row
-            str << %|<td>#{process(value)}</td>|
+            str << %|<td>#{value}</td>|
           end
           
           str << '</tr>'
@@ -131,7 +132,7 @@ module TableHelper
         str << '>'
         
         for value in row
-          str << %|<td>#{process(value)}</td>|
+          str << %|<td>#{value}</td>|
         end
         
         str << '</tr>'
@@ -159,7 +160,6 @@ 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,37 +233,14 @@ module TableHelper
     return Glue::UriUtils.update_query_string(request.uri.to_s, params)
   end
   
+  #--
+  # gmosx: Arrgh!! dangerous method, who added this?
+  #++
+  
   def create_tbody?(options)
-    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
+    options[:values][0][0].respond_to?(:to_ary)
   end
 
 end
 
 end 
-
-# * George Moschovitis <gm@navel.gr>
-# * Kashia Buch <kashia@vfemail.net>

data/lib/nitro/helper/url.rb

@@ -0,0 +1,104 @@
+module Nitro
+
+module URLHelper
+
+  # Encode controller, action, params into a valid url.
+  # Automatically respects nice urls and routing.
+  #
+  # Handles parameters either as a hash or as an array.
+  # Use the array method to pass parameters to 'nice' actions.
+  #
+  # Pass Controller, action, and (param_name, param_value) 
+  # pairs.
+  #
+  # === Examples
+  #
+  # encode_url ForaController, :post, :title, 'Hello', :body, 'World'
+  # encode_url :post, :title, 'Hello', :body, 'World' # => implies controller == self
+  # encode_url :kick, :oid, 4
+  # encode_url article # => article.to_href
+  # 
+  # Alternatively you can pass options with a hash:
+  #
+  # encode_url :controller => ForaController, :action => :delete, :params => { :title => 'Hello' }
+  # encode_url :action => :delete
+  #--
+  # FIXME: better implementation? optimize this?
+  # TODO: move elsewhere.
+  #++
+  
+  def encode_url(*args)
+    f = args.first
+    
+    # A standard url as string, return as is.
+    
+    if f.is_a? String
+      return f
+    end
+  
+    # If the passed param is an object that responds to :to_href
+    # returns the url to this object.
+    
+    if f.respond_to? :to_href
+      return args.first.to_href
+    end
+    
+    if f.is_a? Symbol
+      # no controller passed, imply controller == self!
+      args.unshift(self.class)
+    end
+
+    # Try to encode using the router.
+    
+    if url = Nitro.server.dispatcher.encode_route(*args)
+      return url
+    end
+    
+    # No routing rule, manual encoding.
+    
+    controller = args.shift
+    action = args.shift.to_sym
+    
+    if action == :index
+      url = "#{controller.mount_path}"
+    else
+      mount_path = controller.mount_path
+      mount_path = nil if mount_path == '/'    
+      url = "#{mount_path}/#{action}"
+    end
+      
+    unless args.empty?
+      if controller.respond_to_action_or_template? action
+        param_count = controller.instance_method(action).arity
+        if param_count != 0
+          param_count.times do
+            args.shift # name 
+            url << "/#{CGI.escape(args.shift.to_s)}"
+          end        
+        end
+      end
+      
+      unless args.empty?
+        url << '?'
+        params = []
+        (args.size / 2).times do
+          params << "#{args.shift}=#{args.shift}" 
+        end
+        url << params.join(';')
+      end
+    end
+    
+    return url  
+  end
+  alias R encode_url
+    
+  # Just like encode_url, but generates an absolute url instead.
+  
+  def encode_absolute_url(*args)
+    return "#{request.host_url}#{encode_url(*args)}"
+  end
+  alias RA encode_absolute_url
+
+end
+
+end

data/lib/nitro/helper/xhtml.rb

@@ -6,6 +6,9 @@ module Nitro
 module XhtmlHelper
 
   # Creates the href of an Object.
+  #--
+  # gmosx: this duplicates R functionality, merge!
+  #++
     
   def href_of(obj, base = nil)
     if obj.is_a?(Symbol) or obj.is_a?(String)
@@ -89,11 +92,25 @@ module XhtmlHelper
     end
   end
 
+  # Convert a collection of objects to options.
+  
+  def objects_to_options(objs, params = {})
+    labels = []
+    values = []
+    for obj in objs
+      labels << obj.to_s
+      values << obj.pk
+    end
+    params[:labels] = labels
+    params[:values] = values
+    options(params)
+  end
+
   # Render a hidden form input.
   
-  def hidden(options)
-    opts = options.collect { |k, v| %[#{k}="#{v}"] }.join(' ')
-    %[<input type="hidden" #{opts} />]
+  def hidden(name, value)
+#   opts = options.collect { |k, v| %[#{k}="#{v}"] }.join(' ')
+    %[<input type="hidden" name="#{name}" value="#{value}" />]
   end
   
   # Render a submit input.
@@ -199,4 +216,3 @@ end
 
 end
 
-# * George Moschovitis <gm@navel.gr>

data/lib/nitro/helper/xml.rb

@@ -123,5 +123,3 @@ class Glue::XmlBuilder
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/nitro/markup.rb

@@ -0,0 +1,131 @@
+require 'singleton'
+require 'redcloth'
+require 'cgi'
+
+require 'facets/core/module/class_extension'
+
+require 'nitro/sanitize'
+
+module Nitro
+
+# Generalised Markup transformations.
+#
+# The expand methods evaluate (expand) the markup
+# code to produce the final content. The compact
+# methods reverse this process to create the original
+# markup code. Not all markup transformations are
+# reversible.
+#
+# When this library is included, the default PropertyUtils 
+# implementation is overriden to add markup support.
+#
+# === Examples
+#
+# Define your custom markup methods like this:
+#
+# module Markup
+#   def markup_simple
+#      ...
+#    end
+#    def markup_special
+#      ...
+#    end
+#
+#   # maps the {{..}} macro
+#    alias_method :sanitize, :markup_simple
+#    # maps the {|..|} macro
+#    alias_method :markup, :markup_special
+#  end
+#
+# here comes the #{obj.body} # => prints the expanded version.
+#
+#  obj.body = markup(@params['body'])  
+
+module Markup
+
+private
+  # The default markup method. You should override this method 
+  # in your application to call your custom markup 
+  # methods.
+
+  def expand(str)
+    if str
+      xstr = str.dup
+      xstr.gsub!(/</, '&lt;')
+      xstr.gsub!(/>/, '&gt;')
+      xstr.gsub!(/\r/, '<br />')
+      return String.sanitize(xstr)
+    end
+    return nil
+  end
+  alias_method :sanitize, :expand
+
+  # ...
+  begin
+    require 'redcloth'
+    # Translates a String with Textile/Markdown formatting
+    # into XHTML. Depends on the RedCloth gem to work properly
+
+    def expand_redcloth(str)
+      if str
+        return RedCloth.new(expand(str)).to_html
+      end
+      return nil
+    end
+  rescue LoadError
+    def expand_redcloth(str) # :nodoc: 
+      "You called expand_redcloth(), but it needs RedCloth installed to work"
+    end
+  end
+  alias_method :markup, :expand_redcloth
+
+  # Compact (reverse) the content to the origial markup
+  # code. Not all markup transformations are reversible.
+  # You should override this method in your application
+  # to call your custom markup methods.
+  #
+  # NOT IMPLEMENTED.
+
+  def compact(str, meth = nil)
+  end
+
+  # Remove markup code from the input string.
+  #
+  # NOT IMPLEMENTED.
+
+  def clear(str)
+  end
+
+  def escape(str)
+    CGI.escape(str.gsub(/ /, '_'))
+  end
+
+  def unescape(str)
+    CGI.unescape(str.gsub(/_/, ' '))
+  end
+
+  class_extension do
+    # Helper method for manipulating the sanitize transformation.
+
+    def setup_sanitize_transform(&block)
+      self.send :define_method, :sanitize, block
+    end
+    alias_method :setup_sanitize_transformation, :setup_sanitize_transform
+
+    # Helper method for manipulating the markup transformation.
+
+    def setup_markup_transform(&block)
+      self.send :define_method, :markup, block
+    end
+    alias_method :setup_markup_transformation, :setup_markup_transform
+  end
+end
+
+# An abstract Markup class.
+
+class MarkupKit
+  extend Markup
+  include Markup
+end
+
+end