web_translate_it 3.2.1 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9a027a46383d8932b3776d7c614592e3bb186bed328954f0a39bd2e168f2ba3
-  data.tar.gz: 75bd8ab7c9129e6fb4f6c3c982fee30b1793a01ce2ba8219aa4e2480cb491246
+  metadata.gz: 2344f55bed19e435f8334c66229e58266ff1efe3cf54e9e81f4d17287f42a93d
+  data.tar.gz: 89c6ea08bcc87a43741c8419d5de32e2441f896f12e8338762c15cf84759ab5e
 SHA512:
-  metadata.gz: 20ce007c03f2a00b5eb2c4ba019f37b814ad5184792a1d14a6231351402f0c5988d470a6f64e1b732a2409c74a8f9696b542b3b12aa7ab9c267f0f1c94c5f3ef
-  data.tar.gz: 6aafb08ddff729b498093150eddafd55410f45a1f8d0239d7a11a5c1a2a06ccff802bd53996d442ef89da955ba38b290b25aad6e0f8bb7182e15527faec2d418
+  metadata.gz: c4a9b5b8f2874c7779eedb0d413d826a1d9bccbd8e9db33834ab82a0b8b22b2fb719bf412e7339cb05880018ddc072ee6e70a370824f3fc96f7d6982a2f8396f
+  data.tar.gz: ad5b96143c805efa324ea6119af80dd24517c2e41691b451920934a3deea7115385c13f859ccff7d314c034680f64b95033aba839b1bc4728ff09aa885395a00

data/bin/wti

@@ -28,7 +28,7 @@ show_commands = <<~COMMANDS
 COMMANDS
 
 SUB_COMMANDS = %w[pull push match diff add rm mv addlocale rmlocale status st init].freeze
-global_options = Optimist.options do
+Optimist.options do
   stop_on SUB_COMMANDS
   banner show_commands
   version "wti version #{WebTranslateIt::Util.version}"
@@ -57,13 +57,11 @@ when 'push'
     opt :locale, 'ISO code of locale(s) to push, space-separated', type: :string
     opt :target, 'Upload all target files'
     opt :force,  'Force push (bypass conditional requests to WTI)'
-    opt :low_priority, 'Deprecated: option to process this file with a low priority'
     opt :merge, 'Force WTI to merge this file'
     opt :ignore_missing, 'Force WTI to not obsolete missing strings'
     opt :minor, 'Minor Changes. When pushing a master file, prevents target translations to be flagged as `to_verify`.'
     opt :label,  'Apply a label to the changes', type: :string
     opt :config, 'Path to a configuration file', short: '-c', default: '.wti'
-    opt :all,    'DEPRECATED -- See `wti push --target` instead'
     opt :debug,  'Display debug information'
   end
 when 'diff'
@@ -78,7 +76,6 @@ when 'diff'
 when 'add'
   Optimist.options do
     banner 'wti add filename - Create and push a new master language file'
-    opt :low_priority, 'Deprecated: option to process this file with a low priority'
     opt :config, 'Path to a configuration file', short: '-c', default: '.wti'
     opt :debug,  'Display debug information'
   end
@@ -135,7 +132,7 @@ end
 
 begin
   WebTranslateIt::Connection.turn_debug_on if command_options.debug
-  WebTranslateIt::CommandLine.new(command, command_options, global_options, ARGV, File.expand_path('.'))
+  WebTranslateIt::Runner.new(command, command_options, ARGV, File.expand_path('.'))
 rescue Interrupt
   puts StringUtil.failure("\nQuitting...")
   exit 1

data/history.md

