aurita-gui 0.1.0 → 0.1.5

data/aurita-gui.gemspec

@@ -14,7 +14,7 @@ as stand-alone library in any context (such as rails).
 As there seems to be a lack of ruby form generators, i decided to release this 
 part of Aurita in a single gem with no dependencies. 
   EOF
-  s.version = '0.1.0'
+  s.version = '0.1.5'
   s.author = 'Tobias Fuchs'
   s.email = 'fuchs@atomnode.net'
   s.date = Time.now

data/lib/aurita-gui/form/boolean_field.rb

@@ -0,0 +1,18 @@
+
+require('aurita-gui/form/options_field')
+
+module Aurita
+module GUI
+
+  # Convenience configuration of Checkbox_Field. 
+  # Renders one checkbox with :options => [1]
+  class Boolean_Field < Checkbox_Field
+    def initialize(params, &block)
+      params[:options] = [ 1 ]
+      super(params, &block)
+    end
+  end
+  
+end
+end
+

data/lib/aurita-gui/form/hidden_field.rb

@@ -26,6 +26,9 @@ module GUI
     def element
       HTML.input(@attrib)
     end
+    def readonly_element
+      element()
+    end
   end
 
   class Form < Element

data/lib/aurita-gui/form/options_field.rb

@@ -46,34 +46,125 @@ module GUI
   #   select[4] = { 5 => 'fifth' }
   #
   # 
+  # == Setting option values and labels
+  #
+  # There are a zillion ways to set option values and labels. 
+  # The following examples all use Select_Field, but this
+  # behaviour applies to all derivates of Options_Field. 
+  # 
+  # If there are no option labels set, 
+  # option values will be displayed directly: 
+  #
+  #   s1 = Select_Field.new(:name => :test, 
+  #                         :label => 'Priority', 
+  #                         :options => (1..10)) # Option labels are 0..10
+  # 
+  # Set option values and labels at once using a hash: 
+  #
+  #   s1 = Select_Field.new(:name => :test, 
+  #                         :label => 'Pick one', 
+  #                         :options => { 1 => 'eins', 2 => 'zwei', 3 => 'drei' })
+  # 
+  # Set option values as array, labels as hash: 
+  #
+  #   s1 = Select_Field.new(:name => :test, 
+  #                         :label => { 'Pick one' => [ 'foo', 'bar', 'wombat' ] }, 
+  #                         :options => [ 1,2,3 ])
+  # Same as 
+  #
+  #   s1 = Select_Field.new(:name => :test, 
+  #                         :label => 'Pick one', 
+  #                         :option_labels => [ 'foo', 'bar', 'wombat' ], 
+  #                         :options => [ 1,2,3 ] )
+  # Ranges are ok, too: 
+  #
+  #   s1 = Select_Field.new(:name => :test, 
+  #                         :label => 'Pick one', 
+  #                         :option_labels => [ 'foo', 'bar', 'wombat' ], 
+  #                         :options => (1..3))
+  # 
+  # Change option labels using an array. 
+  # Option labels will be assigned in order, 
+  # so options[0] has label[0] etc.
+  #
+  #   s1.option_labels = [ 'first', 'second', 'third' ]
+  # 
+  # Change option labels using a hash. 
+  # Compared to using an array, this is useful 
+  # in case you don't know the order of option 
+  # values. 
+  #
+  #   s1.option_labels = { 1 => 'ras', 2 => 'dwa', 3 => 'tri' }
+  # 
+  # Overwriting the labels field does the same, 
+  # but this way, you also can change the 
+  # field label: 
+  #
+  #   s1.label = { 'Select one' => [ 'foo', 'bar', 'wombat' ] }
+  #
+  # Or
+  #
+  #   s1.label = { 'Select one' => { 1 => 'foo', 2 => 'bar', 3 => 'wombat' } }
+  # 
+  # Of yourse you can replace all option values 
+  # and their labels at once by overwriting 
+  # the options field: 
+  #
+  #   s1.label = 'Choose'
+  #   s1.options = { 1 => :foo, 2 => :bar, 3 => :wombat }
   #
   class Options_Field < Form_Field
 
-    attr_accessor :options, :options_range, :options_labels, :value
+    attr_accessor :options, :options_range, :option_labels, :value
 
     def initialize(params, &block)
-      @options          = params[:options]
-      @options_range    = params[:options_range]
-      @options_labels   = params[:options_labels]
-      @options        ||= {}
-      @options_range  ||= []
-      @options_labels ||= []
-      @option_elements  = []
-      @value            = params[:value]
+      @options           = params[:options]
+      @options           = @options.to_a if @options.kind_of? Range
+      @options_range     = params[:options_range]
+      @option_labels     = params[:option_labels]
+      set_option_labels(params[:option_labels]) if params[:option_labels]
+      @option_labels   ||= []
+      @options         ||= {}
+      @options_range   ||= []
+      @option_elements ||= []
+      @value             = params[:value]
+
       if block_given? then
         yield.each { |option|
           add_option(option)
         }
-      elsif params[:options] then
+      elsif params[:options] and !params[:option_labels] then
         add_option(params[:options])
       end
       params.delete(:options)
-      params.delete(:value) # Value is determined via selected value
+      # Option fields don't have a value attribute themselves
+      params.delete(:value) 
       params.delete(:options_range)
-      params.delete(:options_labels)
+      params.delete(:option_labels)
       super(params)
     end
 
+    def option_labels=(labels)
+      @option_labels = labels
+      renamed_options = {}
+      if @options.kind_of? Hash then
+        index = 0
+        @options.each_pair { |value,label|
+          renamed_options[value] = labels[value]
+          index += 1
+        }
+      elsif @options.kind_of? Array then
+        index = 0
+        @options.each { |value|
+          renamed_options[value] = labels[index]
+          index += 1
+        }
+      end
+      @options = renamed_options
+      @option_elements = [ @options ]
+    end
+    alias set_option_labels option_labels=
+
     def add_option(option={})
       if option.kind_of? Array then
         @option_elements += option

data/lib/aurita-gui/form/select_field.rb

@@ -28,6 +28,11 @@ module GUI
         option_elements()
       } 
     end
+    def readonly_element
+      HTML.div(@attrib) { 
+        @options[@value]
+      }
+    end
   end
   
 end

data/test/tc_options.rb

@@ -0,0 +1,59 @@
+
+require('rubygems')
+require('aurita-gui')
+
+include Aurita::GUI
+
+# If there are no option labels set, 
+# option values will be displayed directly: 
+s1 = Select_Field.new(:name => :test, 
+                      :label => 'Priority', 
+                      :options => (1..10))
+
+# Set option values and labels at once using a hash: 
+s1 = Select_Field.new(:name => :test, 
+                      :label => 'Pick one', 
+                      :options => { 1 => 'eins', 2 => 'zwei', 3 => 'drei' })
+
+# Set option values as array, labels as hash: 
+s1 = Select_Field.new(:name => :test, 
+                      :label => { 'Pick one' => [ 'foo', 'bar', 'wombat' ] }, 
+                      :options => [ 1,2,3 ])
+# Same as 
+puts '----------------------'
+s1 = Select_Field.new(:name => :test, 
+                      :label => 'Pick one', 
+                      :option_labels => [ 'foo', 'bar', 'wombat' ] , 
+                      :options => [ 1..3 ] )
+puts '----------------------'
+puts s1
+# Ranges are ok, too: 
+s1 = Select_Field.new(:name => :test, 
+                      :label => 'Pick one', 
+                      :option_labels => [ 'foo', 'bar', 'wombat' ], 
+                      :options => (1..3) )
+
+# Change option labels using an array. 
+# Option labels will be assigned in order, 
+# so options[0] has label[0] etc.
+s1.option_labels = [ 'first', 'second', 'third' ]
+
+# Change option labels using a hash. 
+# Compared to using an array, this is useful 
+# in case you don't know the order of option 
+# values. 
+s1.option_labels = { 1 => 'ras', 2 => 'dwa', 3 => 'tri' }
+
+# Overwriting the labels field does the same, 
+# but this way, you also can change the 
+# field label: 
+s1.label = { 'Select one' => [ 'foo', 'bar', 'wombat' ] }
+# Or
+s1.label = { 'Select one' => { 1 => 'foo', 2 => 'bar', 3 => 'wombat' } }
+
+# Of yourse you can replace all option values 
+# and their labels at once by overwriting 
+# the options field: 
+s1.label = 'Choose'
+s1.options = { 1 => :foo, 2 => :bar, 3 => :wombat }
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aurita-gui
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors: 
 - Tobias Fuchs
@@ -44,12 +44,14 @@ files:
 - lib/aurita-gui/form/form_field.rb
 - lib/aurita-gui/form/textarea_field.rb
 - lib/aurita-gui/form/datetime_field.rb
+- lib/aurita-gui/form/boolean_field.rb
 - lib/aurita-gui/form/fieldset.rb
 - lib/aurita-gui/form/select_field.rb
 - lib/aurita-gui/form/radio_field.rb
 - lib/aurita-gui/form/hidden_field.rb
 - lib/aurita-gui/form/input_field.rb
 - lib/aurita-gui/form/date_field.rb
+- test/tc_options.rb
 - test/tc_table.rb
 - test/tc_form.rb
 has_rdoc: true