aurita-gui 0.3.0 → 0.3.1

data/History.txt

@@ -1,3 +1,8 @@
+=== 0.3.1 / 2009-01-15
+
+* Added specs for Element and HTML. 
+* Polished rendering. 
+
 === 0.2.0 / 2009-01-12
 
 * Added magic: 

data/TODO

@@ -2,6 +2,9 @@
 - Implement <fieldset>
 - Implement <optgroup>
 
+- Implement element.sibling[:dom_id] --> element
+- Implement XPath1.0 method (parent, sibling, descendant, following ...)
+
 - Implement field visibility using 
   field.visible = true/false, wrapped in 
   def form.fields=(fields)

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.3.0'
+  s.version = '0.3.1'
   s.author = 'Tobias Fuchs'
   s.email = 'fuchs@atomnode.net'
   s.date = Time.now
@@ -25,7 +25,7 @@ part of Aurita in a single gem with no dependencies.
                      'lib/aurita-gui/*', 
                      'lib/aurita-gui/form/*', 
                      'bin/*', 
-                     'test/*'].to_a
+                     'spec/*'].to_a
 
   s.has_rdoc = true
   s.rdoc_options << '--title' << 'Aurita::GUI' <<

data/lib/aurita-gui.rb

@@ -3,4 +3,4 @@ require('aurita-gui/element')
 require('aurita-gui/html')
 require('aurita-gui/form')
 require('aurita-gui/table')
-
+require('aurita-gui/button')

data/lib/aurita-gui/element.rb

@@ -46,35 +46,43 @@ module GUI
     
     @@element_count = 0
     
-    attr_accessor :attrib, :type, :content, :parent, :tag
+    attr_accessor :attrib, :content, :parent, :tag, :force_closing_tag
     
     def initialize(params={}, &block) 
+
       @@element_count += 1
       @id          = @@element_count
       @parent      = params[:parent]
-      @force_close = params[:force_closing_tag]
+      @force_closing_tag = params[:force_closing_tag]
+      params[:tag] = :div if params[:tag].nil?
+      @tag     = params[:tag]
+      if [ :div, :label, :button, :textarea ].include? @tag then
+        @force_closing_tag = true
+      end
       params.delete(:parent)
       params.delete(:force_closing_tag)
 
-      params[:tag] = :div if params[:tag].nil?
-
       if block_given? then
         @content = yield
       else
         @content = params[:content]
-        @content = [ @content ] unless @content.kind_of? Array
       end
+      @content   = [ @content ] unless (@content.kind_of? Array or @content.to_s.length == 0)
+      @content ||= []
       params.delete(:content)
-      @tag     = params[:tag]
       params.delete(:tag)
       # params[:id] = self.class.to_s.split('::')[-1].downcase + '_' << @@element_count.to_s if params[:id].nil?
-      params[:onclick] << ';' unless params[:onclick].nil? or params[:onclick].include?(';')
+      # params[:onclick] << ';' unless params[:onclick].nil? or params[:onclick].include?(';')
       
       @attrib = params
       # @attrib[:id] = @attrib[:id].to_s 
       
     end
 
+    def has_content? 
+      (@content.length > 0)
+    end
+
     # Return DOM id of this element. 
     def dom_id
       @attrib[:id]
@@ -105,6 +113,10 @@ module GUI
       @attrib[meth.to_s.gsub('=','').intern] = value
     end
 
+    def content=(obj)
+      @content = [ obj ]
+    end
+
     # Define explicitly so built-in method #type 
     # is not invoked instead
     def type=(type)
@@ -156,18 +168,20 @@ module GUI
         end
         if !value.nil? then
           value = value.to_s
-          attrib_string << name.to_s + '="' << value + '" '
+          attrib_string << ' ' << name.to_s + '="' << value + '"'
         end
       }
       
-      if @force_close || content.to_s != '' then
-        '<' << @tag.to_s << ' ' << attrib_string << '>' << "\n  " << 
-        content.to_s.gsub("\n","\n  ") + "\n" << 
-        '</' << @tag.to_s << '>'
+      out = ''
+      if @force_closing_tag || content.to_s != '' then
+        out << "<#{@tag}"
+        out << attrib_string if attrib_string.length > 0
+        out << ">#{content}"
+        out << "</#{@tag}>"
       else
-        '<' << @tag.to_s << ' ' << attrib_string << '/>' 
+        out = "<#{@tag.to_s}#{attrib_string} />" 
       end
-      
+      return out
     end
     alias to_s string
 

data/lib/aurita-gui/form.rb

@@ -26,7 +26,7 @@ module GUI
     attr_accessor :field
 
     def initialize(field)
-      label_params = { :for => field.dom_id }
+      label_params = { :for => field.dom_id, :force_closing_tag => true }
       label_params[:id] = field.dom_id.to_s + '_label'
       label = field.label
       @content = [ HTML.label(label_params) { label }, field ]
@@ -177,7 +177,7 @@ module GUI
   #
   class Form < Element
 
-    attr_accessor :method, :target, :action, :fields, :elements, :element_map
+    attr_accessor :method, :target, :action, :fields, :elements, :element_map, :values
   
     def initialize(params, &block)
       @action       = params[:action]
@@ -216,9 +216,17 @@ module GUI
     end
 
     # Assign / overwrite field element with index form_index. 
+    # TODO: FIX ME
     def []=(index, form_field)
-      @elements[index] = form_field
       @content = false # Invalidate
+      if !index.kind_of? Numeric
+        @element_map[index,to_s] = form_field 
+        @elements.collect { |e|
+          e = form_field if e.name.to_s == index.to_s
+        }
+      else 
+        @elements[index] = form_field
+      end
     end
     
     # Delete form field with name field_name from 
@@ -240,6 +248,8 @@ module GUI
     end
 
     # Add form field element to this form. 
+    # TODO: Should overwrite previous field element 
+    # with same field name. 
     def add(form_field_element)
       if !form_field_element.dom_id then
         form_field_element.dom_id = form_field_element.name.to_s.gsub('.','_')

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

@@ -18,6 +18,7 @@ module GUI
       @attrib[:force_closing_tag] = true
       HTML.textarea(@attrib) { @value.to_s }
     end
+
   end
   
 end

data/lib/aurita-gui/html.rb

@@ -220,9 +220,9 @@ module GUI
     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
-      cont = yield if block_given?
-      attrib_hash[:content] = cont
-      Element.new(attrib_hash)
+#      cont = yield if block_given?
+#      attrib_hash[:content] = cont
+      Element.new(attrib_hash, &block)
     end
 
     def self.build(&block)

data/spec/;

@@ -0,0 +1,14 @@
+
+class Context_Loader
+
+  def self.render(element)
+    puts 'loader: ' << element.to_s + ' end loader'
+
+  def run(&block)
+    class_eval(&block)
+  end
+
+end
+
+l = Context_Loader.new()
+l.run { 'foo' }

data/spec/element.rb

@@ -0,0 +1,157 @@
+
+require('rubygems')
+require('aurita-gui/element')
+
+include Aurita::GUI
+
+describe Aurita::GUI::Element, "basic rendering" do
+  before do
+    @e1 = Element.new(:tag => :tagname)
+    @inner = Element.new(:tag => :h2) { 'i am an inner header' }
+    @outer = Element.new(:tag => :p, :class => :outer) { @inner }
+  end
+
+  it "should have a tag attribute" do
+    e = Element.new(:tag => :tagname)
+    e.tag.should == :tagname
+  end
+
+  it "should have :div as default attribute" do
+    e = Element.new()
+    e.tag.should == :div
+  end
+
+  it "should redirect id to a tag attribute (DOM id)" do
+    e = Element.new(:id => :the_dom_id)
+    e.id.should == :the_dom_id
+    e.id = :changed_id
+    e.id.should == :changed_id
+  end
+
+  it "should render to an array automatically if necessary" do
+    e1 = Element.new(:id => :first)
+    e2 = Element.new(:id => :second)
+
+    (e1 << e2).should == [ e1, e2 ]
+    (e1 + e2).should == [ e1, e2 ]
+  end
+
+  it "should be able to render to string" do 
+    @e1.to_s.should == '<tagname />'
+    @e1.string.should == '<tagname />'
+  end
+
+  it "should have enclosed content that is an array" do
+    @e1.content.length.should == 0
+    @e1.has_content?().should == false
+    @e1.content.should == []
+  end
+
+  it "should close the tag depending on content" do
+    @e1.content = 'the content'
+    @e1.content.should == [ 'the content' ]
+    @e1.to_s.should == '<tagname>the content</tagname>'
+  end
+
+  it "should not allow self-closing tags in some cases (textarea, label, button ...)" do
+    textarea = Element.new(:tag => :textarea)
+    textarea.to_s.should == '<textarea></textarea>'
+    button = Element.new(:tag => :button, :param => :value)
+    button.to_s.should == '<button param="value"></button>'
+    label = Element.new(:tag => :label, :param => :value)
+    label.to_s.should == '<label param="value"></label>'
+  end
+
+  it "should be possible to force a closing tag" do 
+    e = Element.new(:tag => :something, :force_closing_tag => true)
+    e.to_s.should == '<something></something>'
+    e.force_closing_tag = false
+    e.to_s.should == '<something />'
+  end
+
+  it "should offer tag attributes as hash, maintaining keys as provided" do
+    e = Element.new(:foo => 1, :bar => 'barvalue', 'wombat' => 3)
+    e.attrib[:foo].should == 1
+    e.attrib[:bar].should == 'barvalue'
+    e.attrib['wombat'].should == 3
+  end
+
+  it "should render parameters as tag attributes" do 
+    e = Element.new(:tag => :foo, :some_param => :the_value) 
+    e.to_s.should == '<foo some_param="the_value" />'
+  end
+
+  it "should be possible to retreive original parameter values" do
+    e = Element.new(:tag => :foo, :some_param => :the_value) 
+    e.some_param.should == :the_value
+  end
+
+  it "should accept parameter :content" do 
+    e = Element.new(:tag => :bar, :content => 'content here', :name => :wombat)
+    e.content.should == ['content here']
+    e.name.should == :wombat
+    e.to_s.should == '<bar name="wombat">content here</bar>'
+  end
+
+  it "should accept content as block, maintaining object identity" do 
+    test_obj_identity = 'lorem_ipsum'
+    e = Element.new(:tag => :jada) { test_obj_identity }
+    e.content.should == [ test_obj_identity ]
+    e.tag.should == :jada
+  end
+
+  it "should be possible to add new attributes" do 
+    e = Element.new(:tag => :jada) { 'string' }
+    added_value = 'added_value'
+    e.added = added_value
+    e.added.should == added_value
+  end
+
+  it "should accept other element instances as content" do
+    @outer.content.should == [ @inner ]
+    @outer.to_s.should == '<p class="outer"><h2>i am an inner header</h2></p>'
+  end
+
+  it "should maintain an object hierarchy" do
+    @outer.content.first.new_attrib = 23
+    @outer.content.first.new_attrib.should == 23
+  end
+
+  it "should be possible to alter an enclosed element after adding it as content" do
+    @inner.decorated_attrib = 'decorated'
+    @inner.content << ' with decoration'
+
+    @outer.to_s.should == '<p class="outer"><h2 decorated_attrib="decorated">i am an inner header with decoration</h2></p>'
+
+    @inner.content = 'maintaining hierarchies rocks!'
+
+    @outer.to_s.should == '<p class="outer"><h2 decorated_attrib="decorated">maintaining hierarchies rocks!</h2></p>'
+  end
+
+  it "should delegate array operators to @content array" do
+    inner = Element.new(:tag => :h2) { 'i am an inner header' }
+    outer = Element.new(:tag => :p) { inner }
+    outer[0].new_attrib = 23
+    outer[0].new_attrib.should == 23
+  end
+
+  it "should be able to overwrite tag attributes" do 
+    e = Element.new(:tag => :div, :the_param => 42) 
+    e.the_param.should == 42
+    e.the_param = 23
+    e.the_param.should == 23
+  end
+
+  it "should be possible to add content elements" do 
+    e = Element.new(:foo => :bar)
+    ras = 'one'
+    dwa = 'two'
+    tri = 'three' 
+    e.content = ras
+    e.content.should == [ ras ] 
+    e.content << dwa
+    e.content << tri
+    e.content.should == [ ras, dwa, tri ]
+  end
+
+end

