ad_localize 5.0.0 → 6.0.0

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,29 +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],
-          non_empty_values: options[:'non-empty-values'],
-          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,39 +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")
-        parser.on("-x", "--non-empty-values", TrueClass, "Do not export keys with empty values (iOS only)")
-      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

data/lib/ad_localize/parsers/csv_parser.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Parsers
+    class CSVParser
+      COMMENT_KEY_COLUMN_IDENTIFIER = 'comment'.freeze
+      CSV_WORDING_KEYS_COLUMN = 'key'.freeze
+
+      def initialize(key_parser: nil)
+        @key_parser = key_parser.presence || KeyParser.new
+      end
+
+      def call(csv_path:, export_request:)
+        locales = find_locales(csv_path: csv_path, export_request: export_request)
+        LOGGER.debug("#{csv_path} - locales : #{locales.to_sentence}")
+        return if locales.blank?
+
+        keys = find_keys(csv_path: csv_path)
+        wording = build_wording(
+          csv_path: csv_path,
+          locales: locales,
+          keys: keys,
+          export_request: export_request
+        )
+        wording
+      end
+
+      private
+
+      def find_locales(csv_path:, export_request:)
+        csv = CSV.open(csv_path, headers: true, skip_blanks: true)
+        headers = csv.first.headers
+        locales = headers[headers.index(CSV_WORDING_KEYS_COLUMN).succ..-1].compact.reject do |header|
+          header.include?(COMMENT_KEY_COLUMN_IDENTIFIER)
+        end
+        export_request.locales.empty? ? locales : locales & export_request.locales
+      end
+
+      def find_keys(csv_path:)
+        keys = {}
+        CSV.foreach(csv_path, headers: true, skip_blanks: true, skip_lines: /^#/) do |row|
+          next if row[CSV_WORDING_KEYS_COLUMN].blank?
+
+          raw_key = row[CSV_WORDING_KEYS_COLUMN].strip
+          key = @key_parser.call(raw_key: raw_key)
+
+          existing_key = keys.values.detect do |k|
+            k.id == key.id || (k.label == key.label && (k.variant_name.nil? || key.variant_name.nil?))
+          end
+          if existing_key
+            LOGGER.warn "A #{existing_key.type} value already exist for key '#{existing_key.label}'. Will skip new #{key.type} value. Remove duplicates."
+          else
+            keys[raw_key] = key
+          end
+        end
+        keys
+      end
+
+      def build_wording(csv_path:, locales:, keys:, export_request:)
+        default_locale = locales.first
+        wording = Hash.new { |hash, key|
+          hash[key] = Entities::LocaleWording.new(locale: key, is_default: key == default_locale)
+        }
+        added_keys = Hash.new { |hash, key| hash[key] = false }
+        CSV.foreach(csv_path, headers: true, skip_blanks: true, skip_lines: /^#/) do |row|
+          next if row[CSV_WORDING_KEYS_COLUMN].blank?
+
+          raw_key = row[CSV_WORDING_KEYS_COLUMN].strip
+          key = keys[raw_key]
+          next if key.nil? || added_keys[raw_key]
+
+          locales.each do |locale|
+            value = row[locale]
+            next if export_request.bypass_empty_values && value.blank?
+
+            comment = row["#{COMMENT_KEY_COLUMN_IDENTIFIER} #{locale}"]
+            wording[locale].add_wording(key: key, value: value&.strip, comment: comment)
+          end
+          added_keys[raw_key] = true
+        end
+        wording
+      end
+    end
+  end
+end

data/lib/ad_localize/parsers/key_parser.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Parsers
+    class KeyParser
+      PLURAL_KEY_REGEXP = /\#\#\{([A-Za-z]+)\}/.freeze
+      ADAPTIVE_KEY_REGEXP = /\#\#\{(\d+)\}/.freeze
+      # see https://developer.apple.com/documentation/bundleresources/information_property_list
+      INFO_PLIST_KEY_REGEXP = /(NS.+UsageDescription)|(CF.+Name)|NFCReaderUsageDescription/.freeze
+
+      def call(raw_key:)
+        type = compute_type(raw_key: raw_key)
+        label = compute_label(raw_key: raw_key, type: type)
+        variant_name = compute_variant_name(raw_key: raw_key, type: type)
+        Entities::Key.new(id: raw_key, label: label, type: type, variant_name: variant_name)
+      end
+
+      def plural?(raw_key:)
+        !raw_key.match(PLURAL_KEY_REGEXP).nil?
+      end
+
+      def adaptive?(raw_key:)
+        !raw_key.match(ADAPTIVE_KEY_REGEXP).nil?
+      end
+
+      def info_plist?(raw_key:)
+        !raw_key.match(INFO_PLIST_KEY_REGEXP).nil?
+      end
+
+      def compute_type(raw_key:)
+        if plural?(raw_key: raw_key)
+          Entities::WordingType::PLURAL
+        elsif adaptive?(raw_key: raw_key)
+          Entities::WordingType::ADAPTIVE
+        elsif info_plist?(raw_key: raw_key)
+          Entities::WordingType::INFO_PLIST
+        else
+          Entities::WordingType::SINGULAR
+        end
+      end
+
+      def compute_label(raw_key:, type:)
+        case type
+        when Entities::WordingType::PLURAL
+          raw_key.gsub(PLURAL_KEY_REGEXP, '')
+        when Entities::WordingType::ADAPTIVE
+          raw_key.gsub(ADAPTIVE_KEY_REGEXP, '')
+        else
+          raw_key
+        end
+      end
+
+      def compute_variant_name(raw_key:, type:)
+        case type
+        when Entities::WordingType::PLURAL
+          raw_key.match(PLURAL_KEY_REGEXP)&.captures&.first
+        when Entities::WordingType::ADAPTIVE
+          raw_key.match(ADAPTIVE_KEY_REGEXP)&.captures&.first
+        end
+      end
+    end
+  end
+end

data/lib/ad_localize/repositories/drive_repository.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Repositories
+    class DriveRepository
+      def initialize
+        @drive_service = Google::Apis::DriveV3::DriveService.new
+        @sheet_service = Google::Apis::SheetsV4::SheetsService.new
+        if ENV['GOOGLE_APPLICATION_CREDENTIALS']
+          drive_scope = [Google::Apis::DriveV3::AUTH_DRIVE_READONLY]
+          sheet_scope = [Google::Apis::SheetsV4::AUTH_SPREADSHEETS_READONLY]
+          @drive_service.authorization = Google::Auth.get_application_default(drive_scope)
+          @sheet_service.authorization = Google::Auth.get_application_default(sheet_scope)
+        end
+      end
+
+      def download_sheets_by_id(spreadsheet_id:, sheet_ids:)
+        sheet_ids.filter_map do |sheet_id|
+          begin
+            url = export_url(spreadsheet_id: spreadsheet_id, sheet_id: sheet_id)
+            string = @drive_service.http(:get, url, options: { retries: 3, max_elapsed_time: 60 })
+            next unless string
+
+            tempfile = Tempfile.new
+            tempfile.write(string)
+            tempfile.rewind
+            tempfile
+          rescue => e
+            LOGGER.error("Cannot download sheet with id #{sheet_id}. Error: #{e.message}")
+            nil
+          end
+        end
+      end
+
+      def download_all_sheets(spreadsheet_id:)
+        begin
+          spreadsheet = @sheet_service.get_spreadsheet(spreadsheet_id)
+          sheet_ids = spreadsheet.sheets.map { |sheet| sheet.properties.sheet_id }
+          LOGGER.debug("#{sheet_ids.size} sheets in the spreadsheet")
+          download_sheets_by_id(spreadsheet_id: spreadsheet_id, sheet_ids: sheet_ids)
+        rescue => e
+          LOGGER.error("Cannot download sheets. Error: #{e.message}")
+          []
+        end
+      end
+
+      private
+
+      def export_url(spreadsheet_id:, sheet_id:)
+        "https://docs.google.com/spreadsheets/d/#{spreadsheet_id}/export?format=csv&gid=#{sheet_id}"
+      end
+    end
+  end
+end

data/lib/ad_localize/repositories/file_system_repository.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module AdLocalize
   module Repositories
     class FileSystemRepository
@@ -10,4 +11,4 @@ module AdLocalize
       end
     end
   end
-end
+end