i18n-js 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ddbdc40f7c45b3d6f6efd89f7e38ce602e06309280cf4b23a0c66fbbb465a6f
-  data.tar.gz: 820b05a44bcff8eb060d53a007b9d61342bfaf9d49a1286c69f9dfe2d6cf60dd
+  metadata.gz: d31e5a96a37e60b0fddf00af9f9bad30a93b66adde3d85e3ad9b9b2771c31bdc
+  data.tar.gz: e615279399a220d76c6678d63e797b2abd5b843ae92078fab95b1bfc220b2b16
 SHA512:
-  metadata.gz: 2b9ff1a4f87ba0d8e69e0b2719a2a32ae605a96953a76e443052f7a622b6735aa5e5c0c1a7b3af50e98558c3ab9e1d04d7a32d67c5acd4cb328cd99f10092531
-  data.tar.gz: 76d742dd79d8af3e6d689487096efe318cd7e4eabd3b2c8c67157b90357ca8eeea106c820d3ef832ec802daefdb28e6a7081c14d9a66128c0bf3bb8fcdb031cd
+  metadata.gz: f43b695fba0788ca02c5a36776b1f197895cc639640f4fc96a1bb5a8cd236229991f69ab83c08e1a2d0163cc77f68832ba45b34c0f61903b28b76305e590ff94
+  data.tar.gz: 387b2be62ae991d415c9c599cf9b56c4162654bbb2ee5cd5e11b8b264f6d79f2f14b007d16051c4a9d1c5a0b50d15f8f94cbe2b9dea2623a9daf1fe6b92c67bf

data/.gitignore

@@ -2,5 +2,6 @@ pkg
 node_modules
 Gemfile.lock
 .idea/
