phraseapp_updater 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f33deb3a77a37a47abdf44c354526cbe3ad3d10256bb2a046bf48922178187fd
-  data.tar.gz: f22f2ceed18653b09c24be4724707cdc40c39539535c226fd028bc03338437cd
+  metadata.gz: f010eea4d5b1504c18facc0756b88021d87d207b7942ad66b30aee3800fbb82f
+  data.tar.gz: c1e0d6146fbadda3d36bcc622e8889de17072be9c5172e71c3a9545854f956be
 SHA512:
-  metadata.gz: 822cc67247e2e2752397127f6b4e5e0d893cdfc3c64a29f14067d2bc5b6e131f3924d5cad982960df65da4b47971c12ad43fc9caf9c9ff15e756a596a64c163e
-  data.tar.gz: a2e1152e1a376690722722d73c2654d4ab4e417530b66b86f7562cd0b17e54f06976a295bae601ec0d4ed1e8570a518eef9a37ff317f24001643e711c0365e6c
+  metadata.gz: aac0c0be65646c83f608fca0ab7f5b45cdc0d7c0f58cf11eab1efbe714b709557a76de7082062c213d415f7153482fbeca3311c3a6a3152e0e6c10d012781c3d
+  data.tar.gz: 29fd576ce2a3fb249689a01f3d648b5e7f80992f7a55f702ed802054d5b8419ae4b8bb0ae4d1bd1d4782c7c031d9e72d5a2cdb70e17051b8dbc896c666ba95f3

data/bin/phraseapp_updater

@@ -14,6 +14,7 @@ class PhraseAppUpdaterCLI < Thor
   method_option :phraseapp_api_key,      type: :string, required: true, desc: 'PhraseApp API key.'
   method_option :phraseapp_project_name, type: :string, required: true, desc: 'Name for new PhraseApp project.'
   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'
 
   def setup(locales_path)
     validate_readable_path!('locales', locales_path)
@@ -26,7 +27,7 @@ class PhraseAppUpdaterCLI < Thor
                  options[:parent_commit],
                  verbose: options[:verbose])
 
-      updater.upload_directory(locales_path)
+      updater.upload_directory(locales_path, remove_orphans: options[:remove_orphans])
 
       puts project_id
     end
@@ -104,6 +105,7 @@ class PhraseAppUpdaterCLI < Thor
   method_option :phraseapp_api_key,    type: :string, required: true, desc: 'PhraseApp API key.'
   method_option :phraseapp_project_id, type: :string, required: true, desc: 'PhraseApp project ID.'
   method_option :parent_commit,        type: :string, required: true, desc: 'git commit hash of locales being uploaded'
+  method_option :remove_orphans,       type: :boolean, default: true, desc: 'Remove keys not in the uploaded default locale'
 
   def upload(source_path)
     validate_readable_path!('source path', source_path)
@@ -115,7 +117,7 @@ class PhraseAppUpdaterCLI < Thor
         options[:file_format],
         verbose: options[:verbose])
 
-      updater.upload_directory(source_path)
+      updater.upload_directory(source_path, remove_orphans: options[:remove_orphans])
       updater.update_parent_commit(options[:parent_commit])
     end
   end
@@ -162,6 +164,23 @@ class PhraseAppUpdaterCLI < Thor
     end
   end
 
+  desc 'normalize <source_path> <destination_path>',
+       'Normalize the locale directory at <source_path> into <destination_path>.'
+
+  long_desc <<-LONGDESC
+    Read, normalize, then write out the locales in <source_path> into <destination_path>.
+  LONGDESC
+
+  def normalize(source_path, destination_path)
+    validate_readable_path!('source_path', source_path)
+    validate_writable_path!('destination_path', destination_path)
+
+    handle_errors do
+      updater = PhraseAppUpdater.new(nil, nil, options[:file_format], verbose: options[:verbose])
+      updater.normalize_directory(source_path, destination_path)
+    end
+  end
+
   desc 'merge <ancestor_path> <our_path> <their_path>',
        '3-way merge locale file directories <ancestor_path>, <our_path>, <their_path> into TO.'
 

data/lib/phraseapp_updater/phraseapp_api.rb

@@ -41,7 +41,7 @@ class PhraseAppUpdater
     end
 
     def lookup_project_id(name)
-      result, = paginated_request(Phrase::ProjectsApi, :projects_list, { per_page: PAGE_SIZE }, limit: 1) { |p| p.name == name }
+      result, = paginated_request(Phrase::ProjectsApi, :projects_list, per_page: PAGE_SIZE, limit: 1) { |p| p.name == name }
 
       raise ProjectNotFoundError.new(name) if result.nil?
 

data/lib/phraseapp_updater/version.rb

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

data/lib/phraseapp_updater.rb

@@ -52,9 +52,9 @@ class PhraseAppUpdater
     write_locale_file(result, result_file)
   end
 
-  def upload_directory(path)
+  def upload_directory(path, remove_orphans: true)
     locales = load_locale_directory(path)
-    upload_locale_files(locales)
+    upload_locale_files(locales, remove_orphans: remove_orphans)
   end
 
   def download_to_directory(path)
@@ -62,6 +62,11 @@ class PhraseAppUpdater
     write_locale_directory(path, locale_files)
   end
 
+  def normalize_directory(source, destination)
+    locales = load_locale_directory(source)
+    write_locale_directory(destination, locales)
+  end
+
   def update_parent_commit(parent_commit)
     @phraseapp_api.update_parent_commit(parent_commit)
   end
@@ -98,7 +103,7 @@ class PhraseAppUpdater
     end
   end
 
-  def upload_locale_files(locale_files)
+  def upload_locale_files(locale_files, remove_orphans: true)
     # We assert that the default locale contains all legitimate strings, and so
     # we clean up orphaned content on PhraseApp post-upload by removing keys not
     # in the default locale.
@@ -109,8 +114,10 @@ class PhraseAppUpdater
     upload_ids = @phraseapp_api.upload_files(locale_files, default_locale: @default_locale)
     default_upload_id = upload_ids.fetch(@default_locale)
 
-    STDERR.puts "Removing keys not in default locale '#{@default_locale}' upload '#{default_upload_id}'"
-    @phraseapp_api.remove_keys_not_in_upload(default_upload_id)
+    if remove_orphans
+      STDERR.puts "Removing keys not in default locale '#{@default_locale}' upload '#{default_upload_id}'"
+      @phraseapp_api.remove_keys_not_in_upload(default_upload_id)
+    end
   end
 
   def download_locale_files

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phraseapp_updater
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - iKnow Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-20 00:00:00.000000000 Z
+date: 2023-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor