nitro 0.29.0 → 0.30.0

data/README

@@ -1,4 +1,4 @@
-= Nitro 0.29.0 README
+= Nitro 0.30.0 README
 
 Nitro provides everything you need to develop professional Web
 applications using Ruby and Javascript. 
@@ -325,14 +325,14 @@ doc/RELEASES
 
 The latest version of Nitro can be found at
 
-* http://www.nitrohq.com
+* http://www.nitroproject.org
 
 
 == Documentation
 
 Documentation for Nitro can be found at
 
-* http://www.nitrohq.com
+* http://www.nitroproject.org
 
 Don't forget to read the file doc/RELEASES for usefull
 documentation bits. Also, have a look at the test cases in
@@ -344,7 +344,7 @@ the test directory for examples of usage.
 A number of videos  that demonstrate Nitro in practical usage
 are available here:
 
-http://www.nitrohq.com/view/Videos
+http://www.nitroproject.org/view/Videos
 
 
 == Requirements
@@ -549,7 +549,7 @@ http://rubyforge.org/mailman/listinfo/nitro-general
 Copyright (c) 2004-2006, George 'gmosx' Moschovitis (http://www.gmosx.com)
 Copyright (c) 2004-2006, Navel Ltd (http://www.navel.gr)
 
-Nitro (http://www.nitrohq.com) is copyrighted free software 
+Nitro (http://www.nitroproject.org) is copyrighted free software 
 created and maintained by George Moschovitis (mailto:gm@navel.gr)
 and released under the standard BSD Licence. For details consult
 the file LICENCE.

data/doc/AUTHORS

@@ -50,6 +50,12 @@ IDEAS, ADDITIONAL CODING, SUPPORT:
 * TRANS <transfire@gmail.com>
   Small bug fixes, patches.
 
+* Kashia Buch <kashia@vfemail.net>
+  Patches, documentation.
+  
+* Massimo Maria Ghisalberti 
+  Patches.
+
 * Dan Yoder <dan@zeraweb.com>
   Original 'Elements' implementation, bug reports.
     

data/doc/RELEASES

@@ -1,3 +1,160 @@
+== Version 0.30.0
+
+Another pragmatic release. The Nitro development team worked over
+the submitted tickets and provided many bug fixes. More over, there
+are many small improvements along the codebase and as always
+we could not resist adding some cool new features. 
+
+Special thanks fly to Bryan Sotto for making this release
+possible!
+
+Most notable chages:
+
+* Nitro allows fine grained customization of the compiler 
+  tranformation pipeline per controller or even per action. 
+  Here come some examples:
+  
+  class MyController
+    ann :self, :transformation_pipeline => [MyTransformer, AnotherXForm]
+
+    ... 
+
+    def my_action
+      ...
+    end
+    ann :my_action, :transformation_pipeline => Compiler.transformation_pipeline.dup.shift(CustomXForm)
+   
+    ...
+  end
+  
+* Nitro automates integration testing by means of the new
+  session VCR feature that allows for easy proxy based 
+  functional testing. A typicall session goes like this:
+  
+  Start your app with:
+  
+  ruby run.rb --record myfile
+  
+  Then use your web browser to 'perform' your testing session.
+  You can used multiple browsers, concurrent users and hit all 
+  the pages in your app. At the end, just stop the server.
+  
+  In order to perform regression testing against this recorded
+  session just restart the server in playback mode:
+  
+  ruby run.rb --playback myfile
+  
+  Nitro automatically plays back the recorded session and logs
+  any errors or Exceptions.
+
+* Better Global variable implementation works better with
+  distributed stores (Drb, Memcached). Notice the new
+  Global.init and Global[:key].update { |v| } methods.  
+
+* Improved the Router implementation. One notable addition
+  is support for global router initialization:
+  
+  Router.rules = [
+    { :match => /~(.*)/, :controller => IdController, :action => :view, :params => [:name] }
+  ]
+
+* Cleaned up glue by removing files duplicating functionality
+  allready available in Facets. Moreover, we moved several 
+  generally useful files and methods from Glue to Facets.
+  
+* Replaced the old RSSHelper with the new FeedHelper. The new
+  implementation provides support for RSS, Atom, OPML. The
+  FeedHelper is backwards compatible with the old helper but
+  provides even more features. 
+  
+  class MyController
+    helper :feed
+  end
+  
+* Added Og query by example support. Query the database for an 
+  entity that matches the example. The example is a hash 
+  populated with the property values to search for.
+
+  The provided property values are joined with AND to build
+  the actual query.
+
+  Article.query_by_example :title => 'IBM%', :hits => 2
+  Article.find_with_properties :title => 'IBM%', :hits => 2
+
+* Added type casting support for Og aggregations and
+  calculations.
+  
+* Greatly improved the configuration system. One noteable 
+  (and extremely useful) new feature is that you can now 
+  customize classes before they are even defined:
+  
+  
+  Configuration.User.crypt_salt = 'HELLO'
+  require 'users'
+  
+  in users.rb:
+  
+  class User
+    setting :crypt_salt, :default => 'DF', :doc => 'The crypt salt'
+  end
+
+* Calculate rendering level in actions to allow for conditional
+  rendering in top level actions or sub-actions. Some helpers
+  are also provided:      
+  
+  def myaction
+    if request.is_top_level?
+      ...
+    end
+  end
+
+* Introduced an alternative more sophisticated (yet intuitive) 
+  form builder. While this new helper is still under construction,
+  it is already very useful. Here come some examples:
+
+  <!-- entity backed form -->
+    
+  <div id="myform">
+  #{form :object => @owner, :action => :save_profile do |f|
+    f.property :name, :editable => false
+    f.property :password
+    f.br
+    f.submit 'Update'
+  end}
+  </div>
+
+  <!-- form with virtual method (:multipart),
+       special controls (:select_file) -->
+  
+  <div id="myform">
+  #{form :method => :multipart do |f|
+    f.p {
+      f.label 'Select the new icon filename'
+      f.select_file :file, :label => 'Select icon'
+    }
+    f.p {
+      f.submit 'Change'
+    }
+  end}
+  </div>
+
+* More flexible Script generator, the developer can use most of 
+  its features without a Client subclass.
+  
+* Reimplemented session garbage collection.
+
+* Added many more RDoc comments to the source code.
+  
+* Many, many bug fixes.
+
+* Updated to latest Facets, Scriptaculous, Prototype.
+
+
+Please note that the project home page has been moved to:
+
+http://www.nitroproject.org
+
+
 == Version 0.29.0
 
 A bold step towards maturity. Great care was taken to 
@@ -1098,7 +1255,7 @@ Another superb release! State of the art AJAX/Javascript support,
 Wee components / programmatic renderer integration, a beginners
 tutorial, self documenting configuration and many important bug 
 fixes. Don't forget to check out our new community site at
-http://www.nitrohq.com
+http://www.nitroproject.org
 
 Some notable changes:
 
@@ -1297,7 +1454,7 @@ Some notable changes:
 
 * This is surely the most request feature: Nitro Step by Step
   by James Britt, a beginers guide to Nitro. Available in the
-  brand-new, Nitro-powered, www.nitrohq.com Community wiki.
+  brand-new, Nitro-powered, www.nitroproject.org Community wiki.
 
 * New examples: The totaly recoded and ultra cool ajax example,
   a Wee/Nitro example and the new Hello world example.

data/lib/glue/sweeper.rb

@@ -1,4 +1,4 @@
-require 'glue/aspects'
+require 'facets/more/aspects'
 
 module Glue
 
@@ -12,7 +12,7 @@ module Glue
 #++
 
 module Sweeper
-  include Glue::Aspects
+  include ::Aspects
   
   before "sweep_affected(:insert)", :on => :og_insert
   before "sweep_affected(:update)", :on => :og_update

data/lib/glue/webfile.rb

@@ -5,6 +5,20 @@ require 'facet/inheritor'
 module Glue
 
 # A Web File.
+#
+# You can customize the path where the uploaded file will be 
+# by defining a webfile_path class method *before* the property:
+#
+# class Icon
+#   def self.webfile_path request, name
+#     File.join(Uploads.public_root, request.user.name, 'icon.png')
+#   end      
+#
+#   property :file, WebFile, :magick => { :small => '64x64', :medium => '96x96' }    
+# end
+#--
+# TODO: webfile_path customization sucks, should be improved!
+#++
 
 class WebFile
 
@@ -65,7 +79,6 @@ class WebFile
         def #{name}_from_request(request)
           param = request['#{name}']
       }
-      
       if base.respond_to? :webfile_path
         code << %{
           path = #{base}.webfile_path(request, '#{name}')

data/lib/nitro.rb

@@ -1,9 +1,9 @@
 # = Nitro 
 #
-# Copyright (c) 2004-2005, Navel Ltd (http://www.navel.gr)
-# Copyright (c) 2004-2005, George Moschovitis (http://www.gmosx.com)
+# Copyright (c) 2004-2006, George Moschovitis (http://www.gmosx.com)
+# Copyright (c) 2004-2006, Navel Ltd (http://www.navel.gr)
 #
-# Nitro (http://www.nitrohq.com) is copyrighted free software 
+# Nitro (http://www.nitroproject.org) is copyrighted free software 
 # created and maintained by George Moschovitis (mailto:gm@navel.gr) 
 # and released under the standard BSD Licence. For details 
 # consult the file doc/LICENCE.
@@ -16,7 +16,7 @@ module Nitro
   
   # The version.
 
-  Version = '0.29.0'
+  Version = '0.30.0'
 
   # Library path.
 
@@ -39,6 +39,7 @@ end
 # gmosx: leave them here.
 #++
 
+require 'nitro/global'
 require 'nitro/context'
 require 'nitro/controller'
 require 'nitro/dispatcher'
@@ -95,11 +96,7 @@ module Nitro
         
   end
 
-  # Cache for application scoped (global) variables. This is a 
-  # temporal store, will be moved to the actuall cache in 
-  # Server.start
-  
-  $global = $application = {}
+  $global = $application = Global
   
 end
 

data/lib/nitro/adapter/mongrel.rb

@@ -138,59 +138,53 @@ class MongrelAdapter < ::Mongrel::HttpHandler
     unless handle_file(req, res)
       path = req.path_info
 
-      unless path =~ /\./
-        begin
-          context = Context.new(@server)
+      begin
+        context = Context.new(@server)
 
-          context.in = StringIO.new(req.body || "")
+        context.in = StringIO.new(req.body || "")
 
-          context.headers = {}
-          req.params.each { |h, v|
-            if h =~ /\AHTTP_(.*)\Z/
+        context.headers = {}
+        req.params.each { |h, v|
+          if h =~ /\AHTTP_(.*)\Z/
                 context.headers[$1.gsub("_", "-")] = v
             end
             context.headers[h] = v
-          }
-          # context.headers.update(req.meta_vars)
+        }
+        # context.headers.update(req.meta_vars)
 
-          context.headers['REQUEST_URI'] = context.headers['SCRIPT_NAME']
+        context.headers['REQUEST_URI'] = context.headers['SCRIPT_NAME']
           
-          if context.headers['PATH_INFO'].blank?
-            context.headers['REQUEST_URI'] = '/'
-          else
-            context.headers['REQUEST_URI'] = '/' + context.headers['PATH_INFO']          
-          end
+        if context.headers['PATH_INFO'].blank?
+          context.headers['REQUEST_URI'] = '/'
+        else
+          context.headers['REQUEST_URI'] = '/' + context.headers['PATH_INFO']          
+        end
 
-          # gmosx: make compatible with fastcgi.
-          #context.headers['REQUEST_URI'].slice!(/http:\/\/(.*?)\//)
-          # context.headers['REQUEST_URI'] << '/'
+        # gmosx: make compatible with fastcgi.
 
-          Cgi.parse_params(context)
-          Cgi.parse_cookies(context)
+        context.headers['REQUEST_URI'].slice!(/http:\/\/(.*?)\//)
+        context.headers['REQUEST_URI'] = '/' + context.headers['REQUEST_URI']
 
-          context.render(path)
-          
-          res.socket << "HTTP/1.1 #{context.status.to_s} "
-          
-          if STATUS_CODES.has_key? context.status
-            res.socket << STATUS_CODES[context.status]
-          else
-            res.socket << "Unknown Status Code"
-          end
-          res.socket << "\r\n"
-
-          headers = context.response_headers
-          headers["Content-length"] = context.out.size
-          headers.each { |h,v| res.socket << "#{h}: #{v}\r\n" }
-          res.socket << "\r\n"
-
-          # TODO handle setting cookies
-          res.socket << context.out
-          
-          context.close
-        ensure
-          Og.manager.put_store if defined?(Og) and Og.respond_to?(:manager)
+        Cgi.parse_params(context)
+        Cgi.parse_cookies(context)
+
+        context.render(path)
+  
+        res.socket << "HTTP/1.1 #{context.status.to_s} "
+  
+        if STATUS_CODES.has_key? context.status
+          res.socket << STATUS_CODES[context.status]
+        else
+          res.socket << "Unknown Status Code"
         end
+        res.socket << "\r\n"
+
+        res.socket << Cgi.response_headers(context)
+        res.socket << context.out
+ 
+        context.close
+      ensure
+        Og.manager.put_store if defined?(Og) and Og.respond_to?(:manager) and Og.manager
       end
     end
   end
@@ -218,4 +212,3 @@ end
 
 # * Joshua Hoke
 # * George Moschovitis <gm@navel.gr>
-

data/lib/nitro/adapter/scgi.rb

@@ -168,7 +168,7 @@ module SCGI # :nodoc: all
         Nitro::Cgi.process(@server, cgi, cgi.stdinput, cgi.stdoutput)
     #end
       ensure
-        Og.manager.put_store if defined?(Og) and Og.respond_to?(:manager)
+        Og.manager.put_store if defined?(Og) and Og.respond_to?(:manager) and Og.manager
       end
   end
     

data/lib/nitro/adapter/webrick.rb

@@ -32,6 +32,7 @@ class Webrick
       end
 
      webrick_options = server.options.dup
+     
      require 'webrick/https' if webrick_options[:SSLEnable]
 
      webrick_options.update(
@@ -43,6 +44,10 @@ class Webrick
           [wblog, WEBrick::AccessLog::REFERER_LOG_FORMAT]
         ]
       )
+      
+      enable_record_mode($record_session_filename) if $record_session_filename
+      enable_playback_mode($playback_session_filename) if $playback_session_filename
+      
       @webrick = WEBrick::HTTPServer.new(webrick_options)
       
       trap('INT') { stop }
@@ -65,6 +70,75 @@ class Webrick
     
     def initialize_webrick(server)
     end
+
+    # Enables session recording. The recorded data can be used 
+    # for automatic app testing by means of the playback mode.
+    
+    def enable_record_mode(filename = 'session.yaml')
+      Logger.info "Recording application server session to '#{filename}'."
+      
+      require 'facets/core/file/self/create'
+
+      $record_session = []
+      $last_record_time = Time.now
+
+      Nitro::WebrickAdapter.class_eval %{   
+        def do_GET(req, res)
+          record_context(req, res)
+          handle(req, res)
+        end
+        alias_method :do_POST, :do_GET
+
+        def record_context(req, res)
+          delta = Time.now - $last_record_time
+          $last_record_time = Time.now
+          $record_session << [delta, req, res]
+        end          
+      }
+
+      at_exit do
+        File.create(filename, YAML.dump($record_session))
+      end
+    end
+    
+    # Playback a recorded session. Typically used for testing.
+    
+    def enable_playback_mode(filename = 'session.yaml')
+      Logger.info "Playing back application server session from '#{filename}'."
+      
+      $playback_session = YAML.load_file(filename)
+      $playback_exception_count = 0
+          
+      WEBrick::HTTPServer.class_eval %{
+        def start(&block)
+          run(nil)
+        end
+        
+        def run(sock)
+          while true
+            delta, req, res = $playback_session.shift
+            
+            if delta
+              sleep(delta)
+              begin
+                service(req, res)
+              rescue Object => ex
+                $playback_exception_count += 1
+                p '---', ex                
+              end
+            else
+              return
+            end
+          end
+        end
+      }
+      
+      at_exit do
+        puts "\n\n"
+        puts "Playback raised #$playback_exception_count exceptions.\n"
+        puts "\n"
+      end
+    end
     
   end
 
@@ -127,39 +201,37 @@ class WebrickAdapter < WEBrick::HTTPServlet::AbstractServlet
     unless handle_file(req, res)
       path = req.request_uri.path
 
-      unless path =~ /\./
-        begin
-          path = req.request_uri.path
+      begin
+        path = req.request_uri.path
 
-          context = Context.new(@server)
+        context = Context.new(@server)
 
-          context.in = StringIO.new(req.body || "")
+        context.in = StringIO.new(req.body || "")
 
-          context.headers = {}
-          req.header.each { |h, v| context.headers[h.upcase] = v.first }
-          context.headers.update(req.meta_vars)
+        context.headers = {}
+        req.header.each { |h, v| context.headers[h.upcase] = v.first }
+        context.headers.update(req.meta_vars)
 
-          # gmosx: make compatible with fastcgi.
+        # gmosx: make compatible with fastcgi.
           
-          context.headers['REQUEST_URI'].slice!(/http:\/\/(.*?)\//)
-          context.headers['REQUEST_URI'] = '/' + context.headers['REQUEST_URI']
+        context.headers['REQUEST_URI'].slice!(/http:\/\/(.*?)\//)
+        context.headers['REQUEST_URI'] = '/' + context.headers['REQUEST_URI']
 
-          Cgi.parse_params(context)
-          Cgi.parse_cookies(context)
+        Cgi.parse_params(context)
+        Cgi.parse_cookies(context)
 
-          context.render(path)
+        context.render(path)
           
-          res.status = context.status
-          res.instance_variable_set(:@header, context.response_headers || {})
-          res.instance_variable_set(:@cookies, context.response_cookies || {})
-          res.body = context.out
-          res.chunked = true if context.out.is_a?(IO) and context["SERVER_PROTOCOL"] == "HTTP/1.1"
+        res.status = context.status
+        res.instance_variable_set(:@header, context.response_headers || {})
+        res.instance_variable_set(:@cookies, context.response_cookies || {})
+        res.body = context.out
+        res.chunked = true if context.out.is_a?(IO) and context["SERVER_PROTOCOL"] == "HTTP/1.1"
           
-          context.close
-        ensure
-         $autoreload_dirty = false
-         Og.manager.put_store if defined?(Og) and Og.respond_to?(:manager)
-        end
+        context.close
+      ensure
+       $autoreload_dirty = false
+       Og.manager.put_store if defined?(Og) and Og.respond_to?(:manager) and Og.manager
       end
     end
   end