singleton-client-test 0.7.0.34 → 0.7.0.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6722a7f77f8f9ee4fbf2f481d0c66e30b818c61746a9c7e8471fc1b225079f72
-  data.tar.gz: ba0e6acade9bc655f97a731cf760e15097b713e99000cf8f2612e4975a357d2d
+  metadata.gz: 365e6be5a17d3f95f2529789f8632092e859c793c96d67b4f8ddd6492f3e3687
+  data.tar.gz: a2df815daeda06f52484e61ef7c64e2c5bc6ce5d46332a10b60187bbc2440a59
 SHA512:
-  metadata.gz: 27e3c13e20185a08049c2d634bc11e3a6d4e05095802e3c76026b74c34acd3a327b2e49c79020b9143479747e9d25fbfe5eaf4c859621afdc23f512859efd0fc
-  data.tar.gz: bed85d6578397cd90e0823574f552d7f7e98e19a0f49e35e12963eecc32d5f87d85b8c0a8ab2c50c5c66b3ea81e630334194f8d4600fdc4a0eec2bf391b2decb
+  metadata.gz: 64ef532c3de19ee72c7b0c28661c1192856eb9ebdef0a335d7d702d98b0d7bf56411691cd3ce2c8ceeae829d0d8d8eaad53981cde88721b49e606c657f053028
+  data.tar.gz: 27d63abbf9b7df87e20997664eebc97853ae1837f5f3c3853c1f77ce1ace43000d25482ae6f261a3d18788fbba9f026ca75374e1a14c078aa068dbdfec8a532a

data/README.md

@@ -1,54 +1,53 @@
-# Singeleton client for Ruby
+# Singleton Client for Ruby
 
 ## Prerequisites
 - Ruby version: 3.0.0 or above
 - Bundler version: 2.2.3 or above
 
 ## Run Unit Test
-rake spec:unit
+`rake spec`
 
 ## Usage
 
 Basic Usage:
 
 ```ruby
-require 'singleton-ruby'
-
-include SgtnClient
-
-SgtnClient.load(file, mode)
-
-SgtnClient::Source.loadBundles(locale)
-
-@Result = SgtnClient::Translation.getString(component, key, locale)
+require 'singleton-client'
 
+Sgtn.load_config(file, env)
+result = Sgtn.translate(key, component, locale)
 ```
 ## API Usage
 
 ### Get a string's translation
-SgtnClient::Translation.getString(component, key, locale)
-
-### Get a string's translation and format it with placeholders
-SgtnClient::Translation.getString_f(component, key, args, locale)
-
-### Get a component's translations
-SgtnClient::Translation.getStrings(component, locale)
-
+`result = Sgtn.translate(key, component, locale)`
 
-## API Usage(with request_store)
-
-Before call below APIs(without locale and component arguments), it requires to set the locale and component in the initial codes.
-
-### Get a string's translation
-SgtnClient::T.s(key)
+### Get a string's translation with default value when no translation
+`result = Sgtn.translate(key, component, locale) { 'default value' }`
 
 ### Get a string's translation and format it with placeholders
-SgtnClient::T.s_f(key, args)
+`result = Sgtn.translate(key, component, locale, **args)`
 
-### Get a component's translations
-SgtnClient::T.c()
+### Get pluralized translation
+`result = Sgtn.translate(key, component, locale, **args)`
 
+### Get translations of a bundle
+`result = Sgtn.get_translations(component, locale)`
 
+### Set locale for a request
+`Sgtn.locale = 'en'`
 
+### Get locale of the request
+`result = Sgtn.locale`
 
+### Get a string's translation with locale set
+```ruby
+Sgtn.locale = 'en'
+result = Sgtn.translate(key, component)
+```
 
+### Get translations of a bundle with locale set
+```ruby
+Sgtn.locale = 'en'
+result = Sgtn.get_translations(component)
+```

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

@@ -6,19 +6,19 @@ require 'request_store'
 module SgtnClient
   module Translation
     module Implementation
-      # <b>DEPRECATED:</b> Please use <tt>Singleton:translate</tt> instead.
+      # <b>DEPRECATED:</b> Please use <tt>Sgtn:translate</tt> instead.
       def getString(component, key, locale)
         SgtnClient.logger.debug "[Translation.getString]component: #{component}, key: #{key}, locale: #{locale}"
         translate(key, component, locale) { nil }
       end
 
