malt 0.3.0 → 0.4.0

data/qed/03_formats/14_scss.rdoc

@@ -1,58 +0,0 @@
-== SCSS
-
-Lets say we have a SCSS document called 'test.scss' containing:
-
-  $blue: #3bbfce;
-  $margin: 16px;
-
-  .content-navigation {
-    border-color: $blue;
-    color:
-      darken($blue, 9%);
-  }
-
-  .border {
-    padding: $margin / 2;
-    margin: $margin / 2;
-    border-color: $blue;
-  }
-
-We can render the Sass document via #render.
-
-  @css = Malt.render(:file=>'tmp/test.scss')
-
-And we can verify that @css is the expected CSS:
-
-  .content-navigation {
-    border-color: #3bbfce;
-    color: #2ca2af; }
-
-  .border {
-    padding: 8px;
-    margin: 8px;
-    border-color: #3bbfce; }
-
-We can also get a hold of the SCSS document via the Malt.file function.
-
-  scss = Malt.file('tmp/test.scss')
-
-  scss.class.assert == Malt::Format::SCSS
-
-We can convert the SCSS document to a CSS document via the #to_css method.
-
-  css = scss.to_css
-
-We can see that the output is an instance of Malt::Format::SCSS.
-
-  css.class.assert == Malt::Format::CSS
-
-And that by calling #to_s we can get the rendered CSS document.
-
-  css.to_s.assert.include?('border-color: #3bbfce;')
-
-Or we can convert the SCSS document directly to CSS via the #css method.
-
-  out = scss.css
-
-  out.assert.include?('border-color: #3bbfce;')
-

data/qed/03_formats/15_less.rdoc

@@ -1,46 +0,0 @@
-== LESS
-
-Lets say we have a LESS document called 'test.less' containing:
-
-  @brand_color: #4D926F;
-  #header {
-    color: @brand_color;
-  }
-  h2 {
-    color: @brand_color;
-  }
-
-We can render it via Malt with #render.
-
-  @css = Malt.render(:file=>'tmp/test.less')
-
-And we can verify that @css is:
-
-  #header, h2 { color: #4d926f; }
-
-Look how concise that is. LESS is pretty slick.
-
-We can also get a hold of the LESS document via the Malt.file function.
-
-  less = Malt.file('tmp/test.less')
-
-  less.class.assert == Malt::Format::LESS
-
-We can convert the LESS document to a CSS document via the #to_css method.
-
-  css = less.to_css
-
-We can see that the output is an instance of Malt::Format::HTML.
-
-  css.class.assert == Malt::Format::CSS
-
-And that by calling #to_s we can get the rendered CSS document.
-
-  css.to_s.assert.include?('#header, h2 { color: #4d926f; }')
-
-Or we can convert the LESS document directly to CSS via the #css method.
-
-  out = less.css
-
-  out.assert.include?('#header, h2 { color: #4d926f; }')
-

data/qed/03_formats/16_ruby.rdoc

@@ -1,48 +0,0 @@
-== Ruby
-
-It may not seem obvious at first, but Ruby itself can be used as
-a template system.
-
-Lets say we have a Ruby document called 'test.rb' containing:
-
-  "<h1>Example #{ title }</h1>\n" +
-  "<p>This is an example of Ruby rendering.</p>"
-
-We can run this Ruby script thru Malt's +render+ function.
-
-  data = {:title => 'Document'}
-
-  html = Malt.render(:file=>'tmp/test.rb', :data=>data)
-
-Whatever was the final result of evaluating the Ruby script, converted to
-a string via #to_s, will be the result of the rendering.
-
-  html.assert.include?('<h1>Example Document</h1>')
-
-We can get a hold of the Ruby template via the Malt.file function.
-
-  ruby = Malt.file('tmp/test.rb')
-
-  ruby.class.assert == Malt::Format::Ruby
-
-Ruby is a <i>universal template format</i>, so it can be converted to any other
-format (even if it is not really that format).
-
-  data = {:title => "Document"}
-
-  html = ruby.to_html(data)
-
-First we will notice that the output is an instance of Malt::Format::HTML.
-
-  html.class.assert == Malt::Format::HTML
-
-And that by calling #to_s we can get the rendered HTML document.
-
-  html.to_s.assert.include?('<h1>Example Document</h1>')
-
-Or we can convert the Ruby document directly to HTML via the #html method.
-
-  out = ruby.html(data)
-
-  out.assert.include?('<h1>Example Document</h1>')
-

data/qed/03_formats/17_markaby.rdoc

@@ -1,50 +0,0 @@
-== Markaby
-
-Lets say we have a Markaby document called 'test.markaby' containing:
-
-  html do
-    h1 "Example #{@title}"
-    p "This is an example of a Maraby template."
-  end
-
-Notice the use of the instance variable. Markaby templates must use instance
-variables for data rendering in order to avoid ambiguity with the markup
-syntax itself.
-
-We can render Markaby documents via the +render+ method, as we can any format.
-Since Markaby is a template format and not just a markup syntax, so we need
-to also provide the +render+ function with data for interpolation into the
-Markaby document. 
-
-  data = { :title=>"Document" }
-
-  html = Malt.render(:file=>'tmp/test.markaby', :data=>data)
-
-  html.assert.include?('<h1>Example Document</h1>')
-
-We can get a hold of the Markaby document via the Malt.file function.
-
-  markaby = Malt.file('tmp/test.markaby')
-
-  markaby.class.assert == Malt::Format::Markaby
-
-We can convert Markaby documents to html very easily.
-
-  data = {:title => "Document"}
-
-  html = markaby.to_html(data)
-
-First we will notice that the output is an instance of Malt::Format::HTML.
-
-  html.class.assert == Malt::Format::HTML
-
-And that by calling #to_s we can get the rendered HTML document.
-
-  html.to_s.assert.include?('<h1>Example Document</h1>')
-
-Or we can convert the Markaby document directly to HTML via the #html method.
-
-  out = markaby.html(data)
-
-  out.assert.include?('<h1>Example Document</h1>')
-

data/qed/03_formats/18_builder.rb

@@ -1,50 +0,0 @@
-== Builder
-
-Lets say we have a Builder document called 'test.builder' containing:
-
-  html do |h|
-    h.h1 "Example #{@title}"
-    h.p "This is an example of a Maraby template."
-  end
-
-Notice the use of the instance variable. Builder templates must use instance
-variables for data rendering in order to avoid ambiguity with the markup
-syntax itself.
-
-We can render Builder documents via the +render+ method, as we can any format.
-Since Builder is a template format and not just a markup syntax, so we need
-to also provide the +render+ function with data for interpolation into the
-Builder document. 
-
-  data = { :title=>"Document" }
-
-  html = Malt.render(:file=>'tmp/test.builder', :data=>data)
-
-  html.assert.include?('<h1>Example Document</h1>')
-
-We can get a hold of the Builder document via the Malt.file function.
-
-  builder = Malt.file('tmp/test.builder')
-
-  builder.class.assert == Malt::Format::Builder
-
-We can convert Builder documents to html very easily.
-
-  data = {:title => "Document"}
-
-  html = builder.to_html(data)
-
-First we will notice that the output is an instance of Malt::Format::HTML.
-
-  html.class.assert == Malt::Format::HTML
-
-And that by calling #to_s we can get the rendered HTML document.
-
-  html.to_s.assert.include?('<h1>Example Document</h1>')
-
-Or we can convert the Builder document directly to HTML via the #html method.
-
-  out = builder.html(data)
-
-  out.assert.include?('<h1>Example Document</h1>')
-

data/qed/03_formats/19_erector.rb

@@ -1,50 +0,0 @@
-== Erector
-
-Lets say we have a Erector document called 'test.erector' containing:
-
-  html do
-    h1 "Example #{@title}"
-    p "This is an example of a Maraby template."
-  end
-
-Notice the use of the instance variable. Erector templates must use instance
-variables for data rendering in order to avoid ambiguity with the markup
-syntax itself.
-
-We can render Erector documents via the +render+ method, as we can any format.
-Since Erector is a template format and not just a markup syntax, so we need
-to also provide the +render+ function with data for interpolation into the
-Erector document. 
-
-  data = { :title=>"Document" }
-
-  html = Malt.render(:file=>'tmp/test.erector', :data=>data)
-
-  html.assert.include?('<h1>Example Document</h1>')
-
-We can get a hold of the Erector document via the Malt.file function.
-
-  erector = Malt.file('tmp/test.erector')
-
-  erector.class.assert == Malt::Format::Erector
-
-We can convert Erector documents to html very easily.
-
-  data = {:title => "Document"}
-
-  html = erector.to_html(data)
-
-First we will notice that the output is an instance of Malt::Format::HTML.
-
-  html.class.assert == Malt::Format::HTML
-
-And that by calling #to_s we can get the rendered HTML document.
-
-  html.to_s.assert.include?('<h1>Example Document</h1>')
-
-Or we can convert the Erector document directly to HTML via the #html method.
-
-  out = erector.html(data)
-
-  out.assert.include?('<h1>Example Document</h1>')
-

data/qed/03_formats/20_mustache.rdoc

@@ -1,54 +0,0 @@
-== Mustache
-
-Lets say we have a Mustache document called 'test.mustache' containing:
-
-  <h1>Example {{ title }}</h1>
-
-  <p>This is an example of a Mustache template.</p>
-
-We can render mustache documents via the +render+ method, as we can any format.
-However, becuase Mustache is a template format and not just a markup syntax,
-we need to also provide the +render+ function with data for interpolation
-into the mustache document. 
-
-  data = { :title=>"Document" }
-
-  html = Malt.render(:file=>'tmp/test.mustache', :data=>data)
-
-  html.assert.include?('<h1>Example Document</h1>')
-
-Mustache doesn't actually care what format the document is rendered as, since it
-is purely a template engine that can be applied to any other format.
-Lets say we have a Mustache document called 'test.mustache' containing ...
-
-  <h1>Example {{ title }}</h1>
-
-  <p>This is an example of a Mustache template.</p>
-
-We can render erb documents to any format we wish.
-
-  liq = Malt.file('tmp/test.mustache')
-
-  html = liq.to_html(:title=>"Document")
-
-We will notice that the output is an instance of Malt::Format::HTML.
-
-  html.class.assert == Malt::Format::HTML
-
-We will notice that the output is an instance of Malt::Format::HTML.
-
-  html.class.assert == Malt::Format::HTML
-
-Then by calling #to_s we can get the rendered HTML document.
-
-  html.to_s.assert.include?('<h1>Example Document</h1>')
-
-Or we can convert the document directly to HTML via the #html method.
-
-  out = liq.html(:title=>"Alternate")
-
-  out.assert.include?('<h1>Example Alternate</h1>')
-
-Mustache doesn't actually care what format the document is rendered as, since it
-is purely a template engine that can be applied to any format.
-

data/qed/05_machine/01_limited_formats.rdoc

@@ -1,29 +0,0 @@
-== Limited Formats
-
-The Machine class makes it possible to control which formats
-are available for rendering.
-
-For example, let's make a Machine that only support RDoc format
-and no others.
-
-  malt = Malt::Machine.new(:types=>[:rdoc])
-
-Now we use the `malt` machine object to handle rendering. First let's
-make sure that the machine is infact setup to limit formats to just RDoc.
-
-  malt.formats.keys.assert = [:rdoc]
-
-  malt.assert.format?('.rdoc')
-  malt.refute.format?('.markdown')
-
-This being the case we should be able to render an RDoc file without issue.
-
-  malt.render(:file=>'qed/samples/sample.rdoc')
-
-Where as another format type, though usually supported, but excluded in this
-case, will fail.
-
-  expect Malt::NoEngineError do
-    malt.render(:file=>'qed/samples/sample.markdown')
-  end
-

data/qed/05_machine/02_prioritized_engines.rdoc

@@ -1,34 +0,0 @@
-== Prioritized Engines
-
-The Malt Machine class can also be used to prioritize engines.
-For instance, by default markdown documents are handled by
-the RDiscount library. 
-
-  malt = Malt::Machine.new
-
-  engine = malt.pry.engine(:markdown)
-  engine.assert == Malt::Engine::RDiscount
-
-To use Kramdown instead, we can specify
-it as a priority when initilizeing a new Machine.
-
-  malt = Malt::Machine.new(:priority=>[:kramdown])
-
-Lets check to make sure.
-
-  engine = malt.pry.engine(:markdown)
-  engine.assert == Malt::Engine::Kramdown
-
-To change the engine priorities of the master Malt Machine, provide 
-the #priority method with the type and it will put it at the top of
-the priority list.
-
-  Malt.machine.priority :kramdown
-
-Lets check to make sure.
-
-  engine = Malt.machine.pry.engine(:markdown)
-  engine.assert == Malt::Engine::Kramdown
-
-(If you are wondering, #pry is simply used to call a private method.)
-

data/qed/applique/malt.rb

@@ -1,13 +0,0 @@
-require 'malt'
-require 'ae/pry'
-
-When "say we have a (((\\w+))) document called '(((\\S+)))' containing" do |type, fname, text|
-  file = File.join('tmp',fname)
-  File.open(file, 'w'){ |f| f << text }
-end
-
-When "verify that (((.*?))) is" do |var, text|
-  out = instance_variable_get(var)
-  out.strip.assert == text.strip
-end
-

data/qed/samples/data.yml

@@ -1,4 +0,0 @@
----
-name : Tom
-state: Florida
-