phraseapp_updater 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fda2274698391255a06511a13c2ee32f163986e
-  data.tar.gz: 7d8e53efb3379ca73721762d61ae3382d9c4179d
+  metadata.gz: 1b4b5ca69acb3ee2e8aa1b40c1325872ac307c50
+  data.tar.gz: 0f1e8961e0e35908ab8c8094ee845a9d71c8badf
 SHA512:
-  metadata.gz: 2813702a946d84e7fcb926b9ddf8e4accd6c9fd2c18ca678d389b8e953759cd041c7b09248da8d51f7032b113aa7208ae15d580f23223afb4dc518d78b6cce09
-  data.tar.gz: 67d9a874fc97e09018e464ade886851a4c32b63d05ebc8c90da46be5b4179d4368130c1bd0c23bec91c1b7cebb9f0d2699ffe44bd359dccdae1e14a51fc2e7c8
+  metadata.gz: 70c04afe5d8a011e3f7d68872f82bfa7a67150c6868d29f2b7b2a0990647a9496a92165c1d44f7753ec72b59b4fd5649f0e93b41ca68c8041829f830033d3715
+  data.tar.gz: b6880095d635a3b72dade7bbe19ea363b6c1fb38db91cae84f230e307f34f9f7757e6b9a3bfdcdeeb208a36f3d8689705f5bc58211916bf1f68df44db5c60720

