lokalise_rails 9.1.0 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10aca9c56566ddf94f027c08089f95fb779b1a939858d7b70d4824bd41559c1c
-  data.tar.gz: 69f38ae41196a487926e269b4d8f48a409c0ff282055fecb95ddb53736941890
+  metadata.gz: 42a36a8f1a48885107ab483355a20b5165bf5560bda87469718d4f868e419b9b
+  data.tar.gz: ea273319e86b45f3dd8d00e72695e55724f6ec3864915f8b031c928b02fc2b48
 SHA512:
-  metadata.gz: 39cc268525d31a84a0fa8b9b924964a2913bf0dd320cb63f26eec80265f6a645139352e5bd3bf9a2e159cd8c0a4cad2beb61306b22817eade5158489e0587f25
-  data.tar.gz: cb3c6a2323b358ae5e6c887caf686e4b8adcfd028fdedc38aa5dfdfe27540a996691aee36c7a52a96c659c536f6045aacf6dcd920b337a86c49fd190ff6f1956
+  metadata.gz: f75b0fe35c4721f6a5dacc2e7cdb2c18f49058b741369933629a60875b9ee374c49a16bdb57dd01fe3798ddc47eedca7de6d2a4fea4a4be1dc42f8021a4b2e92
+  data.tar.gz: 79cfffd769d35dec7e53b96eec3ceffad46fc93cedca58ff348705477901e7a7d50fb816af75cbca4bd575229bb623b754672290c1332fefe05d3e764b981c86

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 10.0.0 (31-Aug-2026)
+
+* **Require Ruby 3.2+**
+* Various code updates and enhancements
+
 ## 9.1.0 (22-Feb-2026)
 
 - Added `LokaliseRails::GlobalConfig.for_default_project` to define per-run overrides for the default project (without changing global settings), and updated rake tasks to use `project_opts(:default)`.

data/README.md

