l10n 1.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6644cfaf6aea0f30feeec78e291d9f5e8aa14533e768e0dfceb79848ffe596a8
-  data.tar.gz: 515e0717bcd5fd57b9f564551f0f0a6e275d017713023385a7c36459ac87b95f
+  metadata.gz: 983a6cc561859d662fc97347df35643e42444b6c996b1ff224a327a0fe5dfe77
+  data.tar.gz: f4baa0c9c30895603cec6ec75c93236d1a9b8668e7d3f0912b2ae5303093cabe
 SHA512:
-  metadata.gz: f1466c4890beff653f8614b0621095ce763c3512094086a61a1f38eb110e88d15661b3c4cc0c30b09db351b00d7a7f1824ef304c2f423af249425c87a542c82a
-  data.tar.gz: 97b95622153d130ecf0a36a2e7e7149ec31d45df3eb129170d037e9b612694c7c24400a267b9634614002a9da6350ed486ceb279ebbbb80d1a1a2eb7aa9a8aab
+  metadata.gz: 9856cc22286c2cf3ec0731c46e047024f9963efdfd957126d6a0f659c0c435d8625b22b1aa2e2e70722b869d7663845c8879568fccab9e567450d1bdd73dc7df
+  data.tar.gz: 21bbb3ac8f822c9c70e2ce90fa74917bc621e86ea77dfd4ec87fcadbaf8d7cc39d0af425618bf2cae46b1736878b7680c1aa0f171fbea184abd982c3872260bd

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+## 2.0.0 - Unreleased
+
+- Support Rails 7
+- use `to_lfs` instead of `to_formatted_s` which has been reclaimed by Rails
+- JS: move implementation to ES module, drop JavaScriptHelper
+- Inflections: drop ordinalization, provided by Rails now
+
+## 1.4.0 - 2018-06-21
+
+- Removing jQuery dependency from i18n javascript
+
+## 1.1.0 - 2014-12-09
+
+- Adding Time#l
+- Adding I18n support for JavaScript
+- Updating README

data/README.md

