lokalise_rails 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09902a3883dec5ff5390383ef2770947547955202c759d794809616c3713bb5e'
-  data.tar.gz: 1f21ca62432cbdd640286419d2964b87ab4398b91efa505a8e00b284842e39bf
+  metadata.gz: 87524123a10425d69c33950f4b2c16366146f5c1ab14c19dbc7185de61fb726a
+  data.tar.gz: 39ba0b0a91f443ea162d7804c89906f4523f7c13411fbd541624bafb9197a569
 SHA512:
-  metadata.gz: 74105425483dd2371140b27771a050e912173756a65e732289ce991a0c6513f58b4bfdc1a2bbeee4ecef75054226976034edd46447cc0b60857215e689a15d1f
-  data.tar.gz: 0176b8f37389c4699fdc620c57c17bfa2143f1dd5fc1f3914e953f90a6a4e9434899bab1df53eb6f359928174089a8791cff75e3544bcae0a4b3c8602f844680
+  metadata.gz: 4e36f385c123ab80402aaa428973c2c0706b2cbceabade8bcf12689fe0955bdc927a223c27a9114c102d83af6a709b061e1c10d2e189ca832b5b56a0a6b043f8
+  data.tar.gz: bbbe1857d99cdc7c3595f611d664c555981fbdf5f1d37c30a52cb179d641902f879b1492996dc7c1c1cb6dacdfbd7c2a3ca226f31a687879fddf59b1e8f9fe7a

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 1.0.0 (01-Oct-20)
+
+* Added export feature
+* More convenient configuration and additional options
+* Other major enhancements
+
+## 0.2.0 (26-Sep-20)
+
+* Allow to override options properly
+
 ## 0.1.0 (26-Sep-20)
 
 * Initial (proper) release

data/README.md

@@ -1,6 +1,6 @@
 # LokaliseRails
 
