aurita-gui 0.1.6 → 0.2.0

data/History.txt

@@ -1,3 +1,14 @@
+=== 0.2.0 / 2009-01-12
+
+* Added magic: 
+
+   HTML.div { 
+     ul(:class => :list) { 
+       li { 'first' }
+       li { 'second' }
+     }
+   }
+
 === 0.1.0 / 2009-01-07
 
 * First commit. 

data/TODO

@@ -0,0 +1,4 @@
+
+- Implement <fieldset>
+- Implement <optgroup>
+

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.6'
+  s.version = '0.2.0'
   s.author = 'Tobias Fuchs'
   s.email = 'fuchs@atomnode.net'
   s.date = Time.now
@@ -29,7 +29,7 @@ part of Aurita in a single gem with no dependencies.
 
   s.has_rdoc = true
   s.rdoc_options << '--title' << 'Aurita::GUI' <<
-                    '--main' << 'Aurita::GUI::HTML' <<
+                    '--main' << './cheatsheet.rb' <<
                     '--line-numbers'
 
   s.homepage = 'http://aurita.wortundform.de/'

data/cheatsheet.rb

@@ -0,0 +1,112 @@
+
+require('rubygems')
+require('aurita-gui')
+require('test/unit/assertions')
+
+include Test::Unit::Assertions
+
+include Aurita::GUI
+
+#== The basics
+
+# This is the most convenient way to build 
+# HTML using aurita-gui. 
+# (Thanks to oGMo for demanding more magic)
+t1 = HTML.build { 
+  div(:class => :css_class, 
+      :onmouseover => "do_something_with(this);") { 
+    ul(:id => :the_list) { 
+      li(:class => :first) { 'foo' } +
+      li(:class => :second) { 'bar' } +
+      li(:class => :third) { 'batz' }
+    }
+  }
+}
+puts t1.to_s
+puts '-----------------------------------------'
+
+# The previous example effectively does the 
+# following: 
+t2 = HTML.div(:class => :css_class, 
+              :onmouseover => "do_something_with(this);") { 
+  HTML.ul(:id => :the_list) { 
+    [ 
+      HTML.li(:class => :first) { 'foo' }, 
+      HTML.li(:class => :second) { 'bar' }, 
+      HTML.li(:class => :third) { 'batz' }
+    ]
+  }
+}
+assert_equal(t1.to_s, t2.to_s)
+
+# Element is not a full Enumerable implementation (yet), 
+# but it offers random access operators ...
+
+assert_equal(t1[0].tag, :ul)  # First element of div is <ul>
+
+t1[0][1] = HTML.li(:class => :changed) { 'wombat' }
+puts t1.to_s
+puts '-----------------------------------------'
+
+# ... as well as #each ... 
+
+t1[0].each { |element|
+  element.id = 'each_change'
+}
+
+puts t1.to_s
+
+# ... empty? and length. More to come in future releases. 
+
+assert_equal(t1[0].length, 3) # List has 3 entries
+assert_equal(t1[0].empty?, false) # List has 3 entries
+
+
+#== Form generation
+
+puts '-----------------------------------------'
+form = Form.new(:name   => :the_form, 
+                :id     => :the_form_id, 
+                :action => :where_to_send)
+# You can either set all attributes in the 
+# constructor call ...
+text = Input_Field.new(:name => :description, 
+                       :class => :the_css_class, 
+                       :onfocus => "alert('input focussed');", 
+                       :value => 'some text')
+# Or set them afterwards: 
+text.onblur = "alert('i lost focus :(');"
+
+# Enable / disable: 
+text.disable! 
+text.enable! 
+puts text.to_s
+puts '-----------------------------------------'
+
+# Set an element to readonly mode (display value only): 
+text.readonly! 
+puts text.to_s
+puts '-----------------------------------------'
+# And back to editable mode: 
+text.editable! 
+
+# Add it to the form: 
+form.add(text)
+puts form.to_s
+puts '-----------------------------------------'
+
+# Access it again, via name: 
+assert_equal(form[:description], text)
+# Or by using its index: 
+assert_equal(form[0], text)
+
+# This is useful! 
+form[:description].value = 'change value'
+
+checkbox = Checkbox_Field.new(:name => :enable_me, 
+                              :value => :foo, 
+                              :label => 'Check me', 
+                              :options => [ :foo, :bar ] )
+form.add(checkbox)
+puts form.to_s
+

