RubyGems - cuca - Versions diffs - 0.02 → 0.03 - Mend

cuca 0.02 → 0.03

Files changed (15) hide show

data/application_skeleton/README +1 -1
data/application_skeleton/app/_widgets/test.rb +2 -1
data/application_skeleton/conf/config.rb +49 -0
data/application_skeleton/conf/environment.rb +6 -16
data/application_skeleton/public/404.html +8 -0
data/application_skeleton/public/500.html +9 -0
data/application_skeleton/scripts/console.rb +0 -0
data/lib/cuca/app.rb +57 -23
data/lib/cuca/const.rb +1 -1
data/lib/cuca/controller.rb +57 -6
data/lib/cuca/urlmap.rb +7 -3
data/lib/cuca.rb +9 -2
metadata +5 -6
data/application_skeleton/app/user/__default_username/index.rb +0 -7
data/application_skeleton/scripts/console +0 -5

data/application_skeleton/README CHANGED Viewed

@@ -17,5 +17,5 @@ To get started:
 2. See http://cuca.rubyforge.org/ for more information
-Questions/Comments/Suggestions are welcome: Email boesemar@rubyforge.org or
+Questions/Comments/Suggestions are welcome: Email boesemar@gmx.de or
 use the rubyforge cuca project forum.

data/application_skeleton/app/_widgets/test.rb CHANGED Viewed

@@ -11,7 +11,8 @@ class TestWidget < Cuca::Widget
   def output(*args, &block)
     @a = @_assigns
