lokalise_rails 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e85d26a390d153b8deabe38694c1b7313fca351232066d58918828388dcc7fc
-  data.tar.gz: 0ee837ad7426ed5570badcec88245de2f4d35ea27b3c821f3facb5922083b2b2
+  metadata.gz: 6448a3718185d09a6712428f671e02121e59c967199ae6e24f27b8623f12b280
+  data.tar.gz: c0f2501d9c937b26088ee23a6603a842121cb6a88516ae19d09d40abe1968161
 SHA512:
-  metadata.gz: 4af0fd091968510911787fcdc7bd7ffdefada590fb48c4137106de5d3d34296890a868b65debbf2262fc0d82901eb77a35407e3d6a7c5f958babbb2b548b14cd
-  data.tar.gz: ff6948bb092ab43e837b54de2d593d8e5db319ac872390aa335cb67802d198f11a30d58993d3d5e561a1f3ad823fe52ac7f55b1bcbe3de9a2ba09dfb0d41d99f
+  metadata.gz: be178f379eb4abbb4d50c4f3817422c665bed0c8a75f256c083b0229a57594956ca8c42648fe98be40ed1c4183f0e00fd51fcaf153a87ed408279c1d2ac152ec
+  data.tar.gz: db7dd0efdb0d9a7b72116adba959a04b899e41d5ccd89181f48e2ec2e1d097ebfebb732e6592c725b831cebf89134e77e0639deb8591876267306583064efa96

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.4.0 (29-Jun-21)
+
+* Re-worked exception handling. Now when something goes wrong during the import or export process, this gem will re-raise all such errors (previously it just printed out some errors to the `$stdout`). If you run a Rake task, it will exit with a status code `1` and the actual error message. If you run a task programattically, you'll get an exception.
+* Dropped support for Ruby 2.5
+* Test against Ruby 3
+
 ## 1.3.1 (01-Apr-21)
 
 * A bit better exception handling

data/README.md

