cuca 0.05 → 0.06

data/lib/cuca/stdlib/form.rb

@@ -1,35 +1,109 @@
 # == FormWidget
 #
-# To implement a form inherit this class and overwrite:
+# The FormWidget helps you to build and validate html forms.
 #
-# * form - generate your form (as if it was the output method of a widget)
-#   - Use @form_name for your html form name
-#   - Use @submit_name for your submit button
-# * validate - to validate a posted form
-#   - write @form_errors['element_name'] on errors (to handle them with FormErrors Widget)
-# * setup - Define initial values for your form
+# Every form has a name and some optional options per instance.
 #
-# A form will call {form_name}_submit(result) on the CONTROLLER if the form was submitted
-# and validation passed.
-# If you don't want this, overwrite on_submit
+# = Implementation
 #
-# A form will use instance variables for form values
+# To implement your form, derive a class from FormWidget and implement these methods:
+#
+#  * form - To generate your form
+#    - Use @form_name to name your form
+#    - Use @submit_name to name your submit button
+#  * validate(variables) - OPTIONAL
+#    - Validate the result of the form (variables == hash with values)
+#    - Write @form_errors['element_name'] = 'Error message' on all errors
+#  * setup - OPTIONAL (setup additional stuff after object initialization)
+#  * before_validate(variables)
+#    - rewrite fields or compose real fields out of virtual fields
+#  * on_submit - OPTIONAL
+#    - Do stuff once submitted
+#    - By default this method will call formname_submit on the controller
+#
+# = Usage
+# 
+# On a controller, call with
+#
+# MyForm('form_name', :option=>:value ..)
+#
+#
+# = Example
+#
+#  class EmailFormWidget < ARFormWidget
+#     include Cuca::FormElements
+#     
+#     # euser and edomain will complse email_address
+#     def before_validate(variables)
+#         variables['email_address'] = variables['euser'] + '@' + variables['edomain']
+#         variables.delete('euser')
+#         variables.delete('edomain')
+#         variables
+#     end
+#    
+#     def validate(var)
+#        @form_errors['euser'] = 'Invalid Format' \
+#                   unless var['email_address'] =~ /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,6}$/
+#     end
+#
+#     # create a custom layout using FormElement module
+#     def form
+#       mab do
+#          FormErrors(@form_errors)
+#          fe_formstart
+#          text "Email Address" ; fe_text('euser'); text '@' ; fe_text('edomain')
+#          fe_submit
+#          fe_formend
+#       end
+#     end
+#  end
+#
+# On the controller
+#
+#  class EmailAddController < ApplicationController
+#
+#  def email_add_submit(var)
+#      mab { text "You entered #{var.inspect}" }
+#  end
+#
+#  def run
+#    mab { EmailForm('email_add', :default_values => { :euser => 'your-name', :edomain => 'domain.com' } }
+#  end
+# end
+#
+
 class FormWidget < Cuca::Widget
 
+ # Returns true if this form was posted
  def posted?
    return (request_method == 'POST' && !params[@submit_name].nil?)
  end
+
+ # Returns true if a form with that name was posted
+ def self.posted?(form_name)
+   w = Cuca::Widget.new
+   return (w.request_method == 'POST' && !w.params['submit_' + form_name].nil?)
+ end
+ 
+ # get form params and return them as hash. If form hasn't been posted yet
+ # it will get the variables from the options[:default_values]
+ def get_form_variables
+   var = @options[:default_values] || {}
+   params.each_pair { |k,v| var[k] = v } if posted?
+   @variables = {}
+   var.each_pair { |k,v| @variables[k.to_s] = v }		# this allows is to pass symbols to default_values
+   @variables
+ end
  
- # get from params and set instance variables
- def load_variables
-   params.each_pair { |k,v| instance_variable_set('@'+k, v)  }
+ # returns the default value for a variable.
+ def get_default_variable(var)
+   @options[:default_values].each_pair { |k,v| return v if k.to_s == var.to_s }
+   nil   
  end
 
- # get from params and return them as hash
- def get_variables
-   r = {}
-   params.each_pair { |k,v| r[k] = v }
-   return r
+ # accessor to current values of a variable by name. This is for posted an un-posted forms.
+ def v
+  @variables
  end
 
  # Overwrite this method to setup initial values
@@ -37,49 +111,54 @@ class FormWidget < Cuca::Widget
  def setup
  end
 
