kiss 0.9.4 → 1.0

data/lib/kiss/form.rb

@@ -1,3 +1,5 @@
+module Digest; end
+
 class Kiss
   class Form
     module AttributesSetter
@@ -77,53 +79,50 @@ class Kiss
       @fields << :section_break
     end
     
-    # Creates and adds a field to the form, according to specified attributes.
-    def add_field(attrs)
-      raise "added second field named '#{attrs[:name]}'; field names must be unique" if @fields_hash[attrs[:name]]
+    def create_field(attrs)
+      raise "form already has field named '#{attrs[:name]}'" if @fields_hash[attrs[:name]]
       
       attrs[:type] ||= :text
       type = attrs[:type].to_sym
-      unless @@field_types.has_key?(type)
-        type = attrs[:type] = :text
-      end
-      
-      @has_required_fields ||= attrs[:required]
+      type = attrs[:type] = :text unless @@field_types.has_key?(type)
       
       field_class = @@field_types[type]
-      field = field_class.new(attrs)
+      field = field_class.new(self,attrs)
       
       field_name = field.name.to_s
       field.form = self
       
-      unless type == :submit
-        @fields << field
-        @fields_hash[field_name] = field
+      while true
+        other_field = field.other_field
+        break unless other_field
+        other_field.form = self
+        @other_field = @form.create_field( { :name => @name + '.other' }.merge(@other) )
       end
       
+      @fields_hash[field_name] = field
+      
       @enctype = 'multipart/form-data' if field.type == :file
       
-      # if param submitted, set value of field to match
-      if (param = @params[field_name])
-        field.value = param
-      elsif @object && !attrs.has_key?(:value)
-        value = @object[field_name.to_sym] || @object[field_name]
+      field
+    end
+    
+    # Creates and adds a field to the form, according to specified attributes.
+    def add_field(attrs)
+      # create field
+      field = create_field(attrs)
+      
+      # used with mark_required to display required fields legend
+      @has_required_fields ||= attrs[:required]
       
-        case field.format
-        when :date:
-          field.value = value ? value.strftime("%m/%d/%Y") : ''
-        when :datetime:
-          field.value = value ? value.strftime("%m/%d/%Y %I:%M%p") : ''
-        else
-          field.value = value.to_s
-        end
-      end
+      # add field to form array/hash
+      @fields << field
       
       field
     end
     
     # Creates and adds set of submit buttons to the form, per specified attributes.
     def add_submit(attrs)
