lokalise_rails 5.1.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22e008938f4d8c056bd3ab42087a3ea5a996e32e0c5fc1eb5fbcaab978235c42
-  data.tar.gz: e2ca1a4c9a6888e357c660ec721c8d6cee37ce51297ed5afb3992b7cbaba6b64
+  metadata.gz: 14b031485e357b3c1b4d4aa5640f214ddcdb382fe53266de02d70b118867515d
+  data.tar.gz: e0b8070461e74fcdf9dd465335b60486d98dd80456b46934029ef5da23e60525
 SHA512:
-  metadata.gz: 56a4e4b06697bb5b1ddf40f43792e75b2321028665059833c7986d41821717f64cb3ea950b19a05fc9434854c8bfec61e4dd84f895172e0b53ac985265a4ccbd
-  data.tar.gz: 82c589564b69dbc2d2e6921e2f6e5164959bbcf08ea2a5dd9822de474fc6d11c27429f957a2d05128e3927b0ecbe9da5bcdc4d4a9de6081a6b5be42dce6841be
+  metadata.gz: 9aab358a2d9cb224c199a0b052d5749ffad9dc4c3a1e739ab6a1532a7303dd45d88ba1e9b242e3a1ce8b8c0ecef98288abf7049124d2ae56170ebf417573eb20
+  data.tar.gz: fa9ed8e36017819eeb00f712910d582fb13d2ca63a07fb62b85c561fd3edb8e93fe1275a4fcca5be80093a97c4f5dc2260305daf94afa96146a22dd001831a27

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 6.0.0 (27-Jul-2023)
+
+* Use lokalise-manager v4 and ruby-lokalise-api v8. The latter is a major rewrite of the original SDK and has some breaking changes (however 95% of the methods have similar signatures). Therefore please make sure that your tests pass.
+* Do not test with Ruby 2.7 (EOL)
+
+## 5.2.0 (26-Jan-2023)
+
+* The gem can now be added to the `development` group instead of `production` to reduce the bundle size
+* Update dependences, test with Ruby 3.2
+
 ## 5.1.0 (26-Aug-2022)
 
 * Fixed an issue with `\n` being improperly imported

data/Gemfile

@@ -5,16 +5,15 @@ source 'http://rubygems.org'
 gemspec
 
 group :test do
-  gem 'codecov', '~> 0.2'
   gem 'dotenv', '~> 2.5'
-  gem 'rails', '~> 7.0'
+  gem 'rails', '~> 7.0.4'
   gem 'rake', '~> 13.0'
   gem 'rspec', '~> 3.6'
   gem 'rubocop', '~> 1.0'
   gem 'rubocop-performance', '~> 1.5'
+  gem 'rubocop-rake', '~> 0.6'
   gem 'rubocop-rspec', '~> 2.6'
