RubyGems - tiltout - Versions diffs - 1.0.0 - Mend

tiltout 1.0.0

Files changed (8) hide show

data/Gemfile ADDED

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock ADDED

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    tiltout (1.0.0)
+      tilt (~> 1.3)
+GEM
+  remote: http://rubygems.org/
+  specs:
+    metaclass (0.0.1)
+    minitest (2.12.1)
+    mocha (0.12.6)
+      metaclass (~> 0.0.1)
+    rake (0.9.2.2)
+    tilt (1.3.3)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  minitest (~> 2.0)
+  mocha
+  rake (~> 0.9)
+  tiltout!

data/Rakefile ADDED

@@ -0,0 +1,34 @@
+# encoding: utf-8
+# --
+# The MIT License (MIT)
+#
+# Copyright (C) 2012 Gitorious AS
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#++
+require "rake/testtask"
+require "bundler/gem_tasks"
+Rake::TestTask.new("test") do |test|
+  test.libs << "test"
+  test.pattern = "test/**/*_test.rb"
+  test.verbose = true
+end
+task :default => :test

data/Readme.md ADDED

@@ -0,0 +1,194 @@
+# Tiltout
+## Tilt templates with layouts and helpers
+Tiltout is a small abstraction over Tilt that allows you to render templates
+with some additional conveniences:
+* Layouts
+* Helper modules
+* Caching
+## Overview
+Let's say we have a template, `~/projects/tiltout/templates/greet.erb`:
+```rhtml
+<h1><%= @title = greet("Hey", name) %></h1>
+```
+And another template, `~/projects/tiltout/templates/layout.erb`:
+```rhtml
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= @title %></title>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>
+```
+Then the following code:
+```ruby
+require "tiltout"
+module Greeter
+  def greet(greeting, name)
+    "#{greeting} #{name}!"
+  end
+end
+out = Tiltout.new("~/projects/tiltout/templates", :layout => "layout")
+out.helper(Greeter, { :name => "Chris" })
+html = out.render(:greet)
+```
+Will produce the following HTML:
+```html
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Hey Chris!</title>
+  </head>
+  <body>
+    <h1>Hey Chris!</h1>
+  </body>
+</html>
+```
+## Layouts
+`Tiltout` can be instantiated with a default layout that will be used for every
+template. You can also optionally override the layout for each individual
+template to render.
+Layouts are rendered with the same context as templates, and are rendered after
+the template itself. This means that you can set instance variables in the
+template that can be used in the layout (useful for e.g. extra head data, title
+etc).
+Templates are included in the layout where the layout `yield`s, e.g.:
+```rhtml
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= @title %></title>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>
+```
+Given the following template:
+```rhtml
+<h1><%= @title = "Hey!" %></h1>
+```
+The following output would be produced:
+```html
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Hey!</title>
+  </head>
+  <body>
+    <h1>Hey!</h1>
+  </body>
+</html>
+```
+## Helper modules
+`Tiltout` provides a convenient API for registering modules that are included in
+the rendering context so you can call the module's methods as "helpers" from
+your templates:
+```rhtml
+<!-- greet.erb -->
+<h1>Hey <%= snake_case(name) %></h1>
+```
+```ruby
+require "tiltout"
+module SnakeCaser
+  def snake_case(text)
+    text.gsub(/(.)([A-Z])/,'\1_\2').downcase
+  end
+end
+out = Tiltout.new("path/to/templates")
+out.helper(SnakeCaser)
+out.render(:greet, { :name => "ChrisJohansen" })
+#=> "<h1>Hey chris_johansen</h1>"
+```
+## Caching
+By default, `Tiltout` will cache your templates after reading them from file the
+first time. If you don't want caching - say because you're actively developing
+the template - you simply disable it when instantiating your `Tiltout` instance:
+```ruby
+out = Tiltout.new("path/to/templates", :cache => false)
+```
+## Installing
+`tiltout` ships as a gem:
+    $ gem install tiltout
+Or in your Gemfile:
+    gem "tiltout", "~> 1.0.0"
+## Contributing
+Contributions are welcome. To get started:
+    $ git clone git://gitorious.org/gitorious/tiltout.git
+    $ cd tiltout
+    $ bundle install
+    $ rake
+When you have fixed a bug/added a feature/done your thing, create a
+[clone on Gitorious](http://gitorious.org/gitorious/tiltout) or a
+[fork on GitHub](http://github.com/cjohansen/tiltout) and send a
+merge request/pull request, whichever you prefer.
+Please add tests when adding/altering code, and always make sure all the tests
+pass before submitting your contribution.
+## License
+### The MIT License (MIT)
+**Copyright (C) 2012 Gitorious AS**
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/tiltout.rb ADDED

@@ -0,0 +1,77 @@
+# encoding: utf-8
+# --
+# The MIT License (MIT)
+#
+# Copyright (C) 2012 Gitorious AS
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#++
+require "tilt"
+class Tiltout
+  VERSION = "1.0.0"
+  def initialize(template_root, opt = {})
+    @template_root = template_root
+    @cache = {} if !opt.key?(:cache) || opt[:cache]
+    @layout = opt[:layout]
+    @default_type = opt[:default_type] || "erb"
+    @context_class = Class.new
+  end
+  def helper(helper)
+    helper = [helper] unless Array === helper
+    helper.each { |h| @context_class.send(:include, h) }
+  end
+  def render(template, locals = {}, options = {})
+    context = @context_class.new
+    content = load(template).render(context, locals)
+    layout_tpl = options.key?(:layout) ? options[:layout] : @layout
+    if !layout_tpl.nil?
+      content = load(layout_tpl).render(context, locals) { content }
+    end
+    content
+  end
+  private
+  def load(name)
+    file_name = find_file(name)
+    return @cache[file_name] if cached?(file_name)
+    template = Tilt.new(file_name)
+    cache(file_name, template)
+    template
+  end
+  def find_file(name)
+    full_name = File.join(@template_root, name.to_s)
+    return full_name if cached?(full_name) || File.exists?(full_name)
+    File.join(@template_root, "#{name}.#{@default_type}")
+  end
+  def cache(name, template)
+    @cache[name] = template if @cache
+  end
+  def cached?(name)
+    @cache && !!@cache[name]
+  end
+end

data/test/tiltout_test.rb ADDED

@@ -0,0 +1,140 @@
+# encoding: utf-8
+# --
+# The MIT License (MIT)
+#
+# Copyright (C) 2012 Gitorious AS
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#++
+require "bundler/setup"
+require "minitest/autorun"
+require "mocha"
+require "tiltout"
+module ViewHelper
+  def say_it; "YES"; end
+end
+describe Tiltout do
+  before { @root = "/dolt/views" }
+  it "reads template from file" do
+    File.expects(:read).with("/dolt/views/file.erb").returns("")
+    renderer = Tiltout.new("/dolt/views")
+    renderer.render(:file)
+  end
+  it "renders template with locals" do
+    File.stubs(:read).returns("<%= name %>!")
+    renderer = Tiltout.new(@root)
+    assert_equal "Chris!", renderer.render(:file, { :name => "Chris"})
+  end
+  it "caches template in memory" do
+    renderer = Tiltout.new(@root)
+    File.stubs(:read).returns("Original")
+    renderer.render(:file)
+    File.stubs(:read).returns("Updated")
+    assert_equal "Original", renderer.render(:file)
+  end
+  it "does not cache template in memory when configured not to" do
+    renderer = Tiltout.new(@root, :cache => false)
+    File.stubs(:read).returns("Original")
+    renderer.render(:file)
+    File.stubs(:read).returns("Updated")
+    assert_equal "Updated", renderer.render(:file)
+  end
+  it "renders template with layout" do
+    renderer = Tiltout.new("/", :layout => "layout")
+    File.stubs(:read).with("/file.erb").returns("Template")
+    File.stubs(:read).with("/layout.erb").returns("I give you: <%= yield %>")
+    assert_equal "I give you: Template", renderer.render(:file)
+  end
+  it "renders template once without layout" do
+    renderer = Tiltout.new("/", :layout => "layout")
+    File.stubs(:read).with("/file.erb").returns("Template")
+    File.stubs(:read).with("/layout.erb").returns("I give you: <%= yield %>")
+    assert_equal "Template", renderer.render(:file, {}, :layout => nil)
+  end
+  it "renders template once with different layout" do
+    renderer = Tiltout.new("/", :layout => "layout")
+    File.stubs(:read).with("/file.erb").returns("Template")
+    File.stubs(:read).with("/layout.erb").returns("I give you: <%= yield %>")
+    File.stubs(:read).with("/layout2.erb").returns("I present you: <%= yield %>")
+    html = renderer.render(:file, {}, :layout => "layout2")
+    assert_equal "I present you: Template", html
+  end
+  it "renders templates of default type" do
+    renderer = Tiltout.new("/", :default_type => :str)
+    File.stubs(:read).with("/file.str").returns("Hey!")
+    assert_equal "Hey!", renderer.render(:file)
+  end
+  it "renders templates of specific type" do
+    renderer = Tiltout.new("/", :default_type => :lol)
+    File.stubs(:read).with("/file.lol").returns("No!")
+    File.stubs(:read).with("/file.erb").returns("Yes!")
+    File.stubs(:exists?).with("/file.lol").returns(false)
+    File.stubs(:exists?).with("/file.erb").returns(true)
+    assert_equal "Yes!", renderer.render("file.erb")
+  end
+  it "renders with helper object" do
+    renderer = Tiltout.new("/")
+    renderer.helper(ViewHelper)
+    File.stubs(:read).with("/file.erb").returns("Say it: <%= say_it %>")
+    assert_equal "Say it: YES", renderer.render(:file)
+  end
+  it "does not leak state across render calls" do
+    renderer = Tiltout.new("/")
+    File.stubs(:read).with("/file.erb").returns(<<-TEMPLATE)
+<%= @response %><% @response = "NO" %><%= @response %>
+    TEMPLATE
+    assert_equal "NO", renderer.render(:file)
+    assert_equal "NO", renderer.render(:file)
+  end
+  it "shares state between template and layout" do
+    renderer = Tiltout.new("/", :layout => "layout")
+    File.stubs(:read).with("/file.erb").returns(<<-TEMPLATE)
+<% @response = "NO" %><h1><%= @response %></h1>
+    TEMPLATE
+    tpl = "<title><%= @response %></title><%= yield %>"
+    File.stubs(:read).with("/layout.erb").returns(tpl)
+    assert_equal "<title>NO</title><h1>NO</h1>\n", renderer.render(:file)
+  end
+end

data/tiltout.gemspec ADDED

@@ -0,0 +1,51 @@
+# encoding: utf-8
+# --
+# The MIT License (MIT)
+#
+# Copyright (C) 2012 Gitorious AS
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#++
+dir = File.expand_path(File.dirname(__FILE__))
+require File.join(dir, "lib/tiltout")
+Gem::Specification.new do |s|
+  s.name        = "tiltout"
+  s.version     = Tiltout::VERSION
+  s.authors     = ["Christian Johansen"]
+  s.email       = ["christian@gitorious.org"]
+  s.homepage    = "http://gitorious.org/gitorious/tiltout"
+  s.summary     = %q{Tilt templates with layouts and helpers}
+  s.description = <<-DESC
+Tiltout is a small abstraction on top of Tilt that allows you to render
+templates with optional layouts, share state between layout and template,
+register helper modules and optionally cache templates.
+DESC
+  s.add_dependency "tilt", "~>1.3"
+  s.add_development_dependency "minitest", "~> 2.0"
+  s.add_development_dependency "rake", "~> 0.9"
+  s.add_development_dependency "mocha"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata ADDED

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: tiltout
+version: !ruby/object:Gem::Version
+  hash: 23
+  prerelease:
+  segments:
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors:
+- Christian Johansen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-10-05 00:00:00 +02:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tilt
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        hash: 9
+        segments:
+        - 1
+        - 3
+        version: "1.3"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: minitest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        hash: 25
+        segments:
+        - 0
+        - 9
+        version: "0.9"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: |
+  Tiltout is a small abstraction on top of Tilt that allows you to render
+  templates with optional layouts, share state between layout and template,
+  register helper modules and optionally cache templates.
+email:
+- christian@gitorious.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- lib/tiltout.rb
+- test/tiltout_test.rb
+- tiltout.gemspec
+has_rdoc: true
+homepage: http://gitorious.org/gitorious/tiltout
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.4.2
+signing_key:
+specification_version: 3
+summary: Tilt templates with layouts and helpers
+test_files: []