ad_localize 4.1.1 → 6.0.0

data/lib/ad_localize/interactors/base_generate_files.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class BaseGenerateFiles
+      def initialize(serializer:)
+        @serializer = serializer
+        raise MissingArgument.new('Missing Serializer') unless serializer
+
+        @file_system_repository = Repositories::FileSystemRepository.new
+      end
+
+      def call(wording:, export_request:)
+        wording.each do |locale, locale_wording|
+          next unless has_wording?(locale_wording: locale_wording)
+
+          path = output_path(locale_wording: locale_wording, export_request: export_request)
+          filename = path.basename
+          LOGGER.debug("[#{locale}] Generating #{filename}")
+          @file_system_repository.create_directory(path: path.dirname)
+          content = @serializer.render(locale_wording: locale_wording)
+          @file_system_repository.write(content: content, path: path)
+          LOGGER.debug("[#{locale}] #{filename} done !")
+        end
+      end
+
+      protected
+
+      def has_wording?(locale_wording:)
+        raise 'override me!'
+      end
+
+      def output_path(locale_wording:, export_request:)
+        raise 'override me!'
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/download_spreadsheets.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class DownloadSpreadsheets
+      def initialize
+        @drive_repository = Repositories::DriveRepository.new
+      end
+
+      def call(export_request:)
+        LOGGER.debug("Downloading spreadsheets")
+        if export_request.export_all
+          @drive_repository.download_all_sheets(spreadsheet_id: export_request.spreadsheet_id)
+        else
+          @drive_repository.download_sheets_by_id(spreadsheet_id: export_request.spreadsheet_id,
+                                                  sheet_ids: export_request.sheet_ids)
+        end
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/export_wording.rb

@@ -1,31 +1,40 @@
+# frozen_string_literal: true
 module AdLocalize
   module Interactors
     class ExportWording
-      def initialize
-        @export_platform_factory = Platforms::ExportPlatformFactory.new
-      end
-
       def call(export_request:, wording:)
-        LOGGER.debug("Starting export wording")
         export_request.platforms.each do |platform|
-          platform_dir = compute_platform_dir(export_request: export_request, platform: platform)
-          export_platform = @export_platform_factory.build(platform: platform)
-          if export_platform.should_export_locale_by_locale?
-            locales = export_request.locales.size.zero? ? wording.locales : wording.locales & export_request.locales
-            locales.each do |locale|
-              export_platform.call(wording: wording, locale: locale, platform_dir: platform_dir)
-            end
-          else
-            export_platform.call(export_request: export_request, platform_dir: platform_dir)
-          end
+          configure_output_directory(platform: platform, export_request: export_request)
+          LOGGER.debug("[#{platform}] Start exporting in #{export_request.output_dir}")
+          export_platform(wording: wording, platform: platform, export_request: export_request)
+          LOGGER.debug("[#{platform}] done !")
         end
       end
 
       private
 
-      def compute_platform_dir(export_request:, platform:)
-        export_request.multiple_platforms? ? export_request.output_path.join(platform.to_s) : export_request.output_path
+      def configure_output_directory(platform:, export_request:)
+        if export_request.many_platforms?
+          export_request.output_dir = export_request.output_path.join(platform)
+        else
+          export_request.output_dir = export_request.output_path
+        end
+      end
+
+      def export_platform(wording:, platform:, export_request:)
+        case platform
+        when Entities::Platform::IOS
+          GenerateIOSFiles.new.call(wording: wording, export_request: export_request)
+        when Entities::Platform::ANDROID
+          GenerateStrings.new.call(wording: wording, export_request: export_request)
+        when Entities::Platform::YML
+          GenerateYAML.new.call(wording: wording, export_request: export_request)
+        when Entities::Platform::JSON
+          GenerateJSON.new.call(wording: wording, export_request: export_request)
+        when Entities::Platform::PROPERTIES
+          GenerateProperties.new.call(wording: wording, export_request: export_request)
+        end
       end
     end
   end
-end
+end

