singleton-client 0.7.5 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 662845b2e8dcbe69030049114857506ba0e2d5fd0ab98fdf886ddfd07ed1c7a8
-  data.tar.gz: bafa7b6a9f9d68e735ad1c830f37ea7f770381cafd7ff4ecda142d1673cec9c3
+  metadata.gz: a587958936d82290e3937f0a96097f4254bb3e8743673a808702a2881d414ff9
+  data.tar.gz: f60706e62d08f058fca8eb1b286800f61f4a79f78cd5aadb4b1c53ed7736f62f
 SHA512:
-  metadata.gz: 3249cfcdce192e2e04670aefb03fd090c9b436171edeb80bec82d1d62816e8406d7aaaa92e3b85aec0d9e625babbab136d61e3e0d4ecf12d582c0fd99ad5a5c5
-  data.tar.gz: c694298fc391a1395ea62b4b3fe7595c5deae8fd1909d01af1b6097a03848583a81e5b0d52ef16339645bc74035f180feae9110cad56f0b67d082a95c72bb3e1
+  metadata.gz: 7f89add299ebf85604d748fdc5c3d4e0fed05f98810514ca4de8b23eb3305af0568c32d308b59fa2b54f1f3188531de4c07732d6d5c59d4d13cc3a6f6ef0cb21
+  data.tar.gz: c2192d0d69ed16250d55a5f9e255c4ede49b404cc93f90ae3d266aa1663cdfcdce114317b593509a8be64e0f6d3587811eb4f8587b39517c08a5647460a462d1

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/source.rb

@@ -1,73 +1,15 @@
 # Copyright 2022 VMware, Inc.
 # SPDX-License-Identifier: EPL-2.0
 
+require 'sgtn-client/loader/source'
+
 module SgtnClient
-  
-  autoload :CacheUtil,       "sgtn-client/util/cache-util"
+  autoload :CacheUtil, 'sgtn-client/util/cache-util'
 
   class Source
-
-      def self.getSource(component, key, locale)
-        SgtnClient.logger.debug "[Source][getSource]component=#{component}, key=#{key}, locale=#{locale}"
-        cache_key = SgtnClient::CacheUtil.get_cachekey(component, locale)
-        expired, items = SgtnClient::CacheUtil.get_cache(cache_key)
-        if items.nil?
-          items = getBundle(component, locale)    
-          SgtnClient::CacheUtil.write_cache(cache_key, items)
-        else
-          SgtnClient.logger.debug "[Source][getSource]getting sources from cache with key: " + cache_key
-        end
-        s = (items.nil? || items[locale].nil?)? nil : items[locale][key]  
-        if items.nil? || s.nil?
-          SgtnClient.logger.debug "[Source][getSource]source not found, return key: " + key
-          #return key
-          return nil
-        else
-          return s
-        end
-      end
-
-      def self.getSources(component, locale)
-        SgtnClient.logger.debug "[Source][getSources]component=#{component}, locale=#{locale}"
-        cache_key = SgtnClient::CacheUtil.get_cachekey(component, locale)
-        expired, items = SgtnClient::CacheUtil.get_cache(cache_key)
-        if items.nil? || expired
-          items = getBundle(component, locale)
-          SgtnClient::CacheUtil.write_cache(cache_key, items)
-        else
-          SgtnClient.logger.debug "[Source][getSources]getting sources from cache with key: " + cache_key
-        end
-        return items
-      end
-
-      def self.loadBundles(locale)
-        SgtnClient.logger.debug "[Source][loadBundles]locale=#{locale}"
-        env = SgtnClient::Config.default_environment
-        SgtnClient::Config.configurations.default = locale
-        source_bundle = SgtnClient::Config.configurations[env]["source_bundle"]
-        Dir.foreach(source_bundle) do |component|
-          next if component == '.' || component == '..'
-          yamlfile = File.join(source_bundle, component + "/" + locale + ".yml")
-          bundle = SgtnClient::FileUtil.read_yml(yamlfile)
-          cachekey = SgtnClient::CacheUtil.get_cachekey(component, locale)
-          SgtnClient::CacheUtil.write_cache(cachekey,bundle)
-        end
-      end
-
-      private
-      def self.getBundle(component, locale)
-        SgtnClient.logger.debug "[Source][getBundle]component=#{component}, locale=#{locale}"
-        env = SgtnClient::Config.default_environment
-        source_bundle = SgtnClient::Config.configurations[env]["source_bundle"]
-        bundlepath = source_bundle  + "/" + component + "/" + locale + ".yml"
-        begin
-          bundle = SgtnClient::FileUtil.read_yml(bundlepath)
-        rescue => exception
-          SgtnClient.logger.error exception.message
-        end
-        return bundle
-      end
-
+    def self.loadBundles(locale)
+      SgtnClient.logger.debug "[Source][loadBundles]locale=#{locale}"
+      SgtnClient::Config.configurations.default = locale
+    end
   end
