lokalise_rails 0.2.0 → 1.3.0

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+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
+      expect(-> { described_class.open_and_process_zip(faulty_trans) }).
+        to output(/Psych::DisallowedClass/).to_stdout
+    end
+  end
+
+  describe '.download_files' do
+    it 'returns a proper download URL' do
+      allow_project_id '189934715f57a162257d74.88352370' do
+        response = VCR.use_cassette('download_files') do
+          described_class.download_files
+        end
+
+        expect(response['project_id']).to eq('189934715f57a162257d74.88352370')
+        expect(response['bundle_url']).to include('s3-eu-west-1.amazonaws.com')
+      end
+    end
+
+    it 'rescues from 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
+      end
+    end
+  end
+
+  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(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(count_translations).to eq(0)
+      end
+    end
+  end
+end

data/spec/lib/lokalise_rails_spec.rb

@@ -1,40 +1,95 @@
 # frozen_string_literal: true
 
 describe LokaliseRails do
-  it 'should return a proper version' 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
-      expect(fake_class).to receive(:project_id=).with('123.abc')
+      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
-      expect(fake_class).to receive(:import_opts=).with(duck_type(:each))
+      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
-      expect(fake_class).to receive(:import_safe_mode=).with(true)
+      allow(fake_class).to receive(:import_safe_mode=).with(true)
       fake_class.import_safe_mode = true
     end
 
     it 'is possible to set api_token' do
-      expect(fake_class).to receive(:api_token=).with('abc')
+      allow(fake_class).to receive(:api_token=).with('abc')
       fake_class.api_token = 'abc'
     end
 
     it 'is possible to override locales_path' do
-      expect(fake_class).to receive(:locales_path).and_return('/demo/path')
+      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
 
-      expect(fake_class.locales_path).to eq('/demo/path')
+    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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe LokaliseRails do
+  it 'runs export rake task properly' do
+    expect(export_executor).to output(/complete!/).to_stdout
+  end
+end

data/spec/lib/tasks/import_task_spec.rb

@@ -3,6 +3,10 @@
 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' }
+
   context 'when directory is empty' do
     before do
       mkdir_locales
@@ -13,70 +17,92 @@ RSpec.describe LokaliseRails do
       rm_translation_files
     end
 
-    it 'is callable' do
-      expect(LokaliseRails::TaskDefinition::Importer).to receive(
+    it 'import rake task is callable' do
+      allow(LokaliseRails::TaskDefinition::Importer).to receive(
         :download_files
       ).and_return(
         {
           'project_id' => '123.abc',
-          'bundle_url' => "#{Rails.root}/public/translations.zip"
+          'bundle_url' => local_trans
         }
       )
 
       expect(import_executor).to output(/complete!/).to_stdout
 
       expect(count_translations).to eq(4)
-
-      main_en = File.join described_class.locales_path, 'main_en.yml'
-      expect(File.file?(main_en)).to be true
+      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 'downloads ZIP archive properly' do
-      expect(LokaliseRails::TaskDefinition::Importer).to receive(
+    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' => 'https://github.com/bodrovis/lokalise_rails/blob/master/spec/dummy/public/translations.zip?raw=true'
+          'bundle_url' => remote_trans
         }
       )
 
       expect(import_executor).to output(/complete!/).to_stdout
 
+      expect(LokaliseRails::TaskDefinition::Importer).to have_received(:download_files)
       expect(count_translations).to eq(4)
-
-      main_en = File.join described_class.locales_path, 'main_en.yml'
-      expect(File.file?(main_en)).to be true
+      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
   end
 
-  context 'when directory is not empty' do
+  context 'when directory is not empty and safe mode enabled' do
     before :all do
       mkdir_locales
-      rm_translation_files
-      temp_file = File.join described_class.locales_path, 'kill.me'
-      File.open(temp_file, 'w+') { |file| file.write('temp') }
       described_class.import_safe_mode = true
     end
 
+    before do
+      rm_translation_files
+      add_translation_files!
+    end
+
     after :all do
       rm_translation_files
       described_class.import_safe_mode = false
     end
 
-    it 'returns a success message with default settings' do
-      expect(LokaliseRails::TaskDefinition::Importer).to receive(
+    it 'import proceeds when the user agrees' do
+      allow(LokaliseRails::TaskDefinition::Importer).to receive(
         :download_files
       ).and_return(
         {
           'project_id' => '123.abc',
-          'bundle_url' => "#{Rails.root}/public/translations.zip"
+          'bundle_url' => local_trans
         }
       )
-      expect($stdin).to receive(:gets).and_return('Y')
+
+      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)
     end
   end
 end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@
 
 require 'dotenv/load'
 require 'simplecov'
+
 SimpleCov.start 'rails' do
   add_filter 'spec/'
   add_filter '.github/'
@@ -19,16 +20,18 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }
 
 # Configure Rails Environment
 ENV['RAILS_ENV'] = 'test'
-
 require_relative '../spec/dummy/config/environment'
-ActiveRecord::Migrator.migrations_paths = [File.expand_path('../spec/dummy/db/migrate', __dir__)]
 ENV['RAILS_ROOT'] ||= "#{File.dirname(__FILE__)}../../../spec/dummy"
 
-require 'rspec/rails'
-
 RSpec.configure do |config|
-  config.include FileUtils
+  config.include FileManager
   config.include RakeUtils
+  config.include SpecAddons
 end
 
+# rubocop:disable Style/MixinUsage
+include FileManager
+# rubocop:enable Style/MixinUsage
+
+add_config!
 Rails.application.load_tasks

data/spec/support/file_manager.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+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)
+  end
+
+  def rm_translation_files
+    FileUtils.rm_rf locales_dir
+  end
+
+  def locales_dir
+    Dir["#{LokaliseRails.locales_path}/**/*"]
+  end
+
+  def count_translations
+    locales_dir.count { |file| File.file?(file) }
+  end
+
+  def add_translation_files!(with_ru: false)
+    FileUtils.mkdir_p "#{Rails.root}/config/locales/nested"
+    File.open("#{Rails.root}/config/locales/nested/en.yml", 'w+:UTF-8') do |f|
+      f.write en_data
+    end
+
+    return unless with_ru
+
+    File.open("#{Rails.root}/config/locales/ru.yml", 'w+:UTF-8') do |f|
+      f.write ru_data
+    end
+  end
+
+  def add_config!
+    data = <<~DATA
+      require 'lokalise_rails'
+      LokaliseRails.config do |c|
+        c.api_token = ENV['LOKALISE_API_TOKEN']
+        c.project_id = ENV['LOKALISE_PROJECT_ID']
+      end
+    DATA
+
+    File.open("#{Rails.root}/config/lokalise_rails.rb", 'w+:UTF-8') do |f|
+      f.write data
+    end
+  end
+
+  def remove_config
+    FileUtils.remove_file config_file if File.file?(config_file)
+  end
+
+  def config_file
+    "#{Rails.root}/config/lokalise_rails.rb"
+  end
+
+  private
+
+  def en_data
+    <<~DATA
+      en:
+        my_key: "My value"
+        nested:
+          key: "Value 2"
+    DATA
+  end
+
+  def ru_data
+    <<~DATA
+      ru_RU:
+        my_key: "Моё значение"
+        nested:
+          key: "Значение 2"
+    DATA
+  end
+end

data/spec/support/rake_utils.rb

@@ -5,6 +5,10 @@ module RakeUtils
     -> { Rake::Task['lokalise_rails:import'].execute }
   end
 
+  def export_executor
+    -> { Rake::Task['lokalise_rails:export'].execute }
+  end
+
   def install_invoker
     Rails::Generators.invoke 'lokalise_rails:install'
   end

data/spec/support/spec_addons.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SpecAddons
+  def allow_project_id(value = ENV['LOKALISE_PROJECT_ID'])
+    allow(LokaliseRails).to receive(:project_id).and_return(value)
+    return unless block_given?
+
+    yield
+    expect(LokaliseRails).to have_received(:project_id)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lokalise_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Ilya Bodrov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-26 00:00:00.000000000 Z
+date: 2021-02-02 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: '3.1'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.3
+        version: 6.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.3
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,34 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.60'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.60'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.37'
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.37'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -178,20 +164,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -228,6 +200,7 @@ files:
 - lib/lokalise_rails.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/version.rb
 - lib/tasks/lokalise_rails_tasks.rake
@@ -255,18 +228,22 @@ files:
 - spec/dummy/config/routes.rb
 - spec/dummy/db/seeds.rb
 - spec/lib/generators/lokalise_rails/install_generator_spec.rb
-- spec/lib/lokalise_rails/importer_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_spec.rb
+- spec/lib/tasks/export_task_spec.rb
 - spec/lib/tasks/import_task_spec.rb
 - spec/spec_helper.rb
-- spec/support/file_utils.rb
+- spec/support/file_manager.rb
 - spec/support/rake_utils.rb
+- spec/support/spec_addons.rb
 - spec/support/vcr.rb
 homepage: https://github.com/bodrovis/lokalise_rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -281,8 +258,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.7
+signing_key:
 specification_version: 4
 summary: Lokalise integration for Ruby on Rails
 test_files:
@@ -309,10 +286,14 @@ 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/importer_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_spec.rb
+- spec/lib/tasks/export_task_spec.rb
 - spec/lib/tasks/import_task_spec.rb
 - spec/spec_helper.rb
-- spec/support/file_utils.rb
+- spec/support/file_manager.rb
 - spec/support/rake_utils.rb
+- spec/support/spec_addons.rb
 - spec/support/vcr.rb