malt 0.1.0

data/History.rdoc

@@ -0,0 +1,13 @@
+= Release History
+
+== 0.1.0 | 2010-06-23
+
+This if the initial release of Malt. I have no doubt the code base
+still needs some fine-tuning --hence the 0.1 version, but I have put
+it to good use with the latest version of Brite, my static website
+generator, so I know that it is at least is a working state.
+
+Changes:
+
+* Initial release.
+

data/License.txt

@@ -0,0 +1,204 @@
+.
+                             Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+

data/README.rdoc

@@ -0,0 +1,68 @@
+= Malt
+
+* home: http://rubyworks.github.com/malt
+* code: http://github.com/rubyworks/malt
+
+
+== DESCRIPTION
+
+Malt provides a factory framework for rendering
+a variety of template and markup document formats.
+
+
+== SYNOPSIS
+
+=== Functional API
+
+  Malt.render(:file=>'foo.erb', :format=>:html, :data=>data)
+
+Where +data+ is a data source of some type. Malt will see
+that the file is an ERB template and render it accordingly.
+
+The output of this call will be the HTML String.
+
+=== Object-oriented API
+
+  Malt.file('foo.erb').to_html(data).to_s
+
+Where +data+ is a data source of some type. Malt will see
+that the file is an ERB template and render it accordingly.
+
+To get the render text you simple need to provide the template
+or markup type.
+
+  Malt.text(text, :type=>:erb).to_html(data).to_s
+
+Notice the #to_s. This is needed because #to_html returns an 
+Malt::Format::HTML object.
+
+
+== COMING SOON
+
+Malt can also "multi-render".
+
+  Malt.file('foo.rdoc.erb').to_html(data)   # ~> foo.html
+
+
+== INSTALATION
+
+To install with RubyGems simply open a console and type:
+
+  $ gem install  
+
+For a site install you will need Ruby Setup and the compressed
+packages (tar.gz or zip usually). Uncompress the package
+cd into it and run setup.rb, e.g.
+
+  $ tar -xvzf malt-x.y.z.tgz
+  $ cd malt-x.y.z.tgz
+  $ sudo setup.rb
+
+
+== COPYING
+
+Copyright (c) 2010 Thomas Sawyer
+
+This program is ditributed under the terms of the Apache 2.0 license.
+
+See the LICENSE.txt file for details.

data/bin/malt

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'malt'
+Malt.main(*ARGV)
+

data/features/consistent_rendering.feature

@@ -0,0 +1,36 @@
+Feature: Consistant rendering across all template engines.
+  As a developer
+  In order to render templates
+  I want to have my choice of template engines
+  And I want all templates to behave consistently
+
+  Scenario: Template with Binding Data Source
+    Given an equivalent template for each engine
+    And a Binding for a data source
+    When the template is rendered
+    Then the result is the same for each
+
+  Scenario: Template with Object Data Source
+    Given an equivalent template for each engine
+    And a Object for a data source
+    When the template is rendered
+    Then the result is the same for each
+
+  Scenario: Template with Struct Data Source
+    Given an equivalent template for each engine
+    And a Struct for a data source
+    When the template is rendered
+    Then the result is the same for each
+
+  Scenario: Template with Hash Date Source
+    Given an equivalent template for each engine
+    And a Hash for a data source
+    When the template is rendered
+    Then the result is the same for each
+
+  Scenario: Template with OpenStruct Locals
+    Given an equivalent template for each engine
+    And a OpenStruct for a data source
+    When the template is rendered
+    Then the result is the same for each
+

data/features/samples/sample.erb

@@ -0,0 +1 @@
+<%= name %> lives in <%= state %>

data/features/samples/sample.erubis

@@ -0,0 +1 @@
+<%= name %> lives in <%= state %>

data/features/samples/sample.liquid

@@ -0,0 +1 @@
+{{ name }} lives in {{ state }}

data/features/samples/sample.mustache

@@ -0,0 +1 @@
+{{ name }} lives in {{ state }}

data/features/samples/sample.radius

@@ -0,0 +1 @@
+<r:name /> lives in <r:state />

data/features/step_definitions/engine_steps.rb

