aurita-gui 0.3.3 → 0.3.4

data/History.txt

@@ -1,4 +1,44 @@
-=== 0.3.3 / 2009-01-24
+
+=== 0.3.4 / 2009-01-26
+
+* Added retreiving elements from object tree 
+  via DOM id: 
+
+    x = HTML.build { 
+          div { 
+            p { 
+              span(:id => :nested) { 'content before' }
+            }
+          }
+        }
+
+    x[:nested].content = 'content after'
+
+  Also added replacing elements in tree: 
+
+    x[:nested] = HTML.div { 'other element' }
+    
+* Added marshalling of element hierarchies: 
+
+   e = HTML.build { div.outer(:onclick => js.alert('message')) { p.inner 'nested content' } }
+   e.to_s == Element.marshal_load(e.marshal_dump)
+
+  and thus
+
+   Element.marshal_load(e.marshal_dump)[0].onclick 
+   --> "alert('message');"
+   Element.marshal_load(e.marshal_dump)[0][0].class
+   --> 'inner'
+
+  This is useful for caching object hierarchies. 
+
+  
+* Extended API by convenience shortcuts: 
+  Content for elements can be set markaby-like now: 
+
+    HTML.div 'content here' :class => :highlighted
+
+=== 0.3.3 / 2009-01-25
 
 * Added form helpers for template rendering. 
 * Extended API by convenience shortcuts: 

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.3'
+  s.version = '0.3.4'
   s.author = 'Tobias Fuchs'
   s.email = 'fuchs@atomnode.net'
   s.date = Time.now

data/lib/aurita-gui/element.rb

@@ -42,6 +42,59 @@ module GUI
   # by any derived class like Aurita::GUI::Form or 
   # Aurita::GUI::Table. 
   #
+  # == Markaby style
+  #
+  # A syntax similar to markaby is also provided: 
+  #
+  #   HTML.build { 
+  #     div.outer { 
+  #       p.inner 'click me'
+  #     } + 
+  #     div.footer 'text at the bottom'
+  #   }.to_s
+  #
+  # --> 
+  #
+  #   <div class="outer">
+  #    <p class="inner">paragraph</p>
+  #   </div>
+  #   <div class="footer">text at the bottom</div>
+  #
+  # == Javascript convenience
+  #
+  # When including the Javascript helper (aurita-gui/javascript), 
+  # class HTML is extended by method .js, which provides 
+  # building Javascript snippets in ruby: 
+  #
+  #   e = HTML.build { 
+  #     div.outer(:onclick => js.Wombat.alert('message')) { 
+  #       p.inner 'click me'
+  #     }
+  #   }
+  #   e.to_s 
+  # --> 
+  #   <div class="outer" onclick="Wombat.alert(\'message\'); ">
+  #     <p class="inner">click me</p>
+  #   </div>
+  #
+  # But watch out for operator precedence! This won't work, as 
+  # .js() catches the block first: 
+  #
+  #   HTML.build { 
+  #     div :header, :onclick => js.funcall { 'i will not be passed to div' }
+  #   }
+  # --> 
+  #   <div class="header" onclick="funcall();"></div>
+  #
+  #
+  # So be explicit, use parentheses: 
+  #
+  #   HTML.build { 
+  #     div(:header, :onclick => js.funcall) { 'aaah, much better' }
+  #   }
+  # -->
+  #   <div class="header" onclick="funcall();">aaah, much better</div>
+  #
   # == Notes
   #
   # Double-quotes in tag parameters will be escaped 
@@ -139,11 +192,54 @@ module GUI
 
     # Redirect methods to setting or retreiving tag 
     # attributes. 
-    def method_missing(meth, value=nil)
-      return @attrib[meth] unless value or meth.to_s.include? '='
-      @attrib[meth.to_s.gsub('=','').intern] = value
+    # There are several possible routings for method_missing: 
+    #
+    # 1. Setting an attribute (no block, method ends in '=') Example: 
+    #   my_div = HTML.div 'content'
+    #   my_div.onlick = "alert('foo');"
+    #   puts my_div.to_s
+    # --> 
+    #   <div onclick="alert('foo');">content</div>
+    #
+    # 2. Retreiving an attribute (no block, method does not end in '='). Example: 
+    #
+    #   puts my_div.onlick
+    # --> 
+    #   'alert(\'foo\');'
+    #
+    # 3. Setting the css class (block or value passed, method does not end in '='). Example: 
+    #
+    #   my_div.highlighted { 'content' } 
+    # or 
+    #   my_div.highlighted 'content'
+    #
+    # --> 
+    #   <div class="highlighted">content</div>
+    #
+    def method_missing(meth, value=nil, &block)
+      if block_given? then
+        @attrib[:class] = meth
+        @attrib.update(value) if value.is_a? Hash
+        @content = yield
+        return self
+      elsif !value.nil? && !meth.to_s.include?('=') then
+        @attrib[:class] = meth
+        case value
+        when Hash then
+          @attrib.update(value)
+          @content = value[:content]
+        when String then
+          @content = value
+        end
+        return self
+      else
+        return @attrib[meth] unless value or meth.to_s.include? '='
+        @attrib[meth.to_s.gsub('=','').intern] = value
+      end
     end
 
