opal-i18next 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6e23990c8b1a275471ba5880ea7b75db97794620ef037d28b411c21986b1d6d
-  data.tar.gz: 1ef817b85846c9bb8b7a93321aef9bf15a637bec76947ca6362579ec497cb94b
+  metadata.gz: a608d9ba3fba9ee08cc35ee247cad22a5c89c9950232c7f9f70c73e588d6da9a
+  data.tar.gz: 8e82b9dadb4b73f55d5156ac1deccfe7c1b17f1c64abec548734c33f7b9c040b
 SHA512:
-  metadata.gz: 4288938af6057505cc90f478ff7c366e0a95be8a35257729800c1480b814ffc5f88e8d86b9e3a8a2e0e014933a0e85bbc14b97fba16f578f251d3019d2fb36a6
-  data.tar.gz: ad2988876b8b3dafd899da0949d0380280d85ff564d52eb3be1b187a12d0cd2bd02b69606e48e71e47476f0177cb8750bd256312eed74653ae364f55d80131cc
+  metadata.gz: 904501d0d9ef54c0c23a011cb5326db007e06f5d6ae42880e778330ce68003e3b667a6d5c19b92a3be4ee95f9dcc7b1c147e4fd2e732208139038f0bb85ba74e
+  data.tar.gz: 7494d5183b943f29a92745405684c97569bff3309396f7abc9eebdf558185c0c616e3e68c6156d8866ba3f4be8cf1a4774a99d8d5c172242a4674152ac872240

data/.yardopts

@@ -0,0 +1 @@
+--no-private opal/i18next/**/*.rb

data/opal/i18next/i18next.rb

@@ -1,5 +1,6 @@
 require "opal"
 require "native"
+require "json"
 
   # Uses PromiseV2 if present
   # @see https://opalrb.com/docs/guides/v1.5.1/async PromiseV2
@@ -9,14 +10,29 @@ require "native"
 
   # {I18next} is a basic wrapper around the JavaScript {https://www.i18next.com i18next module}.
   #
-  # It wraps i18next methods {https://www.i18next.com/overview/api#init init},
-  # {https://www.i18next.com/overview/api#use use},
-  # {https://www.i18next.com/overview/api#t t},
-  # {https://www.i18next.com/overview/api#changelanguage changeLanguage}, and
-  # {https://www.i18next.com/overview/api#language language}.
+  # It wraps i18next methods {https://www.i18next.com/overview/api#addResource addResource},
+  # {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#getResource getResource},
+  # {https://www.i18next.com/overview/api#getResourceBundle getResourceBundle},
+  # {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#loadNamespaces loadNamespaces},
+  # {https://www.i18next.com/overview/api#resolvedLanguage resolvedLanguage},
+  # {https://www.i18next.com/overview/api#setDefaultNamespace setDefaultNamespace},
+  # {https://www.i18next.com/overview/api#t t}, and
+  # {https://www.i18next.com/overview/api#use use}.
   # It also provides method {#import_js_module} for loading {https://www.i18next.com/overview/plugins-and-utils i18next plugins}.
   class I18next
 
+    # Each I18next instance has its own i18next Javascript module
+    def initialize
+      @i18next = `i18next.createInstance()`
+    end
+
     # Imports a JavaScript module (ESM)
     #
     # Use this method to import {https://www.i18next.com/overview/plugins-and-utils i18next JavaScript plugins}
@@ -44,16 +60,16 @@ require "native"
     # @param js_module a plugin's JavaScript module that was imported
     #   by method {#import_js_module}
     def use(js_module)
-      `i18next.use(js_module.default)`
+      `#{@i18next}.use(js_module.default)`
     end
 
     # Initializes {https://www.i18next.com/overview/api#init i18next}
-    # @param options [Hash] a hash with keys matching the {https://www.i18next.com/overview/configuration-options i18next options}
+    # @param options [Hash] a hash with keys matching the {https://www.i18next.com/overview/configuration-options i18next options}.
     # @return [Promise] a promise that resolves when i18next has been initialized
-    def init(options)
+    def init(options = {})
       promise = Promise.new
       `
-      i18next.init(#{options.to_n})
+      #{@i18next}.init(#{options.to_n})
         .then(
           t => {
             promise.$resolve(t);
@@ -69,9 +85,9 @@ require "native"
     def change_language(language)
       promise = Promise.new
       `
