i18n-js 3.0.0.rc13 → 3.0.0.rc14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d618c24aafbe01dfc9573cf7a3df0c214b9b48a
-  data.tar.gz: 22bbc551ae4ba0d927c4d8b61fbf54996f51de4f
+  metadata.gz: 10a07ab318e610dfc7102d3d88015d8a55c42a76
+  data.tar.gz: 21fa8daa428b711f6d592c3b14bad7183e5af2f8
 SHA512:
-  metadata.gz: f8ada8c660b2185867aa9c5ed68627aaee251c164032e39cf1b3fd0e9f0690f161defe732055f9eb97945084665208237252174ebf60131e66e6589fdf666506
-  data.tar.gz: aabf496875397c179606adf78bba0bee468e5d923a7d3c6d21d36494b03aab55cc650fdf8a672eea0da410a9c57c18ea07ae7c377129aa275cea6254c260a073
+  metadata.gz: cef3f6f68e7ca327e96902093069c47df6897074d35db121700076e3e7137d1ae68a9222e76ded1bea5e8d3145597cc0f37c9651d12a3b62ccbf766ce8374186
+  data.tar.gz: 6940d5acc297f6482cb74caa56f64c85b2be20065a069fd26267956ee157ce139b2f92b425c9e2e55ce983c285bd66dcdae861454bc4371aa4e478687613da4d

data/CHANGELOG.md

@@ -16,6 +16,18 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 - Nothing
 
+
+## [3.0.0.rc14] - 2016-08-29
+
+### Changed
+
+- [JS] Method `I18n.extend()` behave as deep merging instead of shallow merging. (https://github.com/fnando/i18n-js/pull/416)
+- [Ruby] Use object/class instead of block when registering Sprockets preprocessor (https://github.com/fnando/i18n-js/pull/418)  
+  To ensure that your cache will expire properly based on locale file content after upgrading,  
+  you should run `rake assets:clobber` and/or other rake tasks that clear the asset cache once gem updated
+- [Ruby] Detect & support rails 5 (https://github.com/fnando/i18n-js/pull/413)
+
+
 ## [3.0.0.rc13] - 2016-06-29
 
 ### Added
@@ -31,7 +43,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - [JS] Initialize option `missingBehaviour` & `missingTranslationPrefix` with default values ([#398](https://github.com/fnando/i18n-js/pull/398))
 - [JS] Throw an error when `I18n.strftime()` takes an invalid date ([#383](https://github.com/fnando/i18n-js/pull/383))
 - [JS] Fix default error message when translation missing to consider locale passed in options
-- [Ruby] Reset middleware cache on rails startup 
+- [Ruby] Reset middleware cache on rails startup
 ([#402](https://github.com/fnando/i18n-js/pull/402))
 
 
@@ -94,7 +106,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - [Ruby] Add `:except` option to exclude certain phrases or groups of phrases from the
   outputted translations ([#312](https://github.com/fnando/i18n-js/pull/312))
 - [JS] You can now set `I18n.missingBehavior='guess'` to have the scope string output as text instead of of the
-  "[missing `scope`]" message when no translation is available.  
+  "[missing `scope`]" message when no translation is available.
   Combined that with `I18n.missingTranslationPrefix='SOMETHING'` and you can
   still identify those missing strings.
   ([#304](https://github.com/fnando/i18n-js/pull/304))
@@ -110,8 +122,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### enhancements
 
 - Add support for loading via AMD and CommonJS module loaders ([#266](https://github.com/fnando/i18n-js/pull/266))
-- Add `I18n.nullPlaceholder`  
-  Defaults to I18n.missingPlaceholder (`[missing {{name}} value]`)  
+- Add `I18n.nullPlaceholder`
+  Defaults to I18n.missingPlaceholder (`[missing {{name}} value]`)
   Set to `function() {return "";}` to match Ruby `I18n.t("name: %{name}", name: nil)`
 - For date formatting, you can now also add placeholders to the date format, see README for detail
 - Add fallbacks option to `i18n-js.yml`, defaults to `true`
@@ -121,8 +133,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Fix factory initialization so that the Node/CommonJS branch only gets executed if the environment is Node/CommonJS
   (it currently will execute if module is defined in the global scope, which occurs with QUnit, for example)
 - Fix pluralization rules selection for negative `count` (e.g. `-1` was lead to use `one` for pluralization) ([#268](https://github.com/fnando/i18n-js/pull/268))
-- Remove check for `Rails.configuration.assets.compile` before telling Sprockets the dependency of translations JS file  
-  This might be the reason of many "cache not expired" issues  
+- Remove check for `Rails.configuration.assets.compile` before telling Sprockets the dependency of translations JS file
+  This might be the reason of many "cache not expired" issues
   Discovered/reported in #277
 
 ## 3.0.0.rc7
@@ -130,11 +142,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### enhancements
 
 - The Rails Engine initializer is now named as `i18n-js.register_preprocessor` (https://github.com/fnando/i18n-js/pull/261)
-- Rename `I18n::JS.config_file` to `I18n::JS.config_file_path` and make it configurable  
+- Rename `I18n::JS.config_file` to `I18n::JS.config_file_path` and make it configurable
   Expected a `String`, default is still `config/i18n-js.yml`
 - When running `rake i18n:js:export`, the `i18n.js` will also be exported to `I18n::JS.export_i18n_js_dir_path` by default
-- Add `I18n::JS.export_i18n_js_dir_path`  
-  Expected a `String`, default is `public/javascripts`  
+- Add `I18n::JS.export_i18n_js_dir_path`
+  Expected a `String`, default is `public/javascripts`
   Set to `nil` will disable exporting `i18n.js`
 
 ### bug fixes
@@ -176,6 +188,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 
 
-[Unreleased]: https://github.com/fnando/i18n-js/compare/v3.0.0.rc13...HEAD
+[Unreleased]: https://github.com/fnando/i18n-js/compare/v3.0.0.rc14...HEAD
+[3.0.0.rc14]: https://github.com/fnando/i18n-js/compare/v3.0.0.rc13...v3.0.0.rc14
 [3.0.0.rc13]: https://github.com/fnando/i18n-js/compare/v3.0.0.rc12...v3.0.0.rc13
 [3.0.0.rc12]: https://github.com/fnando/i18n-js/compare/v3.0.0.rc11...v3.0.0.rc12

data/README.md

@@ -65,23 +65,23 @@ Then get the JS files following the instructions below.
 
 **There are two ways to get `translations.js`.**
 
-1. This `translations.js` file can be automatically generated by the `I18n::JS::Middleware`.  
-  Just add `config.middleware.use I18n::JS::Middleware` to your `config/application.rb` file.  
+1. This `translations.js` file can be automatically generated by the `I18n::JS::Middleware`.
+  Just add `config.middleware.use I18n::JS::Middleware` to your `config/application.rb` file.
 2. If you can't or prefer not to generate this file,
   you can move the middleware line to your `config/environments/development.rb` file
   and run `rake i18n:js:export` before deploying.
   This will export all translation files, including the custom scopes
-  you may have defined on `config/i18n-js.yml`.  
+  you may have defined on `config/i18n-js.yml`.
   If `I18n.available_locales` is set (e.g. in your Rails `config/application.rb` file)
-  then only the specified locales will be exported.  
+  then only the specified locales will be exported.
   Current version of `i18n.js` will also be exported to avoid version mismatching by downloading.
 
 #### Export Configuration (For translations)
 
-Exported translation files generated by `I18n::JS::Middleware` or `rake i18n:js:export` can be customized with config file `config/i18n-js.yml`  
-(use `rails generate i18n:js:config` to create it).  
-You can even get more files generated to different folders and with different translations to best suit your needs.  
-The config file also affects developers using Asset Pipeline to require translations.  
+Exported translation files generated by `I18n::JS::Middleware` or `rake i18n:js:export` can be customized with config file `config/i18n-js.yml`
+(use `rails generate i18n:js:config` to create it).
+You can even get more files generated to different folders and with different translations to best suit your needs.
+The config file also affects developers using Asset Pipeline to require translations.
 Except the option `file`, since all translations are required by adding `//= require i18n/translations`.
 
 Examples:
@@ -134,14 +134,14 @@ translations:
 #### Export Configuration (For other things)
 
 - `I18n::JS.config_file_path`
-  Expected Type: `String`  
-  Default: `config/i18n-js.yml`  
-  Behaviour: Try to read the config file from that location  
+  Expected Type: `String`
+  Default: `config/i18n-js.yml`
+  Behaviour: Try to read the config file from that location
 
 - `I18n::JS.export_i18n_js_dir_path`
-  Expected Type: `String`  
-  Default: `public/javascripts`  
-  Behaviour:  
+  Expected Type: `String`
+  Default: `public/javascripts`
+  Behaviour:
   - Any `String`: considered as a relative path for a folder to `Rails.root` and export `i18n.js` to that folder for `rake i18n:js:export`
   - Any non-`String` (`nil`, `false`, `:none`, etc): Disable `i18n.js` exporting
 
@@ -169,7 +169,7 @@ To find more examples on how to use the configuration file please refer to the t
 
 #### Fallbacks
 
-If you specify the `fallbacks` option, you will be able to fill missing translations with those inside fallback locale(s).  
+If you specify the `fallbacks` option, you will be able to fill missing translations with those inside fallback locale(s).
 Default value is `true`.
 
 Examples:
@@ -256,10 +256,10 @@ translations:
 ```
 
 
-#### Javscript Merge (:js_extend option)
+#### Javscript Deep Merge (:js_extend option)
 
 By default, the output file Javascript will call the `I18n.extend` method to ensure that newly loaded locale
-files are shallow-merged with any locale data already in memory. To disable this either globally or per-file,
+files are deep-merged with any locale data already in memory. To disable this either globally or per-file,
 set the `js_extend` option to false
 
 ```yaml
@@ -617,7 +617,7 @@ This method is useful for very large apps where a single contained translations.
     + file: "app/assets/javascript/nls/welcome.js"
       only:
         + '*.welcome.*'
-    
+
     + file: "app/assets/javascript/nls/albums.js"
       only:
         + '*.albums.*'
@@ -687,13 +687,13 @@ To use this with require.js we are only going to change a few things from above.
       deps:
         + i18n
 
-  # Finally in your modules 
+  # Finally in your modules
   modules:
     + name: 'application'
       include:
         + i18n
         + 'nls/global'
-    
+
     + name: 'welcome'
       exclude:
         + application
@@ -767,7 +767,7 @@ This means that new locale files will not be detected, and so they will not trig
     $ rake assets:precompile
     ```
     or similar commands.  If you are precompiling assets on the target machine(s), cached pages may be broken by this, so they will need to be refreshed.
-    
+
 2. You can change something in a different locale file.
 
 3. Finally, you can change `config.assets.version`.

data/app/assets/javascripts/i18n.js

@@ -79,6 +79,20 @@
     return +(value[0] + 'e' + (value[1] ? (+value[1] + exp) : exp));
   }
 
+  var merge = function (dest, obj) {
+    var key, value;
+    for (key in obj) if (obj.hasOwnProperty(key)) {
+      value = obj[key];
+      if (Object.prototype.toString.call(value) === '[object String]') {
+        dest[key] = value;
+      } else {
+        if (dest[key] == null) dest[key] = {};
+        merge(dest[key], value);
+      }
+    }
+    return dest;
+  };
+
   // Set default days/months translations.
   var DATE = {
       day_names: ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
@@ -921,19 +935,10 @@
    * https://stackoverflow.com/questions/8157700/object-has-no-hasownproperty-method-i-e-its-undefined-ie8
    */
   I18n.extend = function ( obj1, obj2 ) {
-    var extended = {};
-    var prop;
-    for (prop in obj1) {
-      if (Object.prototype.hasOwnProperty.call(obj1, prop)) {
-        extended[prop] = obj1[prop];
-      }
-    }
-    for (prop in obj2) {
-      if (Object.prototype.hasOwnProperty.call(obj2, prop)) {
-        extended[prop] = obj2[prop];
-      }
+    if (typeof(obj1) === "undefined" && typeof(obj2) === "undefined") {
+      return {};
     }
-    return extended;
+    return merge(obj1, obj2);
   };
 
   // Set aliases, so we can save some typing.

data/lib/i18n/js/dependencies.rb

@@ -12,6 +12,10 @@ module I18n
           safe_gem_check("rails", "~> 4.0", ">= 4.0.0.beta1") && running_rails4?
         end
 
+        def rails5?
+          safe_gem_check("rails", "~> 5.0", ">= 5.0.0.beta1") && running_rails5?
+        end
+
         def sprockets_supports_register_preprocessor?
           defined?(Sprockets) && Sprockets.respond_to?(:register_preprocessor)
         end
@@ -24,9 +28,13 @@ module I18n
           safe_gem_check("rails", '>= 3.0.0.beta')
         end
 
+        # This cannot be called at class definition time
+        # Since not all libraries are loaded
+        #
+        # Call this in an initializer
         def using_asset_pipeline?
           assets_pipeline_available =
-            (rails3? || rails4?) &&
+            (rails3? || rails4? || rails5?) &&
             Rails.respond_to?(:application) &&
             Rails.application.respond_to?(:assets)
           rails3_assets_enabled =
@@ -34,7 +42,7 @@ module I18n
             assets_pipeline_available &&
             Rails.application.config.assets.enabled != false
 
-          assets_pipeline_available && (rails4? || rails3_assets_enabled)
+          assets_pipeline_available && (rails4? || rails5? || rails3_assets_enabled)
         end
 
         private
@@ -47,6 +55,10 @@ module I18n
           running_rails? && Rails.version.to_i == 4
         end
 
+        def running_rails5?
+          running_rails? && Rails.version.to_i == 5
+        end
+
         def running_rails?
           defined?(Rails) && Rails.respond_to?(:version)
         end

data/lib/i18n/js/engine.rb

@@ -2,39 +2,91 @@ require "i18n/js"
 
 module I18n
   module JS
+    # @api private
+    # The class cannot be private
+    class SprocketsExtension
+      # Actual definition is placed below
+    end
+
     class Engine < ::Rails::Engine
-      # `sprockets.environment` was used for 1.x of `sprockets-rails`
-      # https://github.com/rails/sprockets-rails/issues/227
-      #
-      # References for current values:
-      #
-      # Here is where sprockets are attached with Rails. There is no 'sprockets.environment' mentioned.
-      # https://github.com/rails/sprockets-rails/blob/master/lib/sprockets/railtie.rb
-      #
-      # Finisher hook is the place which should be used as border.
-      # http://guides.rubyonrails.org/configuring.html#initializers
-      #
-      # For detail see Pull Request:
-      # https://github.com/fnando/i18n-js/pull/371
-      initializer "i18n-js.register_preprocessor", after: :engines_blank_point, before: :finisher_hook do
-        next unless JS::Dependencies.using_asset_pipeline?
-        next unless JS::Dependencies.sprockets_supports_register_preprocessor?
-
-        # From README of 2.x & 3.x of `sprockets-rails`
-        # It seems the `configure` block is preferred way to call `register_preprocessor`
-        # Not sure if this will break older versions of rails
+      if JS::Dependencies.sprockets_supports_register_preprocessor?
+        # constant `Sprockets` should be available here after
+        # `.sprockets_supports_register_preprocessor?` called
+        sprockets_version = Gem::Version.new(Sprockets::VERSION).release
+        v2_only = Gem::Dependency.new("", " ~> 2")
+        v3_plus = Gem::Dependency.new("", " >= 3")
+
+        # See https://github.com/rails/sprockets/blob/master/guides/extending_sprockets.md#supporting-all-versions-of-sprockets-in-processors
+        # for reference of supporting multiple versions
+
+        # `sprockets.environment` was used for 1.x of `sprockets-rails`
+        # https://github.com/rails/sprockets-rails/issues/227
+        #
+        # References for current values:
+        #
+        # Here is where sprockets are attached with Rails. There is no 'sprockets.environment' mentioned.
+        # https://github.com/rails/sprockets-rails/blob/master/lib/sprockets/railtie.rb
         #
-        # https://github.com/rails/sprockets-rails/blob/v2.3.3/README.md
-        # https://github.com/rails/sprockets-rails/blob/v3.0.0/README.md
-        Rails.application.config.assets.configure do |config|
-          config.register_preprocessor "application/javascript", :"i18n-js_dependencies" do |context, source|
-            if context.logical_path == "i18n/filtered"
-              ::I18n.load_path.each {|path| context.depend_on(File.expand_path(path))}
-            end
-            source
+        # Finisher hook is the place which should be used as border.
+        # http://guides.rubyonrails.org/configuring.html#initializers
+        #
+        # For detail see Pull Request:
+        # https://github.com/fnando/i18n-js/pull/371
+        initializer_args = case sprockets_version
+        when -> (v) { v2_only.match?("", v) || v3_plus.match?("", v) }
+          { after: :engines_blank_point, before: :finisher_hook }
+        else
+          raise StandardError, "Sprockets version #{sprockets_version} is not supported"
+        end
+
+        initializer "i18n-js.register_preprocessor", initializer_args do
+          # This must be called inside initializer block
+          # For details see comments for `using_asset_pipeline?`
+          next unless JS::Dependencies.using_asset_pipeline?
+
+          # From README of 2.x & 3.x of `sprockets-rails`
+          # It seems the `configure` block is preferred way to call `register_preprocessor`
+          # Not sure if this will break older versions of rails
+          #
+          # https://github.com/rails/sprockets-rails/blob/v2.3.3/README.md
+          # https://github.com/rails/sprockets-rails/blob/v3.0.0/README.md
+          Rails.application.config.assets.configure do |config|
+            config.register_preprocessor(
+              "application/javascript",
+              ::I18n::JS::SprocketsExtension,
+            )
           end
         end
       end
     end
+
+    # @api private
+    class SprocketsExtension
+      def initialize(filename, &block)
+        @filename = filename
+        @source   = block.call
+      end
+
+      def render(context, empty_hash_wtf)
+        self.class.run(@filename, @source, context)
+      end
+
+      def self.run(filename, source, context)
+        if context.logical_path == "i18n/filtered"
+          ::I18n.load_path.each { |path| context.depend_on(File.expand_path(path)) }
+        end
+
+        source
+      end
+
+      def self.call(input)
+        filename = input[:filename]
+        source   = input[:data]
+        context  = input[:environment].context_class.new(input)
+
+        result = run(filename, source, context)
+        context.metadata.merge(data: result)
+      end
+    end
   end
 end

data/lib/i18n/js/version.rb

@@ -4,7 +4,7 @@ module I18n
       MAJOR = 3
       MINOR = 0
       PATCH = 0
-      STRING = "#{MAJOR}.#{MINOR}.#{PATCH}.rc13"
+      STRING = "#{MAJOR}.#{MINOR}.#{PATCH}.rc14"
     end
   end
 end

data/spec/js/extend.spec.js

@@ -38,4 +38,25 @@ describe("Extend", function () {
 
     expect(I18n.extend(obj1,obj2)).toEqual(expected);
   });
+
+  it("should merge deeply from obj1 with the same key of obj2", function() {
+    var obj1 = {
+      test1: {
+        test2: "abc"
+      }
+    }
+    , obj2 = {
+      test1: {
+        test3: "xyz"
+      }
+    }
+    , expected = {
+      test1: {
+        test2: "abc"
+        , test3: "xyz"
+      }
+    }
+
+    expect(I18n.extend(obj1, obj2)).toEqual(expected);
+  })
 });

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-js
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc13
+  version: 3.0.0.rc14
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-29 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -208,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: It's a small library to provide the Rails I18n translations on the Javascript.