markaby 0.3 → 0.4

data/Rakefile

@@ -12,4 +12,4 @@ setup_rdoc ['README', 'CHANGELOG', 'lib/**/*.rb']
 
 summary = "Markup as Ruby, write HTML in your native Ruby tongue"
 test_file = "test/test_markaby.rb"
-setup_gem("markaby", "0.3",  "Tim Fletcher and _why", summary, ['builder'], test_file)
+setup_gem("markaby", "0.4",  "Tim Fletcher and _why", summary, ['builder'], test_file)

data/lib/markaby.rb

@@ -1,4 +1,4 @@
-# = About lib/markany.rb
+# = About lib/markaby.rb
 #
 # By requiring <tt>lib/markaby</tt>, you can load Markaby's dependency (the Builder library,)
 # as well as the full set of Markaby classes.
@@ -19,7 +19,7 @@ $:.unshift File.expand_path(File.dirname(__FILE__))
 # * Markaby::Template: a class for hooking Markaby into Rails as a
 #   proper templating language.
 module Markaby
-    VERSION = '0.3'
+  VERSION = '0.4'
 end
 
 unless defined?(Builder)

data/lib/markaby/builder.rb

@@ -18,6 +18,22 @@ module Markaby
   #
   class Builder
 
+    @@default = {
+      :indent => 2,
+      :output_helpers => true,
+      :output_xml_instruction => true,
+      :output_meta_tag => true,
+      :image_tag_options => { :border => '0', :alt => '' }
+    }
+
+    def self.set(option, value)
+      @@default[option] = value
+    end
+
+    XHTMLTransitional = ["-//W3C//DTD XHTML 1.0 Transitional//EN", "DTD/xhtml1-transitional.dtd"]
+    
+    XHTMLStrict = ["-//W3C//DTD XHTML 1.0 Strict//EN", "DTD/xhtml1-strict.dtd"]
+
     attr_accessor :output_helpers
 
     # Create a Markaby builder object.  Pass in a hash of variable assignments to
@@ -38,8 +54,12 @@ module Markaby
     def initialize(assigns = {}, helpers = nil, &block)
       @stream = []
       @assigns = assigns
-      @builder = ::Builder::XmlMarkup.new(:indent => 2, :target => @stream)
-      @output_helpers = true
+      @margin = -1
+
+      @indent = @@default[:indent]
+      @output_helpers = @@default[:output_helpers]
+      @output_meta_tag = @@default[:output_meta_tag]
+      @output_xml_instruction = @@default[:output_xml_instruction]
 
       if helpers.nil?
         @helpers = nil
@@ -59,6 +79,9 @@ module Markaby
         end
       end
 
+      @margin += 1
+      @builder = ::Builder::XmlMarkup.new(:indent => @indent, :margin => @margin, :target => @stream)
+
       if block
         r = instance_eval &block
         text(r) if to_s.empty?
@@ -67,7 +90,7 @@ module Markaby
 
     # Returns a string containing the HTML stream.  Internally, the stream is stored as an Array.
     def to_s
-      @builder.target!.join
+      @stream.join
     end
 
     # Write a +string+ to the HTML stream without escaping it.
@@ -76,21 +99,24 @@ module Markaby
       nil
     end
     alias_method :<<, :text
+    alias_method :concat, :text
+
+    # Emulate ERB to satisfy helpers like <tt>form_for</tt>.
+    def _erbout; self end
 
     # Captures the HTML code built inside the +block+.  This is done by creating a new
-    # builder object, running the block and passing back its stream as a string.
+    # stream for the builder object, running the block and passing back its stream as a string.
     #
     #   >> Markaby::Builder.new.capture { h1 "TEST"; h2 "CAPTURE ME" }
     #   => "<h1>TITLE</h1>\n<h2>CAPTURE ME</h2>\n"
     #
     def capture(&block)
-      assigns = instance_variables.inject({}) do |hsh, iv|
-        unless ['@stream', '@builder', '@assigns', '@helpers'].include?(iv)
-          hsh[iv[1..-1]] = instance_variable_get(iv)
-        end
-        hsh
-      end
-      self.class.new(assigns, @helpers, &block).to_s
+      old_stream = @stream.dup
+      @stream.replace []
+      str = instance_eval(&block).to_s
+      str = @stream.join unless @stream.empty?
+      @stream.replace old_stream
+      str
     end
 
     # Content_for will store the given block in an instance variable for later use 
@@ -136,45 +162,45 @@ module Markaby
     #   and output to the stream.
     # * Otherwise, +sym+ and its arguments are passed to tag!
     def method_missing(sym, *args, &block)
-      args.each do |arg|
-        @stream.delete_if { |x| x.object_id == arg.object_id }
-      end
-      if TAGS.include?(sym)
+      if TAGS.include?(sym) or (FORM_TAGS.include?(sym) and args.empty?)
         if args.empty? and block.nil?
           return CssProxy.new do |args, block|
+            if FORM_TAGS.include?(sym) and args.last.respond_to?(:to_hash) and args.last[:id]
+              args.last[:name] ||= args.last[:id]
+            end
             tag!(sym, *args, &block)
           end
         end
+        if args.first.respond_to? :to_hash
+          block ||= proc{}
+        end
         tag!(sym, *args, &block)
       elsif SELF_CLOSING_TAGS.include?(sym)
         tag!(sym, *args)
-      elsif instance_variable_get("@#{sym}")
-        instance_variable_get("@#{sym}")
       elsif @helpers.respond_to?(sym)
         r = @helpers.send(sym, *args, &block)
         @builder << r if @output_helpers
         r
+      elsif instance_variable_get("@#{sym}")
+        instance_variable_get("@#{sym}")
       else
         tag!(sym, *args, &block)
       end
     end
 
-    def p(*args, &block)
-      method_missing(:p, *args, &block)
-    end
-
-    @@default_image_tag_options ||= { :border => '0', :alt => '' }
+    undef_method :p
+    undef_method :select
 
     # Builds a image tag.  Assumes <tt>:border => '0', :alt => ''</tt>.
     def img(opts = {})
-      tag!(:img, @@default_image_tag_options.merge(opts))
+      tag!(:img, @@default[:image_tag_options].merge(opts))
     end
 
     # Builds a head tag.  Adds a <tt>meta</tt> tag inside with Content-Type
     # set to <tt>text/html; charset=utf-8</tt>.
     def head(*args, &block)
       tag!(:head, *args) do
-        tag!(:meta, 'http-equiv' => 'Content-Type', 'content' => 'text/html; charset=utf-8')
+        tag!(:meta, "http-equiv" => "Content-Type", "content" => "text/html; charset=utf-8") if @output_meta_tag
         instance_eval &block
       end
     end
@@ -182,20 +208,18 @@ module Markaby
     # 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>.
-    def html(*args, &block)
-      if args.empty?
-        args = ["-//W3C//DTD XHTML 1.0 Transitional//EN", "DTD/xhtml1-transitional.dtd"]
-      end
-      @builder.instruct!
-      @builder.declare!(:DOCTYPE, :html, :PUBLIC, *args)
-      tag!(:html, :xmlns => "http://www.w3.org/1999/xhtml",
-        "xml:lang" => "en", :lang => "en", &block)
+    def html(*doctype, &block)
+      doctype = XHTMLTransitional if doctype.empty?
+      @builder.instruct! if @output_xml_instruction
+      @builder.declare!(:DOCTYPE, :html, :PUBLIC, *doctype)
+      tag!(:html, :xmlns => "http://www.w3.org/1999/xhtml", "xml:lang" => "en", :lang => "en", &block)
     end
     alias_method :xhtml_transitional, :html
 
     # Builds an html tag with XHTML 1.0 Strict doctype instead.
     def xhtml_strict(&block)
-      html("-//W3C//DTD XHTML 1.0 Strict//EN", "DTD/xhtml1-strict.dtd", &block)
+      html XHTMLStrict, &block
     end
+
   end
 end

data/lib/markaby/tags.rb

@@ -9,6 +9,7 @@ module Markaby
     :noscript, :object, :ol, :pre, :q, :samp, :script, :style, :table, :ul
   ]
 
+  FORM_TAGS = [ :form, :input, :select, :textarea ]
   SELF_CLOSING_TAGS = [ :hr, :br, :link, :meta, :input ]
 
 end

data/test/test_markaby.rb

@@ -1,26 +1,22 @@
 require 'test/unit'
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'markaby'))
 
+module MarkabyTestHelpers
+  def link_to(obj)
+    %{<a href="">#{obj}</a>}
+  end
+  def pluralize(n, string)
+    n == 1 ? string : string + "s"
+  end
+  module_function :link_to, :pluralize
+end
+
 class MarkabyTest < Test::Unit::TestCase
   
   def mab(string, assigns = {}, helpers = nil)
     Markaby::Template.new(string.to_s).render(assigns, helpers)
   end
   
-  def setup
-    @helpers = Module.new do
-      def link_to(obj)
-        %{<a href="">#{obj}</a>}
-      end
-      def pluralize(n, string)
-        n == 1 ? string : string + "s"
-      end
-      module_function :link_to, :pluralize
-    end
-    @helpers_ohf = @helpers.dup
-    @helpers_ohf.instance_variable_set("@output_helpers", false)
-  end
-
   def test_simple
     assert_equal "<hr/>\n", mab("hr")
     assert_equal "<p>foo</p>\n", mab("p 'foo'")
@@ -36,6 +32,7 @@ class MarkabyTest < Test::Unit::TestCase
   def test_escaping
     assert_equal "<h1>Apples &amp; Oranges</h1>\n", mab("h1 'Apples & Oranges'")
     assert_equal "<h1>\nApples & Oranges</h1>\n", mab("h1 { 'Apples & Oranges' }")
+    assert_equal "<h1 class=\"fruits&amp;floots\">Apples</h1>\n", mab("h1 'Apples', :class => 'fruits&floots'")
   end
 
   def test_capture
@@ -45,9 +42,17 @@ class MarkabyTest < Test::Unit::TestCase
     assert mab("capture { h1 'hello world' }").empty?
   end
 
+  def test_ivars
+    html = "<div>\n<h1>Steve</h1>\n<div>\n<h2>Gerald</h2>\n</div>\n<h3>Gerald</h3>\n</div>\n"
+    assert_equal html, mab("div { @name = 'Steve'; h1 @name; div { @name = 'Gerald'; h2 @name }; h3 @name }")
+    assert_equal html, mab("div { @name = 'Steve'; h1 @name; self << capture { div { @name = 'Gerald'; h2 @name } }; h3 @name }")
+    assert_equal html, mab("div { h1 @name; self << capture { div { @name = 'Gerald'; h2 @name } }; h3 @name }",
+                           :name => 'Steve')
+  end
+
   def test_output_helpers
-    assert_equal %{<a href="">edit</a>}, mab("link_to('edit')", {}, @helpers)
-    assert mab("link_to('edit')", {}, @helpers_ohf).empty?
+    assert_equal %{<a href="">edit</a>}, mab("link_to('edit')", {}, MarkabyTestHelpers)
+    assert mab("@output_helpers = false; link_to('edit')", {}, MarkabyTestHelpers).empty?
   end
 
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: markaby
 version: !ruby/object:Gem::Version 
-  version: "0.3"
-date: 2006-02-01 00:00:00 -07:00
+  version: "0.4"
+date: 2006-04-11 00:00:00 -06:00
 summary: Markup as Ruby, write HTML in your native Ruby tongue
 require_paths: 
 - lib
@@ -31,75 +31,16 @@ files:
 - README
 - Rakefile
 - setup.rb
-- doc/rdoc
-- doc/rdoc/created.rid
-- doc/rdoc/rdoc-style.css
-- doc/rdoc/files
-- doc/rdoc/classes
-- doc/rdoc/fr_file_index.html
-- doc/rdoc/fr_class_index.html
-- doc/rdoc/fr_method_index.html
-- doc/rdoc/index.html
-- doc/rdoc/files/README.html
-- doc/rdoc/files/CHANGELOG.html
-- doc/rdoc/files/lib
-- doc/rdoc/files/lib/markaby_rb.html
-- doc/rdoc/files/lib/markaby
-- doc/rdoc/files/lib/markaby/metaid_rb.html
-- doc/rdoc/files/lib/markaby/tags_rb.html
-- doc/rdoc/files/lib/markaby/builder_rb.html
-- doc/rdoc/files/lib/markaby/cssproxy_rb.html
-- doc/rdoc/files/lib/markaby/view_rb.html
-- doc/rdoc/files/lib/markaby/template_rb.html
-- doc/rdoc/files/lib/markaby/helper_rb.html
-- doc/rdoc/classes/Object.src
-- doc/rdoc/classes/Markaby
-- doc/rdoc/classes/Object.html
-- doc/rdoc/classes/Markaby.html
-- doc/rdoc/classes/Object.src/M000001.html
-- doc/rdoc/classes/Object.src/M000002.html
-- doc/rdoc/classes/Object.src/M000003.html
-- doc/rdoc/classes/Object.src/M000004.html
-- doc/rdoc/classes/Markaby/ActionControllerHelper.src
-- doc/rdoc/classes/Markaby/CssProxy.src
-- doc/rdoc/classes/Markaby/Builder.src
-- doc/rdoc/classes/Markaby/Template.src
-- doc/rdoc/classes/Markaby/View.src
-- doc/rdoc/classes/Markaby/ActionControllerHelper.html
-- doc/rdoc/classes/Markaby/CssProxy.html
-- doc/rdoc/classes/Markaby/Builder.html
-- doc/rdoc/classes/Markaby/Template.html
-- doc/rdoc/classes/Markaby/View.html
-- doc/rdoc/classes/Markaby/ActionControllerHelper.src/M000005.html
-- doc/rdoc/classes/Markaby/CssProxy.src/M000006.html
-- doc/rdoc/classes/Markaby/CssProxy.src/M000007.html
-- doc/rdoc/classes/Markaby/Builder.src/M000008.html
-- doc/rdoc/classes/Markaby/Builder.src/M000009.html
-- doc/rdoc/classes/Markaby/Builder.src/M000010.html
-- doc/rdoc/classes/Markaby/Builder.src/M000012.html
-- doc/rdoc/classes/Markaby/Builder.src/M000013.html
-- doc/rdoc/classes/Markaby/Builder.src/M000014.html
-- doc/rdoc/classes/Markaby/Builder.src/M000015.html
-- doc/rdoc/classes/Markaby/Builder.src/M000016.html
-- doc/rdoc/classes/Markaby/Builder.src/M000017.html
-- doc/rdoc/classes/Markaby/Builder.src/M000018.html
-- doc/rdoc/classes/Markaby/Builder.src/M000019.html
-- doc/rdoc/classes/Markaby/Builder.src/M000021.html
-- doc/rdoc/classes/Markaby/Template.src/M000022.html
-- doc/rdoc/classes/Markaby/Template.src/M000023.html
-- doc/rdoc/classes/Markaby/View.src/M000024.html
-- doc/rdoc/classes/Markaby/View.src/M000025.html
 - test/test_markaby.rb
-- test/example.rb
 - lib/markaby
 - lib/markaby.rb
-- lib/markaby/metaid.rb
+- lib/markaby/helper.rb
 - lib/markaby/tags.rb
+- lib/markaby/metaid.rb
 - lib/markaby/builder.rb
 - lib/markaby/cssproxy.rb
 - lib/markaby/view.rb
 - lib/markaby/template.rb
-- lib/markaby/helper.rb
 - tools/rakehelp.rb
 test_files: 
 - test/test_markaby.rb

data/doc/rdoc/classes/Markaby.html

@@ -1,192 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html 
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>Module: Markaby</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-
-    elemStyle = elem.style;
-    
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-
-    return true;
-  }
-  
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  
-  // ]]>
-  </script>
-
-</head>
-<body>
-
-
-
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Module</strong></td>
-          <td class="class-name-in-header">Markaby</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../files/lib/markaby_rb.html">
-                lib/markaby.rb
-                </a>
-        <br />
-                <a href="../files/lib/markaby/tags_rb.html">
-                lib/markaby/tags.rb
-                </a>
-        <br />
-                <a href="../files/lib/markaby/builder_rb.html">
-                lib/markaby/builder.rb
-                </a>
-        <br />
-                <a href="../files/lib/markaby/cssproxy_rb.html">
-                lib/markaby/cssproxy.rb
-                </a>
-        <br />
-                <a href="../files/lib/markaby/view_rb.html">
-                lib/markaby/view.rb
-                </a>
-        <br />
-                <a href="../files/lib/markaby/template_rb.html">
-                lib/markaby/template.rb
-                </a>
-        <br />
-                <a href="../files/lib/markaby/helper_rb.html">
-                lib/markaby/helper.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-
-        </table>
-    </div>
-  <!-- banner header -->
-
-  <div id="bodyContent">
-
-
-
-  <div id="contextContent">
-
-    <div id="description">
-      <p>
-<a href="Markaby.html">Markaby</a> is a module containing all of the great
-<a href="Markaby.html">Markaby</a> classes that do such an excellent job.
-</p>
-<ul>
-<li><a href="Markaby/Builder.html">Markaby::Builder</a>: the class for actually
-calling the Ruby methods which write the HTML.
-
-</li>
-<li>Markaby::CSSProxy: a class which adds element classes and IDs to elements
-when used within <a href="Markaby/Builder.html">Markaby::Builder</a>.
-
-</li>
-<li>Markaby::MetAid: metaprogramming helper methods.
-
-</li>
-<li>Markaby::Tags: lists the roles of various XHTML tags to help <a
-href="Markaby/Builder.html">Builder</a> use these tags as they are
-intended.
-
-</li>
-<li><a href="Markaby/Template.html">Markaby::Template</a>: a class for hooking
-<a href="Markaby.html">Markaby</a> into Rails as a proper templating
-language.
-
-</li>
-</ul>
-
-    </div>
-
-
-   </div>
-
-
-  </div>
-
-
-    <!-- if includes -->
-
-    <div id="section">
-
-    <div id="class-list">
-      <h3 class="section-bar">Classes and Modules</h3>
-
-      Module <a href="Markaby/ActionControllerHelper.html" class="link">Markaby::ActionControllerHelper</a><br />
-Class <a href="Markaby/Builder.html" class="link">Markaby::Builder</a><br />
-Class <a href="Markaby/CssProxy.html" class="link">Markaby::CssProxy</a><br />
-Class <a href="Markaby/Template.html" class="link">Markaby::Template</a><br />
-Class <a href="Markaby/View.html" class="link">Markaby::View</a><br />
-
-    </div>
-
-    <div id="constants-list">
-      <h3 class="section-bar">Constants</h3>
-
-      <div class="name-list">
-        <table summary="Constants">
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">VERSION</td>
-          <td>=</td>
-          <td class="context-item-value">'0.3'</td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">TAGS</td>
-          <td>=</td>
-          <td class="context-item-value">[     :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</td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">SELF_CLOSING_TAGS</td>
-          <td>=</td>
-          <td class="context-item-value">[ :hr, :br, :link, :meta, :input ]</td>
-        </tr>
-        </table>
-      </div>
-    </div>
-
-
-
-      
-
-
-    <!-- if method_list -->
-
-
-  </div>
-
-
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>