cuca 0.03 → 0.04

data/CHANGELOG

@@ -0,0 +1,39 @@
+
+* xxxx/xx/xx - 0.04
+   - Fixed error-message displaying traceback but not the actual exception
+   - Display trace if enabled on 'stop :error' events
+   - Option for autoloading support files (instead of bulk 'require')
+   - Fixed bug where session didn't close (saved to disk) if 'stop' was raised (fastcgi)
+   - 'url', 'base_path and 'path_tree' property added into urlmap class
+   - Priority option on filters.
+   - Mount option for external directories on application path
+   - Cleanup app.rb, removed some global variables
+   - get/post parameters are automaticaly visible within the session page container
+   - Added some unit tests
+   - Minor fixes in stdlib
+   - Some fixes in dispatchers
+   - 
+
+
+* 2008/05/18 - 0.03
+   - Fixed uncaught possible routing error exception
+   - Splitted load configuration to conf/config.rb and conf/environment.rb
+   - Allow setting the mime-type and http return status per controller action
+   - Added http 404 and 500 customizable error messages
+   - Option to switch off error tracebacks displayed in browser
+   - 'base_url' property added into the urlmap class
+   - Added 'layout' instance method within controller to overwrite 
+     or disable default layout for current action
+   - fixed bug on fastcgi where the 'stop' method could remove the layout 
+     definition from controller class
+   - Minor changes/fixes in application skeleton
+
+* 2008/05/11 - 0.02
+   - Fixed bug in erb/view generator ("can't find view path")
+   - stdlib/listwidget:
+         - Fixed table joins not displaying content (dblist)
+         - Dynamic column sorting in both directions (ASC/DESC)
+   - Fixed session bug when using fastcgi
+   - minor documentation and stdlib improvements 
+
+* 2008/05/08 - 0.01 - Initial Release

data/application_skeleton/conf/config.rb

@@ -2,7 +2,7 @@
 # Use this file to set initial cuca framework and application configuration 
 # values - Only!
 #
-# You should NOT use this to load additional libraries or to modify cuca classes. Use
+# You should not use this to load additional libraries or to modify cuca classes. Use
 # conf/environment.rb instead.
 #
 # The cuca framework itself isn't fully loaded at this point.
@@ -18,10 +18,20 @@ Cuca::App.configure do |config|
   ### future use?
   config.log_level     = 3
 
-  ### files within these directories will be automatically 'required' before
-  ### your controller script get loaded.
+  ### Files within these directories will be automatically 'required' before
+  ### your controller script get loaded. Cuca will look for these directories
+  ### relatively to your action script. It will also require all these directories
+  ### in lower levels of your directory layout.
   config.include_directories = %w{_controllers _layouts _models _widgets}
 
+  ### This would be an autoload configuration
+  # config.include_directories = [
+  #    { :dir => '_controllers', :class_naming = Proc.new { |f| f.capitalize+'Controller' } },
+  #    { :dir => '_widgets',     :class_naming = Proc.new { |f| f.capitalize+'Widget' } },
+  #    { :dir => '_layouts',     :class_naming = Proc.new { |f| f.capitalize+'Layout' } }
+  #    { :dir => '_models',      :class_naming = Proc.new { |f| f.capitalize } }
+  #  ]
+
   ### For pretty url mapping
   # config.magic_action_prefix = '__default_'
   
@@ -38,12 +48,21 @@ Cuca::App.configure do |config|
   # config.http_500 = '500.html'
   
   ### display_errors: Instead of showing a http-500 page this will display an application
-  ### trace (similar to php display-errors) on an error event. Switch that off in
-  # production systems.
+  ### trace (similar to php display-errors) on an error event. Switch that off once in
+  ### production.
   # config.display_errors = true
 
   ### Default mime type to be sent within the http header unless specified by the 
   ### Controller
   # config.default_mime_type = 'text/html'
 
+  ### Mount external Directories to the application path. This only works with
+  ### directories and have higher priority than local files.
+  ### Example:
+  # config.mount = { '/customer/special => "#{$cuca_path}/plugins/special",
+  #                  '/systeminfo/'     => "/usr/cuca/static/sysinfo/" }
+  
+  ### 'expires' http header for static content (only if served by the dispatcher), in seconds
+  # config.http_static_content_expires = 300
+
 end

data/application_skeleton/public/dispatch.cgi

@@ -1,31 +1,18 @@
 #!/usr/bin/ruby
 
