nitro 0.31.0 → 0.40.0

data/lib/nitro/adapter/script.rb

@@ -12,7 +12,7 @@ class ScriptAdapter
   
   attr_accessor :response
   
-  def initialize server
+  def initialize(server)
     @server = server
   end
   
@@ -25,7 +25,7 @@ class ScriptAdapter
   # app.post 'users/login?name=gmosx;password=pass
   # app.post 'articles/view/1'
   
-  def handle uri, options = {}
+  def handle(uri, options = {})
     context = Context.new(@server)
     
     begin
@@ -52,14 +52,14 @@ class ScriptAdapter
   
   # Perform a programmatic http get request to the web app.
    
-  def get uri, options = {}
+  def get(uri, options = {})
     options[:method] = :get
     handle uri, options
   end
 
   # Perform a programmatic http post request to the web app.
    
-  def post uri, options = {}
+  def post(uri, options = {})
     options[:method] = :post
     handle uri, options
   end
@@ -67,5 +67,3 @@ class ScriptAdapter
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/nitro/adapter/webrick.rb

@@ -45,9 +45,16 @@ class Webrick
         ]
       )
       
-      enable_record_mode($record_session_filename) if $record_session_filename
-      enable_playback_mode($playback_session_filename) if $playback_session_filename
+      if $record_session_filename
+        require 'nitro/adapter/webrick/vcr'
+        VCR.record($record_session_filename)
+      end
       
+      if $playback_session_filename
+        require 'nitro/adapter/webrick/vcr'
+        VCR.playback($playback_session_filename)
+      end
+            
       @webrick = WEBrick::HTTPServer.new(webrick_options)
       
       trap('INT') { stop }
@@ -71,75 +78,6 @@ 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
 
 end
@@ -168,6 +106,8 @@ class WebrickAdapter < WEBrick::HTTPServlet::AbstractServlet
     @server = server
     @server.options[:HandlerTable] = { 'xhtml' => XhtmlFileHandler }
 
+    @handle_static_files = Server.handle_static_files
+
     # Handles static resources. Useful when running 
     # a stand-alone webrick server.
 
@@ -181,18 +121,28 @@ class WebrickAdapter < WEBrick::HTTPServlet::AbstractServlet
   # Handle a static file. Also handles cached pages.
 
   def handle_file(req, res)
-    begin
-      rewrite(req)
-      @file_handler.do_GET(req, res)
-      return true
-    rescue WEBrick::HTTPStatus::PartialContent, WEBrick::HTTPStatus::NotModified => err
-      res.set_error(err)
-      return true
-    rescue Object => ex
+    rewrite(req)
+
+    # gmosx, FIXME: this is a nasty hack that fixes a really
+    # *nasty* caching bug. Find a better solution. When hitting
+    # the backend server, if the index method takes parameters
+    # the dispatcher considers all static files as parameters.
+    # If you have output caching enabled for the index page, 
+    # all your static files get corrupted.
+    
+    if (@handle_static_files == false) and (req.path_info =~ /\.html$/)
       return false
-    ensure
-      unrewrite(req)
     end
+
+    @file_handler.do_GET(req, res)
+    return true
+  rescue WEBrick::HTTPStatus::PartialContent, WEBrick::HTTPStatus::NotModified => err
+    res.set_error(err)
+    return true
+  rescue Object => ex
+    return false
+  ensure
+    unrewrite(req)
   end
 
   # Handle the request.
@@ -243,7 +193,7 @@ class WebrickAdapter < WEBrick::HTTPServlet::AbstractServlet
     if req.path_info == '/'
       req.instance_variable_set(:@path_info, '/index.html') 
     elsif req.path_info =~ /^([^.]+)$/
-      req.instance_variable_set(:@path_info, "#{$1}/index.html") 
+      req.instance_variable_set(:@path_info, "#{$1}.html") 
     end
   end
 
@@ -252,14 +202,10 @@ class WebrickAdapter < WEBrick::HTTPServlet::AbstractServlet
   def unrewrite(req)
     if req.path_info == '/index.html'
       req.instance_variable_set(:@path_info, '/') 
-    elsif req.path_info =~ /^([^.]+)\/index.html$/    
+    elsif req.path_info =~ /^([^.]+)\.html$/    
       req.instance_variable_set(:@path_info, $1) 
     end
   end
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>
-# * Guillaume Pierronnet <guillaume.pierronnet@laposte.net>
-# * Bryan Soto <bryan.a.soto@gmail.com>

data/lib/nitro/adapter/webrick/vcr.rb

