cerubis 0.0.1

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/*
+docs/*
+.rbx/*
+coverage.data
+coverage/*
+docs/* # for now

data/.travis.yml

@@ -0,0 +1,14 @@
+bundler_args: --without development
+rvm:
+  #- 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby
+  - rbx
+  - rbx-2.0
+  #- ree
+  - ruby-head
+script: "ruby -Itest:lib test/all.rb"
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in cerubis.gemspec
+gemspec
+
+group :development do
+  gem 'ruby-debug19', :platform => :ruby_19
+  gem 'cover_me', :platform => :mri_19
+end
+
+group :test do
+  gem 'rake'
+  gem 'capybara'
+  gem 'minitest', '>= 2.5'
+end

data/README.md

@@ -0,0 +1,111 @@
+# Cerubis [![Test Status](https://secure.travis-ci.org/daneharrigan/cerubis.png)][3]
+
+*WARNING:* Cerubis is still under initial development. Most features are
+not functional yet.
+
+Cerubis is inspired by [Liquid Markup][1] and [Mustache][2]. I like how
+Mustache syntax looks, but it's logic-less. Liquid allows just enough
+logic, but I don't like the syntax. And so Cerubis was born.
+
+## Syntax
+
+A block is started with `{{# ... }}` and closed with `{{/ ... }}`.
+Output is defined as `{{ ... }}`.
+
+    <header>
+      <h1>{{ page.title }}</h1>
+      {{#unless navigation.empty?}}
+      <menu>
+        {{#loop nav in navigation}}
+        <li>{{ link_to page }}</li>
+        {{/loop}}
+      </menu>
+      {{/unless}}
+    </header>
+
+## Standard Blocks
+
+* if
+* unless
+* loop
+
+## Objects in Template Context
+
+Rendering a Cerubis template with objects in the context is easy:
+
+    template_str = <<-STR
+      {{#if items.empty?}}
+        <p>There are no items!</p>
+      {{/if}}
+    STR
+
+    context = { items: [1,2,3] }
+
+    Cerubis.render(template_str, context)
+
+You can create your own objects and add them to template context, but
+you need to make Cerubis aware of the methods it's allowed to call:
+
+    class Foo
+      include Cerubis::Method
+      cerubis_method :foo, :bar, :baz
+
+      def foo; "Foo Method"; end
+      def bar; "Bar Method"; end
+      def baz; "Baz Method"; end
+    end
+
+    template_str = "<some-template-text>"
+    context      = { foo: Foo.new }
+
+    Cerubis.render(template_str, context)
+
+Shown above, object methods are made available to Cerubis templates by
+indicating them with `cerubis_method`. The `cerubis_method` can have
+many method names passed to it and `cerubis_method` can be called
+multiple times.
+
+## Template Helpers
+
+Template helpers are meant to add convienence methods to your code.
+Below you see how simple it is to add a helper and to use it in your
+template:
+
+    # Adding a new helper
+    module FooHelper
+      def foo_helper(name, value)
+        "My name is #{name} and my value is #{value}"
+      end
+    end
+
+    Cerubis.register_helper FooHelper
+
+    # Using the helper
+    content = <<-STR
+      Hello {{ foo_helper 'John Doe', '12' }}
+    STR
+
+    template = Cerubis.render(content)
+    template.to_html
+
+## Testing
+
+You can run the tests in a few different ways. First, you've got your
+standard ruby way:
+
+    ruby -Ilib:test test/cerubis_test.rb
+    ruby -Ilib:test test/all.rb
+
+Or you can run them all with Rake:
+
+    rake test
+
+## Code Coverage
+
+The [cover_me][4] gem has been added to the project. If you'd like to see
+the current coverage just run `thor test:coverage`.
+
+[1]: http://github.com/shopify/liquid
+[2]: http://github.com/defunkt/mustache
+[3]: https://secure.travis-ci.org/daneharrigan/cerubis
+[4]: https://github.com/markbates/cover_me

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc 'Runs all test files'
+task :test do
+  system "ruby -Ilib:test test/all.rb"
+end
+
+desc 'Generate test coverage report'
+task :'test:coverage' do
+  require 'cover_me'
+
+  Rake::Task.invoke :test
+  CoverMe.complete!
+end

data/TODO.md

@@ -0,0 +1,31 @@
+# Cerubis TODO
+
+## Hash arguments
+
+Helpers only support an argument list. They don't support hashes.
+Blocks don't support hashes either. I think it'll be harder to add hash
+support to blocks than to helpers, but I see value in adding it to both.
+
+    {{#form_for page, as: f}}
+      {{f.text_field 'first_name', value: 'John'}}
+      {{f.text_field 'last_name',  value: 'Smith'}}
+      {{f.text_area  'comments',   value: 'Comments...'}}
+      {{f.submit     'Send!',      id: 'comment-button'}}
+    {{/form_for}}
+
+The code above is an example of how I think I'd like the hash syntax to
+work in `Cerubis`. Note that I the "as: f" key/value pair does not have
+quotes around the "f." This is intentional, to indicate that the value
+can be any item within the template context.
+
+## Refactors
+
+The `Cerubis::Parser#nested_block?` and `Cerubis::Parser#blocks_not_closed?`
+methods are very similar. I think they can be consolidated.
+
+Add backwards compatibility for 1.8.7/ree
+
+## Test coverage
+
+At the time of writing, `Cerubis` sits at 98.8% coverage and less than
+400 LOC. I'd like to see the coverage brought to 100%.`

data/cerubis.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cerubis/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cerubis"
+  s.version     = Cerubis::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Dane Harrigan"]
+  s.email       = ["dane.harrigan@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{A simple, secure, non-evaluating template engine}
+  s.description = %q{A simple, secure, non-evaluating template engine}
+
+  s.rubyforge_project     = "cerubis"
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/examples/blocks.rb

@@ -0,0 +1,20 @@
+require 'bundler/setup'
+require 'cerubis'
+
+content = <<-STR
+<html>
+  {{#if true}}
+    <header>
+      {{#unless false}}
+        <ul>
+          {{#loop item in collection}}
+            <li>{{item}}</li>
+          {{/loop}}
+        </ul>
+      {{/unless}}
+    </header>
+  {{/if}}
+</html>
+STR
+
+puts Cerubis.render(content, collection: [1,2,3])

data/examples/full/blocks/script_block.rb

@@ -0,0 +1,8 @@
+class ScriptBlock
+  include Cerubis::VariableReplacement
+  include Cerubis::Block
+
+  def render
+    %{<script>#{replace_variables(yield)}</script>}
+  end
+end

data/examples/full/config.rb

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+require 'cerubis'
+require 'helpers/html_helpers'
+require 'helpers/include_helper'
+require 'blocks/script_block'
+require 'models/page'
+require 'models/site'
+
+# register blocks
+Cerubis.register_block :script, ScriptBlock
+
+# register helpers
+Cerubis.register_helper :stylesheet_link_tag, :javascript_include_tag, :link_to, HTMLHelpers
+Cerubis.register_helper :include, IncludeHelper

data/examples/full/example.rb

@@ -0,0 +1,25 @@
+ExampleRoot = File.expand_path(File.dirname(__FILE__))
+$: << ExampleRoot
+
+require 'config'
+
+# create page objects
+subpages = [
+  Page.new('Sub-page: 1'),
+  Page.new('Sub-page: 2'),
+  Page.new('Sub-page: 3'),
+  Page.new('Sub-page: 4'),
+  Page.new('Sub-page: 5')
+]
+
+homepage = Page.new('Example Page Title', subpages)
+
+# create site object
+site = Site.new('Example Site', homepage: homepage)
+
+# get main template
+content = File.read("#{ExampleRoot}/templates/main.cerubis")
+
+# render template
+template = Cerubis.render(content, page: homepage, site: site, current_year: Time.now.year)
+puts template.to_html

data/examples/full/helpers/html_helpers.rb

@@ -0,0 +1,13 @@
+module HTMLHelpers
+  def stylesheet_link_tag(name)
+    %{<link href="/stylesheets/#{name}.css" rel="stylesheet">}
+  end
+
+  def javascript_include_tag(name)
+    %{<script src="/javascripts/#{name}.js"></script>}
+  end
+
+  def link_to(title, url)
+    %{<a href="#{url}">#{title}</a>}
+  end
+end

data/examples/full/helpers/include_helper.rb

@@ -0,0 +1,15 @@
+module IncludeHelper
+  def include(name)
+    full_path = "#{template_root}/_#{name}.cerubis"
+    if File.exists?(full_path)
+      template = File.read(full_path)
+
+      Cerubis.render(template, context)
+    end
+  end
+
+  private
+    def template_root
+      @template_root ||= File.expand_path(File.dirname(__FILE__) + '/../templates')
+    end
+end

data/examples/full/models/page.rb

@@ -0,0 +1,17 @@
+class Page
+  include Cerubis::Method
+
+  attr :title
+  attr :subpages
+
+  cerubis_method :title, :subpages, :permalink
+
+  def initialize(title, subpages=[])
+    @title    = title
+    @subpages = subpages
+  end
+
+  def permalink
+    "/#{@title.downcase.gsub(/\s/,'-')}"
+  end
+end

data/examples/full/models/site.rb

@@ -0,0 +1,13 @@
+class Site
+  include Cerubis::Method
+
+  attr :title
+  attr :homepage
+
+  cerubis_method :title, :homepage
+
+  def initialize(title, homepage)
+    @title    = title
+    @homepage = homepage
+  end
+end

data/examples/full/templates/_footer.cerubis

@@ -0,0 +1 @@
+<footer>&copy;{{current_year}} {{site.title}}</footer>

data/examples/full/templates/_header.cerubis

@@ -0,0 +1 @@
+<header>{{site.title}}</header>

data/examples/full/templates/main.cerubis

@@ -0,0 +1,31 @@
+<!doctype html>
+<html>
+  <head>
+    {{stylesheet_link_tag 'main'}}
+    {{javascript_include_tag 'main'}}
+    <title>{{page.title}} | {{site.title}}</title>
+    {{#script}}
+      var name = '{{page.title}}';
+      console.log('Page loaded: ' + name);
+    {{/script}}
+  </head>
+  <body>
+    {{include 'header'}}
+    <div id="container">
+      <div id="content">
+        <h1>{{page.title}}</h1>
+        {{#if site.homepage === page}}
+        <h2>Welcome to {{page.title}}!</h2>
+        {{/if}}
+      </div>
+      <aside>
+        <ul>
+          {{#loop item in page.subpages}}
+            <li>{{link_to item.title, item.permalink}}</li>
+          {{/loop}}
+        </ul>
+      </aside>
+    </div>
+    {{include 'footer'}}
+  </body>
+</html>

data/examples/helpers.rb

@@ -0,0 +1,22 @@
+require 'bundler/setup'
+require 'cerubis'
+
+Page = Struct.new(:title, :permalink)
+page = Page.new('Homepage', '/')
+
+module LinkTo
+  def link_to(page_or_title, permalink='')
+    title = page_or_title.is_a?(String) ? page_or_title : page_or_title.title
+    permalink = page_or_title.permalink unless page_or_title.is_a?(String)
+
+    %{<a href="#{permalink}">#{title}</a>}
+  end
+end
+
+content = <<-STR
+1: {{ link_to page }}
+2: {{ link_to 'About Us', '/about-us' }}
+STR
+
+Cerubis.register_helper :link_to, LinkTo
+puts Cerubis.render(content, page: page)

data/examples/html.rb

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+require 'cerubis'
+
+content = <<-STR
+<html>
+  <body>
+    {{#if true}}
+      <h1>Header Content</h1>
+      {{#if true}}
+        <p>Branding Message</p>
+      {{/if}}
+    {{/if}}
+  </body>
+</html>
+STR
+
+template = Cerubis.render(content)
+puts template.to_html