lokalise_rails 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 951a2d142a56078d2d9509fa36c13f87f7069b8f2defa9bd158a90a67aba2b9a
-  data.tar.gz: ac2360ad608a4251c9061454c0fea986f868facb90567a5bcd94ae01d33bd8e3
+  metadata.gz: 02b78ecae0b5dbf76599249606858c5b24e31fc9826f8795feb34abac9d5ffb4
+  data.tar.gz: b7bc51d45b689181ae0d3d5366f507ae0e43c878c4ab55979ba54d7089eb49f7
 SHA512:
-  metadata.gz: 4f41072fa0c0e138fc3f6a838b672c50e0f3af799e151b0cbc2b66aa1792446c6cdde4a1426ed1a5243871c48cc55bc9e12439ecc7eb00be090629ad0a77bd4c
-  data.tar.gz: ae1acd8d95ce227c8c16a362d2fb0d0bc371a986e5108043a7d9f3037bf292e1da2a48efa4c84720e7a4f1f1e66c13e757ba59ababe1ab081d77960516340803
+  metadata.gz: 838ddae7af99842dbc4a7ce900c8b02a07571ff9c561e642e3bac6f92dbaabd9132f775b0ff1877ffd18fc20c1bf84ec3f7792139bad0c9fc97dec1d03389e64
+  data.tar.gz: 79c0314752c8e48b552eb78c564d24da0cd14fa41b1195909d8d06ca81913322fefa56a696f3c20d1c53c51aa16feb731c85f6fdd860242c98ad8b018b9c68ae

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.2.0 (11-Nov-20)
+
+* New option `translations_loader`
+* New option `translations_converter`
+* New option `lang_iso_inferer`
+
 ## 1.1.0 (23-Oct-20)
 
 * New option `branch`

data/README.md

@@ -92,7 +92,6 @@ Options are specified in the `config/lokalise_rails.rb` file.
 * `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).
 * `branch` (`string`) - Lokalise project branch to use. Defaults to `"master"`.
 * `timeouts` (`hash`) - set [request timeouts for the Lokalise API client](https://lokalise.github.io/ruby-lokalise-api/additional_info/customization#setting-timeouts). By default, requests have no timeouts: `{open_timeout: nil, timeout: nil}`. Both values are in seconds.
 
@@ -134,6 +133,15 @@ en_US:
 c.skip_file_export = ->(file) { f.split[1].to_s.include?('fr') }
 ```
 
