lokalise_manager 5.1.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82874b49ae901318d91845641a40e1c0b085764e53179799dffb54f84e205fc0
-  data.tar.gz: 5c8035fed54faf4dbd82eba23acaf172af60bf0d0cd4f4b0705bace632b1049a
+  metadata.gz: f0df6efdcebd1ef7b1f3992a14c997d56859553cf0e1b089d43fe496f479bb1e
+  data.tar.gz: 762127da9ea96e1b5ad532a5217d0f06556b3d9f61b65f722f79a50a406bba23
 SHA512:
-  metadata.gz: 473fc616ce635982fe180396a3f2be51c974fd05bbca4e5f1a4780cdda9f10951a0763ce1c366abccae96ba618a20f7d9d94b150c4f9423ba72d678dec2f53cf
-  data.tar.gz: 24b1bd4791c79ef2ff0e6f1fc096b23a50a63878f55c66c10b0830d4ac614e76890a7b50d376cef649dae6970ded2215088ca95b9c96ee3124574b7594eda086
+  metadata.gz: 42c3990642e4598cc746f1f991d57bceb1793b0de6f8a9ff8b7a33d42194c47a9d84243ee045658a4925dda13d2b6ee63bb0464bd48c8094951b60c2b83e8c9b
+  data.tar.gz: 156793b3c527be7e88fa4790db675f98958ba80a2be717259f4e3fca937a1369b9660210d8778b727cce1249f9237873507c6800e88eec33d40aac3bf9b42c8a

data/CHANGELOG.md

@@ -1,6 +1,22 @@
 # Changelog
 
-## 5.1.1
+## 6.0.0 (29-Nov-2024)
+
+* **Breaking change**: rename the `timeouts` config method to `additional_client_opts`. It has the same usage but now enables you to set both client timeouts and override the API host to send requests to.
+
+```ruby
+additional_client_opts: {
+  open_timeout: 100,
+  timeout: 500,
+  api_host: 'http://example.com/api'
+}
+```
+
+## 5.1.2 (01-Nov-2024)
+
+* Update dependencies
+
+## 5.1.1 (10-May-2024)
 
 * Update documentation, minor code fixes
 

data/README.md

@@ -108,7 +108,7 @@ Please don't forget that Lokalise API has rate limiting and you cannot send more
 * `project_id` (`string`, required) — Lokalise project ID. You must have import/export permissions in the specified project.
 * `locales_path` (`string`) — path to the directory with your translation files. Defaults to `"#{Dir.getwd}/locales"`.
 * `branch` (`string`) — Lokalise project branch to use. Defaults to `""` (no branch is provided).