-      i18next.changeLanguage(language).then(
-          t => {
-            promise.$resolve(t)
+      #{@i18next}.changeLanguage(language).then(
+          () => {
+            promise.$resolve()
           });
       `
       promise
@@ -79,14 +95,150 @@ require "native"
 
     # @return [String] the current {https://www.i18next.com/overview/api#language i18next} language
     def language
-      `i18next.language`
+      `#{@i18next}.language`
     end
 
     # The {https://www.i18next.com/overview/api#t i18next} translation associated with a key
-    # @param [String] key a key that references a translation, single key only
-    # @return [String] the translation associated with the key
-    def t(key)
-      `i18next.t(key)`
+    # @param [String, Array<String>] key one or more keys that reference translations
+    # @param [Hash] options options for formatters, post processors, etc.
+    # @return [String] the translation associated with the first key that resolves
+    def t(key, options={})
+      `#{@i18next}.t(key, #{options.to_n})`
+    end
+
+    # @return [Boolean] true if the key exists
+    def exists(key)
+      `#{@i18next}.exists(key)`
+    end
+
+    # @private
+    def get_fixed_t
+      raise 'Not implemented'
+    end
+
+    # @see https://www.i18next.com/overview/api#languages The i18next languages method
+    # @return language codes that will be used to look up the translation value
+    def languages
+      `#{@i18next}.languages`
+    end
+
+    # @see https://www.i18next.com/overview/api#resolvedLanguage The i18next resolvedLanguage method
+    # @return the current resolved language
+    def resolved_language
+      `#{@i18next}.resolvedLanguage`
+    end
+
+    # Loads additional namespaces not defined in init options
+    # @param [String, Array<String>] ns 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)
+      promise = Promise.new
+      `
+      #{@i18next}.loadNamespaces(ns)
+        .then(
+          () => {
+            promise.$resolve()
+          });
+      `
+      promise
+    end
+
+    # @private
+    def load_languages(*lngs)
+      raise 'Not implemented'
+    end
+
+    # @private
+    def reload_resources
+      raise 'Not implemented'
+    end
+
+    # Changes the default namespace.
+    # @param ns [String] new default namespace
+    # @see https://www.i18next.com/overview/api#setDefaultNamespace The i18next setDefaultNamespace method
+    def set_default_namespace(ns)
+      `#{@i18next}.setDefaultNamespace(ns)`
+    end
+
+    # Get a language's reading direction
+    # @param lng [String] the language; if omitted, the current language is used
+    # @return "ltr" or "rtl"
+    # @see https://www.i18next.com/overview/api#dir The i18next dir method
+    def dir(lng)
+      `#{@i18next}.dir(lng)`
     end
+
+    # @private
+    def format(data, format, lng)
+      raise 'Not implemented'
+    end
+
+    # @private
+    def create_instance(options)
+      raise 'Not implemented'
+    end
+
+    # @private
+    def clone_instance(options)
+      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 = {})
+      `#{@i18next}.getResource(lng, ns, key, options)`
+    end
+
+    # Adds one key/value.
+    # @see https://www.i18next.com/overview/api#addResource The i18next addResource method
+    def add_resource(lng, ns, key, value, options = {})
+      `#{@i18next}.addResource(lng, ns, key, value, options)`
+    end
+
+    # Adds multiple key/values.
+    # @param resources [Hash] key/value pairs
+    # @see https://www.i18next.com/overview/api#addResources The i18next addResources method
+    def add_resources(lng, ns, resources)
+      `#{@i18next}.addResources(lng, ns, #{resources.to_n})`
+    end
+
+    # @private
+    def add_resource_bundle(lng, ns, resouces, deep, overwrite)
+      raise 'Not implemented'
+    end
+
+    # @private
+    def has_resource_bundle(lng, ns)
+      raise 'Not implemented'
+    end
+
+    # @private
+    def get_data_by_language(lng)
+      raise 'Not implemented'
+    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))`)
+    end
+
+    # @private
+    def remove_resource_bundle(lng, ns)
+      raise 'Not implemented'
+    end
+
   end
 end

data/opal/i18next/version.rb

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

data/opal-i18next.gemspec

@@ -6,8 +6,10 @@ 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
-    init, use, t, changeLanguage, and language. Is also provides method
-    import_js_module for loading i18next plugins.
+    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.
   DESC
   spec.authors = ["Larry North"]
 
@@ -22,6 +24,7 @@ Gem::Specification.new do |spec|
   }
 
   spec.files += Dir["*.gemspec"]
+  spec.files += Dir[".yardopts"]
   spec.files += Dir["lib/**/*"]
   spec.files += Dir["opal/**/*"]
   spec.require_paths = ["lib"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opal-i18next
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Larry North
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-23 00:00:00.000000000 Z
+date: 2022-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal
@@ -26,14 +26,17 @@ dependencies:
         version: 1.5.0
 description: |
   A basic Opal wrapper for the JavaScript i18next module that supports methods
-  init, use, t, changeLanguage, and language. Is also provides method
-  import_js_module for loading i18next plugins.
+  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.
 email:
 - lnorth@swnorth.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - lib/opal-i18next.rb
 - lib/opal/i18next.rb
 - opal-i18next.gemspec