data/lib/ad_localize/interactors/generate_info_plist.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class GenerateInfoPlist < BaseGenerateFiles
+      INFO_PLIST_FILENAME = "InfoPlist.strings".freeze
+      LOCALE_DIRECTORY_CONVENTION = "%{locale}.lproj".freeze
+
+      def initialize
+        super(serializer: Serializers::InfoPlistSerializer.new)
+      end
+
+      private
+
+      def has_wording?(locale_wording:)
+        locale_wording.info_plists.any?
+      end
+
+      def output_path(locale_wording:, export_request:)
+        locale_directory_name = LOCALE_DIRECTORY_CONVENTION % { locale: locale_wording.locale }
+        export_request.output_dir.join(locale_directory_name, INFO_PLIST_FILENAME)
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/generate_ios_files.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class GenerateIOSFiles
+      def call(wording:, export_request:)
+        GenerateInfoPlist.new.call(wording: wording, export_request: export_request)
+        GenerateLocalizableStrings.new.call(wording: wording, export_request: export_request)
+        GenerateLocalizableStringsDict.new.call(wording: wording, export_request: export_request)
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/generate_json.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class GenerateJSON < BaseGenerateFiles
+      def initialize
+        super(serializer: Serializers::JSONSerializer.new)
+      end
+
+      private
+
+      def has_wording?(locale_wording:)
+        locale_wording.singulars.any? || locale_wording.plurals.any?
+      end
+
+      def output_path(locale_wording:, export_request:)
+        export_request.output_dir.join("#{locale_wording.locale}.json")
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/generate_localizable_strings.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class GenerateLocalizableStrings < BaseGenerateFiles
+      LOCALIZABLE_STRINGS_FILENAME = "Localizable.strings".freeze
+      LOCALE_DIRECTORY_CONVENTION = "%{locale}.lproj".freeze
+
+      def initialize
+        super(serializer: Serializers::LocalizableStringsSerializer.new)
+      end
+
+      private
+
+      def has_wording?(locale_wording:)
+        locale_wording.singulars.any?
+      end
+
+      def output_path(locale_wording:, export_request:)
+        locale_directory_name = LOCALE_DIRECTORY_CONVENTION % { locale: locale_wording.locale }
+        export_request.output_dir.join(locale_directory_name, LOCALIZABLE_STRINGS_FILENAME)
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/generate_localizable_strings_dict.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class GenerateLocalizableStringsDict < BaseGenerateFiles
+      LOCALIZABLE_STRINGSDICT_FILENAME = "Localizable.stringsdict".freeze
+      LOCALE_DIRECTORY_CONVENTION = "%{locale}.lproj".freeze
+
+      def initialize
+        super(serializer: Serializers::LocalizableStringsdictSerializer.new)
+      end
+
+      private
+
+      def has_wording?(locale_wording:)
+        locale_wording.plurals.any? || locale_wording.adaptives.any?
+      end
+
+      def output_path(locale_wording:, export_request:)
+        locale_directory_name = LOCALE_DIRECTORY_CONVENTION % { locale: locale_wording.locale }
+        export_request.output_dir.join(locale_directory_name, LOCALIZABLE_STRINGSDICT_FILENAME)
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/generate_properties.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class GenerateProperties < BaseGenerateFiles
+      def initialize
+        super(serializer: Serializers::PropertiesSerializer.new)
+      end
+
+      private
+
+      def has_wording?(locale_wording:)
+        locale_wording.singulars.any?
+      end
+
+      def output_path(locale_wording:, export_request:)
+        export_request.output_dir.join("#{locale_wording.locale}.properties")
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/generate_strings.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class GenerateStrings < BaseGenerateFiles
+      STRINGS_FILENAME = 'strings.xml'.freeze
+      LOCALE_DIRECTORY_CONVENTION = "values".freeze
+
+      def initialize
+        super(serializer: Serializers::StringsSerializer.new)
+      end
+
+      private
+
+      def has_wording?(locale_wording:)
+        locale_wording.singulars.any? || locale_wording.plurals.any?
+      end
+
+      def output_path(locale_wording:, export_request:)
+        locale_dir = LOCALE_DIRECTORY_CONVENTION
+        locale_dir += "-#{locale_wording.locale}" if !locale_wording.is_default
+        export_request.output_dir.join(locale_dir, STRINGS_FILENAME)
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/generate_yaml.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class GenerateYAML < BaseGenerateFiles
+      def initialize
+        super(serializer: Serializers::YAMLSerializer.new)
+      end
+
+      private
+
+      def has_wording?(locale_wording:)
+        locale_wording.singulars.any? || locale_wording.plurals.any?
+      end
+
+      def output_path(locale_wording:, export_request:)
+        export_request.output_dir.join("#{locale_wording.locale}.yml")
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/merge_wordings.rb

@@ -1,13 +1,11 @@
+# frozen_string_literal: true
 module AdLocalize
   module Interactors
     class MergeWordings
       REPLACE_MERGE_POLICY = 'replace'.freeze
       KEEP_MERGE_POLICY = 'keep'.freeze
       MERGE_POLICIES = [KEEP_MERGE_POLICY, REPLACE_MERGE_POLICY]
