nitro 0.21.2 → 0.22.0

data/lib/nitro/mixin/markup.rb

@@ -21,7 +21,7 @@ module Nitro
 #
 # Define your custom markup methods like this:
 #
-# module MarkupMixin
+# module Markup
 #   def markup_simple
 #      ...
 #    end
@@ -49,7 +49,7 @@ private
   def expand(str)
     if str
       xstr = str.dup
-      xstr.gsub!(/</, '&lt;')    
+#     xstr.gsub!(/</, '&lt;')    
       xstr.gsub!(/>/, '&gt;')
       return String.sanitize(xstr)
     end

data/lib/nitro/mixin/pager.rb

@@ -8,9 +8,9 @@ module Nitro
 # === Design
 #
 # This pager is carefully designed for scaleability. It stores 
-# only the items for one page. The name parameter is needed, multiple 
-# pagers can coexist in a single page. Unlike older pagers this 
-# pager leverages the SQL LIMIT option to optimize database 
+# only the items for one page. The key parameter is needed, 
+# multiple pagers can coexist in a single page. The pager 
+# leverages the SQL LIMIT option to optimize database 
 # interaction.
 
 class Pager
@@ -53,21 +53,53 @@ class Pager
     @page_count = (@total_count.to_f / @per_page).ceil
   end
 
+  # Return the first page index.
+  
   def first_page
     return 1
   end
   
+  # Is the first page displayed?
+  
+  def first_page?
+    @page == 1
+  end
+  
+  # Return the last page index.
+  
   def last_page 
     return @page_count
   end
   
+  # Is the last page displayed?
+  
+  def last_page?
+    @page == @page_count
+  end
+  
+  # Return the index of the previous page.
+  
   def previous_page
     return [@page - 1, 1].max()
   end
+
+  # Return the index of the next page.
   
   def next_page
     return [@page + 1, @page_count].min()
   end