data/spec/html.rb

@@ -0,0 +1,39 @@
+
+require('rubygems')
+require('aurita-gui/html')
+
+include Aurita::GUI
+
+describe Aurita::GUI::HTML, "basic rendering" do
+  before do
+    @e = HTML.build { 
+      div(:class => :outer) { 
+        h2(:id => :header) { 'Header' } + 
+        p(:id => :content) { 'Content' }
+      }
+    }
+  end
+
+  it "should act as factory by setting tag attribute for Element on class method calls" do
+    HTML.p.to_s.should == Element.new(:tag => :p).to_s
+    HTML.p(:class => :auto).to_s.should == Element.new(:tag => :p, :class => :auto).to_s
+  end
+
+  it "should accept a block and pass it to Element as content" do
+    HTML.p { 'string' }.to_s.should == '<p>string</p>'
+  end
+
+  it "should provide a build mechanism that delegates class methods" do
+    @e.to_s = '<div class="outer"><h2 id="header">Header</h2><p id="content">Content</p></div>'
+  end
+
+  it "should still provide an object tree" do 
+    @e[0].id.should == :header
+    @e[1].id.should == :content
+    @e[1].content.should == [ 'Content' ]
+    @e[1].content = 'Altered'
+    @e[1].content.should == [ 'Altered' ]
+    @e.to_s.should == '<div class="outer"><h2 id="header">Header</h2><p id="content">Altered</p></div>'
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aurita-gui
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Tobias Fuchs
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-13 00:00:00 +01:00
+date: 2009-01-15 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -24,6 +24,7 @@ extra_rdoc_files: []
 files: 
 - fieldtest.rb
 - cheatsheet.rb
+- spec
 - History.txt
 - lib
 - aurita-gui.gemspec
@@ -56,9 +57,9 @@ files:
 - 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
-- test/tc_table.rb
-- test/tc_form.rb
+- spec/;
+- spec/html.rb
+- spec/element.rb
 has_rdoc: true
 homepage: http://aurita.wortundform.de/
 post_install_message: 

data/test/tc_form.rb

@@ -1,30 +0,0 @@
-
-require('aurita-gui/form')
-
-include Aurita::GUI
-
-form = Form.new(:method => :post, :action => '/where/to/send', :onsubmit => "alert('submitting');") 
-
-input1 = Input_Field.new(:name => :description, :label => 'Description', 
-                         :class => :custom_input_field_class, 
-                         :value => 'first input text'), 
-input2 = Input_Field.new(:name => :custom, :label => 'Custom ID', 
-                         :id => :custom_id_value, 
-                         :value => 'second input text'), 
-select = Select_Field.new(:name => :category, :label => 'Select category', 
-                          :disabled => true, 
-                          :value => :value_b,  # Value to be selected
-                          :options => { :value_a => :key_a, :value_b => :key_b })
-form[1].readonly!
-form.each { |e| e.attrib[:class] = [ e.attrib[:class], :aurita ] }
-form.each { |e| e.attrib[:onfocus] = "alert('focussed #{e.id}');" }
-
-puts HTML.h1 { 'Single element' }
-puts form.element_map[:description]
-
-puts HTML.h1 { 'Editable form, one element disabled' }
-puts form
-
-puts HTML.h1 { 'Readonly form' }
-form.readonly! 
-puts form

data/test/tc_options.rb

@@ -1,59 +0,0 @@
-
-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 }
-

data/test/tc_table.rb

@@ -1,23 +0,0 @@
-
-require 'aurita-gui/table'
-
-
-include Aurita::GUI
-
-t = Table.new(:headers => ['user', 'phone', 'email'], 
-              :options => { :class => 'css_class', :id => 'test_table', :border => 1, :cellpadding => 3 })
-
-t.add_row([ 'a','b','c' ])
-t.add_row([ 'd','e','f','g' ])
-
-t[0][0].value = 'foo'
-t[0][0].colspan = 2
-t[1][0].onclick = 'test();'
-t[0][1] = HTML.a(:href => 'http://google.com') { 'google' }
-
-t[0][1].value.href = 'other'
-t[0][1].value.content = 'clickme'
-
-t[0].class = 'highlighted'
-
-puts t