neapolitan 0.3.0 → 0.4.0

data/.ruby

@@ -0,0 +1,72 @@
+---
+source:
+- var
+authors:
+- name: trans
+  email: transfire@gmail.com
+copyrights: []
+replacements: []
+alternatives: []
+requirements:
+- name: malt
+  version: 0.4.0+
+- name: detroit
+  groups:
+  - build
+  development: true
+- name: yard
+  groups:
+  - document
+  development: true
+- name: qed
+  groups:
+  - test
+  development: true
+- name: coderay
+  groups:
+  - optional
+  - test
+  development: true
+- name: RedCloth
+  groups:
+  - optional
+  - test
+  development: true
+- name: rdoc
+  groups:
+  - optional
+  - test
+  development: true
+- name: liquid
+  groups:
+  - optional
+  - test
+  development: true
+dependencies: []
+conflicts: []
+repositories:
+- uri: git://github.com/rubyworks/neapolitan.git
+  scm: git
+  name: upstream
+resources:
+  home: http://rubyworks.github.com/neapolitan
+  code: http://github.com/rubyworks/neapolitan
+  docs: http://rubydoc.info/gems/neapolitan/frames
+  wiki: http://wiki.github.com/rubyworks/neapolitan
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2009-08-25'
+summary: Kid in the Candy Store Templating
+title: Neapolitan
+version: 0.4.0
+name: neapolitan
+description: ! 'Neapolitan is a meta-templating engine. Like a candy store it allows
+  you to pick
+
+  and choose from a variety of rendering formats in the construction of a single
+
+  document. Selections include eruby, textile, markdown and many others.'
+organization: rubyworks
+date: '2011-11-30'

data/HISTORY.rdoc

@@ -1,5 +1,21 @@
 = RELEASE HISTORY
 
+== 0.4.0 / 2011-11-30
+
+This release updates Neapolitan for use with the latest version
+of Malt (v0.4.0). At the same, time the underlying API has been improved.
+The API remains compatible with the previous version, with the exception
+of one YAML front matter property --the `common` field has been renamed
+to `finish`, to better indicate when it is applied during rendering.
+
+Changes:
+
+* Rename `common` metadata property to `finish`.
+* Add #format block setter for applying complex format rules.
+* Apply #select and #reject blocks during rendering instead of before.
+* Update part rendering for compatibility with Malt 0.4+.
+
+
 == 0.3.0 / 2010-11-09
 
 This release entails a fairly major overhaul of the API. Primarily, the
@@ -25,7 +41,7 @@ Changes:
 
 == 0.1.0 / 2008-10-25
 
-Not an offical release. This is the first usable version of Chocolates.
+Not an official release. This is the first usable version of Chocolates.
 
 Changes:
 

data/LICENSE.txt