-
- # Create your form by overwriting this demo
+ # Create your form by overwriting this
  # Name your submit button @submit_name, so the form can detect if it
- # is submitted or not.
+ # is submitted or not. You can use FormElements module to get access to some
+ # helper functions to build really fast forms.
  def form
  end
  
- # Overwrite this method with your validation code
- # @form_errors hash with error messages
- def validate
+ # this will get called with the request_parameters as arguments for you to filter. 
+ # You can use this to create new fields and to get rid of virtual ones.
+ def before_validate(variables)
+  variables 
+ end
+ 
+ 
+ 
+ # Overwrite this method with your validation code.
+ # Fill up @form_errors hash with error messages.
+ def validate(variables)
  end
 
  # If form is validated we call on_submit. Default behaviour is to call
- # {form_name}_submit(result) on the CONTROLLER.
+ # {form_name}_submit(raw_result, [rewritten_result]) on the CONTROLLER.
  def on_submit
-  controller.send(@form_name+'_submit', get_variables) unless controller.nil?
-  clear
-  form
+  met = @form_name+"_submit"
+  if controller.method(met.intern).arity == 2 then
+    controller.send(met, @variables, @before_validate_variables) unless controller.nil?
+  else
+    controller.send(met, @variables) unless controller.nil?
+  end
  end
 
  # options can be used for form specific stuff
  # we only use :post_to to set @post_to atm
  def output(form_name, options = {})
+   @options = options
+   @post_to   = @options[:post_to] || cgi.path_info
    @form_name = form_name
-   
    @submit_name = 'submit_'+@form_name
    @form_errors = {}
 
-   @options = options
-   
    setup
-
-   @post_to   = @options[:post_to] || cgi.path_info
-
-
-#   form
+   
+   get_form_variables
 
    if posted? then
-     load_variables
-     validate
+     @before_validate_variables = before_validate(request_parameters.dup)
+     validate(@before_validate_variables)
      if @form_errors.empty? then
-# What was that thought about?
-#        clear		# submitted forms should not have any content that might have been generated
         return on_submit
      else
         form
@@ -90,52 +169,3 @@ class FormWidget < Cuca::Widget
  end
 end
 
-
-
-require 'cuca/generator/markaby'
-
-class TestFormWidget < FormWidget
-
- include Cuca::Generator::Markaby
-
- def setup
-   @demo_input = "enter something"
- end
-
- def make_tips
-   @form_errors.each_pair do |k,v| 
-      hints[:tips] ||= []
-      hints[:tips] << { :id => k, :title => "Error in form", :text => v}
-  end
- end
-
-
- def validate
-   # validate form return true/false
-   if @demo_input != 'demo' then
-     @form_errors['demo_input'] = "I said please enter 'demo' but you entered #{@demo_input}"
-   end
-   make_tips
-   true
- end
-
- def form
-   mab { 
-
-      FormErrors(@form_errors)
- 
-       form( :action=>@post_to, :method=>'post') { # :name=>@form_name,
-	 text "This is a demo form, overwrite 'form' method. Enter 'demo'"
-         br
-	 E('demo_input', true) { input(:type => 'text', :value => @demo_input, :name=>'demo_input'); text @error_text }
-         br
-         br
-         input(:type => 'submit', :value => 'save', :name => @submit_name)
-        }
-   }
- end
-
-end
-
-
-# end

data/lib/cuca/stdlib/formelements.rb

