nitro 0.27.0 → 0.28.0

data/lib/nitro/caching.rb

@@ -1,5 +1,3 @@
-require 'fileutils'
-
 require 'glue/attribute'
 require 'glue/configuration'
 require 'glue/sweeper'
@@ -10,7 +8,11 @@ require 'nitro/caching/fragments'
 
 module Nitro
 
-# Adds support for caching.
+# Nitro Hierarchical Caching system.
+#
+# # Output caching (caches the whole page, main action)
+# # Action caching (cache the fragment generated by an action)
+# # Fragment caching (fine-grained fragment caching, cache snippets of code) 
 #--
 # TODO: add per controller caching_enabled.
 #++
@@ -21,8 +23,7 @@ module Caching
   
   setting :caching_enabled, :default => true, :doc => 'Globaly enable/disable caching'
   
-  def self.append_features(base) #:nodoc:
-    super
+  def self.included(base) #:nodoc:
     base.send :include, Output, Actions, Fragments
     base.module_eval do
 #      @caching_enabled = true

data/lib/nitro/caching/actions.rb

@@ -1,17 +1,21 @@
 require 'fileutils'
 
+require 'nitro/caching/fragments'
+
 module Nitro
 
 # Adds support for caching.
 
 module Caching
 
-  # Action caching.
+  # Action caching is a set of helper to allow the caching
+  # generated by an action. In the caching hierarchy it lies
+  # between Output caching (top action, full page) and fragment
+  # caching (fine-grained caching).
 
   module Actions 
 
-    def self.append_features(base) # :nodoc: 
-      super
+    def self.included(base) # :nodoc: 
       base.extend(ClassMethods)
     end
 
@@ -20,10 +24,10 @@ module Caching
       def cache_action(*actions)
         return unless caching_enabled?
         