-      # <b>DEPRECATED:</b> Please use <tt>Singleton:translate</tt> instead.
+      # <b>DEPRECATED:</b> Please use <tt>Sgtn:translate</tt> instead.
       def getString_p(component, key, plural_args, locale)
         SgtnClient.logger.debug "[Translation][getString_p]component=#{component}, key=#{key}, locale=#{locale}"
         translate(key, component, locale, **plural_args) { nil }
       end
 
-      # <b>DEPRECATED:</b> Please use <tt>Singleton:translate</tt> instead.
+      # <b>DEPRECATED:</b> Please use <tt>Sgtn:translate</tt> instead.
       def getString_f(component, key, args, locale, *_optionals)
         SgtnClient.logger.debug "[Translation][getString_f]component=#{component}, key=#{key}, locale=#{locale}"
         s = translate(key, component, locale) { nil }
@@ -34,7 +34,7 @@ module SgtnClient
         s
       end
 
-      # <b>DEPRECATED:</b> Please use <tt>Singleton:get_translations</tt> instead.
+      # <b>DEPRECATED:</b> Please use <tt>Sgtn:get_translations</tt> instead.
       def getStrings(component, locale)
         get_translations(component, locale)
       end

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

@@ -2,6 +2,7 @@
 # SPDX-License-Identifier: EPL-2.0
 
 String.class_eval <<-LOCALIZE, __FILE__, __LINE__ + 1
+          # <b>DEPRECATED:</b> Please use <tt>Sgtn:translate</tt> instead.
           def to_plural_s(locale, arg)
             num_str = SgtnClient::Formatters::PluralFormatter.new(locale).num_s(self, arg)
             if num_str.nil? || num_str.empty?

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

@@ -3,7 +3,7 @@
 
 require 'erb'
 require 'yaml'
-
+require 'observer'
 
 module SgtnClient
   #include Exceptions
@@ -40,6 +40,7 @@ module SgtnClient
   
 
   class Config
+    extend Observable
 
     attr_accessor :username, :password, :signature, :app_id, :cert_path,
     :token, :token_secret, :subject,
@@ -182,6 +183,8 @@ module SgtnClient
             def bundles.locales
               @locales ||= reduce(Set.new) { |locales, id| locales << id.locale }
             end
+            changed
+            notify_observers(:available_locales)
           end
           bundles.locales
         end

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

@@ -1,7 +1,8 @@
 # Copyright 2022 VMware, Inc.
 # SPDX-License-Identifier: EPL-2.0
 
-require 'multi_json'
+require 'json'
+require 'pathname'
 
 module SgtnClient
   module Common

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

@@ -12,12 +12,9 @@ module SgtnClient
       def load_bundle(component, locale)
         SgtnClient.logger.debug "[#{__FILE__}][#{__callee__}] component=#{component}, locale=#{locale}"
 
-        @single_bundle_loader ||= single_loader { |c,l| super(c,l) }
+        @single_bundle_loader ||= single_loader { |c, l| super(c, l) }
         id = CacheUtil.get_cachekey(component, locale)
         @single_bundle_loader.operate(id, component, locale)&.value
-      ensure
-        # delete thread from hash after finish
-        @single_bundle_loader.remove_object(id)
       end
 
       def available_bundles
@@ -25,21 +22,26 @@ module SgtnClient
 
         @single_available_bundles_loader ||= single_loader { super }
         @single_available_bundles_loader.operate(CONSTS::AVAILABLE_BUNDLES_KEY)&.value
-      ensure
-        @single_available_bundles_loader.remove_object(CONSTS::AVAILABLE_BUNDLES_KEY)
       end
 
       private
+
       def single_loader(&block)
-        none_alive = proc { |_, thread| thread.nil? || thread.alive? == false }
+        loader = nil
+        none_alive = proc { |_, thread| thread.nil? }
         creator = proc do |id, _, *args|
           Thread.new do
             SgtnClient.logger.debug "start single loading #{id}"
-            block.call(*args)
+            begin
+              block.call(*args)
+            ensure
+              # delete thread from hash after finish
+              loader.remove_object(id)
+            end
           end
         end
 
-        SgtnClient::SingleOperation.new(none_alive, &creator)
+        loader = SgtnClient::SingleOperation.new(none_alive, &creator)
       end
     end
   end

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

@@ -1,6 +1,9 @@
 # Copyright 2022 VMware, Inc.
 # SPDX-License-Identifier: EPL-2.0
 
+require 'pathname'
+require 'psych/simple'
+
 module SgtnClient
   module Common
     autoload :BundleID, 'sgtn-client/common/data'
@@ -22,7 +25,7 @@ module SgtnClient
         total_messages = {}
 
         (@source_bundle_path + component).glob('**/*.{yml, yaml}') do |f|
-          bundle = YAML.safe_load(File.read(f))
+          bundle = Psych.simple_load(File.read(f))
           messages = bundle&.first&.last # TODO: Warn about inconsistent source locale
           if messages.is_a?(Hash)
             total_messages.merge!(messages)

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

@@ -1,23 +1,29 @@
+# frozen_string_literal: true
+
 # Copyright 2022 VMware, Inc.
 # SPDX-License-Identifier: EPL-2.0
+
 require 'set'
 
 module SgtnClient
   class LocaleUtil
     MAP_LOCALES = {
-      'zh-CN' => 'zh-Hans',
-      'zh-TW' => 'zh-Hant',
-      'zh-Hans-CN' => 'zh-Hans',
-      'zh-Hant-TW' => 'zh-Hant'
+      'zh-cn' => 'zh-hans',
+      'zh-tw' => 'zh-hant',
+      'zh-hans-cn' => 'zh-hans',
+      'zh-hant-tw' => 'zh-hant'
     }.freeze
+    LOCALE_SEPARATOR = '-'
 
     def self.get_best_locale(locale)
+      return locale if Config.available_locales.include?(locale)
+
       return get_fallback_locale if locale.nil?
 
       locale = locale.to_s
       return get_fallback_locale if locale.empty?
 
-      get_best_match(locale.gsub('_', '-'))
+      get_best_match(locale.gsub('_', LOCALE_SEPARATOR).downcase)
     end
 
     def self.is_source_locale(locale = nil)
@@ -26,12 +32,12 @@ module SgtnClient
 
     def self.get_best_match(locale)
       locale = MAP_LOCALES[locale] || locale
-      return locale if Config.available_locales.include?(locale)
-
-      index = locale.rindex('-')
-      return get_fallback_locale if index.nil?
+      lowercase_locales_map[locale] or begin
+        index = locale.rindex(LOCALE_SEPARATOR)
+        return get_fallback_locale if index.nil?
 
-      get_best_match(locale[0...index])
+        get_best_match(locale[0...index])
+      end
     end
 
     def self.get_source_locale
@@ -47,6 +53,18 @@ module SgtnClient
       @fallback_locale ||= get_default_locale || get_source_locale || 'en'
     end
 
-    private_class_method :get_best_match
+    def self.lowercase_locales_map
+      @lowercase_locales_map ||= Config.available_locales.each_with_object({}) do |locale, memo|
+        memo[locale.to_s.downcase] = locale
+      end
+    end
+
+    def self.reset_available_locales(type)
+      @lowercase_locales_map = nil if type == :available_locales
+    end
+
+    SgtnClient::Config.add_observer(self, :reset_available_locales)
+
+    private_class_method :get_best_match, :lowercase_locales_map, :reset_available_locales
   end
 end

data/lib/singleton-client.rb

@@ -3,7 +3,7 @@
 
 require_relative 'singleton-ruby'
 
-module Singleton # :nodoc:
+module Sgtn # :nodoc:
   # load configuration from a file
   def self.load_config(*args)
     SgtnClient.load(*args)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: singleton-client-test
 version: !ruby/object:Gem::Version
-  version: 0.7.0.34
+  version: 0.7.0.37
 platform: ruby
 authors:
 - VMware G11n Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-27 00:00:00.000000000 Z
+date: 2022-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -142,6 +142,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.6'
+- !ruby/object:Gem::Dependency
+  name: psych-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Singleton Ruby client
 email: g11n-vip-project@vmware.com
 executables: []