@@ -0,0 +1,135 @@
+# mixin this module to build form elements
+
+module Cuca
+module FormElements
+
+ private 
+ def a2p(attribs)
+   a = attribs.dup
+   a.delete(:default_value) # reserved attribute
+   a.inject([]) { |m,e| m << ((e[1].to_s != '') ? "#{e[0].to_s}='#{e[1].to_s}'" : e[0].to_s) }.join(' ')
+ end
+ 
+ private
+ def twodig(n)
+   n.to_s.length == 1 ? "0"+n.to_s : n.to_s
+ end
+ 
+ # this allows to pass a :default_value to the set of attribs 
+ private 
+ def get_value(name, attribs)
+    v[name] || (attribs[:default_value] || '')
+ end
+ 
+ def fe_text(name, attribs = {})
+    "<input type='text' name='#{name}' value='#{get_value(name, attribs)}' #{a2p(attribs)}>\n"
+ end
+
+ def fe_hidden(name, attribs = {})
+   "<input type='hidden' name='#{name}' value='#{get_value(name, attribs)}' #{a2p(attribs)}>\n"
+ end
+
+ def fe_int(name, attribs = {})
+    fe_text(name, attribs)
+ end
+
+
+ def fe_textarea(name, attribs = {})
+   a = { :rows => 5, :cols => 50 }.merge(attribs)
+   "<textarea name='#{name}' #{a2p(a)}>#{get_value(name, attribs)}</textarea>\n"
+ end
+ 
+ # build a form start tag
+ def fe_formstart(attribs = {})
+   a = {:name=>@form_name, :method=>'post', :action=>@post_to }.merge(attribs)
+   "<form #{a2p(a)}>\n"
+ end
+
+ # fe password doesn't show passwords content but default (unless :showvalue defined in attribs)
+ def fe_password(name, attribs = {})
+    v = attribs[:showvalue] ? get_value(name, attribs) : ''
+    attribs.delete(:showvalue)
+    "<input type='password' name='#{name}' value='#{v}' #{a2p(attribs)}>\n"
+ end
+ 
+ 
+ # this is to build a select box, example:
+ # fe_select('gender', [['f', 'female'],['m','Male']]) or
+ # fe_select('gender', ['f','m'])
+ def fe_select(name, options, attribs = {})
+   r = "<select name='#{name}' #{a2p(attribs)}>\n"
+   options.each do |o|
+     ov = o.instance_of?(Array) ? o[0] : o
+     sel = ''
+     sel = ' selected' if v[name] == ov
+     if o.instance_of?(Array) then
+       r+="<option value='#{o[0]}'#{sel}>#{o[1]}</option>\n"
+     else
+      r+="<option value='#{o}'#{sel}>#{o}</option>\n"
+     end
+   end
+   r+="</select>\n" 
+end
+
+  def fe_bool(name,attribs = {})
+    r = ''
+    attribs = attribs.dup
+    truename = attribs[:true] || 'true'   
+    falsename = attribs[:false] || 'false'
+    trueval = attribs.has_key?(:trueval) ? attribs[:trueval] : 't'
+    falseval = attribs.has_key?(:falseval) ? attribs[:falseval] : 'f'
+    $stderr.puts "#{name}: #{v[name].inspect} #{trueval.inspect} #{falseval.inspect}"
+    attribs.delete(:true)
+    attribs.delete(:false)
+    attribs.delete(:trueval)
+    attribs.delete(:falseval)
+
+    
+    r << "\n<select name='#{name}' #{a2p(attribs)}>\n"
+    r << "<option #{"selected" if v[name] == trueval} value='#{trueval}'>#{truename}</option>\n"
+    r << "<option #{"selected" if v[name] == falseval} value='#{falseval}'>#{falsename}</option>\n"
+    r << "</select>\n"
+ end
+
+ 
+ def fe_submit(attribs = {})
+   a = { :value => 'Submit', :name=>@submit_name }.merge(attribs)
+   "<input type='submit' #{a2p(a)}>\n"
+ end
+ 
+ 
+ def fe_formend
+   "</form>\n"
+ end
+ 
+ 
+ def fe_datetime(name, attribs = {})
+   require 'date'
+   begin
+     val = v[name].instance_of?(Time) ? v[name] : DateTime.parse(v[name] || 'now')
+   rescue ArgumentError
+     val = DateTime.now
+   end
+   value = "#{val.year}/#{twodig(val.month)}/#{twodig(val.day)} #{val.hour}:#{val.min}"
+   "<input type='text' name='#{name}' value='#{value}' #{a2p(attribs)}>\n"
+ end
+ 
+ def fe_date(name, attribs = {})
+   require 'date'
+   if v[name].instance_of?(Date) then
+      value = "#{v[name].year}/#{twodig(v[name].month)}/#{twodig(v[name].day)}"
+   end
+   if v[name].nil? || (v[name].instance_of?(String) && v[name].empty?) then
+      value = ''
+   end
+   if value.nil? then
+      val = Date.today
+      value = "#{val.year}/#{twodig(val.month)}/#{twodig(val.day)}"
+   end
+   
+   "<input type='text' name='#{name}' value='#{value}' #{a2p(attribs)}> (yyyy/mm/dd)\n"
+ end
+ 
+
+end
+end

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

@@ -19,12 +19,12 @@ require 'active_record'
 class DBListWidget < BaseList
  def columns
 #   $stderr.puts " Getting Columns: #{@columns}"
-   @columns
+   @columns.delete_if { |c| !c[:display] }
  end
   
  # returns :query field by :id (only :id is defined in the QueryDef)
  def wc_query_field(field_id)