-        before_filter(
+        before(
           %{
             fragment_name = "\#\{@action_name\}\#{@request.query_string}"
-            if fragment = Fragment.get(fragment_name)
+            if fragment = Fragments.get(fragment_name)
               @out = fragment
               return
             end
@@ -31,10 +35,10 @@ module Caching
           :only => actions
         )
         
-        after_filter(
+        after(
           %{ 
             fragment_name = "\#\{@action_name\}\#{@request.query_string}"
-            Fragment.put(fragment_name, @out) 
+            Fragments.put(fragment_name, @out) 
           },
           :only => actions
         )
@@ -44,8 +48,10 @@ module Caching
 
     private 
 
+    # Expire the cached fragment of the given actions.
+    #
     #--
-    # FIXME: not implemented.
+    # FIXME: not very good implementation?
     #++
     
     def expire_action(*actions)

data/lib/nitro/caching/fragments.rb

@@ -1,7 +1,8 @@
 require 'fileutils'
 
+require 'glue/configuration'
 require 'glue/attribute'
-require 'nitro/caching/stores'
+require 'glue/cache/memory'
 
 module Nitro
 
@@ -10,40 +11,53 @@ module Nitro
 module Caching
 
   # Action caching. Caches a fragment, ie a page part.
-  # Use output cachingfor full page caching.
+  # Use output caching for full page caching.
 
   module Fragments
 
-    @@store = FileStore.new # MemoryStore.new
-
-    def self.store 
-      @@store 
-    end
+    # The cache used to store the fragments.
     
-    def self.store=(store) 
-      @@store = store
-    end
+    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
     
     def self.get(name, options = {})
-      return @@store.read(name, options)
+      return @@cache.get(name, options)
     end
     
     def self.put(name, content = nil, options = {})
-      @@store.write(name, content, options)
+      @@cache.put(name, content, options)
       return content
     end
     
-    def self.append_features(base) # :nodoc: 
-      super
-    end
-
     private
 
+    # Helper method to cache a fragment. 
+    #
+    # === Example
+    #
+    # ...
+    # <h1>Article list</h1>
+    #
+    # <?r cache(:my_cache_key) do ?>
+    #   <ul>
+    #     <li each="a in Article.all">#{a.title}</li>
+    #   </ul>
+    # <?r end ?>
+    # ...
+
     def cache(name = nil, options = {}, &block)
       name = @action_name unless name  
       cache_fragment(block, "#{name}#{options}", options)
     end
 
+    # Internal method, prefer to use cache instead.
+    
     def cache_fragment(block, name, options = {})
       unless caching_enabled?
         block.call
@@ -59,13 +73,14 @@ module Caching
       end
     end
 
+    # Expire a cached fragment.
     #--
     # gmosx: If you modify the code here, don't forget to modify
     # the same method on the sweeper.
     #++
     
     def expire_fragment(name, options = {})
-      Fragments.store.delete(name, options)
+      Fragments.cache.delete(name, options)
     end
   end
   

data/lib/nitro/caching/output.rb

@@ -6,12 +6,20 @@ module Nitro
 
 module Caching
 
-  # Output caching.
+  # The Output caching subsystem stores whole pages in the 
+  # filesystem to be served directly be the front web server
+  # (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.
+  #--
+  # gmosx, FIXME: Don't create excessive directories, use better
+  # rewrite rules to handle xxx.html files.
+  #++
 
   module Output
 
     def self.included(base) # :nodoc: 
-      super
       base.extend(ClassMethods)
       base.module_eval do
         cattr_accessor :output_cache_root, 'public'

data/lib/nitro/cgi.rb

@@ -45,9 +45,13 @@ class Cgi
       out.print(Cgi.response_headers(context))
       
       if context.out.is_a?(IO)
-        while buf = context.out.read(4096)
-          out.write(buf)
-        end
+        begin
+          while buf = context.out.read(4096)
+            out.write(buf)
+          end
+  ensure
+          context.out.close
+  end
       else
         out.print(context.out)
       end

data/lib/nitro/cgi/stream.rb

@@ -27,10 +27,8 @@ module Render
       Thread.new do 
         begin
           yield
-        rescue Object => ex
-          p ex
         ensure
-          w.close
+    w.close
         end
       end
     end

data/lib/nitro/compiler.rb

@@ -1,5 +1,3 @@
-require 'nano/kernel/singleton'
-
 require 'glue/template'
 
 require 'nitro/compiler/elements'
@@ -215,14 +213,17 @@ class Compiler
           code << "params = [];"
         end
         code << %{
-          if context.query_string
-            context.query_string.split(/[&;]/).each_with_index do |qs, i|
+          unless context.query_string.blank?
+            all_params = context.query_string.split(/[&;]/)
+            is_hash = all_params.first.index('=')
+            all_params.each_with_index do |qs, i|
         }
         # Don't pass more parameters than the action's arity.
         if param_count > 0 
           code << "break unless i < #{param_count};"
         end
         code << %{
+            break if qs.index('=') and not is_hash
               params[i] = CGI.unescape(qs.split(/=/).last)
             end            
           end          

data/lib/nitro/compiler/errors.rb

@@ -1,4 +1,4 @@
-require 'mega/orm_support'
+require 'facet/ormsupport'
 
 module Nitro
 

data/lib/nitro/compiler/morphing.rb

@@ -1,8 +1,8 @@
 require 'rexml/document'
 require 'rexml/streamlistener'
 
-require 'mega/dictionary'
-require 'nano/string/blank'
+require 'facet/dictionary'
+require 'facet/string/blank'
 
 require 'glue/html'
 

data/lib/nitro/compiler/script.rb

@@ -1,4 +1,4 @@
-require 'nano/kernel/constant'
+require 'facet/kernel/constant'
 
 require 'nitro/helper/javascript'
 

data/lib/nitro/context.rb

@@ -1,4 +1,4 @@
-require 'nano/kernel/assign_with'
+require 'facet/kernel/assign_with'
 
 require 'nitro/cgi'
 require 'nitro/cgi/request'
@@ -55,7 +55,13 @@ class Context
   # end of the HTTP request handling code.
 
   def close
-    @session.sync if @session
+    if @session
+      # Ugly hack: need to use AOP instead
+      if @session.has_key?(:FLASH)
+        @session[:FLASH].clean
+      end
+      @session.sync 
+    end
   end
   alias_method :finish, :close
 

data/lib/nitro/controller.rb

@@ -1,4 +1,4 @@
-require 'mega/annotation'
+require 'facet/annotation'
 
 require 'glue/aspects'
 require 'glue/markup'

data/lib/nitro/dispatcher.rb

@@ -1,5 +1,3 @@
-require 'nano/kernel/singleton'
-
 require 'nitro/controller'
 require 'nitro/compiler'
 require 'nitro/routing'

data/lib/nitro/element.rb

@@ -1,8 +1,8 @@
-require 'nano/string/capitalized'
-require 'nano/string/camelize'
-require 'nano/string/underscore'
-require 'nano/dir/self/recurse'
-require 'mega/annotation'
+require 'facet/string/capitalized'
+require 'facet/string/camelize'
+require 'facet/string/underscore'
+require 'facet/dir/self/recurse'
+require 'facet/annotation'
 
 require 'glue/flexob'
 require 'glue/configuration'

data/lib/nitro/flash.rb

@@ -9,7 +9,7 @@ module Nitro
     def self.append_features(base)
       super      
       base.before 'flash.discard'
-      base.after 'flash.clean'
+      #base.after 'flash.clean'
     end
     
     # A Flash is a special hash object that lives in the session. 

data/lib/nitro/helper.rb

@@ -1,5 +1,5 @@
-require 'nano/kernel/constant'
-require 'nano/string/camelize'
+require 'facet/kernel/constant'
+require 'facet/string/camelize'
 
 require 'glue/attribute'
 

data/lib/nitro/helper/form.rb

@@ -1,4 +1,4 @@
-require 'nano/inflect'
+require 'facet/inflect'
 
 require 'nitro/helper/form/controls'
 

data/lib/nitro/helper/form/controls.rb

@@ -266,7 +266,8 @@ class HasManyControl < Control
   # to extend and customise the HasManyControl
   
   def all_items
-    rel.target_class.all
+    return @all_items unless @all_items.nil?
+    @all_items = rel.target_class.all
   end
   
   def selected_items

data/lib/nitro/helper/javascript.rb

@@ -1,4 +1,4 @@
-require 'nano/inflect'
+require 'facet/inflect'
 
 module Nitro
 

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

@@ -1,4 +1,4 @@
-require 'mega/dictionary'
+require 'facet/dictionary'
 
 require 'nitro/compiler/morphing'
 

data/lib/nitro/helper/layout.rb

@@ -1,4 +1,4 @@
-require 'nano/string/camelize'
+require 'facet/inflect'
 
 require 'nitro/element'
 

data/lib/nitro/helper/pager.rb

@@ -120,12 +120,16 @@ class Pager
     end
   end
   
+  # Is the pager empty, ie has one page only?
+  
   def empty?
-    return @items.empty?
+    return @page_count < 1
   end
   
+  # The items count.
+  
   def size
-    return @items.size()
+    return @total_count
   end
   
   # Returns the range of the current page.
@@ -271,7 +275,7 @@ private
       when Array
         items = items.dup
         pager = Pager.new(request, per_page, items.size, pager_key)
-        items = items.slice(pager.offset, pager.per_page)
+        items = items.slice(pager.offset, pager.per_page) || []
         return items, pager      
       
       when Og::Collection

data/lib/nitro/helper/rss.rb

@@ -1,7 +1,7 @@
 require 'cgi'
 require 'rss/0.9'
 
-require 'nano/string/first_char'
+require 'facet/string/first_char'
 
 require 'glue/markup'
 

data/lib/nitro/render.rb

@@ -2,7 +2,7 @@ require 'singleton'
 require 'sync'
 require 'stringio'
 
-require 'nano/string/blank'
+require 'facet/string/blank'
 
 require 'glue/attribute'
 require 'glue/settings'

data/lib/nitro/scaffolding.rb

@@ -56,8 +56,13 @@ module Scaffolding
       @plural = options[:plural_name]
       @suffix = options[:suffix]
       @compiler = Compiler.new(@controller)
+
       @base = options[:base] || options[:mount] || options[:at]
-      @base = @plural.dup if @base == true
+      if @base == true
+        @base = @plural.dup 
+      elsif @base == :ROOT
+        @base = nil
+      end            
       @base__ = "#{@base}__" if @base
     end
   
@@ -257,6 +262,16 @@ module Scaffolding
     # This method modifies both the controller and the
     # scaffolded Class. 
     #
+    #
+    # === Options
+    #
+    # * base/mount : mountpoint for the action, defines a
+    #   prefix for the scaffolded action.
+    #   If mount => true, the prefix is the plural of the 
+    #   scaffolded class name.
+    #   If mount => :ROOT or nil, the actions are mounted at the 
+    #   root of the controller.
+    #
     # === Example
     #
     # scaffold Article
@@ -278,6 +293,8 @@ module Scaffolding
     #--
     # This is the first phase of the scaffolding proccess,
     # scaffold targets are marked, and default options set.
+    #
+    # FIXME: Rethink the options, make :ROOT the default.
     #++
   
     def scaffold(klass, options = {})
@@ -301,7 +318,7 @@ module Scaffolding
     
     def compile_scaffolding_code
       # load scaffolding for all og classes if specified
-      
+
       if scaffold_all?
         options = scaffold_all_options
         Og.manager.manageable_classes.each do |klass|
@@ -320,8 +337,13 @@ module Scaffolding
     end
     
     #--
-    # set the options flag to trigger scaffolding of all classes in second phase
-    # use exclude to ignore classes.... scaffold_all :exclude => [Product, Category]
+    # set the options flag to trigger scaffolding of all classes 
+    # in second phase.
+    # use exclude to ignore classes:
+    # scaffold_all :exclude => [Product, Category]
+    #
+    # gmosx: I do NOT lke this, will remove this in a future 
+    # version.
     #++
     
     def scaffold_all(options = {})