lokalise_rails 2.0.0 → 3.0.0

data/spec/lib/lokalise_rails_spec.rb

@@ -4,102 +4,4 @@ describe LokaliseRails do
   it 'returns a proper version' do
     expect(LokaliseRails::VERSION).to be_a(String)
   end
-
-  it 'is possible to provide config options' do
-    described_class.config do |c|
-      expect(c).to eq(described_class)
-    end
-  end
-
-  describe 'parameters' do
-    let(:fake_class) { class_double('LokaliseRails') }
-
-    it 'is possible to set project_id' do
-      allow(fake_class).to receive(:project_id=).with('123.abc')
-      fake_class.project_id = '123.abc'
-    end
-
-    it 'is possible to set file_ext_regexp' do
-      allow(fake_class).to receive(:file_ext_regexp=).with(Regexp.new('.*'))
-      fake_class.file_ext_regexp = Regexp.new('.*')
-    end
-
-    it 'is possible to set import_opts' do
-      allow(fake_class).to receive(:import_opts=).with(duck_type(:each))
-      fake_class.import_opts = {
-        format: 'json',
-        indentation: '8sp'
-      }
-    end
-
-    it 'is possible to set export_opts' do
-      allow(fake_class).to receive(:export_opts=).with(duck_type(:each))
-      fake_class.export_opts = {
-        convert_placeholders: true,
-        detect_icu_plurals: true
-      }
-    end
-
-    it 'is possible to set branch' do
-      allow(fake_class).to receive(:branch=).with('custom')
-      fake_class.branch = 'custom'
-    end
-
-    it 'is possible to set timeouts' do
-      allow(fake_class).to receive(:timeouts=).with(duck_type(:each))
-      fake_class.timeouts = {
-        open_timeout: 100,
-        timeout: 500
-      }
-    end
-
-    it 'is possible to set import_safe_mode' do
-      allow(fake_class).to receive(:import_safe_mode=).with(true)
-      fake_class.import_safe_mode = true
-    end
-
-    it 'is possible to set max_retries_export' do
-      allow(fake_class).to receive(:max_retries_export=).with(10)
-      fake_class.max_retries_export = 10
-    end
-
-    it 'is possible to set max_retries_import' do
-      allow(fake_class).to receive(:max_retries_import=).with(10)
-      fake_class.max_retries_import = 10
-    end
-
-    it 'is possible to set api_token' do
-      allow(fake_class).to receive(:api_token=).with('abc')
-      fake_class.api_token = 'abc'
-    end
-
-    it 'is possible to override locales_path' do
-      allow(fake_class).to receive(:locales_path=).with('/demo/path')
-      fake_class.locales_path = '/demo/path'
-    end
-
-    it 'is possible to set skip_file_export' do
-      cond = ->(f) { f.nil? }
-      allow(fake_class).to receive(:skip_file_export=).with(cond)
-      fake_class.skip_file_export = cond
-    end
-
-    it 'is possible to set translations_loader' do
-      runner = ->(f) { f.to_json }
-      allow(fake_class).to receive(:translations_loader=).with(runner)
-      fake_class.translations_loader = runner
-    end
-
-    it 'is possible to set translations_converter' do
-      runner = ->(f) { f.to_json }
-      allow(fake_class).to receive(:translations_converter=).with(runner)
-      fake_class.translations_converter = runner
-    end
-
-    it 'is possible to set lang_iso_inferer' do
-      runner = ->(f) { f.to_json }
-      allow(fake_class).to receive(:lang_iso_inferer=).with(runner)
-      fake_class.lang_iso_inferer = runner
-    end
-  end
 end

data/spec/lib/tasks/export_task_spec.rb

@@ -1,27 +1,26 @@
 # frozen_string_literal: true
 
-RSpec.describe LokaliseRails do
+RSpec.describe 'Export Rake task' do
+  let(:global_config) { LokaliseRails::GlobalConfig }
+
   it 'halts when the API key is not set' do
-    allow(described_class).to receive(:api_token).and_return(nil)
+    allow(global_config).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)
+    expect(global_config).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
+    allow(global_config).to receive(:project_id).and_return(nil)
+
+    expect(export_executor).to raise_error(SystemExit, /ID is not set/i)
 
-  it 'runs export rake task properly' do
-    expect(export_executor).to output(/complete!/).to_stdout
+    expect(global_config).to have_received(:project_id)
   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
