singleton-client-test 0.7.7.7 → 0.7.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71f20276ef709f5a183ab1e6572f171bfe9e5cdb0d0f09decea0fdb2e3aa2e88
-  data.tar.gz: 1eeebcc0cc3a964c90a00523fdda8aae09d3dc69ddc51af658c6218eb8e97c05
+  metadata.gz: 54400e87e847568bead1be140a4374acced859dc3fa9f3fa954b3ddd3fae7192
+  data.tar.gz: 073364cb409f2b2fdfa40d0ebadd6c6d36983c262dad8cd9f1d57bae602d419f
 SHA512:
-  metadata.gz: cd7cd9a1b977ddfd9110758b997c26bda3d8f2507f95036c87db24e130b7249f9c57871ce7f46c45827c810f0c7dd991b36dde656d3ce8a809e9ef4792554a65
-  data.tar.gz: 1d8c12a9f7dc6c65ebddcdf1eef50907cd8838a38a0c1a4c98c7001b4b9c77c55c5486d109fc7d9aca01c2c85c99e658ab381e8f2994e7818c73eb3d2a220295
+  metadata.gz: 5b213886e41d561eb73c20008920a2ddf87ddd98645f64efdda180f1e157749302494c944f581b87d529ed688e44858d3d0c8cb01cb7eeed9c6a50106b0494f8
+  data.tar.gz: efc69bd188f29815770d8c65541ade62268d063cf38a88b3a3cd416ad4c5e961b3bf7e290d4c9faec9510f3ac76e3c15bd6e2070e1e175e2f1969bb09f0d0bae

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

@@ -39,10 +39,6 @@ module SgtnClient
         get_translations(component, locale)
       end
 
-      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
@@ -56,8 +52,8 @@ module SgtnClient
         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)
-          result, actual_locale = get_translation!(key, component, best_match_locale)
+          picked_locale = pickup_locale(locale || SgtnClient.locale, component)
+          result, actual_locale = get_string!(key, component, picked_locale)
         rescue StandardError => e
           raise e if block.nil?
         end
@@ -68,7 +64,7 @@ module SgtnClient
           return if result.nil?
         end
 
-        kwargs.empty? ? result : result.localize(actual_locale) % kwargs
+        kwargs.empty? ? result : interpolate(result, actual_locale, **kwargs)
       end
       alias t! translate!
 
@@ -82,13 +78,19 @@ module SgtnClient
       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 = get_bundle!(component, best_match_locale)
+        picked_locale = pickup_locale(locale || SgtnClient.locale, component)
+        get_bundle!(component, picked_locale)
+      end
 
-        { 'component' => component, 'locale' => best_match_locale, 'messages' => messages } if messages
+      protected
+
+      def pickup_locale(locale, component)
+        LocaleUtil.get_best_locale(locale, component)
       end
 
-      private
+      def interpolate(translation, locale, **kwargs)
+        translation.localize(locale) % kwargs
+      end
 
       def get_bundle!(component, locale)
         SgtnClient.config.loader.get_bundle(component, locale)
@@ -100,6 +102,13 @@ module SgtnClient
         SgtnClient.config.notify_observers(:available_locales, component)
         raise
       end
+
+      private
+
+      def get_string!(key, component, locale)
+        bundle = get_bundle!(component, locale)
+        [bundle.fetch(key), bundle.locale]
+      end
     end
 
     extend Implementation

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

@@ -50,13 +50,19 @@ module SgtnClient
     class BundleData < Hash # :nodoc:
       include DataInfo
 
-      def initialize(*args)
+      attr_reader :origin, :locale, :component
+
+      def initialize(*args, origin: nil, locale: nil, component: nil)
         if !args.empty? && args[0].is_a?(Hash)
           update(args[0])
           super()
         else
           super
         end
+
+        @origin = origin
+        @locale = locale
+        @component = component
       end
     end
 

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

@@ -11,9 +11,13 @@ module SgtnClient
     include Observable
     include Singleton
 
-    attr_accessor :product_name, :version, :vip_server, :translation_bundle, :source_bundle, :cache_expiry_period, :log_file, :log_level
+    attr_accessor :product_name, :version, :vip_server, :translation_bundle, :source_bundle, :cache_expiry_period,
+                  :log_file, :log_level
+    attr_writer :logger, :pseudo_tag
 
