singleton-client-test 0.7.7.6 → 0.7.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bd55bdad7f46bf9c0cffd42a710cfb6dcae97ecadbbb148af41d2b44be0afca
-  data.tar.gz: 026ef3a390e9a88691decb97b1131ac31e358c9ede7628a7b698d38899a80465
+  metadata.gz: 71f20276ef709f5a183ab1e6572f171bfe9e5cdb0d0f09decea0fdb2e3aa2e88
+  data.tar.gz: 1eeebcc0cc3a964c90a00523fdda8aae09d3dc69ddc51af658c6218eb8e97c05
 SHA512:
-  metadata.gz: 5792e7d5f543603927732321cf440be37266fdc5a65fdd6075017068bb98fd9e5b8b4c52e8421fb0508166997993117d6c151921243b642ea448fb5ceea2e542
-  data.tar.gz: 7a8938ba9ffe0b6480a4b83e441b48d48eec98f5e2262019ff5db001e94fe50d404cc3c4277e464cab90ab7141076223b370d2c3a733058d95eecd940f8d8e88
+  metadata.gz: cd7cd9a1b977ddfd9110758b997c26bda3d8f2507f95036c87db24e130b7249f9c57871ce7f46c45827c810f0c7dd991b36dde656d3ce8a809e9ef4792554a65
+  data.tar.gz: 1d8c12a9f7dc6c65ebddcdf1eef50907cd8838a38a0c1a4c98c7001b4b9c77c55c5486d109fc7d9aca01c2c85c99e658ab381e8f2994e7818c73eb3d2a220295

data/lib/sgtn-client/api/translation.rb

@@ -39,55 +39,57 @@ module SgtnClient
         get_translations(component, locale)
       end
 
-      def translate(key, component, locale = nil, **kwargs)
+      def get_translation!(key, component, locale)
+        [get_bundle!(component, locale)[key], locale]
+      end
+
+      def translate(key, component, locale = nil, **kwargs, &block)
+        translate!(key, component, locale, **kwargs, &block)
+      rescue StandardError => e
+        SgtnClient.logger.debug { "[#{method(__callee__).owner}.#{__callee__}] {#{key}, #{component}, #{locale}}. #{e}" }
+        key
+      end
+      alias t translate
+
+      # raise error when translation is not found
+      def translate!(key, component, locale = nil, **kwargs, &block)
         SgtnClient.logger.debug { "[#{method(__callee__).owner}.#{__callee__}] key: #{key}, component: #{component}, locale: #{locale}, args: #{kwargs}" }
 
         begin
           best_match_locale = LocaleUtil.get_best_locale(locale || SgtnClient.locale, component)
-          messages, actual_locale = get_bundle_with_fallback(component, best_match_locale)
-          result = messages&.fetch(key, nil)
+          result, actual_locale = get_translation!(key, component, best_match_locale)
         rescue StandardError => e
-          SgtnClient.logger.debug { "[#{method(__callee__).owner}.#{__callee__}] translation is missing. {#{key}, #{component}, #{locale}}. #{e}" }
-          result = nil
+          raise e if block.nil?
         end
-
         if result.nil?
-          return key unless block_given?
+          raise SingletonError, 'translation is missing.' if block.nil?
 
-          result = yield
+          result = block.call
           return if result.nil?
         end
 
-        if kwargs.empty?
-          result
-        else
-          result.localize(actual_locale) % kwargs
-        end
+        kwargs.empty? ? result : result.localize(actual_locale) % kwargs
       end
-      alias t translate
+      alias t! translate!
 
       def get_translations(component, locale = nil)
+        get_translations!(component, locale)
+      rescue StandardError => e
+        SgtnClient.logger.error "[#{method(__callee__).owner}.#{__callee__}] {#{component}, #{locale}}. #{e}"
+        nil
+      end
+
+      def get_translations!(component, locale = nil)
         SgtnClient.logger.debug { "[#{method(__callee__).owner}.#{__callee__}] component: #{component}, locale: #{locale}" }
 
         best_match_locale = LocaleUtil.get_best_locale(locale || SgtnClient.locale, component)
-        messages, actual_locale = get_bundle_with_fallback(component, best_match_locale)
+        messages = get_bundle!(component, best_match_locale)
 
-        { 'component' => component, 'locale' => actual_locale, 'messages' => messages } if messages
-      rescue StandardError => e
-        SgtnClient.logger.error "[#{method(__callee__).owner}.#{__callee__}] translations are missing. {#{component}, #{locale}}. #{e}"
-        nil
+        { 'component' => component, 'locale' => best_match_locale, 'messages' => messages } if messages
       end
 
       private
 
