Changeset 60

Timestamp:

05/29/2006 05:19:14 (3 years ago)

Author:

tec

Message:

merging in the xhtml-careful branch

Location:

trunk

Files:

• README (modified) (2 diffs)
• Rakefile (modified) (1 diff)
• lib/markaby.rb (modified) (1 diff)
• lib/markaby/builder.rb (modified) (11 diffs)
• lib/markaby/tags.rb (modified) (1 diff)
• test/test_markaby.rb (modified) (2 diffs)
• tools/rakehelp.rb (modified) (1 diff)

trunk/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( " | " )

trunk/Rakefile

@@ -13 +13 @@
 summary = "Markup as Ruby, write HTML in your native Ruby tongue"
 test_file = "test/test_markaby.rb"
-setup_gem("markaby", "0.4",  "Tim Fletcher and _why", summary, ['builder'], test_file)
+setup_gem("markaby", "0.5",  "Tim Fletcher and _why", summary, [['builder', '>=2.0.0']], test_file)

trunk/lib/markaby.rb

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

trunk/lib/markaby/builder.rb

@@ -52 +52 @@
     #
     def initialize(assigns = {}, helpers = nil, &block)
-      @stream = []
+      @streams = [[]]
       @assigns = assigns
       @margin = -1
@@ -59 +59 @@
       @output_helpers = @@default[:output_helpers]
       @output_meta_tag = @@default[:output_meta_tag]
+
+      use_tagset Markaby::XHTMLTransitionalTags
 
       if helpers
@@ -77 +79 @@
 
       @margin += 1
-      @builder = ::Builder::XmlMarkup.new(:indent => @indent, :margin => @margin, :target => @stream)
+      @builder = ::Builder::XmlMarkup.new(:indent => @indent, :margin => @margin, :target => @streams.last)
+
+      def @builder.target=(io)
+        @target = io
+      end
 
       instance_eval(&block) if block
@@ -84 +90 @@
     # Returns a string containing the HTML stream.  Internally, the stream is stored as an Array.
     def to_s
-      @stream.join
+      @streams.last.join
     end
 
@@ -105 +111 @@
     #
     def capture(&block)
-      old_stream = @stream.dup
-      @stream.replace []
-      str = instance_eval(&block).to_s
-      str = to_s unless @stream.empty?
-      @stream.replace old_stream
+      @streams.push(builder.target = [])
+      str = instance_eval(&block)
+      str = to_s unless @streams.last.compact.empty?
+      @streams.pop
+      builder.target = @streams.last
       str
     end
@@ -133 +139 @@
     # 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 k =~ /:/ or @tagset[tag].include? k.to_s.downcase.intern
+              raise InvalidXhtmlError, "no attribute `#{k}' on #{tag} elements"
+            end
+          end
+        end
+      end
       if block
         str = capture &block
         block = proc { text(str) }
       end
-      @builder.method_missing(tag, *args, &block)
+      fragment { @builder.method_missing(tag, *args, &block) }
     end
 
@@ -146 +164 @@
     # variables.  Here is the order of interception:
     #
+    # * If +sym+ is a helper method, the helper method is called
+    #   and output to the stream.
     # * If +sym+ is a recognized HTML tag, the tag is output
     #   or a CssProxy is returned if no arguments are given.
@@ -152 +172 @@
     # * If +sym+ is also the name of an instance variable, the
     #   value of the instance variable is returned.
-    # * If +sym+ is a helper method, the helper method is called
-    #   and output to the stream.
     # * Otherwise, +sym+ and its arguments are passed to tag!
     def method_missing(sym, *args, &block)
       if @helpers.respond_to?(sym)
         r = @helpers.send(sym, *args, &block)
-        @builder << r if @output_helpers
-        r
+        @output_helpers ? fragment { @builder << r } : r
       elsif ::Builder::XmlMarkup.instance_methods.include?(sym.to_s)
         @builder.__send__(sym, *args, &block)
-      elsif TAGS.include?(sym) or (FORM_TAGS.include?(sym) and args.empty?)
-        if args.empty? and block.nil?
+      elsif @tagset and @tagset_tags.include?(sym)
+        if @tagset_self_closing.include?(sym) and block
+          raise InvalidXhtmlError, "the `#{sym}' element is self-closing, please remove the block"
+        end
+        if args.empty? and block.nil? and not NO_PROXY.include?(sym)
           return CssProxy.new do |args, block|
-            if FORM_TAGS.include?(sym) and args.last.respond_to?(:to_hash) and args.last[:id]
+            if @tagset_forms.include?(sym) and args.last.respond_to?(:to_hash) and args.last[:id]
               args.last[:name] ||= args.last[:id]
             end
@@ -171 +191 @@
           end
         end
+        if not @tagset_self_closing.include?(sym) and args.first.respond_to?(:to_hash)
+          block ||= proc{}
+        end
         tag!(sym, *args, &block)
-      elsif SELF_CLOSING_TAGS.include?(sym)
-        tag!(sym, *args)
-      elsif value = instance_variable_get("@#{sym}")
-        value
+      elsif instance_variable_get("@#{sym}")
+        instance_variable_get("@#{sym}")
+      elsif @tagset.nil?
+        tag!(sym, *args, &block)
       else
-        tag!(sym, *args, &block)
+        raise NoMethodError, "no such method `#{sym}'"
       end
     end
@@ -197 +220 @@
     end
 
+    def use_tagset(tagset)
+      return if @tagset == tagset
+      @tagset = tagset
+      @tagset_tags = tagset.keys
+      @tagset_forms = @tagset_tags & FORM_TAGS
+      @tagset_self_closing = @tagset_tags & SELF_CLOSING_TAGS
+    end
+
     # Builds an html tag.  An XML 1.0 instruction and an XHTML 1.0 Transitional doctype
     # are prepended.  Also assumes <tt>:xmlns => "http://www.w3.org/1999/xhtml",
-    # "xml:lang" => "en", :lang => "en"</tt>.
+    # :lang => "en"</tt>.
     def html(*doctype, &block)
-      doctype = XHTMLTransitional if doctype.empty?
+      if doctype.empty?
+        doctype = XHTMLTransitional
+        use_tagset Markaby::XHTMLTransitionalTags
+      end
       declare!(:DOCTYPE, :html, :PUBLIC, *doctype)
       tag!(:html, :xmlns => "http://www.w3.org/1999/xhtml", "xml:lang" => "en", :lang => "en", &block)
@@ -209 +243 @@
     # Builds an html tag with XHTML 1.0 Strict doctype instead.
     def xhtml_strict(&block)
+      use_tagset Markaby::XHTMLStrictTags
       instruct!
       html *XHTMLStrict, &block
     end
 
+    private
+
+    def fragment
+      stream = @streams.last
+      f1 = stream.length
+      yield
+      f2 = stream.length - f1
+      Fragment.new(stream, f1, f2)
+    end
+
   end
+
+  class Fragment < ::Builder::BlankSlate
+    def initialize(s, a, b)
+      @s, @f1, @f2 = s, a, b
+    end
+    def method_missing(*a)
+      unless @str
+        @str = @s[@f1, @f2].to_s
+        @s[@f1, @f2] = [nil] * @f2
+        @str
+      end
+      @str.send(*a)
+    end
+  end
+
 end

trunk/lib/markaby/tags.rb

@@ -1 +1 @@
 module Markaby
 
