i18n-js 3.8.4 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 228b00c6b2733537cc164228e6da21dfee1531b26186258861b2f710b7c80cae
-  data.tar.gz: 000d759f9753bb29900a7e09eca044f643cbdde5b0779eeb71683805ac780e14
+  metadata.gz: '08599ed12ef6edb132d1a71b74e5ca2f3b3c04dc4463286414540f4631676984'
+  data.tar.gz: 3dd94b7a9974952a5cb7996c222d1aaeb3e5c756cc811a8890e4d5fa79ffccb3
 SHA512:
-  metadata.gz: a180630b6968c7e38723f8d42828e3d9aa6c32d0250e2e28c4a56a644d6a943124bd7183908f5e05616237dc9ebefd69c21a1f0190f2995062745fb12f7b76d9
-  data.tar.gz: b301cb38ecf02cbf08b92798b0d7457fc00c1903f3fb27ca9c5d821c0c9fdf7f7f500b19b935a1eb3052a066b3057bc763635c4e0e8daf8f7448c500ffc90746
+  metadata.gz: 26138b1fafc184b7858a97969130f29f9562cdaab41d1f05c1e31a37064a2f40a31b4d0a349e12ddaa6f769ab229618a854efaee0102f99821edd489b9d1deb5
+  data.tar.gz: d763f7ebe8d1bba649c521bba03fa7fb77e4283b90ce6f1a1bb78ebf22dc7146f4e2eb02484f7d9f104d4d5454d90d0622af14128c6b383cd399e52aabaaf08b

data/CHANGELOG.md

@@ -18,6 +18,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Nothing
 
 
+## [3.9.0]
+
+### Added
+
+- [Ruby] Allow to set custom locales instead of using only `I18n.available_locales`.
+  (PR: https://github.com/fnando/i18n-js/pull/617)
+
+
 ## [3.8.4]
 
 ### Fixed
@@ -509,7 +517,8 @@ And today is not April Fools' Day
 
 
 
-[Unreleased]: https://github.com/fnando/i18n-js/compare/v3.8.4...HEAD
+[Unreleased]: https://github.com/fnando/i18n-js/compare/v3.9.0...HEAD
+[3.9.0]:      https://github.com/fnando/i18n-js/compare/v3.8.4...v3.9.0
 [3.8.4]:      https://github.com/fnando/i18n-js/compare/v3.8.3...v3.8.4
 [3.8.3]:      https://github.com/fnando/i18n-js/compare/v3.8.2...v3.8.3
 [3.8.2]:      https://github.com/fnando/i18n-js/compare/v3.8.1...v3.8.2

data/README.md

@@ -271,6 +271,17 @@ You must disable this feature by setting the option to `false`.
 To find more examples on how to use the configuration file please refer to the
 tests.
 
+#### Available locales
+
+By specifying option `js_available_locales` with a list of locales, this list
+would be used instead of default `I18n.available_locales` to generate translations.
+
+Example:
+
+```yaml
+js_available_locales: ["de", "en"]
+```
+
 #### Namespace
 
 Setting the `namespace` option will change the namespace of the output

data/lib/i18n/js.rb

@@ -81,7 +81,7 @@ module I18n
 
     # deep_merge! given result with result for fallback locale
     def self.merge_with_fallbacks!(result)
-      I18n.available_locales.each do |locale|
+      js_available_locales.each do |locale|
         fallback_locales = FallbackLocales.new(fallbacks, locale)
         fallback_locales.each do |fallback_locale|
           # `result[fallback_locale]` could be missing
@@ -183,7 +183,7 @@ module I18n
         #
         # So the input is wrapped by our class for better `#slice`
         Private::HashWithSymbolKeys.new(translations).
-          slice(*::I18n.available_locales).
+          slice(*::I18n::JS.js_available_locales).
           to_h
       end
     end
@@ -213,6 +213,16 @@ module I18n
       end
     end
 
+    # Get all available locales.
+    #
+    # @return [Array<Symbol>] the locales.
+    def self.js_available_locales
+      config.fetch(:js_available_locales) do
+        # default value
+        I18n.available_locales
+      end.map(&:to_sym)
+    end
+
     def self.sort_translation_keys?
       @sort_translation_keys ||= (config[:sort_translation_keys]) if config.key?(:sort_translation_keys)
       @sort_translation_keys = true if @sort_translation_keys.nil?

data/lib/i18n/js/segment.rb

@@ -33,7 +33,7 @@ module I18n
       # Saves JSON file containing translations
       def save!
         if @file =~ LOCALE_INTERPOLATOR
-          I18n.available_locales.each do |locale|
+          I18n::JS.js_available_locales.each do |locale|
             write_file(file_for_locale(locale), @translations.slice(locale))
           end
         else

data/lib/i18n/js/version.rb

@@ -2,6 +2,6 @@
 
 module I18n
   module JS
-    VERSION = "3.8.4"
+    VERSION = "3.9.0"
   end
 end

data/spec/fixtures/js_available_locales_custom.yml

@@ -0,0 +1 @@
+js_available_locales: ["en", "foo"]

data/spec/ruby/i18n/js_spec.rb

@@ -307,21 +307,30 @@ EOS
       expect(subject[:de][:null_test]).to eql(nil)
     end
 
-    context "when given locale is in `I18n.available_locales` but its translation is missing" do
+    context 'when given locale is in `I18n.available_locales` but its translation is missing' do
       subject { translations[:fr][:fallback_test] }
 
-      let(:new_locale) { :pirate }
-      let!(:old_available_locales) { I18n.config.available_locales }
-      let!(:new_available_locales) { I18n.config.available_locales + [new_locale] }
+      let(:available_locales) { %i[fr pirate] }
+
       before do
-        I18n.config.available_locales = new_available_locales
-        set_config "js_file_per_locale_with_fallbacks_as_locale_without_fallback_translations.yml"
+        allow(::I18n).to receive(:available_locales).and_return(available_locales)
+        set_config 'js_file_per_locale_with_fallbacks_as_locale_without_fallback_translations.yml'
       end
-      after do
-        I18n.config.available_locales = old_available_locales
+
+      it { should eql(nil) }
+    end
+
+    context 'when given locale is in `.js_available_locales` but its translation is missing' do
+      subject { translations[:fr][:fallback_test] }
+
+      let(:available_locales) { %i[fr pirate] }
+
+      before do
+        allow(described_class).to receive(:js_available_locales).and_return(available_locales)
+        set_config 'js_file_per_locale_with_fallbacks_as_locale_without_fallback_translations.yml'
       end
 
-      it {should eql(nil)}
+      it { should eql(nil) }
     end
 
     context "with I18n::Fallbacks enabled" do
@@ -385,27 +394,67 @@ EOS
     end
   end
 
-  context "I18n.available_locales" do
+  describe '.js_available_locales' do
+    subject { described_class.js_available_locales }
+
+    let(:results) { described_class.scoped_translations('*.admin.*.title') }
+    let(:result)  { ->(locale) { results[locale][:admin][:show][:title] } }
 
-    context "when I18n.available_locales is not set" do
-      it "should allow all locales" do
-        result = I18n::JS.scoped_translations("*.admin.*.title")
+    context 'when I18n.available_locales is not set' do
+      it { expect(subject).to eq ::I18n.available_locales }
 
-        expect(result[:en][:admin][:show][:title]).to eql("Show")
-        expect(result[:fr][:admin][:show][:title]).to eql("Visualiser")
-        expect(result[:ja][:admin][:show][:title]).to eql("Ignore me")
+      it 'should allow all locales' do
+        expect(result.call(:en)).to eql('Show')
+        expect(result.call(:fr)).to eql('Visualiser')
+        expect(result.call(:ja)).to eql('Ignore me')
       end
     end
 
-    context "when I18n.available_locales is set" do
-      before { allow(::I18n).to receive(:available_locales){ [:en, :fr] } }
+    context 'when I18n.available_locales is set' do
+      let(:available_locales) { %i[en fr] }
+
+      before { allow(::I18n).to receive(:available_locales).and_return(available_locales) }
+
+      it { expect(subject).to eq available_locales }
+
+      it 'should ignore non-valid locales' do
+        expect(result.call(:en)).to eql('Show')
+        expect(result.call(:fr)).to eql('Visualiser')
+        expect(results).not_to include(:ja)
+      end
+
+      context 'when :js_available_locales set in config' do
+        before { set_config 'js_available_locales_custom.yml' }
 
-      it "should ignore non-valid locales" do
-        result = I18n::JS.scoped_translations("*.admin.*.title")
+        it { expect(subject).to eq %i[en foo] }
+
+        it 'should ignore non-valid locales' do
+          expect(result.call(:en)).to eql('Show')
+          expect(results).not_to include(:fr, :ja)
+        end
+      end
+    end
+  end
+
+  context 'I18n.available_locales' do
+    let(:results) { described_class.scoped_translations('*.admin.*.title') }
+    let(:result)  { ->(locale) { results[locale][:admin][:show][:title] } }
+
+    context 'when I18n.available_locales is not set' do
+      it 'should allow all locales' do
+        expect(result.call(:en)).to eql('Show')
+        expect(result.call(:fr)).to eql('Visualiser')
+        expect(result.call(:ja)).to eql('Ignore me')
+      end
+    end
+
+    context 'when I18n.available_locales is set' do
+      before { allow(::I18n).to receive(:available_locales){ [:en, :fr] } }
 
-        expect(result[:en][:admin][:show][:title]).to eql("Show")
-        expect(result[:fr][:admin][:show][:title]).to eql("Visualiser")
-        expect(result.keys.include?(:ja)).to eql(false)
+      it 'should ignore non-valid locales' do
+        expect(result.call(:en)).to eql('Show')
+        expect(result.call(:fr)).to eql('Visualiser')
+        expect(results).not_to include(:ja)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-js
 version: !ruby/object:Gem::Version
-  version: 3.8.4
+  version: 3.9.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-27 00:00:00.000000000 Z
+date: 2021-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -152,6 +152,7 @@ files:
 - spec/fixtures/default.yml
 - spec/fixtures/erb.yml
 - spec/fixtures/except_condition.yml
+- spec/fixtures/js_available_locales_custom.yml
 - spec/fixtures/js_export_dir_custom.yml
 - spec/fixtures/js_export_dir_none.yml
 - spec/fixtures/js_extend_parent.yml
@@ -236,6 +237,7 @@ test_files:
 - spec/fixtures/default.yml
 - spec/fixtures/erb.yml
 - spec/fixtures/except_condition.yml
+- spec/fixtures/js_available_locales_custom.yml
 - spec/fixtures/js_export_dir_custom.yml
 - spec/fixtures/js_export_dir_none.yml
 - spec/fixtures/js_extend_parent.yml