+### Settings to work with formats other than YAML
+
+If your translation files are not in YAML format, you will need to adjust the following options:
+
+* `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).
+* `translations_loader` (`lambda` or `proc`) - loads translations data and makes sure they are valid before saving them to a translation file. Defaults to `->(raw_data) { YAML.safe_load raw_data }`. In the simplest case you may just return the data back, for example `-> (raw_data) { raw_data }`.
+* `translations_converter` (`lambda` or `proc`) - converts translations data to a proper format before saving them to a translation file. Defaults to `->(raw_data) { raw_data.to_yaml }`. In the simplest case you may just return the data back, for example `-> (raw_data) { raw_data }`.
+* `lang_iso_inferer` (`lambda` or `proc`) - infers language ISO code based on the translation file data before uploading it to Lokalise. Defaults to `->(data) { YAML.safe_load(data)&.keys&.first }`.
+
 ## Running tests
 
 1. Copypaste `.env.example` file as `.env`. Put your Lokalise API token and project ID inside. The `.env` file is excluded from version control so your data is safe. All in all, we use pre-recorded VCR cassettes, so the actual API requests won’t be sent. However, providing at least some values is required.

data/lib/generators/templates/lokalise_rails_config.rb

@@ -35,6 +35,16 @@ LokaliseRails.config do |c|
   # 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
+  # Set the options below if you would like to work with format other than YAML
+  ## 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
+
+  ## Load translations data and make sure they are valid:
+  ## c.translations_loader = ->(raw_data) { YAML.safe_load raw_data }
+
+  ## Convert translations data to a proper format:
+  ## c.translations_converter = ->(raw_data) { raw_data.to_yaml }
+
+  ## Infer language ISO code for the translation file:
+  ## c.lang_iso_inferer = ->(data) { YAML.safe_load(data)&.keys&.first }
 end

data/lib/lokalise_rails.rb

@@ -8,7 +8,8 @@ module LokaliseRails
   class << self
     attr_accessor :api_token, :project_id
     attr_writer :import_opts, :import_safe_mode, :export_opts, :locales_path,
-                :file_ext_regexp, :skip_file_export, :branch, :timeouts
+                :file_ext_regexp, :skip_file_export, :branch, :timeouts,
+                :translations_loader, :translations_converter, :lang_iso_inferer
 
     # Main interface to provide configuration options for rake tasks
     def config
@@ -61,6 +62,20 @@ module LokaliseRails
     def skip_file_export
       @skip_file_export || ->(_) { false }
     end
+
+    def translations_loader
+      @translations_loader || ->(raw_data) { YAML.safe_load raw_data }
+    end
+
+    # Converts translations data to the proper format
+    def translations_converter
+      @translations_converter || ->(raw_data) { raw_data.to_yaml }
+    end
+
+    # Infers lang ISO for the given translation file
+    def lang_iso_inferer
+      @lang_iso_inferer || ->(data) { YAML.safe_load(data)&.keys&.first }
+    end
   end
 end
 

data/lib/lokalise_rails/task_definition/exporter.rb

@@ -55,12 +55,10 @@ module LokaliseRails
         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
+            lang_iso: LokaliseRails.lang_iso_inferer.call(content)
           }
 
           initial_opts.merge LokaliseRails.export_opts

data/lib/lokalise_rails/task_definition/importer.rb

@@ -46,7 +46,7 @@ module LokaliseRails
         #
         # @param path [String]
         def open_and_process_zip(path)
-          Zip::File.open_buffer(URI.open(path)) do |zip|
+          Zip::File.open_buffer(open_file_or_remote(path)) do |zip|
             fetch_zip_entries(zip) { |entry| process!(entry) }
           end
         end
@@ -64,13 +64,13 @@ module LokaliseRails
 
         # 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
+          data = data_from zip_entry
           subdir, filename = subdir_and_filename_for zip_entry.name
           full_path = "#{LokaliseRails.locales_path}/#{subdir}"
           FileUtils.mkdir_p full_path
 
           File.open(File.join(full_path, filename), 'w+:UTF-8') do |f|
-            f.write data.to_yaml
+            f.write LokaliseRails.translations_converter.call(data)
           end
         rescue StandardError => e
           $stdout.puts "Error when trying to process #{zip_entry&.name}: #{e.inspect}"
@@ -87,6 +87,24 @@ module LokaliseRails
           answer = $stdin.gets
           answer.to_s.strip == 'Y'
         end
+
+        # Opens a local file or a remote URL using the provided patf
+        #
+        # @return [String]
+        def open_file_or_remote(path)
+          parsed_path = URI.parse(path)
+          if parsed_path&.scheme&.include?('http')
+            parsed_path.open
+          else
+            File.open path
+          end
+        end
+
+        private
+
+        def data_from(zip_entry)
+          LokaliseRails.translations_loader.call zip_entry.get_input_stream.read
+        end
       end
     end
   end

data/lib/lokalise_rails/version.rb

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

data/lokalise_rails.gemspec

@@ -35,9 +35,9 @@ Gem::Specification.new do |spec|
   end
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.6'
-  spec.add_development_dependency 'rubocop', '~> 0.60'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
   spec.add_development_dependency 'rubocop-performance', '~> 1.5'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.37'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.0.0'
   spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'vcr', '~> 6.0'
 end

data/spec/dummy/config/lokalise_rails.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'lokalise_rails'
 LokaliseRails.config do |c|
   c.api_token = ENV['LOKALISE_API_TOKEN']

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

@@ -45,12 +45,12 @@ describe LokaliseRails::TaskDefinition::Base do
     end
 
     it 'returns an error when the project_id is not set' do
-      allow(LokaliseRails).to receive(:project_id).and_return(nil)
-      errors = described_class.opt_errors
+      allow_project_id nil do
+        errors = described_class.opt_errors
 
-      expect(LokaliseRails).to have_received(:project_id)
-      expect(errors.length).to eq(1)
-      expect(errors.first).to include('Project ID is not set')
+        expect(errors.length).to eq(1)
+        expect(errors.first).to include('Project ID is not set')
+      end
     end
   end
 

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

@@ -49,10 +49,9 @@ describe LokaliseRails::TaskDefinition::Exporter do
       end
 
       it 'halts when the project_id is not set' do
-        allow(LokaliseRails).to receive(:project_id).and_return(nil)
-
-        expect(-> { described_class.export! }).to output(/Project ID is not set/).to_stdout
-        expect(LokaliseRails).to have_received(:project_id)
+        allow_project_id nil do
+          expect(-> { described_class.export! }).to output(/Project ID is not set/).to_stdout
+        end
       end
     end
 

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

@@ -12,14 +12,14 @@ describe LokaliseRails::TaskDefinition::Importer do
 
   describe '.download_files' do
     it 'returns a proper download URL' do
-      allow(LokaliseRails).to receive(:project_id).and_return('189934715f57a162257d74.88352370')
-      response = VCR.use_cassette('download_files') do
-        described_class.download_files
-      end
+      allow_project_id '189934715f57a162257d74.88352370' do
+        response = VCR.use_cassette('download_files') do
+          described_class.download_files
+        end
 
-      expect(LokaliseRails).to have_received(:project_id)
-      expect(response['project_id']).to eq('189934715f57a162257d74.88352370')
-      expect(response['bundle_url']).to include('s3-eu-west-1.amazonaws.com')
+        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
@@ -40,10 +40,10 @@ describe LokaliseRails::TaskDefinition::Importer do
     end
 
     it 'halts when the project_id is not set' do
-      allow(LokaliseRails).to receive(:project_id).and_return(nil)
-      expect(-> { described_class.import! }).to output(/Project ID is not set/).to_stdout
-      expect(LokaliseRails).to have_received(:project_id)
-      expect(count_translations).to eq(0)
+      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

@@ -73,5 +73,23 @@ describe LokaliseRails do
       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/support/spec_addons.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 module SpecAddons
-  def allow_project_id(value = '189934715f57a162257d74.88352370')
-    allow(LokaliseRails).to receive(:project_id).
-      and_return(value)
+  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: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Ilya Bodrov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-23 00:00:00.000000000 Z
+date: 2020-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lokalise-api
@@ -114,14 +114,14 @@ dependencies:
     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
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.37'
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.37'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -243,7 +243,7 @@ homepage: https://github.com/bodrovis/lokalise_rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -259,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Lokalise integration for Ruby on Rails
 test_files: