lokalise_manager 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f9ca0fe8caf151e84dcc09f29368bc61b5bc3cdb4341ef5c1b21040b764a17a
-  data.tar.gz: 8c9194a836a1261638f2b22d8d2d7553bfbe605325911cb0c0ecef9332e9084c
+  metadata.gz: f68d621f5413a53e386f1d1f1539e8f824f6f3e90e81c0fb93c71e9e1c271c9a
+  data.tar.gz: ecaf5166531cb24f7fa6162ea11d86f885ead2e911f40543cdd08e717e9731e4
 SHA512:
-  metadata.gz: 7c4b7131ea9d6b60ff4094d0e34c92484818eb3c608a016932426c83bbcab4a06f4c820399f2fa70cc2a78d9a60a73dcf442ec9ba082bdc095ab539b467e1677
-  data.tar.gz: b98c062b4ecc030c37fa1f1ad95126209749c99ec7aba72b616fad380819d55552dc6d4b2a611b94471f79b3748855eefbaab3c9397ab49e9f8e19a6a6afb1ab
+  metadata.gz: 659795e4573dab1751fa00b7d23ed43d6c9b276561fc763341b9a2d72dabadb9e8eeb638a7888d4f736b42e49efcb75a627d12c3b5bc63c9a46f369077dacb2c
+  data.tar.gz: f3681cca401d48512786731538697a2dcac4a7f47ab8d7037a6ce9444308dc4ab71ee34220218654dc71823c1d1a0b3945494015f6f822ac089ca87627a92d1d

data/CHANGELOG.md

@@ -1,5 +1,63 @@
 # Changelog
 
