closure-templates 0.1.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+build.sh
+test/js/*.js

data/Gemfile

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

data/README.md

@@ -0,0 +1,118 @@
+# Closure Templates
+
+Gem for using [Google Closure Templates](http://code.google.com/closure/templates/) with [jRuby](http://jruby.org/).
+
+## Installation
+
+    gem install closure-templates
+
+## Usage
+
+Assuming a simple template:
+
+    /** myapp.soy */
+
+    {namespace myapp.templates}
+    
+    /**
+      * Hello there template
+      * @param name The name of the person to greet
+      */
+    {template}
+      Hi {$name}
+    {/template}
+
+Use it in jRuby:
+
+    require 'closure-templates'
+
+    ClosureTemplates.config(
+      :template_directory => '/path/to/soy/templates', 
+      :output_directory => '/path/to/where/generated/javascript/should/go'
+    )
+
+    # render a template
+    ClosureTemplates.render('myapp.templates.hello', :name => 'Dylan')
+    # returns 'Hi Dylan'
+
+Use it in JavaScript:
+
+    <script type="text/javascript" src="soyutils.js"></script>
+    <!-- following was generated by ClosureTemplates -->
+    <script type="text/javascript" src="myapp.templates.js"></script>
+    <script type="text/javascript">
+    var output = myapp.templates.hello({ name: 'Dylan' });
+    </script>
+
+You will need to include either [soyutils.js](http://code.google.com/p/closure-templates/source/browse/trunk/javascript/soyutils.js) (if you are not also using Google Closure Library) or [soyutils_usegoog.js](http://code.google.com/p/closure-templates/source/browse/trunk/javascript/soyutils_usegoog.js) (if you are).  Read more [here](http://code.google.com/closure/templates/docs/javascript_usage.html#utilities).
+
+## Details
+
+### Rails Usage
+
+Currently I have an initializer that looks like this:
+
+    require 'closure-templates'
+
+    ClosureTemplates.config(
+      :template_directory => "#{Rails.root}/app/templates",
+      :output_directory => "#{Rails.root}/app/assets/javascripts/templates"
+    )
+
+Then I render the templates where needed (HAML example):
+
+    != ClosureTemplates.render('myapp.posts.index', :posts => @posts)
+
+### Template Inputs
+
+Google Closure Templates have some requirements for the data passed in, specifically (from [SoyData.java](http://code.google.com/p/closure-templates/source/browse/trunk/java/src/com/google/template/soy/data/SoyData.java#37)):
+
+> Note that in order for the conversion process to succeed, the given data structure must
+> correspond to a valid SoyData tree. Some requirements include:
+> (a) all Maps within your data structure must have string keys that are identifiers,
+> (b) all non-leaf nodes must be Maps or Lists,
+> (c) all leaf nodes must be null, boolean, int, double, or String (corresponding to Soy
+>     primitive data types null, boolean, integer, float, string).
+
+This gem makes some attempts to meet these requirements by converting hash keys to strings and calling the 'attributes' method (by default) on objects which respond to it.  This allows the use of Rails models, for example, to be passed to templates and have their basic attributes accessible.  You can customize the method that the gem uses to try to get a hash of attributes by passing the 'attribute_method' option to the config method (see below).
+
+### Config Options
+
+These are all passed to the ClosureTemplates.config method, which must be called before the first ClosureTemplates.render.
+
+#### :template_directory
+
+*default*: templates
+
+Where you keep your soy templates.  You should specify this.
+
+#### :output_directory
+
+*default*: closure_js
+
+Where you want the gem to put the generated JavaScript files.  You should specify this.
+
+#### :recompile
+
+*default*: true
+
+The gem maintains a list of the soy template files and can check to see if any of them have been modified when calling render.  If one has been modified, then if :recompile is true, it will regenerate the Java object and the JavaScript files from the latest soy templates, which is nice for development.  You could turn this off in production to get slightly faster rendering.
+
+#### :attribute_method
+
+*default*: attributes
+
+This is the method the gem will try to use to get a more Closure Templates friendly representation of Ruby Objects before passing them into the template.  It will call this method on objects if they respond to it.  If you want to customize which properties (or make methods available) you can customize this method to be one you implement in your classes.
+
+### Attributions
+
+Idea for this gem came from a discussion on the Google Closure Template discuss group:
+
+[Closure Templates in Ruby?](https://groups.google.com/group/closure-templates-discuss/browse_thread/thread/50d977fcc121953b)
+
+where Aliaksandr Zahatski pointed me to a [gist](https://gist.github.com/1160217) by Ilya Grigorik which led me to the [Closure Sprockets](https://github.com/igrigorik/closure-sprockets) gem also by Ilya.  I took code and ideas from both places as starting points for this gem.
+
+### License
+
+(MIT License) - Copyright (c) 2011 Dylan Vaughn
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/closure-templates.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "closure-templates/version"
+
+Gem::Specification.new do |s|
+  s.name        = "closure-templates"
+  s.version     = Closure::Templates::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Dylan Vaughn"]
+  s.email       = ["dylancvaughn@gmail.com"]
+  s.homepage    = "https://github.com/dylanvaughn/closure-templates"
+  s.summary     = %q{Google Closure Templates for jRuby / Rails}
+  s.description = %q{Generates methods / code for server and client-side use of Google Closure Templates with jRuby}
+
+  s.add_development_dependency('test-unit')
+
+  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/closure-templates.rb

@@ -0,0 +1,102 @@
+require 'fileutils'
+require 'java'
+require "#{File.dirname(__FILE__)}/jar/soy-latest.jar"
+
+require 'closure-templates/version'
+
+java_import "com.google.template.soy.SoyFileSet"
+java_import "com.google.template.soy.data.SoyMapData"
+java_import "com.google.template.soy.tofu.SoyTofu"
+java_import "com.google.template.soy.jssrc.SoyJsSrcOptions"
+
+class ClosureTemplates
+  @@files           = {}
+  @@template_dir    = nil
+  @@output_dir      = nil
+  @@tofu            = nil
+  @@initialized     = false
+  @@recompile       = nil
+  @@soyJsSrcOptions = nil
+  @@attr_method     = nil
+  
+  def self.config(opts)
+    @@template_dir    = opts[:template_directory] || 'templates'
+    @@output_dir      = opts[:output_directory] || 'closure_js'
+    @@recompile       = !opts[:recompile].nil? ? opts[:recompile] : true
+    @@attr_method     = opts[:attribute_method] || 'attributes'
+    @@soyJsSrcOptions = SoyJsSrcOptions.new
+
+    @@soyJsSrcOptions.setShouldProvideRequireSoyNamespaces(true)
+    FileUtils.mkdir(@@output_dir) unless File.directory?(@@output_dir)
+    self.compile
+
+    @@initialized = true
+  end
+
+  def self.render(template, assigns = {})
+    if !@@initialized
+      raise "ERROR: Not configured!\nConfigure by calling 'ClosureTemplates.config(:template_directory => path_to_templates, :output_directory => path_to_where_js_should_go)' before calling render.\n"
+    end
+    if @@tofu.nil?
+      raise "ERROR: No templates found in #{@@template_dir}"
+    end
+    if @@recompile
+      @@files.keys.each do |f|
+        if File.mtime(f).to_i > @@files[f]
+          self.compile
+          break
+        end
+      end
+    end
+    locals = assigns.dup
+    locals.keys.each do |key|
+      val = locals.delete(key)
+      if val.is_a?(Array)
+        locals[key.to_s] = val.map { |v| convert_for_closure(v) }
+      else
+        locals[key.to_s] = convert_for_closure(val)
+      end
+    end
+    @@tofu.render(template, locals, nil)
+  end
+
+  def self.convert_for_closure(val)
+    val = val.send(@@attr_method) if val.respond_to?(@@attr_method)
+    if val.is_a?(Hash)
+      val.keys.each do |k|
+        v = val.delete(k)
+        val[k.to_s] = v.is_a?(Integer) ? v.to_java(:int) : v
+      end
+    end
+    val
+  end
+
+  def self.compile
+    @@files = {}
+    files_in_order = []
+    sfs_builder = SoyFileSet::Builder.new
+    Dir.glob("#{@@template_dir}/**/*.soy") do |file|
+      files_in_order << file
+      @@files[file] = File.mtime(file).to_i
+      sfs_builder.add(java.io.File.new(file))
+    end
+    if @@files.keys.size == 0
+      # no templates
+      @@tofu = nil
+    else
+      sfs = sfs_builder.build
+
+      # ruby
+      @@tofu = sfs.compileToJavaObj(true)
+
+      # javascript
+      sfs.compileToJsSrc(@@soyJsSrcOptions, nil).each_with_index do |js_out, index|
+        file_path = File.join(@@output_dir, files_in_order[index].gsub(/^#{@@template_dir}\//, '').gsub(/soy$/, 'js'))
+        File.open(file_path, 'w') do |f|
+          f.write(js_out)
+        end
+      end
+    end
+  end
+
+end

data/lib/closure-templates/version.rb

@@ -0,0 +1,5 @@
+module Closure
+  module Templates
+    VERSION = "0.1.1"
+  end
+end

data/test/person.rb

@@ -0,0 +1,33 @@
+class Person
+
+  def initialize(first_name, last_name)
+    @first_name = first_name
+    @last_name = last_name
+  end
+
+  def age
+    35
+  end
+
+  def first_name
+    @first_name
+  end
+
+  def last_name
+    @last_name
+  end
+
+  def full_name
+    "#{first_name} #{last_name}"
+  end
+
+  def attributes
+    {
+      "first_name" => first_name,
+      "last_name" => last_name,
+      "full_name" => full_name,
+      "age" => age
+    }
+  end
+
+end

data/test/templates/examples.nested.soy

@@ -0,0 +1,35 @@
+{namespace examples.nested}
+
+/**
+ * Greets a person using "Hello" by default.
+ * @param name The name of the person.
+ * @param? greetingWord Optional greeting word to use instead of "Hello".
+ */
+{template .helloName}
+  {if not $greetingWord}
+    Hello {$name}!
+  {else}
+    {$greetingWord} {$name}!
+  {/if}
+{/template}
+
+/**
+ * Greets a person and optionally a list of other people.
+ * @param name The name of the person.
+ * @param additionalNames The additional names to greet. May be an empty list.
+ */
+{template .hello}
+  // Greet the person.
+  {call .helloName data="all" /}<br>
+  // Greet the additional people.
+  {foreach $additionalName in $additionalNames}
+    {call .helloName}
+      {param name: $additionalName /}
+    {/call}
+    {if not isLast($additionalName)}
+      <br>  // break after every line except the last
+    {/if}
+  {ifempty}
+    No additional people to greet.
+  {/foreach}
+{/template}

data/test/templates/examples.simple.soy

@@ -0,0 +1,57 @@
+{namespace examples.simple}
+
+/**
+ * Greets a person using "Hello" by default.
+ * @param name The name of the person.
+ */
+{template .helloSimple}
+  Hiya {$name}!
+{/template}
+
+/**
+ * Greets a object
+ * @param object The named thing.
+ */
+{template .helloObject}
+  First name is: {$object.first_name} and last name is: {$object.last_name} and full name is: {$object.full_name}
+{/template}
+
+/**
+ * Tells you your age (testing numbers)
+ * @param object The named thing.
+ */
+{template .helloObjectInt}
+  {$object.first_name}'s age is {$object.age}
+{/template}
+
+
+/**
+ * Greets a list of objects
+ * @param objects An array of the things.
+ */
+{template .helloObjects}
+  {foreach $object in $objects}
+    {call .helloObject}
+      {param object: $object /}
+    {/call}
+    <br />
+  {/foreach}
+{/template}
+
+
+/**
+ * Data tests
+ * @param data A hash of different data types
+ */
+{template .dataObjects}
+String is {$data.string}, int is {$data.int}, float is {$data.float}, null is {$data.null}, bool_true is {$data.bool_true}, bool_false is {$data.bool_false}
+{/template}
+
+
+/**
+ * Data tests
+ * @param data A hash of different bools
+ */
+{template .booleans}
+{if $data.bool_true}True is true.{/if} {if not $data.bool_false}False is false.{/if}
+{/template}

data/test/test_closure-templates.rb

@@ -0,0 +1,70 @@
+require 'test/unit'
+require 'closure-templates'
+require 'person'
+
+class TestClosureTemplates < Test::Unit::TestCase
+
+  def setup
+    ClosureTemplates.config(:template_directory => "#{File.dirname(__FILE__)}/templates", :output_directory => "test/js")
+  end
+
+  def test_simple_template
+    assert_equal ClosureTemplates.render('examples.simple.helloSimple', { :name => 'Bob' }), 'Hiya Bob!'
+  end
+
+  def test_more_complicated_template
+    assert_equal ClosureTemplates.render('examples.nested.hello', { :name => 'Jane', :additionalNames => ['Sue', 'Frank'] }), 'Hello Jane!<br>Hello Sue!<br>Hello Frank!'
+  end
+
+  def test_simple_template_without_locals
+    assert_raise NativeException do
+      ClosureTemplates.render('examples.simple.helloSimple')
+    end
+  end
+
+  def test_empty_template_dir
+    assert_nothing_raised do
+      ClosureTemplates.config(:template_directory => "#{File.dirname(__FILE__)}/no_templates", :output_directory => "test/js")
+    end
+  end
+
+  def test_calling_render_with_no_templates
+    assert_raise RuntimeError do
+      ClosureTemplates.config(:template_directory => "#{File.dirname(__FILE__)}/no_templates", :output_directory => "test/js")
+      ClosureTemplates.render('examples.simple.helloSimple')
+    end
+  end
+
+  def test_calling_render_with_incorrect_template_name
+    assert_raise NativeException do
+      ClosureTemplates.render('examples.simple.notSoSimple', { :name => 'Bob' })
+    end
+  end
+
+  def test_calling_with_ruby_object
+    dylan = Person.new('Dylan', 'Vaughn')
+    assert_equal ClosureTemplates.render('examples.simple.helloObject', :object => dylan), 'First name is: Dylan and last name is: Vaughn and full name is: Dylan Vaughn'
+  end
+
+  def test_calling_with_ruby_object_with_int
+    dylan = Person.new('Dylan', 'Vaughn')
+    assert_equal ClosureTemplates.render('examples.simple.helloObjectInt', :object => dylan), "Dylan's age is 35"
+  end
+
+  def test_calling_with_array_of_ruby_objects
+    dylan = Person.new('Dylan', 'Vaughn')
+    dana = Person.new('Dana', 'Vaughn')
+    assert_equal ClosureTemplates.render('examples.simple.helloObjects', :objects => [dylan, dana]), 'First name is: Dylan and last name is: Vaughn and full name is: Dylan Vaughn<br />First name is: Dana and last name is: Vaughn and full name is: Dana Vaughn<br />'
+  end
+
+  def test_data_types
+    data = { :string => 'string', :int => 2, :float => 3.4, :null => nil, :bool_true => true, :bool_false => false }
+    assert_equal ClosureTemplates.render('examples.simple.dataObjects', :data => data), 'String is string, int is 2, float is 3.4, null is null, bool_true is true, bool_false is false'
+  end
+
+  def test_booleans
+    data = { :bool_true => true, :bool_false => false }
+    assert_equal ClosureTemplates.render('examples.simple.booleans', :data => data), 'True is true. False is false.'
+  end
+
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: closure-templates
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Dylan Vaughn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-11 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Generates methods / code for server and client-side use of Google Closure Templates with jRuby
+email: 
+- dylancvaughn@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- closure-templates.gemspec
+- lib/closure-templates.rb
+- lib/closure-templates/version.rb
+- lib/jar/soy-latest.jar
+- test/person.rb
+- test/templates/examples.nested.soy
+- test/templates/examples.simple.soy
+- test/test_closure-templates.rb
+has_rdoc: true
+homepage: https://github.com/dylanvaughn/closure-templates
+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: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Google Closure Templates for jRuby / Rails
+test_files: []
+