@@ -1,3 +1,32 @@
+## Version 3.2.2 / 2026-03-03
+
+* Replace O(n²) string concatenation loop in `StringUtil#backward_truncate` with `String#ljust`.
+* Move `$stdout.sync = true` and parameter validation into `Base`. Add `Base#require_parameters!` helper, replacing 5 duplicate `validate_parameters!` methods. Drop `Metrics/MethodLength` `rubocop:todo` from Pull.
+* Refactor all command classes for consistency: extract small private methods, use guard clauses, and drop all `rubocop:todo` annotations for `Metrics/AbcSize`, `Metrics/MethodLength`, `Metrics/CyclomaticComplexity`, and `Metrics/PerceivedComplexity` across Add, Addlocale, Diff, Init, Match, Mv, Rm, Rmlocale, and Status. Add `Configuration#target_files_for` to centralize `master_id` lookups.
+* Ensure `Addlocale#call` and `Rmlocale#call` return `true` on success. Previously they returned `nil`, causing `Runner` to `exit 1` even after successful operations.
+* Remove dead code: commented-out `ignore_files` method in `Configuration`, unused `last_modification` in `TranslationFile`, unused `titleize` in `StringUtil`.
+* Replace `Object#in?` (ActiveSupport) with `Array#include?` in `fetch_translations`. #435
+* `Configuration#initialize` now defaults to `Dir.pwd` instead of `Rails.root`, removing the hard Rails dependency. #435
+* Add `Configuration#files_for` to centralize locale and path filtering. Replaces duplicated `find_all`/`sort` logic in Pull, Push, Diff, and Match commands. #436
+* Split `Util` class into focused modules: `HttpResponse`, `Concurrency`, and `Prompt`. `Util` retains only `version`, `calculate_percentage`, and `can_display_colors?`. #434
+* Extract `Configuration#load_project_data` to eliminate duplicated logic between `initialize` and `reload`. #433
+* Refactor `Util.handle_response` to return response body consistently and let callers decide what to print. Extract `status_label` for display formatting. #423
+* Remove `Hash#stringify_keys!` monkey-patch in favour of `Hash#transform_keys(&:to_s)`. #432
+* Extract `Spinner` class from `Runner#throb`. Thread management, ANSI codes, and frame animation are now testable and reusable. #426
+* Add `Connection#get`, `#post`, `#put`, `#delete` wrappers to eliminate repeated `Net::HTTP::*.new` / `Util.add_fields` / `http_connection.request` boilerplate across all API call sites. #424
+* Simplify `fetch_locales` in `Pull` and `Push` commands. Extract `warn_unknown_locales` helper. Remove deprecated `--all` and `--low-priority` options from `push` and `add` commands. #422
+* Extract `TranslationBase` base class from `Translation` and `TermTranslation` to share `initialize`, `save`, `to_json`, and API path logic. #425
+* `Util.with_retries` now re-raises `Timeout::Error` after exhausting retries instead of returning `false`. Methods like `find_all`, `find`, `create`, and `update` now return consistent types. #411
+* Standardize `to_hash`/`to_json` pattern across all model classes. Make `to_hash` private in `ApiResource`, `String`, and `Term`. Convert positional boolean to keyword argument. #410
+* Extract threading logic into `Util.concurrent_batch`. Simplify `Pull#pull_files` and fix thread-safety bug with shared mutable state. Use `Thread#value` for error propagation. #409
+* Separate display logic from business methods in `TranslationFile`. `fetch`, `upload`, `create`, and `delete` now return a `Result` struct instead of printing to stdout, enabling programmatic use without terminal side-effects. Remove broken `modified_remotely?` dead code. #407
+* Refactor long parameter lists to use keyword arguments in `TranslationFile#upload` and `TranslationFile#initialize`. Extract `TranslationFile.from_api` factory method. Remove unused `_global_options` parameter from `Runner#initialize`. #405
+* Replace fragile path splitting with `File.dirname` in `TranslationFile#fetch`. Add specs. #408
+* Decompose `CommandLine` god class into 11 focused command classes under `Commands::` namespace, rename to `Runner`. #404
+* Extract `ApiResource` base class from `String` and `Term` to remove duplicated CRUD logic. #403
+* Fix generic `rescue` blocks to capture and re-raise `StandardError`. #406
+* Extract `Util.with_retries` helper to deduplicate retry logic. #402
+
 ## Version 3.2.1 / 2026-03-02
 
 * Refactor `Connection` class to eliminate class variables. #254

data/lib/web_translate_it/api_resource.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module WebTranslateIt
+
+  class ApiResource # rubocop:todo Metrics/ClassLength
+
+    attr_accessor :id, :created_at, :updated_at, :translations, :new_record, :connection
+
+    def initialize(params = {}, connection: nil)
+      params = params.transform_keys(&:to_s)
+      self.connection   = connection
+      self.id           = params['id'] || nil
+      self.created_at   = params['created_at'] || nil
+      self.updated_at   = params['updated_at'] || nil
+      self.translations = params['translations'] || []
+      self.new_record   = true
+      assign_attributes(params)
+    end
+
+    def self.find_all(connection, params = {}) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
+      params = params.transform_keys(&:to_s)
+      url = "/api/projects/#{connection.api_key}/#{resource_path}"
+      url += "?#{HashUtil.to_params(filter_params(params))}" unless params.empty?
+
+      Concurrency.with_retries do
+        records = []
+        loop do
+          response = connection.get(url)
+          return [] unless response.code.to_i < 400
+
+          JSON.parse(response.body).each do |record_response|
+            record = new(record_response, connection: connection)
+            record.new_record = false
+            records.push(record)
+          end
+          break unless response['Link']&.include?('rel="next"')
+
+          url = response['Link'].match(/<(.*)>; rel="next"/)[1]
+        end
+        records
+      end
+    end
+
+    def self.find(connection, id)
+      Concurrency.with_retries do
+        response = connection.get("/api/projects/#{connection.api_key}/#{resource_path}/#{id}")
+        return nil if response.code.to_i == 404
+
+        record = new(JSON.parse(response.body), connection: connection)
+        record.new_record = false
+        return record
+      end
+    end
+
+    def self.resource_path
+      raise NotImplementedError, "#{name} must implement self.resource_path"
+    end
+
+    def self.filter_params(params)
+      params
+    end
+
+    def save
+      new_record ? create : update
+    end
+
+    def delete
+      Concurrency.with_retries do
+        HttpResponse.handle_response(connection.delete("/api/projects/#{connection.api_key}/#{self.class.resource_path}/#{id}"))
+      end
+    end
+
+    def translation_for(locale) # rubocop:todo Metrics/AbcSize
+      translation = translations.detect { |t| t.locale == locale }
+      return translation if translation
+      return nil if new_record
+
+      Concurrency.with_retries do
+        response = HttpResponse.handle_response(connection.get("/api/projects/#{connection.api_key}/#{self.class.resource_path}/#{id}/locales/#{locale}/translations"))
+        json = JSON.parse(response)
+        return nil if json.empty?
+
+        parse_translation_response(json)
+      end
+    end
+
+    protected
+
+    def assign_attributes(_params)
+      # Override in subclasses to set resource-specific attributes
+    end
+
+    def parse_translation_response(_json)
+      raise NotImplementedError, "#{self.class.name} must implement parse_translation_response"
+    end
+
+    def assign_translation_parent_id(_translation)
+      raise NotImplementedError, "#{self.class.name} must implement assign_translation_parent_id"
+    end
+
+    def update
+      translations.each do |translation|
+        assign_translation_parent_id(translation)
+        translation.connection = connection
+        translation.save
+      end
+
+      Concurrency.with_retries do
+        HttpResponse.handle_response(connection.put("/api/projects/#{connection.api_key}/#{self.class.resource_path}/#{id}", body: to_json))
+      end
+    end
+
+    def create
+      Concurrency.with_retries do
+        raw = connection.post("/api/projects/#{connection.api_key}/#{self.class.resource_path}", body: to_json(with_translations: true))
+        response = JSON.parse(HttpResponse.handle_response(raw))
+        self.id = response['id']
+        self.new_record = false
+        return true
+      end
+    end
+
+    def to_json(*_args, with_translations: false)
+      hash = to_hash
+      hash['translations'] = translations.map(&:to_hash) if translations.any? && with_translations
+      MultiJson.dump(hash)
+    end
+
+    private
+
+    def to_hash
+      {'id' => id}
+    end
+
+  end
+
+end