+
+  # A set of helpers to create links to common pages.
+  
+  for target in [:first, :last, :previous, :next]
+    eval %{
+      def link_#{target}_page
+        target_uri(#{target}_page)
+      end
+      alias_method :#{target}_page_uri, :link_#{target}_page
+      alias_method :#{target}_page_href, :link_#{target}_page
+    }
+  end
   
   # Iterator
   
@@ -119,7 +151,11 @@ class Pager
   # To be used with Og queries.
     
   def limit
-    { :limit => @per_page, :offset => @start_idx }
+    if @start_idx > 0
+      { :limit => @per_page, :offset => @start_idx }
+    else
+      { :limit => @per_page }
+    end
   end
 
   def offset 
@@ -146,17 +182,17 @@ class Pager
   def navigation
     nav = ""
     
-    unless @page == first_page()
+    unless first_page?
       nav << %{
-        <div class="first"><a href="#{target_uri(first_page())}">First</a></div>
-        <div class="previous"><a href="#{target_uri(previous_page())}">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 @page == last_page()
+    unless last_page?
       nav << %{
-        <div class="last"><a href="#{target_uri(last_page())}">Last</a></div>
-        <div class="next"><a href="#{target_uri(next_page())}">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
 
@@ -198,32 +234,51 @@ module PagerMixin
 private
   
   # Helper method that generates a collection of items and the
-  # asorted pager object.
+  # associated pager object.
   #
   # === Example
   #
   # entries, pager = paginate(Article, :condition => 'title LIKE %Ab%', :per_page => 10)
   # 
+  # or 
+  #
+  # items = [ 'item1', 'item2', ... ]
+  # entries, pager = paginate(items, :per_page => 10)
+  # 
+  # or
+  #
+  # entries, pager = paginate(article.comments, :per_page => 10)
+  #
   # <ul>
   # <?r for entry in entries ?>
   #    <li>#{entry.to_link}</li>
   # <?r end ?>
-  #  </ul>
-  #  #{pager.links}
+  # </ul>
+  # #{pager.links}
   
-  def paginate(klass_or_array, options = {})
+  def paginate(items, options = {})
     per_page = options.delete(:per_page) || Pager.per_page
-    
-    if klass_or_array.is_a? Array
-      items = klass_or_array.dup
-      pager = Pager.new(request, per_page, items.size, key = Pager.key)
-      items = items.slice(pager.offset, pager.per_page)
-      return items, pager      
-    else
-      pager = Pager.new(request, per_page, klass_or_array.count(options), key = Pager.key)
-      options.update(pager.limit)
-      items = klass_or_array.all(options)
-      return items, pager
+
+    case items
+      when Array
+        items = items.dup
+        pager = Pager.new(request, per_page, items.size, key = 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, key = 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), key = Pager.key)
+        options.update(pager.limit)
+        items = klass.all(options)
+        return items, pager
     end
   end
   

data/lib/nitro/mixin/rss.rb

@@ -3,6 +3,8 @@ require 'rss/0.9'
 
 require 'facet/string/first_char'
 
+require 'nitro/mixin/markup'
+
 module Nitro
 
 # Build RSS represenations of ruby object collections.
@@ -17,7 +19,8 @@ module Nitro
 #++
 
 module RssMixin
-
+  include Nitro::Markup
+  
   # === Options
   #
   # [+:description+]
@@ -44,7 +47,7 @@ module RssMixin
       item = RSS::Rss::Channel::Item.new
       item.title = obj.title if obj.respond_to?(:title)
       if obj.respond_to? :body and body = obj.body
-        item.description = CGI.escape(body.first_char(256)) 
+        item.description = markup(body.first_char(256)) 
       end
       if obj.respond_to? :to_href
         item.link = "#{c[:base]}/#{obj.to_href}" 

data/lib/nitro/render.rb

@@ -7,6 +7,7 @@ require 'glue/attribute'
 require 'glue/misc'
 require 'glue/object'
 require 'glue/settings'
+require 'glue/template'
 require 'glue/builder'
 require 'glue/builder/xml'
 
@@ -173,6 +174,14 @@ private
   end
   alias_method :print, :render_text
 
+  # Render a template into the output buffer.
+  
+  def render_template(filename)
+    filename = "#{filename}.xhtml" unless filename =~ /\.xhtml$/
+    template = File.read("#{self.class.template_root}/#{filename}")
+    Template.process_template(template, '@out', binding)
+  end
+
   # Access the programmatic renderer (builder).
   
   def build(&block)

data/lib/nitro/request.rb

@@ -2,7 +2,7 @@ module Nitro
   
 # Encapsulates a request. This is an abstract request
 # typically extended by sub-classes. This module
-# is included in Context
+# is included in Context.
 
 module Request
 
@@ -16,7 +16,6 @@ module Request
   attr_accessor :headers
   alias_method :env, :headers
   alias_method :env=, :headers=
-  # for compatibility with cgi.rb
   alias_method :env_table, :headers
 
   # The parsed query parameters collection.
@@ -56,23 +55,107 @@ module Request
     @headers['PATH_INFO']
   end
 
+  # Returns the domain part of a host.
+   #
+   # === Examples
+   #
+   # www.nitrohq.com: request.domain # => 'nitrohq.com'
+   # www.nitrohq.co.uk: request.domain(2) # => 'nitrohq.co.uk'
+  
+  def domain(tld_length = 1)
+    host.split('.').last(1 + tld_length).join('.')
+  end
+
+  # Returns all the subdomains as an array.
+  #
+  # === Examples
+  # 
+  # my.name.nitrohq.com: request.subdomains # => ['my', 'name']
+  
+  def subdomains(tld_length = 1)
+    parts = host.split('.')
+    parts[0..-(tld_length+2)]
+  end
+
   # The request query string.
 
   def query_string 
     @headers['QUERY_STRING']
   end
   
-  # The request method.
+  # The request method. Alternatively you could use the 
+  # request method predicates.
+  #
+  # === Examples
+  #
+  # if request.method == :get
+  # if request.get?
 
   def method
     @headers['REQUEST_METHOD'].downcase.intern
   end
 
-  # Is this a post method?
+  #--
+  # Define a set of helpers to determine the request
+  # method (get?, post?, put?, delete?, head?)
+  #++
+  
+  for m in [:get, :post, :put, :delete, :head]
+    eval %{
+      def #{m}?; method == :#{m}; end
+    }
+  end
+
+  # Determine whether the body of a POST request is URL-encoded 
+  # (default), XML, or YAML by checking the Content-Type HTTP 
+  # header:
+  #
+  #   Content-Type        Post Format
+  #   application/xml     :xml
+  #   text/xml            :xml
+  #   application/x-yaml  :yaml
+  #   text/x-yaml         :yaml
+  #   *                   :url_encoded
   
-  def post?
-    method == :post
+  def post_format
+    @post_format ||= if @headers['HTTP_X_POST_DATA_FORMAT']
+      @headers['HTTP_X_POST_DATA_FORMAT'].downcase.to_sym
+    else
+      case @headers['CONTENT_TYPE'].to_s.downcase
+      when 'application/xml', 'text/xml' then :xml
+      when 'application/x-yaml', 'text/x-yaml' then :yaml
+      else :url_encoded
+      end
+    end
   end
+
+  # Is this a POST request formatted as XML or YAML?
+  
+  def formatted_post?
+    post? && (post_format == :xml || post_format == :yaml)
+  end
+
+  # Is this a POST request formatted as XML?
+  
+  def xml_post?
+    post? && post_format == :xml
+  end
+
+  # Is this a POST request formatted as YAML?
+  
+  def yaml_post?
+    post? && post_format == :yaml
+  end
+
+  # Is this an XhtmlRpcRequest?
+  # Returns true if the request's 'X-Requested-With' header 
+  # contains 'XMLHttpRequest'. Compatible with the Prototype 
+  # Javascript library.
+  
+  def xml_http_request?
+    not /XMLHttpRequest/i.match(@headers['HTTP_X_REQUESTED_WITH']).nil?
+  end
+  alias xhr? :xml_http_request?
     
   # Return the referer. For the initial page in the
   # clickstream there is no referer, set "/" by default.
@@ -122,6 +205,8 @@ module Request
     @headers['HTTP_X_FORWARDED_HOST'] || @headers['HTTP_HOST'] 
   end
 
+  # The host url.
+  
   def host_url
     "http://#{host}"
   end
@@ -161,3 +246,5 @@ module Request
 end
 
 end
+
+# * George Moschovitis <gm@navel.gr>

data/lib/nitro/response.rb

@@ -16,6 +16,10 @@ module Response
 
   attr_accessor :response_cookies
 
+  def content_type
+    @response_headers['Content-Type']
+  end
+
   def content_type=(ctype)
     @response_headers['Content-Type'] = ctype
   end

data/lib/nitro/server.rb

@@ -61,7 +61,7 @@ class Server
   # The access_log for this server, used by Webrick.
 
   attr_accessor :access_log   
-      
+
   def initialize(name = 'Nitro', options = {})
     @name = name
     @map = self.class.map.dup
@@ -82,9 +82,9 @@ class Server
   
   # Start the server.
   
-  def start(controller = nil)    
-    @map['/'] = controller if controller
-    @dispatcher = Dispatcher.new(@map)
+  def start(options = {})    
+    @map['/'] = options[:controller] if options[:controller]
+    @dispatcher = options[:dispatche] || Dispatcher.new(@map)
   end
 
   def root=(controller)
@@ -96,15 +96,30 @@ class Server
   end
 
   # Helper method.
-  
-  def self.run(controller = nil)
+  #
+  # Available options: 
+  #
+  # :dispatcher, :controller
+  #
+  # Altetnatively you can pass a single Controller class instead
+  # of the options hash.
+
+  def self.run(options = {})
+    unless options.is_a?(Hash)
+      options = { :controller => options }
+    end
+    
     runner = Runner.new
     runner.setup_options
     runner.setup_mode
     runner.daemonize if runner.daemon  
+    
     server = Server.new
-    server.start(controller)
-    runner.invoke(server)        
+    server.start(options)
+    
+    runner.invoke(server) unless $NITRO_NO_INVOKE 
+    
+    return server
   end
 
   # A Helper class used for CherryPy-style publishing.
@@ -123,8 +138,7 @@ class Server
       end
     end
   end
-  
-  
+    
 end
 
 end