+## 3.0.0 (11-Mar-22)
+
+* **Breaking change**: Require Ruby 2.7 or above
+* **Breaking change (potentially)**: Use ruby-lokalise-api v6. In general, this transition should not affect you if you employ `export!` and `import!` methods only. However, please be aware that ruby-lokalise-api has a few breaking changes [listed in its own changelog](https://lokalise.github.io/ruby-lokalise-api/additional_info/changelog)
+* Use Zeitwerk loader
+* Prettify and update source code
+
+## 2.2.0 (23-Feb-22)
+
+* Use ruby-lokalise-api v5
+* Don't use any compression options (compression is now enabled by default)
+* Update tests
+
+## 2.1.0 (27-Jan-22)
+
+* **Breaking change**: `export!` will now return an array of objects responding to the following methods:
+  + `success` — usually returns `true` (to learn more, check documentation for the `:raise_on_export_fail` option below)
+  + `process` — returns an object (an instance of the `Lokalise::Resources::QueuedProcess`) representing a [queued background process](https://lokalise.github.io/ruby-lokalise-api/api/queued-processes) as uploading is done in the background on Lokalise. You can use this object to check the process status (whether the uploading is completed or not).
+  + `path` — returns an instance of the `Pathname` class which represent the file being uploaded.
+* Here's an example:
+
+```ruby
+def uploaded?(process)
+  5.times do # try to check the status 5 times
+    process = process.reload_data # load new data
+    return(true) if process.status == 'finished' # return true is the upload has finished
+    sleep 1 # wait for 1 second, adjust this number with regards to the upload size
+  end
+
+  false # if all 5 checks failed, return false (probably something is wrong)
+end
+
+processes = exporter.export!
+puts "Checking status for the #{processes[0].path} file"
+uploaded? processes[0].process
+```
+
+* Introduced a new option `raise_on_export_fail` (`boolean`) which is `true` by default. When this option is enabled, LokaliseManager will re-raise any exceptions that happened during the file uploading. When this option is disabled, the exporting process will continue even if something goes wrong. In this case you'll probably need to check the result yourself and make the necessary actions. For example:
+
+```ruby
+processes = exporter.export!
+
+processes.each do |proc_data|
+  if proc_data.success
+    # Everything is good, the uploading is queued
+    puts "#{proc_data.path} is sent to Lokalise!"
+    process = proc_data.process
+    puts "Current process status is #{process.status}"
+  else
+    # Something bad has happened
+    puts "Could not send #{proc_data.path} to Lokalise"
+    puts "Error #{proc_data.error.class}: #{proc_data.error.message}"
+    # Or you could re-raise this exception:
+    # raise proc_data.error.class
+  end
+end
+```
+
 ## 2.0.0 (27-Jan-22)
 
 * `export!` method is now taking advantage of multi-threading (as Lokalise API allows to send requests in parallel since January 2022)

data/README.md

@@ -43,7 +43,7 @@ importer = LokaliseManager.importer api_token: '1234abc', project_id: '123.abc'
 exporter = LokaliseManager.exporter api_token: '1234abc', project_id: '123.abc'
 ```
 
-You *must* provide an API token and a project ID (your project ID can be found under Lokalise project settings). [Other options can be customized as well (see below)](https://github.com/bodrovis/lokalise_manager#configuration) but they have sensible defaults.
+You *must* provide an API token and a project ID (your project ID can be found under Lokalise project settings). [Other options can be customized as well (see below)](#configuration) but they have sensible defaults.
 
 ### Importing files from Lokalise into your project
 
@@ -55,7 +55,7 @@ result = importer.import!
 
 The `result` will contain a boolean value which says whether the operation was successfull or not.
 
-Please note that upon importing translations any duplicating files inside the `locales` directory (or any other directory that you've specified in the options) will be overwritten! You can enable [safe mode](https://github.com/bodrovis/lokalise_manager#import-config) to check whether the folder is empty or not.
+Please note that upon importing translations any duplicating files inside the `locales` directory (or any other directory that you've specified in the options) **will be overwritten**! You can enable [safe mode](#import-config) to check whether the folder is empty or not.
 
 ### Exporting files from your project to Lokalise
 
@@ -65,13 +65,21 @@ To upload your translation files from a local directory (defaults to `locales/`)
 processes = exporter.export!
 ```
 
-`processes` will contain an array of queued background processes as uploading is done in the background on Lokalise. You can perform periodic checks to read the status of the process. Here's a very simple example:
+The uploading process is multi-threaded.
+
+`processes` will contain an array of objects responding to the following methods:
+
+* `#success` — usually returns `true` (to learn more, check documentation for the `:raise_on_export_fail` option below)
+* `#process` — returns an object (an instance of the `RubyLokaliseApi::Resources::QueuedProcess`) representing a [queued background process](https://lokalise.github.io/ruby-lokalise-api/api/queued-processes) as uploading is done in the background on Lokalise.
+* `#path` — returns an instance of the `Pathname` class which represent the file being uploaded.
+
+You can perform periodic checks to read the status of the process. Here's a very simple example:
 
 ```ruby
 def uploaded?(process)
   5.times do # try to check the status 5 times
-    process = process.reload_data # load new data
-    return(true) if process.status == 'finished' # return true is the upload has finished
+    process = process.reload_data # load new info about this process
+    return(true) if process.status == 'finished' # return true if the upload has finished
     sleep 1 # wait for 1 second, adjust this number with regards to the upload size
   end
 
@@ -79,7 +87,8 @@ def uploaded?(process)
 end
 
 processes = exporter.export!
-uploaded? processes[0]
+puts "Checking status for the #{processes[0].path} file"
+uploaded? processes[0].process
 ```
 
 Please don't forget that Lokalise API has rate limiting and you cannot send more than six requests per second.
@@ -130,7 +139,7 @@ importer = LokaliseManager.importer api_token: '1234abc',
 ```
 
 * `import_safe_mode` (`boolean`) — default to `false`. When this option is enabled, the import task will check whether the directory set with `locales_path` is empty or not. If it is not empty, you will be prompted to continue.
-* `max_retries_import` (`integer`) — this option is introduced to properly handle Lokalise API rate limiting. If the HTTP status code 429 (too many requests) has been received, this gem will apply an exponential backoff mechanism with a very simple formula: `2 ** retries`. If the maximum number of retries has been reached, a `Lokalise::Error::TooManyRequests` exception will be raised and the operation will be halted.
+* `max_retries_import` (`integer`) — this option is introduced to properly handle Lokalise API rate limiting. If the HTTP status code 429 (too many requests) has been received, this gem will apply an exponential backoff mechanism with a very simple formula: `2 ** retries`. If the maximum number of retries has been reached, a `RubyLokaliseApi::Error::TooManyRequests` exception will be raised and the operation will be halted.
 
 ### Export config
 
@@ -162,7 +171,29 @@ In this case the `export_opts` will have `detect_icu_plurals` set to `true` and
 c.skip_file_export = ->(file) { f.split[1].to_s.include?('fr') }
 ```
 
-* `max_retries_export` (`integer`) — this option is introduced to properly handle Lokalise API rate limiting. If the HTTP status code 429 (too many requests) has been received, LokaliseRails will apply an exponential backoff mechanism with a very simple formula: `2 ** retries` (initially `retries` is `0`). If the maximum number of retries has been reached, a `Lokalise::Error::TooManyRequests` exception will be raised and the export operation will be halted. By default, LokaliseRails will make up to `5` retries which potentially means `1 + 2 + 4 + 8 + 16 + 32 = 63` seconds of waiting time. If the `max_retries_export` is less than `1`, LokaliseRails will not perform any retries and give up immediately after receiving error 429.
+* `max_retries_export` (`integer`) — this option is introduced to properly handle Lokalise API rate limiting. If the HTTP status code 429 (too many requests) has been received, LokaliseManager will apply an exponential backoff mechanism with a very simple formula: `2 ** retries` (initially `retries` is `0`). If the maximum number of retries has been reached, a `RubyLokaliseApi::Error::TooManyRequests` exception will be raised and the export operation will be halted. By default, LokaliseManager will make up to `5` retries which potentially means `1 + 2 + 4 + 8 + 16 + 32 = 63` seconds of waiting time. If the `max_retries_export` is less than `1`, LokaliseManager will not perform any retries and give up immediately after receiving error 429.
+* `raise_on_export_fail` (`boolean`) — default is `true`. When this option is enabled, LokaliseManager will re-raise any exceptions that happened during the file uploading. In other words, if any uploading thread raised an exception, your exporting process will exit with an exception. Suppose, you are uploading 12 translation files; these files will be split in 2 groups with 6 files each, and each group will be uploaded in parallel (using threads). However, suppose some exception happens when uploading the first group. By default this exception will be re-raised for the whole process and the script will never try to upload the second group. If you would like to continue uploading even if an exception happened, set the `raise_on_export_fail` to `false`. In this case the `export!` method will return an array with scheduled processes and with information about processes that were not successfully scheduled. This information is represented as an object with three methods: `path` (contains an instance of the `Pathname` class which says which file could not be uploaded), `error` (the actual exception), and `success` (returns `false`). So, you can use the following snippet to check your processes:
+
+```ruby
+processes = exporter.export!
+
+processes.each do |proc_data|
+  if proc_data.success
+    # Everything is good, the uploading is queued
+    puts "#{proc_data.path} is sent to Lokalise!"
+    process = proc_data.process
+    puts "Current process status is #{process.status}"
+  else
+    # Something bad has happened
+    puts "Could not send #{proc_data.path} to Lokalise"
+    puts "Error #{proc_data.error.class}: #{proc_data.error.message}"
+    # Or you could re-raise this exception:
+    # raise proc_data.error.class
+  end
+end
+```
+
+* For example, you could collect all the files that were uploaded successfully, re-create the exporter object with the `skip_file_export` option (skipping all files that were successfully imported), and re-run the whole exporting process once again.
 
 ### Config to work with formats other than YAML
 
@@ -193,7 +224,7 @@ importer = LokaliseManager.importer api_token: '1234abc',
 
 These options will be merged with the default ones. Please note that per-client config has the highest priority.
 
-You can also adjust individual options later using the `#config` instance variable (it contains an OpenStruct object):
+You can also adjust individual options later using the `#config` instance variable (it contains a Struct object):
 
 ```
 importer.config.project_id = '678xyz'

data/lib/lokalise_manager/error.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module LokaliseManager
+  # LokaliseManager error class, subclass of StandardError
   class Error < StandardError
     # Initializes a new Error object
     def initialize(message = '')

data/lib/lokalise_manager/global_config.rb

@@ -1,19 +1,26 @@
 # frozen_string_literal: true
 
 module LokaliseManager
+  # Global configuration options available for LokaliseManager
   class GlobalConfig
     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,
                   :translations_loader, :translations_converter, :lang_iso_inferer,
-                  :max_retries_export, :max_retries_import, :use_oauth2_token, :silent_mode
+                  :max_retries_export, :max_retries_import, :use_oauth2_token, :silent_mode,
+                  :raise_on_export_fail
 
       # Main interface to provide configuration options
       def config
         yield self
       end
 
+      # When enabled, will re-raise any exception that happens during file exporting
+      def raise_on_export_fail
+        @raise_on_export_fail || true
+      end
+
       # When enabled, won't print any debugging info to $stdout
       def silent_mode
         @silent_mode || false

data/lib/lokalise_manager/task_definitions/base.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-require 'ruby-lokalise-api'
+require 'ruby_lokalise_api'
 require 'pathname'
 
 module LokaliseManager
   module TaskDefinitions
+    # Base class for LokaliseManager task definitions that includes common methods and logic
     class Base
       using LokaliseManager::Utils::HashUtils
 
@@ -33,18 +34,18 @@ module LokaliseManager
 
       # Creates a Lokalise API client
       #
-      # @return [Lokalise::Client]
+      # @return [RubyLokaliseApi::Client]
       def api_client
-        client_opts = [config.api_token, {enable_compression: true}.merge(config.timeouts)]
-        client_method = config.use_oauth2_token ? :oauth_client : :client
+        client_opts = [config.api_token, config.timeouts]
+        client_method = config.use_oauth2_token ? :oauth2_client : :client
 
-        @api_client = ::Lokalise.send(client_method, *client_opts)
+        @api_client = ::RubyLokaliseApi.send(client_method, *client_opts)
       end
 
       # Resets API client
       def reset_api_client!
-        ::Lokalise.reset_client!
-        ::Lokalise.reset_oauth_client!
+        ::RubyLokaliseApi.reset_client!
+        ::RubyLokaliseApi.reset_oauth2_client!
         @api_client = nil
       end
 
@@ -94,7 +95,7 @@ module LokaliseManager
         retries = 0
         begin
           yield
-        rescue Lokalise::Error::TooManyRequests => e
+        rescue RubyLokaliseApi::Error::TooManyRequests => e
           raise(e.class, "Gave up after #{retries} retries") if retries >= max_retries
 
           sleep 2**retries

data/lib/lokalise_manager/task_definitions/exporter.rb

@@ -4,8 +4,11 @@ require 'base64'
 
 module LokaliseManager
   module TaskDefinitions
+    # Exporter class is used when you want to upload translation files from your project to Lokalise
     class Exporter < Base
-      using LokaliseManager::Utils::ArrayUtils
+      # Lokalise allows no more than 6 requests per second
+      MAX_THREADS = 6
+
       # Performs translation file export to Lokalise and returns an array of queued processes
       #
       # @return [Array]
@@ -14,11 +17,11 @@ module LokaliseManager
 
         queued_processes = []
 
-        all_files.in_groups_of(6) do |files_group|
+        all_files.each_slice(MAX_THREADS) do |files_group|
           parallel_upload(files_group).each do |thr|
-            raise_on_fail thr
+            raise_on_fail(thr) if config.raise_on_export_fail
 
-            queued_processes.push thr[:process]
+            queued_processes.push thr
           end
         end
 
@@ -30,42 +33,44 @@ module LokaliseManager
       private
 
       def parallel_upload(files_group)
-        files_group.compact.map do |file_data|
+        files_group.map do |file_data|
           do_upload(*file_data)
         end.map(&:value)
       end
 
       def raise_on_fail(thread)
-        raise thread[:error].class, "Error while trying to upload #{thread[:path]}: #{thread[:error].message}" if thread[:status] == :fail
+        return if thread.success
+
+        raise(thread.error.class, "Error while trying to upload #{thread.path}: #{thread.error.message}")
       end
 
       # Performs the actual file uploading to Lokalise. If the API rate limit is exceeed,
       # applies exponential backoff
       def do_upload(f_path, r_path)
+        proc_klass = Struct.new(:success, :process, :path, :error, keyword_init: true)
+
         Thread.new do
           process = with_exp_backoff(config.max_retries_export) do
             api_client.upload_file project_id_with_branch, opts(f_path, r_path)
           end
-          {status: :ok, process: process}
+          proc_klass.new success: true, process: process, path: f_path
         rescue StandardError => e
-          {status: :fail, path: f_path, error: e}
+          proc_klass.new success: false, path: f_path, error: e
         end
       end
 
       # Gets translation files from the specified directory
       def all_files
-        files = []
         loc_path = config.locales_path
-        Dir["#{loc_path}/**/*"].sort.each do |f|
+        Dir["#{loc_path}/**/*"].filter_map do |f|
           full_path = Pathname.new f
 
           next unless file_matches_criteria? full_path
 
           relative_path = full_path.relative_path_from Pathname.new(loc_path)
 
-          files << [full_path, relative_path]
+          [full_path, relative_path]
         end
-        files
       end
 
       # Generates export options

data/lib/lokalise_manager/task_definitions/importer.rb

@@ -6,6 +6,7 @@ require 'fileutils'
 
 module LokaliseManager
   module TaskDefinitions
+    # Importer class is used when you want to download translation files from Lokalise into your project
     class Importer < Base
       # Performs translation files import from Lokalise
       #

data/lib/lokalise_manager/utils/hash_utils.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-# Taken from https://github.com/rails/rails/blob/83217025a171593547d1268651b446d3533e2019/activesupport/lib/active_support/core_ext/hash/deep_merge.rb
-
 module LokaliseManager
   module Utils
+    # Common helper methods for hashes
     module HashUtils
       refine Hash do
+        # Deeply merges two hashes
+        # Taken from https://github.com/rails/rails/blob/83217025a171593547d1268651b446d3533e2019/activesupport/lib/active_support/core_ext/hash/deep_merge.rb
         def deep_merge(other_hash, &block)
           dup.deep_merge!(other_hash, &block)
         end

data/lib/lokalise_manager/version.rb

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

data/lib/lokalise_manager.rb

@@ -1,17 +1,21 @@
 # frozen_string_literal: true
 
+require 'zeitwerk'
 require 'yaml'
 
-require 'lokalise_manager/utils/hash_utils'
-require 'lokalise_manager/utils/array_utils'
-
-require 'lokalise_manager/version'
-require 'lokalise_manager/error'
-require 'lokalise_manager/global_config'
-require 'lokalise_manager/task_definitions/base'
-require 'lokalise_manager/task_definitions/importer'
-require 'lokalise_manager/task_definitions/exporter'
+loader = Zeitwerk::Loader.for_gem
+loader.setup
 
+# LokaliseManager main module that exposes helper methods:
+#
+#   importer = LokaliseManager.importer api_token: '1234abc', project_id: '123.abc'
+#   exporter = LokaliseManager.exporter api_token: '1234abc', project_id: '123.abc'
+#
+# Use the instantiated objects to import or export your translation files:
+#
+#   importer.import!
+#   exporter.export!
+#
 module LokaliseManager
   class << self
     # Initializes a new importer client which is used to download

data/lokalise_manager.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.homepage              = 'https://github.com/bodrovis/lokalise_manager'
   spec.license               = 'MIT'
   spec.platform              = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.required_ruby_version = '>= 2.7'
 
   spec.files = Dir['README.md', 'LICENSE',
                    'CHANGELOG.md', 'lib/**/*.rb',
@@ -23,8 +23,9 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = ['README.md']
   spec.require_paths    = ['lib']
 
-  spec.add_dependency 'ruby-lokalise-api', '~> 4.0'
+  spec.add_dependency 'ruby-lokalise-api', '~> 6.0'
   spec.add_dependency 'rubyzip', '~> 2.3'
+  spec.add_dependency 'zeitwerk', '~> 2.4'
 
   spec.add_development_dependency 'codecov', '~> 0.2'
   spec.add_development_dependency 'dotenv', '~> 2.5'

data/spec/lib/lokalise_manager/global_config_spec.rb

@@ -14,6 +14,11 @@ describe LokaliseManager::GlobalConfig do
     fake_class.project_id = '123.abc'
   end
 
+  it 'is possible to set raise_on_export_fail' do
+    allow(fake_class).to receive(:raise_on_export_fail=).with(false)
+    fake_class.raise_on_export_fail = false
+  end
+
   it 'is possible to set silent_mode' do
     allow(fake_class).to receive(:silent_mode=).with(true)
     fake_class.silent_mode = true

data/spec/lib/lokalise_manager/task_definitions/base_spec.rb

@@ -22,7 +22,7 @@ describe LokaliseManager::TaskDefinitions::Base do
   end
 
   specify '.reset_client!' do
-    expect(described_object.api_client).to be_an_instance_of(Lokalise::Client)
+    expect(described_object.api_client).to be_an_instance_of(RubyLokaliseApi::Client)
     described_object.reset_api_client!
     current_client = described_object.instance_variable_get :@api_client
     expect(current_client).to be_nil
@@ -63,14 +63,18 @@ describe LokaliseManager::TaskDefinitions::Base do
     it 'raises an error when the API key is not set' do
       allow(LokaliseManager::GlobalConfig).to receive(:api_token).and_return(nil)
 
-      expect(-> { described_object.send(:check_options_errors!) }).to raise_error(LokaliseManager::Error, /API token is not set/i)
+      expect do
+        described_object.send(:check_options_errors!)
+      end.to raise_error(LokaliseManager::Error, /API token is not set/i)
 
       expect(LokaliseManager::GlobalConfig).to have_received(:api_token)
     end
 
     it 'returns an error when the project_id is not set' do
       allow_project_id described_object, nil do
-        expect(-> { described_object.send(:check_options_errors!) }).to raise_error(LokaliseManager::Error, /ID is not set/i)
+        expect do
+          described_object.send(:check_options_errors!)
+        end.to raise_error(LokaliseManager::Error, /ID is not set/i)
       end
     end
   end
@@ -95,8 +99,8 @@ describe LokaliseManager::TaskDefinitions::Base do
                                                                       })
 
       client = described_object.api_client
-      expect(client).to be_an_instance_of(Lokalise::Client)
-      expect(client).not_to be_an_instance_of(Lokalise::OAuthClient)
+      expect(client).to be_an_instance_of(RubyLokaliseApi::Client)
+      expect(client).not_to be_an_instance_of(RubyLokaliseApi::OAuth2Client)
       expect(client.open_timeout).to eq(100)
       expect(client.timeout).to eq(500)
     end
@@ -106,8 +110,8 @@ describe LokaliseManager::TaskDefinitions::Base do
 
       client = described_object.api_client
 
-      expect(client).to be_an_instance_of(Lokalise::OAuthClient)
-      expect(client).not_to be_an_instance_of(Lokalise::Client)
+      expect(client).to be_an_instance_of(RubyLokaliseApi::OAuth2Client)
+      expect(client).not_to be_an_instance_of(RubyLokaliseApi::Client)
     end
   end
 end

data/spec/lib/lokalise_manager/task_definitions/exporter_spec.rb

@@ -14,105 +14,157 @@ describe LokaliseManager::TaskDefinitions::Exporter do
   end
 
   context 'with many translation files' do
-    before :all do
-      add_translation_files! with_ru: true, additional: 5
-    end
+    describe '.export!' do
+      context 'with no errors' do
+        before do
+          add_translation_files! with_ru: true, additional: 5
+        end
 
-    after :all do
-      rm_translation_files
-    end
+        after do
+          rm_translation_files
+        end
 
-    describe '.export!' do
-      it 'sends a proper API request and handles rate limiting' do
-        process = nil
+        it 'sends a proper API request and handles rate limiting' do
+          process = nil
 
-        VCR.use_cassette('upload_files_multiple') do
-          expect(-> { process = described_object.export!.first }).to output(/complete!/).to_stdout
+          VCR.use_cassette('upload_files_multiple') do
+            expect { process = described_object.export!.first.process }.to output(/complete!/).to_stdout
+          end
+
+          expect(process.project_id).to eq(project_id)
+          expect(process.status).to eq('queued')
         end
 
-        expect(process.project_id).to eq(project_id)
-        expect(process.status).to eq('queued')
+        it 'handles too many requests but does not re-raise anything when raise_on_export_fail is false' do
+          allow(described_object.config).to receive(:max_retries_export).and_return(1)
+          allow(described_object.config).to receive(:raise_on_export_fail).and_return(false)
+          allow(described_object).to receive(:sleep).and_return(0)
+
+          fake_client = instance_double('RubyLokaliseApi::Client')
+          allow(fake_client).to receive(:token).with(any_args).and_return('fake_token')
+          allow(fake_client).to receive(:upload_file).with(any_args).and_raise(RubyLokaliseApi::Error::TooManyRequests)
+          allow(described_object).to receive(:api_client).and_return(fake_client)
+          processes = []
+          expect { processes = described_object.export! }.not_to raise_error
+
+          expect(processes[0].success).to be false
+          expect(processes[1].error.class).to eq(RubyLokaliseApi::Error::TooManyRequests)
+          expect(processes.count).to eq(7)
+
+          expect(described_object).to have_received(:sleep).exactly(7).times
+          expect(described_object).to have_received(:api_client).at_least(14).times
+          expect(fake_client).to have_received(:upload_file).exactly(14).times
+        end
       end
 
-      it 'handles too many requests' do
-        allow(described_object.config).to receive(:max_retries_export).and_return(1)
-        allow(described_object).to receive(:sleep).and_return(0)
+      context 'with errors' do
+        before do
+          add_translation_files! with_ru: true
+        end
+
+        after do
+          rm_translation_files
+        end
+
+        it 'handles too many requests' do
+          allow(described_object.config).to receive(:max_retries_export).and_return(1)
+          allow(described_object).to receive(:sleep).and_return(0)
 
-        fake_client = instance_double('Lokalise::Client')
-        allow(fake_client).to receive(:token).with(any_args).and_return('fake_token')
-        allow(fake_client).to receive(:upload_file).with(any_args).and_raise(Lokalise::Error::TooManyRequests)
-        allow(described_object).to receive(:api_client).and_return(fake_client)
+          fake_client = instance_double('RubyLokaliseApi::Client')
+          allow(fake_client).to receive(:token).with(any_args).and_return('fake_token')
+          allow(fake_client).to receive(:upload_file).with(any_args).and_raise(RubyLokaliseApi::Error::TooManyRequests)
+          allow(described_object).to receive(:api_client).and_return(fake_client)
 
-        expect(-> { described_object.export! }).to raise_error(Lokalise::Error::TooManyRequests, /Gave up after 1 retries/i)
+          expect do
+            described_object.export!
+          end.to raise_error(RubyLokaliseApi::Error::TooManyRequests, /Gave up after 1 retries/i)
 
-        expect(described_object).to have_received(:sleep).exactly(6).times
-        expect(described_object).to have_received(:api_client).at_least(12).times
-        expect(fake_client).to have_received(:upload_file).exactly(12).times
+          expect(described_object).to have_received(:sleep).exactly(2).times
+          expect(described_object).to have_received(:api_client).at_least(4).times
+          expect(fake_client).to have_received(:upload_file).exactly(4).times
+        end
       end
     end
   end
 
   context 'with one translation file' do
-    before :all do
-      add_translation_files!
-    end
+    context 'without files' do
+      it 'halts when the API key is not set' do
+        allow(described_object.config).to receive(:api_token).and_return(nil)
 
-    after :all do
-      rm_translation_files
+        expect { described_object.export! }.to raise_error(LokaliseManager::Error, /API token is not set/i)
+        expect(described_object.config).to have_received(:api_token)
+      end
+
+      it 'halts when the project_id is not set' do
+        allow_project_id described_object, nil do
+          expect { described_object.export! }.to raise_error(LokaliseManager::Error, /ID is not set/i)
+        end
+      end
     end
 
-    describe '.export!' do
-      it 'sends a proper API request but does not output anything when silent_mode is enabled' do
-        allow(described_object.config).to receive(:silent_mode).and_return(true)
+    context 'with files' do
+      before do
+        add_translation_files!
+      end
 
-        process = nil
+      after do
+        rm_translation_files
+      end
 
-        VCR.use_cassette('upload_files') do
-          expect(-> { process = described_object.export!.first }).not_to output(/complete!/).to_stdout
-        end
+      describe '.export!' do
+        it 'sends a proper API request but does not output anything when silent_mode is enabled' do
+          allow(described_object.config).to receive(:silent_mode).and_return(true)
 
-        expect(process.status).to eq('queued')
-        expect(described_object.config).to have_received(:silent_mode).at_most(1).times
-      end
+          process = nil
 
-      it 'sends a proper API request' do
-        process = VCR.use_cassette('upload_files') do
-          described_object.export!
-        end.first
+          VCR.use_cassette('upload_files') do
+            expect { process = described_object.export!.first.process }.not_to output(/complete!/).to_stdout
+          end
 
-        expect(process.project_id).to eq(project_id)
-        expect(process.status).to eq('queued')
-      end
+          expect(process.status).to eq('queued')
+          expect(described_object.config).to have_received(:silent_mode).at_most(1).times
+        end
 
-      it 'sends a proper API request when a different branch is provided' do
-        allow(described_object.config).to receive(:branch).and_return('develop')
+        it 'sends a proper API request' do
+          process = VCR.use_cassette('upload_files') do
+            described_object.export!
+          end.first.process
 
-        process = VCR.use_cassette('upload_files_branch') do
-          described_object.export!
-        end.first
+          expect(process.project_id).to eq(project_id)
+          expect(process.status).to eq('queued')
+        end
 
-        expect(described_object.config).to have_received(:branch).at_most(2).times
-        expect(process.project_id).to eq(project_id)
-        expect(process.status).to eq('queued')
-      end
+        it 'sends a proper API request when a different branch is provided' do
+          allow(described_object.config).to receive(:branch).and_return('develop')
 
-      it 'halts when the API key is not set' do
-        allow(described_object.config).to receive(:api_token).and_return(nil)
+          process_data = VCR.use_cassette('upload_files_branch') do
+            described_object.export!
+          end.first
 
-        expect(-> { described_object.export! }).to raise_error(LokaliseManager::Error, /API token is not set/i)
-        expect(described_object.config).to have_received(:api_token)
-      end
+          expect(described_object.config).to have_received(:branch).at_most(2).times
+          expect(process_data.success).to be true
+          expect(process_data.path.to_s).to include('en.yml')
 
-      it 'halts when the project_id is not set' do
-        allow_project_id described_object, nil do
-          expect(-> { described_object.export! }).to raise_error(LokaliseManager::Error, /ID is not set/i)
+          process = process_data.process
+          expect(process).to be_an_instance_of(RubyLokaliseApi::Resources::QueuedProcess)
+          expect(process.project_id).to eq(project_id)
+          expect(process.status).to eq('queued')
         end
       end
     end
 
     describe '#all_files' do
+      before do
+        add_translation_files!
+      end
+
+      after do
+        rm_translation_files
+      end
+
       it 'yield proper arguments' do
-        expect(described_object.send(:all_files).first).to include(
+        expect(described_object.send(:all_files).flatten).to include(
           Pathname.new(path),
           Pathname.new(relative_name)
         )
@@ -120,6 +172,14 @@ describe LokaliseManager::TaskDefinitions::Exporter do
     end
 
     describe '.opts' do
+      before do
+        add_translation_files!
+      end
+
+      after do
+        rm_translation_files
+      end
+
       let(:base64content) { Base64.strict_encode64(File.read(path).strip) }
 
       it 'generates proper options' do
@@ -152,11 +212,11 @@ describe LokaliseManager::TaskDefinitions::Exporter do
     let(:filename_ru) { 'ru.yml' }
     let(:path_ru) { "#{Dir.getwd}/locales/#{filename_ru}" }
 
-    before :all do
+    before do
       add_translation_files! with_ru: true
     end
 
-    after :all do
+    after do
       rm_translation_files
     end
 
@@ -165,7 +225,7 @@ describe LokaliseManager::TaskDefinitions::Exporter do
         allow_project_id described_object, '542886116159f798720dc4.94769464'
 
         VCR.use_cassette('upload_files_error') do
-          expect { described_object.export! }.to raise_error(Lokalise::Error::BadRequest, /Unknown `lang_iso`/)
+          expect { described_object.export! }.to raise_error(RubyLokaliseApi::Error::BadRequest, /Unknown `lang_iso`/)
         end
       end
     end
@@ -182,14 +242,14 @@ describe LokaliseManager::TaskDefinitions::Exporter do
       end
     end
 
-    describe '#each_file' do
+    describe '#all_files' do
       it 'returns all files' do
-        files = described_object.send(:all_files)
-        expect(files[0]).to include(
+        files = described_object.send(:all_files).flatten
+        expect(files).to include(
           Pathname.new(path),
           Pathname.new(relative_name)
         )
-        expect(files[1]).to include(
+        expect(files).to include(
           Pathname.new(path_ru),
           Pathname.new(filename_ru)
         )
@@ -199,7 +259,7 @@ describe LokaliseManager::TaskDefinitions::Exporter do
         allow(described_object.config).to receive(:skip_file_export).twice.and_return(
           ->(f) { f.split[1].to_s.include?('ru') }
         )
-        files = described_object.send(:all_files)
+        files = described_object.send(:all_files).sort
         expect(files[0]).to include(
           Pathname.new(path),
           Pathname.new(relative_name)

data/spec/lib/lokalise_manager/task_definitions/importer_spec.rb

@@ -15,14 +15,14 @@ describe LokaliseManager::TaskDefinitions::Importer do
       entry = double
       allow(entry).to receive(:name).and_return('fail.yml')
       allow(described_object).to receive(:data_from).with(entry).and_raise(EncodingError)
-      expect(-> { described_object.send(:process!, entry) }).
+      expect { described_object.send(:process!, entry) }.
         to raise_error(EncodingError, /Error when trying to process fail\.yml/)
 
       expect(described_object).to have_received(:data_from)
     end
 
     it 're-raises errors during file opening' do
-      expect(-> { described_object.send(:open_and_process_zip, 'http://fake.url/wrong/path.zip') }).
+      expect { described_object.send(:open_and_process_zip, 'http://fake.url/wrong/path.zip') }.
         to raise_error(SocketError, /Failed to open TCP connection/)
     end
   end
@@ -35,15 +35,14 @@ describe LokaliseManager::TaskDefinitions::Importer do
 
       expect(response['project_id']).to eq('672198945b7d72fc048021.15940510')
       expect(response['bundle_url']).to include('s3-eu-west-1.amazonaws.com')
-      expect(described_object.api_client.enable_compression).to eq(true)
     end
 
     it 're-raises errors during file download' do
       allow_project_id described_object, 'invalid'
 
       VCR.use_cassette('download_files_error') do
-        expect(-> { described_object.send :download_files }).
-          to raise_error(Lokalise::Error::BadRequest, /Invalid `project_id` parameter/)
+        expect { described_object.send :download_files }.
+          to raise_error(RubyLokaliseApi::Error::BadRequest, /Invalid `project_id` parameter/)
       end
     end
   end
@@ -53,11 +52,11 @@ describe LokaliseManager::TaskDefinitions::Importer do
       it 'handles too many requests' do
         allow(described_object).to receive(:sleep).and_return(0)
 
-        fake_client = instance_double('Lokalise::Client')
-        allow(fake_client).to receive(:download_files).and_raise(Lokalise::Error::TooManyRequests)
+        fake_client = instance_double('RubyLokaliseApi::Client')
+        allow(fake_client).to receive(:download_files).and_raise(RubyLokaliseApi::Error::TooManyRequests)
         allow(described_object).to receive(:api_client).and_return(fake_client)
 
-        expect(-> { described_object.import! }).to raise_error(Lokalise::Error::TooManyRequests, /Gave up after 2 retries/i)
+        expect { described_object.import! }.to raise_error(RubyLokaliseApi::Error::TooManyRequests, /Gave up after 2 retries/i)
 
         expect(described_object).to have_received(:sleep).exactly(2).times
         expect(described_object).to have_received(:api_client).exactly(3).times
@@ -66,14 +65,14 @@ describe LokaliseManager::TaskDefinitions::Importer do
 
       it 'halts when the API key is not set' do
         allow(described_object.config).to receive(:api_token).and_return(nil)
-        expect(-> { described_object.import! }).to raise_error(LokaliseManager::Error, /API token is not set/i)
+        expect { described_object.import! }.to raise_error(LokaliseManager::Error, /API token is not set/i)
         expect(described_object.config).to have_received(:api_token)
         expect(count_translations).to eq(0)
       end
 
       it 'halts when the project_id is not set' do
         allow_project_id described_object, nil do
-          expect(-> { described_object.import! }).to raise_error(LokaliseManager::Error, /ID is not set/i)
+          expect { described_object.import! }.to raise_error(LokaliseManager::Error, /ID is not set/i)
           expect(count_translations).to eq(0)
         end
       end
@@ -82,10 +81,9 @@ describe LokaliseManager::TaskDefinitions::Importer do
     context 'when directory is empty' do
       before do
         mkdir_locales
-        rm_translation_files
       end
 
-      after :all do
+      after do
         rm_translation_files
       end
 
@@ -110,7 +108,7 @@ describe LokaliseManager::TaskDefinitions::Importer do
         result = nil
 
         VCR.use_cassette('import') do
-          expect(-> { result = described_object.import! }).to output(/complete!/).to_stdout
+          expect { result = described_object.import! }.to output(/complete!/).to_stdout
         end
 
         expect(result).to be true
@@ -125,7 +123,7 @@ describe LokaliseManager::TaskDefinitions::Importer do
         result = nil
 
         VCR.use_cassette('import') do
-          expect(-> { result = described_object.import! }).not_to output(/complete!/).to_stdout
+          expect { result = described_object.import! }.not_to output(/complete!/).to_stdout
         end
 
         expect(result).to be true
@@ -142,16 +140,13 @@ describe LokaliseManager::TaskDefinitions::Importer do
                             import_safe_mode: true
       end
 
-      before :all do
-        mkdir_locales
-      end
-
       before do
+        mkdir_locales
         rm_translation_files
         add_translation_files!
       end
 
-      after :all do
+      after do
         rm_translation_files
       end
 
@@ -164,7 +159,7 @@ describe LokaliseManager::TaskDefinitions::Importer do
         )
 
         allow($stdin).to receive(:gets).and_return('Y')
-        expect(-> { safe_mode_obj.import! }).to output(/is not empty/).to_stdout
+        expect { safe_mode_obj.import! }.to output(/is not empty/).to_stdout
 
         expect(count_translations).to eq(5)
         expect($stdin).to have_received(:gets)
@@ -177,18 +172,18 @@ describe LokaliseManager::TaskDefinitions::Importer do
       it 'import halts when a user chooses not to proceed' do
         allow(safe_mode_obj).to receive(:download_files).at_most(0).times
         allow($stdin).to receive(:gets).and_return('N')
-        expect(-> { safe_mode_obj.import! }).to output(/cancelled/).to_stdout
+        expect { safe_mode_obj.import! }.to output(/cancelled/).to_stdout
 
         expect(safe_mode_obj).not_to have_received(:download_files)
         expect($stdin).to have_received(:gets)
         expect(count_translations).to eq(1)
       end
 
-      it 'import halts when a user chooses not to proceed and debug info is not printed out when silent_mode is enabled' do
+      it 'import halts when a user chooses to halt and debug info is not printed out when silent_mode is enabled' do
         allow(safe_mode_obj.config).to receive(:silent_mode).and_return(true)
         allow(safe_mode_obj).to receive(:download_files).at_most(0).times
         allow($stdin).to receive(:gets).and_return('N')
-        expect(-> { safe_mode_obj.import! }).not_to output(/cancelled/).to_stdout
+        expect { safe_mode_obj.import! }.not_to output(/cancelled/).to_stdout
 
         expect(safe_mode_obj).not_to have_received(:download_files)
         expect(safe_mode_obj.config).to have_received(:silent_mode)

data/spec/support/file_manager.rb

@@ -4,7 +4,9 @@ require 'fileutils'
 
 module FileManager
   def mkdir_locales
-    FileUtils.mkdir_p(LokaliseManager::GlobalConfig.locales_path) unless File.directory?(LokaliseManager::GlobalConfig.locales_path)
+    return if File.directory?(LokaliseManager::GlobalConfig.locales_path)
+
+    FileUtils.mkdir_p(LokaliseManager::GlobalConfig.locales_path)
   end
 
   def rm_translation_files

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lokalise_manager
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2022-03-11 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: '4.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -187,7 +201,6 @@ files:
 - lib/lokalise_manager/task_definitions/base.rb
 - lib/lokalise_manager/task_definitions/exporter.rb
 - lib/lokalise_manager/task_definitions/importer.rb
-- lib/lokalise_manager/utils/array_utils.rb
 - lib/lokalise_manager/utils/hash_utils.rb
 - lib/lokalise_manager/version.rb
 - lokalise_manager.gemspec
@@ -195,9 +208,8 @@ files:
 - spec/lib/lokalise_manager/task_definitions/base_spec.rb
 - spec/lib/lokalise_manager/task_definitions/exporter_spec.rb
 - spec/lib/lokalise_manager/task_definitions/importer_spec.rb
+- spec/lib/lokalise_manager/utils/hash_utils_spec.rb
 - spec/lib/lokalise_manager_spec.rb
-- spec/lib/utils/array_utils_spec.rb
-- spec/lib/utils/hash_utils_spec.rb
 - spec/spec_helper.rb
 - spec/support/file_manager.rb
 - spec/support/spec_addons.rb
@@ -215,14 +227,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.3.8
 signing_key:
 specification_version: 4
 summary: Lokalise integration for Ruby
@@ -231,9 +243,8 @@ test_files:
 - spec/lib/lokalise_manager/task_definitions/base_spec.rb
 - spec/lib/lokalise_manager/task_definitions/exporter_spec.rb
 - spec/lib/lokalise_manager/task_definitions/importer_spec.rb
+- spec/lib/lokalise_manager/utils/hash_utils_spec.rb
 - spec/lib/lokalise_manager_spec.rb
-- spec/lib/utils/array_utils_spec.rb
-- spec/lib/utils/hash_utils_spec.rb
 - spec/spec_helper.rb
 - spec/support/file_manager.rb
 - spec/support/spec_addons.rb

data/lib/lokalise_manager/utils/array_utils.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-# Taken from https://github.com/rails/rails/blob/6bfc637659248df5d6719a86d2981b52662d9b50/activesupport/lib/active_support/core_ext/array/grouping.rb
-
-module LokaliseManager
-  module Utils
-    module ArrayUtils
-      refine Array do
-        def in_groups_of(number, fill_with = nil, &block)
-          if number.to_i <= 0
-            raise ArgumentError,
-                  "Group size must be a positive integer, was #{number.inspect}"
-          end
-
-          if fill_with == false
-            collection = self
-          else
-            padding = (number - (size % number)) % number
-            collection = dup.concat(Array.new(padding, fill_with))
-          end
-
-          collection.each_slice(number, &block)
-        end
-      end
-    end
-  end
-end

data/spec/lib/utils/array_utils_spec.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-describe LokaliseManager::Utils::ArrayUtils do
-  using described_class
-  let(:arr) { (1..8).to_a }
-
-  describe '#in_groups_of' do
-    it 'raises an exception when the number is less than 1' do
-      expect(-> { arr.in_groups_of(-1) }).to raise_error(ArgumentError)
-    end
-
-    it 'uses collection itself if fill_with is false' do
-      enum = arr.in_groups_of(5, false)
-      enum.next
-      expect(enum.next.count).to eq(3)
-    end
-  end
-end