@@ -14,7 +14,7 @@ This gem provides [Lokalise](http://lokalise.com) integration for Ruby on Rails
 
 ### Requirements
 
-This gem requires Ruby 3.0+ and Rails 5.1+. It might work with older versions of Rails though. You will also need to [set up a Lokalise account](https://app.lokalise.com/signup) and create a [translation project](https://docs.lokalise.com/en/articles/1400460-projects). Finally, you will need to generate a [read/write API token](https://docs.lokalise.com/en/articles/1929556-api-tokens) at your Lokalise profile (or a read-only token if you plan to perform only imports).
+This gem requires Ruby 3.2+ and Rails 5.1+. It might work with older versions of Rails though. You will also need to [set up a Lokalise account](https://app.lokalise.com/signup) and create a [translation project](https://docs.lokalise.com/en/articles/1400460-projects). Finally, you will need to generate a [read/write API token](https://docs.lokalise.com/en/articles/1929556-api-tokens) at your Lokalise profile (or a read-only token if you plan to perform only imports).
 
 Alternatively, you can utilize a token obtained via OAuth 2 flow. When using such a token, you'll have to set `:use_oauth2_token` option to `true` (please check [options docs](https://github.com/bodrovis/lokalise_manager#common-config) to learn more).
 
@@ -69,6 +69,76 @@ To export translations from your Rails app to the specified Lokalise project, ru
 rails lokalise_rails:export
 ```
 
+## Configuration
+
+Options are specified in the `config/lokalise_rails.rb` file.
+
+Here's an example:
+
+```ruby
+LokaliseRails::GlobalConfig.config do |c|
+  # These are mandatory options that you must set before running rake tasks:
+  c.api_token = ENV['LOKALISE_API_TOKEN']
+  c.project_id = ENV['LOKALISE_PROJECT_ID']
+
+  # Provide a custom path to the directory with your translation files:
+  # c.locales_path = "#{Rails.root}/config/locales"
+
+  # Provide a Lokalise project branch to use:
+  c.branch = 'develop'
+
+  # Provide request timeouts for the Lokalise API client:
+  c.additional_client_opts = {open_timeout: 5, timeout: 5}
+
+  # Provide maximum number of retries for file exporting:
+  c.max_retries_export = 5
+
+  # Provide maximum number of retries for file importing:
+  c.max_retries_import = 5
+
+  # Import options have the following defaults:
+  # c.import_opts = {
+  #   format: 'ruby_yaml',
+  #   placeholder_format: :icu,
+  #   yaml_include_root: true,
+  #   original_filenames: true,
+  #   directory_prefix: '',
+  #   indentation: '2sp'
+  # }
+
+  # Safe mode for imports is disabled by default:
+  # c.import_safe_mode = false
+
+  # Additional export options (only filename, contents, and lang_iso params are provided by default)
+  # c.export_opts = {}
+
+  # Provide additional file exclusion criteria for exports (by default, any file with the proper extension will be exported)
+  # c.skip_file_export = ->(file) { file.split[1].to_s.include?('fr') }
+
+  # Set the options below if you would like to work with format other than YAML
+  ## Regular expression to use when choosing the files to extract from the downloaded archive and upload to Lokalise
+  ## c.file_ext_regexp = /\.ya?ml\z/i
+
+  ## Load translations data and make sure they are valid:
+  ## c.translations_loader = ->(raw_data) { YAML.safe_load raw_data }
+
+  ## Convert translations data to a proper format:
+  ## c.translations_converter = ->(raw_data) { YAML.dump(raw_data).gsub(/\\\\n/, '\n') }
+
+  ## Infer language ISO code for the translation file:
+  ## c.lang_iso_inferer = ->(data, _path) { YAML.safe_load(data)&.keys&.first }
+
+  ## Pre-process translations before exporting to Lokalise:
+  ## c.export_preprocessor = ->(raw_data, _path) { raw_data }
+
+  ## Disable the export rake task:
+  ## c.disable_export_task = false
+
+  ## Disable the import rake task:
+  ## c.disable_import_task = false
+end
+```
+
 ## Running tasks programmatically
 
 You can also run the import and export tasks programmatically from your code. To achieve that, please check the [`lokalise_manager`](https://github.com/bodrovis/lokalise_manager) gem which `lokalise_rails` relies on.
@@ -217,76 +287,6 @@ end
 
 Named projects are configured with `for_project(:name)` and generate scoped tasks like `lokalise_rails:<name>:import` and `lokalise_rails:<name>:export`.
 
-## Configuration
-
-Options are specified in the `config/lokalise_rails.rb` file.
-
-Here's an example:
-
-```ruby
-LokaliseRails::GlobalConfig.config do |c|
-  # These are mandatory options that you must set before running rake tasks:
-  c.api_token = ENV['LOKALISE_API_TOKEN']
-  c.project_id = ENV['LOKALISE_PROJECT_ID']
-
-  # Provide a custom path to the directory with your translation files:
-  # c.locales_path = "#{Rails.root}/config/locales"
-
-  # Provide a Lokalise project branch to use:
-  c.branch = 'develop'
-
-  # Provide request timeouts for the Lokalise API client:
-  c.additional_client_opts = {open_timeout: 5, timeout: 5}
-
-  # Provide maximum number of retries for file exporting:
-  c.max_retries_export = 5
-
-  # Provide maximum number of retries for file importing:
-  c.max_retries_import = 5
-
-  # Import options have the following defaults:
-  # c.import_opts = {
-  #   format: 'ruby_yaml',
-  #   placeholder_format: :icu,
-  #   yaml_include_root: true,
-  #   original_filenames: true,
-  #   directory_prefix: '',
-  #   indentation: '2sp'
-  # }
-
-  # Safe mode for imports is disabled by default:
-  # c.import_safe_mode = false
-
-  # Additional export options (only filename, contents, and lang_iso params are provided by default)
-  # c.export_opts = {}
-
-  # Provide additional file exclusion criteria for exports (by default, any file with the proper extension will be exported)
-  # c.skip_file_export = ->(file) { file.split[1].to_s.include?('fr') }
-
-  # Set the options below if you would like to work with format other than YAML
-  ## Regular expression to use when choosing the files to extract from the downloaded archive and upload to Lokalise
-  ## c.file_ext_regexp = /\.ya?ml\z/i
-
-  ## Load translations data and make sure they are valid:
-  ## c.translations_loader = ->(raw_data) { YAML.safe_load raw_data }
-
-  ## Convert translations data to a proper format:
-  ## c.translations_converter = ->(raw_data) { YAML.dump(raw_data).gsub(/\\\\n/, '\n') }
-
-  ## Infer language ISO code for the translation file:
-  ## c.lang_iso_inferer = ->(data, _path) { YAML.safe_load(data)&.keys&.first }
-
-  ## Pre-process translations before exporting to Lokalise:
-  ## c.export_preprocessor = ->(raw_data, _path) { raw_data }
-
-  ## Disable the export rake task:
-  ## c.disable_export_task = false
-
-  ## Disable the import rake task:
-  ## c.disable_import_task = false
-end
-```
-
 ## Running tests
 
 1. Copy-paste `.env.example` file as `.env`. Put your Lokalise API token and project ID inside. The `.env` file is excluded from version control so your data is safe. All in all, we use stubbed requests, so the actual API requests won't be sent. However, providing at least some values is required.

data/lib/generators/templates/lokalise_rails_config.rb

@@ -37,7 +37,7 @@ if defined?(LokaliseRails::GlobalConfig)
     # Run imports asynchronously
     # c.import_async = false
 
-    # Additional export options (only filename, contents, and lang_iso params are provided by default)
+    # Additional export options (only data, filename, and lang_iso params are provided by default)
     # c.export_opts = {}
 
     # Provide additional file exclusion criteria for exports:

data/lib/lokalise_rails/global_config.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'set'
-
 module LokaliseRails
   # Extends `LokaliseManager::GlobalConfig` to provide a global configuration
   # specific to the LokaliseRails gem in a Rails application.

data/lib/lokalise_rails/utils.rb

@@ -19,16 +19,24 @@ module LokaliseRails
       # Returns the root directory of a Rails application, if present.
       #
       # - Uses `Rails.root` when Rails is loaded.
-      # - Falls back to `RAILS_ROOT` for legacy Rails versions.
       # - Returns `nil` when Rails is not available.
       #
       # @return [Pathname, nil] Pathname pointing to the Rails root, or `nil`.
       def rails_root
-        if defined?(::Rails) && ::Rails.respond_to?(:root) && (r = ::Rails.root)
-          Pathname(r)
-        elsif defined?(::RAILS_ROOT)
-          Pathname(::RAILS_ROOT)
+        ::Rails.root if defined?(::Rails) && ::Rails.respond_to?(:root)
+      end
+
+      def require_config!
+        config_path = root.join('config', 'lokalise_rails.rb')
+
+        unless config_path.exist?
+          abort <<~MSG
+            LokaliseRails configuration file was not found at #{config_path}.
+            Run `rails generate lokalise_rails:install` first.
+          MSG
         end
+
+        require config_path.to_s
       end
     end
   end

data/lib/lokalise_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LokaliseRails
-  VERSION = '9.1.0'
+  VERSION = '10.0.0'
 end

data/lib/lokalise_rails.rb

@@ -7,7 +7,7 @@ require 'lokalise_manager'
 loader = Zeitwerk::Loader.for_gem
 
 # Ignore files that should not be autoloaded.
-loader.ignore "#{__dir__}/lokalise_rails/railtie.rb" # Exclude Railtie when not in a Rails app
+loader.ignore "#{__dir__}/lokalise_rails/railtie.rb" # Load Railtie manually only in Rails applications.
 loader.ignore "#{__dir__}/generators" # Exclude generators
 
 loader.setup

data/lib/tasks/lokalise_rails_tasks.rake

@@ -3,7 +3,7 @@
 require 'rake'
 require 'lokalise_rails'
 
-require LokaliseRails::Utils.root.join('config', 'lokalise_rails.rb').to_s
+LokaliseRails::Utils.require_config!
 
 # Rake tasks for syncing translation files between a Rails project and Lokalise.
 namespace :lokalise_rails do

data/lokalise_rails.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.homepage              = 'https://github.com/bodrovis/lokalise_rails'
   spec.license               = 'MIT'
   spec.platform              = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 3.0'
+  spec.required_ruby_version = '>= 3.2'
 
   spec.files = Dir['README.md', 'LICENSE.md',
                    'CHANGELOG.md', 'lib/**/*.rb',
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = ['README.md']
   spec.require_paths    = ['lib']
 
-  spec.add_dependency 'lokalise_manager', '~> 7.0'
+  spec.add_dependency 'lokalise_manager', '~> 8.0'
   spec.add_dependency 'zeitwerk', '~> 2.4'
 
   spec.add_development_dependency 'rake', '~> 13.0'
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-performance', '~> 1.5'
   spec.add_development_dependency 'rubocop-rake', '~> 0.7'
   spec.add_development_dependency 'rubocop-rspec', '~> 3.0'
-  spec.add_development_dependency 'simplecov', '~> 0.22'
+  spec.add_development_dependency 'simplecov', '~> 1.0'
 
   spec.metadata = {
     'rubygems_mfa_required' => 'true',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lokalise_rails
 version: !ruby/object:Gem::Version
-  version: 9.1.0
+  version: 10.0.0
 platform: ruby
 authors:
 - Ilya Krukowski
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -127,14 +127,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '1.0'
 description: This gem allows to exchange translation files between your Rails app
   and Lokalise TMS.
 email:
@@ -172,14 +172,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.19
 specification_version: 4
 summary: Lokalise integration for Ruby on Rails
 test_files: []