cuca 0.01 → 0.02

data/application_skeleton/app/index.rb

@@ -14,7 +14,7 @@ class IndexController < ApplicationController
     br
     text "Thank you for installing the cuca framework.";br;
     br
-    h2 { "If you want to lean cuca" }
+    h2 { "If you want to learn cuca" }
     ul do 
      li { text "Have a look at the Demo Widgets: "; SLink('demo', 'Here') }
      li { text "Checkout the cuca website: "; SLink("http://cuca.rubyforge.net") }
@@ -32,7 +32,7 @@ class IndexController < ApplicationController
     end
     br
     h2 { "Good Luck..." }
-    text "If you like cuca use the rubyforge to give any type of feedback."
+    text "If you like cuca use rubyforge to give any type of feedback."
   end
  end
 end

data/lib/cuca/app.rb

@@ -20,6 +20,9 @@ class Sandbox
        when 'GET' 
             controller.send('_do'.intern, 'get', subcall)
    end
+
+   controller.run_after_filters
+
    return controller.send(:to_s)
  end
 end
@@ -68,7 +71,7 @@ class App
      self['session_key'] = 'cuca_session'
      self['session_prefix'] = 'cuca.'
      self['session_valid'] = 3600*24
-     self['view_directoru'] = 'app/_view'	# where to find views for the view/erb generator
+     self['view_directory'] = 'app/_view'	# where to find views for the view/erb generator
      
    end
    
@@ -77,6 +80,7 @@ class App
  attr_reader :conf, :cgi, :logger, :urlmap
 
  @@app_config = Config.new
+ @@oncall = []
 
  ## Application configuration
  public
@@ -88,6 +92,13 @@ 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
@@ -257,6 +268,8 @@ class App
     return
   end
 
+  # Notify who needs to know
+  @@oncall.each { |p| p.call }
 
   # 3rd: Load additional files
   load_support_files

data/lib/cuca/const.rb

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

data/lib/cuca/controller.rb

@@ -85,53 +85,83 @@ class Controller < Widget
  attr_reader :cancel_execution  # this can be set by anyone, 
 				# methods get/post/run will not be executed
 
-  def self.def_layout
-   begin
-     self.def_layout_name
-   rescue
-     nil
-   end
+
+ # get layout
+ def self.def_layout
+   self.run_attr_method('def_layout_name')
  end
 
+ # define a layout
  def self.layout(name)
    define_attr_method(:def_layout_name,  name)
  end
 
- def self.before_filter(method)
+ private
+ def self.define_filter_method(chain_name, method_name)
    begin
-     filters = self.def_before_filter
-     filters = "#{filters};#{method}"
-     define_attr_method(:def_before_filter, filters)
-   rescue => e
-     define_attr_method(:def_before_filter, method)
+     filters = self.send(chain_name)
+     filters = "#{filters};#{method_name}"
+     define_attr_method(chain_name, filters)
+   rescue NoMethodError => e
+     define_attr_method(chain_name, method_name)
    end
  end
 
