phraseapp_updater 3.2.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e8639a81e55d83a36d03854f2c970737ee9754266e629ef2bad1d9e65c53826
-  data.tar.gz: '078928d80c10deb59f9a293fbd7135a2d9b4b52479809985b5c4cf9835332131'
+  metadata.gz: 5d137755330d9711327e6731a7b4ae1fc701ec705ce719055bca7479dcd3579a
+  data.tar.gz: ab2839920b873ed264759eadf926d6b9df837b511b163f1f18e4ef777bcfc820
 SHA512:
-  metadata.gz: 1e2927b0dc2e87ba9ec5c64c8d0393a58624ce7e754183d556e1e165bb51fed61e0cac138a8e9bb9b46e2f97b74628ff75e2d24190fad30a68a1124d1425dee9
-  data.tar.gz: 23f2339b569cbe5f6237d1f23c89259153ac80c79830a02861ec740c5c077384a8794aadad4d462fca4d95e46c04e4b145aff09f1bf5d1bc89c1b8f44e38f805
+  metadata.gz: afe9e8266f248e39c52095a762a64a9e1823bf94f825a4cbe7d166946892cd1c171252d2218b3dce0c47c6dd6e4cfe224c826a5ffea812d8f3011f07991c5034
+  data.tar.gz: ba81fe027f6016fc759e72b5cf27c88e1c31ca7e08e1580dd4c5b110ecaa83dcd6f603ec686978b21071fbb5bc9e02e5967e32a1a102612a5a16448094c3158a

data/bin/phraseapp_updater

@@ -9,6 +9,14 @@ class PhraseAppUpdaterCLI < Thor
   class_option :file_format,    type: :string, default: 'json', desc: 'Filetype of localization files.'
   class_option :verbose,        type: :boolean, default: false, desc: 'Verbose output'
 
+  # Options that mirror the PhraseApp API (https://developers.phrase.com/api/#post-/projects)
+  PHRASEAPP_CREATE_PROJECT_OPTIONS = {
+    zero_plural_form_enabled: {
+      type: :boolean,
+      desc: 'Displays the input fields for the \'ZERO\' plural form for every key as well although only some languages require the \'ZERO\' explicitly.'
+    },
+  }
+
   desc 'setup <locale_path>',
        'Create a new PhraseApp project, initializing it with locale files at <locale_path>. the new project ID is printed to STDOUT'
   method_option :phraseapp_api_key,      type: :string, required: true, desc: 'PhraseApp API key.'
@@ -16,16 +24,23 @@ class PhraseAppUpdaterCLI < Thor
   method_option :parent_commit,          type: :string, required: true, desc: 'git commit hash of initial locales'
   method_option :remove_orphans,         type: :boolean, default: true, desc: 'Remove keys not in the uploaded default locale'
 
+  PHRASEAPP_CREATE_PROJECT_OPTIONS.each do |name, params|
+    method_option(name, **params)
+  end
+
   def setup(locales_path)
     validate_readable_path!('locales', locales_path)
 
     handle_errors do
+      phraseapp_opts = options.slice(*PHRASEAPP_CREATE_PROJECT_OPTIONS.keys)
+
       updater, project_id = PhraseAppUpdater.for_new_project(
                  options[:phraseapp_api_key],
                  options[:phraseapp_project_name],
                  options[:file_format],
                  options[:parent_commit],
-                 verbose: options[:verbose])
+                 verbose: options[:verbose],
+                 **phraseapp_opts)
 
       updater.upload_directory(locales_path, remove_orphans: options[:remove_orphans])
 

data/lib/phraseapp_updater/phraseapp_api.rb

@@ -4,6 +4,7 @@ require 'phraseapp_updater/locale_file'
 require 'phraseapp_updater/index_by'
 require 'uri'
 require 'phrase'
+require 'concurrent'
 require 'parallel'
 require 'tempfile'
 
@@ -25,10 +26,15 @@ class PhraseAppUpdater
       @locale_file_class = locale_file_class
     end
 
-    def create_project(name, parent_commit)
+    # @param [Hash] opts Options to be passed to the {https://developers.phrase.com/api/#post-/projects PhraseApp API}
+    def create_project(name, parent_commit, **opts)
       params = Phrase::ProjectCreateParameters.new(
-        name: name,
-        main_format: @locale_file_class.phraseapp_type)
+        # Merges name and main_format into opts to prevent overriding these properties
+        opts.merge(
+          name: name,
+          main_format: @locale_file_class.phraseapp_type
+        )
+      )
 
       project = phraseapp_request(Phrase::ProjectsApi, :project_create, params)
 
