trimmer 0.0.3

data/.gitignore

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

data/Gemfile

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

data/History.md

@@ -0,0 +1,12 @@
+* Version 0.0.1
+  * Initial commit
+* Version 0.0.2
+  #####Changed
+
+  * Only cache templates in production environment
+* Version 0.0.3
+  #####Changed
+
+  * Ruby 1.9 and 1.8 compatibility
+
+

data/README.md

@@ -0,0 +1,6 @@
+Trimmer Controller
+=================
+
+Rack endpoint to make templates and i18n translations available in javascript.
+
+See specs for details.

data/Rakefile

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

data/lib/trimmer/controller.rb

@@ -0,0 +1,123 @@
+require 'rack'
+require 'rack/request'
+require 'json'
+require 'tilt'
+require 'i18n'
+
+module Trimmer
+
+  class Controller
+    attr_accessor :templates_path, :allowed_keys, :renderer_scope
+
+    def initialize(app, opts={})
+      @app = app
+
+      @templates_path = opts[:templates_path] || File.expand_path(File.dirname(__FILE__))
+      @allowed_keys = opts[:allowed_keys] || "*"
+      @renderer_scope = opts[:renderer_scope] || Object.new
+    end
+
+    # Handle trimmer routes
+    # else call the next middleware with the environment.
+    def call(env)
+      request = Rack::Request.new(env)
+      response = nil
+      case request.path
+      when /\/trimmer(\/([^\/]+))*\/translations\.([js]+)$/
+        validate_locale($2) if $2 || ($2 && $2.empty?)
+        response = translations($2, $3)
+      when /\/trimmer\/([^\/]+)\/templates\.([js]+)$/
+        validate_locale($1)
+        response = templates($1, $2)
+      when /\/trimmer\/([^\.|\/]+)\.([js]+)$/
+        validate_locale($1)
+        response = resources($1, $2)
+      else
+        response = @app.call(env)
+      end
+
+      response
+    end
+
+  protected
+
+    def templates(locale, ext)
+      [200, {'Content-Type' => 'text/javascript'}, templates_to_js(locale)]
+    end
+
+
+    def translations(locale, ext)
+      [200, {'Content-Type' => 'text/javascript'}, translations_to_js(:locale => locale, :only => allowed_keys)]
+    end 
+
+    # Exports templates and translations in a single request
+    def resources(locale, ext)
+      opts = {:only => allowed_keys}
+      opts[:locale] = locale if locale && !locale.empty?
+
+      response = translations_to_js(opts)
+      response << "\n"
+      response << templates_to_js(locale)
+      [200, {'Content-Type' => 'text/javascript'}, [response]]
+    end
+
+    #Render a template (using Tilt)
+    def render_to_string(path, opts={})
+      if ENV['RACK_ENV'] == 'production'
+        template = Thread.current[:"#{path}"] || Thread.current[:"#{path}"] = Tilt.new(path, opts)
+      else
+        template = Tilt.new(path, opts)
+      end
+
+      ::I18n.with_exception_handler(:raise_all_exceptions) do
+        string = template.render(renderer_scope)
+        string.respond_to?(:force_encoding) ? string.force_encoding("utf-8") : string
+      end
+    end
+
+    #Validates locale is one recognised by I18n::Locale::Tag implementation
+    def validate_locale(locale)
+      raise "Invalid locale" unless ::I18n::Locale::Tag.tag(locale)
+    end
+
+    # Gets all templates and renders them as JSON, to be used as Mustache templates
+    def templates_to_js(locale)
+      ::I18n.with_locale(locale) do
+        templates = JSON.dump(get_templates_from(templates_path))
+        "Templates = (#{templates});"
+      end
+    end
+
+    # Traverses recursively base_path and fetches templates
+    def get_templates_from(base_path)
+      templates = {}
+      Dir.glob("#{base_path}/**").each do |entry|
+        if File.directory? entry
+          templates[File.basename(entry)] = get_templates_from entry
+        elsif File.file? entry
+          name = File.basename(entry).split('.').first
+          if !name.empty?
+            templates[name] = render_to_string(entry, :ugly => true)
+          end
+        end
+      end
+      templates
+    end
+
+    # Dumps all the translations. Options you can pass:
+    # :locale. If specified, will dump only translations for the given locale.
+    # :only. If specified, will dump only keys that match the pattern. "*.date"
+    def translations_to_js(options = {})
+      "if(typeof(I18n) == 'undefined') { I18n = {}; };\n" +
+      "I18n.translations = (#{locale_with_fallback(options).to_json});"
+    end
+
+    def locale_with_fallback options
+      original_translation = ::I18n.to_hash(options) || {}
+      fallback_translation = ::I18n.to_hash(options.merge(:locale => ::I18n.default_locale))
+      fallback_translation ||= {}
+      fallback_translation.deep_merge original_translation
+    end
+
+  end
+end