-  TAGS = [
-    :a, :abbr, :acronym, :span, :b, :caption, :del, :cite, :code, :col,
-    :colgroup, :dd, :dfn, :dt, :em, :fieldset, :i, :img, :ins, :kbd, :p,
-    :label, :legend, :li, :optgroup, :option, :select, :small, :span, :strong,
-    :sub, :sup,  :tbody, :td, :textarea, :thead, :title, :th, :tr, :tfoot,
-    :tt, :address, :blockquote, :body, :div, :dl, :form, :h1, :h2, :h3, :head,
-    :noscript, :object, :ol, :pre, :q, :samp, :script, :style, :table, :ul
-  ]
+  # Common sets of attributes.
+  AttrCustom = [:id, :class, :style]
+  AttrEvents = [:onclick, :ondblclick, :onmousedown, :onmouseup, :onmouseover, :onmousemove, 
+      :onmouseout, :onkeypress, :onkeydown, :onkeyup]
+  AttrAnno = [:title, :lang, :dir]
+  Attrs = AttrCustom + AttrEvents + AttrAnno
+
+  # Very basic rules from the XHTML 1.0 Strict DTD.
+  XHTMLStrictTags = {
+    :pre => AttrCustom + AttrAnno + [:space], 
+    :em => Attrs,
+    :code => Attrs,
+    :h2 => Attrs,
+    :h3 => Attrs,
+    :h1 => Attrs,
+    :h6 => Attrs,
+    :dl => Attrs,
+    :h4 => Attrs,
+    :h5 => Attrs,
+    :area => Attrs + [:accesskey, :tabindex, :onfocus, :onblur, :shape, :coords, :href, :nohref, :alt], 
+    :meta => [:lang, :dir, :id, :name, :content, :scheme, "http-equiv".intern], 
+    :table => [], 
+    :dfn => Attrs,
+    :label => Attrs + [:for, :accesskey, :onfocus, :onblur], 
+    :select => Attrs + [:name, :size, :multiple, :disabled, :tabindex, :onfocus, :onblur, :onchange], 
+    :noscript => Attrs,
+    :style => [:lang, :dir, :id, :type, :media, :title, :space], 
+    :strong => Attrs,
+    :span => Attrs,
+    :sub => Attrs,
+    :img => Attrs + [:src, :alt, :longdesc, :height, :width, :usemap, :ismap], 
+    :title => [:lang, :dir, :id], 
+    :bdo => AttrCustom + [:title] + AttrEvents + [:lang, :dir], 
+    :tr => [], 
+    :tbody => [], 
+    :param => [:id, :name, :value, :valuetype, :type], 
+    :li => Attrs,
+    :acronym => Attrs,
+    :html => [:lang, :dir, :id, :xmlns], 
+    :caption => [], 
+    :tfoot => [], 
+    :th => [], 
+    :sup => Attrs,
+    :var => Attrs,
+    :input => Attrs + [:accesskey, :tabindex, :onfocus, :onblur, :type, :name, :value, :checked, :disabled, :readonly, :size, :maxlength, :src, :alt, :usemap, :onselect, :onchange, :accept], 
+    :td => Attrs + [:summary, :width, :border, :frame, :rules, :cellspacing, :cellpadding, :span, :align, :char, :charoff, :valign, :abbr, :axis, :headers, :scope, :rowspan, :colspan], 
+    :samp => Attrs,
+    :cite => Attrs,
+    :thead => [], 
+    :body => Attrs + [:onload, :onunload], 
+    :map => AttrCustom + [:lang, :dir, ] + AttrEvents + [:title, :name], 
+    :head => [:lang, :dir, :id, :profile], 
+    :blockquote => Attrs + [:cite], 
+    :fieldset => Attrs,
+    :option => Attrs + [:selected, :disabled, :label, :value], 
+    :form => Attrs + [:action, :method, :enctype, :onsubmit, :onreset, :accept, 'accept-charset'], 
+    :hr => Attrs,
+    :big => Attrs,
+    :dd => Attrs,
+    :object => Attrs + [:declare, :classid, :codebase, :data, :type, :codetype, :archive, :standby, :height, :width, :usemap, :name, :tabindex], 
+    :base => [:href, :id], 
+    :link => Attrs + [:charset, :href, :hreflang, :type, :rel, :rev, :media], 
+    :kbd => Attrs,
+    :br => AttrCustom + [:title], 
+    :address => Attrs,
+    :optgroup => Attrs + [:disabled, :label], 
+    :dt => Attrs,
+    :ins => Attrs + [:cite, :datetime], 
+    :b => Attrs,
+    :legend => Attrs + [:accesskey], 
+    :abbr => Attrs,
+    :a => Attrs + [:accesskey, :tabindex, :onfocus, :onblur, :charset, :type, :name, :href, :hreflang, :rel, :rev, :shape, :coords], 
+    :ol => Attrs,
+    :textarea => Attrs + [:accesskey, :tabindex, :onfocus, :onblur, :name, :rows, :cols, :disabled, :readonly, :onselect, :onchange], 
+    :colgroup => [], 
+    :i => Attrs,
+    :button => Attrs + [:accesskey, :tabindex, :onfocus, :onblur, :name, :value, :type, :disabled], 
+    :script => [:id, :charset, :type, :src, :defer, :space], 
+    :col => [], 
+    :q => Attrs + [:cite], 
+    :p => Attrs,
+    :del => Attrs + [:cite, :datetime], 
+    :small => Attrs,
+    :div => Attrs,
+    :tt => Attrs,
+    :ul => Attrs  
+  }
+
+  # Additional tags found in XHTML 1.0 Transitional
+  XHTMLTransitionalTags = XHTMLStrictTags.merge \
+    :strike => Attrs,
+    :center => Attrs,
+    :dir => Attrs + [:compact], 
+    :noframes => Attrs,
+    :basefont => [:id, :size, :color, :face], 
+    :u => Attrs,
+    :menu => Attrs + [:compact], 
+    :iframe => AttrCustom + [:title, :longdesc, :name, :src, :frameborder, :marginwidth, :marginheight, :scrolling, :align, :height, :width], 
+    :font => AttrCustom + AttrAnno + [:size, :color, :face], 
+    :s => Attrs,
+    :applet => AttrCustom + [:title, :codebase, :archive, :code, :object, :alt, :name, :width, :height, :align, :hspace, :vspace], 
+    :isindex => AttrCustom + AttrAnno + [:prompt]
+
+  # Additional attributes found in XHTML 1.0 Transitional
+  { :script => [:language],
+    :a => [:target],
+    :td => [:bgcolor, :nowrap, :height],
+    :p => [:align],
+    :h5 => [:align],
+    :h3 => [:align],
+    :li => [:type, :value],
+    :div => [:align],
+    :pre => AttrEvents + [:width],
+    :body => [:background, :bgcolor, :text, :link, :vlink, :alink],
+    :ol => [:type, :compact, :start],
+    :h4 => [:align],
+    :h2 => [:align],
+    :object => [:align, :border, :hspace, :vspace],
+    :img => [:name, :align, :border, :hspace, :vspace],
+    :link => [:target],
+    :legend => [:align],
+    :dl => [:compact],
+    :input => [:align],
+    :h6 => [:align],
+    :hr => [:align, :noshade, :size, :width],
+    :base => [:target],
+    :ul => [:type, :compact],
+    :br => [:clear],
+    :form => [:name, :target],
+    :area => [:target],
+    :h1 => [:align]
+  }.each do |k, v|
+      XHTMLTransitionalTags[k] += v
+  end
 
   FORM_TAGS = [ :form, :input, :select, :textarea ]
   SELF_CLOSING_TAGS = [ :hr, :br, :link, :meta, :input ]
