lokalise_manager 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6dbbda54dc255ed4ec13547b954213e41ab38c90d1520ffe3762d36dc2917f8
-  data.tar.gz: a341a91e4fea6ff76e0de87e5efa9660f5a0c5a7659656fbcfa14600fc4937d8
+  metadata.gz: 49d525043d80bf4643208f1de37d06bdd12826c04b01cbde07ae566e5ab1e056
+  data.tar.gz: a3f7ea97ae346b93220677342e771f2e916112572d4c54c779664c7a0651f2b3
 SHA512:
-  metadata.gz: 2f5f277f431596f70ee52f45186a972dcd507d1be08f6fc71bd04117556ca803efbe3e8b0d6a123ec6f81b959a5a1c99d9aa63a3189a4700a195fb823ca766e2
-  data.tar.gz: c64848ee98ee90cd77507bae719048ac425c60b7f16581b52de6ed6ab2301976487f6999027eab729244c4d3e8b27af1d5d6875c74d8b3d7cbd35112e0ededf1
+  metadata.gz: 59b08352f934330e07762d73066afadcb440478ef3548686b1ef32ab6ae3a0fb645a4da55cb7c75c02ff42d49ea73c82728f8247a6e78531de1154c40573f002
+  data.tar.gz: 98337218aa0519ab6d2982b38ce7582276301692c6cde59f5d2d75039a1951b1d8b7769584d6884ae3994286998299826cedadd8eba9ae3a5f65d87a1a9dabc9

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.2.0 (26-Oct-21)
+
+* Add a new option `:silent_mode` which is `false` by default. When silent mode is enabled, no debug info will be printed out to `$stdout`. The only exception are the "safe mode" messages — you'll still be prompted to continue if the target directory is not empty.
+* Use `#deep_merge` instead of a simple merge when processing options.
+
 ## 1.1.0 (25-Oct-21)
 
 * Add a new option `:use_oauth2_token` which is `false` by default. When enabled, you'll be able to provide a token obtained via [OAuth 2 flow](https://docs.lokalise.com/en/articles/5574713-oauth-2) rather than generated via Lokalise profile. The token should still be provided via the `:api_token` option:

data/README.md