@@ -31,12 +30,20 @@ RSpec.describe LokaliseRails do
       rm_translation_files
     end
 
-    describe '.export!' do
-      it 're-raises export errors' do
-        allow_project_id
+    describe 'export' do
+      it 'is callable' do
+        allow_project_id global_config, ENV['LOKALISE_PROJECT_ID'] do
+          VCR.use_cassette('upload_files') do
+            expect(export_executor).to output(/complete!/).to_stdout
+          end
+        end
+      end
 
-        VCR.use_cassette('upload_files_error') do
-          expect(export_executor).to raise_error(SystemExit, /Unknown `lang_iso`/)
+      it 're-raises export errors' do
+        allow_project_id global_config, '542886116159f798720dc4.94769464' do
+          VCR.use_cassette('upload_files_error') do
+            expect(export_executor).to raise_error(SystemExit, /Unknown `lang_iso`/)
+          end
         end
       end
     end

data/spec/lib/tasks/import_task_spec.rb

@@ -2,120 +2,57 @@
 
 require 'fileutils'
 
-RSpec.describe LokaliseRails do
-  let(:loc_path) { described_class.locales_path }
-  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' }
+RSpec.describe 'Import Rake task' do
+  let(:global_config) { LokaliseRails::GlobalConfig }
+  let(:loc_path) { global_config.locales_path }
 
   it 'halts when the API key is not set' do
-    allow(described_class).to receive(:api_token).and_return(nil)
+    allow(global_config).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)
+    expect(global_config).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
-      rm_translation_files
-    end
-
-    after :all do
-      rm_translation_files
-    end
-
-    it 'import rake task is callable' do
-      allow(LokaliseRails::TaskDefinition::Importer).to receive(
-        :download_files
-      ).and_return(
-        {
-          'project_id' => '123.abc',
-          'bundle_url' => local_trans
-        }
-      )
-
-      expect(import_executor).to output(/complete!/).to_stdout
+    allow(global_config).to receive(:project_id).and_return(nil)
 
-      expect(count_translations).to eq(4)
-      expect(LokaliseRails::TaskDefinition::Importer).to have_received(:download_files)
-      expect_file_exist loc_path, 'en/nested/main_en.yml'
-      expect_file_exist loc_path, 'en/nested/deep/secondary_en.yml'
-      expect_file_exist loc_path, 'ru/main_ru.yml'
-    end
-
-    it 'import rake task downloads ZIP archive properly' do
-      allow(LokaliseRails::TaskDefinition::Importer).to receive(
-        :download_files
-      ).and_return(
-        {
-          'project_id' => '123.abc',
-          'bundle_url' => remote_trans
-        }
-      )
+    expect(import_executor).to raise_error(SystemExit, /ID is not set/i)
 
-      expect(import_executor).to output(/complete!/).to_stdout
-
-      expect(LokaliseRails::TaskDefinition::Importer).to have_received(:download_files)
-      expect(count_translations).to eq(4)
-      expect_file_exist loc_path, 'en/nested/main_en.yml'
-      expect_file_exist loc_path, 'en/nested/deep/secondary_en.yml'
-      expect_file_exist loc_path, 'ru/main_ru.yml'
-    end
+    expect(global_config).to have_received(:project_id)
   end
 
-  context 'when directory is not empty and safe mode enabled' do
-    before :all do
-      mkdir_locales
-      described_class.import_safe_mode = true
-    end
-
+  context 'when directory is empty' do
     before do
+      mkdir_locales
       rm_translation_files
-      add_translation_files!
     end
 
     after :all do
       rm_translation_files
-      described_class.import_safe_mode = false
     end
 
-    it 'import proceeds when the user agrees' do
-      allow(LokaliseRails::TaskDefinition::Importer).to receive(
-        :download_files
-      ).and_return(
-        {
-          'project_id' => '123.abc',
-          'bundle_url' => local_trans
-        }
-      )
-
-      allow($stdin).to receive(:gets).and_return('Y')
-      expect(import_executor).to output(/is not empty/).to_stdout
-
-      expect(count_translations).to eq(5)
-      expect($stdin).to have_received(:gets)
-      expect(LokaliseRails::TaskDefinition::Importer).to have_received(:download_files)
-      expect_file_exist loc_path, 'en/nested/main_en.yml'
-      expect_file_exist loc_path, 'en/nested/deep/secondary_en.yml'
-      expect_file_exist loc_path, 'ru/main_ru.yml'
-    end
-
-    it 'import halts when a user chooses not to proceed' do
-      allow(LokaliseRails::TaskDefinition::Importer).to receive(
-        :download_files
-      ).at_most(0).times
-      allow($stdin).to receive(:gets).and_return('N')
-      expect(import_executor).to output(/is not empty/).to_stdout
-
-      expect(LokaliseRails::TaskDefinition::Importer).not_to have_received(:download_files)
-      expect($stdin).to have_received(:gets)
-      expect(count_translations).to eq(1)
+    describe 'import' do
+      it 'is callable' do
+        allow_project_id global_config, ENV['LOKALISE_PROJECT_ID'] do
+          VCR.use_cassette('download_files') do
+            expect(import_executor).to output(/complete!/).to_stdout
+          end
+
+          expect(count_translations).to eq(4)
+
+          expect_file_exist loc_path, 'en.yml'
+          expect_file_exist loc_path, 'ru.yml'
+          expect_file_exist loc_path, 'yo.yml'
+        end
+      end
+
+      it 're-raises export errors' do
+        allow_project_id global_config, 'fake' do
+          VCR.use_cassette('download_files_error') do
+            expect(import_executor).to raise_error(SystemExit, /Invalid `project_id` parameter/)
+          end
+        end
+      end
     end
   end
 end

data/spec/lib/utils_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+describe LokaliseRails::Utils do
+  describe '.rails_root' do
+    it 'returns RAILS_ROOT if defined' do
+      allow(::Rails).to receive(:root).and_return(nil)
+      stub_const('RAILS_ROOT', '/stub')
+      expect(described_class.rails_root).to eq('/stub')
+    end
+
+    it 'fallbacks if neither roots are present' do
+      allow(::Rails).to receive(:root).and_return(nil)
+      expect(described_class.rails_root).to be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -7,7 +7,6 @@ SimpleCov.start 'rails' do
   add_filter 'spec/'
   add_filter '.github/'
   add_filter 'lib/generators/templates/'
-  add_filter 'lib/lokalise_rails/version'
 end
 
 if ENV['CI'] == 'true'

data/spec/support/file_manager.rb

@@ -3,13 +3,8 @@
 require 'fileutils'
 
 module FileManager
-  def expect_file_exist(path, file)
-    file_path = File.join path, file
-    expect(File.file?(file_path)).to be true
-  end
-
   def mkdir_locales
-    FileUtils.mkdir_p(LokaliseRails.locales_path) unless File.directory?(LokaliseRails.locales_path)
+    FileUtils.mkdir_p(LokaliseRails::GlobalConfig.locales_path) unless File.directory?(LokaliseRails::GlobalConfig.locales_path)
   end
 
   def rm_translation_files
@@ -17,7 +12,7 @@ module FileManager
   end
 
   def locales_dir
-    Dir["#{LokaliseRails.locales_path}/**/*"]
+    Dir["#{LokaliseRails::GlobalConfig.locales_path}/**/*"]
   end
 
   def count_translations
@@ -41,15 +36,15 @@ module FileManager
     end
   end
 
-  def add_config!
+  def add_config!(custom_text = '')
     data = <<~DATA
-      require 'lokalise_rails'
-      LokaliseRails.config do |c|
+      LokaliseRails::GlobalConfig.config do |c|
         c.api_token = ENV['LOKALISE_API_TOKEN']
         c.project_id = ENV['LOKALISE_PROJECT_ID']
-      end
     DATA
 
+    data += custom_text
+    data += "\nend"
     open_and_write('config/lokalise_rails.rb') { |f| f.write data }
   end
 

data/spec/support/spec_addons.rb

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
 module SpecAddons
-  def allow_project_id(value = '189934715f57a162257d74.88352370')
-    allow(LokaliseRails).to receive(:project_id).and_return(value)
+  def expect_file_exist(path, file)
+    file_path = File.join path, file
+    expect(File.file?(file_path)).to be true
+  end
+
+  def allow_project_id(obj, value)
+    allow(obj).to receive(:project_id).and_return(value)
     return unless block_given?
 
     yield
-    expect(LokaliseRails).to have_received(:project_id)
+    expect(obj).to have_received(:project_id)
   end
 end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: lokalise_rails
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
+date: 2021-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ruby-lokalise-api
+  name: lokalise_manager
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: rubyzip
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 6.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 6.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -198,11 +184,9 @@ 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/global_config.rb
 - lib/lokalise_rails/railtie.rb
