lokalise_rails 8.0.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5acb05fa54c4ff1e243de21c053b5154e307709e1bd569fa3dbb363e147e1443
-  data.tar.gz: 84714f2c2250a8d81a5671cc6bfaa6735151151bf5c5f6b38ae7f6e13579a3e3
+  metadata.gz: a3ff7f8491d3b827f087d10075343078f5bb084b7fb648fac8270b65af1c26f2
+  data.tar.gz: d0176a00387aea9c8e4fd3063f214f8a1e3fc5b33b5a026cae685931214ce99b
 SHA512:
-  metadata.gz: a457a3fcf4abe0783029f6458a4139b1d24c073b7480f59170f41eaf52fe9989735ffdb4f67ee0a829f29dfa65ca296debb8a32029079816dbfc9621fc8ef662
-  data.tar.gz: eb21427d268d3ce61d7c87184f07bc2347174d4a9d54f556b64b87a284309b1d6a91324ade166d0abb6fa8db425e788e0add91b29cee3dc05e1f8d4aaf791c33
+  metadata.gz: 16ba4b740fb69c45c4de23fc629618fe93a18de23d55b8b7658590c36372d21fe685999f0576fe5055b3f58e331f0493c2f703eb8a0ca5f5bf7613956ddfdd12
+  data.tar.gz: 5db3aa39c333e88496a6a48efe13d0792da290cb46676058fd012e9ad3cca8a054c20f171436a3124739ce81ce6a0a566a45f12e57a774ee38c2475fe5415956

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 8.1.0 (17-Apr-2025)
+
+* Added `disable_export_task` boolean option. When enabled, the export task is turned off in your project to prevent from accidentally exporting keys to Lokalise and overwriting existing data. Defaults to `false`. Thanks, @aarisr!
+
+## 8.0.1 (19-Feb-2025)
+
+* Minor code tweaks, use latest `lokalise_manager` that now enables asynchronous imports
+
 ## 8.0.0 (29-Nov-2024)
 
 * **Breaking change**: rename the `timeouts` config option to `additional_client_opts`. It has the same usage but now enables you to set both client timeouts and override the API host to send requests to.

data/Gemfile

@@ -6,7 +6,7 @@ gemspec
 
 group :test do
   gem 'dotenv', '~> 3.0'
-  gem 'rails', '8.0.0'
+  gem 'rails', '~> 8.0'
   gem 'rake', '~> 13.0'
   gem 'rspec', '~> 3.6'
   gem 'rubocop', '~> 1.0'

data/README.md

@@ -185,6 +185,9 @@ LokaliseRails::GlobalConfig.config do |c|
 
   ## Infer language ISO code for the translation file:
   ## c.lang_iso_inferer = ->(data, _path) { YAML.safe_load(data)&.keys&.first }
