opal-i18next 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a608d9ba3fba9ee08cc35ee247cad22a5c89c9950232c7f9f70c73e588d6da9a
-  data.tar.gz: 8e82b9dadb4b73f55d5156ac1deccfe7c1b17f1c64abec548734c33f7b9c040b
+  metadata.gz: 44c564b588879276f62325e8812dcab71272bffbd1c97e5cb122a0ef00039314
+  data.tar.gz: 0e588fd5cc1a8bc63d5060b52e862b9dbe7375f96673971eb421baca723aaf46
 SHA512:
-  metadata.gz: 904501d0d9ef54c0c23a011cb5326db007e06f5d6ae42880e778330ce68003e3b667a6d5c19b92a3be4ee95f9dcc7b1c147e4fd2e732208139038f0bb85ba74e
-  data.tar.gz: 7494d5183b943f29a92745405684c97569bff3309396f7abc9eebdf558185c0c616e3e68c6156d8866ba3f4be8cf1a4774a99d8d5c172242a4674152ac872240
+  metadata.gz: 76a08af7bd190a3538c98e47112a69cf183d6ec023b959af778e25f7b55effcaa64f34dbb0eff19de8dd674c3017b726c1b09ed92315f1f582d216eb337dd32d
+  data.tar.gz: c58800b3e827727ccac4ac8d001ca2444ff30e378ee38c1053edc8083f30b84af6cbd6f79b5d48eb6b8112c0a470423eb392d607dcf7d467fb06e4a94d6af578

data/opal/i18next/i18next.rb

@@ -2,29 +2,42 @@ require "opal"
 require "native"
 require "json"
 
-  # Uses PromiseV2 if present
-  # @see https://opalrb.com/docs/guides/v1.5.1/async PromiseV2
-  module I18next
+# Uses PromiseV2 if present
+# @see https://opalrb.com/docs/guides/v1.5.1/async PromiseV2
+module I18next
 
   Promise = defined?(PromiseV2) ? PromiseV2 : ::Promise
 
   # {I18next} is a basic wrapper around the JavaScript {https://www.i18next.com i18next module}.
   #
   # It wraps i18next methods {https://www.i18next.com/overview/api#addResource addResource},
+  # {https://www.i18next.com/overview/api#addResourceBundle addResourceBundle},
   # {https://www.i18next.com/overview/api#addResources addResources},
   # {https://www.i18next.com/overview/api#changelanguage changeLanguage},
   # {https://www.i18next.com/overview/api#dir dir},
   # {https://www.i18next.com/overview/api#exists exists},
+  # {https://www.i18next.com/overview/api#getDataByLanguage getDataByLanguage},
+  # {https://www.i18next.com/overview/api#getFixedT getFixedT},
   # {https://www.i18next.com/overview/api#getResource getResource},
   # {https://www.i18next.com/overview/api#getResourceBundle getResourceBundle},
+  # {https://www.i18next.com/overview/api#hasResourceBundle hasResourceBundle},
   # {https://www.i18next.com/overview/api#init init},
   # {https://www.i18next.com/overview/api#language language},
   # {https://www.i18next.com/overview/api#languages languages},
+  # {https://www.i18next.com/overview/api#loadLanguages loadLanguages},
   # {https://www.i18next.com/overview/api#loadNamespaces loadNamespaces},
+  # {https://www.i18next.com/overview/api#events off},
+  # {https://www.i18next.com/overview/api#events on},
+  # {https://www.i18next.com/overview/api#removeResourceBundle removeResourceBundle},
   # {https://www.i18next.com/overview/api#resolvedLanguage resolvedLanguage},
   # {https://www.i18next.com/overview/api#setDefaultNamespace setDefaultNamespace},
+  # {https://www.i18next.com/overview/api#https://www.i18next.com/overview/api#store-events store.on},
   # {https://www.i18next.com/overview/api#t t}, and
   # {https://www.i18next.com/overview/api#use use}.
+  #
+  # It can handle {https://www.i18next.com/overview/api#events i18next events}. See methods on
+  # and off.
+  #
   # It also provides method {#import_js_module} for loading {https://www.i18next.com/overview/plugins-and-utils i18next plugins}.
   class I18next
 
@@ -59,8 +72,10 @@ require "json"
     #
     # @param js_module a plugin's JavaScript module that was imported
     #   by method {#import_js_module}
+    # @return [I18next::I18next] self
     def use(js_module)
       `#{@i18next}.use(js_module.default)`
+      self
     end
 
     # Initializes {https://www.i18next.com/overview/api#init i18next}
@@ -111,9 +126,24 @@ require "json"
       `#{@i18next}.exists(key)`
     end
 