- def run_before_filters
-#   $stderr.puts "Run  before filters"
-   begin 
-     before_filter = self.class.def_before_filter
-   rescue NoMethodError => e
-	# == no filters defined at all
-#        $stderr.puts " No before filters defined for #{self.class}"
-     return
-   end
-   before_filter.split(';').each do |filter| 
-     begin
-        if (!self.methods.include?(filter)) then
-          raise ApplicationException.new("Before filter method not defined: '#{filter}'")
-        end
-        ret = self.send(filter)
-        @cancel_execution = true if ret == false
-#     rescue NoMethodError => e
-#        raise ApplicationException.new "Before filter method not defined: '#{filter}'"
-     rescue BreakControllerException => bc
+ # One or more before filter can set by an application Controller
+ # The instance methods will be run before the action get ran (get/post/run)
+ public
+ def self.before_filter(method)
+    define_filter_method(:def_before_filter, method)
+ end
+
+ # Priority before filters will be ran before any before filters
+ # this should be only used internally
+ public
+ def self.priority_before_filter(method)
+   define_filter_method(:def_priority_before_filter, method)
+ end
+
+ # after_filter - get run after the controller action has be executed
+ public
+ def self.after_filter(method)
+   define_filter_method(:def_after_filter, method)
+ end
+
+ private
+ def run_filters(chain_name, debug_filter_names)
+   filters = self.class.run_attr_method(chain_name.to_s)
+   return if filters.nil?
+   filters.split(';').each do |filter|
+      next if filter.strip == ''
+
+      begin
+          if (!self.methods.include?(filter)) then
+              raise ApplicationException.new("Filter not found in chain #{debug_filter_names}: #{filter}")
+          end
+#          $stderr.puts "Running Filter (#{debug_filter_names}): #{filter}"
+          ret = self.send(filter.intern)
+          @cancel_execution = true if ret == false 
+      rescue BreakControllerException => bc
         handle_exception(bc)
-     end
+      end
    end
  end
 
 
+ # this will run defined before filters on a controller instance
+ public
+ def run_before_filters
+   run_filters(:def_priority_before_filter, 'Priority Before Filters')
+   run_filters(:def_before_filter, 'Before Filters')
+ end
+
+ # run defined after_filters
+ public 
+ def run_after_filters
+   run_filters(:def_after_filter, 'After Filters')
+ end
+
+
  # this method will stop execution of the controller
  # it's usefull to break somewhere in the middle or to 
  # set a different layout

data/lib/cuca/generator/view.rb

@@ -86,7 +86,7 @@ module View
   def viewtext(filename=nil)
     view_dir = $cuca_path + '/' + App::config['view_directory']
     begin
-       f = File.open(VIEW_DIR + "/#{filename}", 'r')
+       f = File.open(view_dir + "/#{filename}", 'r')
     rescue => e
        return "Error opening template: #{e}"
     end

data/lib/cuca/session.rb

@@ -86,6 +86,7 @@ class Session
    make_session
  end
 
+
  # returns true/false if a session exists
  def exists?
    begin
@@ -126,18 +127,39 @@ class Session
    @sess.close
  end
 
+ def update
+   @sess.update
+ end
+ 
+ def delete
+   @sess.delete
+ end
+
+ 
 end
 
-class Widget
+class Controller
+  # This will create filters that initialize the session before the action and
+  # close it afterwards.
   def self.use_session
-     @@session ||= Session.new($cgi)
+     priority_before_filter('ses_initialize_session')
+     after_filter('ses_close_session')
   end
-  def session
-     @@session
+
+  def ses_initialize_session
+    $session = Session.new($cgi)
+  end
+  def ses_close_session
+    $session.close
   end
 end
 
 
+class Widget
+  def session
+     $session
+  end
+end
 
 end
 

data/lib/cuca/sessionflash.rb

@@ -1,10 +1,10 @@
 module Cuca
 
 # Whatever you write into flash will be valid for the current and for the
-# next action. You can keep the content for another cycle by calling the 
+# next http request. You can keep the content for another cycle by calling the 
 # keep method. Access via session.flash. (See Cuca::Session)
 class SessionFlash
- class SessionFlashItem # :nodoc: 
+ class SessionFlashItem # :nodoc:
     def value
         @value
     end
@@ -49,7 +49,10 @@ class SessionFlash
 
  private
  def expire
-   flashmem.each_pair { |k,v| v.inc; flashmem.delete(k) if v.expired? }
+   flashmem.each_pair do |k,v| 
+         v.inc
+         flashmem.delete(k) if v.expired?
+   end
  end
 end
 

data/lib/cuca/sessionpage.rb

@@ -13,7 +13,6 @@ class SessionPage
    @ses[:SessionPage]
  end
 
-
  public
  def initialize(session)
    @ses = session

