markaby 0.2 → 0.3

data/README

@@ -0,0 +1,189 @@
+= Markaby (Markup as Ruby)
+
+Markaby is a very short bit of code for writing HTML pages in pure Ruby.
+It is an alternative to ERb which weaves the two languages together.
+Also a replacement for templating languages which use primitive languages
+that blend with HTML.
+
+== Using Markaby as a Rails plugin
+
+Write Rails templates in pure Ruby.  Example layout:
+
+  html do
+    head do
+      title 'Products: ' + action_name
+      stylesheet_link_tag 'scaffold'
+    end
+  
+    body do
+      p flash[:notice], :style => "color: green"
+  
+      self << content_for_layout
+    end
+  end
+
+== Using Markaby as a Ruby class
+
+Markaby is flaming easy to call from your Ruby classes.
+
+  require 'markaby'
+
+  mab = Markaby::Builder.new
+  mab.html do
+    head { title "Boats.com" }
+    body do
+      h1 "Boats.com has great deals"
+      ul do
+        li "$49 for a canoe"
+        li "$39 for a raft"
+        li "$29 for a huge boot that floats and can fit 5 people"
+      end
+    end
+  end
+  puts mab.to_s
+
+Markaby::Builder.new does take two arguments for passing in variables and
+a helper object.  You can also affix the block right on to the class.
+
+See Markaby::Builder for all of that.
+
+= A Note About <tt>instance_eval</tt>
+
+The Markaby::Builder class is different from the normal Builder class,
+since it uses <tt>instance_eval</tt> when running blocks.  This cleans
+up the appearance of the Markaby code you write.  If <tt>instance_eval</tt>
+was not used, the code would look like this:
+
+  mab = Markaby::Builder.new
+  mab.html do
+    mab.head { mab.title "Boats.com" }
+    mab.body do
+      mab.h1 "Boats.com has great deals"
+    end
+  end
+  puts mab.to_s
+
+So, the advantage is the cleanliness of your code.  The disadvantage is that
+the block will run inside the Markaby::Builder object's scope.  This means
+that inside these blocks, <tt>self</tt> will be your Markaby::Builder object.
+When you use instance variables in these blocks, they will be instance variables
+of the Markaby::Builder object.
+
+This doesn't effect Rails users, but when used in regular Ruby code, it can
+be a bit disorienting.  You are recommended to put your Markaby code in a
+module where it won't mix with anything.
+
+= A Note About Rails Helpers
+
+When used in Rails templates, the Rails helper object is passed into 
+Markaby::Builder.  When you call helper methods inside Markaby, the output
+from those methods will be output to the stream.  This is incredibly
+handy, since most Rails helpers output HTML tags.
+
+  head do
+    javascript_include_tag 'prototype'
+    autodiscovery_link_tag
+  end
+
+However, some methods are designed to give back a String which you can use
+elsewhere.  Call the <tt>@helpers</tt> object with the method and you'll get
+the String back and nothing will be output.
+
+  p "Total is: #{@helper.number_to_human_size @file_bytes}"
+
+Conversely, you may call instance variables from your controller by using
+a method and its value will be returned, nothing will be output.
+
+  # Inside imaginary ProductController
+  def list
+    @products = Product.find :all
+  end
+
+  # Inside app/views/product/list.mab
+  products.each do |product|
+    p product.title
+  end
+
+= A Quick Tour
+
+If you dive right into Markaby, it'll probably make good sense, but you're
+likely to run into a few kinks.  Keep these pointers in mind and everything
+will be fine.
+
+== Element Classes
+
+Element classes may be added by hooking methods onto container elements:
+
+  div.entry do
+    h2.entryTitle 'Son of WebPage'
+    div.entrySection %{by Anthony}
+    div.entryContent 'Okay, once again, the idea here is ...'
+  end
+
+Which results in:
+
+  <div class="entry">
+    <h2 class="entryTitle">Son of WebPage</h2>
+    <div class="entrySection">by Anthony</div>
+    <div class="entryContent">Okay, once again, the idea here is ...</div>
+  </div>
+
+== Element IDs
+
+IDs may be added by the use of bang methods:
+
+  div.page!
+    div.content!
+      h1 "A Short Short Saintly Dog"
+    end
+  end
+
+Which results in:
+
+  <div id="page">
+    <div id="content">
+      <h1>A Short Short Saintly Dog</h1>
+    </div>
+  </div>
+
+== Markaby assumes XHTML 1.0 Transitional 
+
+Output defaults to XHTML 1.0 Transitional. To do XHTML 1.0 Strict,
+try this:
+
+  xhtml_strict do
+    # innerds
+  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:
+
+  div.menu! \
+    ['5.gets', 'bits', 'cult', 'inspect', '-h'].map do |category|
+      capture { link_to category }
+    end.
+    join( " | " )
+
+== The <tt>tag!</tt> Method
+
+If you need to force a tag at any time, call <tt>tag!</tt> with the
+tag name followed by the possible arguments and block.  The CssProxy
+won't work with this technique.
+
+  tag! :select, :id => "country_list" do
+    countries.each do |country|
+      tag! :option, country
+    end
+  end
+
+= Credits
+
+Markaby is a work of immense hope by Tim Fletcher and why the lucky stiff.
+Thankyou for giving it a whirl.
+
+Markaby is inspired by the HTML library within cgi.rb.  Hopefully it will
+turn around and take some cues.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'tools/rakehelp'
+require 'fileutils'
+include FileUtils
+
+setup_tests
+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)

data/doc/rdoc/classes/Markaby.html

@@ -0,0 +1,192 @@
+<?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>

data/doc/rdoc/classes/Markaby/ActionControllerHelper.html

@@ -0,0 +1,145 @@
+<?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::ActionControllerHelper</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::ActionControllerHelper</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <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> helpers for Rails.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000005">render_markaby</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
+
+        <div class="method-heading">
+          <a href="ActionControllerHelper.src/M000005.html" target="Code" class="method-signature"
+            onclick="popupCode('ActionControllerHelper.src/M000005.html');return false;">
+          <span class="method-name">render_markaby</span><span class="method-args">(options = {}, &amp;block)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Returns a string of HTML built from the attached <tt>block</tt>. Any
+<tt>options</tt> are passed into the render method.
+</p>
+<p>
+Use this method in your controllers to output <a
+href="../Markaby.html">Markaby</a> directly from inside.
+</p>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>