remote_i18n 0.1.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,16 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)

data/LICENSE.md

@@ -0,0 +1,21 @@
+Copyright (c) 2010 Julien Guimont
+Copyright (c) 2009 Darcy Laycock
+
+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

@@ -0,0 +1,50 @@
+# Remote I18n #
+
+Remote I18n helps developer export translated messages from a Rails server to a Javascript/HTML client application. More and more we need to use templates in javascript to create new HTML segments, but when you are building an I18n application you need to make sure that those segments contains the right language. This is what this project is for. For now it bundle the Rails translations into different javascript file ready for consumption.
+
+## Getting started
+*For Rails 3 only*
+
+1. Add `gem 'remote_i18n' to your Gemfile
+2. Run `bundle install`
+3. Create a "remote_i18n" in /config/initializers 
+
+Add the following
+
+    RemoteI18n.configure do |config|
+      config.translate :name=>:date, :i18n_path=>"date", :only=>["en", "fr-CA"]
+      config.translate :name=>:errors, :i18n_path=>"errors", :only=>["en", "fr-CA"]
+    end
+
+The configuration can't be simpler
+-  _name_ is the name of the resulting file in /public/javascripts
+-  _i18n_path_ is the path to use in the Rails i18n module
+-  _only_ is to specify languages, by default it is all configured ones
+ 
+The output of this configuration would be:
+
+    - /public/javascripts/date.en.js
+    - /public/javascripts/date.fr-CA.js
+    - /public/javascripts/errors.en.js
+    - /public/javascripts/errors.fr-CA.js
+   
+In Javascript the _T_ object is created to access the translations:
+
+    blank_error = T.errors.message.blank;
+    january = T.date.month_names[1];
+
+## More Details
+
+In development and in test, a rack middleware is loaded and compiles the changes to the translations at each requests. This cannot be done in production, so there is a bundled rake task to generate the javascript files for deployment:
+
+    rake remote_i18n:compile
+    
+I use Jammit to organize my javascript files. I create a Jammit package for each language and use the locale to include it on the page:
+
+    include_javascripts "translations_#{I18n.locale}"
+
+## Copyright ##
+Most of the code is heavily inspired by excellent Barista from Darcy Laycock.
+
+Copyright (c) 2010 Julien Guimont. See LICENSE for details.
+Copyright (c) 2010 Darcy Laycock. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "remote_i18n/version"
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "remote_i18n"
+  gem.homepage = "http://github.com/juggy/remote_i18n"
+  gem.license = "MIT"
+  gem.summary = %Q{I18n for Javascript with Rails}
+  gem.description = %Q{RemoteI18n helps developer export translated messages from a Rails server to a Javascript/HTML client application. More and more we need to use templates in javascript to create new HTML segments, but when you are building an I18n application you need to make sure that those segments contains the right language. This is what this project is for. For now it bundle the Rails translations into different javascript file ready for consumption.}
+  gem.version = RemoteI18n::Version::STRING
+  gem.email = "julien@porkepic.com"
+  gem.authors = ["Julien Guimont"]
+end
+Jeweler::RubygemsDotOrgTasks.new

data/lib/remote_i18n/filter.rb

@@ -0,0 +1,19 @@
+module RemoteI18n
+  class Filter
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
+      RemoteI18n.debug 'Compiling all translations'
+      RemoteI18n.compile_all!
+      @app.call env
+    end
+
+  end
+end

data/lib/remote_i18n/integration/rails3.rb

@@ -0,0 +1,17 @@
+module RemoteI18n
+  module Integration
+    module Rails3    
+      class Railtie < Rails::Railtie
+        
+        rake_tasks do
+          load RemoteI18n.library_root.join('remote_i18n/tasks/remote_i18n.rake').to_s
+        end
+        
+        initializer 'remote_i18n.wrap_filter' do
+          config.app_middleware.use RemoteI18n::Filter if RemoteI18n.add_filter?
+        end
+        
+      end
+    end
+  end
+end

data/lib/remote_i18n/integration.rb

@@ -0,0 +1,25 @@
+module RemoteI18n
+  module Integration
+    
+    autoload :Rails3,  'remote_i18n/integration/rails3'
+    
+    def self.setup
+      setup_rails   if defined?(Rails)
+      setup_sinatra if defined?(::Sinatra)
+    end
+    
+    def self.setup_rails
+      case Rails::VERSION::MAJOR
+      when 3
+        Rails3
+      when 2
+        throw "Not supported yet"
+      end
+    end
+    
+    def self.setup_sinatra
+      throw "Not supported yet"
+    end
+    
+  end
+end

data/lib/remote_i18n/tasks/remote_i18n.rake

@@ -0,0 +1,8 @@
+namespace :remote_i18n do
+
+  desc "Compiles translations to javascripts into public/javascripts"
+  task :compile => :environment do
+    RemoteI18n.compile_all!
+  end
+  
+end

data/lib/remote_i18n/version.rb

@@ -0,0 +1,8 @@
+module RemoteI18n
+  module Version
+    MAJOR  = 0
+    MINOR  = 1
+    PATCH  = 0
+    STRING = [MAJOR, MINOR, PATCH].join(".")
+  end
+end

data/lib/remote_i18n.rb

@@ -0,0 +1,126 @@
+require 'i18n'
+
+module RemoteI18n
+  autoload :Integration, 'remote_i18n/integration'
+  autoload :Filter,      'remote_i18n/filter'
+  
+  class << self
+    
+    def configure
+      yield self if block_given?
+    end
+    
+    def library_root
+      @library_root ||= Pathname(__FILE__).dirname
+    end
+    
+    def default_for_add_filter
+      local_env?
+    end
+    
+    def local_env?
+      %w(test development).include? RemoteI18n.env
+    end
+    
+    def env
+      @env ||= default_for_env
+    end
+
+    def env=(value)
+      @env = value.to_s.strip
+      @env = nil if @env == ''
+    end
+    
+    def default_for_env
+      return Rails.env.to_s if defined?(Rails.env)
+      ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+    end
+    
+    def add_filter?
+      local_env?
+    end
+    
+    def default_for_logger
+      if defined?(Rails.logger)
+        Rails.logger
+      else
+        require 'logger'
+        Logger.new(STDOUT)
+      end
+    end
+    
+    def logger
+      @logger ||= default_for_logger
+    end
+
+    def logger=(value)
+      @logger = value
+    end
+    
+    def debug(message)
+      logger.debug "[RemoteI18n] #{message}"
+    end
+    
+    def app_root
+      @app_root ||= default_for_app_root
+    end
+
+    def app_root=(value)
+      @app_root = value.nil? ? nil : Pathname(value.to_s)
+    end
+    
+    def output_root
+      @output_root ||= app_root.join("public", "javascripts")
+    end
+
+    def output_root=(value)
+      @output_root = value.nil? ? nil : Pathname(value.to_s)
+    end
+    
+    def default_for_app_root
+      if defined?(Rails.root)
+        Rails.root
+      else
+        Pathname(Dir.pwd)
+      end
+    end
+    
+    def translate(opts)
+      translations << opts
+    end
+    
+    def translations
+      @translations ||= []
+    end
+    
+    def compile_all!
+      I18n.backend.send("init_translations")
+      languages = I18n.backend.send("translations")
+      default_locale = I18n.locale
+      languages.each_key do |locale|
+        I18n.locale = locale
+        translations.each do |t|
+          name = t[:name]
+          i18n_path = t[:i18n_path]
+          only = t[:only]
+          
+          next if !(only.include? locale.to_s)
+          
+          output = I18n.translate(i18n_path)
+          path = output_root.join("#{name}.#{locale}.js")
+          
+          compiled_output = "if(this.T === null || this.T == undefined)this.T = {};this.T.#{name} = #{output.to_json}"
+          
+          FileUtils.mkdir_p File.dirname(path)
+          File.open(path, "w+") { |f| f.write compiled_output }
+        end
+      end
+      I18n.locale = default_locale
+    end
+    
+  end
+  
+  # Setup integration by default.
+  Integration.setup
+  
+end

data/remote_i18n.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{remote_i18n}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Julien Guimont"]
+  s.date = %q{2011-01-14}
+  s.description = %q{RemoteI18n helps developer export translated messages from a Rails server to a Javascript/HTML client application. More and more we need to use templates in javascript to create new HTML segments, but when you are building an I18n application you need to make sure that those segments contains the right language. This is what this project is for. For now it bundle the Rails translations into different javascript file ready for consumption.}
+  s.email = %q{julien@porkepic.com}
+  s.extra_rdoc_files = [
+    "LICENSE.md",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.md",
+    "README.md",
+    "Rakefile",
+    "lib/remote_i18n.rb",
+    "lib/remote_i18n/filter.rb",
+    "lib/remote_i18n/integration.rb",
+    "lib/remote_i18n/integration/rails3.rb",
+    "lib/remote_i18n/tasks/remote_i18n.rake",
+    "lib/remote_i18n/version.rb",
+    "remote_i18n.gemspec"
+  ]
+  s.homepage = %q{http://github.com/juggy/remote_i18n}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{I18n for Javascript with Rails}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+  end
+end
+

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: remote_i18n
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Julien Guimont
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-14 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id002
+description: RemoteI18n helps developer export translated messages from a Rails server to a Javascript/HTML client application. More and more we need to use templates in javascript to create new HTML segments, but when you are building an I18n application you need to make sure that those segments contains the right language. This is what this project is for. For now it bundle the Rails translations into different javascript file ready for consumption.
+email: julien@porkepic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.md
+- README.md
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/remote_i18n.rb
+- lib/remote_i18n/filter.rb
+- lib/remote_i18n/integration.rb
+- lib/remote_i18n/integration/rails3.rb
+- lib/remote_i18n/tasks/remote_i18n.rake
+- lib/remote_i18n/version.rb
+- remote_i18n.gemspec
+has_rdoc: true
+homepage: http://github.com/juggy/remote_i18n
+licenses: 
+- MIT
+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.3.7
+signing_key: 
+specification_version: 3
+summary: I18n for Javascript with Rails
+test_files: []
+