data/lib/cuca/stdlib/arform.rb

@@ -1,13 +1,14 @@
-module Cuca::Stdlib
-
-require 'form'
+require 'cuca/stdlib/form'
 require 'cuca/generator/markaby'
 
 # == Form's for ActiveRecord
 # AR Form can work just by providing one model of ActiveRecord.
 # Likly that you want to overwrite the form method to
 # run a custom layout. You can use the fe* methods to
-# build form elements for the model columns
+# build form elements for the model columns definition.
+#
+# This Widget will call <form_name>_submit(model) if Form is submitted
+# and validation passed. You still have to ::save the model.
 #
 # = Example:
 #
@@ -43,15 +44,11 @@ class ARFormWidget < FormWidget
    p.delete(@submit_name)
 
    # don't save empty passwords!!
-    $stderr.puts "Before validate: #{@password_fields.inspect}"
    @password_fields ||= []
    @password_fields.each do |pwf|
-     $stderr.puts "PWS: #{pwf} - #{p[pwf]}"
       p.delete(pwf) if p[pwf].chomp.empty?
-     $stderr.puts "PWS: #{p.inspect}"
    end
 
-   $stderr.puts "ARFORM Validate #{p.inspect}"
    @model.attributes = p
    
    return true if @model.valid?
@@ -203,6 +200,3 @@ end
 
 end
 
-
-
-end

data/lib/cuca/stdlib/arview.rb

@@ -1,8 +1,16 @@
 
-# This is a small widget to display an ActiveRecord Record
+# == ARViewWidget - Display an ActiveRecord record.
+#
+# This is a small widget to quick&dirty display the content
+# of a record.
+#
+# = Example
+# 
+#  mab { ARView(User.find(:id=>123)) }
+#
 class ARViewWidget < Cuca::Widget
 
- def output(model, headline='')
+ def output(model)
   @model = model
 
    r = "<table>"

data/lib/cuca/stdlib/form.rb

@@ -1,11 +1,3 @@
-#
-# == Cuca Standard Widget Library
-# This namespace should contain a standard widget library.
-# 
-# <b>Warning: The widgets you find here are fairly untested and might not work!!</b>
-# Any request and patches - Welcome
-# module Cuca::Stdlib
-
 # == FormWidget
 #
 # To implement a form inherit this class and overwrite:
@@ -30,8 +22,7 @@ class FormWidget < Cuca::Widget
  
  # get from params and set instance variables
  def load_variables
-   $stderr.puts "\n\nLoad Variables: #{$cgi.params.inspect}\n\n"
-   params.each_pair { |k,v| instance_variable_set('@'+k, v) ; $stderr.puts "Form: Setting #{k} - #{v}" }
+   params.each_pair { |k,v| instance_variable_set('@'+k, v)  }
  end
 
  # get from params and return them as hash

data/lib/cuca/stdlib/link.rb

@@ -1,7 +1,14 @@
 require 'cuca/generator/markaby'
 
 
-# A markaby link - Please use with care!! it's slow! Better to use SLinkWidget.
+# == A markaby link
+# WARNING: This is a very slow way of creating a link. Better to use 
+#    SLinkWidget if you call this many times per page!
+#
+# = Example:
+#
+#  mab { Link('http://cuca.rubyforge.org') { b { "Click here" } }
+#
 class LinkWidget < Cuca::Widget
 
  include Cuca::Generator::Markaby

data/lib/cuca/stdlib/list.rb

@@ -1,3 +1,2 @@
-require 'cuca/stdlib/listwidget/list'
 require 'cuca/stdlib/listwidget/dblist'
 require 'cuca/stdlib/listwidget/staticdatalist'

data/lib/cuca/stdlib/listwidget/dblist.rb

@@ -55,9 +55,8 @@ class DBListWidget < BaseList
    ar_res.each do |r|
       c = []
       columns.each do |col| 
