ad_localize 3.6.0 → 4.0.0

data/lib/ad_localize/interactors/export_wording.rb

@@ -0,0 +1,27 @@
+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")
+        locales = export_request.locales.size.zero? ? wording.locales : wording.locales & export_request.locales
+        export_request.platforms.each do |platform|
+          locales.each do |locale|
+            platform_dir = compute_platform_dir(export_request: export_request, platform: platform)
+            export_platform = @export_platform_factory.build(platform: platform)
+            export_platform.call(wording: wording, locale: locale, platform_dir: platform_dir)
+          end
+        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
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/merge_wordings.rb

@@ -0,0 +1,43 @@
+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
+
+      def call(wordings:, merge_policy:)
+        if wordings.size == 1
+          wordings.first
+        elsif wordings.size > 1
+          LOGGER.debug("Merge wordings before processing")
+          merge_many(wordings: wordings, merge_policy: merge_policy)
+        end
+      end
+
+      private
+
+      def merge_many(wordings:, merge_policy:)
+        final_wording = 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
+          end
+        end
+        final_wording
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/platforms/export_android_locale_wording.rb

@@ -0,0 +1,39 @@
+module AdLocalize
+  module Interactors
+    module Platforms
+      class ExportAndroidLocaleWording
+        STRINGS_FILENAME = 'strings.xml'.freeze
+        LOCALE_DIRECTORY_CONVENTION = "values%{locale_suffix}".freeze
+
+        def initialize
+          @strings_serializer = Serializers::StringsSerializer.new
+          @file_system_repository = Repositories::FileSystemRepository.new
+        end
+
+        def call(wording:, locale:, platform_dir:)
+          LOGGER.debug("Starting export Android wording for locale #{locale}")
+          locale_wording = wording.translations_for(locale: locale)
+          return unless has_android_wording?(locale_wording: locale_wording)
+
+          output_dir = compute_output_dir(wording: wording, locale: locale, platform_dir: platform_dir)
+          @file_system_repository.create_directory(path: output_dir)
+
+          content = @strings_serializer.render(locale_wording: locale_wording)
+          @file_system_repository.write(content: content, path: output_dir.join(STRINGS_FILENAME))
+          LOGGER.debug("#{STRINGS_FILENAME} done !")
+        end
+
+        private
+
+        def has_android_wording?(locale_wording:)
+          locale_wording.has_singular_keys? || locale_wording.has_plural_keys?
+        end
+
+        def compute_output_dir(wording:, locale:, platform_dir:)
+          locale_suffix = wording.default_locale?(locale: locale) ? '' : "-#{locale}"
+          platform_dir.join(LOCALE_DIRECTORY_CONVENTION % { locale_suffix: locale_suffix })
+        end
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/platforms/export_ios_locale_wording.rb

@@ -0,0 +1,62 @@
+module AdLocalize
+  module Interactors
+    module Platforms
+      class ExportIOSLocaleWording
+        INFO_PLIST_FILENAME = "InfoPlist.strings".freeze
+        LOCALIZABLE_STRINGS_FILENAME = "Localizable.strings".freeze
+        LOCALIZABLE_STRINGSDICT_FILENAME = "Localizable.stringsdict".freeze
+        LOCALE_DIRECTORY_CONVENTION = "%{locale}.lproj".freeze
+
+        def initialize
+          @info_plist_serializer = Serializers::InfoPlistSerializer.new
+          @localizable_strings_serializer = Serializers::LocalizableStringsSerializer.new
+          @localizable_stringsdict_serializer = Serializers::LocalizableStringsdictSerializer.new
+          @file_system_repository = Repositories::FileSystemRepository.new
+        end
+
+        def call(wording:, locale:, platform_dir:)
+          LOGGER.debug("Starting export iOS wording for locale #{locale}")
+          locale_wording = wording.translations_for(locale: locale)
+          return unless has_ios_wording?(locale_wording: locale_wording)
+
+          output_dir = platform_dir.join(LOCALE_DIRECTORY_CONVENTION % { locale: locale })
+          @file_system_repository.create_directory(path: output_dir)
+
+          export_info_plist(locale_wording: locale_wording, output_dir: output_dir)
+          export_localizable_strings(locale_wording: locale_wording, output_dir: output_dir)
+          export_localizable_stringsdict(locale_wording: locale_wording, output_dir: output_dir)
+        end
+
+        private
+
+        def has_ios_wording?(locale_wording:)
+          locale_wording.has_info_plist_keys? ||
+            locale_wording.has_singular_keys? ||
+            locale_wording.has_plural_keys? ||
+            locale_wording.has_adaptive_keys?
+        end
+
+        def export_info_plist(locale_wording:, output_dir:)
+          return unless locale_wording.has_info_plist_keys?
+          content = @info_plist_serializer.render(locale_wording: locale_wording)
+          @file_system_repository.write(content: content, path: output_dir.join(INFO_PLIST_FILENAME))
+          LOGGER.debug("#{INFO_PLIST_FILENAME} done !")
+        end
+
+        def export_localizable_strings(locale_wording:, output_dir:)
+          return unless locale_wording.has_singular_keys?
+          content = @localizable_strings_serializer.render(locale_wording: locale_wording)
+          @file_system_repository.write(content: content, path: output_dir.join(LOCALIZABLE_STRINGS_FILENAME))
+          LOGGER.debug("#{LOCALIZABLE_STRINGS_FILENAME} done !")
+        end
+
+        def export_localizable_stringsdict(locale_wording:, output_dir:)
+          return unless locale_wording.has_plural_keys? || locale_wording.has_adaptive_keys?
+          content = @localizable_stringsdict_serializer.render(locale_wording: locale_wording)
+          @file_system_repository.write(content: content, path: output_dir.join(LOCALIZABLE_STRINGSDICT_FILENAME))
+          LOGGER.debug("#{LOCALIZABLE_STRINGSDICT_FILENAME} done !")
+        end
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/platforms/export_json_locale_wording.rb