@@ -91,38 +97,60 @@ class PhraseAppUpdater
       end
     end
 
-    # Empirically, PhraseApp fails to parse the uploaded files when uploaded in
-    # parallel. Give it a better chance by uploading them one at a time.
     def upload_files(locale_files, default_locale:)
-      is_default = ->(l) { l.locale_name == default_locale }
+      locale_files = locale_files.sort_by(&:locale_name)
+      default_locale_file = locale_files.detect { |l| l.locale_name == default_locale }
+      locale_files.delete(default_locale_file) if default_locale_file
 
-      # Ensure the locales all exist
-      STDERR.puts('Creating locales')
       known_locales = fetch_locales.index_by(&:name)
+
+      # Phraseapp appears to use to use the first file uploaded to resolve conflicts
+      # between pluralized and non-pluralized keys. Upload and verify the canonical
+      # default locale first before uploading translated locales.
+      if default_locale_file
+        unless known_locales.has_key?(default_locale_file.locale_name)
+          STDERR.puts("Creating default locale (#{default_locale_file})")
+          create_locale(default_locale_file.locale_name, default: true)
+        end
+
+        STDERR.puts("Uploading default locale (#{default_locale_file})")
+        upload_id = upload_file(default_locale_file)
+
+        successful_default_upload = verify_uploads({ upload_id => default_locale_file })
+      else
+        STDERR.puts("No upload for default locale (#{default_locale})")
+      end
+
+      # Ensure the locales all exist
+      STDERR.puts('Creating translation locales')
       threaded_request(locale_files) do |locale_file|
         unless known_locales.has_key?(locale_file.locale_name)
-          create_locale(locale_file.locale_name, default: is_default.(locale_file))
+          create_locale(locale_file.locale_name, default: false)
         end
       end
 
-      # Upload the files in a stable order, ensuring the default locale is first.
-      locale_files.sort! do |a, b|
-        next -1 if is_default.(a)
-        next 1  if is_default.(b)
+      uploads = Concurrent::Hash.new
 
-        a.locale_name <=> b.locale_name
+      threaded_request(locale_files) do |locale_file|
+        STDERR.puts("Uploading #{locale_file}")
+        upload_id = upload_file(locale_file)
+        uploads[upload_id] = locale_file
       end
 
-      uploads = {}
+      successful_uploads = verify_uploads(uploads)
 
-      uploads = locale_files.to_h do |locale_file|
-        STDERR.puts("Uploading #{locale_file}")
-        upload_id = upload_file(locale_file)
-        [upload_id, locale_file]
+      if default_locale_file
+        successful_uploads = successful_uploads.merge(successful_default_upload)
       end
 
-      # Validate the uploads, retrying failures as necessary
-      successful_upload_ids = {}
+      successful_uploads
+    end
+
+    # Given a map of {upload_id => locale_file} pairs, use the upload_show
+    # API to verify that they're complete, and re-upload them if they failed.
+    # Return a map of locale name to upload id.
+    def verify_uploads(uploads)
+      successful_upload_ids = Concurrent::Hash.new
 
       STDERR.puts('Verifying uploads...')
       until uploads.empty?
@@ -152,6 +180,7 @@ class PhraseAppUpdater
       successful_upload_ids
     end
 
+
     def remove_keys_not_in_uploads(upload_ids)
       threaded_request(upload_ids) do |upload_id|
         STDERR.puts "Removing keys not in upload #{upload_id}"

data/lib/phraseapp_updater/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class PhraseAppUpdater
-  VERSION = '3.2.0'
+  VERSION = '3.3.1'
 end

data/lib/phraseapp_updater.rb

@@ -10,9 +10,9 @@ require 'phraseapp_updater/yml_config_loader'
 class PhraseAppUpdater
   using IndexBy
 
-  def self.for_new_project(phraseapp_api_key, phraseapp_project_name, file_format, parent_commit, verbose: false)
+  def self.for_new_project(phraseapp_api_key, phraseapp_project_name, file_format, parent_commit, verbose: false, **phraseapp_opts)
     api = PhraseAppAPI.new(phraseapp_api_key, nil, LocaleFile.class_for_file_format(file_format))
-    project_id = api.create_project(phraseapp_project_name, parent_commit)
+    project_id = api.create_project(phraseapp_project_name, parent_commit, **phraseapp_opts)
     return self.new(phraseapp_api_key, project_id, file_format, verbose: verbose), project_id
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phraseapp_updater
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.1
 platform: ruby
 authors:
 - iKnow Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-04 00:00:00.000000000 Z
+date: 2024-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.23'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -193,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: A three-way differ for PhraseApp projects.