data/lib/aurita-gui/element.rb

@@ -59,7 +59,8 @@ module GUI
       if block_given? then
         @content = yield
       else
-        @content = params[:content].to_s
+        @content = params[:content]
+        @content = [ @content ] unless @content.kind_of? Array
       end
       params.delete(:content)
       @tag     = params[:tag]
@@ -84,11 +85,17 @@ module GUI
     # Render this element to a string and append another 
     # element. 
     def +(other)
-      return string << other.string if other.kind_of? Element
-      return string << other
+#     return string << other.string if other.kind_of? Element
+      return [ self, other ]
     end
     alias << +
 
+    def to_ary
+      [ self ]
+    end
+    alias to_a to_ary
+
+
     # Redirect methods to setting or retreiving tag 
     # attributes. 
     def method_missing(meth, value=nil)
@@ -113,12 +120,20 @@ module GUI
     end
 
     # Do not redirect random access operators. 
-    def [](a)
-      raise ::Exception.new('Undefined method [] for ' << self.class.to_s)
+    def [](index)
+      return @content[index]
+   #   raise ::Exception.new('Undefined method [] for ' << self.class.to_s)
     end
     # Do not redirect random access operators. 
-    def []=(a,b)
-      raise ::Exception.new('Undefined method []= for ' << self.class.to_s)
+    def []=(index,element)
+      @content[index] = element
+   #  raise ::Exception.new('Undefined method []= for ' << self.class.to_s)
+    end
+    def length
+      @content.length
+    end
+    def empty? 
+      @content.length == 0
     end
 
     # Static helper definition for clearing 
@@ -153,6 +168,10 @@ module GUI
       
     end
     alias to_s string
+
+    def each(&block)
+      @content.each(&block)
+    end
     
   end # class
   

data/lib/aurita-gui/form.rb

@@ -14,6 +14,9 @@ require('aurita-gui/form/textarea_field')
 require('aurita-gui/form/date_field')
 require('aurita-gui/form/datetime_field')
 require('aurita-gui/form/file_field')
+require('aurita-gui/form/boolean_field')
+require('aurita-gui/form/text_field')
+require('aurita-gui/form/password_field')
 
 module Aurita
 module GUI
@@ -25,7 +28,8 @@ module GUI
     def initialize(field)
       label_params = { :for => field.dom_id }
       label_params[:id] = field.dom_id.to_s + '_label' 