-
 end

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

@@ -2,24 +2,23 @@
 # SPDX-License-Identifier: EPL-2.0
 
 module SgtnClient
-    class T < Translation
-
-        def self.s(key)
-            locale = RequestStore.store[:locale]
-            component = RequestStore.store[:component]
-            return getString(component, key, locale)
-        end
+  class T
+    def self.s(key)
+      locale = RequestStore.store[:locale]
+      component = RequestStore.store[:component]
+      Translation.getString(component, key, locale)
+    end
 
-        def self.s_f(key, args)
-            locale = RequestStore.store[:locale]
-            component = RequestStore.store[:component]
-            return getString_f(component, key, args, locale)
-        end
+    def self.s_f(key, args)
+      locale = RequestStore.store[:locale]
+      component = RequestStore.store[:component]
+      Translation.getString_f(component, key, args, locale)
+    end
 
-        def self.c()
-            locale = RequestStore.store[:locale]
-            component = RequestStore.store[:component]
-            return getStrings(component, locale)
-        end
+    def self.c
+      locale = RequestStore.store[:locale]
+      component = RequestStore.store[:component]
+      Translation.getStrings(component, locale)
     end
+  end
 end

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

@@ -1,158 +1,113 @@
 # Copyright 2022 VMware, Inc.
 # SPDX-License-Identifier: EPL-2.0
 
-require 'multi_json'
+require 'request_store'
 
 module SgtnClient
-
-  module Core
-    autoload :Request,     "sgtn-client/core/request"
-    autoload :Cache,       "sgtn-client/core/cache"
-    autoload :CacheUtil,   "sgtn-client/util/cache-util"
-    autoload :LocaleUtil,   "sgtn-client/util/locale-util"
-  end
-  
-  class Translation
-
-      def self.getString(component, key, locale)
+  module Translation
+    module Implementation
+      # <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}"
-        str = getTranslation(component, key, locale)
-        if str.nil?
-          str = SgtnClient::Source.getSource(component, key, SgtnClient::Config.configurations.default)
-          if str.nil?
-            SgtnClient.logger.debug "[Translation][getString] Missing source string with key: #{key}, component: #{component}, locale: #{locale}"
-          end
-        end
-        str
+        translate(key, component, locale) { nil }
       end
 
-      def self.getString_p(component, key, plural_args, locale)
+      # <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}"
-        str = getTranslation(component, key, locale)
-        if str.nil?
-          str = SgtnClient::Source.getSource(component, key, SgtnClient::Config.configurations.default)
-          if str.nil?
-            SgtnClient.logger.debug "[Translation][getString_p] Missing source string with key: #{key}, component: #{component}, locale: #{locale}"
-            return nil
-          end
-          str.to_plural_s(:en, plural_args)
-        else
-          str.to_plural_s(locale, plural_args)
-        end
+        translate(key, component, locale, **plural_args) { nil }
       end
 