data/lib/web_translate_it/commands/add.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module WebTranslateIt
+
+  module Commands
+
+    class Add < Base
+
+      def call
+        require_parameters!(
+          min: 1,
+          error: 'Error: You must provide the path to the master file to add.',
+          usage: 'wti add path/to/master_file_1 path/to/master_file_2 ...'
+        )
+        complete_success = true
+        with_connection do |conn|
+          complete_success = add_files(conn)
+        end
+        complete_success
+      end
+
+      private
+
+      def validate_parameters!
+        return unless parameters == []
+
+        puts StringUtil.failure('Error: You must provide the path to the master file to add.')
+        puts 'Usage: wti add path/to/master_file_1 path/to/master_file_2 ...'
+        exit
+      end
+
+      def add_files(conn)
+        to_add = new_master_files
+        if to_add.empty?
+          puts 'No new master file to add.'
+          return true
+        end
+        to_add.all? { |param| create_file(param, conn) }
+      end
+
+      def create_file(param, conn)
+        file = TranslationFile.new(nil, param.gsub(/ /, '\\ '), nil, configuration.api_key)
+        result = file.create(conn)
+        puts StringUtil.array_to_columns(result.output)
+        result.success
+      end
+
+      def new_master_files
+        existing = configuration.files_for(locale: configuration.source_locale)
+                                .to_set { |file| File.expand_path(file.file_path) }
+        parameters.reject { |param| existing.include?(File.expand_path(param)) }
+      end
+
+    end
+
+  end
+
+end

data/lib/web_translate_it/commands/addlocale.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module WebTranslateIt
+
+  module Commands
+
+    class Addlocale < Base
+
+      def call
+        require_parameters!(
+          min: 1,
+          error: 'Locale code missing.',
+          usage: 'wti addlocale fr es ...'
+        )
+        parameters.each do |param|
+          print StringUtil.success("Adding locale #{param.upcase}... ")
+          with_connection do |conn|
+            WebTranslateIt::Project.create_locale(conn, param)
+          end
+          puts 'Done.'
+        end
+        true
+      end
+
+      private
+
+      def validate_parameters!
+        return unless parameters == []
+
+        puts StringUtil.failure('Locale code missing.')
+        puts 'Usage: wti addlocale fr es ...'
+        exit 1
+      end
+
+    end
+
+  end
+
+end

data/lib/web_translate_it/commands/base.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module WebTranslateIt
+
+  module Commands
+
+    class Base
+
+      attr_accessor :configuration, :command_options, :parameters
+
+      def initialize(configuration, command_options, parameters)
+        self.configuration = configuration
+        self.command_options = command_options
+        self.parameters = parameters
+        $stdout.sync = true
+      end
+
+      def call
+        raise NotImplementedError, "#{self.class.name} must implement #call"
+      end
+
+      protected
+
+      def require_parameters!(error:, usage:, min: 0, max: nil)
+        return if parameters.size >= min && (max.nil? || parameters.size <= max)
+
+        puts StringUtil.failure(error)
+        puts "Usage: #{usage}"
+        exit 1
+      end
+
+      def with_connection(&block)
+        WebTranslateIt::Connection.new(configuration.api_key, &block)
+      end
+
+      def run_hook(hook_command, label)
+        return unless hook_command
+
+        output = `#{hook_command}`
+        if $CHILD_STATUS.success?
+          puts output
+        else
+          abort "Error: #{label} command exited with: #{output}"
+        end
+      end
+
+      def warn_unknown_locales(locales)
+        locales.each do |locale|
+          puts "Locale #{locale} doesn't exist -- `wti addlocale #{locale}` to add it." unless configuration.target_locales.include?(locale)
+        end
+        locales
+      end
+
+    end
+
+  end
+
+end