-* `timeouts` (`hash`) — set [request timeouts for the Lokalise API client](https://lokalise.github.io/ruby-lokalise-api/additional_info/customization#setting-timeouts). By default, requests have no timeouts: `{open_timeout: nil, timeout: nil}`. Both values are in seconds.
+* `additional_client_opts` (`hash`) — set [request timeouts and API host for the Lokalise client](https://lokalise.github.io/ruby-lokalise-api/additional_info/customization). By default, requests have no timeouts and the API host is not overriden: `{open_timeout: nil, timeout: nil, api_host: nil}`. Timeout values are in seconds.
 * `silent_mode` (`boolean`) — whether you would like to output debugging information to `$stdout`. By default, after a task is performed, a short notification message will be printed out to the terminal. When set to `false`, notifications won't be printed. Please note that currently `import_safe_mode` has higher priority. Even if you enable `silent_mode`, and the `import_safe_mode` is enabled as well, you will be prompted to confirm the import operation if the target directory is not empty.
 
 ### Import config

data/lib/lokalise_manager/error.rb

@@ -7,7 +7,7 @@ module LokaliseManager
   class Error < StandardError
     # Initializes a new Error object
     def initialize(message = '')
-      super(message)
+      super
     end
   end
 end

data/lib/lokalise_manager/global_config.rb

@@ -7,7 +7,7 @@ module LokaliseManager
     class << self
       attr_accessor :api_token, :project_id
       attr_writer :import_opts, :import_safe_mode, :export_opts, :locales_path,
-                  :file_ext_regexp, :skip_file_export, :branch, :timeouts,
+                  :file_ext_regexp, :skip_file_export, :branch, :additional_client_opts,
                   :translations_loader, :translations_converter, :lang_iso_inferer,
                   :max_retries_export, :max_retries_import, :use_oauth2_token, :silent_mode,
                   :raise_on_export_fail
@@ -42,9 +42,9 @@ module LokaliseManager
         @branch || ''
       end
 
-      # Return API request timeouts
-      def timeouts
-        @timeouts || {}
+      # Return additional API client options
+      def additional_client_opts
+        @additional_client_opts || {}
       end
 
       # Return the max retries for export

data/lib/lokalise_manager/task_definitions/base.rb

@@ -5,9 +5,8 @@ require 'pathname'
 
 module LokaliseManager
   module TaskDefinitions
-    # Base class for LokaliseManager task definitions, including common methods and logic.
-    # This class serves as the foundation for importer and exporter classes, handling API
-    # client interactions and configuration merging.
+    # Base class for LokaliseManager task definitions, providing common methods and logic
+    # for importer and exporter classes. Handles API client interactions and configuration merging.
     class Base
       using LokaliseManager::Utils::HashUtils
 
@@ -18,31 +17,15 @@ module LokaliseManager
       # @param custom_opts [Hash] Custom configurations for specific tasks.
       # @param global_config [Object] Reference to the global configuration.
       def initialize(custom_opts = {}, global_config = LokaliseManager::GlobalConfig)
-        primary_opts = global_config
-                       .singleton_methods
-                       .filter { |m| m.to_s.end_with?('=') }
-                       .each_with_object({}) do |method, opts|
-          reader = method.to_s.delete_suffix('=')
-          opts[reader.to_sym] = global_config.send(reader)
-        end
-
-        all_opts = primary_opts.deep_merge(custom_opts)
-
-        config_klass = Struct.new(*all_opts.keys, keyword_init: true)
-
-        @config = config_klass.new all_opts
+        merged_opts = merge_configs(global_config, custom_opts)
+        @config = build_config_class(merged_opts)
       end
 
-      # Creates or retrieves a Lokalise API client based on configuration.
+      # Retrieves or creates a Lokalise API client based on configuration.
       #
       # @return [RubyLokaliseApi::Client] Lokalise API client.
       def api_client
-        return @api_client if @api_client
-
-        client_opts = [config.api_token, config.timeouts]
-        client_method = config.use_oauth2_token ? :oauth2_client : :client
-
-        @api_client = ::RubyLokaliseApi.send(client_method, *client_opts)
+        @api_client ||= create_api_client
       end
 
       # Resets API client
@@ -54,15 +37,42 @@ module LokaliseManager
 
       private
 
+      # Creates a Lokalise API client based on configuration.
+      def create_api_client
+        client_opts = [config.api_token, config.additional_client_opts]
+        client_method = config.use_oauth2_token ? :oauth2_client : :client
+
+        ::RubyLokaliseApi.public_send(client_method, *client_opts)
+      end
+
+      # Merges global and custom configurations.
+      def merge_configs(global_config, custom_opts)
+        primary_opts = global_config
+                       .singleton_methods
+                       .select { |m| m.to_s.end_with?('=') }
+                       .each_with_object({}) do |method, opts|
+          reader = method.to_s.delete_suffix('=')
+          opts[reader.to_sym] = global_config.public_send(reader)
+        end
+
+        primary_opts.deep_merge(custom_opts)
+      end
+
+      # Builds a config class with the given options.
+      def build_config_class(all_opts)
+        config_klass = Struct.new(*all_opts.keys, keyword_init: true)
+        config_klass.new(all_opts)
+      end
+
       # Checks and validates task options, raising errors if configurations are missing.
       def check_options_errors!
         errors = []
         errors << 'Project ID is not set!' if config.project_id.nil? || config.project_id.empty?
         errors << 'Lokalise API token is not set!' if config.api_token.nil? || config.api_token.empty?
-        raise LokaliseManager::Error, errors.join(' ') if errors.any?
+        raise LokaliseManager::Error, errors.join(' ') unless errors.empty?
       end
 
-      # Determines if the file has the correct extension based on the configuration.
+      # Checks if the file has the correct extension based on the configuration.
       #
       # @param raw_path [String, Pathname] Path to check.
       # @return [Boolean] True if the extension matches, false otherwise.
@@ -91,7 +101,7 @@ module LokaliseManager
       # Until this is fixed, we revert to this quick'n'dirty solution.
       EXCEPTIONS = [JSON::ParserError, RubyLokaliseApi::Error::TooManyRequests].freeze
 
-      # Implements an exponential backoff strategy for handling retries after failures.
+      # Handles retries with exponential backoff for specific exceptions.
       def with_exp_backoff(max_retries)
         return unless block_given?
 

data/lib/lokalise_manager/task_definitions/exporter.rb

@@ -15,13 +15,9 @@ module LokaliseManager
       def export!
         check_options_errors!
 
-        queued_processes = []
-
-        all_files.each_slice(MAX_THREADS) do |files_group|
-          parallel_upload(files_group).each do |thr|
-            raise_on_fail(thr) if config.raise_on_export_fail
-
-            queued_processes.push thr
+        queued_processes = all_files.each_slice(MAX_THREADS).flat_map do |files_group|
+          parallel_upload(files_group).tap do |threads|
+            threads.each { |thr| raise_on_fail(thr) if config.raise_on_export_fail }
           end
         end
 
@@ -36,17 +32,19 @@ module LokaliseManager
       #
       # @param files_group [Array] Group of files to be uploaded.
       # @return [Array] Array of threads handling the file uploads.
-
       def parallel_upload(files_group)
         files_group.map do |file_data|
           Thread.new { do_upload(*file_data) }
         end.map(&:value)
       end
 
+      # Raises an error if a file upload thread failed.
+      #
+      # @param thread [Struct] The result of the file upload thread.
       def raise_on_fail(thread)
         return if thread.success
 
-        raise(thread.error.class, "Error while trying to upload #{thread.path}: #{thread.error.message}")
+        raise thread.error.class, "Error while trying to upload #{thread.path}: #{thread.error.message}"
       end
 
       # Performs the actual upload of a file to Lokalise.
@@ -56,56 +54,55 @@ module LokaliseManager
       # @return [Struct] A struct with the success status, process details, and any error information.
       def do_upload(f_path, r_path)
         proc_klass = Struct.new(:success, :process, :path, :error, keyword_init: true)
-        begin
-          process = with_exp_backoff(config.max_retries_export) do
-            api_client.upload_file(project_id_with_branch, opts(f_path, r_path))
-          end
-          proc_klass.new(success: true, process: process, path: f_path)
-        rescue StandardError => e
-          proc_klass.new(success: false, path: f_path, error: e)
+
+        process = with_exp_backoff(config.max_retries_export) do
+          api_client.upload_file(project_id_with_branch, opts(f_path, r_path))
         end
+
+        proc_klass.new(success: true, process: process, path: f_path)
+      rescue StandardError => e
+        proc_klass.new(success: false, path: f_path, error: e)
       end
 
       # Prints a completion message to standard output.
       def print_completion_message
-        $stdout.print('Task complete!')
+        $stdout.puts 'Task complete!'
       end
 
-      # Gets translation files from the specified directory
+      # Retrieves all translation files from the specified directory.
+      #
+      # @return [Array] Array of [Pathname, Pathname] pairs representing full and relative paths.
       def all_files
-        loc_path = config.locales_path
-        Dir["#{loc_path}/**/*"].filter_map do |f|
-          full_path = Pathname.new f
+        loc_path = Pathname.new(config.locales_path)
 
-          next unless file_matches_criteria? full_path
-
-          relative_path = full_path.relative_path_from Pathname.new(loc_path)
+        Dir["#{loc_path}/**/*"].filter_map do |file|
+          full_path = Pathname.new(file)
+          next unless file_matches_criteria?(full_path)
 
+          relative_path = full_path.relative_path_from(loc_path)
           [full_path, relative_path]
         end
       end
 
-      # Generates export options
+      # Generates options for file upload to Lokalise.
       #
-      # @return [Hash]
-      # @param full_p [Pathname]
-      # @param relative_p [Pathname]
+      # @param full_p [Pathname] Full path to the file.
+      # @param relative_p [Pathname] Relative path within the project.
+      # @return [Hash] Options for the Lokalise API upload.
       def opts(full_p, relative_p)
-        content = File.read full_p
+        content = File.read(full_p).strip
 
-        initial_opts = {
-          data: Base64.strict_encode64(content.strip),
-          filename: relative_p,
+        {
+          data: Base64.strict_encode64(content),
+          filename: relative_p.to_s,
           lang_iso: config.lang_iso_inferer.call(content, full_p)
-        }
-
-        initial_opts.merge config.export_opts
+        }.merge(config.export_opts)
       end
 
-      # Checks whether the specified file has to be processed or not
+      # Checks whether the specified file meets the criteria for upload.
       #
-      # @return [Boolean]
-      # @param full_path [Pathname]
+      # @param full_path [Pathname] Full path to the file.
+      # @return [Boolean] True if the file matches criteria, false otherwise.
       def file_matches_criteria?(full_path)
         full_path.file? && proper_ext?(full_path) &&
           !config.skip_file_export.call(full_path)

data/lib/lokalise_manager/task_definitions/importer.rb

@@ -6,9 +6,8 @@ require 'fileutils'
 
 module LokaliseManager
   module TaskDefinitions
-    # The Importer class is responsible for downloading translation files from Lokalise
-    # and importing them into the specified project directory. This class extends the Base class,
-    # which provides shared functionality and configuration management.
+    # The Importer class handles downloading translation files from Lokalise
+    # and importing them into the specified project directory.
     class Importer < Base
       # Initiates the import process by checking configuration, ensuring safe mode conditions,
       # downloading files, and processing them. Outputs task completion status.
@@ -46,11 +45,7 @@ module LokaliseManager
       # @param path [String] The URL or local path to the ZIP archive.
       def open_and_process_zip(path)
         Zip::File.open_buffer(open_file_or_remote(path)) do |zip|
-          zip.each do |entry|
-            next unless proper_ext?(entry.name)
-
-            process_entry(entry)
-          end
+          zip.each { |entry| process_entry(entry) if proper_ext?(entry.name) }
         end
       rescue StandardError => e
         raise e.class, "Error processing ZIP file: #{e.message}"
@@ -80,8 +75,7 @@ module LokaliseManager
 
         $stdout.puts "The target directory #{config.locales_path} is not empty!"
         $stdout.print 'Enter Y to continue: '
-        answer = $stdin.gets
-        answer.to_s.strip == 'Y'
+        $stdin.gets.strip.upcase == 'Y'
       end
 
       # Opens a local file or a remote URL using the provided path, safely handling different path schemes.
@@ -89,13 +83,8 @@ module LokaliseManager
       # @param path [String] The path to the file, either a local path or a URL.
       # @return [IO] Returns an IO object for the file.
       def open_file_or_remote(path)
-        parsed_path = URI.parse(path)
-
-        if parsed_path&.scheme&.include?('http')
-          parsed_path.open
-        else
-          File.open path
-        end
+        uri = URI.parse(path)
+        uri.scheme&.start_with?('http') ? uri.open : File.open(path)
       end
 
       # Loads translations from the ZIP file.

data/lib/lokalise_manager/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LokaliseManager
-  VERSION = '5.1.1'
+  VERSION = '6.0.0'
 end

data/lokalise_manager.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = ['README.md']
   spec.require_paths    = ['lib']
 
-  spec.add_dependency 'ruby-lokalise-api', '~> 9.0'
+  spec.add_dependency 'ruby-lokalise-api', '~> 9.3'
   spec.add_dependency 'rubyzip', '~> 2.3'
   spec.add_dependency 'zeitwerk', '~> 2.4'
 
@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~> 1.0'
   spec.add_development_dependency 'rubocop-performance', '~> 1.5'
   spec.add_development_dependency 'rubocop-rake', '~> 0.6'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.6'
+  spec.add_development_dependency 'rubocop-rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'simplecov-lcov', '~> 0.8'
   spec.add_development_dependency 'webmock', '~> 3.18'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lokalise_manager
 version: !ruby/object:Gem::Version
-  version: 5.1.1
+  version: 6.0.0
 platform: ruby
 authors:
 - Ilya Krukowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-10 00:00:00.000000000 Z
+date: 2024-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lokalise-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '9.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '9.3'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -238,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Lokalise integration for Ruby