@@ -0,0 +1,23 @@
+module AdLocalize
+  module Interactors
+    module Platforms
+      class ExportJSONLocaleWording
+        def initialize
+          @json_serializer = Serializers::JSONSerializer.new
+          @file_system_repository = Repositories::FileSystemRepository.new
+        end
+
+        def call(wording:, locale:, platform_dir:)
+          LOGGER.debug("Starting export JSON wording for locale #{locale}")
+          locale_wording = wording.translations_for(locale: locale)
+          content = @json_serializer.render(locale_wording: locale_wording)
+          return if content[locale].blank?
+
+          @file_system_repository.create_directory(path: platform_dir)
+          @file_system_repository.write(content: content, path: platform_dir.join("#{locale}.json"))
+          LOGGER.debug("#{locale}.json done !")
+        end
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/platforms/export_platform_factory.rb

@@ -0,0 +1,44 @@
+module AdLocalize
+  module Interactors
+    module Platforms
+      class ExportPlatformFactory
+        def build(platform:)
+          case platform
+          when 'json'
+            json_builder
+          when 'yml'
+            yaml_builder
+          when 'android'
+            android_builder
+          when 'ios'
+            ios_builder
+          when 'properties'
+            properties_builder
+          else
+            raise ArgumentError.new('Unknown platform for builder factory')
+          end
+        end
+
+        def json_builder
+          @json_builder ||= ExportJSONLocaleWording.new
+        end
+
+        def yaml_builder
+          @yaml_builder ||= ExportYAMLLocaleWording.new
+        end
+
+        def android_builder
+          @android_builder ||= ExportAndroidLocaleWording.new
+        end
+
+        def ios_builder
+          @ios_builder ||= ExportIOSLocaleWording.new
+        end
+
+        def properties_builder
+          @properties_builder ||= ExportPropertiesLocaleWording.new
+        end
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/platforms/export_properties_locale_wording.rb

@@ -0,0 +1,29 @@
+module AdLocalize
+  module Interactors
+    module Platforms
+      class ExportPropertiesLocaleWording
+        def initialize
+          @properties_serializer = Serializers::PropertiesSerializer.new
+          @file_system_repository = Repositories::FileSystemRepository.new
+        end
+
+        def call(wording:, locale:, platform_dir:)
+          LOGGER.debug("Starting export Properties wording for locale #{locale}")
+          locale_wording = wording.translations_for(locale: locale)
+          return unless has_properties_wording?(locale_wording: locale_wording)
+
+          content = @properties_serializer.render(locale_wording: locale_wording)
+          @file_system_repository.create_directory(path: platform_dir)
+          @file_system_repository.write(content: content, path: platform_dir.join("#{locale}.properties"))
+          LOGGER.debug("#{locale}.properties done !")
+        end
+
+        private
+
+        def has_properties_wording?(locale_wording:)
+          locale_wording.has_singular_keys?
+        end
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/platforms/export_yaml_locale_wording.rb

@@ -0,0 +1,23 @@
+module AdLocalize
+  module Interactors
+    module Platforms
+      class ExportYAMLLocaleWording
+        def initialize
+          @yaml_serializer = Serializers::YAMLSerializer.new
+          @file_system_repository = Repositories::FileSystemRepository.new
+        end
+
+        def call(wording:, locale:, platform_dir:)
+          LOGGER.debug("Starting export YAML wording for locale #{locale}")
+          locale_wording = wording.translations_for(locale: locale)
+          content = @yaml_serializer.render(locale_wording:locale_wording)
+          return if content[locale].blank?
+
+          @file_system_repository.create_directory(path: platform_dir)
+          @file_system_repository.write(content: content, path: platform_dir.join("#{locale}.yml"))
+          LOGGER.debug("#{locale}.yml done !")
+        end
+      end
+    end
+  end
+end