-<!-- [![Gem Version](https://badge.fury.io/rb/ruby-lokalise-api.svg)](https://badge.fury.io/rb/ruby-lokalise-api) -->
+[![Gem Version](https://badge.fury.io/rb/lokalise_rails.svg)](https://badge.fury.io/rb/lokalise_rails)
 [![Build Status](https://travis-ci.org/bodrovis/lokalise_rails.svg?branch=master)](https://travis-ci.org/bodrovis/lokalise_rails)
 [![Test Coverage](https://codecov.io/gh/bodrovis/lokalise_rails/graph/badge.svg)](https://codecov.io/gh/bodrovis/lokalise_rails)
 
@@ -10,17 +10,17 @@ This gem provides [Lokalise](http://lokalise.com) integration for Ruby on Rails
 
 ### Requirements
 
-This gem requires Ruby 2.5+ and Rails 5.1+. It might work with older versions of Rails though. You will also need to setup a Lokalise account and a translation project. Finally, you will need to generate a read/write API token at your Lokalise profile.
+This gem requires Ruby 2.5+ and Rails 5.1+. It might work with older versions of Rails though. 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.
 
 ### Installation
 
-Add the gem to your `Gemfile`
+Add the gem to your `Gemfile`:
 
 ```ruby
 gem 'lokalise_rails'
 ```
 
-and run
+and run:
 
 ```
 bundle install
@@ -32,12 +32,17 @@ The latter command will generate a new config file `config/lokalise_rails.rb` lo
 ```ruby
 require 'lokalise_rails'
 
-LokaliseRails.api_token = ENV['LOKALISE_API_TOKEN']
-LokaliseRails.project_id = ENV['LOKALISE_PROJECT_ID']
-# ...
+LokaliseRails.config do |c|
+  c.api_token = ENV['LOKALISE_API_TOKEN']
+  c.project_id = ENV['LOKALISE_PROJECT_ID']
+
+  # ...other options
+end
 ```
 
-You have to provide `api_token` and `project_id` to proceed. [Other options can be customized as well (see below)](https://github.com/bodrovis/lokalise_rails#import-settings) but they have sensible defaults.
+You have to provide `api_token` and `project_id` to proceed. `project_id` can be found in your Lokalise project settings.
+
+[Other options can be customized as well (see below)](https://github.com/bodrovis/lokalise_rails#import-settings) but they have sensible defaults.
 
 ## Importing translations from Lokalise
 
@@ -47,7 +52,15 @@ To import translations from the specified Lokalise project to your Rails app, ru
 rails lokalise_rails:import
 ```
 
-Please note that any existing files inside the `locales` directory will be overwritten! You may enable [safe mode](https://github.com/bodrovis/lokalise_rails#import-settings) to check whether the folder is empty or not.
+Please note that any duplicating files inside the `locales` directory (or any other directory that you've specified in the options) will be overwritten! You may enable [safe mode](https://github.com/bodrovis/lokalise_rails#import-settings) to check whether the folder is empty or not.
+
+## Exporting translations to Lokalise
+
+To export translations from your Rails app to the specified Lokalise project, run the following command:
+
+```
+rails lokalise_rails:export
+```
 
 ## Configuration
 
@@ -55,23 +68,14 @@ Options are specified in the `config/lokalise_rails.rb` file.
 
 ### Global settings
 
-* `LokaliseRails.api_token` (`string`, required) - Lokalise API token with read/write permissions.
-* `LokaliseRails.project_id` (`string`, required) - Lokalise project ID. You must have import/export permissions in the specified project.
-* `locales_path` - method returning a string with the path to your translation files. Defaults to `"#{Rails.root}/config/locales"`. To provide a custom path, override the method inside the initializer (make sure that the path exists!):
-
-```ruby
-class LokaliseRails
-  class << self
-    def locales_path
-      "#{Rails.root}/config/locales_custom"
-    end
-  end
-end
-```
+* `api_token` (`string`, required) - Lokalise API token with read/write permissions.
+* `project_id` (`string`, required) - Lokalise project ID. You must have import/export permissions in the specified project.
+* `locales_path` (`string`) - path to the directory with your translation files. Defaults to `"#{Rails.root}/config/locales"`.
+* `file_ext_regexp` (`regexp`) - regular expression applied to file extensions to determine which files should be imported and exported. Defaults to `/\.ya?ml\z/i` (YAML files).
 
 ### Import settings
 
-* `LokaliseRails.import_opts` (`hash`) - options that will be passed to Lokalise API when downloading translations to your app. Here are the default options:
+* `import_opts` (`hash`) - options that will be passed to Lokalise API when downloading translations to your app. Here are the default options:
 
 ```ruby
 {
@@ -84,8 +88,28 @@ end
 }
 ```
 
-Full list of available options [can be found at the official API documentation](https://app.lokalise.com/api2docs/curl/#transition-download-files-post).
-* `LokaliseRails.import_safe_mode` (`boolean`) - default to `false`. When this option is enabled, the import task will check whether the `locales` directory is empty or not. If it is not empty, you will be prompted to continue.
+Full list of available import options [can be found in the official API documentation](https://app.lokalise.com/api2docs/curl/#transition-download-files-post).
+* `import_safe_mode` (`boolean`) - default to `false`. When this option is enabled, the import task will check whether the directory set with `locales_path` is empty or not. If it is not empty, you will be prompted to continue.
+
+### Export settings
+
+* `export_opts` (`hash`) - options that will be passed to Lokalise API when uploading translations. Full list of available export options [can be found in the official documentation](https://app.lokalise.com/api2docs/curl/#transition-download-files-post). By default, the following options are provided:
+  + `data` (`string`, required) - base64-encoded contents of the translation file.
+  + `filename` (`string`, required) - translation file name. If the file is stored under a subdirectory (for example, `nested/en.yml` inside the `locales/` directory), the whole path acts as a name. Later when importing files with such names, they will be placed into the proper subdirectories.
+  + `lang_iso` (`string`, required) - language ISO code which is determined using the root key inside your YAML file. For example, in this case the `lang_iso` is `en_US`:
+
+```yaml
+en_US:
+  my_key: "my value"
+```
+
+**Please note** that if your Lokalise project does not have a language with the specified `lang_iso` code, the export will fail.
+
+* `skip_file_export` (`lambda` or `proc`) - specify additional exclusion criteria for the exported files. By default, the rake task will ignore all non-file entries and all files with improper extensions (the latter is controlled by the `file_ext_regexp`). Lambda passed to this option should accept a single argument which is full path to the file (instance of the [`Pathname` class](https://ruby-doc.org/stdlib-2.7.1/libdoc/pathname/rdoc/Pathname.html)). For example, to exclude all files that have `fr` part in their names, add the following config:
+
+```ruby
+c.skip_file_export = ->(file) { f.split[1].to_s.include?('fr') }
+```
 
 ## License
 

data/lib/generators/lokalise_rails/install_generator.rb

@@ -2,7 +2,7 @@
 
 require 'rails/generators'
 
-class LokaliseRails
+module LokaliseRails
   module Generators
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path('../templates', __dir__)

data/lib/generators/templates/lokalise_rails_config.rb

@@ -2,28 +2,33 @@
 
 require 'lokalise_rails'
 
-# These are mandatory options that you must set before running rake tasks:
-LokaliseRails.api_token = ENV['LOKALISE_API_TOKEN']
-LokaliseRails.project_id = ENV['LOKALISE_PROJECT_ID']
-
-# Import options have the following defaults:
-# LokaliseRails.import_opts = {
-#   format: 'yaml',
-#   placeholder_format: :icu,
-#   yaml_include_root: true,
-#   original_filenames: true,
-#   directory_prefix: '',
-#   indentation: '2sp'
-# }
-
-# Safe mode is disabled by default:
-# LokaliseRails.import_safe_mode = false
-
-# Provide a custom path to the directory with your translation files:
-# class LokaliseRails
-#   class << self
-#     def locales_path
-#       "#{Rails.root}/config/locales"
-#     end
-#   end
-# end
+LokaliseRails.config do |c|
+  # These are mandatory options that you must set before running rake tasks:
+  # c.api_token = ENV['LOKALISE_API_TOKEN']
+  # c.project_id = ENV['LOKALISE_PROJECT_ID']
+
+  # Provide a custom path to the directory with your translation files:
+  # c.locales_path = "#{Rails.root}/config/locales"
+
+  # Import options have the following defaults:
+  # c.import_opts = {
+  #   format: 'yaml',
+  #   placeholder_format: :icu,
+  #   yaml_include_root: true,
+  #   original_filenames: true,
+  #   directory_prefix: '',
+  #   indentation: '2sp'
+  # }
+
+  # Safe mode for imports is disabled by default:
+  # c.import_safe_mode = false
+
+  # Additional export options (only filename, contents, and lang_iso params are provided by default)
+  # c.export_opts = {}
+
+  # Provide additional file exclusion criteria for exports (by default, any file with the proper extension will be exported)
+  # c.skip_file_export = ->(file) { file.split[1].to_s.include?('fr') }
+
+  # Regular expression to use when choosing the files to extract from the downloaded archive and upload to Lokalise
+  # c.file_ext_regexp = /\.ya?ml\z/i
+end

data/lib/lokalise_rails.rb

@@ -2,29 +2,54 @@
 
 require 'lokalise_rails/task_definition/base'
 require 'lokalise_rails/task_definition/importer'
+require 'lokalise_rails/task_definition/exporter'
 
-class LokaliseRails
-  @project_id = nil
-  @import_opts = {
-    format: 'yaml',
-    placeholder_format: :icu,
-    yaml_include_root: true,
-    original_filenames: true,
-    directory_prefix: '',
-    indentation: '2sp'
-  }
-  # @export_opts = {
-  #
-  # }
-  @import_safe_mode = false
-  @api_token = nil
-
+module LokaliseRails
   class << self
-    attr_accessor :import_opts, :import_safe_mode, :api_token, :export_opts,
-                  :project_id
+    attr_accessor :api_token, :project_id
+    attr_writer :import_opts, :import_safe_mode, :export_opts, :locales_path,
+                :file_ext_regexp, :skip_file_export
+
+    # Main interface to provide configuration options for rake tasks
+    def config
+      yield self
+    end
 
+    # Full path to directory with translation files
     def locales_path
-      "#{Rails.root}/config/locales"
+      @locales_path || "#{Rails.root}/config/locales"
+    end
+
+    # Regular expression used to select translation files with proper extensions
+    def file_ext_regexp
+      @file_ext_regexp || /\.ya?ml\z/i
+    end
+
+    # Options for import rake task
+    def import_opts
+      @import_opts || {
+        format: 'yaml',
+        placeholder_format: :icu,
+        yaml_include_root: true,
+        original_filenames: true,
+        directory_prefix: '',
+        indentation: '2sp'
+      }
+    end
+
+    # Options for export rake task
+    def export_opts
+      @export_opts || {}
+    end
+
+    # Enables safe mode for import. When enabled, will check whether the target folder is empty or not
+    def import_safe_mode
+      @import_safe_mode.nil? ? false : @import_safe_mode
+    end
+
+    # Additional file skip criteria to apply when performing export
+    def skip_file_export
+      @skip_file_export || ->(_) { false }
     end
   end
 end

data/lib/lokalise_rails/railtie.rb

@@ -2,7 +2,7 @@
 
 require 'rake'
 
-class LokaliseRails
+module LokaliseRails
   class Railtie < Rails::Railtie
     rake_tasks do
       load 'tasks/lokalise_rails_tasks.rake'

data/lib/lokalise_rails/task_definition/base.rb

@@ -1,21 +1,48 @@
 # frozen_string_literal: true
 
 require 'ruby-lokalise-api'
-require 'open-uri'
+require 'pathname'
 
-class LokaliseRails
+module LokaliseRails
   module TaskDefinition
     class Base
       class << self
-        def check_required_opts
-          return [
-            false, 'Project ID is not set! Aborting...'
-          ] if LokaliseRails.project_id.nil? || LokaliseRails.project_id.empty?
-          return [
-            false, 'Lokalise API token is not set! Aborting...'
-          ] if LokaliseRails.api_token.nil? || LokaliseRails.api_token.empty?
+        attr_writer :api_client
 
-          [true, '']
+        # Creates a Lokalise API client
+        #
+        # @return [Lokalise::Client]
+        def api_client
+          @api_client ||= ::Lokalise.client LokaliseRails.api_token
+        end
+
+        # Checks task options
+        #
+        # @return Array
+        def opt_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
+        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
       end
     end

data/lib/lokalise_rails/task_definition/exporter.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+module LokaliseRails
+  module TaskDefinition
+    class Exporter < Base
+      class << self
+        # Performs translation file export from Rails to Lokalise and returns an array of queued processes
+        #
+        # @return [Array]
+        def export!
+          errors = opt_errors
+
+          if errors.any?
+            errors.each { |e| $stdout.puts e }
+            return false
+          end
+
+          queued_processes = []
+          each_file do |full_path, relative_path|
+            queued_processes << api_client.upload_file(
+              LokaliseRails.project_id, opts(full_path, relative_path)
+            )
+          rescue StandardError => e
+            $stdout.puts "Error while trying to upload #{full_path}: #{e.inspect}"
+          end
+
+          $stdout.print 'Task complete!'
+
+          queued_processes
+        end
+
+        # Processes each translation file in the specified directory
+        def each_file
+          return unless block_given?
+
+          loc_path = LokaliseRails.locales_path
+          Dir["#{loc_path}/**/*"].sort.each 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
+        end
+
+        # Generates export options
+        #
+        # @return [Hash]
+        # @param full_p [Pathname]
+        # @param relative_p [Pathname]
+        def opts(full_p, relative_p)
+          content = File.read full_p
+
+          lang_iso = YAML.safe_load(content)&.keys&.first
+
+          initial_opts = {
+            data: Base64.strict_encode64(content.strip),
+            filename: relative_p,
+            lang_iso: lang_iso
+          }
+
+          initial_opts.merge LokaliseRails.export_opts
+        end
+
+        # Checks whether the specified file has to be processed or not
+        #
+        # @return [Boolean]
+        # @param full_path [Pathname]
+        def file_matches_criteria?(full_path)
+          full_path.file? && proper_ext?(full_path) &&
+            !LokaliseRails.skip_file_export.call(full_path)
+        end
+      end
+    end
+  end
+end

data/lib/lokalise_rails/task_definition/importer.rb

@@ -1,42 +1,84 @@
 # frozen_string_literal: true
 
-class LokaliseRails
+require 'zip'
+require 'yaml'
+require 'open-uri'
+require 'fileutils'
+
+module LokaliseRails
   module TaskDefinition
     class Importer < Base
       class << self
+        # Performs translation files import from Lokalise to Rails app
+        #
+        # @return [Boolean]
         def import!
-          status_ok, msg = check_required_opts
-          return msg unless status_ok
-          return 'Task cancelled!' unless proceed_when_safe_mode?
+          errors = opt_errors
+
+          if errors.any?
+            errors.each { |e| $stdout.puts e }
+            return false
+          end
+
+          unless proceed_when_safe_mode?
+            $stdout.print 'Task cancelled!'
+            return false
+          end
 
           open_and_process_zip download_files['bundle_url']
 
-          'Task complete!'
+          $stdout.print 'Task complete!'
+          true
         end
 
+        # Downloads files from Lokalise using the specified options
+        #
+        # @return [Hash]
         def download_files
-          client = ::Lokalise.client LokaliseRails.api_token
           opts = LokaliseRails.import_opts
 
-          client.download_files LokaliseRails.project_id, opts
+          api_client.download_files LokaliseRails.project_id, opts
+        rescue StandardError => e
+          $stdout.puts "There was an error when trying to download files: #{e.inspect}"
         end
 
+        # Opens ZIP archive (local or remote) with translations and processes its entries
+        #
+        # @param path [String]
         def open_and_process_zip(path)
-          Zip::File.open_buffer(URI.open(path)) { |zip| process_zip zip }
+          Zip::File.open_buffer(URI.open(path)) do |zip|
+            fetch_zip_entries(zip) { |entry| process!(entry) }
+          end
         end
 
-        def process_zip(zip)
+        # Iterates over ZIP entries. Each entry may be a file or folder.
+        def fetch_zip_entries(zip)
+          return unless block_given?
+
           zip.each do |entry|
-            next unless /\.ya?ml/.match?(entry.name)
+            next unless proper_ext? entry.name
+
+            yield entry
+          end
+        end
+
+        # Processes ZIP entry by reading its contents and creating the corresponding translation file
+        def process!(zip_entry)
+          data = YAML.safe_load zip_entry.get_input_stream.read
+          subdir, filename = subdir_and_filename_for zip_entry.name
+          full_path = "#{LokaliseRails.locales_path}/#{subdir}"
+          FileUtils.mkdir_p full_path
 
-            filename = entry.name.include?('/') ? entry.name.split('/')[1] : entry.name
-            data = YAML.safe_load entry.get_input_stream.read
-            File.open("#{LokaliseRails.locales_path}/#{filename}", 'w+:UTF-8') do |f|
-              f.write(data.to_yaml)
-            end
+          File.open(File.join(full_path, filename), 'w+:UTF-8') do |f|
+            f.write data.to_yaml
           end
+        rescue StandardError => e
+          $stdout.puts "Error when trying to process #{zip_entry&.name}: #{e.inspect}"
         end
 
+        # Checks whether the user wishes to proceed when safe mode is enabled and the target directory is not empty
+        #
+        # @return [Boolean]
         def proceed_when_safe_mode?
           return true unless LokaliseRails.import_safe_mode && !Dir.empty?(LokaliseRails.locales_path.to_s)
 

data/lib/lokalise_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-class LokaliseRails
-  VERSION = '0.2.0'
+module LokaliseRails
+  VERSION = '1.0.0'
 end

data/lib/tasks/lokalise_rails_tasks.rake

@@ -1,15 +1,14 @@
 # frozen_string_literal: true
 
 require 'rake'
-require 'ruby-lokalise-api'
-require 'zip'
-require 'open-uri'
-require 'yaml'
 require "#{Rails.root}/config/lokalise_rails"
 
 namespace :lokalise_rails do
   task :import do
-    msg = LokaliseRails::TaskDefinition::Importer.import!
-    $stdout.print msg
+    LokaliseRails::TaskDefinition::Importer.import!
+  end
+
+  task :export do
+    LokaliseRails::TaskDefinition::Exporter.export!
   end
 end

data/lokalise_rails.gemspec

@@ -40,6 +40,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-performance', '~> 1.5'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.37'
   spec.add_development_dependency 'simplecov', '~> 0.16'
-  spec.add_development_dependency 'sqlite3', '~> 1.4'
   spec.add_development_dependency 'vcr', '~> 6.0'
 end

data/spec/dummy/config/application.rb

@@ -4,9 +4,9 @@ require_relative 'boot'
 
 require 'rails'
 # Pick the frameworks you want:
-require 'active_model/railtie'
+# require 'active_model/railtie'
 # require "active_job/railtie"
-require 'active_record/railtie'
+# require 'active_record/railtie'
 # require "active_storage/engine"
 require 'action_controller/railtie'
 # require "action_mailer/railtie"

data/spec/dummy/config/lokalise_rails.rb

@@ -1,29 +1,5 @@
-# frozen_string_literal: true
-
 require 'lokalise_rails'
-
-# These are mandatory options that you must set before running rake tasks:
-LokaliseRails.api_token = ENV['LOKALISE_API_TOKEN']
-LokaliseRails.project_id = ENV['LOKALISE_PROJECT_ID']
-
-# Import options have the following defaults:
-# LokaliseRails.import_opts = {
-#   format: 'yaml',
-#   placeholder_format: :icu,
-#   yaml_include_root: true,
-#   original_filenames: true,
-#   directory_prefix: '',
-#   indentation: '2sp'
-# }
-
-# Safe mode is disabled by default:
-# LokaliseRails.import_safe_mode = false
-
-# Provide a custom path to the directory with your translation files:
-# class LokaliseRails
-#   class << self
-#     def locales_path
-#       "#{Rails.root}/config/locales"
-#     end
-#   end
-# end
+LokaliseRails.config do |c|
+  c.api_token = ENV['LOKALISE_API_TOKEN']
+  c.project_id = ENV['LOKALISE_PROJECT_ID']
+end

data/spec/lib/generators/lokalise_rails/install_generator_spec.rb

@@ -9,7 +9,7 @@ describe LokaliseRails::Generators::InstallGenerator do
 
   after :all do
     remove_config
-    described_class.start
+    add_config!
   end
 
   it 'installs config file properly' do

data/spec/lib/lokalise_rails/exporter_spec.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+describe LokaliseRails::TaskDefinition::Exporter do
+  let(:filename) { 'en.yml' }
+  let(:path) { "#{Rails.root}/config/locales/nested/#{filename}" }
+  let(:relative_name) { "nested/#{filename}" }
+
+  context 'with one translation file' do
+    before :all do
+      add_translation_files!
+    end
+
+    after :all do
+      rm_translation_files
+    end
+
+    describe '.export!' do
+      it 'sends a proper API request' do
+        process = VCR.use_cassette('upload_files') do
+          described_class.export!
+        end.first
+
+        expect(process.project_id).to eq(LokaliseRails.project_id)
+        expect(process.status).to eq('queued')
+      end
+
+      it 'halts when the API key is not set' do
+        expect(LokaliseRails).to receive(:api_token).and_return(nil)
+        expect(described_class).not_to receive(:each_file)
+        expect(-> { described_class.export! }).to output(/API token is not set/).to_stdout
+      end
+
+      it 'halts when the project_id is not set' do
+        expect(LokaliseRails).to receive(:project_id).and_return(nil)
+        expect(described_class).not_to receive(:each_file)
+        expect(-> { described_class.export! }).to output(/Project ID is not set/).to_stdout
+      end
+    end
+
+    describe '.each_file' do
+      it 'yield proper arguments' do
+        expect { |b| described_class.each_file(&b) }.to yield_with_args(
+          Pathname.new(path),
+          Pathname.new(relative_name)
+        )
+      end
+    end
+
+    describe '.opts' do
+      let(:base64content) { Base64.strict_encode64(File.read(path).strip) }
+
+      it 'generates proper options' do
+        resulting_opts = described_class.opts(path, relative_name)
+
+        expect(resulting_opts[:data]).to eq(base64content)
+        expect(resulting_opts[:filename]).to eq(relative_name)
+        expect(resulting_opts[:lang_iso]).to eq('en')
+      end
+
+      it 'allows to redefine options' do
+        expect(LokaliseRails).to receive(:export_opts).and_return({
+                                                                    detect_icu_plurals: true,
+                                                                    convert_placeholders: true
+                                                                  })
+
+        resulting_opts = described_class.opts(path, relative_name)
+
+        expect(resulting_opts[:data]).to eq(base64content)
+        expect(resulting_opts[:filename]).to eq(relative_name)
+        expect(resulting_opts[:lang_iso]).to eq('en')
+        expect(resulting_opts[:detect_icu_plurals]).to be true
+        expect(resulting_opts[:convert_placeholders]).to be true
+      end
+    end
+  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 'rescues from export errors' do
+        processes = VCR.use_cassette('upload_files_error') do
+          described_class.export!
+        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
+
+    describe '.opts' do
+      let(:base64content_ru) { Base64.strict_encode64(File.read(path_ru).strip) }
+
+      it 'generates proper options' do
+        resulting_opts = described_class.opts(path_ru, relative_name_ru)
+
+        expect(resulting_opts[:data]).to eq(base64content_ru)
+        expect(resulting_opts[:filename]).to eq(relative_name_ru)
+        expect(resulting_opts[:lang_iso]).to eq('ru_RU')
+      end
+    end
+
+    describe '.each_file' do
+      it 'yields every translation file' do
+        expect { |b| described_class.each_file(&b) }.to yield_successive_args(
+          [
+            Pathname.new(path),
+            Pathname.new(relative_name)
+          ],
+          [
+            Pathname.new(path_ru),
+            Pathname.new(relative_name_ru)
+          ]
+        )
+      end
+
+      it 'does not yield files that have to be skipped' do
+        expect(LokaliseRails).to receive(:skip_file_export).twice.and_return(
+          ->(f) { f.split[1].to_s.include?('ru') }
+        )
+        expect { |b| described_class.each_file(&b) }.to yield_successive_args(
+          [
+            Pathname.new(path),
+            Pathname.new(relative_name)
+          ]
+        )
+      end
+    end
+  end
+end

data/spec/lib/lokalise_rails/importer_spec.rb

@@ -1,6 +1,15 @@
 # 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
       expect(LokaliseRails).to receive(:project_id).and_return('189934715f57a162257d74.88352370')
@@ -11,20 +20,27 @@ describe LokaliseRails::TaskDefinition::Importer do
       expect(response['project_id']).to eq('189934715f57a162257d74.88352370')
       expect(response['bundle_url']).to include('s3-eu-west-1.amazonaws.com')
     end
+
+    it 'rescues from errors during file download' do
+      allow(LokaliseRails).to receive(:api_token).and_return('incorrect')
+
+      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
       expect(LokaliseRails).to receive(:api_token).and_return(nil)
-      result = described_class.import!
-      expect(result).to include('API token is not set')
+      expect(-> {described_class.import!}).to output(/API token is not set/).to_stdout
       expect(count_translations).to eq(0)
     end
 
     it 'halts when the project_id is not set' do
       expect(LokaliseRails).to receive(:project_id).and_return(nil)
-      result = described_class.import!
-      expect(result).to include('Project ID is not set')
+      expect(-> {described_class.import!}).to output(/Project ID is not set/).to_stdout
       expect(count_translations).to eq(0)
     end
   end

data/spec/lib/lokalise_rails_spec.rb

@@ -1,10 +1,16 @@
 # 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') }
 
@@ -13,6 +19,11 @@ describe LokaliseRails do
       fake_class.project_id = '123.abc'
     end
 
+    it 'is possible to set file_ext_regexp' do
+      expect(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))
       fake_class.import_opts = {
@@ -21,6 +32,14 @@ describe LokaliseRails do
       }
     end
 
+    it 'is possible to set export_opts' do
+      expect(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 import_safe_mode' do
       expect(fake_class).to receive(:import_safe_mode=).with(true)
       fake_class.import_safe_mode = true
@@ -32,9 +51,14 @@ describe LokaliseRails do
     end
 
     it 'is possible to override locales_path' do
-      expect(fake_class).to receive(:locales_path).and_return('/demo/path')
+      expect(fake_class).to receive(:locales_path=).with('/demo/path')
+      fake_class.locales_path = '/demo/path'
+    end
 
-      expect(fake_class.locales_path).to eq('/demo/path')
+    it 'is possible to set skip_file_export' do
+      cond = ->(f) { f.nil? }
+      expect(fake_class).to receive(:skip_file_export=).with(cond)
+      fake_class.skip_file_export = cond
     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,13 +17,13 @@ RSpec.describe LokaliseRails do
       rm_translation_files
     end
 
-    it 'is callable' do
+    it 'import rake task is callable' do
       expect(LokaliseRails::TaskDefinition::Importer).to receive(
         :download_files
       ).and_return(
         {
           'project_id' => '123.abc',
-          'bundle_url' => "#{Rails.root}/public/translations.zip"
+          'bundle_url' => local_trans
         }
       )
 
@@ -27,17 +31,18 @@ RSpec.describe LokaliseRails do
 
       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
 
-    it 'downloads ZIP archive properly' do
+    it 'import rake task downloads ZIP archive properly' do
       expect(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
         }
       )
 
@@ -45,38 +50,53 @@ RSpec.describe LokaliseRails do
 
       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
+    it 'import proceeds when the user agrees' do
       expect(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')
       expect(import_executor).to output(/is not empty/).to_stdout
 
       expect(count_translations).to eq(5)
+
+      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
+      expect(LokaliseRails::TaskDefinition::Importer).not_to receive(:download_files)
+      expect($stdin).to receive(:gets).and_return('N')
+      expect(import_executor).to output(/is not empty/).to_stdout
+
+      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/'
@@ -21,14 +22,19 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }
 ENV['RAILS_ENV'] = 'test'
 
 require_relative '../spec/dummy/config/environment'
-ActiveRecord::Migrator.migrations_paths = [File.expand_path('../spec/dummy/db/migrate', __dir__)]
+# 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
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lokalise_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-26 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lokalise-api
@@ -178,20 +178,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 +214,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,11 +242,13 @@ files:
 - spec/dummy/config/routes.rb
 - spec/dummy/db/seeds.rb
 - spec/lib/generators/lokalise_rails/install_generator_spec.rb
+- spec/lib/lokalise_rails/exporter_spec.rb
 - spec/lib/lokalise_rails/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/vcr.rb
 homepage: https://github.com/bodrovis/lokalise_rails
@@ -309,10 +298,12 @@ 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/exporter_spec.rb
 - spec/lib/lokalise_rails/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/vcr.rb

data/spec/support/file_utils.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module FileUtils
-  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 remove_config
-    FileUtils.remove_file config_file if File.file?(config_file)
-  end
-
-  def config_file
-    "#{Rails.root}/config/lokalise_rails.rb"
-  end
-end