@@ -0,0 +1,85 @@
+require 'nitro/adapter/webrick'
+
+class Webrick
+
+# VCR functionality, typically used for proxy based regression
+# testing.
+
+class VCR
+
+  class << self
+  
+  # Enables session recording. The recorded data can be used 
+  # for automatic app testing by means of the playback mode.
+  
+  def record(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 playback(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
+  
+end
+
+end

data/lib/nitro/caching.rb

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

data/lib/nitro/caching/actions.rb

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

data/lib/nitro/caching/fragments.rb

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

data/lib/nitro/caching/output.rb

@@ -1,17 +1,25 @@
 require 'fileutils'
 
+require 'nitro/helper/url'
+
 module Nitro
 
 # Adds support for caching.
 
 module Caching
 
+  # The directory where cached pages are generated.
+  #--
+  # TODO: use Server.public_root as default.
+  #++
+  
   setting :output_cache_root, :default => 'public', :doc => 'The directory where cached pages are generated'
 
   # 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.
-  #
+  #    require 'nitro/helper/url'
+
   # Nitro promotes coding your application in such a way as to
   # allow for output caching to the greatest extend. Output 
   # caching *is your friend*.
@@ -22,6 +30,16 @@ module Caching
 
   module Output
 
+    # TODO: something more elegant here.
+    
+    class << self
+      # The collection of cached actions.
+    
+      attr_accessor :cached_actions    
+    end
+
+    Nitro::Caching::Output.cached_actions = [] 
+
     def self.included(base) # :nodoc: 
       base.extend(ClassMethods)
     end
@@ -40,6 +58,11 @@ module Caching
       def cache_output(*actions)
         return unless caching_enabled?
 
+        # keep track of cached actions.
+        for a in actions        
+          Nitro::Caching::Output.cached_actions << [self, a]
+        end
+        
         str = actions.collect { |a| ":#{a}" }.join(', ')
 
         module_eval %{
@@ -48,14 +71,22 @@ module Caching
       end
 
       private
-
+=begin
       def output_cache_path(path)
         filename = ((path.empty? || path == '/') ? 'index.html' : path.dup)
-#        filename.gsub!(/\/$/, '')
         filename << '/index.html' unless (filename.split('/').last || filename).include? '.'
-        return Caching.output_cache_root + '/' + filename
+        return File.join(Caching.output_cache_root, filename).squeeze('/')                     
+      end
+=end      
+      def output_cache_path(path)
+        if path.empty? or path == '/'
+          filename = 'index.html'
+        else
+          filename = "#{path}.html"
+        end
+        return File.join(Caching.output_cache_root, filename).squeeze('/')                     
       end
-      
+
     end
 
     private
@@ -70,19 +101,19 @@ module Caching
     # cache key. The cache key is typically the name of the
     # top level action responsible for generating the page.
     #--
-    # If you change this method, don't forget the CacheSweeper
+    # WARNING: If you change this method, don't forget the CacheSweeper
     # expire method.
+    # FIXME: make the above unneeded through refactoring.
     #++
 
     def expire_output(name)
-      begin
-        Logger.debug "Expirinig cache file '#{Server.public_root}/#{name}'" if $DBG
-        FileUtils.rm_rf("#{Server.public_root}/#{name}")
-      rescue Object => ex
-        # gmosx: is this the right thing to do?
-      end
+      filename = "#{Server.public_root}/#{name}".squeeze('/')
+      Logger.debug "Expiring cache file '#{filename}'" if $DBG
+      FileUtils.rm_rf(filename)
+    rescue Object => ex
+      # ignore any error.
     end
-    alias_method :delete_output, :expire_output
+    alias delete_output expire_output
     
     # Is caching allowed for this action (page)? The default
     # implementation does not cache post request or request 
@@ -91,7 +122,7 @@ module Caching
     # for 'nice' urls.
     
     def caching_allowed?
-      not (@request.post? or @request.uri =~ /\?/)
+      not (request.post? or request.uri =~ /\?/)
     end
 
   end
@@ -99,5 +130,3 @@ module Caching
 end
 
 end
-
-# * George Moschovitis  <gm@navel.gr>

data/lib/nitro/caching/proxy.rb

@@ -0,0 +1,49 @@
+require 'nitro/helper/url'
+require 'nitro/caching/output'
+
+module Nitro
+
+module Caching
+
+# A proxy to the caching system. This is typically used from the
+# console.
+#--
+# gmosx: If anyone can suggest a better name, please speak up!
+#++
+
+class Proxy
+  extend URLHelper
+  extend Output
+  
+  class << self
+  
+    def cleanup_output
+      dirs = {}
+      
+      for ctrl, a in Nitro::Caching::Output.cached_actions 
+        file = encode_url(ctrl, a)
+        
+        file << 'index' if file == '/'
+
+        unless dirs[file]
+          puts "Expiring cache directory '#{file}'"
+          expire_output(file)
+          dirs[file] = true
+        end
+
+        file << '.html'
+        puts "Expiring cache file '#{file}'"
+        expire_output(file)
+      end
+   
+      return true
+    end
+    alias cleanup cleanup_output
+  
+  end
+
+end
+
+end
+
+end