-
-      def self.valid_policy?(policy:)
-        MERGE_POLICIES.include?(policy)
-      end
+      DEFAULT_POLICY = KEEP_MERGE_POLICY
 
       def call(wordings:, merge_policy:)
         if wordings.size == 1
@@ -20,24 +18,57 @@ module AdLocalize
 
       private
 
+      def merge_simple_wordings(reference_list:, new_list:, merge_policy:)
+        new_list.each do |label, new_translation|
+          translation_reference = reference_list[label]
+          if translation_reference.nil?
+            reference_list[label] = new_translation
+          elsif merge_policy == REPLACE_MERGE_POLICY
+            LOGGER.warn("[MERGE] #{label} value changed from #{translation_reference.value} to #{new_translation.value}")
+            reference_list[label].value = new_translation.value
+          end
+        end
+      end
+
+      def merge_compound_wordings(reference_hash:, new_hash:, merge_policy:)
+        new_hash.each do |new_label, new_list|
+          if reference_hash[new_label].nil?
+            reference_hash[new_label] = new_list
+          elsif merge_policy == REPLACE_MERGE_POLICY
+            merge_simple_wordings(reference_list: reference_hash[new_label], new_list: new_list, merge_policy: merge_policy)
+          end
+        end
+      end
+
       def merge_many(wordings:, merge_policy:)
-        final_wording = wordings.first
+        wording_reference = wordings.first
         wordings[1..-1].each do |wording|
-          wording.locale_wordings.each do |locale_wording|
-            locale_wording_reference = final_wording.translations_for(locale: locale_wording.locale)
-            locale_wording.translations.each do |translation|
-              translation_reference = locale_wording_reference.translation_for(key: translation.key)
-              if translation_reference.present?
-                next unless merge_policy.replace?
-                translation_reference.value = translation.value
-              else
-                locale_wording_reference.add_translation(translation: translation)
-              end
-            end
+          wording.each do |locale, locale_wording|
+            reference = wording_reference[locale]
+            merge_simple_wordings(
+              reference_list: reference.singulars,
+              new_list: locale_wording.singulars,
+              merge_policy: merge_policy
+            )
+            merge_simple_wordings(
+              reference_list: reference.info_plists,
+              new_list: locale_wording.info_plists,
+              merge_policy: merge_policy
+            )
+            merge_compound_wordings(
+              reference_hash: reference.plurals,
+              new_hash: locale_wording.plurals,
+              merge_policy: merge_policy
+            )
+            merge_compound_wordings(
+              reference_hash: reference.adaptives,
+              new_hash: locale_wording.adaptives,
+              merge_policy: merge_policy
+            )
           end
         end
-        final_wording
+        wording_reference
       end
     end
   end
-end
+end

data/lib/ad_localize/interactors/parse_csv_files.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class ParseCSVFiles
+      def initialize
+        @csv_parser = Parsers::CSVParser.new
+      end
+
+      def call(export_request:)
+        csv_paths = export_request.all_csv_paths
+        LOGGER.debug("Will parse #{csv_paths.size} csv files")
+        wordings = csv_paths.filter_map do |csv_path|
+          @csv_parser.call(csv_path: csv_path, export_request: export_request)
+        end
+        LOGGER.debug("#{wordings.size} wording contents detected")
+        return if wordings.blank?
+
+        MergeWordings.new.call(wordings: wordings, merge_policy: export_request.merge_policy)
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/process_export_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class ProcessExportRequest
+      def call(export_request:)
+        export_request.verbose ? LOGGER.debug! : LOGGER.info!
+        LOGGER.debug(export_request)
+        LOGGER.debug("Verify if there are CSV to process")
+        return unless export_request.has_csv_paths?
+
+        LOGGER.debug("Parse CSV files")
+        wording = ParseCSVFiles.new.call(export_request: export_request)
+        return unless wording
+
+        LOGGER.debug("Export wording")
+        ExportWording.new.call(export_request: export_request, wording: wording)
+        LOGGER.debug("End of export request execution")
+      end
+    end
+  end
+end

data/lib/ad_localize/mappers/locale_wording_to_hash.rb

@@ -1,33 +1,54 @@
+# frozen_string_literal: true
 module AdLocalize
   module Mappers
     class LocaleWordingToHash
       def map(locale_wording:)
-        result = locale_wording.translations.each_with_object({}) do |translation, hash|
-          inner_keys = translation.key.label.split('.')
-          inner_keys.each_with_index do |inner_key, index|
-            if index === inner_keys.count - 1
-              if translation.key.plural?
-                hash[translation.key.label] = {} unless hash.key? translation.key.label
-                hash[translation.key.label][translation.key.plural_key] = translation.value
-              else
-                unless hash.is_a?(Hash)
-                  LOGGER.warn "Corrupted input. Trying to insert a value for key '#{translation.key.label}' but a value already exists for '#{inner_keys[0..index-1].join(".")}'. Skipping."
-                  break # skip this corrupted key
-                end
-                previous_value = hash[inner_key.to_s]
-                if !previous_value.blank? && previous_value.is_a?(Hash)
-                  LOGGER.warn "Corrupted input. Trying to insert a value for key '#{translation.key.label}' but values already exist for keys '#{translation.key.label}.*'. Previous values will be lost."
-                end
-                hash[inner_key.to_s] = translation.value
-              end
-            else
-              hash[inner_key] = {} if hash[inner_key].nil?
-              hash = hash[inner_key]
-            end
+        singulars_hash = map_singulars(simple_wordings: locale_wording.singulars.values)
+        plural_hash = map_plurals(coumpound_wordings: locale_wording.plurals)
+        locale_hash = singulars_hash.merge(plural_hash)
+        { locale_wording.locale => locale_hash }
+      end
+
+      private
+
+      def inner_keys(label:)
+        label.split('.')
+      end
+
+      def map_singulars(simple_wordings:)
+        map_translations(translations: simple_wordings) do |inner_keys, translation|
+          dotted_key_to_hash(inner_keys, { inner_keys.pop => translation.value })
+        end
+      end
+
+      def map_plurals(coumpound_wordings:)
+        result = {}
+        coumpound_wordings.each do |label, simple_wordings|
+          variants_hash = map_translations(translations: simple_wordings.values) do |keys, translation|
+            dotted_key_to_hash(keys, { translation.key.variant_name => translation.value })
           end
+          result.deep_merge!(variants_hash)
+        end
+        result
+      end
+
+      def map_translations(translations:)
+        translations.each_with_object({}) do |translation, hash|
+          keys = inner_keys(label: translation.key.label)
+          inner_keys_hash = yield(keys, translation)
+          hash.deep_merge!(inner_keys_hash)
+        end
+      end
+
+      def dotted_key_to_hash(array, h)
+        if array.size.zero?
+          h
+        elsif array.size == 1
+          { array.first => h }
+        elsif array.size > 1
+          { array.first => dotted_key_to_hash(array[1..-1], h) }
         end
-        { locale_wording.locale => result }
       end
     end
   end
-end
+end

data/lib/ad_localize/mappers/options_to_export_request.rb

@@ -1,28 +1,21 @@
+# frozen_string_literal: true
 module AdLocalize
   module Mappers
     class OptionsToExportRequest
       def map(options:)
-        Requests::ExportRequest.new(
-          platforms: options[:only],
-          g_spreadsheet_options: map_g_spreadsheet_options(options: options),
-          verbose: options[:debug],
-          output_path: options[:'target-dir'],
-          merge_policy: options[:'merge-policy'],
-          csv_paths: options[:csv_paths]
-        )
-      end
-
-      private
-
-      def map_g_spreadsheet_options(options:)
-        return unless options[:'drive-key']
-        Requests::GSpreadsheetOptions.new(
-          spreadsheet_id: options[:'drive-key'],
-          sheet_ids: options[:'sheets'],
-          export_all: options[:'export-all-sheets'],
-          service_account_config: ENV['GCLOUD_CLIENT_SECRET']
-        )
+        request = Requests::ExportRequest.new
+        request.locales = options[:locales]
+        request.bypass_empty_values = options[:'non-empty-values']
+        request.csv_paths = options[:csv_paths]
+        request.merge_policy = options[:'merge-policy']
+        request.output_path = options[:'target-dir']
+        request.platforms = options[:only]
+        request.spreadsheet_id = options[:'drive-key']
+        request.sheet_ids = options[:sheets]
+        request.export_all = options[:'export-all-sheets']
+        request.verbose = options[:debug]
+        request
       end
     end
   end
-end
+end

data/lib/ad_localize/option_handler.rb

@@ -1,38 +1,62 @@
+# frozen_string_literal: true
 module AdLocalize
   class OptionHandler
+    DEFAULT_OPTIONS = {
+      locales: Requests::ExportRequest::DEFAULTS[:locales],
+      :'non-empty-values' => Requests::ExportRequest::DEFAULTS[:bypass_empty_values],
+      csv_paths: Requests::ExportRequest::DEFAULTS[:csv_paths],
+      :'merge-policy' => Requests::ExportRequest::DEFAULTS[:merge_policy],
+      :'target-dir' => Requests::ExportRequest::DEFAULTS[:output_path],
+      :'drive-key' => Requests::ExportRequest::DEFAULTS[:spreadsheet_id],
+      sheets: Requests::ExportRequest::DEFAULTS[:sheet_ids],
+      :'export-all-sheets' => Requests::ExportRequest::DEFAULTS[:export_all],
+      debug: Requests::ExportRequest::DEFAULTS[:verbose],
+      only: Requests::ExportRequest::DEFAULTS[:platforms]
+    }
+
     def self.parse!(options)
-      option_parser = OptionParser.new do |parser|
-        parser.banner = "Usage: exe/ad_localize [options] file(s)"
+      args = DEFAULT_OPTIONS
+      export_all_option = <<~DOC
+        Export all sheets from spreadsheet specified by --drive-key option.
+        \tBy default, generates one export directory per sheet (see -m|--merge-sheets option to merge them).
+        \tAn GCLOUD_CLIENT_SECRET environment variable containing the client_secret.json content is needed.
+      DOC
+      merge_policy_option = <<~DOC
+        Merge specified csv (or sheets from --export-all) instead of exporting each csv.
+        \treplace: if a key is already defined, replace its value.
+        \tkeep: if a key is already defined, keep the previous value.
+      DOC
+      platforms_option = <<~DOC
+        PLATFORMS is a comma separated list.
+        \tOnly generate localisation files for the specified platforms.
+        \tSupported platforms : #{Entities::Platform::SUPPORTED_PLATFORMS.to_sentence}
+      DOC
 
-        parser.on("-d", "--debug", TrueClass, "Run in debug mode")
-        parser.on("-e", "--export-all-sheets", TrueClass,
-                  <<~DOC
-                    Export all sheets from spreadsheet specified by --drive-key option.
-                    \tBy default, generates one export directory per sheet (see -m|--merge-sheets option to merge them).
-                    \tAn GCLOUD_CLIENT_SECRET environment variable containing the client_secret.json content is needed.
-        DOC
-        )
-        parser.on("-h", "--help", "Prints help") do
+      OptionParser.new do |parser|
+        parser.banner = 'Usage: exe/ad_localize [options] file(s)'
+        parser.on("-d", "--debug", TrueClass, 'Run in debug mode')
+        parser.on("-e", "--export-all-sheets", TrueClass, export_all_option)
+        parser.on("-h", "--help", 'Prints help') do
           puts parser
           exit
         end
-        parser.on("-k", "--drive-key SPREADSHEET_ID", String, "Use google drive spreadsheets")
-        parser.on("-m", "--merge-policy POLICY", String,
-                  <<~DOC
-                    Merge specified csv (or sheets from --export-all) instead of exporting each csv.
-                    \treplace: if a key is already defined, replace its value.
-                    \tkeep: if a key is already defined, keep the previous value.
-        DOC
-        )
-        parser.on("-o", "--only PLATFORMS", Array, "PLATFORMS is a comma separated list. Only generate localisation files for the specified platforms. Supported platforms : #{Requests::ExportRequest::SUPPORTED_PLATFORMS.to_sentence}")
-        parser.on("-s", "--sheets SHEET_IDS", Array, "SHEET_IDS is a comma separated list. Use a specific sheet id for Google Drive spreadsheets with several sheets")
-        parser.on("-t", "--target-dir PATH", String, "Path to the target directory")
-      end
+        parser.on("-k", "--drive-key SPREADSHEET_ID", String, 'Use google drive spreadsheets')
+        parser.on("-l", "--locales LOCALES", Array,
+                  'LOCALES is a comma separated list. Only generate localisation files for the specified locales')
+        parser.on("-m", "--merge-policy POLICY", Interactors::MergeWordings::MERGE_POLICIES, merge_policy_option)
+        parser.on("-o", "--only PLATFORMS", Array, platforms_option)
+        parser.on("-s", "--sheets SHEET_IDS", Array,
+                  'SHEET_IDS is a comma separated list. Use a specific sheet id for Google Drive spreadsheets with several sheets')
+        parser.on("-t", "--target-dir PATH", String, 'Path to the target directory')
+        parser.on("-v", "--version", 'Prints current version') do
+          puts AdLocalize::VERSION
+          exit
+        end
+        parser.on("-x", "--non-empty-values", TrueClass, 'Do not export keys with empty values (iOS only)')
+      end.parse!(options, into: args)
 
-      args = {}
-      option_parser.parse!(options, into: args)
       args[:csv_paths] = options
       return args
     end
   end
-end
+end