-			# fixme: this doesn't catch join table results!!!
-         if @model_class.column_methods_hash[col[:id].intern] then
-            c << r.send(col[:id].to_sym)
+         if r.attributes[col[:id]] then
+            c << r.send(col[:id].intern)
          else
             c << ''
          end
@@ -69,7 +68,7 @@ class DBListWidget < BaseList
 
  def query(query_def)
    findstuff = {:conditions => where_clause(query_def) }
-   findstuff[:order]  = query_def.order_by unless (query_def.order_by.nil? || query_def.order_by == '')
+   findstuff[:order]  = "#{query_def.order_by} #{query_def.order}" unless (query_def.order_by.nil? || query_def.order_by == '')
    findstuff[:offset] = query_def.range.first
    findstuff[:limit]  = query_def.range.last-query_def.range.first+1
    findstuff[:joins]  = @joins || nil
@@ -83,6 +82,7 @@ class DBListWidget < BaseList
    @data = @model_class.find(:all, findstuff)
    @data = normalize_result(@data)
    @total_rows= @model_class.count(:conditions => where_clause(query_def), :joins => @joins)
+   
 #   $stderr.puts "Query: #{@data.inspect} - #{query_def.order_by.inspect}"
  end
 

data/lib/cuca/stdlib/listwidget/list.rb

@@ -46,17 +46,37 @@ class BaseList < Cuca::Widget
    return 
  end
 
- # TODO: Load from Session
+ # TODO: Load from Session?
  def load_query_definition
    qd = QueryDef.new(@list_name)
    qd.from_params(params)
+   if request_method == 'POST' then
+       qd.range = nil 		# reset pagination if someone submitted a filter
+   end
+   qd
  end
 
+ # check query_def was makes sense ... raise error if manipulated!
+ def check_query_def
+    # check if filters match possible column names
+    cn = columns.collect { |c| c[:id] }
+    @query_def.filters.each_pair do |f,v|
+       raise Cuca::ApplicationException.new("Unknown column in filters: #{f}") unless cn.include?(f)
+    end
+    
+    return if @query_def.order_by == ''
+    # check if order_by is a valid column
+    raise Cuca::ApplicationException.new("Unknown sort order: #{@query_def.order_by}") \
+                    unless cn.include?(@query_def.order_by)
+ end
+ 
  def output(list_name)
    @list_name = list_name
 
    @columns = columns
    @query_def = load_query_definition
+   check_query_def
+#   $stderr.puts "Query: Range #{@query_def.range.inspect} Filters: #{@query_def.filters.inspect} Order: #{@query_def.order.inspect} By: #{@query_def.order_by.inspect}"
    query(@query_def)
    @paginate = paginate_links()
    @params = params
@@ -64,9 +84,8 @@ class BaseList < Cuca::Widget
 
    callback_method = "#{@list_name}_data"
 
-#   $stderr.puts "Callback check: #{controller.nil?.inspect}  \n\n -- #{controller.methods.sort.inspect} --\n\n NAME #{controller.class.inspect}"
    if !controller.nil? && controller.methods.include?(callback_method) 
-      controller.send(callback_method, @data)
+      controller.send(callback_method, @data, @total_rows)
    end
 
    view_p(erb_template)
@@ -119,8 +138,19 @@ end
 
       <% @columns.each do |c| %>
         <td class='hl'>
-           <%= (@query_def.order_by == c[:id] || (c[:sortable] == false)) ?
-                  c[:display] : SLink('',c[:display],@query_def.to_h('order_by', c[:id]))
+           <%
+               # this will swap the sort order if the same columns is clicked 
+               if @query_def.order_by == c[:id] then
+                  order = @query_def.order == 'ASC' ? 'DESC' : 'ASC'
+                  display = "#{c[:display]} (#{@query_def.order})"
+               else
+                  order = 'ASC'
+                  display = c[:display]
+               end
+           %>
+           <%= (c[:sortable] == false) ?  display : SLink('',display,
+                                       @query_def.to_h('order_by', c[:id], 
+                                                       'order', order))
                    %>
        </td>
       <% end %>
@@ -156,7 +186,7 @@ ENDTEMPLATE
 end
 
 
-# This would be a markaby template for the listwidget. I find it less readable so will not
+# This was the old markaby template for the listwidget. I find it less readable so will not
 # continue working on it.
 #
 #

data/lib/cuca/stdlib/listwidget/querydef.rb

@@ -3,7 +3,7 @@
 #
 # FIXME: Change name or put into namespace
 class QueryDef
- ATTRIBS = ['order_by','range', 'filters']
+ ATTRIBS = ['order_by', 'order','range', 'filters']
  ATTRIBS_ENCODE = 
     { 
       'range' => 
@@ -15,6 +15,10 @@ class QueryDef
         s = ''; 
         e.each_pair { |k,v| s << "#{k}:#{v};" }; 
         s 
+      end,
+      'order' => 
+      Proc.new do |e|
+        ['ASC', 'DESC'].include?(e) ? e : 'ASC'
       end
     }
  ATTRIBS_DECODE = 
@@ -31,10 +35,15 @@ class QueryDef
                h[vals[0]] = vals[1] if (vals.size == 2)
           end
        h
-       end
+       end,
+       'order' => 
+        Proc.new do |e|
+          ['ASC', 'DESC'].include?(e) ? e : 'ASC'
+        end
     }
  ATTRIBS_DEFAULTS = { 'range' => 0..9,
                       'order_by' => '',
+                      'order' => 'ASC',
                       'filters' => {} }
 
  # take from CGI class
@@ -54,7 +63,7 @@ class QueryDef
 
    #getter 
    if (ATTRIBS.include?(met)) then
-     return @data[met] || ATTRIBS_DEFAULT[met].dup
+     return @data[met] || ATTRIBS_DEFAULTS[met].dup
    end
  
    #setter
@@ -103,10 +112,11 @@ class QueryDef
 
  # returns an hash with the values and escaped names and attributes
  # attr and newval with swap a value for this return without changing the actual data
- def to_h(attr=nil, newval=nil)
+ def to_h(attr=nil, newval=nil, attr2=nil, newval2=nil)
    if attr then
       @backup = @data.dup
       @data[attr] = newval
+      @data[attr2] = newval2 unless attr2.nil?
    end
 
    u = {}

data/lib/cuca/stdlib/listwidget/staticdatalist.rb

@@ -60,6 +60,7 @@ class StaticDataListWidget < BaseList
    cidx = col_idx_by_id(query_def.order_by) || 0
    
    @data = @sd_data.sort { |a,b| a[cidx] <=> b[cidx] }
+   @data = @data.reverse if query_def.order == 'DESC'
    apply_filters(query_def)
    @total_rows = @data.size
    @data = @data[query_def.range]

data/lib/cuca/stdlib/slink.rb

@@ -1,5 +1,8 @@
-# Simple, fast link - no markaby as block
-
+# == Simple, fast link - no markaby as block
+#
+# = Example:
+#  mab { SLink('http://cuca.rubyforge.net', 'click') }
+#
 class SLinkWidget < Cuca::Widget
  private
  def build_href(target, params)

data/lib/cuca/widget.rb

@@ -207,6 +207,13 @@ class Widget
 #  $stderr.puts "def #{name}; #{value.to_s.inspect}; end"
   end
 
+  # tries to run a class method if defined and return it
+  def self.run_attr_method(name)
+    return nil unless self.methods.include?(name)
+    self.send(name.intern)
+  end
+
+
 end
 
 end # Module

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cuca
 version: !ruby/object:Gem::Version 
-  version: "0.01"
+  version: "0.02"
 platform: ruby
 authors: 
 - Martin Boese
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-08 00:00:00 +01:00
+date: 2008-05-11 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency