opal-i18next 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c6e23990c8b1a275471ba5880ea7b75db97794620ef037d28b411c21986b1d6d
+  data.tar.gz: 1ef817b85846c9bb8b7a93321aef9bf15a637bec76947ca6362579ec497cb94b
+SHA512:
+  metadata.gz: 4288938af6057505cc90f478ff7c366e0a95be8a35257729800c1480b814ffc5f88e8d86b9e3a8a2e0e014933a0e85bbc14b97fba16f578f251d3019d2fb36a6
+  data.tar.gz: ad2988876b8b3dafd899da0949d0380280d85ff564d52eb3be1b187a12d0cd2bd02b69606e48e71e47476f0177cb8750bd256312eed74653ae364f55d80131cc

data/lib/opal/i18next.rb

@@ -0,0 +1,3 @@
+require 'opal'
+
+Opal.append_path File.expand_path("../../../opal", __FILE__).untaint

data/lib/opal-i18next.rb

@@ -0,0 +1 @@
+require 'opal/i18next'

data/opal/i18next/i18next.rb

@@ -0,0 +1,92 @@
+require "opal"
+require "native"
+
+  # 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#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 also provides method {#import_js_module} for loading {https://www.i18next.com/overview/plugins-and-utils i18next plugins}.
+  class I18next
+
+    # Imports a JavaScript module (ESM)
+    #
+    # Use this method to import {https://www.i18next.com/overview/plugins-and-utils i18next JavaScript plugins}
+    # that can be passed to the {#use} method.
+    #
+    # @param module_path [String] the path to the module's *.js file, may be a
+    #   file path or a URL
+    #
+    # @return [Promise] a promise that resolves to the JavaScript module that can be passed
+    #  to the {#use} method
+    #
+    def import_js_module(module_path)
+      promise = Promise.new
+      `
+      import(module_path).then(
+        module => {
+          promise.$resolve(module);
+        });
+        `
+      promise
+    end
+
+    # Loads an {https://www.i18next.com/overview/api#use i18next} plugin
+    #
+    # @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)`
+    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}
+    # @return [Promise] a promise that resolves when i18next has been initialized
+    def init(options)
+      promise = Promise.new
+      `
+      i18next.init(#{options.to_n})
+        .then(
+          t => {
+            promise.$resolve(t);
+          });
+      `
+      promise
+    end
+
+    # Changes the {https://www.i18next.com/overview/api#changelanguage i18next} language
+    # @param language [String] the new language
+    # @return [Promise] a promise that resolves when the language's
+    #   translations have been loaded
+    def change_language(language)
+      promise = Promise.new
+      `
+      i18next.changeLanguage(language).then(
+          t => {
+            promise.$resolve(t)
+          });
+      `
+      promise
+    end
+
+    # @return [String] the current {https://www.i18next.com/overview/api#language i18next} language
+    def 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)`
+    end
+  end
+end

data/opal/i18next/version.rb

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

data/opal/opal-i18next.rb

@@ -0,0 +1,2 @@
+require 'i18next/i18next'
+require 'i18next/version'

data/opal-i18next.gemspec

@@ -0,0 +1,32 @@
+require_relative "opal/i18next/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "opal-i18next"
+  spec.version = I18next::VERSION
+  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.
+  DESC
+  spec.authors = ["Larry North"]
+
+  spec.license = "MIT"
+  spec.email = ["lnorth@swnorth.com"]
+  spec.homepage = "https://github.com/LarryNorth/opal-i18next"
+  spec.metadata = {
+    "bug_tracker_uri"   => "https://github.com/LarryNorth/opal-i18next/issues",
+    "documentation_uri" => "https://www.rubydoc.info/gems/opal-i18next",
+    "homepage_uri"      => spec.homepage,
+    "source_code_uri"   => "https://github.com/LarryNorth/opal-i18next"
+  }
+
+  spec.files += Dir["*.gemspec"]
+  spec.files += Dir["lib/**/*"]
+  spec.files += Dir["opal/**/*"]
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 3.1"
+
+  spec.add_dependency 'opal', '~> 1.5.0'
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: opal-i18next
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Larry North
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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.
+email:
+- lnorth@swnorth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/opal-i18next.rb
+- lib/opal/i18next.rb
+- opal-i18next.gemspec
+- opal/i18next/i18next.rb
+- opal/i18next/version.rb
+- opal/opal-i18next.rb
+homepage: https://github.com/LarryNorth/opal-i18next
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/LarryNorth/opal-i18next/issues
+  documentation_uri: https://www.rubydoc.info/gems/opal-i18next
+  homepage_uri: https://github.com/LarryNorth/opal-i18next
+  source_code_uri: https://github.com/LarryNorth/opal-i18next
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: An Opal wrapper for the JavaScript i18next module.
+test_files: []