aurita-gui 0.3.4 → 0.3.5

data/TODO

@@ -5,7 +5,6 @@
 - Fixme: Setting values only works after all elements have been added 
          (values won't be set for elements added after form.values=)
 
-- Implement element.sibling[:dom_id] --> element
 - Implement XPath1.0 method (parent, sibling, descendant, following ...)
 
 - Implement field visibility using 
@@ -20,6 +19,11 @@
 
 = DONE =============================================
 
+- Element should implement / delegate to Array, 
+  so it can be used like any container. 
+
+- Implement element.sibling[:dom_id] --> element
+
 - Provide markaby-like syntax, Example: 
 
     HTML.div 'content here' :class => :highlight
@@ -27,7 +31,7 @@
   and
     
     HTML.build { 
-      div 'content' { 
+      div.header { 
         h1 'header'
       }
     }

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

data/lib/aurita-gui/element.rb

@@ -1,4 +1,6 @@
 
+require('delegate')
+
 module Aurita
 module GUI
     
@@ -14,11 +16,46 @@ module GUI
   #               via parameter :content or using a 
   #               block or by #content and #content=. 
   #
+  # == Usage as container
+  #
+  # Element implements all features expected from a 
+  # container class. 
+  # It delegates access to @content to class Array, 
+  # so an element can be used as Array instance, too: 
+  #
+  #   e = Element.new { Element.new { 'first' } + Element.new { 'second' } }
+  #   puts e.join(' -- ')
+  #   -->
+  #   'first -- second'
+  #
+  # You can also push elements into an element: 
+  #
+  #   e1 = HTML.div { 'Foo' }
+  #   e2 = HTML.div { 'Bar' }
+  #
+  #   assert_equal(e[0], 'Foo')
+  #   assert_equal(e[1], e2)
+  #
+  # It also keeps track of parent classes: 
+  #
+  #   assert_equal(e1[1].parent, e1)
+  #
+  # Random access operators are redefined, so you 
+  # can either access elements by array index, as usual, 
+  # as well as by their DOM id: 
+  #
+  #   e = Element.new { Element.new(:tag => :p, :id => :foo) { 'nested element' } }
+  #   puts e[:foo].to_s
+  #   -->
+  #   '<p id="foo">nested element</p>'
+  #
+  # == Builder
+  #
   # Most methods invoked on an Element instance are 
   # redirected to return or set a tag attribute. 
   # Example: 
   #
-  #   link = Element(:tag => :a) { 'klick me' }
+  #   link = Element.new(:tag => :a) { 'click me' }
   #   link.href = '/link/to/somewhere'
   #
   # Same as 
@@ -108,11 +145,11 @@ module GUI
   #   e.onclick == 'alert("message");'
   #   e.to_s    == '<div onclick="alert(\"message\");"></div>'
   #
-  class Element
+  class Element < DelegateClass(Array)
     
     @@element_count = 0
     
-    attr_accessor :attrib, :content, :parent, :force_closing_tag, :tag
+    attr_accessor :attrib, :parent, :force_closing_tag, :tag
     
     def initialize(*args, &block) 
 
@@ -144,52 +181,73 @@ module GUI
       end
       @content   = [ @content ] unless (@content.kind_of? Array or @content.to_s.length == 0)
       @content ||= []
+
+      @content.each { |c|
+        if c.is_a?(Element) then
+          c.parent = self
+        end
+      }
       params.delete(:content)
       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?(';')
       
       @attrib = params
-      # @attrib[:id] = @attrib[:id].to_s 
-      
+
+      super(@content)
+
     end
 
     def has_content? 
-      (@content.length > 0)
+      (length > 0)
     end
 
-    # Return DOM id of this element. 
-    def dom_id
-      @attrib[:id] if @attrib
-    end
-    # Set DOM id of this element. 
-    def dom_id=(value)
-      @attrib[:id] = value if @attrib
-    end
     # Alias definition for #dom_id=(value)
     # Define explicitly so built-in method #id
     # is not invoked instead
     def id=(value)
-      @attrib[:id] = value
+      @attrib[:id] = value if @attrib
     end
+    alias dom_id= id=
     # Alias definition for #dom_id()
     def id
-      @attrib[:id]
+      @attrib[:id] if @attrib
     end
+    alias dom_id id
 
-    # Render this element to a string and append another 
-    # element. 
+    # Return [ self, other ] so concatenation of 
+    # Element instances works as expected; 
+    #
+    #   HTML.build { 
+    #     div { 'first' } + div { 'second' } 
+    #   }
+    #   --> <Element [ <Element 'first'>, <Element 'second'> ] >
+    #
     def +(other)
-#     return string << other.string if other.kind_of? Element
       return [ self, other ]
     end
-    alias << +
 
+    # Append object to array of nested elements. 
+    # Object to append (other) does not have to 
+    # be an Element instance. 
+    # If so, however, other#parent will be set 
+    # to this instance. 
+    def <<(other)
+      other.parent = self if other.is_a?(Element)
+      __getobj__().push(other)
+    end
+
+    # Returns [ self ], so concatenation with 
+    # Arrays and other Element instances works 
+    # as expected (see #<<(other).
     def to_ary
       [ self ]
     end
     alias to_a to_ary
 
+    # Returns nested content as array. 
+    def get_content
+      __getobj__()
+    end
+
     # Redirect methods to setting or retreiving tag 
     # attributes. 
     # There are several possible routings for method_missing: 
@@ -220,16 +278,20 @@ module GUI
       if block_given? then
         @attrib[:class] = meth
         @attrib.update(value) if value.is_a? Hash
-        @content = yield
+        c = yield
+        c = [ c ] unless c.is_a?(Array)
+        __setobj__(c)
         return self
       elsif !value.nil? && !meth.to_s.include?('=') then
         @attrib[:class] = meth
         case value
         when Hash then
           @attrib.update(value)
-          @content = value[:content]
+          c = value[:content] 
+          c = [ c ] if (c && !c.is_a?(Array))
+          __setobj__(c) if c
         when String then
-          @content = value
+          __setobj__([value])
         end
         return self
       else
@@ -240,9 +302,11 @@ module GUI
 
     # Set enclosed content of this element. 
     # Will be automatically wrapped in an array. 
-    def content=(obj)
-      @content = [ obj ]
+    def set_content(obj)
+      return __setobj__([ obj ]) unless (obj.is_a?(Array))
+      __setobj__(obj)
     end
+    alias content= set_content
 
     # Define explicitly so built-in method #type 
     # is not invoked instead
@@ -252,7 +316,7 @@ module GUI
 
     # Do not redirect random access operators. 
     def [](index)
-      return @content[index] if (index.is_a? Numeric)
+      return super(index) if (index.is_a?(Fixnum))
       return find_by_dom_id(index) 
     end
 
@@ -260,7 +324,7 @@ module GUI
     # its dom_id
     def find_by_dom_id(dom_id)
       dom_id = dom_id.to_sym
-      @content.each { |c|
+      each { |c|
         if c.is_a? Element then
           return c if (c.dom_id == dom_id)
           sub = c.find_by_dom_id(dom_id)
@@ -272,16 +336,10 @@ module GUI
 
     # Do not redirect random access operators. 
     def []=(index,element)
-      @content[index] = element if (index.is_a? Numeric)
+      super(index,element) if (index.is_a? Numeric)
       e = find_by_dom_id(index) 
       e.swap(element)
     end
-    def length
-      @content.length
-    end
-    def empty? 
-      @content.length == 0
-    end
 
     # Copy constructor. Replace self with 
     # other element. 
@@ -290,7 +348,7 @@ module GUI
       @tag = other.tag
       @attrib = other.attrib 
       @attrib[:id] = save_own_id
-      @content = other.content
+      __setobj__(other.get_content)
     end
     alias copy swap
 
@@ -302,43 +360,37 @@ module GUI
 
     # Render this element to a string. 
     def string
-      return content.to_s if @tag == :pseudo
+      return get_content.to_s if @tag == :pseudo
 
       attrib_string = ''
       @attrib.each_pair { |name,value|
         if value.instance_of?(Array) then
           value = value.join(' ')
-        elsif
-          value.instance_of?(TrueClass) then
+        elsif value.instance_of?(TrueClass) then
           value = name
         end
         if !value.nil? then
-          value = value.to_s
-          attrib_string << ' ' << name.to_s + '="' << value.gsub('"','\"') + '"'
+          value = value.to_s.gsub('"','\"')
+          attrib_string << " #{name}=\"#{value}\""
         end
       }
       
-      out = ''
       if (!(@force_closing_tag.instance_of?(FalseClass)) && 
           [ :div, :label, :button, :textarea ].include?(@tag)) then
         @force_closing_tag = true
       end
-      if @force_closing_tag || content.to_s != '' then
-        out << "<#{@tag}"
-        out << attrib_string if attrib_string.length > 0
-        out << ">#{content}"
-        out << "</#{@tag}>"
+      if @force_closing_tag || has_content? then
+        return "<#{@tag}#{attrib_string}>#{__getobj__}</#{@tag}>"
       else
-        out = "<#{@tag.to_s}#{attrib_string} />" 
+        return "<#{@tag.to_s}#{attrib_string} />" 
       end
-      return out
     end
     alias to_s string
+    alias to_str string
 
-    def each(&block)
-      @content.each(&block)
-    end
-
+    # Return CSS classes as array. Note that 
+    # Element#class is not redefined to return 
+    # attribute :class, for obvious reasons. 
     def css_classes
       css_classes = @attrib[:class]
       if css_classes.kind_of? Array
@@ -348,21 +400,76 @@ module GUI
       else # e.g. Symbol
         css_classes = [ css_classes ]
       end
-      css_classes.collect { |c| c.to_sym if c }
+      css_classes.map! { |c| c.to_sym if c }
       return css_classes
     end
     alias css_class css_classes
 
+    # Add CSS class to this Element instance. 
+    #   e = Element.new(:class => :first)
+    #   e.add_class(:second
+    #   e.to_s 
+    # -->
+    #   <div class="first second"></div>
     def add_class(css_class_name)
       @attrib[:class] = (css_classes << css_class_name.to_sym)
     end
+    alias add_css_class add_class
 
+    # Remove CSS class from this Element instance. 
+    # Add CSS class to this Element instance. 
+    #   e = Element.new(:class => [ :first, :second ])
+    #   e.to_s 
+    # -->
+    #   <div class="first second"></div>
+    #
+    #   e.remove_class(:second)
+    #   e.to_s 
+    # -->
+    #   <div class="first"></div>
     def remove_class(css_class_name)
       classes = css_classes
       classes.delete(css_class_name.to_sym)
       @attrib[:class] = classes
     end
-    
+    alias remove_css_class remove_class
+
+    # Iterates over all Elements in this
+    # instances object tree (depth first). 
+    #
+    #   x = HTML.build { 
+    #        div.main { 
+    #          h2.header { 'Title' } + 
+    #          div.lead { 'Intro here' } + 
+    #          div.body { 
+    #            p.section { 'First' } + 
+    #            p.section { 'Second' } 
+    #          }
+    #        }
+    #       }
+    #
+    #   x.recurse { |element| 
+    #     p element.css_class
+    #   }
+    #
+    # --> 
+    #
+    #   :main
+    #   :header
+    #   :lead
+    #   :body
+    #   :section
+    #   :section
+    #
+    def recurse(&block)
+      each { |c| 
+        if c.is_a?(Element) then
+          yield(c)
+          c.recurse(&block) 
+        end
+      }
+    end
+
   end # class
   
 end # module

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

@@ -3,6 +3,7 @@ require('aurita-gui/form/form_field')
 
 module Aurita
 module GUI
+  # TODO: Use ArrayFields for option field/value storage
 
   # Abstract base class for all form elements containing
   # options, like Select_Field, Radio_Field, Checkbox_Field

data/lib/aurita-gui/html.rb

@@ -4,6 +4,9 @@ require('aurita-gui/element')
 module Aurita
 module GUI
 
+  # = Aurita::GUI 
+  # Tobias Fuchs, 2009
+  #
   # == About
   #
   # Aurita::GUI is a library for convenient, simple 

data/samples/pushtest.rb

@@ -0,0 +1,17 @@
+
+require 'rubygems'
+require 'aurita-gui'
+
+include Aurita::GUI
+
+e1 = HTML.div.outer { 'Foo' }
+e2 = HTML.div.inner { 'Bar' }
+
+e1 << e2
+
+puts e1.to_s
+p e1[0] == 'Foo'
+p e1[1] == e2
+
+p e1[1].parent == e1
+p e2.parent == e1

data/samples/putstest.rb

@@ -0,0 +1,22 @@
+
+require 'rubygems'
+require 'aurita-gui'
+
+include Aurita::GUI
+
+
+class Renderfoo
+
+  def outerfun(i)
+    i * i
+  end
+
+  def render
+    puts HTML.build { 
+      outerfun(23) 
+    }.to_s
+  end
+
+end
+
+Renderfoo.new.render

data/samples/recurse.rb

@@ -0,0 +1,21 @@
+
+require 'rubygems'
+require 'aurita-gui'
+
+include Aurita::GUI
+
+x = HTML.build { 
+     div.main { 
+       h2.header { 'Title' } + 
+       div.lead { 'Intro here' } + 
+       div.body { 
+         p.section { 'First' } + 
+         p.section { 'Second' } + 
+         p.section { 'Third' }  
+       }
+     }
+}
+
+x.recurse { |element| 
+  p element.css_class
+}

data/spec/element.rb

@@ -41,8 +41,9 @@ describe Aurita::GUI::Element, "basic rendering" do
     e1 = Element.new(:id => :first)
     e2 = Element.new(:id => :second)
 
-    (e1 << e2).should == [ e1, e2 ]
     (e1 + e2).should == [ e1, e2 ]
+    e1 << e2
+    e1[0].should == e2 
   end
 
   it "should be able to render to string" do 
@@ -51,14 +52,14 @@ describe Aurita::GUI::Element, "basic rendering" do
   end
 
   it "should have enclosed content that is an array" do
-    @e1.content.length.should == 0
+    @e1.get_content.length.should == 0
     @e1.has_content?().should == false
-    @e1.content.should == []
+    @e1.get_content.should == []
   end
 
   it "should close the tag depending on content" do
     @e1.content = 'the content'
-    @e1.content.should == [ 'the content' ]
+    @e1.get_content.should == [ 'the content' ]
     @e1.to_s.should == '<tagname>the content</tagname>'
   end
 
@@ -97,7 +98,7 @@ describe Aurita::GUI::Element, "basic rendering" do
 
   it "should accept parameter :content" do 
     e = Element.new(:tag => :bar, :content => 'content here', :name => :wombat)
-    e.content.should == ['content here']
+    e.get_content.should == ['content here']
     e.name.should == :wombat
     e.to_s.should == '<bar name="wombat">content here</bar>'
   end
@@ -105,7 +106,7 @@ describe Aurita::GUI::Element, "basic rendering" do
   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.get_content.should == [ test_obj_identity ]
     e.tag.should == :jada
   end
 
@@ -117,18 +118,18 @@ describe Aurita::GUI::Element, "basic rendering" do
   end
 
   it "should accept other element instances as content" do
-    @outer.content.should == [ @inner ]
+    @outer.get_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
+    @outer.get_content.first.new_attrib = 23
+    @outer.get_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'
+    @inner.get_content << ' with decoration'
 
     @outer.to_s.should == '<p class="outer"><h2 decorated_attrib="decorated">i am an inner header with decoration</h2></p>'
 
@@ -157,10 +158,10 @@ describe Aurita::GUI::Element, "basic rendering" do
     dwa = 'two'
     tri = 'three' 
     e.content = ras
-    e.content.should == [ ras ] 
-    e.content << dwa
-    e.content << tri
-    e.content.should == [ ras, dwa, tri ]
+    e.get_content.should == [ ras ] 
+    e << dwa
+    e << tri
+    e.get_content.should == [ ras, dwa, tri ]
   end
 
 end

data/spec/html.rb

@@ -38,15 +38,15 @@ describe Aurita::GUI::HTML, "basic rendering" do
     @e[0].css_class.first.should == :outer
     @e[0][0].id.should == :header
     @e[0][1].id.should == :content
-    @e[0][1].content.should == [ 'Content' ]
+    @e[0][1].get_content.should == [ 'Content' ]
     @e[0][1].content = 'Altered'
-    @e[0][1].content.should == [ 'Altered' ]
+    @e[0][1].get_content.should == [ 'Altered' ]
     @e.to_s.should == '<div class="outer"><h2 id="header">Header</h2><p id="content">Altered</p></div>'
   end
 
   it "should be possible to retreive elements just by DOM id" do
     e = @e[:header]
-    e.content.first.should == 'Header'
+    e.get_content.first.should == 'Header'
   end
 
   it "should escape double-quotes in tag parameters" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aurita-gui
 version: !ruby/object:Gem::Version 
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors: 
 - Tobias Fuchs
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-26 00:00:00 +01:00
+date: 2009-01-27 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -22,15 +22,14 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- cheatsheet.rb
 - spec
 - History.txt
 - lib
+- samples
 - aurita-gui.gemspec
 - bin
 - TODO
 - test
-- valuetest.rb
 - LICENSE
 - lib/aurita-gui
 - lib/aurita-gui.rb
@@ -59,6 +58,11 @@ files:
 - lib/aurita-gui/form/template_helper.rb
 - lib/aurita-gui/form/input_field.rb
 - lib/aurita-gui/form/date_field.rb
+- samples/putstest.rb
+- samples/recurse.rb
+- samples/cheatsheet.rb
+- samples/valuetest.rb
+- samples/pushtest.rb
 - spec/marshal.rb
 - spec/javascript.rb
 - spec/form.rb