i18n-js 2.1.2 → 3.0.0.rc1

data/Gemfile.lock

@@ -1,51 +1,43 @@
 PATH
   remote: .
   specs:
-    i18n-js (2.1.2)
+    i18n-js (3.0.0.rc1)
       i18n
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.1.1)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
       multi_json (~> 1.0)
-    coderay (0.9.8)
+    awesome_print (1.0.2)
+    coderay (1.0.6)
     diff-lcs (1.1.3)
-    fakeweb (1.3.0)
     i18n (0.6.0)
-    method_source (0.6.7)
-      ruby_parser (>= 2.3.1)
-    multi_json (1.0.3)
-    notifier (0.1.4)
-    pry (0.9.7.4)
-      coderay (~> 0.9.8)
-      method_source (~> 0.6.7)
-      ruby_parser (>= 2.3.1)
-      slop (~> 2.1.0)
+    method_source (0.7.1)
+    multi_json (1.3.2)
+    pry (0.9.9.3)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
     rake (0.9.2.2)
-    rspec (2.7.0)
-      rspec-core (~> 2.7.0)
-      rspec-expectations (~> 2.7.0)
-      rspec-mocks (~> 2.7.0)
-    rspec-core (2.7.1)
-    rspec-expectations (2.7.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.7.0)
-    ruby_parser (2.3.1)
-      sexp_processor (~> 3.0)
-    sexp_processor (3.0.8)
-    slop (2.1.0)
-    spec-js (0.1.0.beta.3)
-      notifier
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    slop (2.4.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (>= 3.0.0)
-  fakeweb
+  activesupport
+  awesome_print
   i18n-js!
   pry
   rake
-  rspec (~> 2.6)
-  spec-js (~> 0.1.0.beta.0)
+  rspec

data/README.md

@@ -0,0 +1,318 @@
+# I18n.js
+
+It's a small library to provide the Rails I18n translations on the Javascript.
+
+Features:
+
+- Pluralization
+- Date/Time localization
+- Number localization
+- Locale fallback
+- Asset pipeline support
+- Lots more! :)
+
+## Usage
+
+### Installation
+
+#### Rails app
+
+Add the gem to your Gemfile.
+
+    source :rubygems
+    gem "rails", "3.2.3"
+    gem "i18n-js"
+
+If you're using the [asset pipeline](http://guides.rubyonrails.org/asset_pipeline.html),
+then you must add the following line to your `app/assets/javascripts/application.js`.
+
+    //= require i18n/translations
+
+If you're not using the asset pipeline, download the JavaScript file at
+<https://github.com/fnando/i18n-js/tree/master/lib/i18n.js> and load it on your page.
+Also load the `translations.js` file.
+
+    <%= javascript_include_tag "i18n", "translations" %>
+
+This `translations.js` file can be automatically generated by the `I18n::JS::Middleware`.
+Just add it to your `config/application.rb` file.
+
+    config.middleware.use I18n::JS::Middleware
+
+If you can't generate this file in production (Heroku anyone?), you can "precompile"
+it by running the following command. Move the middleware line to your
+`config/environments/development.rb` file and run the following command before
+deploying.
+
+    $ rails runner I18n::JS.export
+
+This will export all translation files, including the custom scopes you may have
+defined on `config/i18n-js.yml`.
+
+#### Vanilla JavaScript
+
+Just add the `i18n.js` file to your page. You'll have to build the translations object
+by hand or using your favorite programming language. More info below.
+
+### Setting up
+
+You **don't** need to set up a thing. The default settings will work just okay. But if you want to split translations into several files or specify specific contexts, you can follow the rest of this setting up section.
+
+Set your locale is easy as
+
+    I18n.defaultLocale = "pt-BR";
+    I18n.locale = "pt-BR";
+    I18n.currentLocale();
+    // pt-BR
+
+In practice, you'll have something like the following in your `application.html.erb`:
+
+    <script type="text/javascript">
+      I18n.defaultLocale = "<%= I18n.default_locale %>";
+      I18n.locale = "<%= I18n.locale %>";
+    </script>
+
+You can use translate your messages:
+
+    I18n.t("some.scoped.translation");
+    // or translate with explicite setting of locale
+    I18n.t("some.scoped.translation", {locale: "fr"});
+
+You can also interpolate values:
+
+    I18n.t("hello", {name: "John Doe"});
+
+You can set default values for missing scopes:
+
+    // simple translation
+    I18n.t("some.missing.scope", {defaultValue: "A default message"});
+
+    // with interpolation
+    I18n.t("noun", {defaultValue: "I'm a {{noun}}", noun: "Mac"});
+
+Translation fallback can be enabled by enabling the `I18n.fallbacks` option:
+
+    <script type="text/javascript">
+      I18n.fallbacks = true;
+    </script>
+
+By default missing translations will first be looked for in less
+specific versions of the requested locale and if that fails by taking
+them from your `I18n.defaultLocale`.
+
+    // if I18n.defaultLocale = "en" and translation doesn't exist
+    // for I18n.locale = "de-DE" this key will be taken from "de" locale scope
+    // or, if that also doesn't exist, from "en" locale scope
+    I18n.t("some.missing.scope");
+
+Custom fallback rules can also be specified for a particular language. There
+are three different ways of doing it so:
+
+    I18n.locales.no = ["nb", "en"];
+    I18n.locales.no = "nb";
+    I18n.locales.no = function(locale){ return ["nb"]; };
+
+Pluralization is possible as well and by default provides english rules:
+
+    I18n.t("inbox.counting", {count: 10}); // You have 10 messages
+
+The sample above expects the following translation:
+
+    en:
+      inbox:
+        counting:
+          one: You have 1 new message
+          other: You have {{count}} new messages
+          zero: You have no messages
+
+**NOTE:** Rais I18n recognizes the `zero` option.
+
+If you need special rules just define them for your language, for example Russian, just add a new pluralizer:
+
+    I18n.pluralization["ru"] = function (count) {
+      return count % 10 == 1 && count % 100 != 11 ? "one" : [2, 3, 4].indexOf(count % 10) >= 0 && [12, 13, 14].indexOf(count % 100) < 0 ? "few" : count % 10 == 0 || [5, 6, 7, 8, 9].indexOf(count % 10) >= 0 || [11, 12, 13, 14].indexOf(count % 100) >= 0 ? "many" : "other";
+    };
+
+You can find all rules on <http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html>.
+
+If you're using the same scope over and over again, you may use the `scope` option.
+
+    var options = {scope: "activerecord.attributes.user"};
+
+    I18n.t("name", options);
+    I18n.t("email", options);
+    I18n.t("username", options);
+
+You also provide an array as scope.
+
+    // use the greetings.hello scope
+    I18n.t(["greetings", "hello"]);
+
+#### Number formatting
+
+Similar to Rails helpers, you have localized number and currency formatting.
+
+    I18n.l("currency", 1990.99);
+    // $1,990.99
+
+    I18n.l("number", 1990.99);
+    // 1,990.99
+
+    I18n.l("percentage", 123.45);
+    // 123.450%
+
+To have more control over number formatting, you can use the
+`I18n.toNumber`, `I18n.toPercentage`, `I18n.toCurrency` and `I18n.toHumanSize`
+functions.
+
+    I18n.toNumber(1000);     // 1,000.000
+    I18n.toCurrency(1000);   // $1,000.00
+    I18n.toPercentage(100);  // 100.000%
+
+The `toNumber` and `toPercentage` functions accept the following options:
+
+- `precision`: defaults to `3`
+- `separator`: defaults to `.`
+- `delimiter`: defaults to `,`
+- `strip_insignificant_zeros`: defaults to `false`
+
+See some number formatting examples:
+
+    I18n.toNumber(1000, {precision: 0});                   // 1,000
+    I18n.toNumber(1000, {delimiter: ".", separator: ","}); // 1.000,000
+    I18n.toNumber(1000, {delimiter: ".", precision: 0});   // 1.000
+
+The `toCurrency` function accepts the following options:
+
+- `precision`: sets the level of precision
+- `separator`: sets the separator between the units
+- `delimiter`: sets the thousands delimiter
+- `format`: sets the format of the output string
+- `unit`: sets the denomination of the currency
+- `strip_insignificant_zeros`: defaults to `false`
+
+You can provide only the options you want to override:
+
+    I18n.toCurrency(1000, {precision: 0}); // $1,000
+
+The `toHumanSize` function accepts the following options:
+
+- `precision`: defaults to `1`
+- `separator`: defaults to `.`
+- `delimiter`: defaults to `""`
+- `strip_insignificant_zeros`: defaults to `false`
+- `format`: defaults to `%n%u`
+
+<!---->
+
+    I18n.toHumanSize(1234); // 1KB
+    I18n.toHumanSize(1234 * 1024); // 1MB
+
+#### Date formatting
+
+    // accepted formats
+    I18n.l("date.formats.short", "2009-09-18");           // yyyy-mm-dd
+    I18n.l("time.formats.short", "2009-09-18 23:12:43");  // yyyy-mm-dd hh:mm:ss
+    I18n.l("time.formats.short", "2009-11-09T18:10:34");  // JSON format with local Timezone (part of ISO-8601)
+    I18n.l("time.formats.short", "2009-11-09T18:10:34Z"); // JSON format in UTC (part of ISO-8601)
+    I18n.l("date.formats.short", 1251862029000);          // Epoch time
+    I18n.l("date.formats.short", "09/18/2009");           // mm/dd/yyyy
+    I18n.l("date.formats.short", (new Date()));           // Date object
+
+If you prefer, you can use the `I18n.strftime` function to format dates.
+
+    var date = new Date();
+    I18n.strftime(date, "%d/%m/%Y");
+
+The accepted formats are:
+
+    %a  - The abbreviated weekday name (Sun)
+    %A  - The full weekday name (Sunday)
+    %b  - The abbreviated month name (Jan)
+    %B  - The full month name (January)
+    %c  - The preferred local date and time representation
+    %d  - Day of the month (01..31)
+    %-d - Day of the month (1..31)
+    %H  - Hour of the day, 24-hour clock (00..23)
+    %-H - Hour of the day, 24-hour clock (0..23)
+    %I  - Hour of the day, 12-hour clock (01..12)
+    %-I - Hour of the day, 12-hour clock (1..12)
+    %m  - Month of the year (01..12)
+    %-m - Month of the year (1..12)
+    %M  - Minute of the hour (00..59)
+    %-M - Minute of the hour (0..59)
+    %p  - Meridian indicator (AM  or  PM)
+    %S  - Second of the minute (00..60)
+    %-S - Second of the minute (0..60)
+    %w  - Day of the week (Sunday is 0, 0..6)
+    %y  - Year without a century (00..99)
+    %-y - Year without a century (0..99)
+    %Y  - Year with century
+    %z  - Timezone offset (+0545)
+
+Check out `spec/*.spec.js` files for more examples!
+
+## Using I18n.js with other languages (Python, PHP, ...)
+
+The JavaScript library is language agnostic; so you can use it with PHP, Python, [you favorite language here].
+The only requirement is that you need to set the `translations` attribute like following:
+
+    I18n.translations = {};
+
+    I18n.translations["en"] = {
+      message: "Some special message for you"
+    }
+
+    I18n.translations["pt-BR"] = {
+      message: "Uma mensagem especial para você"
+    }
+
+## Maintainer
+
+- Nando Vieira - <http://nandovieira.com.br>
+
+## Contributing
+
+Once you've made your great commits:
+
+1. [Fork](http://help.github.com/forking/) I18n.js
+2. Create a topic branch - `git checkout -b my_branch`
+3. Push to your branch - `git push origin my_branch`
+4. [Create an Issue](http://github.com/fnando/i18n-js/issues) with a link to your branch
+5. That's it!
+
+Please respect the indentation rules and code style.
+And use 2 spaces, not tabs. And don't touch the versioning thing.
+
+## Running tests
+
+You can run I18n tests using Node.js or your browser.
+
+To use Node.js, execute the following command from the lib's root directory:
+
+    $ ./node_modules/.bin/jasmine-node spec/js
+
+To run using your browser, just open the `spec/js/specs.html` file.
+
+## License
+
+(The MIT License)
+
+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/Rakefile

@@ -1,13 +1,13 @@
 require "bundler"
 Bundler::GemHelper.install_tasks
 
-require "spec_js/rake_task"
-SpecJs::RakeTask.new do |t|
-  t.env_js = false
-end
-
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:"spec:ruby")
 
+desc "Run JavaScript specs"
+task "spec:js" do
+  system "jasmine-node", "spec/js"
+end
+
 desc "Run all specs"
-task :spec => [:"spec:ruby", :"spec:js"]
+task :spec => ["spec:ruby", "spec:js"]

data/app/assets/javascripts/i18n/translations.js.erb

@@ -0,0 +1,3 @@
+//= require i18n
+//= require_self
+I18n.translations = <%= I18n::JS.filtered_translations.to_json %>;

data/i18n-js.gemspec

@@ -1,10 +1,10 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "i18n-js/version"
+require "i18n/js/version"
 
 Gem::Specification.new do |s|
   s.name        = "i18n-js"
-  s.version     = SimplesIdeias::I18n::Version::STRING
+  s.version     = I18n::JS::Version::STRING
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Nando Vieira"]
   s.email       = ["fnando.vieira@gmail.com"]
@@ -18,10 +18,9 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "i18n"
-  s.add_development_dependency "fakeweb"
-  s.add_development_dependency "activesupport", ">= 3.0.0"
-  s.add_development_dependency "rspec", "~> 2.6"
-  s.add_development_dependency "spec-js", "~> 0.1.0.beta.0"
+  s.add_development_dependency "activesupport"
+  s.add_development_dependency "rspec"
   s.add_development_dependency "rake"
   s.add_development_dependency "pry"
+  s.add_development_dependency "awesome_print"
 end

data/lib/i18n-js.rb

@@ -1,177 +1 @@
-require "FileUtils" unless defined?(FileUtils)
-
-module SimplesIdeias
-  module I18n
-    extend self
-
-    require "i18n-js/railtie" if Rails.version >= "3.0"
-    require "i18n-js/engine" if Rails.version >= "3.1"
-    require "i18n-js/middleware"
-
-    # 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 }
-
-    # Under rails 3.1.1 and higher, perform a check to ensure that the
-    # full environment will be available during asset compilation.
-    # This is required to ensure I18n is loaded.
-    def assert_usable_configuration!
-      @usable_configuration ||= Rails.version >= "3.1.1" &&
-        Rails.configuration.assets.initialize_on_precompile ||
-        raise("Cannot precompile i18n-js translations unless environment is initialized. Please set config.assets.initialize_on_precompile to true.")
-    end
-
-    def has_asset_pipeline?
-      Rails.configuration.respond_to?(:assets) && Rails.configuration.assets.enabled
-    end
-
-    def config_file
-      Rails.root.join("config/i18n-js.yml")
-    end
-
-    def export_dir
-      if has_asset_pipeline?
-        "app/assets/javascripts/i18n"
-      else
-        "public/javascripts"
-      end
-    end
-
-    def javascript_file
-      Rails.root.join(export_dir, "i18n.js")
-    end
-
-    # Export translations to JavaScript, considering settings
-    # from configuration file
-    def export!
-      translation_segments.each do |filename, translations|
-        save(translations, filename)
-      end
-    end
-
-    def segments_per_locale(pattern,scope)
-      ::I18n.available_locales.each_with_object({}) do |locale,segments|
-        result = scoped_translations("#{locale}.#{scope}")
-        unless result.empty?
-          segment_name = ::I18n.interpolate(pattern,{:locale => locale})
-          segments[segment_name] = result
-        end
-      end
-    end
-
-    def segment_for_scope(scope)
-      if scope == "*"
-        translations
-      else
-        scoped_translations(scope)
-      end
-    end
-
-    def configured_segments
-      config[:translations].each_with_object({}) do |options,segments|
-        options.reverse_merge!(:only => "*")
-        if options[:file] =~ ::I18n::INTERPOLATION_PATTERN
-          segments.merge!(segments_per_locale(options[:file],options[:only]))
-        else
-          result = segment_for_scope(options[:only])
-          segments[options[:file]] = result unless result.empty?
-        end
-      end
-    end
-
-    def translation_segments
-      if config? && config[:translations]
-        configured_segments
-      else
-        {"#{export_dir}/translations.js" => translations}
-      end
-    end
-
-    # Load configuration file for partial exporting and
-    # custom output directory
-    def config
-      if config?
-        (YAML.load_file(config_file) || {}).with_indifferent_access
-      else
-        {}
-      end
-    end
-
-    # Check if configuration file exist
-    def config?
-      File.file? config_file
-    end
-
-    # Copy configuration and JavaScript library files to
-    # <tt>config/i18n-js.yml</tt> and <tt>public/javascripts/i18n.js</tt>.
-    def setup!
-      FileUtils.cp(File.dirname(__FILE__) + "/../vendor/assets/javascripts/i18n.js", javascript_file) unless Rails.version >= "3.1"
-      FileUtils.cp(File.dirname(__FILE__) + "/../config/i18n-js.yml", config_file) unless config?
-    end
-
-    # Retrieve an updated JavaScript library from Github.
-    def update!
-      require "open-uri"
-      contents = open("https://raw.github.com/fnando/i18n-js/master/vendor/assets/javascripts/i18n.js").read
-      File.open(javascript_file, "w+") {|f| f << contents}
-    end
-
-    # Convert translations to JSON string and save file.
-    def save(translations, file)
-      file = Rails.root.join(file)
-      FileUtils.mkdir_p File.dirname(file)
-
-      File.open(file, "w+") do |f|
-        f << %(var I18n = I18n || {};\n)
-        f << %(I18n.translations = );
-        f << translations.to_json
-        f << %(;)
-      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
-      ::I18n.backend.instance_eval do
-        init_translations unless initialized?
-        translations
-      end
-    end
-
-    def deep_merge(target, hash) # :nodoc:
-      target.merge(hash, &MERGER)
-    end
-
-    def deep_merge!(target, hash) # :nodoc:
-      target.merge!(hash, &MERGER)
-    end
-  end
-end
-
+require "i18n/js"