data/README.markdown

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/iknow/phraseapp_updater.svg?branch=master)](https://travis-ci.org/iknow/phraseapp_updater)
 
-**Version** 0.1.3
+**Version** 0.1.4
 
 This is a tool for merging PhraseApp locale data with locale data
 committed in your project.

data/bin/phraseapp_updater

@@ -28,7 +28,7 @@ class PhraseAppUpdaterCLI < Thor
     validate_writable_path!('store_phraseapp_originals_path', store_phraseapp_originals_path)
 
     begin
-      result = PhraseAppUpdater.push(phraseapp_api_key, phraseapp_project_id, previous_locales_path, new_locales_path)
+      result = PhraseAppUpdater.new(phraseapp_api_key, phraseapp_project_id).push(previous_locales_path, new_locales_path)
 
       unless store_results_path.empty?
         write_locale_files(store_results_path, result.resolved_files)
@@ -65,18 +65,31 @@ class PhraseAppUpdaterCLI < Thor
     validate_writable_path!('destination_path', destination_path)
 
     begin
-      files = PhraseAppUpdater.pull(phraseapp_api_key, phraseapp_project_id, fallback_path)
+      files = PhraseAppUpdater.new(phraseapp_api_key, phraseapp_project_id).pull(fallback_path)
       write_locale_files(destination_path, files)
     rescue PhraseAppUpdater::PhraseAppAPI::BadAPIKeyError => e
       puts "Bad PhraseApp API key."
     rescue PhraseAppUpdater::PhraseAppAPI::BadProjectIDError => e
       puts "Bad PhraseApp project ID: #{phraseapp_project_id}"
     rescue StandardError => e
-      puts "Unknown error when pushing files"
+      puts "Unknown error when pulling files"
       raise e
     end
   end
 
+  desc "default", "Prints gem information"
+  option :version, aliases: [:v]
+
+  def default
+    if options[:v] || options[:version]
+      puts PhraseAppUpdater::VERSION
+    else
+      help
+    end
+  end
+
+  default_command :default
+
   private
 
   def load_phraseapp_credentials(options)

data/lib/phraseapp_updater.rb

@@ -9,12 +9,23 @@ require 'phraseapp_updater/yml_config_loader'
 class PhraseAppUpdater
   using IndexBy
 
-  def self.push(phraseapp_api_key, phraseapp_project_id, previous_locales_path, new_locales_path)
-    phraseapp_api         = PhraseAppAPI.new(phraseapp_api_key, phraseapp_project_id)
-    phraseapp_locales     = phraseapp_api.download_locales
+  def initialize(phraseapp_api_key, phraseapp_project_id)
+    @phraseapp_api = PhraseAppAPI.new(phraseapp_api_key, phraseapp_project_id)
+  end
+
+  def self.load_config(config_file_path)
+    YMLConfigLoader.new(config_file_path)
+  end
+
+  def push(previous_locales_path, new_locales_path)
+    phraseapp_locales = @phraseapp_api.download_locales
 
-    phraseapp_files, (previous_locale_files, new_locale_files) =
-      load_files(phraseapp_api, phraseapp_locales, false, previous_locales_path, new_locales_path)
+    phraseapp_files = load_phraseapp_files(phraseapp_locales, false)
+
+    (previous_locale_files, new_locale_files) =
+      load_locale_files(previous_locales_path, new_locales_path)
+
+    validate_files!([phraseapp_files, previous_locale_files, new_locale_files])
 
     new_locale_files = new_locale_files.index_by(&:name)
     phraseapp_files  = phraseapp_files.index_by(&:name)
@@ -45,39 +56,45 @@ class PhraseAppUpdater
       file.parsed_content != phraseapp_files[file.name].parsed_content
     end
 
-    upload_ids = phraseapp_api.upload_files(changed_files)
-    phraseapp_api.remove_keys_not_in_uploads(upload_ids)
+    upload_ids = @phraseapp_api.upload_files(changed_files)
+    @phraseapp_api.remove_keys_not_in_uploads(upload_ids)
 
     puts "Uploading #{default_locale_file}"
-    upload_id = phraseapp_api.upload_file(default_locale_file)
+    upload_id = @phraseapp_api.upload_file(default_locale_file)
 
     puts "Removing keys not in upload #{upload_id}"
-    phraseapp_api.remove_keys_not_in_upload(upload_id)
+    @phraseapp_api.remove_keys_not_in_upload(upload_id)
 
     LocaleFileUpdates.new(phraseapp_files.values, [default_locale_file] + resolved_files)
   end
 
-  def self.pull(phraseapp_api_key, phraseapp_project_id, fallback_locales_path)
-    phraseapp_api         = PhraseAppAPI.new(phraseapp_api_key, phraseapp_project_id)
-    phraseapp_locales     = phraseapp_api.download_locales
+  def pull(fallback_locales_path)
+    phraseapp_locales = @phraseapp_api.download_locales
+
+    phraseapp_files_without_unverified = load_phraseapp_files(phraseapp_locales, true)
+    phraseapp_files_with_unverified    = load_phraseapp_files(phraseapp_locales, false)
+    fallback_files                     = load_locale_files(fallback_locales_path).first
 
-    phraseapp_files, (fallback_files,) =
-      load_files(phraseapp_api, phraseapp_locales, true, fallback_locales_path)
+    validate_files!([phraseapp_files_with_unverified, phraseapp_files_without_unverified, fallback_files])
 
-    fallback_files = fallback_files.index_by(&:name)
+    phraseapp_files_with_unverified = phraseapp_files_with_unverified.index_by(&:name)
+    fallback_files                  = fallback_files.index_by(&:name)
 
-    phraseapp_files.map do |phraseapp_file|
-      new_content = Differ.restore_deletions(phraseapp_file.parsed_content,
-                                             fallback_files[phraseapp_file.name].parsed_content)
-      LocaleFile.from_hash(phraseapp_file.name, new_content)
+    # Clean empty strings from the data and merge the fallback data in:
+    # we want to replace unverified keys with their values in the fallback
+    phraseapp_files_without_unverified.map do |phraseapp_without_unverified_file|
+      without_unverified = clear_empty_strings!(phraseapp_without_unverified_file.parsed_content)
+      with_unverified    = clear_empty_strings!(phraseapp_files_with_unverified[phraseapp_without_unverified_file.name].parsed_content)
+      fallback           = clear_empty_strings!(fallback_files[phraseapp_without_unverified_file.name].parsed_content)
+
+      restore_unverified_originals!(fallback, with_unverified, without_unverified)
+      LocaleFile.from_hash(phraseapp_without_unverified_file.name, without_unverified)
     end
   end
 
-  def self.load_config(config_file_path)
-    YMLConfigLoader.new(config_file_path)
-  end
+  private
 
-  def self.find_default_locale_file(locales, files)
+  def find_default_locale_file(locales, files)
     default_locale = locales.find(&:default?)
 
     default_locale_file = files.find do |file|
@@ -85,14 +102,18 @@ class PhraseAppUpdater
     end
   end
 
-  def self.load_files(phraseapp_api, phraseapp_locales, skip_unverified, *paths)
-    file_groups = paths.map do |path|
-       LocaleFileLoader.filenames(path).map { |l| LocaleFileLoader.load(l) }
-    end
+  def load_phraseapp_files(phraseapp_locales, skip_unverified)
+    @phraseapp_api.download_files(phraseapp_locales, skip_unverified)
+  end
 
-    phraseapp_files = phraseapp_api.download_files(phraseapp_locales, skip_unverified)
+  def load_locale_files(*paths)
+    paths.map do |path|
+      LocaleFileLoader.filenames(path).map { |l| LocaleFileLoader.load(l) }
+    end
+  end
 
-    file_name_lists = [*file_groups, phraseapp_files].map do |files|
+  def validate_files!(file_groups)
+    file_name_lists = file_groups.map do |files|
       files.map(&:name).to_set
     end
 
@@ -102,8 +123,43 @@ class PhraseAppUpdater
       or removing langauges: #{file_name_lists}"
       raise RuntimeError.new(message)
     end
+  end
 
-    return [phraseapp_files, file_groups]
+  # Mutates without_verified to include the fallbacks where needed.
+  #
+  # For any keys in both `with_unverified` and `originals` but not present in
+  # `without_unverified`, restore the version from `originals` to
+  # `without_unverified`
+  def restore_unverified_originals!(fallback, with_unverified, without_unverified)
+    fallback.each do |key, value|
+      with_value = with_unverified[key]
+
+      case value
+      when Hash
+        if with_value.is_a?(Hash)
+          without_value = (without_unverified[key] ||= {})
+          restore_unverified_originals!(value, with_value, without_value)
+        end
+      else
+        if with_value && !with_value.is_a?(Hash) && !without_unverified.has_key?(key)
+          without_unverified[key] = value
+        end
+      end
+    end
+  end
+
+  def clear_empty_strings!(hash)
+    hash.delete_if do |key, value|
+      if value == ""
+        true
+      elsif value.is_a?(Hash)
+        clear_empty_strings!(value)
+        value.empty?
+      else
+        false
+      end
+    end
+    hash
   end
 
   class LocaleFileUpdates

data/lib/phraseapp_updater/version.rb

@@ -1,3 +1,3 @@
 class PhraseAppUpdater
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phraseapp_updater
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Kevin Griffin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-17 00:00:00.000000000 Z
+date: 2017-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor