i18n-js 4.2.3 → 4.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08fcf5b6b9e3cff755d11708a88e88cc8d30609251cba16f52e396a86014ac85'
-  data.tar.gz: 90b3fa30d3e6115fe76f81b5621caba070160cf585890f122aa8f646ee10fd2e
+  metadata.gz: f067f8059ef5fe37c2fdb9624cf260e00b3eb60a87492aebccb0b13f170ff17d
+  data.tar.gz: 73acf779ba9a46921e44e4106e66eab2c5d05b7b1163cb93b2889abf446977e0
 SHA512:
-  metadata.gz: 02d7a1a0d46b452727465a35cc9a9c46f4e8fe3d0baee2680e75d70fd6512972c7a28481795f9d0a07295612bd8553b932fb27fae2e86f83adc39e4d8aec5209
-  data.tar.gz: 9987a9679a3aa39f50f70e4b7b67469c2c7549b61b738f3104b837119a1afeb253e932119f24bdb39f29ffdb9b1840aa4f9b20035d1a70f71e51cfc8f0310b03
+  metadata.gz: a71ec7995b41c9e9c56168dccd1a87e1e872c3bfa98075c135aa9d6f4f0259fef6da8e8db81fd1fa63966775b5bd28185ee086a6206c0600b113827938b73412
+  data.tar.gz: be12ef7d7665f61d40abd05849cb25dc303c1679c08e6ed535123e9389cb5d968946b4d716d541bc5e10f8d1384040b7935e56aa0c84d682d0964a0698683d50

data/.github/workflows/ruby-tests.yml

@@ -16,8 +16,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7", "3.0", "3.1"]
-        node: ["16", "18"]
+        ruby: ["3.3", "3.4"]
+        node: ["22", "24"]
         gemfile:
           - Gemfile
     if: |
@@ -25,9 +25,9 @@ jobs:
       github.actor != 'dependabot[bot]'
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         id: bundler-cache
         with:
           path: vendor/bundle
@@ -35,7 +35,7 @@ jobs:
             ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
             hashFiles(matrix.gemfile) }}
 
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         id: npm-cache
         with:
           path: vendor/bundle
@@ -44,7 +44,7 @@ jobs:
             hashFiles('package.json') }}
 
       - name: Set up Node
-        uses: actions/setup-node@v3.6.0
+        uses: actions/setup-node@v4.0.2
         with:
           node-version: ${{ matrix.node }}
 

data/.rubocop.yml

@@ -3,7 +3,7 @@ inherit_gem:
   rubocop-fnando: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.2
   NewCops: enable
   Exclude:
     - tmp/**/*
@@ -17,3 +17,9 @@ Naming/FileName:
 
 Style/PerlBackrefs:
   Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Gemspec/AttributeAssignment:
+  Enabled: false

data/README.md

@@ -36,6 +36,12 @@ Or add the following line to your project's Gemfile:
 gem "i18n-js"
 ```
 
+Create a default configuration file in ./config/i18n.yml
+
+```bash
+i18n init
+```
+
 ## Usage
 
 About patterns:
@@ -73,8 +79,11 @@ translations:
 
 The output path can use the following placeholders:
 
-- `:locale`: the language that's being exported.
-- `:digest`: the MD5 hex digest of the exported file.
+- `:locale` - the language that's being exported.
+- `:digest` - the MD5 hex digest of the exported file.
+
+The example above could generate a file named
+`app/frontend/locales/en.7bdc958e33231eafb96b81e3d108eff3.json`.
 
 The config file is processed as erb, so you can have dynamic content on it if
 you want. The following example shows how to use groups from a variable.
@@ -92,13 +101,28 @@ translations:
       - "!<%= group %>.number.nth"
 ```
 
+### Exporting locale.yml to locale.json
+
+Your i18n yaml file can be exported to JSON using the Ruby API or the command
+line utility. Examples of both approaches are provided below:
+
 The Ruby API:
 
 ```ruby
 require "i18n-js"
 
+# The following call performs the same task as the CLI `i18n export` command
 I18nJS.call(config_file: "config/i18n.yml")
+
+# You can provide the config directly using the following
+config = {
+  "translations"=>[
+    {"file"=>"app/javascript/locales/:locale.json", "patterns"=>["*"]}
+  ]
+}
+
 I18nJS.call(config: config)
+#=> ["app/javascript/locales/de.json", "app/javascript/locales/en.json"]
 ```
 
 The CLI API:
@@ -136,6 +160,7 @@ the default locale together with the target locale.
 To use it, add the following to your configuration file:
 
 ```yaml
+---
 embed_fallback_translations:
   enabled: true
 ```
@@ -147,6 +172,7 @@ plugin allows exporting other file formats. To use it, add the following to your
 configuration file:
 
 ```yaml
+---
 export_files:
   enabled: true
   files:
@@ -154,7 +180,7 @@ export_files:
       output: "%{dir}/%{base_name}.ts"
 ```
 
-You can export multiple files by define more entries.
+You can export multiple files by defining more entries.
 
 The output name can use the following placeholders:
 
@@ -210,7 +236,10 @@ i18n.store({
 
 You can transform the exported translations by adding plugins. A plugin must
 inherit from `I18nJS::Plugin` and can have 4 class methods (they're all optional
-and will default to a noop implementation). For real examples, see [lib/i18n-js/embed_fallback_translations_plugin.rb](https://github.com/fnando/i18n-js/blob/main/lib/i18n-js/embed_fallback_translations_plugin.rb) and [lib/i18n-js/export_files_plugin.rb](https://github.com/fnando/i18n-js/blob/main/lib/i18n-js/export_files_plugin.rb)
+and will default to a noop implementation). For real examples, see
+[lib/i18n-js/embed_fallback_translations_plugin.rb](https://github.com/fnando/i18n-js/blob/main/lib/i18n-js/embed_fallback_translations_plugin.rb)
+and
+[lib/i18n-js/export_files_plugin.rb](https://github.com/fnando/i18n-js/blob/main/lib/i18n-js/export_files_plugin.rb)
 
 ```ruby
 # frozen_string_literal: true
@@ -299,8 +328,8 @@ $ i18n lint:translations
    - pt-BR.github.repository (extraneous)
 ```
 
-This command will exist with status 1 whenever there are missing translations.
-This way you can use it as a CI linting.
+This command will exit with status 1 whenever there are missing translations.
+This way you can use it as a CI linting tool.
 
 You can ignore keys by adding a list to the config file:
 
@@ -375,8 +404,9 @@ $ i18n lint:scripts
    - test/scripts/lint/file.js:6:1: es.another_ignore_scope
 ```
 
-This command will list all locales and their missing translations. Avoid listing
-a particular translation, you can set `lint.ignore` on your config file.
+This command will list all locales and their missing translations. To avoid
+listing a particular translation, you can set `lint_scripts.ignore` or
+`lint_translations.ignore` in your config file.
 
 ```yaml
 ---
@@ -401,7 +431,7 @@ translations:
     patterns:
       - "*"
 
-lint:
+lint_scripts:
   patterns:
     - "app/assets/**/*.ts"
 ```
@@ -438,7 +468,7 @@ watchman -j <<-JSON
 JSON
 
 # If you're running this through Foreman,
-# the uncomment the following lines:
+# then uncomment the following lines:
 # while true; do
 #   sleep 1
 # done
@@ -520,7 +550,7 @@ that loads all the exported translation.
 [There's a document](https://github.com/fnando/i18n-js/tree/main/MIGRATING_FROM_V3_TO_V4.md)
 outlining some of the things you need to do to migrate from v3 to v4. It may not
 be as complete as we'd like it to be, so let us know if you face any issues
-during the migration is not outline is that document.
+during the migration that is not outlined in that document.
 
 #### How can I export translations without having a database around?
 
@@ -543,9 +573,9 @@ I18n.load_path += Dir["./config/locales/**/*.yml"]
 
 > **Note**:
 >
-> You may not need to load ActiveSupport and ActionView lines, or even may need
-> to add additional requires for other libs. With this approach you have full
-> control on what's going to be loaded.
+> You may not need to load the ActiveSupport and ActionView lines, or you may
+> need to add additional requires for other libs. With this approach you have
+> full control on what's going to be loaded.
 
 ## Maintainer
 

data/i18n-js.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "./lib/i18n-js/version"
+require_relative "lib/i18n-js/version"
 
 Gem::Specification.new do |spec|
   spec.name    = "i18n-js"
@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary     = "Export i18n translations and use them on JavaScript."
   spec.description = spec.summary
   spec.license     = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.2.0")
   spec.metadata = {"rubygems_mfa_required" => "true"}
 
   github_url = "https://github.com/fnando/i18n-js"

data/lib/guard/i18n-js.rb

@@ -77,7 +77,7 @@ module Guard
       $stdout = original
     end
 
-    def validate_file(key, file)
+    def validate_file(key, file) #  rubocop:disable Naming/PredicateMethod
       return true if file && File.file?(file)
 
       error("#{key.inspect} must be a file")

data/lib/i18n-js/cli/command.rb

@@ -21,8 +21,8 @@ module I18nJS
         end
       end
 
-      def self.command(&block)
-        define_method(:command, &block)
+      def self.command(&)
+        define_method(:command, &)
       end
 
       def initialize(argv:, ui:)

data/lib/i18n-js/cli/export_command.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "benchmark"
-
 module I18nJS
   class CLI
     class ExportCommand < Command
@@ -30,7 +28,7 @@ module I18nJS
         opts.on(
           "-q",
           "--quiet",
-          "A Ruby file that must be loaded"
+          "Suppress non-error output"
         ) do |quiet|
           options[:quiet] = quiet
         end
@@ -69,18 +67,18 @@ module I18nJS
           )
         end
 
-        time = Benchmark.realtime do
+        time = benchmark_realtime do
           load_require_file!(require_file) if require_file
-          I18nJS.call(config_file: config_file)
+          I18nJS.call(config_file:)
         end
 
         log("=> Done in #{time.round(2)}s")
       end
 
-      private def log(*args)
+      private def log(*)
         return if options[:quiet]
 
-        ui.stdout_print(*args)
+        ui.stdout_print(*)
       end
 
       private def set_defaults!
@@ -90,6 +88,12 @@ module I18nJS
         options[:config_file] ||= config_file if File.file?(config_file)
         options[:require_file] ||= require_file if File.file?(require_file)
       end
+
+      private def benchmark_realtime
+        start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        yield
+        Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
+      end
     end
   end
 end

data/lib/i18n-js/cli/lint_scripts_command.rb

@@ -81,7 +81,7 @@ module I18nJS
 
         config = load_config_file(config_file)
         I18nJS.load_plugins!
-        I18nJS.initialize_plugins!(config: config)
+        I18nJS.initialize_plugins!(config:)
         Schema.validate!(config)
 
         load_require_file!(require_file) if require_file
@@ -91,7 +91,7 @@ module I18nJS
 
         ui.stdout_print "=> Available locales: #{available_locales.inspect}"
 
-        exported_files = I18nJS.call(config_file: config_file)
+        exported_files = I18nJS.call(config_file:)
         data = exported_files.each_with_object({}) do |file, buffer|
           buffer.merge!(JSON.load_file(file, symbolize_names: true))
         end

data/lib/i18n-js/cli/lint_translations_command.rb

@@ -69,7 +69,7 @@ module I18nJS
 
         config = load_config_file(config_file)
         I18nJS.load_plugins!
-        I18nJS.initialize_plugins!(config: config)
+        I18nJS.initialize_plugins!(config:)
         Schema.validate!(config)
 
         load_require_file!(require_file) if require_file

data/lib/i18n-js/cli.rb

@@ -17,7 +17,7 @@ module I18nJS
 
     def initialize(argv:, stdout:, stderr:, colored: stdout.tty?)
       @argv = argv.dup
-      @ui = UI.new(stdout: stdout, stderr: stderr, colored: colored)
+      @ui = UI.new(stdout:, stderr:, colored:)
     end
 
     def call
@@ -43,7 +43,7 @@ module I18nJS
 
     private def commands
       command_classes.map do |command_class|
-        command_class.new(argv: @argv, ui: ui)
+        command_class.new(argv: @argv, ui:)
       end
     end
 

data/lib/i18n-js/export_files_plugin.rb

@@ -54,8 +54,8 @@ module I18nJS
         config[:files].each do |export|
           translations = JSON.load_file(file)
           template = Template.new(
-            file: file,
-            translations: translations,
+            file:,
+            translations:,
             template: export[:template]
           )
 
@@ -63,11 +63,11 @@ module I18nJS
 
           output = format(
             export[:output],
-            dir: dir,
-            name: name,
-            extension: extension,
+            dir:,
+            name:,
+            extension:,
             digest: Digest::MD5.hexdigest(contents),
-            base_name: base_name
+            base_name:
           )
 
           File.open(output, "w") do |io|
@@ -82,7 +82,7 @@ module I18nJS
 
       def initialize(**kwargs)
         kwargs.each do |key, value|
-          public_send("#{key}=", value)
+          public_send(:"#{key}=", value)
         end
       end
 

data/lib/i18n-js/listen.rb

@@ -28,7 +28,7 @@ module I18nJS
     debug("Watching #{relative_paths.inspect}")
 
     listener(config_file, locales_dirs.map(&:to_s), options).start
-    I18nJS.call(config_file: config_file) if run_on_start
+    I18nJS.call(config_file:) if run_on_start
   end
 
   def self.relative_path(path)

data/lib/i18n-js/plugin.rb

@@ -27,7 +27,7 @@ module I18nJS
 
   def self.initialize_plugins!(config:)
     @plugins = available_plugins.map do |plugin|
-      plugin.new(config: config).tap(&:setup)
+      plugin.new(config:).tap(&:setup)
     end
   end
 

data/lib/i18n-js/schema.rb

@@ -133,8 +133,8 @@ module I18nJS
     end
 
     def expect_type(path:, types:)
-      path = prepare_path(path: path)
-      value = value_for(path: path)
+      path = prepare_path(path:)
+      value = value_for(path:)
       types = Array(types)
 
       return if types.any? {|type| value.is_a?(type) }
@@ -156,10 +156,10 @@ module I18nJS
     end
 
     def expect_array_with_items(path:)
-      expect_type(path: path, types: Array)
+      expect_type(path:, types: Array)
 
-      path = prepare_path(path: path)
-      value = value_for(path: path)
+      path = prepare_path(path:)
+      value = value_for(path:)
 
       return unless value.empty?
 
@@ -168,8 +168,8 @@ module I18nJS
     end
 
     def expect_required_keys(keys:, path:)
-      path = prepare_path(path: path)
-      value = value_for(path: path)
+      path = prepare_path(path:)
+      value = value_for(path:)
       actual_keys = value.keys.map(&:to_sym)
 
       keys.each do |key|
@@ -186,8 +186,8 @@ module I18nJS
     end
 
     def reject_extraneous_keys(keys:, path:)
-      path = prepare_path(path: path)
-      value = value_for(path: path)
+      path = prepare_path(path:)
+      value = value_for(path:)
 
       actual_keys = value.keys.map(&:to_sym)
       extraneous = actual_keys.to_a - keys.to_a

data/lib/i18n-js/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module I18nJS
-  VERSION = "4.2.3"
+  VERSION = "4.2.4"
 end

data/lib/i18n-js.rb

@@ -7,7 +7,6 @@ require "glob"
 require "fileutils"
 require "optparse"
 require "erb"
-require "set"
 require "digest/md5"
 
 require_relative "i18n-js/schema"
@@ -28,7 +27,7 @@ module I18nJS
     config = Glob::SymbolizeKeys.call(config || load_config_file(config_file))
 
     load_plugins!
-    initialize_plugins!(config: config)
+    initialize_plugins!(config:)
     Schema.validate!(config)
 
     exported_files = []
@@ -59,7 +58,7 @@ module I18nJS
 
     if output_file_path.include?(":locale")
       filtered_translations.each_key do |locale|
-        locale_file_path = output_file_path.gsub(/:locale/, locale.to_s)
+        locale_file_path = output_file_path.gsub(":locale", locale.to_s)
         exported_files << write_file(locale_file_path,
                                      locale => filtered_translations[locale])
       end
@@ -75,7 +74,7 @@ module I18nJS
 
     contents = ::JSON.pretty_generate(translations)
     digest = Digest::MD5.hexdigest(contents)
-    file_path = file_path.gsub(/:digest/, digest)
+    file_path = file_path.gsub(":digest", digest)
 
     # Don't rewrite the file if it already exists and has the same content.
     # It helps the asset pipeline or webpack understand that file wasn't

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: i18n-js
 version: !ruby/object:Gem::Version
-  version: 4.2.3
+  version: 4.2.4
 platform: ruby
 authors:
 - Nando Vieira
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glob
@@ -225,11 +224,10 @@ metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/fnando/i18n-js
   bug_tracker_uri: https://github.com/fnando/i18n-js/issues
-  source_code_uri: https://github.com/fnando/i18n-js/tree/v4.2.3
-  changelog_uri: https://github.com/fnando/i18n-js/tree/v4.2.3/CHANGELOG.md
-  documentation_uri: https://github.com/fnando/i18n-js/tree/v4.2.3/README.md
-  license_uri: https://github.com/fnando/i18n-js/tree/v4.2.3/LICENSE.md
-post_install_message:
+  source_code_uri: https://github.com/fnando/i18n-js/tree/v4.2.4
+  changelog_uri: https://github.com/fnando/i18n-js/tree/v4.2.4/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/i18n-js/tree/v4.2.4/README.md
+  license_uri: https://github.com/fnando/i18n-js/tree/v4.2.4/LICENSE.md
 rdoc_options: []
 require_paths:
 - lib
@@ -237,15 +235,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Export i18n translations and use them on JavaScript.
 test_files: []