+  NO_PROXY = [ :hr, :br ]
 
 end

trunk/test/test_markaby.rb

@@ -13 +13 @@
 
 class MarkabyTest < Test::Unit::TestCase
-  
+
   def mab(*args, &block)
     Markaby::Builder.new(*args, &block).to_s
+  end
+
+  def assert_exception(exclass, exmsg, *mab_args, &block)
+    begin
+      mab(*mab_args, &block)
+    rescue Exception => e
+      assert_equal exclass, e.class
+      assert_equal exmsg, e.message
+    end
   end
 
@@ -65 +74 @@
   end
 
+  def test_fragments
+    assert_equal %{<div>\n<h1>Monkeys</h1>\n<h2>\nGiraffes <small>Miniature</small>\n and <strong>Large</strong>\n</h2>\n<h3>Donkeys</h3>\n<h4>\nParakeet <b>\n<i>Innocent IV</i>\n</b>\n in Classic Chartreuse</h4>\n</div>\n}, 
+        mab { div { h1 "Monkeys"; h2 { "Giraffes #{small 'Miniature' } and #{strong 'Large'}" }; h3 "Donkeys"; h4 { "Parakeet #{b { i 'Innocent IV' }} in Classic Chartreuse" } } }
+    assert_equal %{<div>\n<h1>Monkeys</h1>\n<h2>\nGiraffes <strong>Miniature</strong>\n</h2>\n<h3>Donkeys</h3>\n</div>\n}, 
+        mab { div { h1 "Monkeys"; h2 { "Giraffes #{strong 'Miniature' }" }; h3 "Donkeys" } }
+    assert_equal %{<div>\n<h1>Monkeys</h1>\n<h2>\nGiraffes <small>Miniature</small>\n and <strong>Large</strong>\n</h2>\n<h3>Donkeys</h3>\n<h4>\nParakeet <strong>Large</strong>\n as well...</h4>\n</div>\n}, 
+        mab { 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(NoMethodError, "no such method `dav'") { dav {} }
+    assert_exception(Markaby::InvalidXhtmlError, "no attribute `styl' on div elements") { div(:styl => 'ok') {} }
+    assert_exception(Markaby::InvalidXhtmlError, "no attribute `class' on tbody elements") { tbody.okay {} }
+  end
+
+  def test_full_doc_transitional
+    doc = %{<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"DTD/xhtml1-transitional.dtd\">
+<html xml:lang=\"en\" xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"en\">
+<head>\n<meta content=\"text/html; charset=utf-8\" http-equiv=\"Content-Type\"/>\n<title>OKay</title>\n</head>\n</html>\n}
+    assert_equal doc, mab { instruct!; html { head { title 'OKay' } } }
+  end
+
+  def test_full_doc_transitional
+    doc = %{<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"DTD/xhtml1-strict.dtd\">
+<html lang=\"en\" xml:lang=\"en\" xmlns=\"http://www.w3.org/1999/xhtml\">
+<head>\n<meta content=\"text/html; charset=utf-8\" http-equiv=\"Content-Type\"/>\n<title>OKay</title>\n</head>\n</html>\n}
+    assert_equal doc, mab { xhtml_strict { head { title 'OKay' } } }
+  end
+
 end

trunk/tools/rakehelp.rb

@@ -80 +80 @@
         s.extra_rdoc_files = [ "README" ]
         dependencies.each do |dep|
-            s.add_dependency(dep)
+            s.add_dependency(*dep)
         end
         s.files = %w(README Rakefile setup.rb) +