singleton-client 0.7.3 → 0.7.6

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

@@ -0,0 +1,58 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
+module SgtnClient
+  autoload :StringUtil, 'sgtn-client/util/string-util'
+  autoload :LocaleUtil, 'sgtn-client/util/locale-util'
+
+  module TranslationLoader
+    autoload :CONSTS, 'sgtn-client/loader/consts'
+
+    module SourceComparer
+      def load_bundle(component, locale)
+        SgtnClient.logger.debug "[#{__FILE__}][#{__callee__}] component=#{component}, locale=#{locale}"
+
+        # source locale and old source locale don't need comparison because they are bases of comparison
+        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)
+
+        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}"
+          return translation_bundle
+        end
+
+        compare_source(translation_bundle, old_source_bundle, source_bundle)
+      end
+
+      private
+
+      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
+
+        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)
+          end
+        end
+        translation_bundle
+      end
+
+      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
+        }.freeze
+      end
+    end
+  end
+end

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

@@ -1,4 +1,9 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 module SgtnClient
+      LOGFILE_SHIFT_AGE = 4
+
       module Core
             autoload :Cache,        "sgtn-client/core/cache"
       end
@@ -12,6 +17,8 @@ module SgtnClient
       autoload :ValidateUtil,       "sgtn-client/util/validate-util"
       autoload :LocaleUtil,         "sgtn-client/util/locale-util"
       autoload :FileUtil,           "sgtn-client/util/file-util"
+      autoload :CacheUtil,          "sgtn-client/util/cache-util"
+      autoload :StringUtil,          "sgtn-client/util/string-util"
 
       module Formatters
             autoload :PluralFormatter,    "sgtn-client/formatters/plurals/plural_formatter"
@@ -38,17 +45,18 @@ module SgtnClient
 
                   # create log file
                   file = './sgtnclient_d.log'
+                  SgtnClient.logger.debug "[Client][load]create log file=#{file}"
                   if args[2] != nil
                         file = args[2]
                   end
                   file = File.open(file, 'a')
                   file.sync = true
-                  SgtnClient.logger = Logger.new(file)
+                  SgtnClient.logger = Logger.new(file, LOGFILE_SHIFT_AGE)
 
                   # Set log level for sandbox mode
                   env = SgtnClient::Config.default_environment
                   mode = SgtnClient::Config.configurations[env]["mode"]
-                  SgtnClient.logger.info "Current mode is: " + mode
+                  SgtnClient.logger.debug "[Client][load]set log level, mode=#{mode}"
                   if mode == 'sandbox'
                         SgtnClient.logger.level = Logger::DEBUG
                   else 
@@ -57,6 +65,7 @@ module SgtnClient
 
                   # initialize cache
                   disable_cache = SgtnClient::Config.configurations[env]["disable_cache"]
+                  SgtnClient.logger.debug "[Client][load]cache initialize, disable_cache=#{disable_cache}"
                   if disable_cache != nil
                         SgtnClient::Core::Cache.initialize(disable_cache)
                   else

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

@@ -1,48 +1,40 @@
-require 'erb'
-require 'yaml'
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
 
 module SgtnClient
-
   module Core
-    autoload :Cache,       "sgtn-client/core/cache"
+    autoload :Cache, 'sgtn-client/core/cache'
   end
-  
+
   class CacheUtil
+    def self.get_cache(cache_key)
+      SgtnClient::Core::Cache.get(cache_key)
+    end
 