data/lib/ad_localize/mappers/android_translation_mapper.rb

@@ -0,0 +1,18 @@
+module AdLocalize
+  module Mappers
+    class AndroidTranslationMapper < TranslationMapper
+      private
+
+      def sanitize_value(value:)
+        return if value.blank?
+        processedValue = value.gsub(/(?<!\\)'/, "\\\\'") # match ' unless there is a \ before
+        processedValue = processedValue.gsub(/(?<!\\)\"/, "\\\"") # match " unless there is a \ before
+        processedValue = processedValue.gsub(/(%(\d+\$)?@)/, '%\2s') # should match values like %1$s and %s
+        processedValue = processedValue.gsub(/(%((\d+\$)?(\d+)?)i)/, '%\2d') # should match values like %i, %3$i, %01i, %1$02i
+        processedValue = processedValue.gsub(/%(?!((\d+\$)?(s|(\d+)?d)))/, '%%') # negative lookahead: identifies when user really wants to display a %
+        processedValue = processedValue.gsub("\\U", "\\u")
+        "\"#{processedValue}\""
+      end
+    end
+  end
+end

data/lib/ad_localize/mappers/csv_path_to_wording.rb

@@ -0,0 +1,76 @@
+module AdLocalize
+  module Mappers
+    class CSVPathToWording
+      def map(csv_path:)
+        @headers = CSV.foreach(csv_path).first
+        return unless valid?(csv_path: csv_path)
+        translations = []
+
+        CSV.foreach(csv_path, headers: true, skip_blanks: true) do |row|
+          row_translations = map_row(row: row, locales: locales)
+          next if row_translations.blank?
+
+          existing_keys = translations.map(&:key)
+          new_translations = row_translations.reject do |translation|
+            existing_keys.any? do |key|
+              existing_plural_key = key.label == translation.key.label && key.plural? && translation.key.singular?
+              key.same_as?(key: translation.key) || existing_plural_key
+            end
+          end
+          translations.concat(new_translations)
+        end
+
+        locale_wordings = translations.group_by(&:locale).map do |locale, group|
+          Entities::LocaleWording.new(locale: locale, translations: group)
+        end
+        Entities::Wording.new(locale_wordings: locale_wordings, default_locale: locales.first)
+      end
+
+      private
+
+      def valid?(csv_path:)
+        File.exist?(csv_path) && has_key_column? && has_locales?
+      end
+
+      def locales
+        @locales ||= compute_locales
+      end
+
+      def compute_locales
+        return [] unless has_key_column? && key_column_index < @headers.size.pred
+
+        @headers.slice(key_column_index.succ..-1).compact.reject do |header|
+          header.to_s.include?(Constant::COMMENT_KEY_COLUMN_IDENTIFIER)
+        end
+      end
+
+      def has_locales?
+        locales.present?
+      end
+
+      def has_key_column?
+        key_column_index.present?
+      end
+
+      def key_column_index
+        @key_column_index ||= @headers.index(Constant::CSV_WORDING_KEYS_COLUMN)
+      end
+
+      def map_row(row:, locales:)
+        csv_wording_key = row.field(Constant::CSV_WORDING_KEYS_COLUMN)
+        return if csv_wording_key.blank?
+
+        key = Entities::Key.new(label: csv_wording_key)
+        locales.map do |locale|
+          comment_column_name = "#{Constant::COMMENT_KEY_COLUMN_IDENTIFIER} #{locale}"
+          Entities::Translation.new(
+            locale: locale,
+            key: key,
+            value: row.field(locale),
+            comment: row.field(comment_column_name)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ad_localize/mappers/ios_translation_mapper.rb

@@ -0,0 +1,12 @@
+module AdLocalize
+  module Mappers
+    class IOSTranslationMapper < TranslationMapper
+      private
+
+      def sanitize_value(value:)
+        return if value.blank?
+        value.gsub(/(?<!\\)\"/, "\\\"")
+      end
+    end
+  end
+end

data/lib/ad_localize/mappers/locale_wording_to_hash.rb

@@ -0,0 +1,25 @@
+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
+                hash[inner_key.to_s] = translation.value
+              end
+            else
+              hash[inner_key] = {} if hash[inner_key].nil?
+              hash = hash[inner_key]
+            end
+          end
+        end
+        { locale_wording.locale => result }
+      end
+    end
+  end
+end

data/lib/ad_localize/mappers/options_to_export_request.rb

@@ -0,0 +1,28 @@
+module AdLocalize
+  module Mappers
+    class OptionsToExportRequest
+      def map(options:)
+        Requests::ExportRequest.new(
+          platform_codes: 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']
+        )
+      end
+    end
+  end
+end