-      def self.getString_f(component, key, args, locale, *optionals)
-         SgtnClient.logger.debug "[Translation][getString_f]component=#{component}, key=#{key}, locale=#{locale}"
-         s = getString(component, key, locale, *optionals)
-         if s.nil?
-          return nil
-         end
-         if args.is_a?(Hash)
+      # <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 }
+        return nil if s.nil?
+
+        if args.is_a?(Hash)
           args.each do |source, arg|
             s.gsub! "{#{source}}", arg
           end
-         elsif args.is_a?(Array)
-          s = sprintf s % args
-         end
-         return s
+        elsif args.is_a?(Array)
+          s = s % args
+        end
+        s
       end
 
-      def self.getStrings(component, locale)
-        SgtnClient.logger.debug "[Translation][getStrings]component=#{component}, locale=#{locale}"
-        locale = SgtnClient::LocaleUtil.get_best_locale(locale)
-        items = get_cs(component, locale)
-        default = SgtnClient::Config.configurations.default
-        if items.nil? || items["messages"] == nil
-          items = {}
-          s = SgtnClient::Source.getSources(component, default)
-          if s.nil?
-            SgtnClient.logger.error "[Translation][getStrings] Missing component: #{component}, locale: #{locale}"
-          else
-            default_component, value = s.first
-            items["component"] = component
-            items["messages"] = value
-            items["locale"] = 'source'
-          end
-        end
-        return items
-       end
+      # <b>DEPRECATED:</b> Please use <tt>Sgtn:get_translations</tt> instead.
+      def getStrings(component, locale)
+        get_translations(component, locale)
+      end
 
+      # raise error when translation is not found
+      def translate(key, component, locale = nil, **kwargs)
+        SgtnClient.logger.debug "[#{method(__callee__).owner}.#{__callee__}] key: #{key}, component: #{component}, locale: #{locale}, args: #{kwargs}"
 
-      private
+        locale = locale.nil? ? self.locale : SgtnClient::LocaleUtil.get_best_locale(locale)
 
-      def self.getTranslation(component, key, locale)
-        locale = SgtnClient::LocaleUtil.get_best_locale(locale)
-        items = get_cs(component, locale)
-        if items.nil? || items["messages"] == nil
-          nil
-        else
-          items["messages"][key]
+        result = get_bundle(component, locale)&.fetch(key, nil)
+        if result.nil? && !LocaleUtil.is_source_locale(locale)
+          locale = LocaleUtil.get_source_locale
+          result = get_bundle(component, locale)&.fetch(key, nil)
         end
-      end
 
-      def self.get_cs(component, locale)
-        # source locale always return source bundle
-        if locale == LocaleUtil.get_source_locale
-          sources = SgtnClient::Source.getSources(component, SgtnClient::Config.configurations.default)
-          messages = sources&.first&.last
-          return {'locale' => locale, 'component' => component, 'messages' => messages} if messages
+        if result.nil?
+          return key unless block_given?
+
+          result = yield
+          return if result.nil?
         end
 
-        cache_key = SgtnClient::CacheUtil.get_cachekey(component, locale)
-        SgtnClient.logger.debug "[Translation][get_cs]cache_key=#{cache_key}"
-        expired, items = SgtnClient::CacheUtil.get_cache(cache_key)
-        if items.nil? || expired
-          items = load(component, locale)
-          if items.nil?
-            items = SgtnClient::Source.getSources(component, SgtnClient::Config.configurations.default)
-            SgtnClient::Core::Cache.put(cache_key, items, 60)
-          else
-            SgtnClient::CacheUtil.write_cache(cache_key, items)
-          end
+        if kwargs.empty?
+          result
         else
-          SgtnClient.logger.debug "[Translation]get translations from cache with key: " + cache_key
+          locale = result.locale if result.is_a?(SgtnClient::StringUtil)
+          result.localize(locale) % kwargs
         end
+      end
+      alias t translate
 
-        return items
-       end
+      def get_translations(component, locale = nil)
+        SgtnClient.logger.debug "[#{method(__callee__).owner}.#{__callee__}] component: #{component}, locale: #{locale}"
 
