RubyGems - jrb - Versions diffs - 0.1.0 - Mend

jrb 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (23) hide show

data/.gitignore +5 -0
data/Gemfile +4 -0
data/LICENSE +19 -0
data/README.md +70 -0
data/Rakefile +10 -0
data/jrb.gemspec +24 -0
data/lib/jrb.rb +5 -0
data/lib/jrb/rails.rb +20 -0
data/lib/jrb/template.rb +40 -0
data/lib/jrb/version.rb +3 -0
data/test/action_view_test.rb +16 -0
data/test/dummy/app/controllers/test_controller.rb +4 -0
data/test/dummy/app/views/layouts/_header.html.rb +1 -0
data/test/dummy/app/views/layouts/test.html.rb +4 -0
data/test/dummy/app/views/test/index.html.rb +1 -0
data/test/dummy/config.ru +4 -0
data/test/dummy/config/application.rb +14 -0
data/test/dummy/config/boot.rb +10 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/routes.rb +3 -0
data/test/test_helper.rb +7 -0
data/test/tilt_test.rb +204 -0
metadata +109 -0

data/.gitignore ADDED

@@ -0,0 +1,5 @@
+*.gem
+*.log
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile ADDED

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+# Specify your gem's dependencies in jrb.gemspec
+gemspec

data/LICENSE ADDED

@@ -0,0 +1,19 @@
+Copyright (c) 2010-2011 Voormedia B.V.
+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/README.md ADDED

@@ -0,0 +1,70 @@
+JRB - Plain Ruby templates
+==========================
+JRB is a simple template handler that allows you to use plain Ruby files as
+templates. Use it when you're experimenting with your views. Use it if you
+have templates that don't have much markup. Or use it if you prefer to use
+HTML generators such as [Crafty](https://github.com/voormedia/crafty).
+Synopsis
+--------
+Add `jrb` to your `Gemfile`:
+    gem "jrb"
+Now you can write Ruby templates whenever you like. JRB renders the last
+return value of your Ruby template.
+    # app/views/examples/hello.html.rb
+    "Hello world!"
+For more complex scenarios, JRB exposes the method `<<`, aliased as `write`.
+It allows you to write directly to the output stream.
+    # app/views/examples/greeting.html.rb
+    write "Hello "
+    write @name
+    write "!"
+JRB escapes HTML output by default.
+    # app/views/examples/escaping.html.rb
+    write "<html>".html_safe
+    write @unsafe_content
+    write "</html>".html_safe
+JRB really shines when used in combination with HTML helpers such as those
+provided by [Crafty](https://github.com/voormedia/crafty).
+    # app/controllers/application_controller.rb
+    class ApplicationController < ActionController::Base
+      helper Crafty::HTML::Basic
+    end
+    # app/views/examples/builder.html.rb
+    html do
+      head do
+        title "Hello"
+      end
+      body do
+        div class: ["main", "content"] do
+          p "Hello #{@name}!"
+        end
+      end
+    end
+About JRB
+---------
+JRB was created by Rolf Timmermans (r.timmermans *at* voormedia.com)
+Copyright 2010-2011 Voormedia - [www.voormedia.com](http://www.voormedia.com/)
+License
+-------
+JRB is released under the MIT license.

data/Rakefile ADDED

@@ -0,0 +1,10 @@
+require "bundler"
+require "rake/testtask"
+Bundler::GemHelper.install_tasks
+Rake::TestTask.new do |test|
+  test.pattern = "test/**/*_test.rb"
+end
+task :default => :test

data/jrb.gemspec ADDED

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jrb/version"
+Gem::Specification.new do |s|
+  s.name        = "jrb"
+  s.version     = JRB::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Rolf Timmermans"]
+  s.email       = ["r.timmermans@voormedia.com"]
+  s.homepage    = "https://github.com/voormedia/jrb"
+  s.summary     = %q{JRB templates are Just Ruby}
+  s.description = %q{JRB is a trivial templating engine that allows you to use plain Ruby files as templates.}
+  s.rubyforge_project = "jrb"
+  s.add_dependency("tilt", ["~> 1.3"])
+  s.add_development_dependency("rails", ["~> 3.0"])
+  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/lib/jrb.rb ADDED

@@ -0,0 +1,5 @@
+require "tilt"
+require "jrb/template"
+require "jrb/rails" if defined?(Rails)
+Tilt.register JRB::Template, "rb"

data/lib/jrb/rails.rb ADDED

@@ -0,0 +1,20 @@
+module JRB
+  module Rails
+    class TemplateHandler
+      class << self
+        def call(template)
+          tilt_template = JRB::Template.new(template.identifier) { template.source }
+          tilt_template.send(:precompiled, {}).first
+        end
+      end
+    end
+    class Railtie < ::Rails::Railtie
+      initializer "jrb.register_handler" do |app|
+        ActiveSupport.on_load(:action_view) do
+          ActionView::Template.register_template_handler "rb", TemplateHandler
+        end
+      end
+    end
+  end
+end

data/lib/jrb/template.rb ADDED

@@ -0,0 +1,40 @@
+require "tilt/template"
+module JRB
+  class Template < Tilt::Template
+    self.default_mime_type = "text/html"
+    def prepare
+      @new_buffer = options.delete(:escape_html) == false ? "''" : "ActiveSupport::SafeBuffer.new"
+    end
+    def precompiled_preamble(locals)
+      <<-RUBY
+        #{super}
+        __output_buffer = #{@new_buffer}
+        __old_output_buffer, @__output_buffer = @__output_buffer, __output_buffer
+        instance_eval do
+          def <<(data)
+            @__output_buffer << data
+          end
+          alias write <<
+        end
+        __result = begin
+      RUBY
+    end
+    def precompiled_postamble(locals)
+      <<-RUBY
+        ensure
+          @__output_buffer = __old_output_buffer
+        end
+        __output_buffer << __result unless __result == __output_buffer
+        __output_buffer
+      RUBY
+    end
+    def precompiled_template(locals)
+      data.to_str
+    end
+  end
+end

data/lib/jrb/version.rb ADDED

@@ -0,0 +1,3 @@
+module JRB
+  VERSION = "0.1.0"
+end

data/test/action_view_test.rb ADDED

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+require File.expand_path("test_helper", File.dirname(__FILE__))
+class ActionViewTest < ActionController::TestCase
+  tests TestController
+  test "rendering .rb files" do
+    get :index, :name => "John"
+    assert_equal "<html><head></head><body>Hello John!</body></html>", response.body
+  end
+  test "escaping html characters" do
+    get :index, :name => "<script>unsafe</script>"
+    assert_equal "<html><head></head><body>Hello &lt;script&gt;unsafe&lt;/script&gt;!</body></html>", response.body
+  end
+end

data/test/dummy/app/controllers/test_controller.rb ADDED

@@ -0,0 +1,4 @@
+class TestController < ActionController::Base
+  def index
+  end
+end

data/test/dummy/app/views/layouts/_header.html.rb ADDED

	@@ -0,0 +1 @@
1	+ "<head></head>".html_safe

data/test/dummy/app/views/layouts/test.html.rb ADDED

@@ -0,0 +1,4 @@
+write "<html>".html_safe
+write render :partial => "layouts/header"
+write "<body>".html_safe + yield + "</body>".html_safe
+write "</html>".html_safe

data/test/dummy/app/views/test/index.html.rb ADDED

	@@ -0,0 +1 @@
1	+ "Hello #{params[:name]}!"

data/test/dummy/config.ru ADDED

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb ADDED

@@ -0,0 +1,14 @@
+require File.expand_path('../boot', __FILE__)
+require "action_controller/railtie"
+Bundler.require
+require "jrb"
+module Dummy
+  class Application < Rails::Application
+    config.encoding = "utf-8"
+    config.active_support.deprecation = :stderr
+  end
+end

data/test/dummy/config/boot.rb ADDED

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/environment.rb ADDED

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy/config/routes.rb ADDED

@@ -0,0 +1,3 @@
+Dummy::Application.routes.draw do
+  get "/" => "test#index"
+end

data/test/test_helper.rb ADDED

@@ -0,0 +1,7 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+Rails.backtrace_cleaner.remove_silencers!

data/test/tilt_test.rb ADDED

@@ -0,0 +1,204 @@
+# encoding: UTF-8
+require File.expand_path("test_helper", File.dirname(__FILE__))
+require "tempfile"
+class TiltTemplateTest < ActiveSupport::TestCase
+  test "registered for .rb files" do
+    assert Tilt.mappings["rb"].include?(JRB::Template)
+  end
+  test "loading and evaluating templates on #render" do
+    template = JRB::Template.new { "'Hello World!'" }
+    assert_equal "Hello World!", template.render
+  end
+  test "can be rendered more than once" do
+    template = JRB::Template.new { "'Hello World!'" }
+    3.times { assert_equal "Hello World!", template.render }
+  end
+  test "passing locals" do
+    template = JRB::Template.new { '"Hey " + name + "!"' }
+    assert_equal "Hey Joe!", template.render(Object.new, :name => 'Joe')
+  end
+  test "evaluating in an object scope" do
+    template = JRB::Template.new { '"Hey #{@name}!"' }
+    scope = Object.new
+    scope.instance_variable_set :@name, 'Joe'
+    assert_equal "Hey Joe!", template.render(scope)
+  end
+  test "automatic output escaping" do
+    template = JRB::Template.new { '"Hey #{@name}!"' }
+    scope = Object.new
+    scope.instance_variable_set :@name, '<script>Joe</script>'
+    assert_equal "Hey &lt;script&gt;Joe&lt;/script&gt;!", template.render(scope)
+  end
+  test "disabled automatic output escaping" do
+    template = JRB::Template.new(:escape_html => false) { '"Hey #{@name}!"' }
+    scope = Object.new
+    scope.instance_variable_set :@name, '<script>Joe</script>'
+    assert_equal "Hey <script>Joe</script>!", template.render(scope)
+  end
+  test "value equals output buffer" do
+    template = JRB::Template.new { '__output_buffer << "Hey #{name}!"; __output_buffer' }
+    assert_equal "Hey Joe!", template.render(Object.new, :name => 'Joe')
+  end
+  test "write method" do
+    template = JRB::Template.new { 'write "Hey "; write name; write "!"' }
+    assert_equal "Hey Joe!", template.render(Object.new, :name => 'Joe')
+    assert_equal "Hey Jane!", template.render(Object.new, :name => 'Jane')
+  end
+  test "passing a block for yield" do
+    template = JRB::Template.new { '"Hey #{yield}!"' }
+    assert_equal "Hey Joe!", template.render { 'Joe' }
+  end
+  test "backtrace file and line reporting without locals" do
+    data = '"Hey #{name}!" + fail'
+    template = JRB::Template.new('test.rb', 11) { data }
+    begin
+      template.render
+      fail 'should have raised an exception'
+    rescue => boom
+      assert_kind_of NameError, boom
+      line = boom.backtrace.grep(/^test\.rb:/).first
+      assert line, "Backtrace didn't contain test.rb"
+      file, line, meth = line.split(":")
+      assert_equal '11', line
+    end
+  end
+  test "backtrace file and line reporting with locals" do
+    data = '"Hey #{name}!" + fail'
+    template = JRB::Template.new('test.rb', 1) { data }
+    begin
+      template.render(Object.new, :name => 'Joe', :foo => 'bar')
+      fail 'should have raised an exception'
+    rescue => boom
+      assert_kind_of RuntimeError, boom
+      line = boom.backtrace.first
+      file, line, meth = line.split(":")
+      assert_equal 'test.rb', file
+      assert_equal '1', line
+    end
+  end
+end
+class CompiledTiltTemplateTest < ActiveSupport::TestCase
+  class Scope
+  end
+  test "compiling template source to a method" do
+    template = JRB::Template.new { "'Hello World!'" }
+    template.render(Scope.new)
+    method = template.send(:compiled_method, [])
+    assert_kind_of UnboundMethod, method
+  end
+  test "loading and evaluating templates on #render" do
+    template = JRB::Template.new { "'Hello World!'" }
+    assert_equal "Hello World!", template.render(Scope.new)
+    assert_equal "Hello World!", template.render(Scope.new)
+  end
+  test "passing locals" do
+    template = JRB::Template.new { '"Hey " + name + "!"' }
+    assert_equal "Hey Joe!", template.render(Scope.new, :name => 'Joe')
+  end
+  test "evaluating in an object scope" do
+    template = JRB::Template.new { '"Hey #{@name}!"' }
+    scope = Scope.new
+    scope.instance_variable_set :@name, 'Joe'
+    assert_equal "Hey Joe!", template.render(scope)
+    scope.instance_variable_set :@name, 'Jane'
+    assert_equal "Hey Jane!", template.render(scope)
+  end
+  test "automatic output escaping" do
+    template = JRB::Template.new { '"Hey #{@name}!"' }
+    scope = Scope.new
+    scope.instance_variable_set :@name, '<script>Joe</script>'
+    assert_equal "Hey &lt;script&gt;Joe&lt;/script&gt;!", template.render(scope)
+  end
+  test "disabled automatic output escaping" do
+    template = JRB::Template.new(:escape_html => false) { '"Hey #{@name}!"' }
+    scope = Scope.new
+    scope.instance_variable_set :@name, '<script>Joe</script>'
+    assert_equal "Hey <script>Joe</script>!", template.render(scope)
+  end
+  test "value equals output buffer" do
+    template = JRB::Template.new { '__output_buffer << "Hey #{name}!"; __output_buffer' }
+    assert_equal "Hey Joe!", template.render(Scope.new, :name => 'Joe')
+  end
+  test "write method" do
+    template = JRB::Template.new { 'write "Hey "; write name; write "!"' }
+    assert_equal "Hey Joe!", template.render(Scope.new, :name => 'Joe')
+    assert_equal "Hey Jane!", template.render(Scope.new, :name => 'Jane')
+  end
+  test "passing a block for yield" do
+    template = JRB::Template.new { '"Hey #{yield}!"' }
+    assert_equal "Hey Joe!", template.render(Scope.new) { 'Joe' }
+    assert_equal "Hey Jane!", template.render(Scope.new) { 'Jane' }
+  end
+  test "backtrace file and line reporting without locals" do
+    data = '"Hey #{name}!" + fail'
+    template = JRB::Template.new('test.erb', 11) { data }
+    begin
+      template.render(Scope.new)
+      fail 'should have raised an exception'
+    rescue => boom
+      assert_kind_of NameError, boom
+      line = boom.backtrace.grep(/^test\.erb:/).first
+      assert line, "Backtrace didn't contain test.erb"
+      file, line, meth = line.split(":")
+      assert_equal '11', line
+    end
+  end
+  test "backtrace file and line reporting with locals" do
+    data = '"Hey #{name}!" + fail'
+    template = JRB::Template.new('test.erb') { data }
+    begin
+      template.render(Scope.new, :name => 'Joe', :foo => 'bar')
+      fail 'should have raised an exception'
+    rescue => boom
+      assert_kind_of RuntimeError, boom
+      line = boom.backtrace.first
+      file, line, meth = line.split(":")
+      assert_equal 'test.erb', file
+      assert_equal '1', line
+    end
+  end
+  test "encoding with magic comment" do
+    f = Tempfile.open("template")
+    f.puts('# coding: UTF-8')
+    f.puts('"ふが #{@hoge}"')
+    f.close()
+    @hoge = "ほげ"
+    jrb = JRB::Template.new(f.path)
+    3.times { jrb.render(self) }
+    f.delete
+  end
+  test "encoding with :default_encoding" do
+    f = Tempfile.open("template")
+    f.puts('"ふが #{@hoge}"')
+    f.close()
+    @hoge = "ほげ"
+    jrb = JRB::Template.new(f.path, :default_encoding => 'UTF-8')
+    3.times { jrb.render(self) }
+    f.delete
+  end
+end

metadata ADDED

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: jrb
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.1.0
+platform: ruby
+authors:
+- Rolf Timmermans
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-05-24 00:00:00 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tilt
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: "1.3"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: "3.0"
+  type: :development
+  version_requirements: *id002
+description: JRB is a trivial templating engine that allows you to use plain Ruby files as templates.
+email:
+- r.timmermans@voormedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- jrb.gemspec
+- lib/jrb.rb
+- lib/jrb/rails.rb
+- lib/jrb/template.rb
+- lib/jrb/version.rb
+- test/action_view_test.rb
+- test/dummy/app/controllers/test_controller.rb
+- test/dummy/app/views/layouts/_header.html.rb
+- test/dummy/app/views/layouts/test.html.rb
+- test/dummy/app/views/test/index.html.rb
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/environment.rb
+- test/dummy/config/routes.rb
+- test/test_helper.rb
+- test/tilt_test.rb
+homepage: https://github.com/voormedia/jrb
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+requirements: []
+rubyforge_project: jrb
+rubygems_version: 1.8.1
+signing_key:
+specification_version: 3
+summary: JRB templates are Just Ruby
+test_files:
+- test/action_view_test.rb
+- test/dummy/app/controllers/test_controller.rb
+- test/dummy/app/views/layouts/_header.html.rb
+- test/dummy/app/views/layouts/test.html.rb
+- test/dummy/app/views/test/index.html.rb
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/environment.rb
+- test/dummy/config/routes.rb
+- test/test_helper.rb
+- test/tilt_test.rb