-    attr_writer :logger
+    def pseudo_tag
+      @pseudo_tag ||= '@@'
+    end
 
     def logger
       @logger ||= if log_file

data/lib/sgtn-client/fallbacks.rb

@@ -3,21 +3,12 @@
 
 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
+    protected
 
-    def get_translations!(component, locale = nil)
+    def get_bundle!(component, locale)
       error = nil
       localechain(locale) do |l|
-        result = super(component, l)
-        return result if result
+        return super(component, l)
       rescue StandardError => e
         error = e
       end

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

@@ -35,7 +35,7 @@ module SgtnClient
       def load_bundle(component, locale)
         SgtnClient.logger.debug { "[#{__FILE__}][#{__callee__}] CacheFiller, component=#{component}, locale=#{locale}" }
 
-        @cache_hash[Common::BundleID.new(component, locale)] = Common::BundleData.new(super)
+        @cache_hash[Common::BundleID.new(component, locale)] = super
       end
 
       def available_bundles

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

@@ -6,16 +6,16 @@ require 'set'
 module SgtnClient
   module TranslationLoader
     class Chain
-      attr_accessor :loaders
+      attr_reader :loaders
 
       def initialize(*loaders)
-        self.loaders = loaders
+        @loaders = loaders
       end
 
       def load_bundle(component, locale)
         exception = nil
 
-        loaders.each do |loader|
+        @loaders.each do |loader|
           begin
             bundle = loader.load_bundle(component, locale)
             return bundle if bundle
@@ -32,7 +32,7 @@ module SgtnClient
         exception = nil
         total_data = Set.new
 
-        loaders.each do |loader|
+        @loaders.each do |loader|
           begin
             item = loader.available_bundles
             total_data += item

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

@@ -6,7 +6,6 @@
 module SgtnClient
   module TranslationLoader
     module CONSTS
-      OLD_SOURCE_LOCALE = 'old_source'
       REAL_SOURCE_LOCALE = 'latest'
 
       AVAILABLE_BUNDLES_KEY = 'available_bundles'

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

@@ -15,6 +15,7 @@ module SgtnClient
 
         chain_loader = Class.new(Chain)
         chain_loader.include SourceComparer
+        chain_loader.include Pseudo
         chain_loader.include CacheFiller
         chain_loader.include SingleLoader
         chain_loader.include Cache

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

@@ -26,17 +26,16 @@ module SgtnClient
 
         raise SingletonError, "no messages in local bundle file: #{file_path}." unless messages
 
-        messages
+        Common::BundleData.new(messages, origin: self, component: component,
+                                         locale: locale == CONSTS::REAL_SOURCE_LOCALE ? LocaleUtil.get_source_locale : locale)
       end
 
       def available_bundles
         SgtnClient.logger.debug { "[#{method(__callee__).owner}.#{__callee__}]" }
 