data/lib/trimmer/core.rb

@@ -0,0 +1,23 @@
+class Hash
+
+  def reverse_merge(other_hash)
+    other_hash.merge(self)
+  end
+
+  def reverse_merge!(other_hash)
+    merge!( other_hash ){|k,o,n| o }
+  end
+
+  def deep_merge!(other_hash)
+    other_hash.each_pair do |k,v|
+      tv = self[k]
+      self[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? tv.deep_merge(v) : v
+    end
+    self
+  end
+
+  def deep_merge(other_hash)
+    dup.deep_merge!(other_hash)
+  end
+
+end

data/lib/trimmer/i18n.rb

@@ -0,0 +1,99 @@
+require 'i18n'
+
+module Trimmer
+  module I18n
+
+    def raise_all_exceptions(*args)
+      raise args.first
+    end
+
+    def with_exception_handler(tmp_exception_handler = nil)
+      if tmp_exception_handler
+        current_exception_handler = self.exception_handler
+        self.exception_handler    = tmp_exception_handler
+      end
+      yield
+    ensure
+      self.exception_handler = current_exception_handler if tmp_exception_handler
+    end
+
+    def without_fallbacks
+      current_translate_method = ::I18n.backend.method(:translate)
+      ::I18n.backend.class.send(:define_method, 'translate', translate_without_fallbacks)
+      yield
+    ensure
+      ::I18n.backend.class.send(:remove_method, 'translate')
+    end
+
+    # deep_merge by Stefan Rusterholz, see http://www.ruby-forum.com/topic/142809
+    MERGER = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &MERGER) : v2 }
+
+    # Exports translations from the I18n backend to a Hash
+    # :locale. If specified, will dump only translations for the given locale.
+    # :only. If specified, will dump only keys that match the pattern. "*.date"
+    def to_hash options = {}
+      options.reverse_merge!(:only => "*")
+
+      if options[:only] == "*"
+        data = translations
+      else
+        data = scoped_translations options[:only]
+      end
+
+      if options[:locale]
+        data[options[:locale].to_sym]
+      else
+        data
+      end
+    end
+
+    def scoped_translations(scopes) # :nodoc:
+      result = {}
+
+      [scopes].flatten.each do |scope|
+        deep_merge! result, filter(translations, scope)
+      end
+
+      result
+    end
+
+    # Filter translations according to the specified scope.
+    def filter(translations, scopes)
+      scopes = scopes.split(".") if scopes.is_a?(String)
+      scopes = scopes.clone
+      scope = scopes.shift
+
+      if scope == "*"
+        results = {}
+        translations.each do |scope, translations|
+          tmp = scopes.empty? ? translations : filter(translations, scopes)
+          results[scope.to_sym] = tmp unless tmp.nil?
+        end
+        return results
+      elsif translations.has_key?(scope.to_sym)
+        return {scope.to_sym => scopes.empty? ? translations[scope.to_sym] : filter(translations[scope.to_sym], scopes)}
+      end
+      nil
+    end
+
+    # Initialize and return translations
+    def translations
+      self.backend.instance_eval do
+        init_translations unless initialized?
+        translations
+      end
+    end
+
+    def deep_merge!(target, hash) # :nodoc:
+      target.merge!(hash, &MERGER)
+    end
+
+    private
+      
+      def translate_without_fallbacks
+        method_name = RUBY_VERSION =~ /1\.9/ ? :translate : 'translate'
+        ancestor_module_with_translate = (::I18n.backend.class.included_modules - [::I18n::Backend::Fallbacks]).select {|m| m.instance_methods(false).include?(method_name) rescue false}
+        ancestor_module_with_translate.first.instance_method(method_name) rescue nil
+      end
+  end
+end

data/lib/trimmer/version.rb

@@ -0,0 +1,3 @@
+module Trimmer
+  VERSION = "0.0.3"
+end

data/lib/trimmer.rb

@@ -0,0 +1,5 @@
+require 'trimmer/core'
+require 'trimmer/i18n'
+require 'trimmer/controller'
+
+I18n.send(:extend, Trimmer::I18n)

data/test/spec_trimmer_controller.rb

@@ -0,0 +1,160 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+context Trimmer::Controller do
+  F = ::File
+
+  def request(opts={}, &block)
+    Rack::MockRequest.new(Trimmer::Controller.new(@def_app, 
+                                                  :templates_path => (opts[:templates_dir] || templates_dir), 
+                                                  :allowed_keys => (opts[:allowed_keys] || nil))).send(opts[:meth]||:get, opts[:path]||@def_path, opts[:headers]||{})
+  end
+
+  setup do
+    # @def_disk_cache = F.join(F.dirname(__FILE__), 'response_cache_test_disk_cache')
+
+    @def_resources_en = <<-VALUE.strip
+if(typeof(I18n) == 'undefined') { I18n = {}; };
+I18n.translations = ({\"foo\":{\"trimmer\":\"trimmer\"}});
+Templates = ({"foo":{"bar":"<span>trimmer</span>\\n"}});
+VALUE
+
+    @def_translations_en = <<-VALUE.strip
+if(typeof(I18n) == 'undefined') { I18n = {}; };
+I18n.translations = ({\"foo\":{\"trimmer\":\"trimmer\"}});
+VALUE
+
+    @def_templates_en = <<-VALUE.strip
+Templates = ({"foo":{"bar":"<span>trimmer</span>\\n"}});
+VALUE
+
+    @def_resources_es = <<-VALUE.strip
+if(typeof(I18n) == 'undefined') { I18n = {}; };
+I18n.translations = ({\"foo\":{\"trimmer\":\"recortadora\"}});
+Templates = ({"foo":{"bar":"<span>recortadora</span>\\n"}});
+VALUE
+
+    @def_translations_es = <<-VALUE.strip
+if(typeof(I18n) == 'undefined') { I18n = {}; };
+I18n.translations = ({\"foo\":{\"trimmer\":\"recortadora\"}});
+VALUE
+
+    @def_templates_es = <<-VALUE.strip
+Templates = ({"foo":{"bar":"<span>recortadora</span>\\n"}});
+VALUE
+
+    @def_resources_ca = <<-VALUE.strip
+if(typeof(I18n) == 'undefined') { I18n = {}; };
+I18n.translations = ({\"foo\":{\"trimmer\":\"trimmer\"}});
+Templates = ({"foo":{"bar":"<span>recortadora</span>\\n"}});
+VALUE
+
+
+    @def_path = '/trimmer/en.js'
+    @def_value = 'hello world'
+    @def_app = lambda { |env| [200, {'Content-Type' => env['CT'] || 'text/html'}, @def_value]}
+  end
+
+  teardown do
+    # FileUtils.rm_rf(@def_disk_cache)
+  end
+
+  specify "should return a response for /trimmer/:locale.js" do
+    request(:path=>'/trimmer/en.js').body.should.equal(@def_resources_en)
+    request(:path=>'/trimmer/es.js').body.should.equal(@def_resources_es)
+  end
+
+  specify "should return a response for /trimmer/:locale/templates.js" do
+    request(:path=>'/trimmer/en/templates.js').body.should.equal(@def_templates_en)
+    request(:path=>'/trimmer/es/templates.js').body.should.equal(@def_templates_es)
+  end
+
+  specify "should return a response for /trimmer/:locale/translations.js" do
+    request(:path=>'/trimmer/en/translations.js').body.should.equal(@def_translations_en)
+    request(:path=>'/trimmer/es/translations.js').body.should.equal(@def_translations_es)
+  end
+
+  specify "should forward request to next middleware if it doesn't match path" do
+    request(:path=>'/trimmer/en/translations.json').body.should.equal(@def_value)
+  end
+
+  specify "should return a response for /trimmer/:locale/templates.js if fallback found" do
+    lambda {
+      request(:path=>'/trimmer/ca/templates.js').body.should.equal(@def_templates_es)
+    }.should.not.raise(::I18n::MissingTranslationData)
+  end
+
+  specify "should return a response for /trimmer/:locale.js if fallback found" do
+    lambda {
+      request(:path=>'/trimmer/ca.js').body.should.equal(@def_resources_ca)
+    }.should.not.raise(::I18n::MissingTranslationData)
+  end
+
+  specify "should reraise i18n exceptions if no fallback found when rendering all resources" do
+    lambda {
+      request(:path=>'/trimmer/ca.js', :templates_dir => templates_missing_t_dir)
+    }.should.raise(::I18n::MissingTranslationData)
+  end
+
+  specify "should reraise i18n exceptions if no fallback found when rendering templates" do
+    lambda {
+      request(:path=>'/trimmer/ca/templates.js', :templates_dir => templates_missing_t_dir)
+    }.should.raise(::I18n::MissingTranslationData)
+  end
+
+  specify "should reraise i18n exceptions if no fallbacks when rendering all resources" do
+    lambda {
+      ::I18n.without_fallbacks do
+        request(:path=>'/trimmer/pl.js')
+      end
+    }.should.raise(::I18n::MissingTranslationData)
+  end
+
+  specify "should reraise i18n exceptions if no fallback when rendering templates" do
+    lambda {
+      ::I18n.without_fallbacks do
+        request(:path=>'/trimmer/pl/templates.js')
+      end
+    }.should.raise(::I18n::MissingTranslationData)
+  end
+
+  specify "should reraise i18n exceptions if no fallbacks and locale is invalid when rendering all resources" do
+    lambda {
+      ::I18n.without_fallbacks do
+        request(:path=>'/trimmer/foobar.js')
+      end
+    }.should.raise(::I18n::MissingTranslationData)
+  end
+
+  specify "should reraise i18n exceptions if no fallbacks and locale is invalid when rendering templates" do
+    lambda {
+      ::I18n.without_fallbacks do
+        request(:path=>'/trimmer/foobar/templates.js')
+      end
+    }.should.raise(::I18n::MissingTranslationData)
+  end
+
+  specify "should filter translations if allowed_keys option set on Trimmer::Controller instance" do
+    request(:path=>'/trimmer/en/translations.js', :allowed_keys => "*.baz").body.should.equal("if(typeof(I18n) == 'undefined') { I18n = {}; };\nI18n.translations = ({});")
+    request(:path=>'/trimmer/en/translations.js', :allowed_keys => "*.foo").body.should.equal(@def_translations_en)
+  end
+
+  specify "should render all translations if no locale" do
+    request(:path=>'/trimmer/translations.js').body.should.equal(<<-RESP.strip)
+if(typeof(I18n) == 'undefined') { I18n = {}; };\nI18n.translations = ({\"foo\":{\"trimmer\":\"trimmer\"},\"en\":{\"foo\":{\"trimmer\":\"trimmer\"}},\"es\":{\"foo\":{\"trimmer\":\"recortadora\"}}});
+RESP
+  end
+
+  specify "should forward request to next middleware if no local when rendering templates" do
+    ::I18n.without_fallbacks do
+      request(:path=>'/trimmer//templates.js').body.should.equal(@def_value)
+    end
+  end
+
+  specify "should forward request to next middleware if no local when rendering resources" do
+    ::I18n.without_fallbacks do
+      request(:path=>'/trimmer.js').body.should.equal(@def_value)
+    end
+  end
+
+end
+

data/test/test_data/locales/ca.yml

@@ -0,0 +1,3 @@
+ca:
+  foo:
+    bed: "llit"

data/test/test_data/locales/en.yml

@@ -0,0 +1,3 @@
+en:
+  foo:
+    trimmer: "trimmer"

data/test/test_data/locales/es.yml

@@ -0,0 +1,3 @@
+es:
+  foo:
+    trimmer: "recortadora"

data/test/test_data/templates/foo/bar.haml

@@ -0,0 +1 @@
+%span=I18n.t('foo.trimmer')

data/test/test_data/templates_missing_t/baz/bif.haml

@@ -0,0 +1,2 @@
+%span=I18n.t('foo.trimmer')
+%p=I18n.t('bar.trimmer')

data/test/test_helper.rb

@@ -0,0 +1,54 @@
+require 'i18n'
+require 'test/spec'
+require 'rack/mock'
+require File.dirname(__FILE__) + '/../lib/trimmer'
+
+class Test::Unit::TestCase
+
+  def setup
+    I18n.backend = I18n::Backend::Simple.new
+    I18n.default_locale = :en
+
+    %w(en es).each do |locale|
+      I18n.load_path << [locales_dir + "/#{locale}.yml"]
+    end
+
+    I18n.backend.class.send(:include, I18n::Backend::Fallbacks)
+    # => [:ca, :es, :en]
+    I18n.fallbacks.map(:ca => :es)
+  end
+
+  def teardown
+    I18n.locale = nil
+    I18n.default_locale = :en
+    I18n.load_path = []
+    I18n.available_locales = nil
+    I18n.backend = nil
+  end
+
+  def translations
+    I18n.backend.instance_variable_get(:@translations)
+  end
+
+  def store_translations(*args)
+    data   = args.pop
+    locale = args.pop || :en
+    I18n.backend.store_translations(locale, data)
+  end
+
+  def locales_dir
+    File.dirname(__FILE__) + '/test_data/locales'
+  end
+
+  def templates_dir
+    File.dirname(__FILE__) + '/test_data/templates'
+  end
+
+  def templates_missing_t_dir
+    File.dirname(__FILE__) + '/test_data/templates_missing_t'
+  end
+
+end
+
+
+

data/trimmer.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "trimmer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "trimmer"
+  s.version     = Trimmer::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Pablo Villalba", "Saimon Moore"]
+  s.email       = ["pablo@teambox.com", "saimon@teambox.com"]
+  s.homepage    = "https://github.com/teambox/trimmer"
+  s.summary = %q{Rack endpoint to make templates and i18n translations available in javascript}
+
+  s.rubyforge_project = "trimmer"
+
+  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"]
+  s.add_dependency 'rack', '~> 1.1'
+  s.add_dependency 'i18n', '~> 0.6.0'
+  s.add_dependency 'tilt', '~> 1.3.3'
+  s.add_development_dependency 'test-spec', '~> 0.9.0'
+  s.add_development_dependency 'haml', '~> 3.0.25'
+  s.add_development_dependency 'json', '~> 1.1'
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification 
+name: trimmer
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Pablo Villalba
+- Saimon Moore
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-13 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: tilt
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: test-spec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 9
+        - 0
+        version: 0.9.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 53
+        segments: 
+        - 3
+        - 0
+        - 25
+        version: 3.0.25
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
+  type: :development
+  version_requirements: *id006
+description: 
+email: 
+- pablo@teambox.com
+- saimon@teambox.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- History.md
+- README.md
+- Rakefile
+- lib/trimmer.rb
+- lib/trimmer/controller.rb
+- lib/trimmer/core.rb
+- lib/trimmer/i18n.rb
+- lib/trimmer/version.rb
+- test/spec_trimmer_controller.rb
+- test/test_data/locales/ca.yml
+- test/test_data/locales/en.yml
+- test/test_data/locales/es.yml
+- test/test_data/templates/foo/bar.haml
+- test/test_data/templates_missing_t/baz/bif.haml
+- test/test_helper.rb
+- trimmer.gemspec
+has_rdoc: true
+homepage: https://github.com/teambox/trimmer
+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: trimmer
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rack endpoint to make templates and i18n translations available in javascript
+test_files: 
+- test/spec_trimmer_controller.rb
+- test/test_data/locales/ca.yml
+- test/test_data/locales/en.yml
+- test/test_data/locales/es.yml
+- test/test_data/templates/foo/bar.haml
+- test/test_data/templates_missing_t/baz/bif.haml
+- test/test_helper.rb