-# Set this Environment variable to load the cuca framework from a specific
-# Path. If not set it will try via rubygems.
-
-FRAMEWORK_PATH = ENV['CUCA_FRAMEWORK_PATH']
-
 $cuca_path = File.dirname(__FILE__)+"/../"
 
-if (FRAMEWORK_PATH) then
- $: << FRAMEWORK_PATH
- require 'cuca'
- require 'rubygems'
-else
- require 'rubygems'
- require 'cuca'
-end
+require 'rubygems'
+require 'cuca'
 
 Signal.trap("INT") do
   $stderr.puts "INT caught"
   exit
 end
 
-
 start = (Time.now.to_f * 1000).to_i
 application = Cuca::App.new
 application.cgicall
 stop = (Time.now.to_f * 1000).to_i
 dur_msec = stop - start
 application.logger.info("App::cgicall: #{dur_msec} msec [= #{(1000 / dur_msec).to_i} pages / second]")
-

data/application_skeleton/public/dispatch.fcgi

@@ -1,18 +1,10 @@
 #!/usr/bin/ruby
 
 
-FRAMEWORK_PATH = ENV['CUCA_FRAMEWORK_PATH']
-
 $cuca_path = File.dirname(__FILE__)+"/../"
 
-if (FRAMEWORK_PATH) then
- $: << FRAMEWORK_PATH
- require 'cuca'
- require 'rubygems'
-else
- require 'rubygems'
- require 'cuca'
-end
+require 'rubygems'
+require 'cuca'
 
 require "fcgi"
 
@@ -21,16 +13,13 @@ Signal.trap("INT") do
   exit
 end
 
-$cuca_path = File.dirname(__FILE__)+"/../"
-
+application = Cuca::App.new
 
 FCGI.each_cgi do |cgi|
   CGI::fix_env(cgi.env_table)
   start = (Time.now.to_f * 1000).to_i
-  application = Cuca::App.new(cgi)
-  application.cgicall
+  application.cgicall(cgi)
   stop = (Time.now.to_f * 1000).to_i
   dur_msec = stop - start
   application.logger.info("App::cgicall (#{cgi.path_info}: #{dur_msec} msec [= #{(1000 / dur_msec).to_i} pages / second]")  
 end
-

data/lib/cuca.rb

@@ -1,4 +1,4 @@
-# == Cuca - a widget-based web framework
+# == Cuca - a ruby web framework
 #
 # Cuca is a small web development framework mainly designed to build
 # applications - there is little focus on design but more on coding
@@ -71,5 +71,9 @@ begin
  require $cuca_path+'/conf/environment'
 rescue LoadError => e
  $stderr.puts "WARN: Error loading conf/environment: #{e}"
+rescue => e
+ e.backtrace.each do |b|
+    $stderr.puts"    #{b}\n"
+ end
 end
 

data/lib/cuca/app.rb

@@ -1,13 +1,21 @@
 require 'logger'
+require 'cuca/config'
+
+
+def cuca_register_autoload(object, file)
+ autoload(object, file)
+end
  
 
 module Cuca
 
+module Objects
+end
+
 # Sandbox is used internally run the action script defined by the controller
 # In future this can be extended to implement some security features etc..
 class Sandbox
 
-
  def self.run(controller_class_name, mod, assigns, request_method, subcall)
    self.class.send(:include, mod)
    controller_class = mod::const_get(controller_class_name)
@@ -16,7 +24,7 @@ class Sandbox
 
 
    controller.send('_do'.intern, 'run', subcall)
-   case $cgi.request_method
+   case request_method
        when 'POST' 
             controller.send('_do'.intern, 'post', subcall)
        when 'GET' 
@@ -36,55 +44,12 @@ end
 # Normally you just create a Cuca::App object and run the cgicall function with optional with 
 # a cgi object as paramenter. 
 # Before doing that you must set $cuca_path to the root of your appication structure.
-
 class App
 