-      def self.load(component, locale)
-        env = SgtnClient::Config.default_environment
-        mode = SgtnClient::Config.configurations[env]["bundle_mode"]
-        SgtnClient.logger.debug "[Translation][load]mode=#{mode}"
-        if mode == 'offline'
-          return load_o(component, locale)
-        else
-          return load_s(component, locale)
+        locale = locale.nil? ? self.locale : SgtnClient::LocaleUtil.get_best_locale(locale)
+        items = get_bundle(component, locale)
+        if items.nil? && !LocaleUtil.is_source_locale(locale)
+          items = get_bundle(component, LocaleUtil.get_source_locale)
+          locale = LocaleUtil.get_source_locale
         end
+
+        { 'component' => component, 'locale' => locale, 'messages' => items || {} } if items
       end
 
-      def self.load_o(component, locale)
-        env = SgtnClient::Config.default_environment
-        product_name = SgtnClient::Config.configurations[env]["product_name"]
-        version = SgtnClient::Config.configurations[env]["version"].to_s
-        translation_bundle = SgtnClient::Config.configurations[env]["translation_bundle"]
-        bundlepath = translation_bundle + "/" + product_name + "/" + version + "/" + component + "/messages_" + locale + ".json"
-        SgtnClient::FileUtil.read_json(bundlepath)
+      def locale
+        RequestStore.store[:locale] ||= SgtnClient::LocaleUtil.get_fallback_locale
       end
 
-      def self.load_s(component, locale)
-        env = SgtnClient::Config.default_environment
-        product_name = SgtnClient::Config.configurations[env]["product_name"]
-        vip_server = SgtnClient::Config.configurations[env]["vip_server"]
-        version = SgtnClient::Config.configurations[env]["version"].to_s
-        url = vip_server + "/i18n/api/v2/translation/products/" + product_name + "/versions/" + version + "/locales/" + locale + "/components/" + component+ "?checkTranslationStatus=false&machineTranslation=false&pseudo=false"
-        begin
-          obj = SgtnClient::Core::Request.get(url)
-        rescue => exception
-          SgtnClient.logger.error exception.message
-        end
-        if obj != nil
-          obj = obj["data"]
-        end
-        return obj
+      def locale=(value)
+        RequestStore.store[:locale] = SgtnClient::LocaleUtil.get_best_locale(value)
       end
 
-  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)
+        id = SgtnClient::Common::BundleID.new(component, locale)
+        bundles = SgtnClient::Config.available_bundles
+        unless bundles.nil? || bundles.empty? || bundles.include?(id)
+          raise SgtnClient::SingletonError, 'bundle is unavailable.'
+        end
+
+        SgtnClient::Config.loader.get_bundle(component, locale)
+      end
+    end
+    extend Implementation
+  end
 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/common/data.rb

@@ -0,0 +1,30 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
+module SgtnClient
+  module Common
+    class BundleID
+      attr_reader :locale, :component
+
+      def initialize(component, locale)
+        @locale = locale
+        @component = component
+        @key = [@component, @locale].hash
+      end
+
+      def hash
+        @key
+      end
+
+      def ==(other)
+       (other.is_a? self.class) && @locale == other.locale && @component == other.component
+      end
+
+      alias eql? ==
+
+      def to_s
+        "locale=#{@locale}, component=#{@component}}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
+module SgtnClient
+  class SingleOperation
+    def initialize(*conditions, &block)
+      raise 'no way to create a new obj' unless block
+
+      @lock = Mutex.new
+      @hash = {}
+
+      @conditions = conditions
+      @creator = block
+    end
+
+    # return new created object
+    def operate(id, *args)
+      @lock.synchronize do
+        obj = @hash[id]
+        @conditions.each do |con|
+          return obj unless con.call(id, obj, *args)
+        end
+        # TODO: whatif returning nil
+        @hash[id] = @creator.call(id, obj, *args)
+      end
+    end
+
+    def remove_object(id)
+      @lock.synchronize do
+        @hash.delete(id)
+      end
+    end
+  end
+end

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

@@ -5,99 +5,30 @@ require 'date'
 
 module SgtnClient::Core
         class Cache
-            Entry = Struct.new(:expiry, :value)
+            Entry = Struct.new(:expiry, :items)
 
             def self.initialize(disabled=false, opts={})
                 @@opts = opts
-                @mutex = Mutex.new
-                if disabled == false
-                    @@data = Hash.new
-                    SgtnClient.logger.debug "[Cache][initialize]cache is enabled!"
-                else
-                    @@data = nil
-                    SgtnClient.logger.debug "[Cache][initialize]cache is disabled!"
-                end
-            end
-
-            def self.keys
-                if @@data == nil
-                    return nil
-                end
-                SgtnClient.logger.debug "[Cache][keys]get cache keys"
-                @@data.keys
+                SgtnClient.logger.debug "[Cache][initialize] Disable cache? #{disabled}"
+                @@data = Hash.new
             end
 
             def self.get(key)
-                if @@data == nil
-                    return nil, nil
-                end
                 SgtnClient.logger.debug "[Cache][get]get cache for key: " + key
-                invalidate(key)
-            end
-
-            def self.has(key)
-                if @@data == nil
-                    return nil
-                end
-                SgtnClient.logger.debug "[Cache][has]check if the cache has key: #{(@@data.has_key? key)}"
-                @@data.has_key? key
+                return @@data&.dig(key)
             end
 
-            def self.put(key, value, ttl=nil)
-                @mutex.synchronize do
-                    if @@data == nil || value == nil
-                        return nil
-                    end
-                    ttl ||= @@opts[:ttl]
-                    # hours from new
-                    SgtnClient.logger.debug "[Cache][put]put cache for key '" + key + "' with expired time at'" + (Time.now + ttl*60).to_s
-                    @@data[key] = Entry.new(Time.now + ttl*60, value)
-                end
-            end
-
-            def self.delete(key)
-                @mutex.synchronize do
-                    if @@data == nil
-                        return nil
-                    end
-                    SgtnClient.logger.debug "[Cache][delete]delete cache for key: " + key
-                    @@data.delete key
-                end
+            def self.put(key, items, ttl=nil)
+                ttl ||= @@opts[:ttl]
+                # hours from new
+                SgtnClient.logger.debug "[Cache][put]put cache for key '" + key + "' with expired time at'" + (Time.now + ttl*60).to_s
+                @@data[key] = Entry.new(Time.now + ttl*60, items)
             end
 
             def self.clear
-                @mutex.synchronize do
-                    if @@data == nil
-                        return nil
-                    end
-                    SgtnClient.logger.debug "[Cache][clear]clear cache!"
-                    @@data = Hash.new
-                end
-            end
-
-            def self.invalidate(key)
-                @mutex.synchronize do
-                    if @@data == nil
-                        return nil, nil
-                    end
-                    SgtnClient.logger.debug "[Cache][invalidate]invalidate expired cache......"
-                    now = Time.now
-                    if has(key)
-                        v = @@data[key]
-                        expired = false
-                        SgtnClient.logger.debug "[Cache][invalidate]check cache: key=#{key}, expiredtime=#{v[:expiry]}, now=#{now}, expired=#{(v[:expiry] < now)}"
-                        if v[:expiry] < now
-                            SgtnClient.logger.debug "[Cache][invalidate]before deleting the cache: data=#{@@data}"
-                            @@data.delete(key)
-                            SgtnClient.logger.debug "[Cache][invalidate]after deleting the cache: data=#{@@data}"
-                            expired = true
-                        end
-                        return expired, v[:value]
-                    else
-                        return nil, nil
-                    end
-                end
+                SgtnClient.logger.debug "[Cache][clear]clear cache!"
+                @@data = Hash.new
             end
         end
 
-end
+end