+coverage/
 gemfiles/*.gemfile.lock
 gemfiles/.bundle

data/.travis.yml

@@ -8,13 +8,11 @@ cache:
   directories:
   - node_modules
 rvm:
-  - 2.1.10
-  - 2.2.8
-  # Since the Travis Build Env does not recognize `2.3` alias yet
-  # We need to specify the version precisely
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
   - ruby-head
 before_install:
 # Need to install something extra to test JS
@@ -23,11 +21,10 @@ before_install:
 # https://github.com/travis-ci/travis-ci/issues/8978#issuecomment-354036443
 - gem update --system
 gemfile:
-  - gemfiles/i18n_0_6.gemfile
-  - gemfiles/i18n_0_7.gemfile
   - gemfiles/i18n_0_8.gemfile
   - gemfiles/i18n_0_9.gemfile
   - gemfiles/i18n_1_0.gemfile
+  - gemfiles/i18n_1_1.gemfile
 matrix:
   fast_finish: true
   allow_failures:

data/Appraisals

@@ -1,12 +1,4 @@
 
-appraise "i18n_0_6" do
-  gem "i18n", "~> 0.6.0", ">= 0.6.6"
-end
-
-appraise "i18n_0_7" do
-  gem "i18n", "~> 0.7.0"
-end
-
 appraise "i18n_0_8" do
   gem "i18n", "~> 0.8.0"
 end
@@ -18,3 +10,7 @@ end
 appraise "i18n_1_0" do
   gem "i18n", "~> 1.0.0"
 end
+
+appraise "i18n_1_1" do
+  gem "i18n", "~> 1.1.0"
+end

data/CHANGELOG.md

@@ -18,16 +18,28 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Nothing
 
 
+## [3.2.0] - 2018-11-16
+
+### Added
+
+- [Ruby] Add option `json_only` to generate translations in JSON  
+  (PR: https://github.com/fnando/i18n-js/pull/524)
+
+### Changed
+
+- [Ruby] Requires `i18n` to be `>= 0.8.0` for CVE-2014-10077
+
+
 ## [3.1.0] - 2018-11-01
 
 ### Added
 
-- [Ruby] Add option to allow setting a different I18n backend
+- [Ruby] Add option to allow setting a different I18n backend  
   (PR: https://github.com/fnando/i18n-js/pull/519)
 
 ### Fixed
 
-- [JS] Fix missing translation when pluralizing with default scopes
+- [JS] Fix missing translation when pluralizing with default scopes  
   (PR: https://github.com/fnando/i18n-js/pull/516)
 
 
@@ -35,7 +47,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
-- [JS] Fix interpolation for array with non string/null elements
+- [JS] Fix interpolation for array with non string/null elements  
   (PR: https://github.com/fnando/i18n-js/pull/505)
 
 
@@ -43,9 +55,9 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
-- [JS] Fix extend method changing keys with `null` to empty objects
+- [JS] Fix extend method changing keys with `null` to empty objects  
   (PR: https://github.com/fnando/i18n-js/pull/503)
-- [JS] Fix variable name in an internal method
+- [JS] Fix variable name in an internal method  
   (PR: https://github.com/fnando/i18n-js/pull/501)
 
 
@@ -60,7 +72,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 
-- [JS] Interpolate translation array too
+- [JS] Interpolate translation array too  
   (PR: https://github.com/fnando/i18n-js/pull/498)
 
 
@@ -75,7 +87,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
-- [Ruby] Make JS `i18n/filtered` depends on i18n-js config too
+- [Ruby] Make JS `i18n/filtered` depends on i18n-js config too  
   (PR: https://github.com/fnando/i18n-js/pull/497)
 
 
@@ -347,8 +359,9 @@ And today is not April Fools' Day
 
 
 
-[Unreleased]: https://github.com/fnando/i18n-js/compare/v3.1.0...HEAD
-[3.1.0]:     https://github.com/fnando/i18n-js/compare/v3.0.11...v3.1.0
+[Unreleased]: https://github.com/fnando/i18n-js/compare/v3.2.0...HEAD
+[3.2.0]:      https://github.com/fnando/i18n-js/compare/v3.1.0...v3.2.0
+[3.1.0]:      https://github.com/fnando/i18n-js/compare/v3.0.11...v3.1.0
 [3.0.11]:     https://github.com/fnando/i18n-js/compare/v3.0.10...v3.0.11
 [3.0.10]:     https://github.com/fnando/i18n-js/compare/v3.0.9...v3.0.10
 [3.0.9]:      https://github.com/fnando/i18n-js/compare/v3.0.8...v3.0.9

data/README.md

@@ -4,8 +4,7 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
 
 [![Build Status](http://img.shields.io/travis/fnando/i18n-js.svg?style=flat-square)](https://travis-ci.org/fnando/i18n-js)
-[![Dependency Status](http://img.shields.io/gemnasium/fnando/i18n-js.svg?style=flat-square)](https://gemnasium.com/fnando/i18n-js)
-[![Code Climate](http://img.shields.io/codeclimate/github/fnando/i18n-js.svg?style=flat-square)](https://codeclimate.com/github/fnando/i18n-js)
+[![Coverage Status](http://img.shields.io/coveralls/fnando/i18n-js.svg?style=flat-square)](https://coveralls.io/r/fnando/i18n-js)
 
 [![Gitter](https://img.shields.io/badge/gitter-join%20chat-1dce73.svg?style=flat-square)](https://gitter.im/fnando/i18n-js)
 
@@ -827,6 +826,46 @@ Ref: http://2ality.com/2012/07/large-integers.html
 
 Feel free to find & discuss possible solution(s) at issue [#511](https://github.com/fnando/i18n-js/issues/511)
 
+### Only works with `Simple` backend
+
+If you set `I18n.backend` to something other than the default `Simple` backend, you will likely get an exception like this:
+
+```
+Undefined method 'initialized?' for <your backend class>
+```
+
+For now, i18n-js is only compatible with the `Simple` backend.
+If you need a more sophisticated backend for your rails application, like `I18n::Backend::ActiveRecord`, you can setup i18n-js to get translations from a separate `Simple` backend, by adding the following in an initializer:
+
+```ruby
+I18n::JS.backend = I18n.backend
+I18n.backend = I18n::Backend::Chain.new(<your other backend(s)>, I18n.backend)
+```
+
+This will use your backend with the default `Simple` backend as fallback, while i18n-js only sees and uses the simple backend.
+This means however, that only translations from your static locale files will be present in JavaScript.
+
+If you do cannot use a `Chain`-Backend for some reason, you can also set
+
+```ruby
+I18n::JS.backend = I18n::Backend::Simple.new
+I18n.backend = <something different>
+```
+
+However, the automatic reloading of translations in developement will not work in this case.
+This is because Rails calls `I18n.reload!` for each request in development, but `reload!` will not be called on `I18n::JS.backend`, since it is a different object.
+One option would be to patch `I18n.reload!` in an initializer:
+
+```ruby
+module I18n
+  def self.reload!
+    I18n::JS.backend.reload!
+    super
+  end
+end
+```
+
+See issue [#428](https://github.com/fnando/i18n-js/issues/428) for more details and discussion of this issue.
 
 ## Maintainer
 

data/gemfiles/{i18n_0_7.gemfile → i18n_1_1.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "i18n", "~> 0.7.0"
+gem "i18n", "~> 1.1.0"
 
 gemspec path: "../"

data/i18n-js.gemspec

@@ -18,12 +18,15 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "i18n", ">= 0.6.6", "< 2"
+  # CVE-2014-10077 which is fixed for >= 0.8.0
+  # https://nvd.nist.gov/vuln/detail/CVE-2014-10077
+  s.add_dependency "i18n", ">= 0.8.0", "< 2"
 
   s.add_development_dependency "appraisal", "~> 2.0"
   s.add_development_dependency "rspec", "~> 3.0"
   s.add_development_dependency "rake", "~> 12.0"
   s.add_development_dependency "gem-release", ">= 0.7"
+  s.add_development_dependency "coveralls", ">= 0.7"
 
   s.required_ruby_version = ">= 2.1.0"
 end

data/lib/i18n/js.rb

@@ -187,6 +187,13 @@ module I18n
       fallbacks != false
     end
 
+    def self.json_only
+      config.fetch(:json_only) do
+        # default value
+        false
+      end
+    end
+
     def self.fallbacks
       config.fetch(:fallbacks) do
         # default value
@@ -215,6 +222,7 @@ module I18n
       segment_options = Private::HashWithSymbolKeys.new({
         js_extend: js_extend,
         sort_translation_keys: sort_translation_keys?,
+        json_only: json_only
       }).freeze
       segment_options.merge(options.slice(*Segment::OPTIONS))
     end

data/lib/i18n/js/errors.rb

@@ -0,0 +1,9 @@
+module I18n
+  module JS
+    class JsonOnlyLocaleRequiredError < StandardError
+      def message
+        'The json_only option requires %{locale} in the file name.'
+      end
+    end
+  end
+end

data/lib/i18n/js/segment.rb

@@ -1,11 +1,12 @@
 require "i18n/js/private/hash_with_symbol_keys"
+require "i18n/js/errors"
 
 module I18n
   module JS
 
     # Class which enscapulates a translations hash and outputs a single JSON translation file
     class Segment
-      OPTIONS = [:namespace, :pretty_print, :js_extend, :sort_translation_keys].freeze
+      OPTIONS = [:namespace, :pretty_print, :js_extend, :sort_translation_keys, :json_only].freeze
       LOCALE_INTERPOLATOR = /%\{locale\}/
 
       attr_reader *([:file, :translations] | OPTIONS)
@@ -23,6 +24,7 @@ module I18n
         @pretty_print = !!options[:pretty_print]
         @js_extend    = options.key?(:js_extend) ? !!options[:js_extend] : true
         @sort_translation_keys = options.key?(:sort_translation_keys) ? !!options[:sort_translation_keys] : true
+        @json_only = options.key?(:json_only) ? !!options[:json_only] : false
       end
 
       # Saves JSON file containing translations
@@ -32,6 +34,9 @@ module I18n
             write_file(file_for_locale(locale), @translations.slice(locale))
           end
         else
+          if @json_only
+            raise I18n::JS::JsonOnlyLocaleRequiredError
+          end
           write_file
         end
       end
@@ -53,7 +58,11 @@ module I18n
       end
 
       def js_header
-        %(#{@namespace}.translations || (#{@namespace}.translations = {});\n)
+        if @json_only
+          ''
+        else
+          %(#{@namespace}.translations || (#{@namespace}.translations = {});\n)
+        end
       end
 
       def js_translations(locale, translations)
@@ -63,7 +72,9 @@ module I18n
       end
 
       def js_translations_line(locale, translations)
-        if @js_extend
+        if @json_only
+          %({"#{locale}":#{translations}})
+        elsif @js_extend
           %(#{@namespace}.translations["#{locale}"] = I18n.extend((#{@namespace}.translations["#{locale}"] || {}), #{translations});\n)
         else
           %(#{@namespace}.translations["#{locale}"] = #{translations};\n)

data/lib/i18n/js/version.rb

@@ -2,6 +2,6 @@
 
 module I18n
   module JS
-    VERSION = "3.1.0"
+    VERSION = "3.2.0"
   end
 end

data/spec/fixtures/json_only.yml

@@ -0,0 +1,8 @@
+fallbacks: false
+json_only: true
+
+translations:
+  - file: "tmp/i18n-js/json_only.%{locale}.js"
+    only:
+      - "*.date.formats.*"
+      - "*.number.currency.*"

data/spec/ruby/i18n/js/segment_spec.rb

@@ -6,10 +6,12 @@ describe I18n::JS::Segment do
   let(:translations){ { en: { "test" => "Test" }, fr: { "test" => "Test2" } } }
   let(:namespace)   { "MyNamespace" }
   let(:pretty_print){ nil }
+  let(:json_only)  { nil }
   let(:js_extend)  { nil }
   let(:sort_translation_keys){ nil }
   let(:options)     { { namespace: namespace,
                         pretty_print: pretty_print,
+                        json_only: json_only,
                         js_extend: js_extend,
                         sort_translation_keys: sort_translation_keys }.delete_if{|k,v| v.nil?} }
   subject { I18n::JS::Segment.new(file, translations, options) }
@@ -59,6 +61,36 @@ describe I18n::JS::Segment do
     end
   end
 
+  describe "#saving!" do
+    before { allow(I18n::JS).to receive(:export_i18n_js_dir_path).and_return(temp_path) }
+
+    context "when json_only is true" do
+      let(:file){ "tmp/i18n-js/%{locale}.js" }
+      let(:json_only){ true }
+      it 'should output the keys as sorted' do
+        subject.save!
+        file_should_exist "en.js"
+        file_should_exist "fr.js"
+
+        File.open(File.join(temp_path, "en.js")){|f| f.read}.should eql(
+          %Q({"en":{"test":"Test"}})
+        )
+
+        File.open(File.join(temp_path, "fr.js")){|f| f.read}.should eql(
+          %Q({"fr":{"test":"Test2"}})
+        )
+      end
+    end
+
+    context "when json_only is true without locale" do
+      let(:file){ "tmp/i18n-js/segment.js" }
+      let(:json_only){ true }
+      it 'should output the keys as sorted' do
+        expect { subject.save! }.to raise_error(I18n::JS::JsonOnlyLocaleRequiredError)
+      end
+    end
+  end
+
   describe "#save!" do
     before { allow(I18n::JS).to receive(:export_i18n_js_dir_path).and_return(temp_path) }
     before { subject.save! }

data/spec/ruby/i18n/js_spec.rb

@@ -30,14 +30,14 @@ describe I18n::JS do
 
     it "exports messages using custom output path" do
       set_config "custom_path.yml"
-      I18n::JS::Segment.should_receive(:new).with("tmp/i18n-js/all.js", translations, {js_extend: true, sort_translation_keys: true}).and_call_original
+      I18n::JS::Segment.should_receive(:new).with("tmp/i18n-js/all.js", translations, {js_extend: true, sort_translation_keys: true, json_only: false}).and_call_original
       I18n::JS::Segment.any_instance.should_receive(:save!).with(no_args)
       I18n::JS.export
     end
 
     it "sets default scope to * when not specified" do
       set_config "no_scope.yml"
-      I18n::JS::Segment.should_receive(:new).with("tmp/i18n-js/no_scope.js", translations, {js_extend: true, sort_translation_keys: true}).and_call_original
+      I18n::JS::Segment.should_receive(:new).with("tmp/i18n-js/no_scope.js", translations, {js_extend: true, sort_translation_keys: true, json_only: false}).and_call_original
       I18n::JS::Segment.any_instance.should_receive(:save!).with(no_args)
       I18n::JS.export
     end
@@ -109,6 +109,22 @@ EOS
 )
     end
 
+    it "exports as json only" do
+      set_config "json_only.yml"
+      I18n::JS.export
+      en_output = File.read(File.join(I18n::JS.export_i18n_js_dir_path, "json_only.en.js"))
+      fr_output = File.read(File.join(I18n::JS.export_i18n_js_dir_path, "json_only.fr.js"))
+      expect(en_output).to eq (<<EOS
+{"en":{"date":{"formats":{"default":"%Y-%m-%d","long":"%B %d, %Y","short":"%b %d"}},"number":{"currency":{"format":{"delimiter":",","format":"%u%n","precision":2,"separator":".","unit":"$"}}}}}
+EOS
+).chop
+      expect(fr_output).to eq (<<EOS
+{"fr":{"date":{"formats":{"default":"%d/%m/%Y","long":"%e %B %Y","long_ordinal":"%e %B %Y","only_day":"%e","short":"%e %b"}},"number":{"currency":{"format":{"format":"%n %u","precision":2,"unit":"€"}}}}}
+EOS
+).chop
+      expect(JSON.parse(en_output).keys.first).to eq 'en'
+    end
+
     it "exports with :except condition" do
       set_config "except_condition.yml"
       I18n::JS.export

data/spec/spec_helper.rb

@@ -1,8 +1,27 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter 'spec'
+  end
+rescue LoadError
+  # SimpleCov ain't available - continue
+end
+
+if ENV["TRAVIS"]
+  require "coveralls"
+  Coveralls.wear!("rails")
+end
+
 require "i18n"
 require "json"
 
 require "i18n/js"
 
+require "rspec"
+
 module Helpers
   # Set the configuration as the current one
   def set_config(path)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-js
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-01 00:00:00.000000000 Z
+date: 2018-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.6
+        version: 0.8.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.6
+        version: 0.8.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -86,6 +86,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: It's a small library to provide the Rails I18n translations on the Javascript.
 email:
 - fnando.vieira@gmail.com
@@ -106,16 +120,16 @@ files:
 - app/assets/javascripts/i18n/filtered.js.erb
 - app/assets/javascripts/i18n/shims.js
 - app/assets/javascripts/i18n/translations.js
-- gemfiles/i18n_0_6.gemfile
-- gemfiles/i18n_0_7.gemfile
 - gemfiles/i18n_0_8.gemfile
 - gemfiles/i18n_0_9.gemfile
 - gemfiles/i18n_1_0.gemfile
+- gemfiles/i18n_1_1.gemfile
 - i18n-js.gemspec
 - lib/i18n-js.rb
 - lib/i18n/js.rb
 - lib/i18n/js/dependencies.rb
 - lib/i18n/js/engine.rb
+- lib/i18n/js/errors.rb
 - lib/i18n/js/fallback_locales.rb
 - lib/i18n/js/middleware.rb
 - lib/i18n/js/private/hash_with_symbol_keys.rb
@@ -144,6 +158,7 @@ files:
 - spec/fixtures/js_file_with_namespace_and_pretty_print.yml
 - spec/fixtures/js_sort_translation_keys_false.yml
 - spec/fixtures/js_sort_translation_keys_true.yml
+- spec/fixtures/json_only.yml
 - spec/fixtures/locales.yml
 - spec/fixtures/multiple_conditions.yml
 - spec/fixtures/multiple_conditions_per_locale.yml
@@ -200,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: It's a small library to provide the Rails I18n translations on the Javascript.
@@ -223,6 +238,7 @@ test_files:
 - spec/fixtures/js_file_with_namespace_and_pretty_print.yml
 - spec/fixtures/js_sort_translation_keys_false.yml
 - spec/fixtures/js_sort_translation_keys_true.yml
+- spec/fixtures/json_only.yml
 - spec/fixtures/locales.yml
 - spec/fixtures/multiple_conditions.yml
 - spec/fixtures/multiple_conditions_per_locale.yml

data/gemfiles/i18n_0_6.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "i18n", "~> 0.6.0", ">= 0.6.6"
-
-gemspec path: "../"