-    mab { text "Debug-Widget: "; br ;
+    @params = params
+    mab { text "Test-Widget (debug): "; br ;
           text "ARGS: " + args.inspect ; br ;
           text "ASSIGNS:" + @a.inspect; br;
 	  text "PARAMS: " + @params.inspect ; br;

data/application_skeleton/conf/config.rb ADDED Viewed

@@ -0,0 +1,49 @@
+# === conf/config.rb
+# 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
+# conf/environment.rb instead.
+#
+# The cuca framework itself isn't fully loaded at this point.
+#
+# === Using Cuca::App.configure:
+#
+# You can pass any information here as you like. Some settings the framework
+# will make use of, but this is also the right place to define application
+# specific settings.
+# You can access these values later anytime with Cuca::App.config[key]
+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.
+  config.include_directories = %w{_controllers _layouts _models _widgets}
+  ### For pretty url mapping
+  # config.magic_action_prefix = '__default_'
+  ### This defines the session cookie definitions
+  # config.session_key = 'cuca_session'
+  # config.session_prefix = 'cuca.'
+  # config.session_valid = 3600*24		# (one day)
+  ### the view generator will look for external templates here:
+  # config.view_directory = 'app/_views'
+  ### 404 (file not found) and 500 system error page (relative to the public folder)
+  # config.http_404 = '404.html'
+  # 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.
+  # 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'
+end

data/application_skeleton/conf/environment.rb CHANGED Viewed

@@ -1,16 +1,6 @@
-# Use this file to setup your application environment
-Cuca::App.configure do |config|
-#  config.db_database   = 'm3'
-#  config.db_username   = 'postgres'
-#  config.db_password   = ''
-#  config.db_host       = 'localhost'
-#  config.db_adapter    = 'postgresql'
-#  config.db_database_testing = 'm3_test'
-  config.log_level     = 3
-  config.include_directories = %w{_controllers _layouts _models _widgets}
-  config.magic_action_prefix = '__default_'
-end
+# Use this file to setup your application environment e.g.:
+#
+# - Initialize a 3rd party library
+# - Load additional variables
+# - Open a database handler
+# - ...

data/application_skeleton/public/404.html ADDED Viewed

@@ -0,0 +1,8 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head><TITLE>404 - File not found</TITLE></head>
+<body>
+<h1>404 - File not found</h1>
+The requested file could not be located.
+</body>
+</html>

data/application_skeleton/public/500.html ADDED Viewed

@@ -0,0 +1,9 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head><TITLE>500 - Server error</TITLE></head>
+<body>
+<h1>500 - Server Error</h1>
+An internal server error happened while processing your request.
+</body>
+</html>

data/application_skeleton/scripts/console.rb CHANGED Viewed

File without changes

data/lib/cuca/app.rb CHANGED Viewed

@@ -6,6 +6,8 @@ module Cuca
 # 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)
@@ -23,7 +25,7 @@ class Sandbox
    controller.run_after_filters
-   return controller.send(:to_s)
+   return [controller.http_status, controller.mime_type, controller.to_s]
  end
 end
@@ -67,12 +69,14 @@ class App
      self['include_directories'] = %w{_controllers _widgets _layouts}
      self['log_level']  = 3
      self['magic_prefix'] = '__default_'
-     self['directory_seperator'] = '/'		# future?
      self['session_key'] = 'cuca_session'
      self['session_prefix'] = 'cuca.'
      self['session_valid'] = 3600*24
-     self['view_directory'] = 'app/_view'	# where to find views for the view/erb generator
+     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
@@ -172,10 +176,10 @@ class App
      @conf['ASSIGNS'] = mapping.assigns
      @conf['ACTION']  = mapping.action
      @urlmap = mapping
-   rescue RoutingError => r
-     @conf['SCRIPT'] = "#{@conf['PUBLIC_PATH']}/#{@conf['PATH_INFO']}"
-     return
-#     raise "RoutingError: #{r}"
+     rescue RoutingError => r # no script found - maybe serve a static file?
+      @conf['SCRIPT'] = nil
+      return
    end
    # get the PATH_TREE for file inclusion!
@@ -213,8 +217,10 @@ class App
    $conf   = @conf
    $app    = self
-   rescue RuntimeError => e
-     @cgi.out { "Error initializing the app: #{$!}" }
+#   rescue RuntimeError => e
+#     @cgi.out { "Error initializing the app: #{$!}" }
+   rescue RoutingError => e
+     @cgi.out { "Error initializing the app (RoutingError: #{$!})" }
  end
  # this has to be public for testing scripts
@@ -238,6 +244,25 @@ class App
 #   end
  end
+ # this will build an error message depending on configuration
+ private
+ def get_error(title, exception, show_trace = true, file=nil)
+   err = "<h3>#{title}</h3>"
+   if (show_trace) then
+      exception.backtrace.each do |b|
+         err +="<br/>#{b}"
+      end
+   else
+      begin
+         err = File.open(file).read
+      rescue
+      end
+   end
+   err
+ end
  public
  def cgicall
   script = @conf['SCRIPT']
@@ -259,6 +284,19 @@ class App
     return
   end
+  # If config (urlmap) couldn't find a script then let's give up
+  # with a file-not-found 404 error
+  if script.nil? then
+     begin
+      file = "#{@conf['PUBLIC_PATH']}/#{Cuca::App.config['http_404']}"
+      c = File.open(file).read
+      @cgi.out('status' => 'NOT_FOUND', 'type' => 'text/html') { c }
+     rescue => e
+      @cgi.out('status' => 'NOT_FOUND', 'type' => 'text/html') { "404 - File not found!" }
+     end
+     return
+  end
   #
   # 2nd: Check if we have a script for requested action
@@ -299,25 +337,21 @@ class App
   #
   begin
-     result = Sandbox.run(controller_class_name, @urlmap.action_module, @conf['ASSIGNS'],
-                   $cgi.request_method, @conf['SUBCALL'])
+     (status, mime, content) = Sandbox.run(controller_class_name,
+                           @urlmap.action_module, @conf['ASSIGNS'],
+                           $cgi.request_method, @conf['SUBCALL'])
-     @cgi.out('type' => 'text/html') {result}
+     @cgi.out('type' => mime, 'status' => status) {content}
   rescue Cuca::ApplicationException => e
-      err = "<b>Application Error: #{e}</b><br/>"
-      e.backtrace.each do |b|
-         err +="<br/>#{b}"
-      end
+      err = get_error("Application Error", e,
+              Cuca::App.config['display_errors'], Cuca::App.config['http_500'])
       @cgi.out('status' => 'SERVER_ERROR') { err }
-      return
+      return
   rescue  => e
-      err = "<b>System Error: #{e}</b><br/>"
-      e.backtrace.each do |b|
-         err +="<br/>#{b}"
-      end
+      err = get_error("System Error", e,
+              Cuca::App.config['display_errors'], Cuca::App.config['http_500'])
       @cgi.out('status' => 'SERVER_ERROR') { err }
       return

data/lib/cuca/const.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Cuca
-   VERSION = '0.02'
+   VERSION = '0.03'
 end

data/lib/cuca/controller.rb CHANGED Viewed

@@ -48,6 +48,28 @@ end
 #
 # The magic URL prefix (default: __default_) can be change within App::Config
 #
+# == Defining a Layouts
+#
+# In most cases a layout is defined on the controller class definition with the
+# layout instruction:
+#
+#  class IndexController
+#      layout 'standard'
+#  end
+#
+# In some cases you want to render a different layout or disable it at all. For
+# this you can call within your action the 'layout' instance method that will
+# temporarily the instruct the controller to render another layout or no layout
+# (if false).
+#
+#
+# == Interrupting the program
+#
+# If you want to stop your program you can call the 'stop' method. Stop has
+# function to do most function, like redirect or setting a different layout or
+# raising an error message.
+#
+#
 # == Examples
 #
 # Hello world (index.rb):
@@ -85,16 +107,39 @@ class Controller < Widget
  attr_reader :cancel_execution  # this can be set by anyone,
 				# methods get/post/run will not be executed
+ # Tells the app what to send to the browser 'text/html'
+ def mime_type(mt=nil)
+  @_mime_type = mt unless mt.nil?
+  @_mime_type
+ end
+ # A ruby cgi status type 'OK', 'NOT_FOUND'....to be sent within the http header
+ def http_status(hs=nil)
+  @_http_status = hs unless hs.nil?
+  @_http_status
+ end
  # get layout
+ private	# ??
  def self.def_layout
+#   return @_layout unless @_layout.nil?
    self.run_attr_method('def_layout_name')
  end
- # define a layout
+ # define a layout for the Controller
+ public
  def self.layout(name)
    define_attr_method(:def_layout_name,  name)
  end
+ # define a layout for the current instance
+ def layout(name)
+   $stderr.puts "Overwriting Layout: #{self.class.def_layout.inspect} with #{name}"
+   @_layout = name
+ end
  private
  def self.define_filter_method(chain_name, method_name)
@@ -177,11 +222,11 @@ class Controller < Widget
  # this piece of code will handle a thrown exception BreakControllerException
  def handle_exception(e)
    if e.flags.has_key?(:layout) then
-       self.class.layout(e.flags[:layout])
+       @_layout = e.flags[:layout]
    end
    if e.flags.has_key?(:redirect) then
-     self.class.layout false
+     @_layout = false
      to = e.flags[:redirect]
      clear
      @_content = "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\"><html><head><title>Redirecting...</title><meta http-equiv=\"REFRESH\" content=\"0;url=#{to}\"></HEAD></HTML>"
@@ -189,7 +234,7 @@ class Controller < Widget
    end
    if e.flags.has_key?(:error) then
-     self.class.layout false
+     @_layout = false
      clear
      @error_message = e.flags[:error]
      @cancel_execution = true
@@ -241,13 +286,19 @@ class Controller < Widget
     get_assigns.each_pair do |k,v|
       instance_variable_set("@#{k}", v)
     end
+    @_mime_type   = Cuca::App.config['default_mime_type']
+    @_http_status = 'OK'
  end
  private
  def load_layout
-   return nil if self.class.def_layout.nil?
+   l = @_layout.nil? ? self.class.def_layout : @_layout
+   return nil if (l.nil? || l == false)
+   lname = l.capitalize+"Layout"
    begin
-     layout_class = Object::const_get(self.class.def_layout.capitalize+"Layout")
+     layout_class = Object::const_get(lname)
    rescue => e
      # fixme - if layout loading fails we should display some error
      return nil

data/lib/cuca/urlmap.rb CHANGED Viewed

@@ -23,8 +23,9 @@ end
 # * assigns 		- hash with variable assigns from the url (magick prefixes)
 # * subcall 		- name of subcall or nil if a normal call was made
 # * action 		- Action name (Note: action.capitalize+"Controller" is your controller class name)
-# * action_path 	- Path to the action
-# * action_path_full 	- Full path to application
+# * base_url		- Base URL to the action (e.g.: /user/someone/show is -> /user/someone/)
+# * action_path 	- Path to the action script
+# * action_path_full 	- Full path to action script
 # * action_module	- The module the action should be loaded into (to avoid name conflicts, depends on action_path)
 #
 #
@@ -52,6 +53,7 @@ end
 #
 #  u.script 	 => '/home/bones/src/cuca_app/app/customer/__customer/show.rb'
 #  u.action 	 => 'show'
+#  u.base_url    => '/customer/__customer/'
 #  u.assigns 	 => { 'customer' => 'southwind_lda' }
 #  u.action_path => 'customer/southwind_lda/'
 #
@@ -59,6 +61,7 @@ class URLMap
  attr_reader :assigns
  attr_reader :script
  attr_reader :subcall
+ attr_reader :base_url
  attr_reader :action
  attr_reader :action_path
  attr_reader :action_path_full
@@ -138,7 +141,7 @@ class URLMap
    files = @path_info.split('/')
    files << '' if @path_info[@path_info.size-1].chr == '/'		# add empty element if we point to a directory
 #   puts files.inspect
    real_path = @base_path
@@ -150,6 +153,7 @@ class URLMap
      real_path = "#{real_path}/#{r}"
    end
+   @base_url	      = "#{files[0..-2].join('/')}/"
    @action_path       = real_path[@base_path.length..-1]
    @action_path_full  = real_path
    @action_module     = make_module(@action_path)

data/lib/cuca.rb CHANGED Viewed

@@ -58,11 +58,18 @@ require 'cuca/app'
 $LOAD_PATH << $cuca_path+'/lib'
 begin
- require $cuca_path+'/conf/environment'
+ require $cuca_path+'/conf/config'
 rescue LoadError => e
- $stderr.puts "WARN: Error loading conf/environment: #{e}"
+ $stderr.puts "WARN: Error loading conf/config: #{e}"
 end
 require 'cuca/widget'
 require 'cuca/controller'
 require 'cuca/layout'
+begin
+ require $cuca_path+'/conf/environment'
+rescue LoadError => e
+ $stderr.puts "WARN: Error loading conf/environment: #{e}"
+end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cuca
 version: !ruby/object:Gem::Version
-  version: "0.02"
+  version: "0.03"
 platform: ruby
 authors:
 - Martin Boese
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2008-05-11 00:00:00 +01:00
+date: 2008-05-18 00:00:00 +01:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -90,9 +90,6 @@ files:
 - application_skeleton/app/_widgets
 - application_skeleton/app/_widgets/test.rb
 - application_skeleton/app/_widgets/sourcecode.rb
-- application_skeleton/app/user
-- application_skeleton/app/user/__default_username
-- application_skeleton/app/user/__default_username/index.rb
 - application_skeleton/app/_views
 - application_skeleton/scripts
 - application_skeleton/scripts/server-lighttpd-fcgi.rb
@@ -100,16 +97,18 @@ files:
 - application_skeleton/scripts/test.rb
 - application_skeleton/scripts/server-lighttpd.rb
 - application_skeleton/scripts/server-webrick.rb
-- application_skeleton/scripts/console
 - application_skeleton/lib
 - application_skeleton/public
+- application_skeleton/public/404.html
 - application_skeleton/public/dispatch.fcgi
 - application_skeleton/public/dispatch.cgi
 - application_skeleton/public/css
 - application_skeleton/public/css/style.css
 - application_skeleton/public/img
 - application_skeleton/public/img/cuca-seagull.png
+- application_skeleton/public/500.html
 - application_skeleton/conf
+- application_skeleton/conf/config.rb
 - application_skeleton/conf/environment.rb
 has_rdoc: true
 homepage: http://cuca.rubyforge.org/

data/application_skeleton/app/user/__default_username/index.rb DELETED Viewed

@@ -1,7 +0,0 @@
-class IndexController < ApplicationController
-def run
-  content << "User is #{@username}"
-end
-end

data/application_skeleton/scripts/console DELETED Viewed

@@ -1,5 +0,0 @@
-#!/usr/bin/ruby
-libs  = " -r irb/completion -r rubygems -r cuca"
-exec "irb #{libs} --simple-prompt"