@@ -3,6 +3,7 @@
 ![Gem](https://img.shields.io/gem/v/lokalise_rails)
 [![Build Status](https://travis-ci.com/bodrovis/lokalise_rails.svg?branch=master)](https://travis-ci.com/github/bodrovis/lokalise_rails)
 [![Test Coverage](https://codecov.io/gh/bodrovis/lokalise_rails/graph/badge.svg)](https://codecov.io/gh/bodrovis/lokalise_rails)
+![Downloads total](https://img.shields.io/gem/dt/lokalise_rails)
 
 This gem provides [Lokalise](http://lokalise.com) integration for Ruby on Rails and allows to exchange translation files easily. It relies on [ruby-lokalise-api](https://lokalise.github.io/ruby-lokalise-api) to send APIv2 requests.
 

data/lib/lokalise_rails.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'lokalise_rails/error'
 require 'lokalise_rails/task_definition/base'
 require 'lokalise_rails/task_definition/importer'
 require 'lokalise_rails/task_definition/exporter'

data/lib/lokalise_rails/error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module LokaliseRails
+  class Error < StandardError
+    # Initializes a new Error object
+    def initialize(message = '')
+      super(message)
+    end
+  end
+end

data/lib/lokalise_rails/task_definition/base.rb

@@ -25,11 +25,12 @@ module LokaliseRails
         # Checks task options
         #
         # @return Array
-        def opt_errors
+        def check_options_errors!
           errors = []
-          errors << 'Project ID is not set! Aborting...' if LokaliseRails.project_id.nil? || LokaliseRails.project_id.empty?
-          errors << 'Lokalise API token is not set! Aborting...' if LokaliseRails.api_token.nil? || LokaliseRails.api_token.empty?
-          errors
+          errors << 'Project ID is not set!' if LokaliseRails.project_id.nil? || LokaliseRails.project_id.empty?
+          errors << 'Lokalise API token is not set!' if LokaliseRails.api_token.nil? || LokaliseRails.api_token.empty?
+
+          raise(LokaliseRails::Error, errors.join(' ')) if errors.any?
         end
 
         private

data/lib/lokalise_rails/task_definition/exporter.rb

@@ -10,12 +10,7 @@ module LokaliseRails
         #
         # @return [Array]
         def export!
-          errors = opt_errors
-
-          if errors.any?
-            errors.each { |e| $stdout.puts e }
-            return errors
-          end
+          check_options_errors!
 
           queued_processes = []
           each_file do |full_path, relative_path|
@@ -23,7 +18,7 @@ module LokaliseRails
               project_id_with_branch, opts(full_path, relative_path)
             )
           rescue StandardError => e
-            $stdout.puts "Error while trying to upload #{full_path}: #{e.inspect}"
+            raise e.class, "Error while trying to upload #{full_path}: #{e.message}"
           end
 
           $stdout.print 'Task complete!'

data/lib/lokalise_rails/task_definition/importer.rb

@@ -13,12 +13,7 @@ module LokaliseRails
         #
         # @return [Boolean]
         def import!
-          errors = opt_errors
-
-          if errors.any?
-            errors.each { |e| $stdout.puts e }
-            return false
-          end
+          check_options_errors!
 
           unless proceed_when_safe_mode?
             $stdout.print 'Task cancelled!'
@@ -39,7 +34,7 @@ module LokaliseRails
 
           api_client.download_files project_id_with_branch, opts
         rescue StandardError => e
-          $stdout.puts "There was an error when trying to download files: #{e.inspect}"
+          raise e.class, "There was an error when trying to download files: #{e.message}"
         end
 
         # Opens ZIP archive (local or remote) with translations and processes its entries
@@ -50,7 +45,7 @@ module LokaliseRails
             fetch_zip_entries(zip) { |entry| process!(entry) }
           end
         rescue StandardError => e
-          $stdout.puts "There was an error when trying to process the downloaded files: #{e.inspect}"
+          raise e.class, "There was an error when trying to process the downloaded files: #{e.message}"
         end
 
         # Iterates over ZIP entries. Each entry may be a file or folder.
@@ -75,7 +70,7 @@ module LokaliseRails
             f.write LokaliseRails.translations_converter.call(data)
           end
         rescue StandardError => e
-          $stdout.puts "Error when trying to process #{zip_entry&.name}: #{e.inspect}"
+          raise e.class, "Error when trying to process #{zip_entry&.name}: #{e.message}"
         end
 
         # Checks whether the user wishes to proceed when safe mode is enabled and the target directory is not empty

data/lib/lokalise_rails/version.rb

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

data/lib/tasks/lokalise_rails_tasks.rake

@@ -6,9 +6,13 @@ require "#{Rails.root}/config/lokalise_rails"
 namespace :lokalise_rails do
   task :import do
     LokaliseRails::TaskDefinition::Importer.import!
+  rescue StandardError => e
+    abort e.inspect
   end
 
   task :export do
     LokaliseRails::TaskDefinition::Exporter.export!
+  rescue StandardError => e
+    abort e.inspect
   end
 end

data/lokalise_rails.gemspec

@@ -37,7 +37,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.2.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.4.0'
   spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'vcr', '~> 6.0'
 end

data/spec/lib/lokalise_rails/task_definition/base_spec.rb

@@ -34,22 +34,18 @@ describe LokaliseRails::TaskDefinition::Base do
     end
   end
 
-  describe '.opt_errors' do
-    it 'returns an error when the API key is not set' do
+  describe '.check_options_errors!' do
+    it 'raises an error when the API key is not set' do
       allow(LokaliseRails).to receive(:api_token).and_return(nil)
-      errors = described_class.opt_errors
+
+      expect(-> { described_class.check_options_errors! }).to raise_error(LokaliseRails::Error, /API token is not set/i)
 
       expect(LokaliseRails).to have_received(:api_token)
-      expect(errors.length).to eq(1)
-      expect(errors.first).to include('API token is not set')
     end
 
     it 'returns an error when the project_id is not set' do
       allow_project_id nil do
-        errors = described_class.opt_errors
-
-        expect(errors.length).to eq(1)
-        expect(errors.first).to include('Project ID is not set')
+        expect(-> { described_class.check_options_errors! }).to raise_error(LokaliseRails::Error, /ID is not set/i)
       end
     end
   end

data/spec/lib/lokalise_rails/task_definition/exporter_spec.rb

@@ -44,13 +44,13 @@ describe LokaliseRails::TaskDefinition::Exporter do
       it 'halts when the API key is not set' do
         allow(LokaliseRails).to receive(:api_token).and_return(nil)
 
-        expect(-> { described_class.export! }).to output(/API token is not set/).to_stdout
+        expect(-> { described_class.export! }).to raise_error(LokaliseRails::Error, /API token is not set/i)
         expect(LokaliseRails).to have_received(:api_token)
       end
 
       it 'halts when the project_id is not set' do
         allow_project_id nil do
-          expect(-> { described_class.export! }).to output(/Project ID is not set/).to_stdout
+          expect(-> { described_class.export! }).to raise_error(LokaliseRails::Error, /ID is not set/i)
         end
       end
     end
@@ -107,17 +107,12 @@ describe LokaliseRails::TaskDefinition::Exporter do
     end
 
     describe '.export!' do
-      it 'rescues from export errors' do
+      it 're-raises export errors' do
         allow_project_id
 
-        processes = VCR.use_cassette('upload_files_error') do
-          described_class.export!
+        VCR.use_cassette('upload_files_error') do
+          expect { described_class.export! }.to raise_error(Lokalise::Error::BadRequest, /Unknown `lang_iso`/)
         end
-
-        expect(processes.length).to eq(1)
-        process = processes.first
-        expect(process.project_id).to eq(LokaliseRails.project_id)
-        expect(process.status).to eq('queued')
       end
     end
 

data/spec/lib/lokalise_rails/task_definition/importer_spec.rb

@@ -4,14 +4,14 @@ describe LokaliseRails::TaskDefinition::Importer do
   describe '.open_and_process_zip' do
     let(:faulty_trans) { "#{Rails.root}/public/faulty_trans.zip" }
 
-    it 'rescues from errors during file processing' do
+    it 're-raises errors during file processing' do
       expect(-> { described_class.open_and_process_zip(faulty_trans) }).
-        to output(/Psych::DisallowedClass/).to_stdout
+        to raise_error(Psych::DisallowedClass, /Error when trying to process fail\.yml/)
     end
 
-    it 'rescues from errors during file opening' do
+    it 're-raises errors during file opening' do
       expect(-> { described_class.open_and_process_zip('http://fake.url/wrong/path.zip') }).
-        to output(/SocketError/).to_stdout
+        to raise_error(SocketError, /Failed to open TCP connection/)
     end
   end
 
@@ -27,11 +27,11 @@ describe LokaliseRails::TaskDefinition::Importer do
       end
     end
 
-    it 'rescues from errors during file download' do
+    it 're-raises errors during file download' do
       allow_project_id 'invalid'
       VCR.use_cassette('download_files_error') do
         expect(-> { described_class.download_files }).
-          to output(/Lokalise::Error::BadRequest/).to_stdout
+          to raise_error(Lokalise::Error::BadRequest, /Invalid `project_id` parameter/)
       end
     end
   end
@@ -39,14 +39,14 @@ describe LokaliseRails::TaskDefinition::Importer do
   describe '.import!' do
     it 'halts when the API key is not set' do
       allow(LokaliseRails).to receive(:api_token).and_return(nil)
-      expect(-> { described_class.import! }).to output(/API token is not set/).to_stdout
+      expect(-> { described_class.import! }).to raise_error(LokaliseRails::Error, /API token is not set/i)
       expect(LokaliseRails).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 nil do
-        expect(-> { described_class.import! }).to output(/Project ID is not set/).to_stdout
+        expect(-> { described_class.import! }).to raise_error(LokaliseRails::Error, /ID is not set/i)
         expect(count_translations).to eq(0)
       end
     end

data/spec/lib/tasks/export_task_spec.rb

@@ -1,7 +1,44 @@
 # frozen_string_literal: true
 
 RSpec.describe LokaliseRails do
+  it 'halts when the API key is not set' do
+    allow(described_class).to receive(:api_token).and_return(nil)
+
+    expect(export_executor).to raise_error(SystemExit, /API token is not set/i)
+    expect(described_class).to have_received(:api_token)
+  end
+
+  it 'halts when the project ID is not set' do
+    allow_project_id nil do
+      expect(export_executor).to raise_error(SystemExit, /ID is not set/i)
+    end
+  end
+
   it 'runs export rake task properly' do
     expect(export_executor).to output(/complete!/).to_stdout
   end
+
+  context 'with two translation files' do
+    let(:filename_ru) { 'ru.yml' }
+    let(:path_ru) { "#{Rails.root}/config/locales/#{filename_ru}" }
+    let(:relative_name_ru) { filename_ru }
+
+    before :all do
+      add_translation_files! with_ru: true
+    end
+
+    after :all do
+      rm_translation_files
+    end
+
+    describe '.export!' do
+      it 're-raises export errors' do
+        allow_project_id
+
+        VCR.use_cassette('upload_files_error') do
+          expect(export_executor).to raise_error(SystemExit, /Unknown `lang_iso`/)
+        end
+      end
+    end
+  end
 end

data/spec/lib/tasks/import_task_spec.rb

@@ -7,6 +7,19 @@ RSpec.describe LokaliseRails do
   let(:local_trans) { "#{Rails.root}/public/trans.zip" }
   let(:remote_trans) { 'https://github.com/bodrovis/lokalise_rails/blob/master/spec/dummy/public/trans.zip?raw=true' }
 
+  it 'halts when the API key is not set' do
+    allow(described_class).to receive(:api_token).and_return(nil)
+
+    expect(import_executor).to raise_error(SystemExit, /API token is not set/i)
+    expect(described_class).to have_received(:api_token)
+  end
+
+  it 'halts when the project ID is not set' do
+    allow_project_id nil do
+      expect(import_executor).to raise_error(SystemExit, /ID is not set/i)
+    end
+  end
+
   context 'when directory is empty' do
     before do
       mkdir_locales

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lokalise_rails
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2021-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lokalise-api
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -198,6 +198,7 @@ files:
 - lib/generators/lokalise_rails/install_generator.rb
 - lib/generators/templates/lokalise_rails_config.rb
 - lib/lokalise_rails.rb
+- lib/lokalise_rails/error.rb
 - lib/lokalise_rails/railtie.rb
 - lib/lokalise_rails/task_definition/base.rb
 - lib/lokalise_rails/task_definition/exporter.rb
@@ -258,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.11
+rubygems_version: 3.2.24
 signing_key:
 specification_version: 4
 summary: Lokalise integration for Ruby on Rails