-        @available_bundles ||= begin
-          @base_path.glob('*/*.json').reduce(Set.new) do |bundles, f|
-            locale = f.basename.to_s.sub(/\A#{BUNDLE_PREFIX}/i, '').sub(/#{BUNDLE_SUFFIX}\z/i, '')
-            bundles.add Common::BundleID.new(f.parent.basename.to_s, locale)
-          end
+        @available_bundles = @base_path.glob('*/*.json').reduce(Set.new) do |bundles, f|
+          locale = f.basename.to_s.sub(/\A#{BUNDLE_PREFIX}/i, '').sub(/#{BUNDLE_SUFFIX}\z/i, '')
+          bundles.add Common::BundleID.new(f.parent.basename.to_s, locale)
         end
       end
     end

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

@@ -0,0 +1,21 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
+module SgtnClient
+  module TranslationLoader
+    module Pseudo # :nodoc:
+      def initialize(*)
+        super
+        @pseudo_tag = Sgtn.pseudo_tag
+      end
+
+      def load_bundle(component, locale)
+        return super unless locale == Sgtn::PSEUDO_LOCALE
+
+        SgtnClient.logger.debug { "[#{__FILE__}][#{__callee__}] component=#{component}, locale=#{locale}" }
+
+        super(component, LocaleUtil.get_source_locale).transform_values! { |v| "#{@pseudo_tag}#{v}#{@pseudo_tag}" }
+      end
+    end
+  end
+end

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

@@ -27,16 +27,18 @@ module SgtnClient
 
         @conn = Faraday.new(config.vip_server, request: REQUEST_ARGUMENTS) do |f|
           f.response :json # decode response bodies as JSON
-          f.use :gzip
           f.response :raise_error
           f.response :logger, config.logger, { log_level: :debug, headers: false, bodies: true }
+          f.use :gzip
         end
       end
 
       def load_bundle(component, locale)
         SgtnClient.logger.debug { "[#{method(__callee__).owner}.#{__callee__}] component=#{component}, locale=#{locale}" }
 
-        query_server(format(@bundle_url, locale, component), ['messages'])
+        data = query_server(format(@bundle_url, locale, component), ['messages'])
+        Common::BundleData.new(data, origin: self, component: component,
+                                     locale: locale == CONSTS::REAL_SOURCE_LOCALE ? LocaleUtil.get_source_locale : locale)
       end
 
       def available_bundles

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

@@ -7,7 +7,7 @@ require 'yaml'
 
 module SgtnClient
   module TranslationLoader
-    class Source
+    class Source # :nodoc:
       def initialize(config)
         @source_bundle_path = Pathname.new(config.source_bundle)
       end
@@ -31,7 +31,7 @@ module SgtnClient
 
         raise SingletonError, "no local source messages for component #{component}" if total_messages.empty?
 
-        total_messages
+        Common::BundleData.new(total_messages, origin: self, component: component, locale: LocaleUtil.get_source_locale)
       end
 
       def available_bundles

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

@@ -11,41 +11,45 @@ module SgtnClient
         real_locale = cache_to_real_map[locale]
         return super(component, real_locale) if real_locale
 
-        old_source_bundle_thread = Thread.new { load_bundle(component, CONSTS::OLD_SOURCE_LOCALE) }
         source_bundle_thread = Thread.new { load_bundle(component, LocaleUtil.get_source_locale) }
-        translation_bundle = super(component, locale)
+        translation_bundle = super
+
+        begin
+          old_source_bundle = translation_bundle.origin.load_bundle(component, old_source_locale(locale))
+        rescue StandardError => e
+          SgtnClient.logger.error "[#{__FILE__}][#{__callee__}] failed to load old source bundle. component:#{component}. error: #{e}"
+        end
 
         begin
-          old_source_bundle = old_source_bundle_thread.value
           source_bundle = source_bundle_thread.value
         rescue StandardError => e
-          SgtnClient.logger.error "[#{__FILE__}][#{__callee__}] failed to load soruce(or old source) bundle. component:#{component}. error: #{e}"
+          SgtnClient.logger.error "[#{__FILE__}][#{__callee__}] failed to load source bundle. component:#{component}. error: #{e}"
           return translation_bundle
         end
 
         compare_source(translation_bundle, old_source_bundle, source_bundle)
       end
 
-      private
+      protected
 
-      def compare_source(translation_bundle, old_source_bundle, source_bundle)
-        if !translation_bundle.is_a?(Hash) || !source_bundle.is_a?(Hash) || !old_source_bundle.is_a?(Hash)
-          SgtnClient.logger.warn "can't do source comparison because some bundle data are wrong."
-          return translation_bundle
-        end
+      def old_source_locale(_locale)
+        LocaleUtil.get_source_locale
+      end
 
-        source_bundle.each do |key, value|
-          if old_source_bundle[key] != value || translation_bundle[key].nil?
-            translation_bundle[key] = StringUtil.new(value, LocaleUtil.get_source_locale)
+      def compare_source(translation_bundle, old_source_bundle, source_bundle)
+        source_bundle.each do |k, v|
+          if translation_bundle[k].nil? || (!old_source_bundle.nil? && old_source_bundle[k] != v)
+            translation_bundle[k] = LocalizedString.new(v, LocaleUtil.get_source_locale) if v
           end
         end
         translation_bundle
       end
 
+      private
+
       def cache_to_real_map
         @cache_to_real_map ||= {
-          LocaleUtil.get_source_locale => CONSTS::REAL_SOURCE_LOCALE,
-          CONSTS::OLD_SOURCE_LOCALE => LocaleUtil.get_source_locale
+          LocaleUtil.get_source_locale => CONSTS::REAL_SOURCE_LOCALE
         }.freeze
       end
     end

data/lib/sgtn-client/loader.rb

@@ -11,6 +11,7 @@ module SgtnClient
     autoload :CONSTS, 'sgtn-client/loader/consts'
     autoload :LoaderFactory, 'sgtn-client/loader/loader_factory'
     autoload :LocalTranslation, 'sgtn-client/loader/local_translation'
+    autoload :Pseudo, 'sgtn-client/loader/pseudo'
     autoload :SgtnServer, 'sgtn-client/loader/server'
     autoload :SingleLoader, 'sgtn-client/loader/single_loader'
     autoload :SourceComparer, 'sgtn-client/loader/source_comparer'

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

@@ -16,9 +16,8 @@ module SgtnClient # :nodoc:
   autoload :Exceptions,         'sgtn-client/core/exceptions'
   autoload :ValidateUtil,       'sgtn-client/util/validate-util'
   autoload :LocaleUtil,         'sgtn-client/util/locale-util'
-  autoload :StringUtil,         'sgtn-client/util/string-util'
+  autoload :LocalizedString,    'sgtn-client/util/localized_string'
   autoload :SingletonError,     'sgtn-client/exceptions'
-  autoload :I18nBackend,        'sgtn-client/i18n_backend'
 
   module Formatters # :nodoc:
     autoload :PluralFormatter, 'sgtn-client/formatters/plurals/plural_formatter'

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

@@ -15,40 +15,38 @@ module SgtnClient
     }.freeze
     LOCALE_SEPARATOR = '-'
     EN_LOCALE = 'en'
-    @locale_match_results = Concurrent::Map.new
+
+    @locale_match_results = Concurrent::Map.new do |hash, component|
+      components = SgtnClient.config.available_components
+      unless components.empty? || components.include?(component)
+        raise SingletonError, "component '#{component}' doesn't exist!"
+      end
+
+      hash[component] = Concurrent::Map.new
+    end
     @lowercase_locales_map = Concurrent::Map.new
 
     def self.get_best_locale(locale, component)
-      component_result = @locale_match_results[component] ||= begin
-        components = SgtnClient.config.available_components
-        unless components.empty? || components.include?(component)
-          raise SingletonError, "component '#{component}' doesn't exist!"
+      return locale if SgtnClient.config.available_locales(component).include?(locale)
+
+      component_result = @locale_match_results[component]
+      component_result[locale] ||= begin
+        if component_result.size >= 50
+          component_result.delete(component_result.keys[Random.rand(component_result.size)])
         end
 
-        Concurrent::Map.new
+        locale = locale.to_s
+        if locale.empty?
+          get_fallback_locale
+        else
+          candidates = lowercase_locales_map(component)
+          if candidates.empty?
+            locale
+          else
+            get_best_match(locale.gsub('_', LOCALE_SEPARATOR).downcase, candidates)
+          end
+        end
       end
-
-      component_result[locale] ||= begin
-                component_result.delete(component_result.keys[Random.rand(component_result.size)]) if component_result.size >= 50
-
-                if SgtnClient.config.available_locales(component).include?(locale)
-                  locale
-                elsif locale.nil?
-                  get_fallback_locale
-                else
-                  locale = locale.to_s
-                  if locale.empty?
-                    get_fallback_locale
-                  else
-                    candidates = lowercase_locales_map(component)
-                    if candidates.empty?
-                      locale
-                    else
-                      get_best_match(locale.gsub('_', LOCALE_SEPARATOR).downcase, candidates)
-                    end
-                  end
-                end
-              end
     end
 
     def self.get_best_match(locale, candidates)

data/lib/sgtn-client/util/{string-util.rb → localized_string.rb}

@@ -2,9 +2,9 @@
 # SPDX-License-Identifier: EPL-2.0
 
 module SgtnClient
-  class StringUtil < String
-    def initialize(str, locale)
-      super(str)
+  class LocalizedString < String
+    def initialize(value, locale)
+      super(value)
       @locale = locale
     end
 

data/lib/{sgtn-client → singleton-client}/i18n_backend.rb

@@ -3,7 +3,7 @@
 
 require 'i18n'
 
-module SgtnClient # :nodoc:
+module Sgtn # :nodoc:
   # When integrating Singleton in a client application that is already using [I18n::Backend (https://www.rubydoc.info/github/svenfuchs/i18n/master/I18n/Backend/), it would be useful to have Singleton override the said module in order to minimize necessary changes. Here is a common usage:
   #
   #   I18n::Backend::Simple.include(I18n::Backend::Fallbacks) # add fallbacks behavior to current backend
@@ -13,6 +13,10 @@ module SgtnClient # :nodoc:
   class I18nBackend
     def initialize(component)
       @component = component
+      @translation = Class.new do
+        include SgtnClient::Translation::Implementation
+        include Sgtn::Pseudo
+      end.new
     end
 
     def initialized?
@@ -34,13 +38,13 @@ module SgtnClient # :nodoc:
     def translations; end
 
     def exists?(locale, key, options)
-      !!(translate(locale, key, options) { nil })
+      !!translate(locale, key, options)
     end
 
     def translate(locale, key, options)
       flat_key = I18n::Backend::Flatten.normalize_flat_keys(locale, key, options[:scope], '.')
       values = options.except(*I18n::RESERVED_KEYS)
-      Translation.translate(flat_key, @component, locale, **values) { nil }
+      @translation.translate(flat_key, @component, locale, **values) { nil }
     end
 
     def localize(locale, object, format, options) end

data/lib/singleton-client/pseudo.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
+module Sgtn
+  module Pseudo # :nodoc:
+    protected
+
+    def pickup_locale(locale, _component)
+      locale == PSEUDO_LOCALE ? PSEUDO_LOCALE : super
+    end
+  end
+end

data/lib/singleton-client.rb

@@ -5,6 +5,15 @@ require 'forwardable'
 require_relative 'singleton-ruby'
 
 module Sgtn # :nodoc:
+  autoload :Pseudo, 'singleton-client/pseudo'
+  autoload :I18nBackend, 'singleton-client/i18n_backend'
+
+  extend SgtnClient::Translation::Implementation
+  extend SgtnClient::Fallbacks
+  extend Sgtn::Pseudo
+
+  PSEUDO_LOCALE = 'pseudo'.freeze
+
   class << self
     extend Forwardable
 
@@ -13,14 +22,6 @@ module Sgtn # :nodoc:
       SgtnClient.load(config_file, env)
     end
 
-    def_delegator SgtnClient::Config, :instance, :config
-    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|
-               [m, "#{m}=".to_sym]
-             } => :config
-
     def with_locale(tmp_locale = nil)
       if tmp_locale.nil?
         yield
