Changeset 55

Timestamp:

05/22/2006 02:06:16 (3 years ago)

Author:

why

Message:

• lib/markaby/builder.rb: validate correct attributes on xhtml elements.
  
• README: explain the implicit stringification and validation additions on the branch.
  

Location:

branches/xhtml-careful

Files:

• README (modified) (2 diffs)
• lib/markaby.rb (modified) (1 diff)
• lib/markaby/builder.rb (modified) (1 diff)
• test/test_markaby.rb (modified) (2 diffs)

branches/xhtml-careful/README

@@ -133 +133 @@
 IDs may be added by the use of bang methods:
 
-  div.page!
-    div.content!
+  div.page! {
+    div.content! {
       h1 "A Short Short Saintly Dog"
-    end
-  end
+    }
+  }
 
 Which results in:
@@ -156 +156 @@
   end
 
-== The <tt>capture</tt> Method
-
-Want to catch a block of HTML as a string and play with it a bit?
-Use the <tt>capture</tt> method.
-
-Commonly used to join HTML blocks together:
+== Markaby prevents invalid HTML
+
+Since Markaby knows which doctype you're using, it checks a big
+list of valid tags and attributes before printing anything.
+
+  >> div :styl => "padding: 10px" do
+  >>   img :src => "samorost.jpg"
+  >> end
+  InvalidHtmlError: no such attribute `styl'
+
+== Auto-stringification
+
+If you end up using any of your Markaby "tags" as a string, the
+tag won't be output.  It'll be up to you to add the new string
+back into the HTML output.
+
+This means if you call <tt>to_s</tt>, you'll get a string back.
+
+  div.title { "Rock Bottom" + span(" by Robert Wyatt").to_s }
+
+But, when you're adding strings in Ruby, <tt>to_s</tt> happens automatically.
+
+  div.title { "Rock Bottom" + span(" by Robert Wyatt") }
+
+Interpolation works fine.
+
+  div.title { "Rock Bottom #{span(" by Robert Wyatt")}" }
+
+And any other operation you might perform on a string.
 
   div.menu! \
     ['5.gets', 'bits', 'cult', 'inspect', '-h'].map do |category|
-      capture { link_to category }
+      link_to category
     end.
     join( " | " )

branches/xhtml-careful/lib/markaby.rb

@@ -21 +21 @@
 module Markaby
   VERSION = '0.4'
+
+  class InvalidXhtmlError < Exception; end
 end
 

branches/xhtml-careful/lib/markaby/builder.rb

@@ -145 +145 @@
     # the arguments are the same as the tags implemented via method_missing.
     def tag!(tag, *args, &block)
+      if @tagset
+          if !@tagset.has_key?(tag)
+              raise InvalidXhtmlError, "no element `#{tag}' for #{doctype}"
+          elsif args.last.respond_to?(:to_hash)
+              attrs = args.last.to_hash
+              attrs.each do |k, v|
+                  unless @tagset[tag].include? k
+                      raise InvalidXhtmlError, "no attribute `#{k}' on #{tag} elements"
+                  end
+              end
+          end
+      end
       if block
         str = capture &block

branches/xhtml-careful/test/test_markaby.rb

@@ -14 +14 @@
 class MarkabyTest < Test::Unit::TestCase
   
+  def assert_exception(str, exclass, exmsg)
+    begin
+      mab(str)
+    rescue Exception => e
+      assert_equal e.class, exclass
+      assert_equal e.message[/^.+?: (.+)$/, 1], exmsg
+    else
+      assert nil, exclass
+    end
+  end
+
   def mab(string, assigns = {}, helpers = nil)
     Markaby::Template.new(string.to_s).render(assigns, helpers)
@@ -64 +75 @@
         mab(%q{div { @a = small 'Miniature'; @b = strong 'Large'; h1 "Monkeys"; h2 { "Giraffes #{@a} and #{@b}" }; h3 "Donkeys"; h4 { "Parakeet #{@b} as well..." }}})
   end
+
+  def test_invalid_xhtml
+    assert_exception %{dav {}}, NoMethodError, "no such method `dav'"
+    assert_exception %{div(:styl => 'ok') {}}, Markaby::InvalidXhtmlError, "no attribute `styl' on div elements"
+    assert_exception %{tbody.okay {}}, Markaby::InvalidXhtmlError, "no attribute `class' on tbody elements"
+  end
 end