-      @content = [ HTML.label(label_params) { field.label }, field ]
+      label = field.label
+      @content = [ HTML.label(label_params) { label }, field ]
       params = { :tag => :li, 
                  :content => @content, 
                  :id => field.dom_id + '_wrap', 
@@ -71,6 +75,7 @@ module GUI
       @element_map  = {}
       @values     ||= {}
       @title        = false
+      @custom_fields = false
       if block_given? then
         yield.each { |e| add(e) }
       end
@@ -139,6 +144,7 @@ module GUI
     #   form.fields = [ :name, :description, :date ]
     #
     def fields=(attrib_array)
+      @custom_fields = true
       @fields = attrib_array.flatten.collect { |fieldname| fieldname.to_s }
       @elements.each { |field|
         @element_map[field.name.to_s] = field
@@ -167,7 +173,7 @@ module GUI
     # Return array of field names currently 
     # available for rendering. 
     def fields()
-      if !@fields || @fields.length == 0 then
+      if !@custom_fields || @fields.length == 0 then
         @elements.each { |field|
           @fields << field.name.to_s
           @element_map[field.name.to_s] = field
@@ -197,14 +203,16 @@ module GUI
           end
         end
       }
-      @content = HTML.ul(:class => :form_fields) { @content }
+      cont = @content
+      @content = HTML.ul(:class => :form_fields) { cont }
       return @content
     end
 
     # Render this form to an HTML.form instance. 
     # Wraps result of #content. 
     def element
-      HTML.form(@attrib) { content() }
+      cont = content()
+      HTML.form(@attrib) { cont }
     end
 
     # Render this form to a string

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

@@ -4,19 +4,43 @@ require('aurita-gui/form/options_field')
 module Aurita
 module GUI
 
+  # Factory for checkbox input fields, specialization 
+  # of Options_Field. 
+  # For usage see documentation of Options_Fiels. 
+  #
   class Checkbox_Field < Options_Field
     def option_elements
       options = []
       @option_elements.each { |option| 
         if option.kind_of? Hash then
+          # Options have been set as value/label pair, like 
+          #
+          #  @options = { 1 => 'first', 2 => 'second' }
+          #
           option.each_pair { |k,v|
-            options << HTML.input(:type => :checkbox, :value => k, :name => @attrib[:name] ) { v }
+            box_attribs = { :type => :checkbox, 
+                            :value => k, 
+                            :name => @attrib[:name] }
+            box_attribs[:checked] = true if (v.to_s == @value.to_s)
+            options << HTML.input(box_attribs)
           }
         elsif option.kind_of? Element then
+          # Option element has been built externally, like in 
+          #
+          #  @options = [ HTML.option(:class => :custom, :label => 'built manually') ]
+          #
           option.name = @attrib[:name]
           option.tag = :input
           option.type = :checkbox
           options << option
+        else 
+          # For  @options = [ :foo, :bar, 'wombat' ], 
+          #
+          box_attribs = { :type => :checkbox, 
+                          :value => option.to_s, 
+                          :name => @attrib[:name] }
+          box_attribs[:checked] = true if (option.to_s == @value.to_s)
+          options << HTML.input(box_attribs)
         end
       }
       options

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

@@ -4,10 +4,21 @@ require('aurita-gui/form/form_field')
 module Aurita
 module GUI
 
+  # Factory for input fields. 
+  # Default type is :text, accoring to W3C, possible 
+  # types are :password, :radio, :checkbox. 
+  #
+  # For radio and checkbox input fields, there are 
+  # classes Radio_Field and Checkbox_Field, providing 
+  # more convenience than building option fields 
+  # manually. 
+  # See also Options_Field on this topic. 
+  #
   # Usage: 
   #
-  #   i = Input_Field.new(:name => :description, 
-  #                       :label => 'Description', 
+  #   i = Input_Field.new(:type => :text, 
+  #                       :name => :description, 
+  #                       :label => 'Enter a discription', 
   #                       :value => 'Lorem ipsum dolor')
   #
   class Input_Field < Form_Field

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

@@ -0,0 +1,23 @@
+
+require('aurita-gui/form/form_field')
+
+module Aurita
+module GUI
+
+  # Wrapper for Input_Field, defaults type to :password. 
+  #
+  # Usage: 
+  #
+  #   i = Password_Field.new(:name  => :pass_confirm, 
+  #                          :label => 'Confirm password', 
+  #                          :value => 'oldpass')  # Possible, but not recommended
+  #
+  class Password_Field < Input_Field
+    def initialize(params, &block)
+      params[:type] = :password unless params[:type]
+      super(params)
+    end
+  end
+  
+end
+end

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

@@ -4,8 +4,29 @@ require('aurita-gui/form/options_field')
 module Aurita
 module GUI
 
+  # Factory for radio input fields, specialization 
+  # of Options_Field. 
+  # Example: 
+  #  
+  #   r = Radio_Field.new(:name => :color, 
+  #                       :value => :red, 
+  #                       :label => 'Select a color', 
+  #                       :options => { :red => 'red color', :blue => 'blue color' })
+  #
+  # Same as 
+  #
+  #   r = Radio_Field.new(:name => :color, :value => :red, :label => 'Select a color') { 
+  #         :red => 'red color', :blue => 'blue_color
+  #       }
+  #
+  # For usage details  see documentation of Options_Fiels. 
+  #
   class Radio_Field < Options_Field
 
+    # Returns array of option elements for this 
+    # radio field. 
+    # Each option is a radio input field with 
+    # @name as common name attribute. 
     def option_elements
       options = []
       @option_elements.each { |option| 
@@ -23,6 +44,8 @@ module GUI
       options
     end
 
+    # Renders this radio field to a HTML.ul element, 
+    # including options from #option_elements. 
     def element
       HTML.ul(:class => :radio_options) { 
         option_elements().map { |o| HTML.li() { o } } 

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

@@ -0,0 +1,23 @@
+
+require('aurita-gui/form/form_field')
+
+module Aurita
+module GUI
+
+  # Wrapper for Input_Field, sets type to :text. 
+  #
+  # Usage: 
+  #
+  #   i = Text_Field.new(:name => :description, 
+  #                      :label => 'Description', 
+  #                      :value => 'Lorem ipsum dolor')
+  #
+  class Text_Field < Input_Field
+    def initialize(params, &block)
+      params[:type] = :text unless params[:type]
+      super(params)
+    end
+  end
+  
+end
+end

data/lib/aurita-gui/html.rb

@@ -29,30 +29,58 @@ module GUI
   #    HTML.a(:href => 'http://domain.com') { 'click me' }
   #    # --> '<a href="http://domain.com">click me</a>'
   #
+  
+  XHTML_TAGS = [ :html, :div, :p, :input, :select, :option, :ul, :ol, :li ]
+
   class HTML
 
+    # Statically defined as <br /> must not have any attributes. 
     def self.br
-      '<br />'
+      Element.new(:tag => :br)
     end
     
     def self.render(meth_name, attrib_hash={}, &block)
       raise ::Exception.new('Missing attributes for HTML.' << meth_name.inspect) unless attrib_hash
       attrib_hash[:tag] = meth_name
-      label = yield if block_given?
-      label = label.to_s unless label.kind_of? String
-      attrib_hash[:content] = label
+      cont = yield if block_given?
+    # cont = self.class_eval(&block) 
+      attrib_hash[:content] = cont
       Element.new(attrib_hash)
     end
+
+    def self.build(&block)
+      raise ::Exception.new('Missing block for HTML.render') unless block_given?
+      self.class_eval(&block) 
+    end
+    
     
     def self.a(attrib_hash={}, &block)
       render(:a, attrib_hash, &block)
     end
 
+    # p is defined in Kernel, so we have to 
+    # redirect it manually (method_missing won't be 
+    # triggered for it)
+    def self.p(attrib_hash={}, &block)
+      render(:p, attrib_hash, &block)
+    end
+
     def self.method_missing(meth_name, attrib_hash={}, &block)
-      render(meth_name, attrib_hash, &block)
+      render(meth_name, attrib_hash, &block) 
     end
 
-  end
+=begin
+    for t in XHTML_TAGS do 
+      meth = <<EOC
+        def self.#{t.to_s}(attribs=nil, &block)
+          render(:#{t.to_s}, attribs, &block)
+        end
+EOC
+      class_eval(meth)
+    end
+=end
+
+  end # class
 
   # A minimalistic generator for javascript calls. 
   # Usage: 
@@ -111,8 +139,9 @@ module GUI
       args_string = args.join(',')
       meth.to_s << '(' << args_string + ');'
     end
-    
-  end
+
+  end # class
+
     
 end # module
 end # module

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aurita-gui
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors: 
 - Tobias Fuchs
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-09 00:00:00 +01:00
+date: 2009-01-12 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -22,13 +22,13 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- cheatsheet.rb
 - History.txt
 - lib
-- aurita-gui-0.1.0.gem
 - aurita-gui.gemspec
 - bin
+- TODO
 - test
-- aurita-gui-0.1.5.gem
 - LICENSE
 - lib/aurita-gui
 - lib/aurita-gui.rb
@@ -38,6 +38,7 @@ files:
 - lib/aurita-gui/table.rb
 - lib/aurita-gui/form
 - lib/aurita-gui/element.rb
+- lib/aurita-gui/form/password_field.rb
 - lib/aurita-gui/form/options_field.rb
 - lib/aurita-gui/form/file_field.rb
 - lib/aurita-gui/form/form_error.rb
@@ -50,6 +51,7 @@ files:
 - 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/text_field.rb
 - lib/aurita-gui/form/input_field.rb
 - lib/aurita-gui/form/date_field.rb
 - test/tc_options.rb
@@ -62,7 +64,7 @@ rdoc_options:
 - --title
 - Aurita::GUI
 - --main
-- Aurita::GUI::HTML
+- ./cheatsheet.rb
 - --line-numbers
 require_paths: 
 - lib