-      @submit = add_field({
+      @submit = create_field({
         :type => :submit,
         :name => 'submit',
         :save => false
@@ -131,13 +130,13 @@ class Kiss
     end
     
     # Gets hash of form values ready to be saved to Sequel::Model object.
-    def sequel_values
-      @sequel_values ||= begin
-        hash = {}
-        @fields.each {|field| hash[field.name] = field.sequel_value unless field == :section_break }
-        hash
-      end
-    end
+    # def sequel_values
+    #   @sequel_values ||= begin
+    #     hash = {}
+    #     @fields.each {|field| hash[field.name] = field.sequel_value unless field == :section_break }
+    #     hash
+    #   end
+    # end
     
     # Gets hash of form values.
     def values
@@ -194,9 +193,13 @@ class Kiss
     		# don't save 'ignore' fields to the database
         next if field.ignore || !field.save
         
-        object[field.name.to_sym] = field.sequel_value
+        value = (field.value != nil || object.class.db_schema[field.name.to_sym].allow_null) ?
+          field.value : (object.class.db_schema[field.name.to_sym][:default] ||= field.format.default)
+        
+        object[field.name.to_sym] = field.save == true ? value :
+          (digest_class = Kiss.digest_class(field.save)) ? digest_class.hexdigest(value) : value
       end
-    
+      
       object.save
     end
     
@@ -211,7 +214,7 @@ class Kiss
     # and returns true.  Otherwise, returns false.
     def process(object = @object)
       return false unless submitted
-    
+      
       if accepted
         validate
         return false if has_errors
@@ -233,7 +236,7 @@ class Kiss
     def errors_html
       return nil unless has_errors
       
-      @errors << "Please remedy the errors shown below." if @has_field_errors
+      @errors << "Please correct the errors highlighted below." if @has_field_errors
       
       if @errors.size == 1
         content = @errors[0]
@@ -244,7 +247,7 @@ class Kiss
       @errors.pop if @has_field_errors
       
       plural = @errors.size > 1 || @has_field_errors ? 's' : nil
-      %Q(<table border=0 cellspacing=0><tr class="kiss_error"><th>Error#{plural}</th></td><td class="kiss_required"></td><td>#{content}</td></tr></table>)
+      %Q(<div class="kiss_error">#{content}</div><br clear="all" />)
     end
     
     # Renders current action using form's HTML as action render content.
@@ -266,74 +269,71 @@ class Kiss
       # style tag
       styles = []
       styles.push( <<-EOT
-.kiss_form table {
+table.kiss_form {
   margin-bottom: 6px;
 }
 .kiss_form td {
   padding: 2px 4px;
+  vertical-align: middle;
 }
-.kiss_form tr.kiss_error {
+.kiss_form .kiss_error {
   background-color: #ff8;
-}
-.kiss_form tr.kiss_error th {
-  vertical-align: top;
-  padding: 2px 4px 3px 4px;
-  text-align: right;
-  background-color: #fc7;
+  padding: 2px 4px;
+  line-height: 135%;
+  float: left;
   color: #900;
-  border: 1px solid #f96;
-  border-right: none;
-}
-.kiss_form tr.kiss_error td {
-  vertical-align: top;
-  padding: 2px 6px 3px 6px;
-  border: 1px solid #f96;
-  border-left: none;
-  color: #000;
+  border: 1px solid #ea4;
+  margin-bottom: 4px;
 }
-.kiss_form tr.kiss_error ul {
+.kiss_form .kiss_error ul {
   padding-left: 16px;
   margin: 0;
 }
-.kiss_form tr.kiss_error td.kiss_required {
-  padding: 0;
-  border-right: none;
-}
 .kiss_form .kiss_help {
-  padding: 0px 3px 8px 6px;
+  padding: 0px 3px 0 6px;
   font-size: 90%;
   color: #555;
 }
-.kiss_form td.kiss_required {
-  padding: 2px 0px;
-  color: #c00;
+.kiss_required {
+  color: #a21;
+  font-size: 150%;
+  line-height: 50%;
+  position: relative;
+  top: 4px;
 }
 .kiss_form td.kiss_label {
   text-align: right;
   white-space: nowrap;
 }
+.kiss_form td.kiss_label.error {
+  color: #b10;
+}
 .kiss_form tr.kiss_prompt td {
-  padding: 8px 3px 2px 4px;
+  padding: 8px 3px 0px 4px;
 }
 .kiss_form tr.kiss_submit td.kiss_submit {
   padding: 6px 3px;
 }
-.kiss_form input[type="text"],.kiss_form textarea {
+.kiss_form input[type="text"],.kiss_form input[type=password],.kiss_form textarea {
   width: 250px;
+  margin-left: 0;
+  margin-right: 0;
 }
 EOT
       )
       styles.push( <<-EOT
 .kiss_form_error_message {
-  padding: 1px 4px 2px 4px;
-  border: 1px solid #f96;
+  padding: 1px 4px;
+  border: 1px solid #edc;
+  border-top: 0;
+  border-bottom: 1px solid #db4;
   background-color: #ff8;
   color: #900;
-  font-size: 85%;
+  font-size: 90%;
+  line-height: 135%;
   display: block;
   float: left;
-  margin-top: 1px;
-  
+  margin-bottom: 2px;
 }
 .kiss_form_error_message div {
   color: #c00;
@@ -343,6 +343,21 @@ EOT
   padding-left: 16px;
   margin: 0;
 }
+tr.kiss_form_error_row td {
+  padding-top: 0;
+}
+tr.kiss_form_error_row .kiss_form_error_message {
+  position: relative;
+  top: -2px;
+  margin-bottom: 0;
+}
+.kiss_form table.kiss_field_columns {
+  border-spacing: 0;
+  border-collapse: collapse;
+}
+.kiss_form table.kiss_field_columns td {
+  padding: 0 0 2px 0;
+}
 EOT
       ) if @error_class == 'kiss_form_error_message'
       style_tag = styles.size == 0 ? '' : "<style>" + styles.join('') + "</style>"
@@ -367,8 +382,8 @@ EOT
     
     # Renders open of form table.
     def table_html_open
-      %Q(<table border=0 cellspacing=0>) +
-        (@has_required_fields && @mark_required ? %Q( <tr><td></td><td class="kiss_required">*</td><td colspan=2 class="kiss_help">Required field.</td></tr> ) : '')
+      %Q(<table class="kiss_form" border=0 cellspacing=0>) +
+        (@has_required_fields && @mark_required ? %Q( <tr><td></td><td class="kiss_help">Required fields marked by <span class="kiss_required">*</span></td></tr> ) : '')
     end
     
     # Renders close of form table.
@@ -378,7 +393,7 @@ EOT
     
     # Renders form submit buttons.
     def submit_html
-      field_html(@submit)
+      @submit ? field_html(@submit) : ''
     end
     
     # Renders complete form HTML.
@@ -396,19 +411,23 @@ EOT
     # Renders HTML for specified form field.
     def field_html(field)
       type = field.type
-      prompt = field.prompt.to_s
-      label = field.label.to_s
+      prompt = field.prompt
+      label = field.label
+      errors = field.errors_html
+      required = field.required ? %Q(<span class="kiss_required">#{@mark_required}</span> ) : ''
       
-      [
-    	  (prompt != '' ? %Q(<tr class="kiss_prompt"><td colspan=2></td><td colspan=2>#{prompt}</td></tr>) : ''),
-    		"",
-        %Q(<tr class="kiss_#{type}"><td class="kiss_label">),
-        label != '' && prompt == '' ? label + ':' : '',
-        '</td><td class="kiss_required">',
-        field.required ? @mark_required : '',
+      ([
+    	  prompt ? %Q(<tr class="kiss_prompt"><td class="kiss_label">#{required}</td><td>#{prompt.to_s}</td></tr>) : '',
+    	  
+        %Q(<tr class="kiss_#{type}"><td class="kiss_label#{errors ? ' error' : ''}">),
+        !prompt ? (required + (label ? label.to_s + ':' : '' )) : '',
     	  %Q(</td><td class="kiss_#{type}">),
-    		field.html, "</td></tr>"
-    	].join
+    		field.element_html, "</td></tr>"
+    	] + (errors ? [
+    	  '<tr class="kiss_form_error_row"><td class="kiss_required"></td><td>',
+    	  errors,
+    	  '</td></tr>'
+    	] : [])).join
     end
   end
 end

data/lib/kiss/form/field.rb

@@ -1,20 +1,58 @@
 class Kiss
   class Form
     class Field
-      attr_accessor :name,:type,:form,:format,:currency,:label,:no_label,:prompt,:value,:ignore,:save,
-        :options,:options_value_key,:options_display_key,:required,:cancel,:columns,:style,:hidden_join
+      
+      attr_accessor :name,:type,:form,:currency,:label,:no_label,:prompt,:value,:ignore,:save,
+        :options,:options_value_key,:options_display_key,:required,:cancel,:columns,:style,:hidden_join,
+        :html,:other,:other_field,:object,:format,:display_format
       
       include Kiss::Form::AttributesSetter
   
-      def initialize(attrs)
+      def initialize(form,attrs)
+        @form = form
         @save = true
-        @value = ''
+        @currency = nil
+        
+        set_attributes({
+          :type => :text,
+          :object => @form.object,
+          :save => true
+        }.merge(attrs))
+        
+        @value = (@object[@name.to_sym] if @object) || @value
         
-        set_attributes(attrs,[:name,:type])
+        @format = Kiss::Format.lookup(@format)
+        @display_format = Kiss::Format.lookup(@display_format)
+        
+        @currency = '$' if @currency == :dollars
         
         @errors = []
       end
       
+      def other_field_html
+        return '' unless @other
+        
+        other_checked = @value && !option_pairs.any? {|v,d| v == @value }
+        
+        (@columns ? '<br/>' : '&nbsp; ') + [
+          input_tag_html(
+            { :value => 'other', :html => { :id => @name+'.other' } },
+            other_checked ? 'checked' : ''
+          ),
+          @other[:label] || 'Other',
+          ': ',
+          @currency.to_s,
+          input_tag_html({
+            :type => :text,
+            :name => @name+'.other',
+            :value => other_checked ? value_to_s(@value) : nil,
+            :html => {
+              :onfocus => "document.getElementById('#{@name}.other').checked = true"
+            }
+          }.merge(@other))
+        ].join
+      end
+      
       def column_layout(elements_html)
         if @columns
           # format elements into cells
@@ -28,50 +66,76 @@ class Kiss
     	    return ['<table class="kiss_field_columns">',element_ranges.map do |range|
     	      ["<tr>", elements_html[range], "</tr>"]
     	    end,'</table>'].flatten.join
-          join_with = ''
-        else
-          join_with = '&nbsp; '
         end
-    
+        
         # else columns <= 1
-        elements_html.join(join_with)
+        elements_html.join('&nbsp; ')
       end
       
-      def sequel_value
-        case @format
-        when :date:
-          return Kiss.mdy_to_ymd(value)
-        when :datetime:
-          datetime = value.sub(/([ap]m)\s*\Z/i,' \1')
-          date, time, ampm = datetime.split(/\s+/)
-          
-          hours, minutes = time.split(/:/)
-          hours = 0 if hours.to_i == 12 && ampm
-          if (ampm.downcase == 'pm')
-            hours = hours.to_i + 12
-          end
-          
-          return Kiss.mdy_to_ymd(date) + " #{hours}:#{minutes}"
-        else
-          return value.is_a?(Array) ? value.map {|v| v.gsub(/,/,'\,')}.join(',') : value
-        end
+      # def sequel_value
+      #   case @format
+      #   when :date:
+      #     return Kiss.mdy_to_ymd(value)
+      #   when :datetime:
+      #     datetime = value.sub(/([ap]m)\s*\Z/i,' \1')
+      #     date, time, ampm = datetime.split(/\s+/)
+      #     
+      #     hours, minutes = time.split(/:/)
+      #     hours = 0 if hours.to_i == 12 && ampm
+      #     if (ampm.downcase == 'pm')
+      #       hours = hours.to_i + 12
+      #     end
+      #     
+      #     return Kiss.mdy_to_ymd(date) + " #{hours}:#{minutes}"
+      #   when :month_year:
+      #     month, year = value.sub(/\A\s*/,'').sub(/\s*\Z/,'').split(/\D+/)
+      #     # convert two-digit years to four-digit years
+      #     year = year.to_i
+      #     if year < 100
+      #       year += 1900
+      #       year += 100 if year < Time.now.year - 95
+      #     end
+      #     return sprintf("%04d-%02d-01",year,month.to_i)
+      #   else
+      #     return value.is_a?(Array) ? value.map {|v| v.gsub(/,/,'\,')}.join(',') : value
+      #   end
+      # end
+      
+      def param
+        @param ||= @form.params[@name.to_s]
       end
       
       def value
-        @value ||= @form.params[@name]
+        @value
       end
       
       def add_error(message)
         @errors << message
         @form.has_field_errors = true
       end
-  
-      def validate
-        if (error = Kiss.validate_value(value,@format,@required))
-          add_error("#{@label} #{error}")
+      
+      def value_to_s(value)
+        value ? @format.value_to_s(value) : ''
+      end
+      
+      def display_to_s(value)
+        value ? @display_format.value_to_s(value) : ''
+      end
+      
+      def validate(enter = 'enter')
+        if @required && (param !~ /\S/)
+          # value required
+          add_error("Please #{enter} #{@label}")
+          return
+        end
+        
+        begin
+          @value = @format.validate(param)
+        rescue Kiss::Format::ValidateError => e
+          add_error("#{e.message.capitalize}")
         end
         
-        value
+        @value
       end
       
       def errors_html
@@ -87,33 +151,62 @@ class Kiss
       end
       
       def element_html
-        if @currency == :dollars
-          return '$' + input_tag_html( :value => @value, :style => 'width: 80px' )
+        attrs = { :value => param || value_to_s(@value) }
+        if width = @format.input_width
+          attrs[:style] = "width: #{width}px"
         end
-        input_tag_html( :value => @value )
+        
+        @currency.to_s + input_tag_html( attrs ) +
+          ((legend = @format.legend) ? " <small>(#{legend})</small>" : '')
       end
       
       def html
         errors = errors_html
-        element_html + (errors ? %Q(<br/>#{errors}) : '')
+        element_html + (errors ? (@columns ? '' : '<br/>') + %Q(#{errors}) : '')
       end
-  
-      def input_tag_html(attrs = {}, extra_html = '')
+      
+      def tag_start_html(tag_name, attrs = {}, extra_html = nil)
         attrs = attrs.clone
         attrs[:name] ||= @name
-        attrs[:type] ||= @type
-        attrs[:style] ||= @style
+        attrs[:size] ||= @size if @size
+        attrs[:style] ||= @style if @style
         
-        attrs_html = []
-        attrs.each_pair {|k,v| attrs_html.push %Q(#{k}="#{v}") }
-        [ '<input', attrs_html, extra_html + '/>' ].flatten.join(' ')
+        html_parts = ["<#{tag_name}"]
+        
+        html = attrs.delete(:html) || @html
+        attrs.each_pair {|k,v| html_parts.push %Q(#{k}="#{v}") }
+        
+        if html
+          if html.is_a?(Hash)
+            html.each_pair {|k,v| html_parts.push %Q(#{k}="#{v}") }
+          else
+            html_parts.push(@html.to_s)
+          end
+        end
+        
+        html_parts.push(extra_html) if extra_html
+        html_parts.join(' ')
+      end
+      
+      def tag_html(tag_name, attrs = {}, extra_html = nil)
+        tag_start_html(tag_name,attrs,extra_html) + ' />'
+      end
+      
+      def content_tag_html(tag_name, content, attrs = {}, extra_html = nil)
+        tag_start_html(tag_name,attrs,extra_html) + ">#{content}</#{tag_name}>"
+      end
+      
+      def input_tag_html(attrs = {}, extra_html = nil)
+        tag_html(
+          'input',
+          {:type => @type}.merge(attrs),
+          extra_html
+        )
       end
     end
 
-    class HiddenField < Field
-    end
-    class TextField < Field
-    end
+    class HiddenField < Field; end
+    class TextField < Field; end
 
     class TextAreaField < Field
       attr_accessor :rows,:cols
@@ -123,8 +216,16 @@ class Kiss
         @cols = 20
         super(*args)
       end
+      
       def element_html
-        %Q(<textarea name="#{@name}" rows="#{@rows ||= 1}" cols="#{@cols ||= 1}" style="#{@style ||= ''}">#{@value}</textarea>)
+        content_tag_html(
+          'textarea',
+          param || value_to_s(@value),
+          {
+            :rows => @rows ||= 1,
+            :cols => @cols ||= 1
+          }
+        )
       end
     end
 
@@ -136,7 +237,7 @@ class Kiss
 
     class BooleanField < Field
       def element_html
-        input_tag_html({ :value => 1 }, @value ? 'CHECKED ' : '')
+        input_tag_html({ :value => 1 }, @value ? 'checked' : '')
       end
     end
 
@@ -164,14 +265,9 @@ class Kiss
         elements_html.join(' ')
       end
       
-      def validate
-        # do nothing for now
-        value
-      end
-      
       def elements_html
         @options.map do |option|
-          input_tag_html({ :value => option })
+          input_tag_html({ :value => value_to_s(option) })
         end
       end
     end
@@ -180,13 +276,12 @@ class Kiss
 
     class MultiChoiceField < Field
       def option_pairs
-        if (defined? @options_value_key)
-          # options_display_map not supported
-          # default to options_display_key
-          return @options.map {|option| [ option[@options_value_key], option[@options_display_key] ]}
-        end
-    
-        @options.map {|option| [ option, option ] }
+        (defined? @options_value_key) ?
+          @options.map {|option| [ option[@options_value_key], option[@options_display_key] ]} :
+          begin
+            @display_format = @format
+            @options.map {|option| [ option, option ] }
+          end
       end
   
       def matched_options(value)
@@ -197,12 +292,13 @@ class Kiss
       end
   
       def validate
-        @value = @form.params[@name]
+        if @other && param == 'other'
+          @param = @form.params[@name+'.other']
+        end
+        super('select')
         
-        if (@value =~ /\S/)
-          add_error "#{@label} invalid" unless matched_options(@value).size > 0
-        elsif @required
-          add_error "#{@label} required"
+        if @value =~ /\S/ && matched_options(@value).size == 0
+          add_error "Invalid selection" 
         end
       end
     end
@@ -215,21 +311,24 @@ class Kiss
         
         options_html = option_pairs.map do |value,display|
           selected = (@value.to_s == value.to_s) ? ' selected' : ''
-          %Q(<option value="#{value}"#{selected}>#{display}</option>)
-        end
-    
-        [%Q(<select name="#{@name}" style="#{@style}">), placeholder_html, options_html, '</select>'].flatten.join
+          %Q(<option value="#{value_to_s(value)}"#{selected}>#{display}</option>)
+        end.join
+        
+        content_tag_html('select', placeholder_html + options_html) + other_field_html
       end
     end
 
     class RadioField < MultiChoiceField
       def element_html
-        column_layout(elements_html)
+        column_layout(elements_html) + other_field_html
       end
   
       def elements_html
-        return option_pairs.map do |value,display|
-          input_tag_html({ :value => value }, (@value.to_s == value.to_s) ? ' checked' : '' ) + display
+        option_pairs.map do |value,display|
+          input_tag_html(
+            { :value => value_to_s(value) },
+            (@value.to_s == value.to_s) ? 'checked' : ''
+          ) + @currency.to_s + display_to_s(display)
         end
       end
     end
@@ -238,18 +337,27 @@ class Kiss
     # ------ MultiValueField
 
     class MultiValueField < MultiChoiceField
+      def param
+        @form.params[@name.to_s+'[]'] || []
+      end
+      
       def validate
-        @value = @form.params[@name.to_s+'[]'] || []
-    
+        begin
+          @value = param.map { |p| @format.validate(p) }
+        rescue Kiss::Format::ValidateError => e
+          add_error("#{e.message.capitalize}")
+          return
+        end
+        
         if @value.size > 0
-          @value.each do |value|
-            unless (matched_options(value).size > 0)
-              add_error "Invalid selection for #{@label}"
+          @value.each do |v|
+            unless (matched_options(v).size > 0)
+              add_error "#Invalid selection"
               return
             end
           end
         elsif @required
-          add_error "#{@label} required"
+          add_error "Please select at least one #{@label}"
         end
       end
   
@@ -260,21 +368,22 @@ class Kiss
 
     class CheckboxField < MultiValueField
       def element_html
-        if @hidden_join
-          hidden_options = input_tag_html(
-            :type => 'hidden',
-            :name => "#{@name}_options",
-            :value => option_pairs.map {|v,d| v}.join(@hidden_join)
-          )
-        else
-          hidden_options = ''
-        end
-        column_layout(elements_html) + hidden_options
+        hidden_options = @hidden_join ? input_tag_html(
+          :type => 'hidden',
+          :name => "#{@name}_options",
+          :value => option_pairs.map {|v,d| value_to_s(v) }.join(@hidden_join)
+        ) : ''
+        
+        column_layout(elements_html) + other_field_html + hidden_options
       end
       
       def elements_html
-        return option_pairs.map do |value,display|
-          input_tag_html({ :name => @name.to_s+'[]', :value => value }, selected_option_values[value.to_s] ? ' checked' : '' ) + display.to_s
+        name = @name.to_s+'[]'
+        option_pairs.map do |value,display|
+          input_tag_html(
+            { :name => name, :value => value_to_s(value) },
+            selected_option_values[value.to_s] ? 'checked' : ''
+          ) + @currency.to_s + display_to_s(display)
         end
       end
     end
@@ -283,10 +392,15 @@ class Kiss
       def element_html
         options_html = option_pairs.map do |value,display|
           selected = selected_option_values[value] ? ' selected' : ''
-          %Q(<option value="#{value}"#{selected}>#{display}</option>)
-        end
-    
-        [%Q(<select multiple name="#{@name}[]" size="#{@size}" style="#{@style}">), options_html, '</select>'].flatten.join
+          %Q(<option value="#{value_to_s(value)}"#{selected}>#{display}</option>)
+        end.join
+        
+        content_tag_html(
+          'select',
+          options_html,
+          {},
+          'multiple'
+        )
       end
     end
   end