- # == Configure the application
- # App::Config is normally called from conf/environment.rb . The attributes below the framework
- # will make use of, but you can always define own ones.
- #
- # == Example
- #
- #  Cuca::App.configure do |conf|
- #      conf.include_directories = %{_widgets _special_widgets}
- #      conf.database            = 'mydb'		# application specific
- #  end
- # === Attributes:
- #
- # * include_directories
- #  An array of directories that will be automatically included if you call an action.
- #  If one of the directories is found in the path where the action file is located it will require
- #  all files found. (default: %w{_controllers _widgets _layouts} )
- # * log_level - default 3
- # * magic_prefix - default: '__default_' (see Cuca::Controller)
- class Config < Hash
-   def method_missing(m, *params)
-       met = m.id2name
-       raise NoMethodError if met[met.size-1].chr != '='
-       self[met[0..met.size-2]] = params[0]
-   end
-   
-   # some default stuff
-   def initialize
-     self['include_directories'] = %w{_controllers _widgets _layouts}
-     self['log_level']  = 3
-     self['magic_prefix'] = '__default_'
-     self['session_key'] = 'cuca_session'
-     self['session_prefix'] = 'cuca.'
-     self['session_valid'] = 3600*24
-     self['view_directory'] = 'app/_views'	# where to find views for the view/erb generator
-     self['http_404'] = '404.html'
-     self['http_500'] = '500.html'
-     self['default_mime_type'] = 'text/html'
-     self['display_errors'] = true
-   end
-   
- end
 
- attr_reader :conf, :cgi, :logger, :urlmap
+ attr_reader :app_path, :log_path, :public_path, :urlmap, :cgi, :logger
 
- @@app_config = Config.new
- @@oncall = []
+ @@app_config = Cuca::Config.new
 
  ## Application configuration
  public
@@ -96,98 +61,32 @@ class App
    @@app_config
  end
 
- # if you should need to get notified on every
- # (cgi)-call you can register a proc here.
- # The SessionFlash/Page is makeing use of this
- def self.oncall(&block)
-   @@oncall << block
- end
-
- 
- # cgi implementation test
  private
- def cgidump(cgi)
-   s = ""
-   s << "-----ENV------<br>"
-   cgi.env_table.each_pair { |k,v| s << "#{k} => #{v}<br>" }
-   s << "--------------<br>"
-   s << "Server Software: #{cgi.server_software}<br>"
-   s << "PATH INFO: #{cgi.path_info}<br>"      
+ def init_app
+   @app_path    = $cuca_path + "/app"
+   @public_path = $cuca_path + "/public"
+   @log_path    = $cuca_path + "/log"
+   @app_path.freeze
+   @public_path.freeze
+   @log_path.freeze
+   @logger      = Logger.new("#{@log_path}/messages")
  end
 
- # Creates the @conf global variable - internal config
+
+ # Initializes settings to run the appliction
  #
- # APP_PATH = Path the the /app folder
- # CGI = CGI object
- # DEF_EXT = Default script extensions (.rb)
- # DEF_ACTION = (like 'index')
- # SCRIPT = Full path to the ruby script dealing with ACTION
- # ACTION = Action called (=links to SCRIPT, eg 'show' or 'index')
- # PATH_INFO = raw path info as from cgi 
- # PATH_TREE = array of path, without action
+ # @xxx_path - path to /app directory
  private
- def mk_config
-   @conf = {}
- 
- # To have a look at ENV and cgi uncomment this
-#   @cgi.out { cgidump(@cgi) }
-#   raise "Debug stop"
- 
-
-   # APP_PATH = Path the the /app folder
-#   @conf['APP_PATH'] = File.expand_path(File.dirname(__FILE__)+"/../app")
-   @conf['APP_PATH'] = $cuca_path + "/app"
-   
-   # PUBLIC_PATH = Path to the /public folder
-#   @conf['PUBLIC_PATH'] = File.expand_path(File.dirname(__FILE__)+"/../public")
-    @conf['PUBLIC_PATH'] = $cuca_path + "/public"
-   
-   # LOG_PATH = Path to logging directory
-#   @conf['LOG_PATH'] = File.expand_path(File.dirname(__FILE__)+"/../log")
-   @conf['LOG_PATH'] = $cuca_path + "/log"
-  
-   # CGI = CGI object
-   @conf['CGI'] = @cgi
-   
-   # DEF_EXT = Default script extensions
-   @conf['DEF_EXT'] = ".rb"
-   
-   @conf['DEF_ACTION'] = 'index'
-
-   # Cookie name
-   @conf['COOKIE_NAME'] = 'cucahap'
-      
-   # ACTION = Action called (=links to SCRIPT), eg 'index'
-   @conf['ACTION'] =  @cgi.path_info.reverse[0].chr == '/' ? @conf['DEF_ACTION'] : @cgi.path_info.split('/').last.downcase
-    
-   # PATH_INFO = raw path info as from cgi
-   @conf['PATH_INFO'] = @cgi.path_info
-   
-   # PATH_TREE = path info as array - without action
-#   @conf['PATH_TREE'] = [''].concat(@conf['PATH_INFO'].split('/').collect { |e| (e==@conf['ACTION'] || e == '') ? nil : e }.compact)
-
-   
+ def init_call(path_info)
    require 'cuca/urlmap'
    
    begin