-    @columns.each do |c| 
+    @columns.each do |c|
           if c[:id] == field_id then 
              return c[:query]
           end
@@ -65,6 +65,7 @@ class DBListWidget < BaseList
    end
    res
  end
+ 
 
  def query(query_def)
    findstuff = {:conditions => where_clause(query_def) }
@@ -72,7 +73,7 @@ class DBListWidget < BaseList
    findstuff[:offset] = query_def.range.first
    findstuff[:limit]  = query_def.range.last-query_def.range.first+1
    findstuff[:joins]  = @joins || nil
-   sel = @columns.collect do |c| 
+   sel = @query_columns.collect do |c| 
       ret = c.has_key?(:query) ? "#{c[:query]} as #{c[:id]}" : c[:id] 
       ret = nil if c[:query] == false
       ret
@@ -80,8 +81,10 @@ class DBListWidget < BaseList
    findstuff[:select] = sel.compact.join(',')
    $stderr.puts "Find-Stuff: #{findstuff.inspect}"
    @data = @model_class.find(:all, findstuff)
-   @data = normalize_result(@data)
+   $stderr.puts "data: #{@data}"
+   @additional_data = @data.dup
    
+   @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}"
@@ -116,8 +119,10 @@ class DBListWidget < BaseList
    setup
    fixup_columns
 #   $stderr.puts @columns.inspect
-   @columns.freeze
+#   @columns.freeze
    @extra_conditions.freeze
+   @query_columns = @columns.dup
+   @columns = @columns.delete_if { |c| !c[:display] } # don't display columns without a 'display'
    super(list_name)
  end
 end

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

@@ -29,10 +29,14 @@ class BaseList < Cuca::Widget
     res
  end
 
- def rewrite_field(row, field_id, content)
+ def rewrite_field(row, field_id, content, additional_content = nil)
 #   $stderr.puts "REwrite field(#{row.inspect}, #{field_id.inspect}, #{content.inspect} - hooks #{@rewrite_hooks.inspect}"
    return content unless @rewrite_hooks[field_id]
-   return @rewrite_hooks[field_id].call(row2hash(row), content)
+   if @rewrite_hooks[field_id].arity == 2 then
+     return @rewrite_hooks[field_id].call(row2hash(row), content)
+   else
+     return @rewrite_hooks[field_id].call(row2hash(row), content, additional_content)
+   end
  end
 
 
@@ -52,12 +56,11 @@ class BaseList < Cuca::Widget
  # @data       = [['a','b', 12], ...]
  # @total_rows = 123
  def query(query_definition)
-   return 
+   return
  end
 
- # TODO: Load from Session?
  def load_query_definition
-   qd = QueryDef.new(@list_name)
+   qd = QueryDef.new(@list_name, (@query_defaults || {}))
    qd.from_params(params)
    if request_method == 'POST' then
        qd.range = nil 		# reset pagination if someone submitted a filter
@@ -105,43 +108,39 @@ class BaseList < Cuca::Widget
    @rows_per_page = (@query_def.range.last - @query_def.range.first) + 1
    @total_pages = (@total_rows / @rows_per_page).to_i
    @total_pages = @total_pages + 1 unless ((@total_rows % @rows_per_page) == 0)
- 
-   pl = '' ; i = 0
-   (0..(@total_pages-1)).each do |p|
-      range = i..(i+@rows_per_page-1)
-      if range.include?(@query_def.range.first+1) then
-          pl<< "#{(p+1).to_s} "
-      else
-          pl << "#{SLinkWidget.new(:args=>['',(p+1).to_s,@query_def.to_h('range', range)]).to_s} "
-      end
-      i+=@rows_per_page
-  end
+
+   pl = ''
+   (0..(@total_pages-1)).map do |e| 
+            { :idx =>e, 
+              :range=>((e*@rows_per_page)..(e*@rows_per_page+@rows_per_page-1)) }
+    end.map do |e|
+       rt = @rows_per_page * 2
+       r = false
+       r = true if e[:idx] == 0
+       r = true if e[:idx] == (@total_pages - 1)
+       r = true if ((e[:range].min - rt)..(e[:range].max + rt)).include?(@query_def.range.first+1)
+       e[:display] = r
+       e[:hit] = e[:range].include?(@query_def.range.first+1)
+       e
+    end.each do |p|
+        if p[:display] && !p[:hit]then
+          pl << "#{SLinkWidget.new(:args=>['',(p[:idx]+1).to_s,@query_def.to_h('range', p[:range])]).to_s} "
+        elsif p[:hit] then
+          pl << "<b>#{p[:idx]+1}</b> " 
+        else
+          pl << '... ' unless pl[-4..-1] == '... '
+        end
+    end
    
   return pl
 