@@ -15,6 +15,8 @@ If you are looking for a Rails integration, please check [lokalise_rails](https:
 
 This gem requires Ruby 2.5+. You will also need to [setup a Lokalise account](https://app.lokalise.com/signup) and create a [translation project](https://docs.lokalise.com/en/articles/1400460-projects). Finally, you will need to generate a [read/write API token](https://docs.lokalise.com/en/articles/1929556-api-tokens) at your Lokalise profile.
 
+Alternatively, you can utilize a token obtained via OAuth 2 flow. When using such a token, you'll have to set `:use_oauth2_token` option to `true` (see below).
+
 ### Installation
 
 Add the gem to your `Gemfile`:
@@ -92,6 +94,7 @@ Please don't forget that Lokalise API has rate limiting and you cannot send more
 * `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.
+* `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/ext/hash.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Taken from https://github.com/rails/rails/blob/83217025a171593547d1268651b446d3533e2019/activesupport/lib/active_support/core_ext/hash/deep_merge.rb
+
+class Hash
+  def deep_merge(other_hash, &block)
+    dup.deep_merge!(other_hash, &block)
+  end
+
+  # Same as +deep_merge+, but modifies +self+.
+  def deep_merge!(other_hash, &block)
+    merge!(other_hash) do |key, this_val, other_val|
+      if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+        this_val.deep_merge(other_val, &block)
+      elsif block
+        yield(key, this_val, other_val)
+      else
+        other_val
+      end
+    end
+  end
+end

data/lib/lokalise_manager/global_config.rb

@@ -7,13 +7,18 @@ 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
+                  :max_retries_export, :max_retries_import, :use_oauth2_token, :silent_mode
 
       # Main interface to provide configuration options
       def config
         yield self
       end
 
+      # When enabled, won't print any debugging info to $stdout
+      def silent_mode
+        @silent_mode || false
+      end
+
       # When enabled, will use OAuth 2 Lokalise client and will require to provide a token obtained via OAuth 2 flow
       # rather than via Lokalise profile
       def use_oauth2_token

data/lib/lokalise_manager/task_definitions/base.rb

@@ -23,7 +23,7 @@ module LokaliseManager
           opts[reader.to_sym] = global_config.send(reader)
         end
 
-        @config = OpenStruct.new primary_opts.merge(custom_opts)
+        @config = OpenStruct.new primary_opts.deep_merge(custom_opts)
       end
 
       # Creates a Lokalise API client

data/lib/lokalise_manager/task_definitions/exporter.rb

@@ -18,7 +18,7 @@ module LokaliseManager
           raise e.class, "Error while trying to upload #{full_path}: #{e.message}"
         end
 
-        $stdout.print 'Task complete!'
+        $stdout.print('Task complete!') unless config.silent_mode
 
         queued_processes
       end

data/lib/lokalise_manager/task_definitions/importer.rb

@@ -14,13 +14,13 @@ module LokaliseManager
         check_options_errors!
 
         unless proceed_when_safe_mode?
-          $stdout.print 'Task cancelled!'
+          $stdout.print('Task cancelled!') unless config.silent_mode
           return false
         end
 
         open_and_process_zip download_files['bundle_url']
 
-        $stdout.print 'Task complete!'
+        $stdout.print('Task complete!') unless config.silent_mode
         true
       end
 

data/lib/lokalise_manager/version.rb

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

data/lib/lokalise_manager.rb

@@ -2,6 +2,8 @@
 
 require 'yaml'
 
+require 'ext/hash'
+
 require 'lokalise_manager/version'
 require 'lokalise_manager/error'
 require 'lokalise_manager/global_config'

data/spec/lib/ext/hash_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+describe Hash do
+  let(:h1) { {a: 100, b: 200, c: {c1: 100}} }
+  let(:h2) { {b: 250, c: {c1: 200}} }
+
+  specify '#deep_merge' do
+    result = h1.deep_merge(h2) { |_key, this_val, other_val| this_val + other_val }
+    expect(result[:b]).to eq(450)
+    expect(result[:c][:c1]).to eq(300)
+  end
+end

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 silent_mode' do
+    allow(fake_class).to receive(:silent_mode=).with(true)
+    fake_class.silent_mode = true
+  end
+
   it 'is possible to set use_oauth2_token' do
     allow(fake_class).to receive(:use_oauth2_token=).with(true)
     fake_class.use_oauth2_token = true

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

@@ -19,6 +19,11 @@ describe LokaliseManager::TaskDefinitions::Base do
       expect(obj.config.project_id).to eq('345')
       expect(obj.config.token).to eq('fake')
     end
+
+    it 'tes' do
+      obj = described_class.new import_opts: {filter_langs: ['fr']}
+      puts obj.config
+    end
   end
 
   specify '.reset_client!' do

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

@@ -24,9 +24,11 @@ describe LokaliseManager::TaskDefinitions::Exporter do
 
     describe '.export!' do
       it 'sends a proper API request and handles rate limiting' do
-        process = VCR.use_cassette('upload_files_multiple') do
-          described_object.export!
-        end.first
+        process = nil
+
+        VCR.use_cassette('upload_files_multiple') do
+          expect(-> { process = described_object.export!.first }).to output(/complete!/).to_stdout
+        end
 
         expect(process.project_id).to eq(project_id)
         expect(process.status).to eq('queued')
@@ -58,6 +60,19 @@ describe LokaliseManager::TaskDefinitions::Exporter do
     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)
+
+        process = nil
+
+        VCR.use_cassette('upload_files') do
+          expect(-> { process = described_object.export!.first }).not_to output(/complete!/).to_stdout
+        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' do
         process = VCR.use_cassette('upload_files') do
           described_object.export!

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

@@ -103,8 +103,10 @@ describe LokaliseManager::TaskDefinitions::Importer do
       end
 
       it 'runs import successfully' do
-        result = VCR.use_cassette('import') do
-          described_object.import!
+        result = nil
+
+        VCR.use_cassette('import') do
+          expect(-> { result = described_object.import! }).to output(/complete!/).to_stdout
         end
 
         expect(result).to be true
@@ -113,6 +115,20 @@ describe LokaliseManager::TaskDefinitions::Importer do
         expect_file_exist loc_path, 'en.yml'
         expect_file_exist loc_path, 'ru.yml'
       end
+
+      it 'runs import successfully but does not provide any output when silent_mode is enabled' do
+        allow(described_object.config).to receive(:silent_mode).and_return(true)
+        result = nil
+
+        VCR.use_cassette('import') do
+          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(described_object.config).to have_received(:silent_mode).at_most(1).times
+      end
     end
 
     context 'when directory is not empty and safe mode enabled' do
@@ -157,9 +173,21 @@ 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(/is not empty/).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
+        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).not_to have_received(:download_files)
+        expect(safe_mode_obj.config).to have_received(:silent_mode)
         expect($stdin).to have_received(:gets)
         expect(count_translations).to eq(1)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lokalise_manager
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-25 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lokalise-api
@@ -181,6 +181,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/ext/hash.rb
 - lib/lokalise_manager.rb
 - lib/lokalise_manager/error.rb
 - lib/lokalise_manager/global_config.rb
@@ -189,6 +190,7 @@ files:
 - lib/lokalise_manager/task_definitions/importer.rb
 - lib/lokalise_manager/version.rb
 - lokalise_manager.gemspec
+- spec/lib/ext/hash_spec.rb
 - spec/lib/lokalise_manager/global_config_spec.rb
 - spec/lib/lokalise_manager/task_definitions/base_spec.rb
 - spec/lib/lokalise_manager/task_definitions/exporter_spec.rb
@@ -217,11 +219,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.2.29
 signing_key:
 specification_version: 4
 summary: Lokalise integration for Ruby
 test_files:
+- spec/lib/ext/hash_spec.rb
 - spec/lib/lokalise_manager/global_config_spec.rb
 - spec/lib/lokalise_manager/task_definitions/base_spec.rb
 - spec/lib/lokalise_manager/task_definitions/exporter_spec.rb