lokalise_manager 1.2.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33815f129df22f7a27f91689cad944193aca9b992f14e7115a2737088785d3b3
-  data.tar.gz: 1fc5a893bb917bac5afd39f2b35dbbb54286b878dce42f0805135105490520b5
+  metadata.gz: fa7eb812b614ec768710c4f085879dfaf6cf89f72e25b1a777f34af3e9cd8be5
+  data.tar.gz: afdd4c08bf9672302c279cd88b4c4caf63317b1aca98036a5e8c1dad361289f0
 SHA512:
-  metadata.gz: 7fecf43ac4f105be85fe2e4548643849b78a239ec523a79b37fec4b6acbeddf319dd4ac594e5caf28e4b174fed76e05b18d3bf6d6343d055daa2115d661b41c4
-  data.tar.gz: 85f6c703a1ee2107cfe165b7c652cc81d2c2f0a0ae2a02af44cfb0e0cf31a185e5cbe3cbe27c8c53d411a8dd4f3046a98b02dadde3d983855e02cead3347cfb4
+  metadata.gz: 5857c35bde158e85bdec5c2e4618ebf1ddc7768f5822d5492109347fa93907434869d23c5053f6c7b98da8016e4e22c40fa8fa4b513c347630aeb18288f8d18d
+  data.tar.gz: 02bbc800a21396c6f106b2c18df5eee2f7247d43fac80da656496d4a8ec6a50c8d9438bb3514d13b57647f29aebfb1caf1e633a79d97eb37e30ae6bbb2634ecd

data/CHANGELOG.md

@@ -1,5 +1,62 @@
 # Changelog
 
+## 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)
+* Test with Ruby 3.1.0
+* Other minor fixes
+
 ## 1.2.1 (26-Nov-21)
 
 * Use refinements instead of monkey patching to add hash methods

data/README.md

@@ -1,7 +1,7 @@
 # LokaliseManager
 
 ![Gem](https://img.shields.io/gem/v/lokalise_manager)
-[![Build Status](https://travis-ci.com/bodrovis/lokalise_manager.svg?branch=master)](https://travis-ci.com/github/bodrovis/lokalise_manager)
+![CI](https://github.com/bodrovis/lokalise_manager/actions/workflows/ci.yml/badge.svg)
 [![Test Coverage](https://codecov.io/gh/bodrovis/lokalise_manager/graph/badge.svg)](https://codecov.io/gh/bodrovis/lokalise_manager)
 ![Downloads total](https://img.shields.io/gem/dt/lokalise_manager)
 
@@ -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 `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.
+* `#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.
@@ -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 `Lokalise::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'
@@ -271,4 +302,4 @@ importer.import!
 
 ## License
 
-Copyright (c) [Lokalise team](http://lokalise.com), [Ilya Bodrov](http://bodrovis.tech). License type is [MIT](https://github.com/bodrovis/lokalise_manager/blob/master/LICENSE).
+Copyright (c) [Lokalise team](http://lokalise.com), [Ilya Bodrov](http://bodrovis.tech). License type is [MIT](https://github.com/bodrovis/lokalise_manager/blob/master/LICENSE).

data/lib/lokalise_manager/global_config.rb

@@ -7,13 +7,19 @@ module LokaliseManager
       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

@@ -35,15 +35,16 @@ module LokaliseManager
       #
       # @return [Lokalise::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 = ::Lokalise.send(client_method, *client_opts)
       end
 
       # Resets API client
       def reset_api_client!
-        Lokalise.reset_client!
+        ::Lokalise.reset_client!
+        ::Lokalise.reset_oauth2_client!
         @api_client = nil
       end
 

data/lib/lokalise_manager/task_definitions/exporter.rb

@@ -5,6 +5,9 @@ require 'base64'
 module LokaliseManager
   module TaskDefinitions
     class Exporter < Base
+      # 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]
@@ -12,10 +15,13 @@ module LokaliseManager
         check_options_errors!
 
         queued_processes = []
-        each_file do |full_path, relative_path|
-          queued_processes << do_upload(full_path, relative_path)
-        rescue StandardError => e
-          raise e.class, "Error while trying to upload #{full_path}: #{e.message}"
+
+        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
+          end
         end
 
         $stdout.print('Task complete!') unless config.silent_mode
@@ -25,28 +31,43 @@ module LokaliseManager
 
       private
 
+      def parallel_upload(files_group)
+        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}") unless thread.success
+      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)
-        with_exp_backoff(config.max_retries_export) do
-          api_client.upload_file project_id_with_branch, opts(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
+          proc_klass.new success: true, process: process, path: f_path
+        rescue StandardError => e
+          proc_klass.new success: false, path: f_path, error: e
         end
       end
 
-      # Processes each translation file in the specified directory
-      def each_file
-        return unless block_given?
-
+      # Gets translation files from the specified directory
+      def all_files
         loc_path = config.locales_path
-        Dir["#{loc_path}/**/*"].sort.each do |f|
+        Dir["#{loc_path}/**/*"].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)
 
-          yield full_path, relative_path
-        end
+          [full_path, relative_path]
+        end.compact
       end
 
       # Generates export options

data/lib/lokalise_manager/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LokaliseManager
-  VERSION = '1.2.1'
+  VERSION = '2.2.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', '~> 4.0'
+  spec.add_dependency 'ruby-lokalise-api', '~> 5.0'
   spec.add_dependency 'rubyzip', '~> 2.3'
 
   spec.add_development_dependency 'codecov', '~> 0.2'
@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.6'
   spec.add_development_dependency 'rubocop', '~> 1.0'
   spec.add_development_dependency 'rubocop-performance', '~> 1.5'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.6.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.6'
   spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'vcr', '~> 6.0'
   spec.metadata = {

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

@@ -24,7 +24,7 @@ describe LokaliseManager::TaskDefinitions::Base do
   specify '.reset_client!' do
     expect(described_object.api_client).to be_an_instance_of(Lokalise::Client)
     described_object.reset_api_client!
-    current_client = described_object.instance_variable_get '@api_client'
+    current_client = described_object.instance_variable_get :@api_client
     expect(current_client).to be_nil
   end
 
@@ -63,14 +63,14 @@ 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 { described_object.send(:check_options_errors!) }.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 { described_object.send(:check_options_errors!) }.to raise_error(LokaliseManager::Error, /ID is not set/i)
       end
     end
   end
@@ -96,7 +96,7 @@ 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).not_to be_an_instance_of(Lokalise::OAuth2Client)
       expect(client.open_timeout).to eq(100)
       expect(client.timeout).to eq(500)
     end
@@ -106,7 +106,7 @@ describe LokaliseManager::TaskDefinitions::Base do
 
       client = described_object.api_client
 
-      expect(client).to be_an_instance_of(Lokalise::OAuthClient)
+      expect(client).to be_an_instance_of(Lokalise::OAuth2Client)
       expect(client).not_to be_an_instance_of(Lokalise::Client)
     end
   end

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

@@ -27,7 +27,7 @@ describe LokaliseManager::TaskDefinitions::Exporter do
         process = nil
 
         VCR.use_cassette('upload_files_multiple') do
-          expect(-> { process = described_object.export!.first }).to output(/complete!/).to_stdout
+          expect { process = described_object.export!.first.process }.to output(/complete!/).to_stdout
         end
 
         expect(process.project_id).to eq(project_id)
@@ -35,17 +35,40 @@ describe LokaliseManager::TaskDefinitions::Exporter do
       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)
 
-        expect(-> { described_object.export! }).to raise_error(Lokalise::Error::TooManyRequests, /Gave up after 2 retries/i)
+        expect { described_object.export! }.to raise_error(Lokalise::Error::TooManyRequests, /Gave up after 1 retries/i)
 
-        expect(described_object).to have_received(:sleep).exactly(2).times
-        expect(described_object).to have_received(:api_client).exactly(3).times
-        expect(fake_client).to have_received(:upload_file).exactly(3).times
+        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
+      end
+
+      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('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)
+        processes = []
+        expect { processes = described_object.export! }.not_to raise_error
+
+        expect(processes[0].success).to be false
+        expect(processes[1].error.class).to eq(Lokalise::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
   end
@@ -66,7 +89,7 @@ describe LokaliseManager::TaskDefinitions::Exporter do
         process = nil
 
         VCR.use_cassette('upload_files') do
-          expect(-> { process = described_object.export!.first }).not_to output(/complete!/).to_stdout
+          expect { process = described_object.export!.first.process }.not_to output(/complete!/).to_stdout
         end
 
         expect(process.status).to eq('queued')
@@ -76,7 +99,7 @@ describe LokaliseManager::TaskDefinitions::Exporter do
       it 'sends a proper API request' do
         process = VCR.use_cassette('upload_files') do
           described_object.export!
-        end.first
+        end.first.process
 
         expect(process.project_id).to eq(project_id)
         expect(process.status).to eq('queued')
@@ -85,11 +108,16 @@ describe LokaliseManager::TaskDefinitions::Exporter do
       it 'sends a proper API request when a different branch is provided' do
         allow(described_object.config).to receive(:branch).and_return('develop')
 
-        process = VCR.use_cassette('upload_files_branch') do
+        process_data = VCR.use_cassette('upload_files_branch') do
           described_object.export!
         end.first
 
         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')
+
+        process = process_data.process
+        expect(process).to be_an_instance_of(Lokalise::Resources::QueuedProcess)
         expect(process.project_id).to eq(project_id)
         expect(process.status).to eq('queued')
       end
@@ -97,20 +125,20 @@ describe LokaliseManager::TaskDefinitions::Exporter 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.export! }).to raise_error(LokaliseManager::Error, /API token is not set/i)
+        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)
+          expect { described_object.export! }.to raise_error(LokaliseManager::Error, /ID is not set/i)
         end
       end
     end
 
-    describe '.each_file' do
+    describe '#all_files' do
       it 'yield proper arguments' do
-        expect { |b| described_object.send(:each_file, &b) }.to yield_with_args(
+        expect(described_object.send(:all_files).flatten).to include(
           Pathname.new(path),
           Pathname.new(relative_name)
         )
@@ -180,30 +208,29 @@ describe LokaliseManager::TaskDefinitions::Exporter do
       end
     end
 
-    describe '.each_file' do
-      it 'yields every translation file' do
-        expect { |b| described_object.send(:each_file, &b) }.to yield_successive_args(
-          [
-            Pathname.new(path),
-            Pathname.new(relative_name)
-          ],
-          [
-            Pathname.new(path_ru),
-            Pathname.new(filename_ru)
-          ]
+    describe '#all_files' do
+      it 'returns all files' do
+        files = described_object.send(:all_files).flatten
+        expect(files).to include(
+          Pathname.new(path),
+          Pathname.new(relative_name)
+        )
+        expect(files).to include(
+          Pathname.new(path_ru),
+          Pathname.new(filename_ru)
         )
       end
 
-      it 'does not yield files that have to be skipped' do
+      it 'does not return files that have to be skipped' do
         allow(described_object.config).to receive(:skip_file_export).twice.and_return(
           ->(f) { f.split[1].to_s.include?('ru') }
         )
-        expect { |b| described_object.send(:each_file, &b) }.to yield_successive_args(
-          [
-            Pathname.new(path),
-            Pathname.new(relative_name)
-          ]
+        files = described_object.send(:all_files).sort
+        expect(files[0]).to include(
+          Pathname.new(path),
+          Pathname.new(relative_name)
         )
+        expect(files.count).to eq(1)
 
         expect(described_object.config).to have_received(:skip_file_export).twice
       end

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

@@ -9,21 +9,25 @@ describe LokaliseManager::TaskDefinitions::Importer do
   let(:loc_path) { described_object.config.locales_path }
   let(:project_id) { ENV['LOKALISE_PROJECT_ID'] }
   let(:local_trans) { "#{Dir.getwd}/spec/fixtures/trans.zip" }
-  let(:faulty_trans) { "#{Dir.getwd}/spec/fixtures/faulty_trans.zip" }
 
-  describe '.open_and_process_zip' do
+  describe '#open_and_process_zip' do
     it 're-raises errors during file processing' do
-      expect(-> { described_object.send(:open_and_process_zip, faulty_trans) }).
-        to raise_error(Psych::DisallowedClass, /Error when trying to process fail\.yml/)
+      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) }.
+        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
 
-  describe '.download_files' do
+  describe '#download_files' do
     it 'returns a proper download URL' do
       response = VCR.use_cassette('download_files') do
         described_object.send :download_files
@@ -31,14 +35,13 @@ 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 }).
+        expect { described_object.send :download_files }.
           to raise_error(Lokalise::Error::BadRequest, /Invalid `project_id` parameter/)
       end
     end
@@ -53,7 +56,7 @@ describe LokaliseManager::TaskDefinitions::Importer do
         allow(fake_client).to receive(:download_files).and_raise(Lokalise::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(Lokalise::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
@@ -62,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
@@ -106,14 +109,14 @@ 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
 
-        expect(count_translations).to eq(8)
-        expect_file_exist loc_path, 'en.yml'
-        expect_file_exist loc_path, 'ru.yml'
+        expect(count_translations).to eq(24)
+        expect_file_exist loc_path, 'en_1.yml'
+        expect_file_exist loc_path, 'ru_2.yml'
       end
 
       it 'runs import successfully but does not provide any output when silent_mode is enabled' do
@@ -121,12 +124,12 @@ 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
-        expect_file_exist loc_path, 'en.yml'
-        expect_file_exist loc_path, 'ru.yml'
+        expect_file_exist loc_path, 'en_1.yml'
+        expect_file_exist loc_path, 'ru_2.yml'
         expect(described_object.config).to have_received(:silent_mode).at_most(1).times
       end
     end
@@ -160,7 +163,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)
@@ -173,7 +176,7 @@ 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)
@@ -184,7 +187,7 @@ describe LokaliseManager::TaskDefinitions::Importer 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/vcr.rb

@@ -6,6 +6,8 @@ VCR.configure do |c|
   c.ignore_hosts 'codeclimate.com'
   c.hook_into :faraday
   c.cassette_library_dir = File.join(File.dirname(__FILE__), '..', 'fixtures', 'vcr_cassettes')
-  c.filter_sensitive_data('<LOKALISE_TOKEN>') { ENV.fetch('LOKALISE_API_TOKEN') }
+  c.filter_sensitive_data('<LOKALISE_TOKEN>') do |_i|
+    ENV.fetch('LOKALISE_API_TOKEN')
+  end
   c.configure_rspec_metadata!
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lokalise_manager
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-26 00:00:00.000000000 Z
+date: 2022-02-23 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: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -220,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.31
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Lokalise integration for Ruby