-#### The above should be a bit faster that this mab version:
-# return mabtext do
-#  i = 0
-#     (0..(@total_pages-1)).each do |p|
-#      range = i..(i+@rows_per_page-1)
-#         $stderr.puts "#{range.inspect} include? #{@query_def.range.first+1}"
-#       if range.include?(@query_def.range.first+1) then
-#       text((p+1).to_s + " ")
-#      else
-#           Link('', @query_def.to_h('range', range)) { ((p+1).to_s) }
-#           SLink('',(p+1).to_s, @query_def.to_h('range', range))
-#          text " "
-#         end
-#         i+=@rows_per_page
-#      end
-#  end
 end
  
  private
  def erb_template
   <<'ENDTEMPLATE'
  <div class='list'>
- <%= @paginate %>
+ [ <%= @paginate %> ]
  <table width>
     <tr>
 
@@ -181,10 +180,12 @@ end
       </tr>
       </form>
 
-      <% @data.each do |row| %>
+      <% @additional_data ||= [] %>
+      <% @data.each_index do |row_idx| %>
       <tr>
-           <% row.each_index do |field_idx| %>
-              <td> <%= rewrite_field(row, @columns[field_idx][:id], row[field_idx]) %> </td>
+           <% @data[row_idx].each_index do |field_idx| %>
+              <% add_data = @additional_data[row_idx] || nil %>
+              <td> <%= rewrite_field(@data[row_idx], @columns[field_idx][:id], @data[row_idx][field_idx], add_data) %> </td>
            <% end %>
       </tr>
       <% end %>
@@ -195,35 +196,3 @@ ENDTEMPLATE
  
 end
 
-
-# This was the old markaby template for the listwidget. I find it less readable so will not
-# continue working on it.
-#
-#
-#   mab {
-#     div.list do
-#     text @paginate
-#     table do
-#         tr do
-#            @columns.each { |c| td { @query_def.order_by == c[:id] ? text(c[:display]) : Link('', @query_def.to_h('order_by',
-#          end
-#         form(:name=>"#{@list_name}_form", :method=>'POST') do
-#           tr do
-#              @columns.each { |c|
-#                                td {    @ftag = "#{@list_name}_filter_#{c[:id]}"
-#                                        input(:type => 'text', :name => @ftag, :value => @query_def.filters[c[:id]])
-#                                        input(:type=>'submit',:value=>'ok') if (@columns.last[:id] == c[:id])
-#                                   }
-#                            }
-#           end
-#         end
-#         @data.each do |row|
-#              tr do
-#                     row.each_index do |field_idx|
-#                           td { text rewrite_field(row, @columns[field_idx][:id], row[field_idx]) }
-#                     end
-#              end
-#          end # data.each
-#      end  # table.do
-#      end # div.list
-#    } #mab

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

@@ -63,7 +63,7 @@ class QueryDef
 
    #getter 
    if (ATTRIBS.include?(met)) then
-     return @data[met] || ATTRIBS_DEFAULTS[met].dup
+     return @data[met] || @attribs_defaults[met].dup
    end
  
    #setter
@@ -94,7 +94,7 @@ class QueryDef
         return ATTRIBS_DECODE[name].call(value)
      rescue
 #        $stderr.puts "Decoding failed: #{name} - #{value}: #{$!}"
-        return ATTRIBS_DEFAULTS[name].dup
+        return @attribs_defaults[name].dup
      end
    else
      return value
@@ -140,7 +140,7 @@ class QueryDef
      if v then 
        @data[a] = ev_dec(a,v)
      else
-       @data[a] = ATTRIBS_DEFAULTS[a].dup
+       @data[a] = @attribs_defaults[a].dup
      end
 #     $stderr.puts "\n*** ENDFROM_PARAMS: #{@data.inspect}"
    end
@@ -162,7 +162,8 @@ class QueryDef
    return self
  end
 
- def initialize(list_name)
+ def initialize(list_name, default_attribs = {})
+  @attribs_defaults = ATTRIBS_DEFAULTS.merge(default_attribs)
   @list_name = list_name 
   @data = {}
  end