-     mapping = URLMap.new(File.expand_path(@conf['APP_PATH']), @conf['PATH_INFO'])
-     @conf['SUBCALL'] = mapping.subcall
-     @conf['SCRIPT']  = mapping.script
-     @conf['ASSIGNS'] = mapping.assigns
-     @conf['ACTION']  = mapping.action
-     @urlmap = mapping
+     @urlmap = URLMap.new(@app_path, path_info)
 
      rescue RoutingError => r # no script found - maybe serve a static file?
-      @conf['SCRIPT'] = nil
+      @urlmap = nil	# == no script found
       return
    end
-   
-   # get the PATH_TREE for file inclusion!
-
-   c_ap = File.expand_path(@conf['APP_PATH'])
-   pt = @conf['SCRIPT'][c_ap.size..-1]
-   ac_script = @conf['SCRIPT'].split('/').last
-   @conf['PATH_TREE'] = [''].concat(pt.split('/').collect { |e| (e==ac_script || e == '') ? nil : e }.compact)
  end
  
  # will do a 'require' on all .rb files in path
@@ -201,47 +100,63 @@ class App
    end
    Dir.chdir(pwd)
  end
- 
- 
- 
- public
- def initialize(cgi = nil)
-   
-   $cgi = cgi || CGI.new
-   @cgi = $cgi
 
-   mk_config
+ # this will schedule all files for autoloading
+ private
+ def autoload_files(path, naming_proc)
+   $app.logger.info "Autoload on #{path}"
+   return unless File.exist?(path)
+   pwd = Dir.pwd
+   Dir.chdir(path)
+   Dir['*.rb'].each do |f|
+        fn = f.scan(/(.*)\.rb/)[0][0]
+        classname = naming_proc.call(fn)
+        $app.logger.info "Scheduling Autoload Object '#{classname}' ==> #{path}/#{f}"
+        cuca_register_autoload(classname.intern, "#{path}/#{f}")
+   end
+   Dir.chdir(pwd)
+ end
 
-   @logger = Logger.new(@conf['LOG_PATH'] + "/messages")
-   $logger = @logger
-   $conf   = @conf
+ public
+ def initialize
    $app    = self
+   init_app
+ end
 
-#   rescue RuntimeError => e
-#     @cgi.out { "Error initializing the app: #{$!}" }
-   rescue RoutingError => e
-     @cgi.out { "Error initializing the app (RoutingError: #{$!})" }
+ # this will yield all support directories from base path and if defined
+ # the naming proc else nil
+ def all_support_directories(path_tree)
+   path_tree.each do |t|
+       (App::config['include_directories'] || []).each do |id|
+          if id.instance_of?(Hash) then 
+              yield "#{t}/#{id[:dir]}", id[:class_naming]
+          else 
+	      yield "#{t}/#{id}", nil
+          end
+       end
+   end  
  end
 
- # this has to be public for testing scripts
  public
- def load_support_files # :nodoc:
+ def load_support_files(urlmap)  # :nodoc:
 #   $stderr.puts "======== load support files ========="
 #   $stderr.puts "Inc Dir: #{App::config['include_directories'].inspect}"
 #   $stderr.puts "Path tr: #{@conf['PATH_TREE'].inspect}"
 #   $stderr.puts "====================================="
    
-   base_path = @conf['APP_PATH']
-   @conf['PATH_TREE'].each do |t|
-       base_path << "/#{t}" 
-       (App::config['include_directories'] || []).each do |id|
-           include_files "#{base_path}/#{id}"
-        end
+#   db = $:.dup
+#   all_support_directories(@conf['APP_PATH'])  { |d,p| $: << d }
+
+#   all_support_directories(@app_path, @urlmap.path_tree) do |dir, proc|
+#    $stderr.puts "PATH TREE: #{urlmap.path_tree.inspect}"
+   all_support_directories(urlmap.path_tree) do |dir, proc|
+#     $stderr.puts "Support Directory #{dir}"
+     if proc then
+        autoload_files(dir, proc)
+     else
+        include_files(dir)
+     end   
    end