+    # Set enclosed content of this element. 
+    # Will be automatically wrapped in an array. 
     def content=(obj)
       @content = [ obj ]
     end
@@ -156,13 +252,29 @@ module GUI
 
     # Do not redirect random access operators. 
     def [](index)
-      return @content[index]
-   #   raise ::Exception.new('Undefined method [] for ' << self.class.to_s)
+      return @content[index] if (index.is_a? Numeric)
+      return find_by_dom_id(index) 
     end
+
+    # Retreive an element from object tree by 
+    # its dom_id
+    def find_by_dom_id(dom_id)
+      dom_id = dom_id.to_sym
+      @content.each { |c|
+        if c.is_a? Element then
+          return c if (c.dom_id == dom_id)
+          sub = c.find_by_dom_id(dom_id)
+          return sub if sub
+        end
+      }
+      return nil
+    end
+
     # Do not redirect random access operators. 
     def []=(index,element)
-      @content[index] = element
-   #  raise ::Exception.new('Undefined method []= for ' << self.class.to_s)
+      @content[index] = element if (index.is_a? Numeric)
+      e = find_by_dom_id(index) 
+      e.swap(element)
     end
     def length
       @content.length
@@ -171,6 +283,17 @@ module GUI
       @content.length == 0
     end
 
+    # Copy constructor. Replace self with 
+    # other element. 
+    def swap(other)
+      save_own_id = dom_id()
+      @tag = other.tag
+      @attrib = other.attrib 
+      @attrib[:id] = save_own_id
+      @content = other.content
+    end
+    alias copy swap
+
     # Static helper definition for clearing 
     # CSS floats. 
     def clear_floating
@@ -179,6 +302,8 @@ module GUI
 
     # Render this element to a string. 
     def string