-      def self.get_cache(cache_key)
-        expired, items = SgtnClient::Core::Cache.get(cache_key)
-        return expired, items
-      end
-
-      def self.clear_cache()
-        SgtnClient::Core::Cache.clear()
-      end
-
-      def self.write_cache(cache_key, items)
-        if items.nil?
-          SgtnClient.logger.debug "write cache with key #{cache_key}, itmes #{items}"
-          return nil
-        end
-        env = SgtnClient::Config.default_environment
-        cache_expiry_period = SgtnClient::Config.configurations[env]["cache_expiry_period"]
-        # expired after 24 hours
-        if cache_expiry_period == nil
-            cache_expiry_period = 24*60
-        end
-        SgtnClient::Core::Cache.put(cache_key, items, cache_expiry_period)
-      end
-
-      def self.get_cachekey(component, locale)
-        env = SgtnClient::Config.default_environment
-        product_name = SgtnClient::Config.configurations[env]["product_name"]
-        version = SgtnClient::Config.configurations[env]["version"].to_s
-        default_l = SgtnClient::Config.configurations[env]["default_language"]
-        if default_l == nil
-          default_l = 'en'
-        end
-        lc = locale == default_l ? SgtnClient::Config.configurations.default: locale
-        return product_name + "_" + version + "_" + component + "_" + lc
-      end
-  end
+    def self.clear_cache
+      SgtnClient::Core::Cache.clear
+    end
+
+    def self.write_cache(cache_key, items)
+      return nil if items.nil? || items.empty?
 
-end
+      env = SgtnClient::Config.default_environment
+      cache_expiry_period = SgtnClient::Config.configurations[env]['cache_expiry_period']
+      # expired after 24 hours
+      cache_expiry_period = 24 * 60 if cache_expiry_period.nil?
+      SgtnClient::Core::Cache.put(cache_key, items, cache_expiry_period)
+    end
+
+    def self.get_cachekey(component, locale)
+      env = SgtnClient::Config.default_environment
+      product_name = SgtnClient::Config.configurations[env]['product_name']
+      version = SgtnClient::Config.configurations[env]['version'].to_s
+      product_name + '_' + version + '_' + component + '_' + locale
+    end
+
+    def self.is_expired(cache_item)
+      cache_item[:expiry] < Time.now
+    end
+
+  end
+end

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

@@ -1,31 +1,70 @@
-module SgtnClient
+# frozen_string_literal: true
+
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
 
-    DEFAULT_LOCALES = ['en', 'de', 'es', 'fr', 'ko', 'ja', 'zh-Hans', 'zh-Hant']
+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",
-                  }
-
-    class LocaleUtil
-        def self.fallback(locale)
-            found = SgtnClient::DEFAULT_LOCALES.select {|e| e == locale}
-            if !found.empty?
-                return found[0]
-            end
-            if SgtnClient::MAP_LOCALES.key?(locale)
-                return SgtnClient::MAP_LOCALES[locale]
-            end
-            parts = locale.split("-")
-            if parts.size > 1
-                f = SgtnClient::DEFAULT_LOCALES.select {|e| e == parts[0]}
-                if !f.empty?
-                    return f[0]
-                end
-            end 
-            return locale
-        end
-    end
-end
+      '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('_', LOCALE_SEPARATOR).downcase)
+    end
+
+    def self.is_source_locale(locale = nil)
+      locale == get_source_locale
+    end
+
+    def self.get_best_match(locale)
+      locale = MAP_LOCALES[locale] || locale
+      lowercase_locales_map[locale] or begin
+        index = locale.rindex(LOCALE_SEPARATOR)
+        return get_fallback_locale if index.nil?
+
+        get_best_match(locale[0...index])
+      end
+    end
+
+    def self.get_source_locale
+      'en'
+    end
+
+    def self.get_default_locale
+      env = SgtnClient::Config.default_environment
+      SgtnClient::Config.configurations[env]['default_language']
+    end
+
+    def self.get_fallback_locale
+      @fallback_locale ||= get_default_locale || get_source_locale || 'en'
+    end
+
+    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/sgtn-client/util/string-util.rb

@@ -0,0 +1,12 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
+module SgtnClient
+  class StringUtil < String
+    def initialize(str, locale)
+      super(str)
+      @locale = locale
+    end
+    attr_accessor :locale
+  end
+end 

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