-- lib/lokalise_rails/task_definition/base.rb
-- lib/lokalise_rails/task_definition/exporter.rb
-- lib/lokalise_rails/task_definition/importer.rb
+- lib/lokalise_rails/utils.rb
 - lib/lokalise_rails/version.rb
 - lib/tasks/lokalise_rails_tasks.rake
 - lokalise_rails.gemspec
@@ -229,12 +213,11 @@ files:
 - spec/dummy/config/routes.rb
 - spec/dummy/db/seeds.rb
 - spec/lib/generators/lokalise_rails/install_generator_spec.rb
-- spec/lib/lokalise_rails/task_definition/base_spec.rb
-- spec/lib/lokalise_rails/task_definition/exporter_spec.rb
-- spec/lib/lokalise_rails/task_definition/importer_spec.rb
+- spec/lib/lokalise_rails/global_config_spec.rb
 - spec/lib/lokalise_rails_spec.rb
 - spec/lib/tasks/export_task_spec.rb
 - spec/lib/tasks/import_task_spec.rb
+- spec/lib/utils_spec.rb
 - spec/spec_helper.rb
 - spec/support/file_manager.rb
 - spec/support/rake_utils.rb
@@ -259,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.25
+rubygems_version: 3.2.26
 signing_key:
 specification_version: 4
 summary: Lokalise integration for Ruby on Rails
@@ -287,12 +270,11 @@ test_files:
 - spec/dummy/config/routes.rb
 - spec/dummy/db/seeds.rb
 - spec/lib/generators/lokalise_rails/install_generator_spec.rb
-- spec/lib/lokalise_rails/task_definition/base_spec.rb
-- spec/lib/lokalise_rails/task_definition/exporter_spec.rb
-- spec/lib/lokalise_rails/task_definition/importer_spec.rb
+- spec/lib/lokalise_rails/global_config_spec.rb
 - spec/lib/lokalise_rails_spec.rb
 - spec/lib/tasks/export_task_spec.rb
 - spec/lib/tasks/import_task_spec.rb
+- spec/lib/utils_spec.rb
 - spec/spec_helper.rb
 - spec/support/file_manager.rb
 - spec/support/rake_utils.rb

data/lib/lokalise_rails/error.rb

@@ -1,10 +0,0 @@
-# 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

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-require 'ruby-lokalise-api'
-require 'pathname'
-
-module LokaliseRails
-  module TaskDefinition
-    class Base
-      class << self
-        attr_writer :api_client
-
-        # Creates a Lokalise API client
-        #
-        # @return [Lokalise::Client]
-        def api_client
-          @api_client ||= ::Lokalise.client LokaliseRails.api_token, {enable_compression: true}.merge(LokaliseRails.timeouts)
-        end
-
-        # Resets API client
-        def reset_api_client!
-          Lokalise.reset_client!
-          @api_client = nil
-        end
-
-        # Checks task options
-        #
-        # @return Array
-        def check_options_errors!
-          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
-
-        # Checks whether the provided file has a proper extension as dictated by the `file_ext_regexp` option
-        #
-        # @return Boolean
-        # @param raw_path [String, Pathname]
-        def proper_ext?(raw_path)
-          path = raw_path.is_a?(Pathname) ? raw_path : Pathname.new(raw_path)
-          LokaliseRails.file_ext_regexp.match? path.extname
-        end
-
-        # Returns directory and filename for the given entry
-        #
-        # @return Array
-        # @param entry [String]
-        def subdir_and_filename_for(entry)
-          Pathname.new(entry).split
-        end
-
-        # Returns Lokalise project ID and branch, semicolumn separated
-        #
-        # @return [String]
-        def project_id_with_branch
-          "#{LokaliseRails.project_id}:#{LokaliseRails.branch}"
-        end
-
-        # Sends request with exponential backoff mechanism
-        def with_exp_backoff(max_retries)
-          return unless block_given?
-
-          retries = 0
-          begin
-            yield
-          rescue Lokalise::Error::TooManyRequests => e
-            raise(e.class, "Gave up after #{retries} retries") if retries >= max_retries
-
-            sleep 2**retries
-            retries += 1
-            retry
-          end
-        end
-      end
-    end
-  end
-end