+      return content.to_s if @tag == :pseudo
+
       attrib_string = ''
       @attrib.each_pair { |name,value|
         if value.instance_of?(Array) then
@@ -226,6 +351,7 @@ module GUI
       css_classes.collect { |c| c.to_sym if c }
       return css_classes
     end
+    alias css_class css_classes
 
     def add_class(css_class_name)
       @attrib[:class] = (css_classes << css_class_name.to_sym)

data/lib/aurita-gui/html.rb

@@ -14,7 +14,55 @@ module GUI
   # is used to support design of OO-accessible GUI 
   # elements. 
   #
-  # Other than other builder implementations (there 
+  # Aurita::GUI is not intended to be used just for 
+  # HTML rendering, that is: It is not just a builder. 
+  # But it includes a builder syntax, extremely 
+  # similar to Markaby, but also including Javascript: 
+  #
+  #   x = HTML.build { 
+  #         div.main(:onclick => js.funcall({ :foo => 23, :bar => 'batz' })) { 
+  #           h2.title 'This is what you already now from markaby'
+  #         } + 
+  #         div.footer('Footer content' :id => :footer)
+  #       }
+  # --> 
+  #   <div class="main" onclick="funcall({ foo: 23, bar: 'batz' }); ">
+  #     <h2 class="title">
+  #       This is what you already now from markaby
+  #     </h2>
+  #     <div class="footer" id="footer">Footer content</div>
+  #   </div>
+  #
+  # But HTML.build is not just rendering text. It 
+  # maintains an object tree. After rendering, you can 
+  # access elements by their index, like in an multi-
+  # dimensional array: 
+  #
+  #   x[0][0].content = "But you didn't know this"
+  #   x[0][0].onmouseover = Javascript.alert("or that")
+  #
+  # Or, more convenient, by their DOM id: 
+  #
+  #   x[:footer].content = 'Or finding an element by DOM id'
+  #
+  # You can even completely replace an element after 
+  # rendering, but you won't be able to change it's DOM id 
+  # (for obvious reasons): 
+  #
+  #   x[:footer] = HTML.span { 'i changed my mind' }
+  #
+  # --> 
+  #   <div class="main" onclick="funcall({ foo: 23, bar: 'batz' }); ">
+  #     <h2 class="title" onmouseover="alert('or that'); ">
+  #       But you didn&apos;t know this
+  #     </h2>
+  #     <span id="footer">I changed my mind</span>
+  #   </div>
+  #
+  # And *this* is the reason there is an own builder 
+  # implementation for Aurita::GUI in the first place. 
+  #
+  # So, other than other builder implementations (there 
   # are many), Aurita::GUI is not just a collection 
   # of template helpers. It is data persistent and 
   # maintains object hierarchies. 
@@ -22,6 +70,10 @@ module GUI
   # rendered to a string - you can access and modify a 
   # generated HTML hierarchy before rendering it. 
   #
+  # Altogether, Aurita::GUI implements a flexible and 
+  # convenient toolkit for GUI element (e.g. Widgets) 
+  # libraries. 
+  #
   # This is especially useful (and necessary) when 
   # generating forms. 
   #
@@ -53,6 +105,10 @@ module GUI
   #   HTML.hr(:class => 'divide')  
   #   # --> '<hr class="divide" />'
   #
+  # Same as 
+  #
+  #   HTML.hr.divide
+  #
   # This is effectively a wrapper for 
   #
   #   Element.new(:tag => :hr, :class => 'divide')
@@ -72,11 +128,16 @@ module GUI
   #
   # So the following statements are equivalent: 
   #
+  #   e = HTML.div.highlight 'hello' 
   #   e = HTML.div 'hello', :class => 'highlight'
   #   e = HTML.div(:class => :highlight) { 'hello' }
   #   e = HTML.div(:class => :highlight, :content => 'hello')
   #
-  # In all cases, e.to_s renders: 
+  # In all cases, e is an Element instance: 
+  #
+  #   e = Element.new(:tag => :div, :class => :highlight, :content => 'hello')
+  #
+  # That again renders to a String: 
   #
   #   <div class="highlight">hello</div>
   #
@@ -103,9 +164,9 @@ module GUI
   #     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' }
+  #         li.first { 'foo' } +
+  #         li.second { 'bar' } +
+  #         li.third { 'batz' }
   #       }
   #     }
   #   }
@@ -124,14 +185,17 @@ module GUI
   #
   # This is due to a class_eval restriction every 
   # builder struggles with at the moment. 
-  # (There is mixico, but it is not portable). 
+  # (There is mixico, but it is not portable), as 
+  # a price you pay for using class_eval on the 
+  # build block, which enables the concise syntax. 
   #
-  # To come by this inconvenience, use, for 
-  # example: 
+  # To come by this inconvenience, use puts, as you'd
+  # do in regular ruby code. 
+  # In the example: 
   #  
   #   HTML.build { 
   #     div { 
-  #       HTML.h2 { compute_string() }
+  #       h2 { puts compute_string() }
   #     }
   #   }.to_s
   #  
@@ -140,18 +204,6 @@ module GUI
   # This works, as explicit calls to class methods 
   # of HTML are not rendered using class_eval. 
   # 
-  # 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 ...
@@ -233,7 +285,6 @@ module GUI
     
     def self.render(meth_name, *args, &block)
       raise ::Exception.new('Missing attributes for HTML.' << meth_name.inspect) unless args
-
       e = Element.new(*args, &block)
       e.tag = meth_name
       e
@@ -241,7 +292,7 @@ module GUI
 
     def self.build(&block)
       raise ::Exception.new('Missing block for HTML.render') unless block_given?
-      self.class_eval(&block) 
+      Element.new(:tag => :pseudo) { self.class_eval(&block) }
     end
     
     
@@ -260,6 +311,10 @@ module GUI
       render(meth_name, *attribs, &block) 
     end
 
+    def self.puts(arg)
+      arg
+    end
+
 =begin
     XHTML_TAGS = [ :html, :div, :p, :input, :select, :option, :ul, :ol, :li ]
     for t in XHTML_TAGS do 

data/lib/aurita-gui/javascript.rb

@@ -153,6 +153,18 @@ module GUI
 
   end # class
 
+  class HTML
+
+    def self.js(&block) 
+      if block_given? then 
+        Javascript.build(&block)
+      else
+        Javascript
+      end
+    end
+
+  end
+
 end
 end
 

data/lib/aurita-gui/marshal.rb

@@ -0,0 +1,25 @@
+
+module Aurita
+module GUI
+
+  module Marshal_Helper
+    def marshal_dump
+      c = { :tag => @tag, :content => @content }
+      @attrib.update(c)
+    end
+  end
+
+  module Marshal_Helper_Class_Methods
+    def marshal_load(dump)
+      self.new(dump)
+    end
+  end
+
+  class Element
+    include Marshal_Helper
+    extend Marshal_Helper_Class_Methods
+  end
+
+end
+end
+

data/spec/html.rb

@@ -35,18 +35,37 @@ describe Aurita::GUI::HTML, "basic rendering" do
   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[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].content = 'Altered'
+    @e[0][1].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'
+  end
+
   it "should escape double-quotes in tag parameters" do
     e = Element.new(:onclick => 'alert("message");')
     e.onclick.should == 'alert("message");'
     e.to_s.should == '<div onclick="alert(\"message\");"></div>'
   end
 
+  it "should provide a shortcut for setting css classes" do
+
+    e = HTML.build { 
+          div.wrapper { 
+            h2.highlight {
+             'content here'
+            } +
+            p.footer('footer content')
+          }
+        }
+    e.to_s.should == '<div class="wrapper"><h2 class="highlight">content here</h2><p class="footer">footer content</p></div>'
+  end
+
 end

data/spec/javascript.rb

@@ -1,6 +1,7 @@
 
 require('rubygems')
 require('aurita-gui/javascript')
+require('aurita-gui/html')
 
 include Aurita::GUI
 
@@ -21,5 +22,14 @@ describe Aurita::GUI::Javascript, "basic rendering" do
     Javascript.Some.Namespace.do_stuff(23, 'wombat').to_s.should == "Some.Namespace.do_stuff(23,'wombat'); "
   end
 
+  it "should extend class HTML by a helper method '.js'" do
+    e = HTML.build { 
+      div.outer(:onclick => js.Wombat.alert('message')) { 
+        p.inner 'click me'
+      }
+    }
+    e.to_s.should == '<div class="outer" onclick="Wombat.alert(\'message\'); "><p class="inner">click me</p></div>'
+  end
+
 end
 

data/spec/marshal.rb

@@ -0,0 +1,33 @@
+
+require('rubygems')
+require('aurita-gui/javascript')
+require('aurita-gui/html')
+require('aurita-gui/marshal')
+
+include Aurita::GUI
+
+describe Aurita::GUI::Marshal_Helper, "dump and load" do
+  before do
+  end
+
+  it "should provide marshal dumping of Element instances" do
+    e = HTML.div 'content here', :id => 'dump_test'
+    l = Element.marshal_load(e.marshal_dump)
+    e.to_s.should == l.to_s
+  end
+
+  it "should also work for object hierarchies" do
+    e = HTML.build { 
+      div.outer(:id => :outer_div) { 
+        p.inner(:id => :inner_p) { 
+          'nested content'
+        } + 
+        button.confirm(:onclick => js.alert('clicked')) { 'click me' }
+      }
+    }
+    e.to_s.should == Element.marshal_load(e.marshal_dump).to_s
+    e[0][1].onclick.to_s.should == "alert('clicked'); "
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aurita-gui
 version: !ruby/object:Gem::Version 
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors: 
 - Tobias Fuchs
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-25 00:00:00 +01:00
+date: 2009-01-26 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -22,7 +22,6 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- fieldtest.rb
 - cheatsheet.rb
 - spec
 - History.txt
@@ -35,6 +34,7 @@ files:
 - LICENSE
 - lib/aurita-gui
 - lib/aurita-gui.rb
+- lib/aurita-gui/marshal.rb
 - lib/aurita-gui/javascript.rb
 - lib/aurita-gui/button.rb
 - lib/aurita-gui/form.rb
@@ -59,6 +59,7 @@ files:
 - lib/aurita-gui/form/template_helper.rb
 - lib/aurita-gui/form/input_field.rb
 - lib/aurita-gui/form/date_field.rb
+- spec/marshal.rb
 - spec/javascript.rb
 - spec/form.rb
 - spec/html.rb

data/fieldtest.rb

@@ -1,64 +0,0 @@
-
-require('rubygems')
-require('aurita-gui')
-require('test/unit/assertions')
-
-include Test::Unit::Assertions
-
-include Aurita::GUI
-
-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, 
-                       :label => 'Enter description', 
-                       :onfocus => "alert('input focussed');", 
-                       :value => 'some text')
-# Or set them afterwards: 
-text.onblur = "alert('i lost focus :(');"
-
-puts "\nDefault ---------------------------------\n"
-puts text.to_s
-puts "\nDisabled --------------------------------\n"
-text.disable! 
-puts text.to_s
-puts "\nEnabled ---------------------------------\n"
-text.enable! 
-puts text.to_s
-puts "\nReadonly --------------------------------\n"
-text.readonly! 
-puts text.to_s
-puts "\nEditable --------------------------------\n"
-text.editable! 
-puts text.to_s
-
-puts "\nTo hidden -------------------------------\n"
-puts text.to_hidden_field.to_s
-
-# Add it to the form: 
-form.add(text)
-puts "\nThe Form --------------------------------\n"
-
-# 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)
-form[:description].required = true
-checkbox.required = true
-form.fields = [ :description, :enable_me ]
-form.delete_field(:enable_me)
-puts form.to_s
-
-