-
-#   (App::config['include_directories'] || []).each do |id|
-#         @conf['PATH_TREE'].each { |t| include_files @conf['APP_PATH'] + '/'+t+"/#{id}/"}
-#   end
  end
 
 
@@ -249,8 +164,11 @@ class App
  private
  def get_error(title, exception, show_trace = true, file=nil)
    err = "<h3>#{title}</h3>"
+   err << "<b>#{exception.class.to_s}: #{CGI::escapeHTML(exception.to_s)}</b><br/>"
+   $stderr.puts "ERROR: #{title} - #{exception.class.to_s}: #{exception.to_s}"
    if (show_trace) then
       exception.backtrace.each do |b|
+         $stderr.puts "   #{b}" 
          err +="<br/>#{b}"
       end
    else
@@ -264,14 +182,14 @@ class App
 
 
  public
- def cgicall
-  script = @conf['SCRIPT']
-
+ def cgicall(cgi = nil)
+  @cgi = cgi || CGI.new
   
+
   #
   # 1st priority: Serve a file if it exists in the 'public' folder
   #
-  file = @conf['PUBLIC_PATH'] + '/' + @conf['PATH_INFO']
+  file = @public_path + '/' + @cgi.path_info
   if File.exists?(file) && File.ftype(file) == 'file' then
     require 'cuca/mimetypes'
     mt = MimeTypes.new
@@ -279,16 +197,19 @@ class App
     extension = file.scan(/.*\.(.*)$/)[0][0] if file.include?('.')
     extension ||= 'html'
     mime = mt[extension] || 'text/html'
-    @cgi.out(mime) { f.read }
+    @cgi.out('type' => mime, 
+             'expires' => (Time.now+App.config['http_static_content_expires'])) { f.read }
     f.close
     return
   end
 
+  init_call(@cgi.path_info)
+
   # If config (urlmap) couldn't find a script then let's give up
   # with a file-not-found 404 error
-  if script.nil? then
+  if @urlmap.nil? then
      begin
-      file = "#{@conf['PUBLIC_PATH']}/#{Cuca::App.config['http_404']}"
+      file = "#{@public_path}/#{Cuca::App.config['http_404']}"
       c = File.open(file).read
       @cgi.out('status' => 'NOT_FOUND', 'type' => 'text/html') { c }
      rescue => e
@@ -297,6 +218,8 @@ class App
      return
   end
 
+  logger.info "CGICall on #{@urlmap.url} - #{@urlmap.script}"
+  script = @urlmap.script
 
   #
   # 2nd: Check if we have a script for requested action
@@ -306,15 +229,14 @@ class App
     return
   end
 
-  # Notify who needs to know
-  @@oncall.each { |p| p.call }
-
   # 3rd: Load additional files
-  load_support_files
+  load_support_files(@urlmap)
+
+  test = ApplicationController.new
 
 
   # 4th: Now let's run the actual page script code
-  controller_class_name = @conf['ACTION'].capitalize+"Controller"
+  controller_class_name = @urlmap.action.capitalize+"Controller"
   
   # Clear all hints
   Widget::clear_hints()
@@ -338,21 +260,26 @@ class App
   begin
 
      (status, mime, content) = Sandbox.run(controller_class_name, 
-                           @urlmap.action_module, @conf['ASSIGNS'], 
-                           $cgi.request_method, @conf['SUBCALL'])
+                           @urlmap.action_module, @urlmap.assigns, 
+                           @cgi.request_method, @urlmap.subcall)
   
+     logger.info "CGICall OK"
      @cgi.out('type' => mime, 'status' => status) {content}
 
   rescue Cuca::ApplicationException => e
-      err = get_error("Application Error", e, 
+      err = get_error("Application Error", e,
               Cuca::App.config['display_errors'], Cuca::App.config['http_500'])
       @cgi.out('status' => 'SERVER_ERROR') { err }
+
+     logger.info "CGICall Application Error"
       return
 
   rescue  => e
       err = get_error("System Error", e, 
               Cuca::App.config['display_errors'], Cuca::App.config['http_500'])
       @cgi.out('status' => 'SERVER_ERROR') { err }
+
+      logger.info "CGICall System Error"
       return 
  
   end