@@ -0,0 +1,29 @@
+Neapolitan - Multi-Format Templates
+
+Copyright 2010 Rubyworks. All rights reserved.
+
+BSD-2-Cluase License
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+(http://rubyworks.github.com/neapolitan)
+

data/README.rdoc

@@ -1,9 +1,11 @@
 = Neapolitan
 
-Copyright (c) 2010 Thomas Sawyer
+{Homepage}[http://rubyworks.github.com/neapolitan] |
+{Development}[http://github.com/rubyworks/neapolitan] |
+{Report Issue}[http://github.com/rubyworks/neapolitan/issues] |
+{Mailing List}[http://groups.google.com/group/rubyworks-mailinglist]
 
-* home: http://rubyworks.github.com/neapolitan
-* code: http://github.com/rubyworks/neapolitan
+{<img src="http://travis-ci.org/rubyworks/neapolitan.png" />}[http://travis-ci.org/rubyworks/neapolitan]
 
 
 == DESCRIPTION
@@ -13,7 +15,7 @@ world. Why be limited to just one? Neapolitan gives
 you a whole box to pick from.
 
 
-== FEATURES/ISSUES
+== FEATURES
 
 * All the variety of a Whitman's Sampler.
 * And all the ease of a Hershey's K.I.S.S.
@@ -22,7 +24,7 @@ you a whole box to pick from.
 
 == SYNOPSIS
 
-For now please see the Neapolitan website and online documentation.
+For now, please see the Neapolitan website and online documentation.
 
 
 == HOW TO INSTALL
@@ -35,11 +37,11 @@ If you're old fashion and want to install to a site
 location, see Setup.rb (http://protuils.github.com/setup).
 
 
-== COPYRIGHT/LICENSE
+== COPYRIGHTS
 
-Neapolitan, Copyright (c) 2010 Thomas Sawyer
+Neapolitan, Copyright (c) 2010 Rubyworks
 
-Neapolitan is distributed under the terms of the Apache License v2.0.
+Neapolitan is distributed under the terms of the *BSD-2-Clause* license.
 
 THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED

data/demo/01_overview.rdoc

@@ -0,0 +1,86 @@
+= Overview
+
+== Example Neapolitan Document
+
+Here is an example Neapolitan template, 'vanilla.np':
+
+    output: vanilla.html
+
+    --- erb rdoc
+
+    = Yummy Vanilla
+
+    Hi <%= name %>,
+
+    I know you want some of that yummy stuff.
+
+    --- coderay.ruby
+
+      %{v a n i l l a}.each do |letter|
+        puts "Give me a #{letter}!"
+      end
+
+      puts "What's that spell?"
+
+    --- liquid html
+
+    <quote>
+      {{ yield }}
+    </quote>
+
+    --- textile
+
+    |                | 2009 | 2010 |
+    | Has Vanilla?   |  No  | Yes! |
+
+    As you can see. It's all _fun_ and _games_ here.
+
+== Loading the Library
+
+Require the library.
+
+    require 'neapolitan'
+
+== Reading a Neapolitan File
+
+To load our example template, we can either pass a +File+ object to the 
++Template+ initializer.
+
+    path = "vanilla.np"
+
+    template = Neapolitan::Template.new(File.new(path))
+
+Or we can use the shortcut +file+ method.
+
+    template = Neapolitan.file(path)
+
+== Rendering Data Sources
+
+Neapolitan uses Malt on the backend. Malt supports a three separate ways to pass
+data into a template.
+
+The most obvious data source is a Hash.
+
+    data = {:name=>"Tom"}
+
+    text = template.render(data).to_s
+
+    text.assert =~ /Hi Tom/
+
+Templates can also be rendered given a Binding.
+
+    name = "Huck"
+
+    text = template.render(binding).to_s
+
+    text.assert =~ /Hi Huck/
+
+Lastly, they can be rendered with the scope of any other type of Object,
+including an instance of a Struct.
+
+    scope = Struct.new(:name).new("Becky")
+
+    text = template.render(scope).to_s
+
+    text.assert =~ /Hi Becky/
+

data/demo/02_faq.rdoc

@@ -0,0 +1,51 @@
+= FAQ
+
+<b>How do I limit the section formats that can be used?</b>
+
+There are two methods that can be used to limit the formats that
+of a Neapolitan template, namely, #select and #reject.
+
+After creating a Template object, use the #select and/or the #reject
+methods to filter out any unwanted formats.
+
+    template = Neapolitan.file('example.np')
+
+    template.reject{ |format| %w{liquid}.include?(format) }
+
+    template.render(:name=>"Tom")
+
+These methods can be used for more aggressive validation by raising
+an error.
+
+    template = Neapolitan.file('example.np')
+
+    template.reject do |format|
+      raise TypeError if %w{liquid}.include?(format)
+      false
+    end
+
+    expect TypeError do
+      template.render(:name=>"Tome")
+    end
+
+<b>Why should template formats be listed before markup format?</b>
+
+Consider what happens if have a document section proccessed by RDoc
+before applying templating such as ERB:
+
+  = Example
+
+  Hi, <%= name %>
+
+The result never ends up utilizing ERB properly because RDoc transformed
+the document into:
+
+  <h1>Example</h1>
+
+  Hi, &lt;%= name &gt;
+
+Therefore you should always list the template format before markup formats.
+Of course usually template formats are not used on section by section
+basis in anycase, so this won't be an issue, but it's good to know just
+in case.
+

data/demo/applique/env.rb

@@ -0,0 +1,12 @@
+directory = File.dirname(__FILE__)
+
+$LOAD_PATH <<  directory + '/../lib'
+
+require 'neapolitan'
+
+FileUtils.install(Dir[directory + '/../fixtures/*'], '.')
+
+When "Here is an example Neapolitan template, '(((.*?)))'" do |file, text|
+  File.open(file, 'w'){ |f| f << text }
+end
+

data/demo/fixtures/example.html

@@ -0,0 +1,39 @@
+<h1>Yummy Choclate </h1>
+<p>
+Hi Ginger,
+</p>
+<p>
+I know you want some of that yummy stuff.
+</p>
+
+<div class="CodeRay">
+  <div class="code"><pre>
+  <span style="background-color:#fff0f0;color:#D20"><span style="color:#710">%{</span><span style="">c h o c o l a t e</span><span style="color:#710">}</span></span>.each <span style="color:#080;font-weight:bold">do</span> |letter|
+    puts <span style="background-color:#fff0f0;color:#D20"><span style="color:#710">&quot;</span><span style="">Give me a </span><span style="background:#ddd;color:black"><span style="background:#ddd;font-weight:bold;color:#666">#{</span>letter<span style="background:#ddd;font-weight:bold;color:#666">}</span></span><span style="">!</span><span style="color:#710">&quot;</span></span>
+  <span style="color:#080;font-weight:bold">end</span>
+
+  puts <span style="background-color:#fff0f0;color:#D20"><span style="color:#710">&quot;</span><span style="">What's that spell?</span><span style="color:#710">&quot;</span></span>
+
+</pre></div>
+</div>
+
+
+<quote>
+  What can I say?
+
+</quote>
+
+
+<table>
+	<tr>
+		<td>                </td>
+		<td> 2009 </td>
+		<td> 2010 </td>
+	</tr>
+	<tr>
+		<td> Has Choclates? </td>
+		<td>  No  </td>
+		<td> Yes! </td>
+	</tr>
+</table>
+<p>As you can see. It's all <em>fun</em> and <em>games</em> here.</p>

data/demo/fixtures/example.np

@@ -0,0 +1,31 @@
+extension: html
+
+--- erb rdoc
+
+= Yummy Choclate 
+
+Hi <%= name %>,
+
+I know you want some of that yummy stuff.
+
+--- coderay.ruby
+
+  %{c h o c o l a t e}.each do |letter|
+    puts "Give me a #{letter}!"
+  end
+
+  puts "What's that spell?"
+
+--- liquid html
+
+<quote>
+  {{ yield }}
+</quote>
+
+--- textile
+
+|                | 2009 | 2010 |
+| Has Choclates? |  No  | Yes! |
+
+As you can see. It's all _fun_ and _games_ here.
+

data/demo/fixtures/example.yaml

@@ -0,0 +1,5 @@
+---
+name: Ginger
+yield: |
+  What can I say?
+

data/lib/neapolitan/cli.rb

@@ -0,0 +1,66 @@
+module Neapolitan
+
+  # Command line interface.
+  def self.cli(*argv)
+    options = {}
+
+    option_parser(options).parse!(argv)
+
+    if src = options[:source]
+      data = YAML.load(File.new(src))
+    else
+      data = {} #@source ||= YAML.load(STDIN.read)
+    end
+
+    files = argv
+
+    begin
+      files.each do |file|
+        template = Template.new(File.new(file))
+        if options[:output]
+          #template.save(data)
+        else
+          puts template.render(data)
+        end
+      end
+    rescue => e
+      $DEBUG ? raise(e) : puts(e.message)
+    end
+  end
+
+  # TODO: Save to output ?
+
+  #
+  def self.option_parser(options)
+    require 'optparse'
+
+    OptionParser.new do |opt|
+      opt.banner = "neapolitan [file1 file2 ...]"
+      #opt.on("--output", "-o [PATH]", "save output to specified directory") do |path|
+      #  options[:output] = path
+      #end
+      opt.on("--source", "-s [FILE]", "data souce (YAML file)") do |file|
+        options[:source] = file
+      end
+      opt.on("--tilt", "use Tilt for rendering instead of Malt") do
+        options[:tilt] = true
+      end
+      opt.on("--trace", "show extra operational information") do
+        $TRACE = true
+      end
+      opt.on("--dryrun", "-n", "don't actually write to disk") do
+        $DRYRUN = true
+      end
+      opt.on("--debug", "run in debug mode") do
+        $DEBUG   = true
+        $VERBOSE = true
+      end
+      opt.on_tail("--help", "display this help message") do
+        puts opt
+        exit
+      end
+    end
+
+  end
+
+end

data/lib/neapolitan/core_ext.rb

@@ -0,0 +1,2 @@
+require 'facets/hash/rekey'
+

data/lib/neapolitan/factory.rb

@@ -0,0 +1,123 @@
+module Neapolitan
+
+  # Controls rendering to a variety of back-end templating
+  # and markup systems via Malt.
+  #
+  class Factory
+    #
+    attr :types
+
+    # @param [Hash] options
+    #
+    # @option options [Array] :types
+    #
+    def initialize(options={})
+      @types  = options[:types]
+      @system = options[:system] || :malt
+    end
+
+    #
+    def render(text, format, scope, locals, &content) 
+      case format
+      when /^coderay/
+        coderay(text, format)
+      when /^syntax/
+        syntax(text, format)
+      when /^rubypants/
+        rubypants(text, format)
+      else
+        if @system == :tilt
+          render_via_tilt(text, format, scope, locals, &content)
+        else
+          render_via_malt(text, format, scope, locals, &content)
+        end
+      end
+    end
+
+    # Render via Malt.
+    def render_via_malt(text, format, scope, locals, &content)
+      doc = malt.text(text, :type=>format.to_sym)
+      doc.render(scope, locals, &content)
+    end
+
+    # Render via Tilt.
+    def render_via_tilt(text, format, scope, locals, &content)
+      if engine = Tilt[format]
+        #case data
+        #when Hash
+        #  scope = Object.new
+        #  table = data
+        #when Binding
+        #  scope = data.eval('self')
+        #  table = {}
+        #else # object scope
+        #  scope = data
+        #  table = {}
+        #end
+        engine.new{text}.render(scope, locals, &content)
+      else
+        text
+      end
+    end
+
+    # Get cached instance of Malt controller.
+    #
+    # @return [Malt::Machine] mutli-format renderer
+    def malt
+      @malt ||= (
+        if types && !types.empty?
+          Malt::Machine.new(:types=>types)
+        else
+          Malt::Machine.new
+        end
+      )
+    end
+
+    # Apply `coderay` syntax highlighting. This is a psuedo-format.
+    def coderay(input, format)
+      require 'coderay'
+      format = format.split('.')[1] || :ruby #:plaintext
+      tokens = CodeRay.scan(input, format.to_sym) #:ruby
+      tokens.div()
+    end
+
+    # Apply `syntax` syntax highlighting. This is a psuedo-format.
+    def syntax(input, format)
+      require 'syntax/convertors/html'
+      format = format.split('.')[1] || 'ruby' #:plaintext
+      lines  = true
+      conv   = Syntax::Convertors::HTML.for_syntax(format)
+      conv.convert(input,lines)
+    end
+
+    #
+    def rubypants(input_html, format)
+      require 'rubypants'
+      format, flag = format.split('.')
+      flag  = (flag || 2).to_i
+      pants = RubyPants.new(input_html, flag)
+      pantts.to_html
+    end
+
+    #
+    #def render_stencil(stencil, text, attributes)
+    #  case stencil
+    #  when 'rhtml'
+    #    erb(text, attributes)
+    #  when 'liquid'
+    #    liquid(text, attributes)
+    #  else
+    #    text
+    #  end
+    #end
+
+    public
+
+    #
+    def self.render(text, format, data, &content) 
+      new.render(text, format, data, &content)
+    end
+
+  end
+
+end

data/lib/neapolitan/part.rb

@@ -0,0 +1,89 @@
+module Neapolitan
+
+  # A part is a section of a template. Templates can be segmented into
+  # parts using the '--- FORMAT' notation.
+  class Part
+
+    # Parse text body and create new part.
+    def self.parse(template, body)
+      index   = body.index("\n")
+      format  = body[0...index].strip
+      text    = body[index+1..-1].strip
+
+      new(template, text, format)
+    end
+
+    # The template to which the part belongs.
+    attr :template
+
+    # Body of text as given in the part.
+    attr :text
+
+    # Setup new Part instance.
+    #
+    # @param [String] text 
+    #   The parts body.
+    #
+    # @param [Array] formats
+    #   The template formats to apply to the body text.
+    #
+    def initialize(template, text, format)
+      @template = template
+      @text     = text
+      @format   = format
+    end
+
+    # Rendering format as given in the template document.
+    def format
+      @format
+    end
+
+    # Part specific format split into array.
+    def specific
+     @_specific ||= split_format(format)
+    end
+
+    # Template default format split into array.
+    def default
+      @_default ||= split_format(template.default)
+    end
+
+    # Template default format split into array.
+    def stencil
+      @_stencil ||= split_format(template.stencil)
+    end
+
+    # Template default format split into array.
+    def finish
+      @_finish ||= split_format(template.finish)
+    end
+
+    #
+    def formatting(&custom)
+      if custom
+        custom.call(self)
+      else
+        if specific.empty?
+          stencil + default + finish
+        else
+          stencil + specific + finish
+        end
+      end
+    end
+
+   private
+
+    #
+    def split_format(format)
+      case format
+      when nil
+        []
+      when Array
+        format
+      else
+        format.to_str.split(/\s+/)
+      end
+    end
+  end
+
+end