isomorfeus-i18n 2.0.22 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea4c7508a819349ad06e7734619f4bfe04f1d363c28c0f4bd3a9ee18f36431c8
-  data.tar.gz: f1d42b7a8a84c355ff9593560322c9d96419485b5c5434cce739ec2872ab71c5
+  metadata.gz: f0410bb425f90fed0d145096eb7b18ba67e3afb30939fec3234825cdf7920868
+  data.tar.gz: a6371b92807bb6928a3978da8b6ff0e63b942a437bf1ccd868a0c559271c840f
 SHA512:
-  metadata.gz: 16c8f5808eb7942319deed94211942f393bd348c9cf216d6e6e8d3c1e296467c615f44ab8c48dfa5acc5a9c8733c06a97d9e5a379112d3344418f75860e99e29
-  data.tar.gz: 424514deaa3ca4d5f0e5165bfb56de9a886bfabd16835acc41e817b13244d67b47ffb393384ee522f81c7899df8082cef029be0ed1e825b825e611bf958877a0
+  metadata.gz: 75eaaf56f00a678735d0ad85c502862c218fe720692e071ddeb62f2750744cdeb974c6f713632c8feb1361446c662e9bc62dac303768fedfdca5fda4f0ed808d
+  data.tar.gz: 8cae156462b749e6b569c31c2caf060ac164f4165963f38090443bab8f08ddb1c16260e413be9a9d27105ec0e247dc432b45a6f2a04359bb79fae45b86403cb4

data/README.md

@@ -11,12 +11,72 @@ Supported formats: .mo, .po, .yml
 
 Using fast_gettext internally.
 
-## Usage
+## Translation
 
 In any class:
 ```
-  include LucidTranslation::Mixin
+  include LucidI18n::Mixin
 ```
-
 after which the _ gettext methods are available for translation.
-See https://github.com/grosser/fast_gettext and https://rubydoc.info/gems/gettext/
+See the [fast_gettext documentation](https://github.com/grosser/fast_gettext) or the
+[gettext documentation](https://rubydoc.info/gems/gettext/).
+
+Also available is the `current_locale` helper, which provides the current locale as string, as it has been negotiated between browser and server.
+
+## Localization
+
+In any class:
+```
+  include LucidI18n::Mixin
+```
+after which the l method is available, which currently can localize Times, Dates and numbers.
+See the [R18n core documentation](https://github.com/r18n/r18n-core)
+
+Only the :full and :standard options are supported for the l method in all environments.
+
+However, output may slightly differ between server and browser and also between browsers, depending on actual browser locale and implementation.
+For most consistent and best results its best to format dates and numbers for display only within components in server side rendering or in the browser.
+
+Within components, the l method allows for additional options for Date and Time objects:
+```ruby
+# signature
+l(object, format = :standard, options = {})
+```
+Here format can be:
+- :standard or :full, which try to be consistent with r18n options
+and in addition:
+- :custom, which passes the options hash along for formatting to the browser or node functions.
+The following options are available for date/time formating:
+- locale: locale string like 'de'
+- time_zone or timeZone: timezone string like 'CET'
+- time_zone_name or timeZoneName: "long" "short"
+- date_style or dateStyle: "full" "long" "medium" "short"
+- time_style or timeStyle: "full" "long" "medium" "short"
+- format_matcher or formatMatcher: "best-fit"(default) "basic"
+- locale_matcher or localeMatcher: "best-fit"(default) "lookup"
+- hour12: false true
+- hour_cycle hourCycle: "h11" "h12" "h23" "h24"
+- hour:	   "2-digit" "numeric"
+- minute:	 "2-digit" "numeric"
+- second:	 "2-digit" "numeric"
+- day	     "2-digit" "numeric"
+- month:   "2-digit" "numeric" "long" "short" "narrow"
+- weekday:                     "long" "short" "narrow"
+- year:	   "2-digit" "numeric"
+For formatting numbers the options are available:
+- currency: any currency code (like "EUR", "USD", "INR", etc.)
+- currency_display or currencyDisplay: "symbol"(default) "code" "name"
+- locale_matcher or localeMatcher: "best-fit"(default) "lookup"
+- maximum_fraction_digits or maximumFractionDigits: A number from 0 to 20 (default is 3)
+- maximum_significant_digits or maximumSignificantDigits: A number from 1 to 21 (default is 21)
+- minimum_fraction_digits or minimumFractionDigits: A number from 0 to 20 (default is 3)
+- minimum_integer_digits or minimumIntegerDigits:	A number from 1 to 21 (default is 1)
+- minimum_significant_digits or minimumSignificantDigits:	A number from 1 to 21 (default is 21)
+- style: "decimal"(default) "currency" "percent"
+- use_grouping or useGrouping: true(default) false
+
+example:
+```ruby
+l(Time.now, :custom, { hour12: true })
+l(1.2345, :custom, { maximum_fraction_digits: 2 })
+```

data/lib/isomorfeus/i18n/config.rb

@@ -19,24 +19,18 @@ module Isomorfeus
         domain
       end
 
-      def locale
+      def default_locale
         result = Redux.fetch_by_path(:i18n_state, :locale)
         result ? result : available_locales.first
       end
 
-      def locale=(loc)
+      def default_locale=(loc)
         Isomorfeus.raise_error(message: "Locale #{loc} not available!") unless available_locales.include?(loc)
-        Isomorfeus.store.dispatch(type: 'I18N_LOAD', data: { locale: locale })
+        Isomorfeus.store.dispatch(type: 'I18N_LOAD', data: { locale: loc })
         loc
       end
 
-      def negotiated_locale
-        @negotiated_locale
-      end
-
-      def negotiated_locale=(l)
-        @negotiated_locale = l
-      end
+      attr_accessor :current_locale
     else
       def available_locales
         @available_locales
@@ -56,14 +50,26 @@ module Isomorfeus
         @i18n_domain = domain
       end
 
-      def locale
-        @locale
+
+      def current_locale
+        Thread.current[:isomorfeus_locale]
+      end
+
+      def current_locale=(loc)
+        FastGettext.locale = loc
+        R18n.thread_set(loc)
+        Thread.current[:isomorfeus_locale] = loc
+      end
+
+      def default_locale
+        @default_locale
       end
 
-      def locale=(loc)
+      def default_locale=(loc)
         Isomorfeus.raise_error(message: "Locale #{loc} not available!") unless available_locales.include?(loc)
         FastGettext.locale = loc
-        @locale = loc
+        R18n.set(loc)
+        @default_locale = loc
       end
 
       def locale_path

data/lib/isomorfeus/i18n/handler/locale_handler.rb

@@ -17,9 +17,9 @@ module Isomorfeus
               response_agent.agent_result['data'] = { 'available_locales' => FastGettext.available_locales,
                                                       'domain' => FastGettext.text_domain }
               response_agent.agent_result['data']['locale'] = if Isomorfeus.available_locales.include?(locale)
-                                                                locale
+                                                                Isomorfeus.current_locale = locale
                                                               else
-                                                                FastGettext.locale
+                                                                Isomorfeus.current_locale = Isomorfeus.default_locale
                                                               end
             else
               response_agent.agent_result[domain] = {}
@@ -31,7 +31,13 @@ module Isomorfeus
                 FastGettext.with_domain(domain) do
                   response_agent.request[domain].each_key do |locale|
                     response_agent.agent_result[domain][locale] = {}
-                    Isomorfeus.raise_error(message: "Locale #{locale} not available!") unless Isomorfeus.available_locales.include?(locale)
+                    if Isomorfeus.current_locale != locale
+                      if Isomorfeus.available_locales.include?(locale)
+                        Isomorfeus.current_locale = locale
+                      else
+                        Isomorfeus.raise_error(message: "Locale #{locale} not available!")
+                      end
+                    end
                     FastGettext.with_locale(locale) do
                       response_agent.request[domain][locale].each_key do |locale_method|
                         method_args = response_agent.request[domain][locale][locale_method]

data/lib/isomorfeus/i18n/init.rb

@@ -11,13 +11,17 @@ module Isomorfeus
             @initialized = false
             if Isomorfeus.on_browser?
               root_element = `document.querySelector('div[data-iso-root]')`
-              Isomorfeus.negotiated_locale = root_element.JS.getAttribute('data-iso-nloc') if root_element
+              if root_element
+                Isomorfeus.current_locale = root_element.JS.getAttribute('data-iso-nloc')
+              else
+                Isomorfeus.current_locale = Isomorfeus.default_locale
+              end
             end
             self.init_promise = init_from_server
           end
 
           def init_from_server
-            Isomorfeus::Transport.promise_send_path('Isomorfeus::I18n::Handler::LocaleHandler', :init, Isomorfeus.negotiated_locale).then do |agent|
+            Isomorfeus::Transport.promise_send_path('Isomorfeus::I18n::Handler::LocaleHandler', :init, Isomorfeus.current_locale).then do |agent|
               agent.process do
                 @initializing = false
                 Isomorfeus.store.dispatch(type: 'I18N_LOAD', data: agent.response[:data])
@@ -27,7 +31,7 @@ module Isomorfeus
           end
 
           def reload_from_server
-            Isomorfeus::Transport.promise_send_path('Isomorfeus::I18n::Handler::LocaleHandler', :init, Isomorfeus.negotiated_locale).then do |agent|
+            Isomorfeus::Transport.promise_send_path('Isomorfeus::I18n::Handler::LocaleHandler', :init, Isomorfeus.current_locale).then do |agent|
               agent.process do
                 Isomorfeus.store.dispatch(type: 'I18N_STATE', set_state: agent.response[:data])
               end
@@ -42,7 +46,6 @@ module Isomorfeus
             FastGettext.add_text_domain(Isomorfeus.i18n_domain, path: Isomorfeus.locale_path, type: Isomorfeus.i18n_type)
             FastGettext.available_locales = Isomorfeus.available_locales
             FastGettext.text_domain = Isomorfeus.i18n_domain
-            FastGettext.locale = Isomorfeus.locale
             Thread.current[:isomorfeus_i18n_initialized] = true
           end
         end

data/lib/isomorfeus/i18n/middleware.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Isomorfeus
+  module I18n
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        locale = env.http_accept_language.preferred_language_from(Isomorfeus.available_locales) ||
+                   env.http_accept_language.compatible_language_from(Isomorfeus.available_locales) ||
+                   Isomorfeus.default_locale
+        Isomorfeus.current_locale = locale if Isomorfeus.current_locale != locale
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/isomorfeus/i18n/version.rb

@@ -1,5 +1,5 @@
 module Isomorfeus
   module I18n
-    VERSION = '2.0.22'
+    VERSION = '2.1.0'
   end
 end

data/lib/isomorfeus-i18n.rb

@@ -4,7 +4,7 @@ if RUBY_ENGINE == 'opal'
   require 'isomorfeus/i18n/config'
   require 'isomorfeus/i18n/reducer'
   Isomorfeus::I18n::Reducer.add_reducer_to_store
-  require 'lucid_translation/mixin'
+  require 'lucid_i18n/mixin'
   require 'isomorfeus/i18n/init'
   if Isomorfeus.on_browser?
     Isomorfeus.add_client_init_after_store_class_name('Isomorfeus::I18n::Init')
@@ -14,6 +14,7 @@ if RUBY_ENGINE == 'opal'
 else
   require 'active_support'
   require 'oj'
+  require 'r18n-core'
   require 'fast_gettext'
   require 'isomorfeus/fast_gettext_cache'
   require 'http_accept_language/parser'
@@ -21,10 +22,12 @@ else
   require 'isomorfeus-data'
   require 'isomorfeus/i18n/config'
   require 'isomorfeus/i18n/init'
-  require 'lucid_translation/mixin'
+  require 'lucid_i18n/mixin'
   require 'isomorfeus/i18n/handler/locale_handler'
+  require 'isomorfeus/i18n/middleware'
 
   Isomorfeus.add_middleware(HttpAcceptLanguage::Middleware)
+  Isomorfeus.insert_middleware_after(HttpAcceptLanguage::Middleware, Isomorfeus::I18n::Middleware)
 
   require 'iso_opal'
   Opal.append_path(__dir__.untaint) unless IsoOpal.paths.include?(__dir__.untaint)
@@ -62,9 +65,9 @@ else
   Isomorfeus.available_locales = ['en'] if Isomorfeus.available_locales.empty?
 
   if Isomorfeus.available_locales.include?('en')
-    Isomorfeus.locale = 'en'
+    Isomorfeus.default_locale = 'en'
   else
-    Isomorfeus.locale = Isomorfeus.available_locales.first
+    Isomorfeus.default_locale = Isomorfeus.available_locales.first
   end
 
   Isomorfeus.i18n_domain = 'app'

data/lib/{lucid_translation → lucid_i18n}/mixin.rb

@@ -1,14 +1,18 @@
-module LucidTranslation
+module LucidI18n
   module Mixin
     CONTEXT_SEPARATOR = "\004"
     NAMESPACE_SEPARATOR = '|'
     NIL_BLOCK = -> { nil }
     TRANSLATION_METHODS = [:_, :n_, :np_, :ns_, :p_, :s_]
 
+    def current_locale
+      Isomorfeus.current_locale
+    end
+
     if RUBY_ENGINE == 'opal'
       def _(*keys, &block)
         domain = Isomorfeus.i18n_domain
-        locale = Isomorfeus.locale
+        locale = Isomorfeus.current_locale
         Isomorfeus.raise_error(message: "I18n _(): no key given!") if keys.empty?
         result = Redux.fetch_by_path(:i18n_state, domain, locale, '_', keys)
         return result if result
@@ -18,7 +22,7 @@ module LucidTranslation
 
       def n_(*keys, count, &block)
         domain = Isomorfeus.i18n_domain
-        locale = Isomorfeus.locale
+        locale = Isomorfeus.current_locale
         Isomorfeus.raise_error(message: "I18n n_(): no key given!") if keys.empty?
         result = Redux.fetch_by_path(:i18n_state, domain, locale, 'n_', keys + [count])
         return result if result
@@ -35,7 +39,7 @@ module LucidTranslation
 
       def ns_(*args, &block)
         domain = Isomorfeus.i18n_domain
-        locale = Isomorfeus.locale
+        locale = Isomorfeus.current_locale
         Isomorfeus.raise_error(message: "I18n ns_(): no args given!") if args.empty?
         result = Redux.fetch_by_path(:i18n_state, domain, locale, 'ns_', args)
         return result if result
@@ -45,7 +49,7 @@ module LucidTranslation
 
       def p_(namespace, key, separator = nil, &block)
         domain = Isomorfeus.i18n_domain
-        locale = Isomorfeus.locale
+        locale = Isomorfeus.current_locale
         args = separator ? [namespace, key, separator] : [namespace, key]
         result = Redux.fetch_by_path(:i18n_state, domain, locale, 'p_', args)
         return result if result
@@ -55,7 +59,7 @@ module LucidTranslation
 
       def s_(key, separator = nil, &block)
         domain = Isomorfeus.i18n_domain
-        locale = Isomorfeus.locale
+        locale = Isomorfeus.current_locale
         args = separator ? [key, separator] : [key]
         result = Redux.fetch_by_path(:i18n_state, domain, locale, 's_', args)
         return result if result
@@ -84,7 +88,7 @@ module LucidTranslation
 
         define_method("D#{method}") do |*args, &block|
           domain = Isomorfeus.i18n_domain
-          locale = Isomorfeus.locale
+          locale = Isomorfeus.current_locale
           Isomorfeus.raise_error(message: "I18n D#{method}(): no args given!") if args.empty?
           result = Redux.fetch_by_path(:i18n_state, domain, locale, "D#{method}", args)
           return result if result
@@ -93,6 +97,74 @@ module LucidTranslation
         end
       end
 
+      def l(object, format = :standard, options = {})
+        c_name = object.class.to_s
+        locale = options.delete(:locale) { Isomorfeus.current_locale }
+        options = options.transform_keys { |k| `Opal.Preact.lower_camelize(k)` }
+        if object.is_a?(Numeric)
+          # options for number formatting:
+          # locale: locale string like 'de'
+          # currency: any currency code (like "EUR", "USD", "INR", etc.)
+          # currency_display or currencyDisplay: "symbol"(default) "code" "name"
+          # locale_matcher or localeMatcher: "best-fit"(default) "lookup"
+          # maximum_fraction_digits or maximumFractionDigits: A number from 0 to 20 (default is 3)
+          # maximum_significant_digits or maximumSignificantDigits: A number from 1 to 21 (default is 21)
+          # minimum_fraction_digits or minimumFractionDigits: A number from 0 to 20 (default is 3)
+          # minimum_integer_digits or minimumIntegerDigits:	A number from 1 to 21 (default is 1)
+          # minimum_significant_digits or minimumSignificantDigits:	A number from 1 to 21 (default is 21)
+          # style: "decimal"(default) "currency" "percent"
+          # use_grouping or useGrouping: true(default) false
+          `(object).toLocaleString(locale, #{options.to_n})`
+        elsif c_name == 'Date' || c_name == 'DateTime'
+          # options for date/time formating:
+          # format: "standard" "full"
+          # locale: locale string like 'de'
+          # time_zone or timeZone: timezone string like 'CET'
+          # time_zone_name or timeZoneName: "long" "short"
+          # date_style or dateStyle: "full" "long" "medium" "short"
+          # time_style or timeStyle: "full" "long" "medium" "short"
+          # format_matcher or formatMatcher: "best-fit"(default) "basic"
+          # locale_matcher or localeMatcher: "best-fit"(default) "lookup"
+          # hour12: false true
+          # hour_cycle hourCycle: "h11" "h12" "h23" "h24"
+          # hour:	   "2-digit" "numeric"
+          # minute:	 "2-digit" "numeric"
+          # second:	 "2-digit" "numeric"
+          # day	     "2-digit" "numeric"
+          # month:   "2-digit" "numeric" "long" "short" "narrow"
+          # weekday:                     "long" "short" "narrow"
+          # year:	   "2-digit" "numeric"
+          native_object = object.to_n
+          case format
+          when :standard
+            `native_object.toLocaleDateString(locale, #{options.to_n})`
+          when :full
+            options[:dateStyle] = 'long'
+            `native_object.toLocaleDateString(locale, #{options.to_n})`
+          when :custom
+            `native_object.toLocaleString(locale, #{options.to_n})`
+          else
+            `native_object.toLocaleDateString(locale, #{options.to_n})`
+          end
+        elsif c_name == 'Time'
+          native_object = object.to_n
+          case format
+          when :standard
+            `native_object.toLocaleString(locale, #{options.to_n})`
+          when :full
+            options[:dateStyle] = 'long'
+            options[:timeStyle] = 'short'
+            `native_object.toLocaleString(locale, #{options.to_n})`
+          when :custom
+            `native_object.toLocaleString(locale, #{options.to_n})`
+          else
+            `native_object.toLocaleString(locale, #{options.to_n})`
+          end
+        else
+          raise "Unknown object type #{object.class} given to #l!"
+        end
+      end
+
       private
 
       def _promise_send_i18n_method(domain, locale, method, args)
@@ -120,12 +192,17 @@ module LucidTranslation
           end
         end
       end
-    else
+    else # RUBY_ENGINE
       class InternalTranslationProxy
         extend FastGettext::Translation
         extend FastGettext::TranslationMultidomain
       end
 
+      def l(object, format = :standard, _options = {})
+        Isomorfeus::I18n::Init.init unless Thread.current[:isomorfeus_i18n_initialized] == true
+        R18n.l(object, format)
+      end
+
       TRANSLATION_METHODS.each do |method|
         define_method(method) do |domain, *args, &block|
           Isomorfeus::I18n::Init.init unless Thread.current[:isomorfeus_i18n_initialized] == true
@@ -142,6 +219,6 @@ module LucidTranslation
           InternalTranslationProxy.send("D#{method}", *args, &block)
         end
       end
-    end
+    end # RUBY_ENGINE
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isomorfeus-i18n
 version: !ruby/object:Gem::Version
-  version: 2.0.22
+  version: 2.1.0
 platform: ruby
 authors:
 - Jan Biedermann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-12 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -100,28 +100,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.9
+        version: 0.14.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.9
+        version: 0.14.10
 - !ruby/object:Gem::Dependency
   name: isomorfeus-preact
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.6.31
+        version: 10.6.34
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.6.31
+        version: 10.6.34
 - !ruby/object:Gem::Dependency
   name: isomorfeus-redux
   requirement: !ruby/object:Gem::Requirement
@@ -142,42 +142,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.22
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.22
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: isomorfeus-data
+  name: r18n-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.22
+        version: 5.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.22
+        version: 5.0.1
 - !ruby/object:Gem::Dependency
   name: isomorfeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.22
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.22
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -219,9 +219,10 @@ files:
 - lib/isomorfeus/i18n/config.rb
 - lib/isomorfeus/i18n/handler/locale_handler.rb
 - lib/isomorfeus/i18n/init.rb
+- lib/isomorfeus/i18n/middleware.rb
 - lib/isomorfeus/i18n/reducer.rb
 - lib/isomorfeus/i18n/version.rb
-- lib/lucid_translation/mixin.rb
+- lib/lucid_i18n/mixin.rb
 homepage: https://isomorfeus.com
 licenses:
 - MIT