RubyGems - joho-Markaby - Versions diffs - 0.6.0 - Mend

joho-Markaby 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (26) hide show

data/CHANGELOG +43 -0
data/Markaby.gemspec +69 -0
data/README +256 -0
data/Rakefile +49 -0
data/VERSION +1 -0
data/init.rb +13 -0
data/lib/markaby.rb +35 -0
data/lib/markaby/builder.rb +289 -0
data/lib/markaby/cssproxy.rb +48 -0
data/lib/markaby/kernel_method.rb +7 -0
data/lib/markaby/metaid.rb +16 -0
data/lib/markaby/rails.rb +90 -0
data/lib/markaby/tags.rb +179 -0
data/lib/markaby/template.rb +31 -0
data/setup.rb +1551 -0
data/test/rails/markaby/_monkeys.mab +12 -0
data/test/rails/markaby/broken.mab +7 -0
data/test/rails/markaby/create.mab +9 -0
data/test/rails/markaby/index.mab +7 -0
data/test/rails/monkeys.html +13 -0
data/test/rails/test_helper.rb +7 -0
data/test/rails/test_preamble.rb +30 -0
data/test/rails_test.rb +99 -0
data/test/test_markaby.rb +126 -0
data/tools/rakehelp.rb +106 -0
metadata +94 -0

data/CHANGELOG ADDED Viewed

@@ -0,0 +1,43 @@
+= 0.6
+=== 23 August, 2009
+* Canonical repo changed to http://github.com/joho/markaby
+* Gem moved to Github (using jeweler)
+* Rails init process changed to work with rails > 2.1
+* Default attributes on the root (<html>) element can now be overidden
+* Reworked CssProxy, allowing attributes on hr and br
+* Added Kernel#mab convenience method (require 'markaby/kernel_method')
+* WhenOnRails: Can now use :locals with render_markaby
+* WhenOnRails: Template errors now report line number
+= 0.5
+=== 03 October, 2006
+* XHTML Validation built in.  So, if you have an invalid tag: error.  Invalid attribute: error.
+  And two identical IDs in the same document: error.  Optional, of course.  But handy!
+* New Markaby::Fragment class adds much flexibility.  If it discovers you are using a tag as a string,
+  the tag is removed from the stream.  (<tt>div { strong("Real") + " Giraffes" }</tt>)
+* The prevailing rule now is: if you want it escaped, pass it as an arg.  If not, pass it to a block.
+* Again, escaped: <tt>h1("Me & You Have a Giraffe")</tt>
+* And, not escaped: <tt>h1 { "<a href='/'>Home</a>" }</tt>
+* Less method_missing, meaning: faster calls all around.  Tag methods generated based on doctype.
+* The <tt>html</tt> method doesn't write the doctype tags and meta tags.  You must use <tt>xhtml_transitional</tt> or <tt>xhtml_strict</tt> methods to do that.
+* The <tt>img</tt> method doesn't try to inject an empty alt tag and a zero border.  No more of that.
+= 0.3
+=== 02nd February, 2006
+* Allow Markaby::Builder.new without args.
+* Rails helper method render_markaby.
+= 0.2
+=== 17th January, 2006
+* Public announcement.
+* DOCTYPES, head tags.
+* Works with Rails helpers.
+= 0.1
+=== 05th January, 2006
+* Initial import.

data/Markaby.gemspec ADDED Viewed

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = %q{Markaby}
+  s.version = "0.6.0"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["_why", "Tim Fletcher", "John Barton", "spox", "smtlaissezfaire"]
+  s.date = %q{2009-08-23}
+  s.description = %q{Tim Fletcher and _why's ruby driven HTML templating system}
+  s.email = %q{jrbarton@gmail.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "CHANGELOG",
+     "Markaby.gemspec",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/markaby.rb",
+     "lib/markaby/builder.rb",
+     "lib/markaby/cssproxy.rb",
+     "lib/markaby/kernel_method.rb",
+     "lib/markaby/metaid.rb",
+     "lib/markaby/rails.rb",
+     "lib/markaby/tags.rb",
+     "lib/markaby/template.rb",
+     "setup.rb",
+     "test/rails/markaby/_monkeys.mab",
+     "test/rails/markaby/broken.mab",
+     "test/rails/markaby/create.mab",
+     "test/rails/markaby/index.mab",
+     "test/rails/monkeys.html",
+     "test/rails/test_helper.rb",
+     "test/rails/test_preamble.rb",
+     "test/rails_test.rb",
+     "test/test_markaby.rb",
+     "tools/rakehelp.rb"
+  ]
+  s.homepage = %q{http://joho.github.com/markaby/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Markup as Ruby, write HTML in your native Ruby tongue}
+  s.test_files = [
+    "test/rails/test_helper.rb",
+     "test/rails/test_preamble.rb",
+     "test/rails_test.rb",
+     "test/test_markaby.rb"
+  ]
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<builder>, [">= 2.0.0"])
+    else
+      s.add_dependency(%q<builder>, [">= 2.0.0"])
+    end
+  else
+    s.add_dependency(%q<builder>, [">= 2.0.0"])
+  end
+end

data/README ADDED Viewed

@@ -0,0 +1,256 @@
+= 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 affect 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.
+= The Six Steps of Markaby
+If you dive right into Markaby, it'll probably make good sense, but you're
+likely to run into a few kinks.  Why not review these six steps and commit
+them memory so you can really *know* what you're doing?
+== 1. 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>
+== 2. Element IDs
+IDs may be added by the use of bang methods:
+  div.page! {
+    div.content! {
+      h1 "A Short Short Saintly Dog"
+    }
+  }
+Which results in:
+  <div id="page">
+    <div id="content">
+      <h1>A Short Short Saintly Dog</h1>
+    </div>
+  </div>
+== 3. Validate Your XHTML 1.0 Output
+If you'd like Markaby to help you assemble valid XHTML documents,
+you can use the <tt>xhtml_transitional</tt> or <tt>xhtml_strict</tt>
+methods in place of the normal <tt>html</tt> tag.
+  xhtml_strict do
+    head { ... }
+    body { ... }
+  end
+This will add the XML instruction and the doctype tag to your document.
+Also, a character set meta tag will be placed inside your <tt>head</tt>
+tag.
+Now, 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'
+Markaby will also make sure you don't use the same element ID twice!
+== 4. Escape or No Escape?
+Markaby uses a simple convention for escaping stuff: if a string
+is an argument, it gets escaped.  If the string is in a block, it
+doesn't.
+This is handy if you're using something like RedCloth or
+RDoc inside an element.  Pass the string back through the block
+and it'll skip out of escaping.
+  div.comment { RedCloth.new(str).to_html }
+But, if we have some raw text that needs escaping, pass it in
+as an argument:
+  div.comment raw_str
+One caveat: if you have other tags inside a block, the string
+passed back will be ignored.
+  div.comment {
+    div.author "_why"
+    div.says "Torpedoooooes!"
+    "<div>Silence.</div>"
+  }
+The final div above won't appear in the output.  You can't mix
+tag modes like that, friend.
+== 5. 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|
+      link_to category
+    end.
+    join( " | " )
+== 6. 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
+= 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.  That's okay!  Every method returns a Fragment object, which can
+be used as a string.
+  p { "Total is: #{number_to_human_size @file_bytes}" }
+Also see the Quick Tour above, specifically the stuff about auto-stringification.
+If for any reason you have trouble with fragments, you can just
+call the <tt>@helpers</tt> object with the method and you'll get
+the String back and nothing will be output.
+  p { "Total is: #{@helpers.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
+= 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 ADDED Viewed

@@ -0,0 +1,49 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/clean'
+require 'rake/rdoctask'
+require 'tools/rakehelp'
+require 'fileutils'
+include FileUtils
+task :default => [:test]
+setup_tests
+setup_rdoc ['README', 'CHANGELOG', 'lib/**/*.rb']
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "Markaby"
+    gemspec.summary = "Markup as Ruby, write HTML in your native Ruby tongue"
+    gemspec.description = "Tim Fletcher and _why's ruby driven HTML templating system"
+    gemspec.email = "jrbarton@gmail.com"
+    gemspec.homepage = "http://joho.github.com/markaby/"
+    gemspec.authors = ["_why", "Tim Fletcher", "John Barton", "spox", "smtlaissezfaire"]
+    gemspec.add_dependency 'builder', '>=2.0.0'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+desc "List any Markaby specific warnings"
+task :warnings do
+  `ruby -w test/test_markaby.rb 2>&1`.split(/\n/).each do |line|
+    next unless line =~ /warning:/
+    next if line =~ /builder-/
+    puts line
+  end
+end
+desc "Start a Markaby-aware IRB session"
+task :irb do
+  sh 'irb -I lib -r markaby -r markaby/kernel_method'
+end
+namespace :test do
+  desc ''
+  task :rails do
+    Dir.chdir '../../../'
+    sh 'rake test:plugins PLUGIN=markaby'
+  end
+end

data/VERSION ADDED Viewed

	@@ -0,0 +1 @@
1	+ 0.6.0

data/init.rb ADDED Viewed

@@ -0,0 +1,13 @@
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
+require 'markaby'
+require 'markaby/rails'
+if defined? ActionView::Template and ActionView::Template.respond_to? :register_template_handler
+  ActionView::Template
+else
+  ActionView::Base
+end.register_template_handler(:mab, Markaby::Rails::ActionViewTemplateHandler)
+ActionController::Base.send :include, Markaby::Rails::ActionControllerHelpers

data/lib/markaby.rb ADDED Viewed

@@ -0,0 +1,35 @@
+# = 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.
+#
+# For a full list of features and instructions, see the README.
+$:.unshift File.expand_path(File.dirname(__FILE__))
+# Markaby is a module containing all of the great Markaby classes that
+# do such an excellent job.
+#
+# * Markaby::Builder: the class for actually calling the Ruby methods
+#   which write the HTML.
+# * Markaby::CSSProxy: a class which adds element classes and IDs to
+#   elements when used within Markaby::Builder.
+# * Markaby::MetAid: metaprogramming helper methods.
+# * Markaby::Tags: lists the roles of various XHTML tags to help Builder
+#   use these tags as they are intended.
+# * Markaby::Template: a class for hooking Markaby into Rails as a
+#   proper templating language.
+module Markaby
+  VERSION = '0.5'
+  class InvalidXhtmlError < Exception; end
+end
+unless defined?(Builder)
+  require 'rubygems'
+  require 'builder'
+end
+require 'markaby/builder'
+require 'markaby/cssproxy'
+require 'markaby/metaid'
+require 'markaby/template'