-      def get_bundle(component, locale)
-        get_bundle!(component, locale)
-      rescue StandardError => e
-        SgtnClient.logger.error "[#{method(__callee__).owner}.#{__callee__}] failed to get a bundle. component: #{component}, locale: #{locale}"
-        SgtnClient.logger.error e
-        nil
-      end
-
       def get_bundle!(component, locale)
         SgtnClient.config.loader.get_bundle(component, locale)
       rescue StandardError
@@ -98,20 +100,9 @@ module SgtnClient
         SgtnClient.config.notify_observers(:available_locales, component)
         raise
       end
-
-      def get_bundle_with_fallback(component, locale)
-        messages = get_bundle(component, locale)
-        return messages, locale if messages
-
-        LocaleUtil.locale_fallbacks.each do |l|
-          next if l == locale
-
-          messages = get_bundle(component, l)
-          return messages, l if messages
-        end
-      end
     end
 
     extend Implementation
+    extend Fallbacks
   end
 end

data/lib/sgtn-client/common/data.rb

@@ -43,7 +43,7 @@ module SgtnClient
       end
 
       def self.age
-        @age ||= SgtnClient.config.cache_expiry_period * 60
+        @age ||= (SgtnClient.config.cache_expiry_period || 24 * 60) * 60
       end
     end
 

data/lib/sgtn-client/fallbacks.rb

@@ -0,0 +1,38 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
+module SgtnClient
+  module Fallbacks # :nodoc:
+    def get_translation!(key, component, locale)
+      error = nil
+      localechain(locale) do |l|
+        return super(key, component, l)
+      rescue StandardError => e
+        error = e
+      end
+      raise error if error
+    end
+
+    def get_translations!(component, locale = nil)
+      error = nil
+      localechain(locale) do |l|
+        result = super(component, l)
+        return result if result
+      rescue StandardError => e
+        error = e
+      end
+      raise error if error
+    end
+
+    private
+
+    def localechain(locale)
+      yield locale
+      LocaleUtil.locale_fallbacks.each do |l|
+        next if l == locale
+
+        yield l
+      end
+    end
+  end
+end

data/lib/sgtn-client/sgtn-client.rb

@@ -9,6 +9,7 @@ module SgtnClient # :nodoc:
   autoload :TranslationLoader,  'sgtn-client/loader'
   autoload :SingleOperation,    'sgtn-client/common/single_operation'
   autoload :Translation,        'sgtn-client/api/translation'
+  autoload :Fallbacks,          'sgtn-client/fallbacks'
   autoload :T,                  'sgtn-client/api/t'
   autoload :Source,             'sgtn-client/api/source'
   autoload :Config,             'sgtn-client/core/config'

data/lib/sgtn-client/util/locale-util.rb

@@ -74,7 +74,7 @@ module SgtnClient
     end
 
     def self.locale_fallbacks
-      @locale_fallbacks ||= [get_default_locale, get_source_locale, EN_LOCALE].uniq(&:to_s) - [nil, '']
+      @locale_fallbacks ||= ([get_default_locale, get_source_locale, EN_LOCALE].uniq(&:to_s) - [nil, '']).freeze
     end
 
     def self.lowercase_locales_map(component)

data/lib/singleton-client.rb

@@ -14,7 +14,7 @@ module Sgtn # :nodoc:
     end
 
     def_delegator SgtnClient::Config, :instance, :config
-    delegate %i[translate t get_translations] => SgtnClient::Translation,
+    delegate %i[translate! t! translate t get_translations! get_translations] => SgtnClient::Translation,
              %i[locale locale=] => SgtnClient,
              %i[logger product_name version vip_server translation_bundle
                 source_bundle cache_expiry_period log_file log_level].flat_map { |m|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: singleton-client-test
 version: !ruby/object:Gem::Version
-  version: 0.7.7.6
+  version: 0.7.7.7
 platform: ruby
 authors:
 - VMware G11n Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-30 00:00:00.000000000 Z
+date: 2022-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -144,6 +144,7 @@ files:
 - lib/sgtn-client/core/config.rb
 - lib/sgtn-client/core/exceptions.rb
 - lib/sgtn-client/exceptions.rb
+- lib/sgtn-client/fallbacks.rb
 - lib/sgtn-client/formatters/plurals/plural_formatter.rb
 - lib/sgtn-client/i18n_backend.rb
 - lib/sgtn-client/loader.rb