javascript_i18n 0.2.2

data/.document

@@ -0,0 +1,7 @@
+README.rdoc
+lib/**/*.rb
+generators/javascript_i18n/*.rb
+generators/javascript_i18n/templates/javascripts/*.js
+generators/javascript_i18n/templates/tasks/*.rake
+generators/javascript_i18n/templates/initializers/*.rb
+LICENSE

data/.gitignore

@@ -0,0 +1,7 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+*.gem
+*.gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jakub Kuźma
+
+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.rdoc

@@ -0,0 +1,68 @@
+= javascript_i18n
+
+Dead simple JavaScript i18n tool. It contains JavaScript builder to
+generate static files with translations in /public/javascripts/i18n
+directory. Each language is stored in separate file, so if we have
+e.g. 10 languages in our application, client needs to download only
+the language he uses (10 times smaller than in Babilu). Because of
+that fact we don't need to set any cookies to tell the client which
+locale he uses. To use the gem put the following line into your
+environment.rb:
+
+  config.gem "qoobaa-javascript_i18n", :lib => "javascript_i18n"
+
+and run:
+
+  gem sources -a http://gems.github.com # (you only have to do this once)
+  sudo rake gems:install
+
+After installing the gem, use the generator:
+
+  ruby script/generate javascript_i18n
+
+That's it! If you want to build javascript files based on current
+translation files use the rake task:
+
+  rake js:i18n:build
+
+To include translations, put the code below in your
+layout file (or somewhere in the view):
+
+  <%= javascript_include_tag "i18n/#{I18n.locale}" %>
+
+If you often change the translations files, you may generate files on
+every request in development mode, putting the code in your
+/app/controllers/application_controller.rb:
+
+  before_filter :update_javascript_i18n
+
+  protected
+
+  def update_javascript_i18n
+    JavascriptI18n.update unless Rails.env.production?
+  end
+
+You can use I18n.t function in your JavaScript files, it's similar to
+ActiveSupport I18n.t:
+
+  I18n.t("hello");
+  // "Hello World!"
+  I18n.t("foo.bar")
+  // "baz"
+  I18n.t("non.existing")
+  // null
+  I18n.t("non.existing", { defaultValue: "foo" })
+  // "foo"
+  I18n.t("bar", { count: 1 })
+  // "foo"
+  I18n.t("bar", { count: 2 })
+  // "foos"
+
+Current locale string can be retrieved using I18n.locale property:
+
+  I18n.locale
+  // "en"
+
+== Copyright
+
+Copyright (c) 2009 Jakub Kuźma. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "javascript_i18n"
+    gem.summary = %Q{Dead simple JavaScript i18n}
+    gem.email = "qoobaa@gmail.com"
+    gem.homepage = "http://github.com/qoobaa/javascript_i18n"
+    gem.authors = ["Jakub Kuźma"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "javascript_i18n #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.2.2

data/generators/javascript_i18n/javascript_i18n_generator.rb

@@ -0,0 +1,24 @@
+require 'rbconfig'
+
+class JavascriptI18nGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.directory "public/javascripts"
+      m.directory "public/javascripts/i18n"
+      m.file      "javascripts/i18n.js", "public/javascripts/i18n/i18n.js"
+
+      m.directory "config"
+      m.directory "config/initializers"
+      m.file      "initializers/javascript_i18n.rb", "config/initializers/javascript_i18n.rb"
+
+      m.directory "lib/tasks"
+      m.file      "tasks/javascript_i18n.rake", "lib/tasks/javascript_i18n.rake"
+    end
+  end
+
+  protected
+
+  def banner
+    "Usage: #{$0} javascript_i18n"
+  end
+end

data/generators/javascript_i18n/templates/initializers/javascript_i18n.rb

@@ -0,0 +1,6 @@
+JavascriptI18n.configuration do |config|
+  config.root_path = RAILS_ROOT
+  config.lib_dir = "public/javascripts/i18n"
+  config.output_dir = "public/javascripts/i18n"
+  config.output_style = :merged
+end

data/generators/javascript_i18n/templates/javascripts/i18n.js

@@ -0,0 +1,88 @@
+// I18n is slightly modified version of babilu.js from Tore Darell
+
+var I18n = I18n || (function() {
+    // Replace {{foo}} with obj.foo
+    function interpolate(string, object) {
+        return string.replace(/\{\{([^}]+)\}\}/g, function() {
+            return object[arguments[1]] || arguments[0];
+        });
+    };
+
+    // Split "foo.bar" to ["foo", "bar"] if key is a string
+    function keyToArray(key) {
+        if(!key) {
+            return [];
+        }
+        if(typeof key != "string") {
+            return key;
+        }
+        return key.split('.');
+    };
+
+    // Looks up a translation using an array of strings where the last
+    // is the key and any string before that define the scope. The
+    // current locale is always prepended and does not need to be
+    // provided. The second parameter is an array of strings used as
+    // defaults if the key can not be found. If a key starts with ":"
+    // it is used as a key for lookup.  This method does not perform
+    // pluralization or interpolation.
+    function lookup(keys, defaults) {
+        var i = 0, value = I18n.translations;
+        defaults = (typeof defaults === "string") ? [defaults] : (defaults || []);
+        while(keys[i]) {
+            value = value && value[keys[i]];
+            i++;
+        }
+        if(value) {
+            return value;
+        } else {
+            if(defaults.length === 0) {
+                return null;
+            } else if (defaults[0].substr(0,1) === ':') {
+                return lookup(keys.slice(0, keys.length - 1).concat(keyToArray(defaults[0].substr(1))), defaults.slice(1));
+            } else {
+                return defaults[0];
+            }
+        }
+    };
+
+    // Returns other when 0 given
+    function pluralize(value, count) {
+        if(count === undefined) return value;
+        return count === 1 ? value.one : value.other;
+    };
+
+    // Works mostly the same as the Ruby equivalent, except there are
+    // no symbols in JavaScript, so keys are always strings. The only
+    // time this makes a difference is when differentiating between
+    // keys and values in the defaultValue option. Strings starting
+    // with ":" will be considered to be keys and used for lookup,
+    // while other strings are returned as-is.
+    function translate(key, options) {
+        if(typeof key != "string") {
+            // Bulk lookup
+            var a = [], i;
+            for(i = 0; i < key.length; i++) {
+                a.push(translate(key[i], options));
+            }
+            return a;
+        } else {
+            options = options || {};
+            options.defaultValue = options.defaultValue || null;
+            key = keyToArray(options.scope).concat(keyToArray(key));
+            var value = lookup(key, options.defaultValue);
+            if(typeof value !== "string" && value) {
+                value = pluralize(value, options.count);
+            }
+            if(typeof value === "string") {
+                value = interpolate(value, options);
+            }
+            return value;
+        }
+    }
+
+    return {
+        translate: translate,
+        t: translate
+    };
+})();

data/generators/javascript_i18n/templates/tasks/javascript_i18n.rake

@@ -0,0 +1,8 @@
+namespace :js do
+  namespace :i18n do
+    desc "Build I18n JavaScript files using current translations"
+    task :build => :environment do
+      JavascriptI18n.update!
+    end
+  end
+end

data/lib/javascript_i18n.rb

@@ -0,0 +1,3 @@
+require "javascript_i18n/configuration"
+require "javascript_i18n/builder"
+require "javascript_i18n/updater"

data/lib/javascript_i18n/builder.rb

@@ -0,0 +1,26 @@
+module JavascriptI18n
+  class Builder
+    attr_accessor :output_path, :lib_path, :output_style
+
+    def initialize(lib_path, output_path, output_style = :merged)
+      self.lib_path = lib_path
+      self.output_path = output_path
+      self.output_style = output_style
+      I18n.backend.send(:init_translations)
+    end
+
+    def run
+      lib = File.read(File.join(lib_path, "i18n.js")) if output_style == :merged
+      I18n.backend.send(:translations).each do |key, value|
+        File.open(File.join(output_path, "#{key}.js"), "w") do |file|
+          if output_style == :merged
+            file.puts(lib)
+            file.puts("\n")
+          end
+          file.puts("I18n.locale = I18n.locale || \"#{key}\";")
+          file.puts("I18n.translations = I18n.translations || #{value.to_json};")
+        end
+      end
+    end
+  end
+end

data/lib/javascript_i18n/configuration.rb

@@ -0,0 +1,30 @@
+require 'singleton'
+
+module JavascriptI18n
+  class Configuration
+    include Singleton
+
+    ATTRIBUTES = [:root_path, :output_dir, :lib_dir, :output_style]
+
+    attr_accessor *ATTRIBUTES
+
+    def output_path
+      if root_path and output_dir
+        File.join(root_path, output_dir)
+      end
+    end
+
+    def lib_path
+      if root_path and lib_dir
+        File.join(root_path, lib_dir)
+      end
+    end
+  end
+
+  def self.configuration
+    if block_given?
+      yield Configuration.instance
+    end
+    Configuration.instance
+  end
+end

data/lib/javascript_i18n/updater.rb

@@ -0,0 +1,33 @@
+require 'singleton'
+
+module JavascriptI18n
+  class Updater
+    include Singleton
+
+    attr_accessor :last_update_time
+
+    def initialize
+      # force first update
+      self.last_update_time = DateTime.parse("1970-01-01 00:00:00")
+    end
+
+    def most_recent_update_time
+      I18n.load_path.map { |translation_file| File.stat(translation_file).mtime }.max
+    end
+
+    def should_update?
+      most_recent_update_time > last_update_time
+    end
+  end
+
+  def self.update
+    update! if Updater.instance.should_update?
+  end
+
+  def self.update!
+    time = Updater.instance.most_recent_update_time
+    builder = Builder.new(configuration.lib_path, configuration.output_path, configuration.output_style)
+    builder.run
+    Updater.instance.last_update_time = time
+  end
+end

data/test/javascript_i18n_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class JavascriptI18nTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'javascript_i18n'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: javascript_i18n
+version: !ruby/object:Gem::Version 
+  version: 0.2.2
+platform: ruby
+authors: 
+- "Jakub Ku\xC5\xBAma"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-20 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: qoobaa@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- generators/javascript_i18n/javascript_i18n_generator.rb
+- generators/javascript_i18n/templates/initializers/javascript_i18n.rb
+- generators/javascript_i18n/templates/javascripts/i18n.js
+- generators/javascript_i18n/templates/tasks/javascript_i18n.rake
+- lib/javascript_i18n.rb
+- lib/javascript_i18n/builder.rb
+- lib/javascript_i18n/configuration.rb
+- lib/javascript_i18n/updater.rb
+- test/javascript_i18n_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/qoobaa/javascript_i18n
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Dead simple JavaScript i18n
+test_files: 
+- test/javascript_i18n_test.rb
+- test/test_helper.rb