i18n-js 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e499400b911829bf876432a25d3bbb1e5c55af10e5cedd2fdbf06a88145e8f3
-  data.tar.gz: '0893d97d2e483f17c8c9a3af79227e6808a01a35275e10fceadc3b8ad507f70d'
+  metadata.gz: e862238199baf310221642a6913ce7d07b87b2c6934e691bed7bc19a613c09b7
+  data.tar.gz: cdc3db450f6613e82246f2b2ba303ae706bbdaadebee84d34024cd8fb371308c
 SHA512:
-  metadata.gz: 66cc8573871132c0af819c87ffb10bf0e918799da4cd77aa01fb2298c422e7c5ae3f92409ae55575215360abba759b65d7410e9e0c1077dd4d75594cd5c1196e
-  data.tar.gz: e4072b5b511a0b39b875dc03258926afc0cc5fe7f512054efcf05ebc9b8df67ada3c937cfe4ce9902dde6a61f87aed2240c971c24f990ae07c8b1309df5a15dc
+  metadata.gz: 2bc681b8e0b8e7260fd5dfdea56c3733234c8c8afedd0e4c6492ef65356e8b7b6d5ee2e959d5ba26751860c89e237813960e5bc4a45cdb7dbd525fe396277718
+  data.tar.gz: 7aaf234e4f39b7f3eeeff50cadd7f6f8625e235477a83d58bbcf17c30ef7e09ab086de27c85fe5c5f802b6e4f935d81a203abccae80bc65c53a6e549eeb989fb

data/.travis.yml

@@ -28,6 +28,7 @@ gemfile:
   - gemfiles/i18n_1_4.gemfile
   - gemfiles/i18n_1_5.gemfile
   - gemfiles/i18n_1_6.gemfile
+  - gemfiles/i18n_1_7.gemfile
 matrix:
   fast_finish: true
   allow_failures:

data/Appraisals

@@ -34,3 +34,7 @@ end
 appraise "i18n_1_6" do
   gem "i18n", "~> 1.6.0"
 end
+
+appraise "i18n_1_7" do
+  gem "i18n", "~> 1.7.0"
+end

data/CHANGELOG.md

@@ -18,6 +18,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Nothing
 
 
+## [3.4.0] - 2019-10-15
+
+### Added
+
+- Allow `prefix` to be added to generated translations files  
+  (PR: https://github.com/fnando/i18n-js/pull/549)
+
+
 ## [3.3.0] - 2019-06-06
 
 ### Added
@@ -400,7 +408,8 @@ And today is not April Fools' Day
 
 
 
-[Unreleased]: https://github.com/fnando/i18n-js/compare/v3.3.0...HEAD
+[Unreleased]: https://github.com/fnando/i18n-js/compare/v3.4.0...HEAD
+[3.4.0]:      https://github.com/fnando/i18n-js/compare/v3.3.0...v3.4.0
 [3.3.0]:      https://github.com/fnando/i18n-js/compare/v3.2.3...v3.3.0
 [3.2.3]:      https://github.com/fnando/i18n-js/compare/v3.2.2...v3.2.3
 [3.2.2]:      https://github.com/fnando/i18n-js/compare/v3.2.1...v3.2.2

data/README.md

@@ -1,6 +1,7 @@
 # I18n.js
 
 [![Gem Version](http://img.shields.io/gem/v/i18n-js.svg?style=flat-square)](http://badge.fury.io/rb/i18n-js)
+[![npm](https://img.shields.io/npm/v/i18n-js.svg?style=flat-square)](https://www.npmjs.com/package/i18n-js)
 [![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)
@@ -8,6 +9,8 @@
 
 [![Gitter](https://img.shields.io/badge/gitter-join%20chat-1dce73.svg?style=flat-square)](https://gitter.im/fnando/i18n-js)
 
+> The above badges are generated by https://shields.io/
+
 It's a small library to provide the Rails I18n translations on the JavaScript.
 
 Features:
@@ -245,6 +248,27 @@ MyNamespace.translations["en"] = { ... }
 ```
 
 
+### Adding a line at the beggining of the translations file (useful for imports)
+
+Setting the `prefix: "import I18n from 'i18n-js';\n"` option will add the line at the beggining of the resultant translation file.
+This can be useful to use this gem with the [i18n-js](https://www.npmjs.com/package/i18n-js) npm package, which is quite useful to use it with webpack.
+The user should provide the semi-colon and the newline character if needed.
+
+For example:
+
+```yaml
+translations:
+- file: "public/javascripts/i18n/translations.js"
+  prefix: "import I18n from 'i18n-js';\n"
+```
+
+will create:
+
+```
+import I18n from 'i18n-js';
+I18n.translations || (I18n.translations = {});
+
+
 #### Pretty Print
 
 Set the `pretty_print` option if you would like whitespace and indentation in your output file (default: false)

data/gemfiles/i18n_1_7.gemfile

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

data/lib/i18n/js/formatters/base.rb

@@ -2,10 +2,11 @@ module I18n
   module JS
     module Formatters
       class Base
-        def initialize(js_extend: false, namespace: nil, pretty_print: false)
+        def initialize(js_extend: false, namespace: nil, pretty_print: false, prefix: nil)
           @js_extend    = js_extend
           @namespace    = namespace
           @pretty_print = pretty_print
+          @prefix = prefix
         end
 
         protected

data/lib/i18n/js/formatters/js.rb

@@ -15,7 +15,8 @@ module I18n
         protected
 
         def header
-          %(#{@namespace}.translations || (#{@namespace}.translations = {});\n)
+          text = @prefix || ''
+          text + %(#{@namespace}.translations || (#{@namespace}.translations = {});\n)
         end
 
         def line(locale, translations)

data/lib/i18n/js/segment.rb

@@ -7,7 +7,7 @@ module I18n
 
     # Class which enscapulates a translations hash and outputs a single JSON translation file
     class Segment
-      OPTIONS = [:namespace, :pretty_print, :js_extend, :sort_translation_keys, :json_only].freeze
+      OPTIONS = [:namespace, :pretty_print, :js_extend, :prefix, :sort_translation_keys, :json_only].freeze
       LOCALE_INTERPOLATOR = /%\{locale\}/
 
       attr_reader *([:file, :translations] | OPTIONS)
@@ -24,6 +24,7 @@ module I18n
         @namespace    = options[:namespace] || 'I18n'
         @pretty_print = !!options[:pretty_print]
         @js_extend    = options.key?(:js_extend) ? !!options[:js_extend] : true
+        @prefix       = options.key?(:prefix) ? options[:prefix] : nil
         @sort_translation_keys = options.key?(:sort_translation_keys) ? !!options[:sort_translation_keys] : true
         @json_only = options.key?(:json_only) ? !!options[:json_only] : false
       end
@@ -68,7 +69,8 @@ module I18n
       def formatter_options
         { js_extend: @js_extend,
           namespace: @namespace,
-          pretty_print: @pretty_print }
+          pretty_print: @pretty_print,
+          prefix: @prefix }
       end
     end
   end

data/lib/i18n/js/version.rb

@@ -2,6 +2,6 @@
 
 module I18n
   module JS
-    VERSION = "3.3.0"
+    VERSION = "3.4.0"
   end
 end

data/spec/fixtures/{js_file_with_namespace_and_pretty_print.yml → js_file_with_namespace_prefix_and_pretty_print.yml}

@@ -5,3 +5,4 @@ translations:
     only: '*'
     namespace: "Foo"
     pretty_print: true
+    prefix: "import random from 'random-library';\n"

data/spec/ruby/i18n/js_spec.rb

@@ -351,11 +351,11 @@ EOS
     end
   end
 
-  context "namespace and pretty_print options" do
+  context "namespace, prefix and pretty_print options" do
 
     before do
       stub_const('I18n::JS::DEFAULT_EXPORT_DIR_PATH', temp_path)
-      set_config "js_file_with_namespace_and_pretty_print.yml"
+      set_config "js_file_with_namespace_prefix_and_pretty_print.yml"
     end
 
     it "exports with defined locale as fallback when enabled" do
@@ -364,6 +364,7 @@ EOS
       output = File.read(File.join(I18n::JS.export_i18n_js_dir_path, "en.js"))
       expect(output).to match(/^#{
 <<EOS
+import random from 'random-library';
 Foo.translations || (Foo.translations = {});
 Foo.translations["en"] = {
   "number": {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-js
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-06 00:00:00.000000000 Z
+date: 2019-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -125,6 +125,7 @@ files:
 - gemfiles/i18n_1_4.gemfile
 - gemfiles/i18n_1_5.gemfile
 - gemfiles/i18n_1_6.gemfile
+- gemfiles/i18n_1_7.gemfile
 - i18n-js.gemspec
 - lib/i18n-js.rb
 - lib/i18n/js.rb
@@ -158,7 +159,7 @@ files:
 - spec/fixtures/js_file_per_locale_with_fallbacks_as_locale_without_fallback_translations.yml
 - spec/fixtures/js_file_per_locale_with_fallbacks_enabled.yml
 - spec/fixtures/js_file_per_locale_without_fallbacks.yml
-- spec/fixtures/js_file_with_namespace_and_pretty_print.yml
+- spec/fixtures/js_file_with_namespace_prefix_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
@@ -218,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: It's a small library to provide the Rails I18n translations on the Javascript.
@@ -238,7 +239,7 @@ test_files:
 - spec/fixtures/js_file_per_locale_with_fallbacks_as_locale_without_fallback_translations.yml
 - spec/fixtures/js_file_per_locale_with_fallbacks_enabled.yml
 - spec/fixtures/js_file_per_locale_without_fallbacks.yml
-- spec/fixtures/js_file_with_namespace_and_pretty_print.yml
+- spec/fixtures/js_file_with_namespace_prefix_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