+
+  ## Disable the export rake task:
+  ## c.disable_export_task = false
 end
 ```
 

data/lib/generators/lokalise_rails/install_generator.rb

@@ -4,21 +4,15 @@ require 'rails/generators'
 
 module LokaliseRails
   module Generators
-    # Generator that sets up the LokaliseRails configuration in a Rails application.
-    # It copies a predefined configuration template into the appropriate directory within the Rails application,
-    # making it easier for users to configure and use LokaliseRails.
+    # Installs the LokaliseRails configuration file in a Rails application.
     class InstallGenerator < Rails::Generators::Base
-      # Sets the directory containing the template files relative to this file's location.
       source_root File.expand_path('../templates', __dir__)
 
-      # Description of the generator's purpose, which is displayed in the Rails generators list.
-      desc 'Creates a LokaliseRails config file in your Rails application.'
+      # Adds a configuration file for LokaliseRails to the Rails application.
+      desc 'Creates a config/lokalise_rails.rb file for LokaliseRails.'
 
-      # The primary method of this generator, responsible for copying the LokaliseRails configuration template
-      # from the gem to the Rails application's config directory. This is where users can customize
-      # their Lokalise settings.
+      # Copies the configuration template to the application's config directory.
       def copy_config
-        # Copies the configuration template to the Rails application's config directory.
         template 'lokalise_rails_config.rb', "#{Rails.root}/config/lokalise_rails.rb"
       end
     end

data/lib/generators/templates/lokalise_rails_config.rb

@@ -34,6 +34,9 @@ if defined?(LokaliseRails::GlobalConfig)
     # Safe mode for imports is disabled by default:
     # c.import_safe_mode = false
 
+    # Run imports asynchronously
+    # c.import_async = false
+
     # Additional export options (only filename, contents, and lang_iso params are provided by default)
     # c.export_opts = {}
 
@@ -52,5 +55,8 @@ if defined?(LokaliseRails::GlobalConfig)
 
     ## Infer language ISO code for the translation file:
     ## c.lang_iso_inferer = ->(data, _path) { YAML.safe_load(data)&.keys&.first }
+
+    ## Disable the export rake task:
+    ## c.disable_export_task = false
   end
 end

data/lib/lokalise_rails/global_config.rb

@@ -1,17 +1,27 @@
 # frozen_string_literal: true
 
 module LokaliseRails
-  # Inherits from LokaliseManager::GlobalConfig to provide a global configuration specific to the LokaliseRails gem.
-  # This class is primarily used to manage configuration settings that affect how the LokaliseRails gem operates
-  # within a Ruby on Rails application, particularly in managing locale paths.
+  # Extends `LokaliseManager::GlobalConfig` to provide a global configuration
+  # specific to the LokaliseRails gem in a Rails application.
   class GlobalConfig < LokaliseManager::GlobalConfig
     class << self
-      # Provides the path to the locales directory where translation files are stored. If not set explicitly,
-      # it defaults to the `config/locales` directory within the root of the application using this gem.
+      attr_writer :disable_export_task
+
+      # Returns whether the export task should be disabled.
+      #
+      # Defaults to `false` if not explicitly set.
+      #
+      # @return [Boolean] `true` if the export task is disabled, otherwise `false`.
+      def disable_export_task
+        @disable_export_task.nil? ? false : @disable_export_task
+      end
+
+      # Returns the path to the directory where translation files are stored.
+      #
+      # Defaults to `config/locales` under the Rails application root if not explicitly set.
       #
-      # @return [String] the path to the locales directory
+      # @return [String] Absolute path to the locales directory.
       def locales_path
-        # If @locales_path is not set, it defaults to a path under the application's root directory.
         @locales_path || "#{LokaliseRails::Utils.root}/config/locales"
       end
     end

data/lib/lokalise_rails/railtie.rb

@@ -1,18 +1,16 @@
 # frozen_string_literal: true
 
 module LokaliseRails
-  # The Railtie class in Rails is used to extend Rails' functionality within an application, or in this case,
-  # a gem. This Railtie is specifically used to add custom Rake tasks from the
-  # LokaliseRails gem into the Rails application.
+  # Extends Rails via Railtie to integrate LokaliseRails functionalities.
   #
-  # It leverages Rails' Railtie architecture to ensure the Rake
-  # tasks are loaded when the application boots up and Rake is invoked.
+  # This Railtie ensures that custom Rake tasks from the LokaliseRails gem
+  # are automatically available within a Rails application.
   class Railtie < Rails::Railtie
-    # Register Rake tasks that are defined within this gem. This block is called by Rails during the initialization
-    # process and ensures that all Rake tasks specific to LokaliseRails are available to the application.
+    # Registers custom Rake tasks for LokaliseRails.
+    #
+    # This ensures that the tasks are loaded when the Rails application boots
+    # and Rake is invoked.
     rake_tasks do
-      # Loads the Rake tasks from a file located relative to this file. Ensure this file exists and contains
-      # valid Rake task definitions specifically tailored for Lokalise integration.
       load 'tasks/lokalise_rails_tasks.rake'
     end
   end

data/lib/lokalise_rails/utils.rb

@@ -3,31 +3,30 @@
 require 'pathname'
 
 module LokaliseRails
-  # Util methods
+  # Utility methods for LokaliseRails
   module Utils
     class << self
       # Retrieves the root directory of the current project.
-      # It attempts to find the Rails root directory if Rails is loaded.
-      # If Rails is not present, it defaults to the current working directory of the process.
       #
-      # @return [Pathname] A Pathname object pointing to the root directory of the project.
+      # If Rails is available, it returns `Rails.root`. Otherwise, it defaults
+      # to the current working directory.
+      #
+      # @return [Pathname] Pathname object pointing to the project root.
       def root
-        # Uses Pathname to create a robust path object from the rails_root or the current working directory.
         Pathname.new(rails_root || Dir.getwd)
       end
 
-      # Attempts to determine the root directory of a Rails
-      # project by checking the presence of Rails and its root method.
-      # If Rails is older and does not have the root method, it falls back to the RAILS_ROOT constant if defined.
+      # Determines the root directory of a Rails project.
+      #
+      # - Uses `Rails.root` if available.
+      # - Falls back to `RAILS_ROOT` for older Rails versions.
+      # - Returns `nil` if Rails is not present.
       #
-      # @return [String, nil] the path to the root directory if Rails is defined, or nil if it cannot be determined.
+      # @return [String, nil] Path to the root directory or `nil` if not found.
       def rails_root
-        # First, check if Rails.root is defined and return its path if available.
         return ::Rails.root.to_s if defined?(::Rails.root) && ::Rails.root
-        # Fallback to the RAILS_ROOT constant from older Rails versions.
         return RAILS_ROOT.to_s if defined?(RAILS_ROOT)
 
-        # Returns nil if none of the above are defined, indicating Rails is not present.
         nil
       end
     end

data/lib/lokalise_rails/version.rb

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

data/lib/lokalise_rails.rb

@@ -3,19 +3,22 @@
 require 'zeitwerk'
 require 'lokalise_manager'
 
-# Configure Zeitwerk loader specific for gem environments. This loader is set up to ignore certain files
-# that should not be autoloaded, such as Rails-specific files or templates which are not part of the main load path.
+# Configure Zeitwerk for managing gem autoloading.
 loader = Zeitwerk::Loader.for_gem
-loader.ignore "#{__dir__}/lokalise_rails/railtie.rb" # Ignore the Railtie in non-Rails environments
-loader.ignore "#{__dir__}/generators/templates/lokalise_rails_config.rb"  # Ignore the generator templates
-loader.ignore "#{__dir__}/generators/lokalise_rails/install_generator.rb" # Ignore installation generator scripts
+
+# Ignore files that should not be autoloaded.
+loader.ignore "#{__dir__}/lokalise_rails/railtie.rb" # Exclude Railtie when not in a Rails app
+loader.ignore "#{__dir__}/generators/templates/lokalise_rails_config.rb" # Ignore generator templates
+loader.ignore "#{__dir__}/generators/lokalise_rails/install_generator.rb" # Ignore installation generator
+
 loader.setup
 
-# Main module for the LokaliseRails gem. This module serves as the namespace for all components
-# related to the LokaliseRails integration. It provides a structured way to manage translations
-# through the Lokalise platform within Ruby on Rails applications.
+# Main module for LokaliseRails.
+#
+# Serves as the namespace for all components of the LokaliseRails gem,
+# providing tools for managing translations in Ruby on Rails applications.
 module LokaliseRails
 end
 
-# Require the Railtie only if Rails is defined to integrate with Rails without manual configuration.
+# Load Railtie if running within a Rails application.
 require_relative 'lokalise_rails/railtie' if defined?(Rails)

data/lib/tasks/lokalise_rails_tasks.rake

@@ -2,33 +2,34 @@
 
 require 'rake'
 require 'lokalise_rails'
-# Loads the configuration settings from the lokalise_rails configuration file within the Rails project.
-require "#{LokaliseRails::Utils.root}/config/lokalise_rails"
+require File.join(LokaliseRails::Utils.root, 'config', 'lokalise_rails')
 
-# Namespace for Rake tasks related to the LokaliseRails gem.
-# These tasks facilitate the synchronization of localization files between the Rails project and the Lokalise platform.
+# Rake tasks for syncing translation files between a Rails project and Lokalise.
 namespace :lokalise_rails do
-  # Imports translation files from Lokalise and integrates them into the current Rails project.
-  # This task utilizes the LokaliseManager to handle the import process according to the configuration specified
-  # in the GlobalConfig class.
-  desc 'Imports translation files from Lokalise to the current Rails project'
+  ##########################################################################
+  # IMPORT
+  ##########################################################################
+  desc 'Import translations from Lokalise into the Rails project'
   task :import do
     importer = LokaliseManager.importer({}, LokaliseRails::GlobalConfig)
     importer.import!
   rescue StandardError => e
-    # Aborts the task and prints the error message.
-    # Ensures that any exceptions raised during import are handled gracefully.
     abort "Import failed: #{e.message}"
   end
 
-  # Exports translation files from the current Rails project to Lokalise.
-  # Similar to the import task, it leverages the LokaliseManager and uses the GlobalConfig for configuration settings.
-  desc 'Exports translation files from the current Rails project to Lokalise'
+  ##########################################################################
+  # EXPORT
+  ##########################################################################
+  desc 'Export translations from the Rails project to Lokalise'
   task :export do
+    if LokaliseRails::GlobalConfig.disable_export_task
+      $stdout.puts 'Export task is disabled.'
+      exit 0
+    end
+
     exporter = LokaliseManager.exporter({}, LokaliseRails::GlobalConfig)
     exporter.export!
   rescue StandardError => e
-    # Aborts the task and prints the error message. Provides clear feedback on why the export failed.
     abort "Export failed: #{e.message}"
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: lokalise_rails
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.1.0
 platform: ruby
 authors:
 - Ilya Krukowski
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lokalise_manager
@@ -69,7 +68,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -84,8 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Lokalise integration for Ruby on Rails
 test_files: []