-    # @private
-    def get_fixed_t
-      raise 'Not implemented'
+    # Returns a Proc that acts a +t+ method that defaults to a language and namespace.
+    # @example When calling the returned Proc, use brackets, not parentheses
+    #   en = get_fixed_t("en")
+    #   translation = en["key"]
+    # @param lng [String] language
+    # @param ns [String] namespace
+    # @param key_prefix [String] key prefix
+    # @see https://www.i18next.com/overview/api#getFixedT The i18next getFixedT method
+    def get_fixed_t(lng = nil, ns = nil, key_prefix = nil)
+      if key_prefix && ns && lng
+        `#{@i18next}.getFixedT(lng, ns, key_prefix)`
+      elsif ns && lng
+        `#{@i18next}.getFixedT(lng, ns)`
+      elsif lng
+        `#{@i18next}.getFixedT(lng)`
+      else
+        `#{@i18next}.getFixedT()`
+      end
     end
 
     # @see https://www.i18next.com/overview/api#languages The i18next languages method
@@ -129,7 +159,7 @@ require "json"
     end
 
     # Loads additional namespaces not defined in init options
-    # @param [String, Array<String>] ns one or more namespaces
+    # @param ns [String, Array<String>] one or more namespaces
     # @return [Promise] a promise that resolves when the namespaces have been loaded
     # @see https://www.i18next.com/overview/api#loadNamespaces The i18next loadNamespaces method
     def load_namespaces(ns)
@@ -144,9 +174,20 @@ require "json"
       promise
     end
 
-    # @private
-    def load_languages(*lngs)
-      raise 'Not implemented'
+    # Loads additional languages not defined in init options (preload).
+    # @param lngs [String, Array<String>] one or more languages
+    # @return [Promise] a promise that resolves when the languages have been loaded
+    # @see https://www.i18next.com/overview/api#loadLanguages The i18next loadLanguages method
+    def load_languages(lngs)
+      promise = Promise.new
+      `
+      #{@i18next}.loadLanguages(lngs)
+      .then(
+        () => {
+          promise.$resolve()
+        });
+    `
+      promise
     end
 
     # @private
@@ -184,16 +225,6 @@ require "json"
       raise 'Not implemented'
     end
 
-    # @private
-    def off
-      raise 'Not implemented'
-    end
-
-    # @private
-    def on
-      raise 'Not implemented'
-    end
-
     # Gets one value by given key.
     # @see https://www.i18next.com/overview/api#getResource The i18next getResource method
     def get_resource(lng, ns, key, options = {})
@@ -213,32 +244,129 @@ require "json"
       `#{@i18next}.addResources(lng, ns, #{resources.to_n})`
     end
 
-    # @private
-    def add_resource_bundle(lng, ns, resouces, deep, overwrite)
-      raise 'Not implemented'
+    # Adds a complete bundle
+    # @param lng [String] bundle language
+    # @param ns [String] bundel namespace
+    # @param deep [Boolean] if true will extend existing translations in the bundle
+    # @param overwrite [Boolean] if true it will overwrite existing translations in the bundle
+    # @see https://www.i18next.com/overview/api#addResourceBundle The i18next addResourceBundle method
+    def add_resource_bundle(lng, ns, resources, deep = false, overwrite = false)
+      `#{@i18next}.addResources(lng, ns, #{resources.to_n}, deep, overwrite)`
     end
 
-    # @private
+    # Checks if a resource bundle exists
+    # @param lng [String] language
+    # @param ns [String] namespace
     def has_resource_bundle(lng, ns)
-      raise 'Not implemented'
+      `#{@i18next}.hasResourceBundle(lng, ns)`
     end
 
-    # @private
+    # Returns resource data for a language.
+    # @param lng [String] language
+    # @return resource data
+    # @see https://www.i18next.com/overview/api#getDataByLanguage The i18next getDataByLanguage method
     def get_data_by_language(lng)
-      raise 'Not implemented'
+      js_obj_to_ruby_hash(`#{@i18next}.getDataByLanguage(lng)`)
     end
 
     # Gets a resource bundle.
     # @return [Hash] key/value pairs
     # @see https://www.i18next.com/overview/api#getResourceBundle The i18next getResourceBundle method
     def get_resource_bundle(lng, ns)
-      JSON.parse(`JSON.stringify(#{@i18next}.getResourceBundle(lng, ns))`)
+      js_obj_to_ruby_hash(`#{@i18next}.getResourceBundle(lng, ns)`)
     end
 
-    # @private
+    # Removes a resource bundle exists
+    # @param lng [String] language
+    # @param ns [String] namespace
     def remove_resource_bundle(lng, ns)
-      raise 'Not implemented'
+      `#{@i18next}.removeResourceBundle(lng, ns)`
+    end
+
+    # Create a listener for an i18next event.
+    # @param event [String] event name
+    # @param &listener [block] an event listener that is passed event-dependent arguments
+    # @return [Proc] the listener, which can be used to unsubscribe it via method off(event, listener)
+    # @see https://www.i18next.com/overview/api#events The i18next events
+    # @see #off
+    def on(event, &listener)
+      # Some events require special listeners because those events return JavaScript objects
+      # to the listeners, and those object must be converted to Ruby Hashes.
+      case event
+      when "initialized"
+        _onInitialized(listener)
+      when "loaded"
+        _onLoaded(listener)
+      else
+        `#{@i18next}.on(event, listener)`
+      end
+      listener
+    end
+
+    # Create a listener for an i18next store event.
+    #
+    # Only available after the init call.
+    #
+    # @param event [String] event name ("added" or "removed")
+    # @param &listener [block] an event listener that is passed language and namespace arguments
+    # @return [Proc] the listener, which can be used to unsubscribe it via method off(event, listener)
+    # @see https://www.i18next.com/overview/api#store-events The i18next store events
+    def store_on(event, &listener)
+      `#{@i18next}.store.on(event, listener)`
+      listener
+    end
+
+    # Unsubscribes an event's listener(s)
+    # @param event [String] event name
+    # @param listener [Proc] the listener to unsubscribe; if absent, unsubscribe all listeners
+    def off(event, listener = nil)
+      if listener
+        `#{@i18next}.off(event, listener)`
+      else
+        `#{@i18next}.off(event)`
+      end
     end
 
+    private
+
+    # @private
+    # Create a listener for the i18next initialized event.
+    # @param &listener [Proc] an event listener block that is passed initialized options Hash
+    # @see https://www.i18next.com/overview/api#oninitialized The i18next initialized event
+    def _onInitialized(listener)
+      `
+      #{@i18next}.on("initialized", (options) => {
+        // Convert the JavaScript options object to a string and
+        // then convert that string to a Ruby hash that is passed
+        // to the listener.
+        listener.$call(Opal.JSON.$parse(JSON.stringify(options)))
+      })
+      `
+    end
+
+    # @private
+    # Create a listener for the i18next loaded event.
+    # @param listener [Proc] an event listener block that is passed loaded Hash
+    # @see https://www.i18next.com/overview/api#onloaded The i18next onLoaded event
+    def _onLoaded(listener)
+      `
+      #{@i18next}.on("loaded", (loaded) => {
+        // Convert the JavaScript load object to a string and
+        // then convert that string to a Ruby hash that is passed
+        // to the listener.
+        listener.$call(Opal.JSON.$parse(JSON.stringify(loaded)))
+      })
+      `
+    end
+
+    # @private
+    # Convert a JavaScript obj to a Ruby Hash.
+    # @param js_obj JavaScript object
+    # @return [Hash] Ruby Hash
+    def js_obj_to_ruby_hash(js_obj)
+      # Convert the JavaScript object to a string and then convert that string
+      # to a Ruby hash.
+      JSON.parse(`JSON.stringify(js_obj)`)
+    end
   end
 end

data/opal/i18next/version.rb

@@ -1,3 +1,3 @@
 module I18next
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/opal-i18next.gemspec

@@ -6,10 +6,11 @@ Gem::Specification.new do |spec|
   spec.summary = "An Opal wrapper for the JavaScript i18next module."
   spec.description = <<~DESC
     A basic Opal wrapper for the JavaScript i18next module that supports methods
-    addResource, addResources, changeLanguage, dir, exists, getResource,
-    getResourceBundle, init, language, languages, loadNamespaces, resolvedLanguage,
-    t, and use. It also provides method import_js_module for
-    loading i18next plugins.
+    addResource, addResourceBundle, addResources, changeLanguage, dir, exists,
+    getDataByLanguage, getFixedT, getResource, getResourceBundle, hasResourceBundle,
+    init, language, languages, loadLanguages, loadNamespaces, off, on,
+    removeResourceBundle, resolvedLanguage, store.on, t, and use. It also
+    provides method import_js_module for loading i18next plugins.
   DESC
   spec.authors = ["Larry North"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opal-i18next
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Larry North
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-31 00:00:00.000000000 Z
+date: 2022-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal
@@ -26,10 +26,11 @@ dependencies:
         version: 1.5.0
 description: |
   A basic Opal wrapper for the JavaScript i18next module that supports methods
-  addResource, addResources, changeLanguage, dir, exists, getResource,
-  getResourceBundle, init, language, languages, loadNamespaces, resolvedLanguage,
-  t, and use. It also provides method import_js_module for
-  loading i18next plugins.
+  addResource, addResourceBundle, addResources, changeLanguage, dir, exists,
+  getDataByLanguage, getFixedT, getResource, getResourceBundle, hasResourceBundle,
+  init, language, languages, loadLanguages, loadNamespaces, off, on,
+  removeResourceBundle, resolvedLanguage, store.on, t, and use. It also
+  provides method import_js_module for loading i18next plugins.
 email:
 - lnorth@swnorth.com
 executables: []