@@ -34,7 +35,11 @@ module Sgtn # :nodoc:
         end
       end
     end
-  end
 
-  I18nBackend = SgtnClient::I18nBackend
+    def_delegator SgtnClient::Config, :instance, :config
+    delegate %i[locale locale=] => SgtnClient,
+             %i[logger product_name version vip_server translation_bundle
+                source_bundle cache_expiry_period log_file log_level
+                pseudo_tag ].flat_map { |m| [m, "#{m}=".to_sym] } => :config
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: singleton-client-test
 version: !ruby/object:Gem::Version
-  version: 0.7.7.7
+  version: 0.7.7.8
 platform: ruby
 authors:
 - VMware G11n Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-18 00:00:00.000000000 Z
+date: 2022-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -146,22 +146,24 @@ files:
 - 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
 - lib/sgtn-client/loader/cache.rb
 - lib/sgtn-client/loader/chain_loader.rb
 - lib/sgtn-client/loader/consts.rb
 - lib/sgtn-client/loader/loader_factory.rb
 - lib/sgtn-client/loader/local_translation.rb
+- lib/sgtn-client/loader/pseudo.rb
 - lib/sgtn-client/loader/server.rb
 - lib/sgtn-client/loader/single_loader.rb
 - lib/sgtn-client/loader/source.rb
 - lib/sgtn-client/loader/source_comparer.rb
 - lib/sgtn-client/sgtn-client.rb
 - lib/sgtn-client/util/locale-util.rb
-- lib/sgtn-client/util/string-util.rb
+- lib/sgtn-client/util/localized_string.rb
 - lib/sgtn-client/util/validate-util.rb
 - lib/singleton-client.rb
+- lib/singleton-client/i18n_backend.rb
+- lib/singleton-client/pseudo.rb
 - lib/singleton-ruby.rb
 - lib/version.rb
 homepage: https://github.com/vmware/singleton
@@ -183,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Singleton Ruby client