lokalise_manager 3.3.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eec5391729d2e75849846e323f88ca9817b01b0fa67c3293c7a14a23edbfea7a
-  data.tar.gz: 8ce91e9c150e5a7c93c7009f027160ceeab4b3e5ebcec3928cf4cfd51476bfc8
+  metadata.gz: 31b3524b3186c5fa2f6ff2f915cf45dc2cc26f69c615ff6d44fffd6581286222
+  data.tar.gz: 324ce28075eb3d6cacfda2076ac5b0d9b18a0750026e464e99ebb8b9aafa70d5
 SHA512:
-  metadata.gz: cb1433d03eb8c52017600dd6833c8cb0214de4ffdaf0215c4bbe700794f3a10ea260f787e56a6393796943d48973e93161314e78f0f330120f3e0478b8895a07
-  data.tar.gz: f109171b02e72eee8ded4aa43c549815170903e0dd6a4b14cc37b20a2b93282dc1f588e8be75c5cceb0e92ac77ec41ee1ad9888e65009d7997d1c61938bf73da
+  metadata.gz: 207900d1455053cc5246892f53ceed6027d2335ced167702e8f9c2eb977b0ce037f089cf447d8b4941bcd49d940de9d66a88c078df147c7ad23cad30e001b230
+  data.tar.gz: 14cc73a9f1a2fe3cad5716e9fe11bb68ad991eb239fc0d2aac45322b3237faf7644b7da403b2124733107e7f29a3e78cba3c510c77993d8f8339753112cd2b16

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 5.0.0 (09-Nov-2023)
+
+* **Breaking change**: require Ruby 3+. Version 2.7 has reached end-of-life and thus we are not planning to support it anymore. If you need support for Ruby 2.7, please stay on 4.0.0.
+* **Potential breaking change**: lambda returned by the `lang_iso_inferer` method has been slightly enhanced. It now accepts not only the file data but also the full path to the file. Therefore, if you redefine the `lang_iso_inferer` option please make sure that the returned lambda accepts two params, not one. This way, you can be more flexible when inferring the locale. For example:
+
+```ruby
+lang_iso_inferer: ->(_data, path) { path.basename('.yml').to_s }
+```
+
+* Use ruby-lokalise-api v9.0.0
+
+## 4.0.0 (27-Jul-2023)
+
+* **Use ruby-lokalise-api version 8**. It should not introduce any breaking changes (as main methods have similar signatures) but you should be aware that v8 is a complete rewrite of the original SDK so please make sure your tests pass.
+* Replace VCR with WebMock in tests
+* Various minor updates
+* Do not test with Ruby 2.7 (EOL)
+
 ## 3.3.0 (18-Nov-22)
 
 * Use newer ruby-lokalise-api

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Lokalise team, Ilya Krukowski
+Copyright (c) 2023 Ilya Krukowski
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,7 +2,8 @@
 
 ![Gem](https://img.shields.io/gem/v/lokalise_manager)
 ![CI](https://github.com/bodrovis/lokalise_manager/actions/workflows/ci.yml/badge.svg)
-[![Test Coverage](https://codecov.io/gh/bodrovis/lokalise_manager/graph/badge.svg)](https://codecov.io/gh/bodrovis/lokalise_manager)
+[![Coverage Status](https://coveralls.io/repos/github/bodrovis/lokalise_manager/badge.svg?branch=master)](https://coveralls.io/github/bodrovis/lokalise_manager?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/9b682367a274ee3dcdee/maintainability)](https://codeclimate.com/github/bodrovis/lokalise_manager/maintainability)
 ![Downloads total](https://img.shields.io/gem/dt/lokalise_manager)
 
 This gem provides [Lokalise](http://lokalise.com) integration for Ruby and allows to exchange translation files between your project and TMS easily. It relies on [ruby-lokalise-api](https://lokalise.github.io/ruby-lokalise-api) to send APIv2 requests.
@@ -202,7 +203,7 @@ If your translation files are not in YAML format, you will need to adjust the fo
 * `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) { YAML.dump(raw_data).gsub(/\\\\n/, '\n') }`. 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 }`.
+* `lang_iso_inferer` (`lambda` or `proc`) — infers language ISO code based on the translation file data and path before uploading it to Lokalise. Defaults to `->(data, _path) { YAML.safe_load(data)&.keys&.first }`. To infer locale based on the filename, you can use something like `->(_data, path) { path.basename('.yml').to_s }`. `path` is an instance of the `Pathname` class.
 
 ### Customizing JSON parser and network adapter
 
@@ -297,9 +298,9 @@ importer.import!
 
 ## 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.
+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 stubs, so the actual API requests won’t be sent. However, providing at least some values is required.
 2. Run `rspec .`. Observe test results and code coverage.
 
 ## License
 
-Copyright (c) [Lokalise team](http://lokalise.com), [Ilya Krukowski](http://bodrovis.tech). License type is [MIT](https://github.com/bodrovis/lokalise_manager/blob/master/LICENSE).
+Copyright (c) [Ilya Krukowski](http://bodrovis.tech). License type is [MIT](https://github.com/bodrovis/lokalise_manager/blob/master/LICENSE).

data/lib/lokalise_manager/global_config.rb

@@ -95,12 +95,14 @@ module LokaliseManager
 
       # Converts translations data to the proper format
       def translations_converter
-        @translations_converter || ->(raw_data) { YAML.dump(raw_data).gsub(/\\\\n/, '\n') }
+        @translations_converter || ->(raw_data) { YAML.dump(raw_data).gsub('\\\\n', '\n') }
       end
 
       # Infers lang ISO for the given translation file
+      # The lambda expects to accept the raw contents of the translation file
+      # and the full path to the file (instance of the `Pathname` class)
       def lang_iso_inferer
-        @lang_iso_inferer || ->(data) { YAML.safe_load(data)&.keys&.first }
+        @lang_iso_inferer || ->(data, _path) { YAML.safe_load(data)&.keys&.first }
       end
     end
   end

data/lib/lokalise_manager/task_definitions/base.rb

@@ -17,10 +17,10 @@ module LokaliseManager
       # @param custom_opts [Hash]
       # @param global_config [Object]
       def initialize(custom_opts = {}, global_config = LokaliseManager::GlobalConfig)
-        primary_opts = global_config.
-                       singleton_methods.
-                       filter { |m| m.to_s.end_with?('=') }.
-                       each_with_object({}) do |method, opts|
+        primary_opts = global_config
+                       .singleton_methods
+                       .filter { |m| m.to_s.end_with?('=') }
+                       .each_with_object({}) do |method, opts|
           reader = method.to_s.delete_suffix('=')
           opts[reader.to_sym] = global_config.send(reader)
         end

data/lib/lokalise_manager/task_definitions/exporter.rb

@@ -84,7 +84,7 @@ module LokaliseManager
         initial_opts = {
           data: Base64.strict_encode64(content.strip),
           filename: relative_p,
-          lang_iso: config.lang_iso_inferer.call(content)
+          lang_iso: config.lang_iso_inferer.call(content, full_p)
         }
 
         initial_opts.merge config.export_opts

data/lib/lokalise_manager/task_definitions/importer.rb

@@ -19,7 +19,7 @@ module LokaliseManager
           return false
         end
 
-        open_and_process_zip download_files['bundle_url']
+        open_and_process_zip download_files.bundle_url
 
         $stdout.print('Task complete!') unless config.silent_mode
         true

data/lib/lokalise_manager/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LokaliseManager
-  VERSION = '3.3.0'
+  VERSION = '5.0.0'
 end

data/lib/lokalise_manager.rb

@@ -2,7 +2,6 @@
 
 require 'zeitwerk'
 require 'yaml'
-require 'psych'
 
 loader = Zeitwerk::Loader.for_gem
 loader.setup

data/lokalise_manager.gemspec

@@ -8,11 +8,12 @@ Gem::Specification.new do |spec|
   spec.authors               = ['Ilya Krukowski']
   spec.email                 = ['golosizpru@gmail.com']
   spec.summary               = 'Lokalise integration for Ruby'
-  spec.description           = 'This gem contains a collection of some common tasks for Lokalise. Specifically, it allows to import/export translation files from/to Lokalise TMS.'
+  spec.description           = 'This gem contains a collection of some common tasks for Lokalise. Specifically, ' \
+                               'it allows to import/export translation files from/to Lokalise TMS.'
   spec.homepage              = 'https://github.com/bodrovis/lokalise_manager'
   spec.license               = 'MIT'
   spec.platform              = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 3.0'
 
   spec.files = Dir['README.md', 'LICENSE',
                    'CHANGELOG.md', 'lib/**/*.rb',
@@ -22,11 +23,10 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = ['README.md']
   spec.require_paths    = ['lib']
 
-  spec.add_dependency 'ruby-lokalise-api', '~> 7'
+  spec.add_dependency 'ruby-lokalise-api', '~> 9.0'
   spec.add_dependency 'rubyzip', '~> 2.3'
   spec.add_dependency 'zeitwerk', '~> 2.4'
 
-  spec.add_development_dependency 'codecov', '~> 0.2'
   spec.add_development_dependency 'dotenv', '~> 2.5'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.6'
@@ -35,7 +35,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rake', '~> 0.6'
   spec.add_development_dependency 'rubocop-rspec', '~> 2.6'
   spec.add_development_dependency 'simplecov', '~> 0.16'
-  spec.add_development_dependency 'vcr', '~> 6.0'
+  spec.add_development_dependency 'simplecov-lcov', '~> 0.8'
+  spec.add_development_dependency 'webmock', '~> 3.18'
   spec.metadata = {
     'rubygems_mfa_required' => 'true'
   }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lokalise_manager
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Ilya Krukowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-18 00:00:00.000000000 Z
+date: 2023-11-09 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: '7'
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
-- !ruby/object:Gem::Dependency
-  name: codecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -179,19 +165,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.16'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '3.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '3.18'
 description: This gem contains a collection of some common tasks for Lokalise. Specifically,
   it allows to import/export translation files from/to Lokalise TMS.
 email:
@@ -231,14 +231,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Lokalise integration for Ruby