data/lib/web_translate_it/commands/diff.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+
+module WebTranslateIt
+
+  module Commands
+
+    class Diff < Base
+
+      def call
+        complete_success = true
+        with_connection do |conn|
+          complete_success = diff_all_files(conn)
+        end
+        complete_success
+      end
+
+      private
+
+      def diff_all_files(conn)
+        files = select_files
+        if files.empty?
+          puts "Couldn't find any local files registered on WebTranslateIt to diff."
+          return true
+        end
+        files.all? { |file| diff_file(file, conn) }
+      end
+
+      def select_files
+        if parameters.any?
+          configuration.files_for(paths: parameters)
+        else
+          configuration.files_for(locale: configuration.source_locale)
+        end
+      end
+
+      def diff_file(file, conn)
+        return local_missing(file) unless File.exist?(file.file_path)
+
+        remote_content = file.fetch_remote_content(conn)
+        return remote_missing(file) unless remote_content
+
+        run_diff(file, remote_content)
+      end
+
+      def local_missing(file)
+        puts StringUtil.failure("Can't diff #{file.file_path}. File doesn't exist locally.")
+        false
+      end
+
+      def remote_missing(file)
+        puts StringUtil.failure("Couldn't fetch remote file #{file.file_path}")
+        false
+      end
+
+      def run_diff(file, remote_content)
+        Tempfile.create('wti') do |temp_file|
+          temp_file.write(remote_content)
+          temp_file.close
+          puts "Diff for #{file.file_path}:"
+          system "diff #{temp_file.path} #{file.file_path}"
+        end
+        true
+      end
+
+    end
+
+  end
+
+end

data/lib/web_translate_it/commands/init.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module WebTranslateIt
+
+  module Commands
+
+    class Init < Base
+
+      def call
+        puts '# Initializing project'
+        api_key, path = read_parameters
+        ensure_directory_exists(path)
+        project_info = JSON.parse(WebTranslateIt::Project.fetch_info(api_key))['project']
+        write_configuration(path, api_key, project_info)
+        print_success(project_info)
+        true
+      end
+
+      private
+
+      def read_parameters
+        if parameters.any?
+          [parameters[0], '.wti']
+        else
+          [Prompt.ask(' Project API Key:'), Prompt.ask(' Path to configuration file:', '.wti')]
+        end
+      end
+
+      def print_success(project_info)
+        puts ''
+        puts " The project #{project_info['name']} was successfully initialized."
+        puts ''
+        print_setup_hints(project_info)
+        puts 'You can now use `wti` to push and pull your language files.'
+        puts 'Check `wti --help` for help.'
+      end
+
+      def ensure_directory_exists(path)
+        dir = File.dirname(path)
+        FileUtils.mkpath(dir) unless dir == '.'
+      end
+
+      def write_configuration(path, api_key, project_info)
+        if File.exist?(path) && !File.writable?(path)
+          puts StringUtil.failure("Error: `#{path}` file is not writable.")
+          exit 1
+        end
+        File.open(path, 'w') { |file| file << generate_configuration(api_key, project_info) }
+      end
+
+      def print_setup_hints(project_info) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
+        if project_info['source_locale']['code'].nil? || project_info['target_locales'].size <= 1 || project_info['project_files'].none?
+          puts ''
+          puts ' There are a few more things to set up:'
+          puts ''
+        end
+        if project_info['source_locale']['code'].nil?
+          puts " *) You don't have a source locale setup."
+          puts '    Add the source locale with: `wti addlocale <locale_code>`'
+          puts ''
+        end
+        if project_info['target_locales'].size <= 1
+          puts " *) You don't have a target locale setup."
+          puts '    Add the first target locale with: `wti addlocale <locale_code>`'
+          puts ''
+        end
+        return unless project_info['project_files'].none?
+
+        puts " *) You don't have linguistic files setup."
+        puts '    Add a master file with: `wti add <path/to/file.xml>`'
+        puts ''
+      end
+
+      def generate_configuration(api_key, project_info)
+        <<~FILE
+          # Required - The Project API Token from WebTranslateIt.com
+          # More information: https://github.com/webtranslateit/webtranslateit/wiki#configuration-file
+
+          api_key: #{api_key}
+
+          # Optional - Locales not to sync with WebTranslateIt.
+          # Takes a string, a symbol, or an array of string or symbol.
+
+          # ignore_locales: [#{project_info['source_locale']['code']}]
+
+          # Optional - Locales to sync with WebTranslateIt.
+          # Takes a string, a symbol, or an array of string or symbol.
+
+          # needed_locales: #{project_info['target_locales'].map { |locale| locale['code'] }}
+
+          # Optional: files not to sync with WebTranslateIt.
+          # Takes an array of globs.
+
+          # ignore_files: ['somefile*.csv']
+
+          # Optional - Hooks
+          # Takes a string containing a command to run.
+
+          # before_pull: "echo 'some unix command'"   # Command executed before pulling files
+          # after_pull:  "touch tmp/restart.txt"      # Command executed after pulling files
+
+          # before_push: "echo 'some unix command'"   # Command executed before pushing files
+          # after_push:  "touch tmp/restart.txt"      # Command executed after pushing files
+
+        FILE
+      end
+
+    end
+
+  end
+
+end

data/lib/web_translate_it/commands/match.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module WebTranslateIt
+
+  module Commands
+
+    class Match < Base
+
+      def call
+        configuration.files_for(locale: configuration.source_locale).each do |master_file|
+          print_file_status(master_file)
+          configuration.target_files_for(master_file).each do |file|
+            print_file_status(file, prefix: '- ')
+          end
+        end
+        true
+      end
+
+      private
+
+      def print_file_status(file, prefix: '')
+        label = "#{prefix}#{file.file_path} (#{file.locale})"
+        puts File.exist?(file.file_path) ? "#{prefix}#{StringUtil.important(file.file_path)} (#{file.locale})" : StringUtil.failure(label)
+      end
+
+    end
+
+  end
+
+end

data/lib/web_translate_it/commands/mv.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module WebTranslateIt
+
+  module Commands
+
+    class Mv < Base
+
+      def call
+        require_parameters!(
+          min: 2, max: 2,
+          error: 'Error: You must provide the source path and destination path of the master file to move.',
+          usage: 'wti mv path/to/master_file_old_path path/to/master_file_new_path'
+        )
+        source = parameters[0]
+        destination = parameters[1]
+        complete_success = true
+        with_connection do |conn|
+          complete_success = move_file(source, destination, conn)
+        end
+        complete_success
+      end
+
+      private
+
+      def move_file(source, destination, conn)
+        return true unless Prompt.ask_yes_no("Are you sure you want to move the master file #{source} and its target files?", true)
+
+        complete_success = true
+        configuration.files_for(paths: [source]).each do |master_file|
+          upload_and_move_master(master_file, source, destination, conn)
+          delete_old_target_files(master_file)
+          configuration.reload
+          complete_success = fetch_new_target_files(master_file, conn)
+          puts StringUtil.success('All done.') if complete_success
+        end
+        complete_success
+      end
+
+      def upload_and_move_master(master_file, source, destination, conn)
+        result = master_file.upload(conn, force: true, rename_others: true, destination_path: destination)
+        puts StringUtil.array_to_columns(result.output)
+        return unless File.exist?(source)
+
+        File.rename(source, destination)
+        puts StringUtil.success("Moved master file #{master_file.file_path}.")
+      end
+
+      def delete_old_target_files(master_file)
+        configuration.target_files_for(master_file).each do |target_file|
+          FileUtils.rm_f(target_file.file_path)
+        end
+      end
+
+      def fetch_new_target_files(master_file, conn)
+        configuration.target_files_for(master_file).all? do |target_file|
+          result = target_file.fetch(conn)
+          print StringUtil.array_to_columns(result.output)
+          result.success
+        end
+      end
+
+    end
+
+  end
+
+end