-  gem 'simplecov', '~> 0.16'
-  gem 'sprockets-rails', '~> 3'
-  gem 'tzinfo-data' # , platforms: %i[mingw mswin x64_mingw jruby]
-  gem 'vcr', '~> 6.1'
+  gem 'simplecov', '~> 0.22'
+  gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]
+  gem 'webmock', '~> 3.14'
 end

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 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,6 @@
 
 ![Gem](https://img.shields.io/gem/v/lokalise_rails)
 ![CI](https://github.com/bodrovis/lokalise_rails/actions/workflows/ci.yml/badge.svg)
-[![Test Coverage](https://codecov.io/gh/bodrovis/lokalise_rails/graph/badge.svg)](https://codecov.io/gh/bodrovis/lokalise_rails)
 ![Downloads total](https://img.shields.io/gem/dt/lokalise_rails)
 
 This gem provides [Lokalise](http://lokalise.com) integration for Ruby on Rails and allows to exchange translation files easily. It relies on [lokalise_manager](https://github.com/bodrovis/lokalise_manager) which perform the actual import/export and can be used to run this task in any Ruby script.
@@ -13,13 +12,13 @@ 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](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.
+This gem requires Ruby 2.7+ 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.
 
 Alternatively, you can utilize a token obtained via OAuth 2 flow. When using such a token, you'll have to set `:use_oauth2_token` option to `true` (please check [options docs](https://github.com/bodrovis/lokalise_manager#common-config) to learn more).
 
 ### Installation
 
-Add the gem to your `Gemfile`:
+Add the gem to your `Gemfile` (it can be added to the `development` group if you're not planning to import/export translations in production):
 
 ```ruby
 gem 'lokalise_rails'
@@ -102,6 +101,30 @@ importer.import!
 exporter.export!
 ```
 
+### Example: Multiple translation paths
+
+Creating custom import/export script can come in really handy if you have a non-standard setup, for instance, your translation files are stored in multiple directories (not only in the default `./config/locales`. To overcome this problem, create a custom Rake task and provide as many importers/exporters as needed:
+
+```ruby
+require 'rake'
+require 'lokalise_rails'
+require "#{LokaliseRails::Utils.root}/config/lokalise_rails"
+
+namespace :lokalise_custom do
+  task :export do
+    # importing from the default directory (./config/locales/)
+    exporter = LokaliseManager.exporter({}, LokaliseRails::GlobalConfig)
+    exporter.export!
+
+    # importing from the custom directory
+    exporter = LokaliseManager.exporter({locales_path: "#{Rails.root}/config/custom_locales"}, LokaliseRails::GlobalConfig)
+    exporter.export!
+  rescue StandardError => e
+    abort e.inspect
+  end
+end
+```
+
 ## Configuration
 
 Options are specified in the `config/lokalise_rails.rb` file.
@@ -165,9 +188,9 @@ end
 
 ## 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 stubbed requests, 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_rails/blob/master/LICENSE).
+Copyright (c) [Ilya Krukowski](http://bodrovis.tech). License type is [MIT](https://github.com/bodrovis/lokalise_rails/blob/master/LICENSE).

data/Rakefile

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require 'rake'
+require 'rake/clean'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 begin
   require 'bundler/setup'
@@ -9,13 +12,33 @@ rescue LoadError
   puts 'although not required, bundler is recommened for running the tests'
 end
 
-task default: :spec
-
-require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-require 'rubocop/rake_task'
 RuboCop::RakeTask.new do |task|
   task.requires << 'rubocop-performance'
   task.requires << 'rubocop-rspec'
+  task.requires << 'rubocop-rake'
+end
+
+CLOBBER.include(FileList['./*.gem'])
+
+namespace :lokalise do
+  desc 'Updates RubyGems, installs dependencies'
+  task :install do
+    puts 'Running bundle install'
+    sh 'gem update --system'
+    sh 'bundle'
+  end
+
+  desc 'Builds the gem'
+  task :build do
+    puts 'Building'
+    sh 'gem build lokalise_rails.gemspec'
+  end
 end
+
+task rubospec: %w[rubocop spec]
+
+task full_build: %w[clobber lokalise:install lokalise:build]
+
+task default: :full_build

data/lib/generators/templates/lokalise_rails_config.rb

@@ -1,54 +1,56 @@
 # frozen_string_literal: true
 
-LokaliseRails::GlobalConfig.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']
+if defined?(LokaliseRails) && defined?(LokaliseRails::GlobalConfig)
+  LokaliseRails::GlobalConfig.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"
+    # Provide a custom path to the directory with your translation files:
+    # c.locales_path = "#{Rails.root}/config/locales"
 
-  # Provide a Lokalise project branch to use:
-  # c.branch = ''
+    # Provide a Lokalise project branch to use:
+    # c.branch = ''
 
-  # Provide request timeouts for the Lokalise API client:
-  # c.timeouts = {open_timeout: nil, timeout: nil}
+    # Provide request timeouts for the Lokalise API client:
+    # c.timeouts = {open_timeout: nil, timeout: nil}
 
-  # Provide maximum number of retries for file exporting:
-  # c.max_retries_export = 5
+    # Provide maximum number of retries for file exporting:
+    # c.max_retries_export = 5
 
-  # Provide maximum number of retries for file importing:
-  # c.max_retries_import = 5
+    # Provide maximum number of retries for file importing:
+    # c.max_retries_import = 5
 
-  # Import options have the following defaults:
-  # c.import_opts = {
-  #   format: 'ruby_yaml',
-  #   placeholder_format: :icu,
-  #   yaml_include_root: true,
-  #   original_filenames: true,
-  #   directory_prefix: '',
-  #   indentation: '2sp'
-  # }
+    # Import options have the following defaults:
+    # c.import_opts = {
+    #   format: 'ruby_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
+    # 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 = {}
+    # 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') }
+    # 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') }
 
-  # 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
+    # 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 }
+    ## 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) { YAML.dump(raw_data).gsub(/\\\\n/, '\n') }
+    ## Convert translations data to a proper format:
+    ## c.translations_converter = ->(raw_data) { YAML.dump(raw_data).gsub(/\\\\n/, '\n') }
 
-  ## Infer language ISO code for the translation file:
-  ## c.lang_iso_inferer = ->(data) { YAML.safe_load(data)&.keys&.first }
+    ## Infer language ISO code for the translation file:
+    ## c.lang_iso_inferer = ->(data) { YAML.safe_load(data)&.keys&.first }
+  end
 end

data/lib/lokalise_rails/version.rb

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

data/lib/tasks/lokalise_rails_tasks.rake

@@ -5,6 +5,7 @@ require 'lokalise_rails'
 require "#{LokaliseRails::Utils.root}/config/lokalise_rails"
 
 namespace :lokalise_rails do
+  desc 'Imports translation files from Lokalise to the current Rails project'
   task :import do
     importer = LokaliseManager.importer({}, LokaliseRails::GlobalConfig)
     importer.import!
@@ -12,6 +13,7 @@ namespace :lokalise_rails do
     abort e.inspect
   end
 
+  desc 'Exports translation files from the current Rails project to Lokalise'
   task :export do
     exporter = LokaliseManager.exporter({}, LokaliseRails::GlobalConfig)
     exporter.export!

data/lokalise_rails.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = ['README.md']
   spec.require_paths    = ['lib']
 
-  spec.add_dependency 'lokalise_manager', '~> 3.2'
+  spec.add_dependency 'lokalise_manager', '~> 4.0'
   spec.add_dependency 'zeitwerk', '~> 2.4'
 
   spec.metadata = {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lokalise_rails
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Ilya Krukowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-26 00:00:00.000000000 Z
+date: 2023-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lokalise_manager
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.21
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: Lokalise integration for Ruby on Rails