@@ -1,23 +1,20 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
 
 module SgtnClient
 
   class ValidateUtil
 
       def self.validate_config()
-        SgtnClient.logger.debug "-----------Start to validate configuration's setting itmes-----------"
         env = SgtnClient::Config.default_environment
+        SgtnClient.logger.debug "[ValidateUtil][validate_config] env = #{env}"
         messages = "\n"
 
         mode = SgtnClient::Config.configurations[env]["mode"]
         if mode != 'sandbox' && mode != 'live'
           messages =  messages + "Configuration[mode] has to be 'sandbox' or 'live'!\n"
         end
-        
-        bundle_mode = SgtnClient::Config.configurations[env]["bundle_mode"]
-        if bundle_mode != 'offline' && bundle_mode != 'online'
-          messages = messages +  "Configuration[bundle_mode] has to be 'offline' or 'online'!\n"
-        end
-        
+
         #version = SgtnClient::Config.configurations[env]["version"]
         #if version.is_a? Integer
           #messages = messages +  "Configuration[version] has to be standard as '#.#.#, e.g '1.0.0'!\n"
@@ -36,9 +33,8 @@ module SgtnClient
         if messages != "\n"
           raise SgtnClient::Exceptions::MissingConfig.new(messages)
         end
-        SgtnClient.logger.debug "-----------End  to  validate configuration's setting itmes-----------"
       end
 
   end
 
-end
+end

data/lib/singleton-client.rb

@@ -0,0 +1,15 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
+require_relative 'singleton-ruby'
+
+module Sgtn # :nodoc:
+  # load configuration from a file
+  def self.load_config(*args)
+    SgtnClient.load(*args)
+  end
+
+  extend SgtnClient::Translation::Implementation
+
+  private_class_method :getString, :getString_p, :getString_f, :getStrings
+end

data/lib/singleton-ruby.rb

@@ -1,3 +1,8 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 require "sgtn-client/sgtn-client"
 require 'sgtn-client/cldr/core_ext'
 require 'twitter_cldr'
+
+require 'sgtn-client/exceptions.rb'

data/lib/version.rb

@@ -1,3 +1,5 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
 
     VERSION_INFO = [0, 2, 1].freeze
     VERSION = VERSION_INFO.map(&:to_s).join('.').freeze

metadata

@@ -1,85 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: singleton-client
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.6
 platform: ruby
 authors:
 - VMware G11n Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2022-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: request_store
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: twitter_cldr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: 2.4.2
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '6.6'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.6'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: 2.4.2
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,54 +44,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  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: pry-doc
-  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: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.4.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.4.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -157,93 +59,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.49'
 - !ruby/object:Gem::Dependency
-  name: http-accept
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: http-cookie
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: mime-types
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: netrc
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: request_store
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: twitter_cldr
   requirement: !ruby/object:Gem::Requirement
@@ -274,17 +158,29 @@ files:
 - lib/sgtn-client/cldr/localized_datetime.rb
 - lib/sgtn-client/cldr/localized_str.rb
 - lib/sgtn-client/cldr/localized_time.rb
+- lib/sgtn-client/common/data.rb
+- lib/sgtn-client/common/single_operation.rb
 - lib/sgtn-client/core/cache.rb
 - lib/sgtn-client/core/config.rb
 - lib/sgtn-client/core/exceptions.rb
 - lib/sgtn-client/core/logging.rb
-- lib/sgtn-client/core/request.rb
+- lib/sgtn-client/exceptions.rb
 - lib/sgtn-client/formatters/plurals/plural_formatter.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/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/cache-util.rb
-- lib/sgtn-client/util/file-util.rb
 - lib/sgtn-client/util/locale-util.rb
+- lib/sgtn-client/util/string-util.rb
 - lib/sgtn-client/util/validate-util.rb
+- lib/singleton-client.rb
 - lib/singleton-ruby.rb
 - lib/version.rb
 homepage: https://github.com/vmware/singleton