@@ -0,0 +1,49 @@
+Given "an equivalent template for each engine" do
+  require 'malt'
+  require 'ostruct'
+
+  @templates = {}
+  @templates[:erb]    = File.dirname(__FILE__) + "/../samples/sample.erb"
+  @templates[:erubis] = File.dirname(__FILE__) + "/../samples/sample.erb"
+
+  #template_types = %w{.erb .erubis} # .liquid .radius} #.mustache
+  #@templates = {}
+  #template_types.each do |ext|
+  #  @templates[ext] = File.dirname(__FILE__) + "/../samples/sample#{ext}"
+  #end
+end
+
+And /a (.*?) for a data source/ do |source_type|
+  case source_type
+  when 'Binding'
+    name  = "Tom"
+    state = "Maryland"
+    @source = binding
+  when 'Object'
+    @source = SampleObject.new("Tom","Maryland")
+  when 'Struct'
+    @source = Struct.new(:name, :state).new("Tom", "Maryland")
+  when 'OpenStruct'
+    @source = OpenStruct.new(:name=>"Tom", :state=>"Maryland")
+  when 'Hash'
+    @source = {:name=>"Tom", :state=>"Maryland"}
+  end
+end
+
+When "the template is rendered" do
+  @results = {}
+  @templates.each do |engine, file|
+    puts "    #{engine}"
+    file = Malt.file(file, :engine=>engine) #Tilt[ext].new(file)
+    @results[engine] = file.html(@source).to_s
+  end
+end
+
+Then "the result is the same for each" do
+  @results.each do |ea, a|
+    @results.each do |eb, b|
+      raise "#{ea} != #{eb}\n#{a} != #{b}" unless a == b
+    end
+  end
+end
+

data/features/support/loadpath.rb

@@ -0,0 +1 @@
+$:.unshift(File.dirname(__FILE__)+'/../../lib') 

data/features/support/sample_class.rb

@@ -0,0 +1,8 @@
+class SampleObject
+  attr :name
+  attr :state
+  def initialize(name,state)
+    @name = name
+    @state = state
+  end
+end

data/lib/malt.rb

@@ -0,0 +1,79 @@
+require 'malt/kernel'
+require 'malt/render'
+
+module Malt
+
+  class << self
+    include Malt::Kernel
+  end
+
+  #
+  def self.register(malt_class, *exts)
+    exts.each do |ext|
+      type = ext_to_type(ext)
+      registry[type] = malt_class
+    end
+  end
+
+  #
+  def self.registry
+    @registry ||= {}
+  end
+
+
+  #
+  def self.file(file, options={})
+    type = options[:type] || options[:format] || File.extname(file)
+    type = ext_to_type(type)
+    malt_class = registry[type]
+    raise "unkown type -- #{type}" unless malt_class
+    malt_class.new(options.merge(:file=>file,:type=>type))
+  end
+
+  #
+  def self.text(text, options={})
+    if file = options[:file]
+      ext = File.extname(file)
+      ext = nil if ext.empty?
+    end
+    type = options[:type] || options[:format] || ext
+    type = ext_to_type(type)
+    malt_class = registry[type] || Formats::Text
+    #raise "unkown type -- #{type}" unless malt_class
+    malt_class.new(options.merge(:text=>text,:file=>file,:type=>type))
+  end
+
+  #
+  def self.open(url, options={})
+    require 'open-uri'
+    text = open(url).read
+    file = File.basename(url) # parse better with URI.parse
+    text(text, :file=>file)
+  end
+
+  #
+  def self.main(*args)
+    require 'optparse'
+    itype, otype = nil, nil
+    OptionParser.new{|o|
+      o.on('-t TYPE', 'input type'){  |t| itype  = t }
+      o.on('-o TYPE', 'output type'){ |t| otype = t }
+      o.on('--help', '-h'       , 'display this help message'){ puts o; exit }
+    }.parse!
+    db, files = *args.partition{ |x| x.index('=') }
+    db = db.inject({}){ |h,kv| k,v = kv.split('='); h[k] = v; h}
+    files.each do |file|
+      puts Malt.render(:file=>file, :type=>itype, :format=>otype)
+      #file = itype ? Malt.file(file, :type=>itype) : Malt.file(file)
+      #if otype
+      #  puts file.render(otype, db)
+      #else
+      #  puts file.render(db)
+      #end
+    end
+  end
+
+end
+
+require 'malt/engines'
+require 'malt/formats'