@@ -1,7 +1,10 @@
-[![Gem Version](https://badge.fury.io/rb/l10n.png)](http://badge.fury.io/rb/l10n) [![Build Status](https://travis-ci.org/mtgrosser/l10n.svg)](https://travis-ci.org/mtgrosser/l10n)
+[![Gem Version](https://badge.fury.io/rb/l10n.png)](http://badge.fury.io/rb/l10n)
+[![build](https://github.com/mtgrosser/l10n/actions/workflows/build.yml/badge.svg)](https://github.com/mtgrosser/l10n/actions/workflows/build.yml)
+
 # L10n - I18n that roarrrs
 
-L10n provides some useful extensions for Rails I18n, including column translations, localization of numeric form fields and JavaScript translation support.
+L10n provides some useful extensions for Rails I18n, including column translations,
+localization of numeric form fields and JavaScript translation support.
 
 ## Installation
 
@@ -98,18 +101,21 @@ I18n.locale = :de
 
 #### Formatting of numbers
 
-Calling `to_formatted_s` on `Numeric`s returns the number as a formatted string. The format is defined by the current locale and respects the decimal delimiters and separators defined in your `<locale>.yml`.
+Calling `to_lfs` on `Numeric`s returns the number as a localized formatted string.
+The format is defined by the current locale and respects the decimal delimiters
+and separators defined in your `<locale>.yml`.
 
 ```ruby
-I18n.as('de') { 1234.5.to_formatted_s } => "1.234,50"
-I18n.as('en') { 1234.5.to_formatted_s } => "1,234.50"
+I18n.as('de') { 1234.5.to_lfs } => "1.234,50"
+I18n.as('en') { 1234.5.to_lfs } => "1,234.50"
 ```
 
 This also works with `BigDecimal`s.
 
 #### Localization of decimal separator and delimiter for numbers
 
-Localization converts decimal separators and delimiters between locales without re-formatting strings. `to_localized_s` can be called on any object.
+Localization converts decimal separators and delimiters between locales without
+re-formatting strings. `to_localized_s` can be called on any object.
 
 ```ruby
 I18n.as('de') { 1234.5.to_localized_s } => "1.234,5"
@@ -125,7 +131,9 @@ I18n.as(:en) { Numeric.localize('1,234.50') } => "1,234.50"
 
 ### Automatic localization of numeric values in Rails forms and models
 
-The `amount_field` form helper automatically formats numbers in the current locale. Numeric columns automatically convert the localized strings into numbers, respecting decimal delimiters and separators.
+The `amount_field` form helper automatically formats numbers in the current locale.
+Numeric columns automatically convert the localized strings into numbers,
+respecting decimal delimiters and separators.
 
 ```ruby
 # in your template
@@ -145,7 +153,8 @@ I18n.locale = :en
 
 ### Accept-Language header parsing in ActionDispatch::Request
 
-The `Accept-Language` HTTP header will be parsed, and locales will be returned ordered by user preference. This comes in handy when setting the current locale in a `before_action`.
+The `Accept-Language` HTTP header will be parsed, and locales will be returned ordered
+by user preference. This comes in handy when setting the current locale in a `before_action`.
 
 ```ruby
 # in your controller
@@ -154,14 +163,15 @@ request.accept_locales => ["en-US", "en", "en-GB"]
 
 ### Javascript I18n, interpolation and pluralization
 
-If you need I18n support in your javascripts, require the `i18n` javascript from your `application.js`:
+Due to the many different options of integrating JavaScript, the `l10n.js` file
+is no longer provided as a standard Rails asset. Instead, it can be installed
+manually using
 
-```javascript
-/* application.js */
-//= require i18n
+```sh
+rake l10n:install:js
 ```
 
-The JS `String` prototype is extended with a `t()` function, supporting translation, pluralization and interpolation:
+Place your JavaScript translations below the `javascript` key:
 
 ```yaml
 # en.yml
@@ -174,14 +184,36 @@ en:
       other: '{count} apples'
 ```
 
+Import the module:
+
+```javascript
+import I18n from 'l10n';
+```
+
+Render the translations either as JSON via an endpoint, or include them in a
+`script` tag:
+
 ```ruby
-# in your application layout
-<%= i18n_script_tag %>
+I18n.t(:javascript).to_json
 ```
 
+Depending on the way the module is integrated, the translations can either be
+set on the `I18n` object:
+
+```javascript
+import I18n from 'l10n';
+window.I18n = I18n;
+I18n.translations = { "hello": "Hello {name}!", "apple": { "one": "{count} apple", "other": "{count} apples" } };
+
+I18n.t("hello", { name: "JS" }) => "Hello JS!"
+I18n.t("apple", { count: 5 }) => "5 apples"
+```
+
+or you can supply them as an argument to the `translate` function:
+
 ```javascript
-// in any javascript
-"hello".t({ name: "JS" }) => "Hello JS!"
+const translations = { "hello": "Hello {name}!", "apple": { "one": "{count} apple", "other": "{count} apples" } };
 
-"apple".t({ count: 5 }) => "5 apples"
+I18n.t("hello", { "name": "JS"}, translations)  => "Hello JS!"
+I18n.t("apple", { count: 5 }, translations) => "5 apples"
 ```

data/lib/install/install.rb

@@ -0,0 +1,2 @@
+say "Copy l10n.js to app/javascript"
+copy_file "#{__dir__}/l10n.js", "app/javascript/l10n.js"

data/lib/install/l10n.js

@@ -0,0 +1,45 @@
+const I18n = {
+  translate: function(str, options, data) {
+    options = options || {};
+    var fallback = options['fallback'] || ('Translation missing: ' + str);  // default is a JS reserved word
+    var translation, matches, method, match, interpolation_value;
+    var count = options['count'];
+    var keys = str.split('.');
+    var obj = data || this.translations;
+  
+    var isString = function(value) {
+      return typeof value === 'string' || value instanceof String;
+    };
+  
+    var isObject = function(value) {
+      return value && typeof value === 'object' && value.constructor === Object;
+    };
+  
+    while(obj && keys.length) obj = obj[keys.shift()];
+    if (obj) {
+      if (isObject(obj) && count !== undefined) {
+        translation = obj[1 == count ? 'one' : 'other'];
+      } else {
+        translation = obj;
+      }
+      if (isString(translation) && (matches = translation.match(/{\w+?}/g))) {
+        while(match = matches.shift()) {
+          method = match.substr(1, match.length - 2);
+          interpolation_value = options[method];
+          if (interpolation_value == undefined) interpolation_value = ('undefined interpolation value: ' + method);
+          translation = translation.replace(new RegExp(match, 'g'), interpolation_value);
+        }
+      }
+    }
+    return translation || fallback;
+  },
+  
+  t: function(str, options, data) {
+    return this.translate(str, options, data);
+  },
+  
+  translations: {}
+
+};
+
+export default I18n;

data/lib/l10n/core_extensions/date_time_ext.rb

@@ -1,8 +1,8 @@
 module L10n
   module CoreExtensions
     module DateTimeExt
-      def localize(*args)
-        I18n.l(self, *args)
+      def localize(*args, **kwargs)
+        I18n.l(self, *args, **kwargs)
       end
       alias :l :localize
     end

data/lib/l10n/core_extensions/numeric_ext.rb

@@ -25,14 +25,16 @@ module L10n
       end
       
       module Formatting
-        # un-deprecate method
-        def to_formatted_s(format = :rounded, options = nil)
+        def to_localized_formatted_s(format = :rounded, options = nil)
           if options.nil? && format.is_a?(Hash)
             options = format
             format = :rounded
           end
-          to_s(format, options || {})
+          options ||= {}
+          options[:locale] ||= I18n.locale
+          to_fs(format, options)
         end
+        alias_method :to_lfs, :to_localized_formatted_s
       end
       
     end
@@ -40,13 +42,7 @@ module L10n
 end
 
 Numeric.extend L10n::CoreExtensions::NumericExt::ClassMethods
-
-# Ruby 2.4+ unifies Fixnum & Bignum into Integer.
-numerics = 0.class == Integer ? [Integer] : [Fixnum, Bignum]
-numerics << Float
-numerics << Rational
-
-numerics.each do |klass|
+[Integer, Float, BigDecimal, Rational].each do |klass|
   klass.include L10n::CoreExtensions::NumericExt::Localization
   klass.prepend L10n::CoreExtensions::NumericExt::Formatting
 end

data/lib/l10n/core_extensions/object_ext.rb

@@ -8,4 +8,4 @@ module L10n
   end
 end
 
-Object.send :include, L10n::CoreExtensions::ObjectExt
+Object.include L10n::CoreExtensions::ObjectExt

data/lib/l10n/forms.rb

@@ -3,6 +3,7 @@ module L10n
     module FormBuilder
       
       def amount_field(field, options = {})
+        options = objectify_options(options)
         format_options = options.extract!(:locale, :precision, :significant, :separator, :delimiter, :strip_insignificant_zeros)
         value = L10n.number_to_rounded(object.public_send(field), format_options)
         options[:value] = value

data/lib/l10n/i18n_extensions.rb

@@ -92,4 +92,4 @@ module L10n
   end
 end
 
-I18n.send :include, L10n::I18nExtensions
+I18n.include L10n::I18nExtensions

data/lib/l10n/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails/engine'
+
+class L10n::Railtie < Rails::Railtie
+  initializer 'l10n' do |app|
+    
+  end
+  
+  rake_tasks do
+    load Pathname.new(__FILE__).dirname.join('..', 'tasks', 'l10n.rake')
+  end
+end

data/lib/l10n/version.rb

@@ -1,3 +1,3 @@
 module L10n
-  VERSION = '1.6.0'
+  VERSION = '2.0.0'
 end

data/lib/l10n.rb

@@ -6,19 +6,22 @@ require 'action_dispatch'
 require 'active_support/all'
 
 require_relative 'l10n/version'
-require_relative 'l10n/core_extensions'
+require_relative 'l10n/core_extensions/object_ext'
+require_relative 'l10n/core_extensions/string_ext'
+require_relative 'l10n/core_extensions/symbol_ext'
+require_relative 'l10n/core_extensions/date_time_ext'
+require_relative 'l10n/core_extensions/numeric_ext'
 require_relative 'l10n/i18n_extensions'
-require_relative 'l10n/inflections'
+#require_relative 'l10n/inflections'
 require_relative 'l10n/numeric_column_conversions'
 require_relative 'l10n/column_translation'
 require_relative 'l10n/translation_validator'
 require_relative 'l10n/forms'
-require_relative 'l10n/javascript_helper'
 require_relative 'l10n/request'
-require_relative 'l10n/engine'
+require_relative 'l10n/railtie'
 
-files = Dir[File.join(File.dirname(__FILE__), 'locales/*.yml')]
-I18n.load_path.concat(files)
+#files = Dir[File.join(File.dirname(__FILE__), 'locales/*.yml')]
+#I18n.load_path.concat(files)
 
 module L10n
   

data/lib/tasks/l10n.rake

@@ -0,0 +1,8 @@
+namespace :l10n do
+  namespace :install do
+    desc 'Copy the l10n.js file to assets'
+    task :js do
+      system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/install.rb",  __dir__)}"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: l10n
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Matthias Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-15 00:00:00.000000000 Z
+date: 2022-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -30,167 +30,108 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.7
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: '7.1'
 description: Extensions for Rails I18n
 email: mtgrosser@gmx.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG
-- MIT-LICENSE
+- CHANGELOG.md
+- LICENSE
 - README.md
-- app/assets/javascripts/i18n.js
+- lib/install/install.rb
+- lib/install/l10n.js
 - lib/l10n.rb
 - lib/l10n/column_translation.rb
-- lib/l10n/core_extensions.rb
-- lib/l10n/core_extensions/big_decimal_ext.rb
 - lib/l10n/core_extensions/date_time_ext.rb
 - lib/l10n/core_extensions/numeric_ext.rb
 - lib/l10n/core_extensions/object_ext.rb
 - lib/l10n/core_extensions/string_ext.rb
 - lib/l10n/core_extensions/symbol_ext.rb
-- lib/l10n/engine.rb
 - lib/l10n/forms.rb
 - lib/l10n/i18n_extensions.rb
 - lib/l10n/inflections.rb
-- lib/l10n/javascript_helper.rb
 - lib/l10n/numeric_column_conversions.rb
 - lib/l10n/numericality_validator.rb
+- lib/l10n/railtie.rb
 - lib/l10n/request.rb
 - lib/l10n/translation_validator.rb
 - lib/l10n/version.rb
-- lib/locales/de.yml
-- lib/locales/en.yml
+- lib/tasks/l10n.rake
 homepage: https://github.com/mtgrosser/l10n
 licenses:
 - MIT
@@ -210,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Make I18n roar again

data/CHANGELOG

@@ -1,9 +0,0 @@
-* 1.4.0 - 2018-06-21
-
-- Removing jQuery dependency from i18n javascript
-
-* 1.1.0 - 2014-12-09
-
-- Adding Time#l
-- Adding I18n support for JavaScript
-- Updating README

data/app/assets/javascripts/i18n.js

@@ -1,42 +0,0 @@
-var I18n = I18n || {};
-
-I18n.translate = function(str, options) {
-  options = options || {};
-  var fallback = options['fallback'] || ('Translation missing: ' + str);  // default is a JS reserved word
-  var translation, matches, method, match, interpolation_value;
-  var count = options['count'];
-  var keys = str.split('.');
-  var obj = this.translations;
-  
-  var isString = function(value) {
-    return typeof value === 'string' || value instanceof String;
-  };
-  
-  var isObject = function(value) {
-    return value && typeof value === 'object' && value.constructor === Object;
-  };
-  
-  while(obj && keys.length) obj = obj[keys.shift()];
-  if (obj) {
-    if (isObject(obj) && count !== undefined) {
-      translation = obj[1 == count ? 'one' : 'other'];
-    } else {
-      translation = obj;
-    }
-    if (isString(translation) && (matches = translation.match(/{\w+?}/g))) {
-      while(match = matches.shift()) {
-        method = match.substr(1, match.length - 2);
-        interpolation_value = options[method];
-        if (interpolation_value == undefined) interpolation_value = ('undefined interpolation value: ' + method);
-        translation = translation.replace(new RegExp(match, 'g'), interpolation_value);
-      }
-    }
-  }
-  return translation || fallback;
-};
-
-I18n.t = function(str, options) {
-  return this.translate(str, options);
-};
-
-String.prototype.t = function(options){ return(I18n.translate(this, options)); }

data/lib/l10n/core_extensions/big_decimal_ext.rb

@@ -1,17 +0,0 @@
-module L10n
-  module CoreExtensions
-    module BigDecimalExt
-
-      def to_localized_s
-        Numeric.localize(self)
-      end
-
-      def to_formatted_s(*args)
-        L10n.number_to_rounded(self, *args)
-      end
-
-    end
-  end
-end
-
-BigDecimal.prepend L10n::CoreExtensions::BigDecimalExt

data/lib/l10n/core_extensions.rb

@@ -1,6 +0,0 @@
-require 'l10n/core_extensions/object_ext'
-require 'l10n/core_extensions/string_ext'
-require 'l10n/core_extensions/symbol_ext'
-require 'l10n/core_extensions/date_time_ext'
-require 'l10n/core_extensions/numeric_ext'
-require 'l10n/core_extensions/big_decimal_ext'

data/lib/l10n/engine.rb

@@ -1,7 +0,0 @@
-require 'rails/engine'
-
-module L10n
-  class Engine < ::Rails::Engine
-    
-  end
-end

data/lib/l10n/javascript_helper.rb

@@ -1,17 +0,0 @@
-module L10n
-  module JavaScriptHelper
-  
-    def i18n_script_tag
-      javascript_tag %<
-      var I18n = I18n || {};
-      
-      I18n.locale = function() {
-        return("#{I18n.locale}");
-      };
-      
-      I18n.translations = #{I18n.t(:javascript).to_json};
-      >
-    end
-    
-  end
-end

data/lib/locales/de.yml

@@ -1,8 +0,0 @@
-de:
-  i18n:
-    inflections:
-      ordinals:
-        first: .
-        second: .
-        third: .
-        other: .

data/lib/locales/en.yml

@@ -1,9 +0,0 @@
-en:
-  i18n:
-    inflections:
-      ordinals:
-        first: st
-        second: nd
-        third: rd
-        other: th
-