ad_localize 4.1.1 → 6.0.0

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

data/lib/ad_localize/requests/export_request.rb

@@ -1,90 +1,134 @@
+# frozen_string_literal: true
 module AdLocalize
   module Requests
     class ExportRequest
-      SUPPORTED_PLATFORMS = %w(ios android yml json properties csv).freeze
-      DEFAULT_EXPORT_FOLDER = 'exports'.freeze
-      CSV_CONTENT_TYPES = %w(text/csv text/plain application/csv).freeze
-      EMPTY_CONTENT_TYPE = 'inode/x-empty'.freeze
-
-      def initialize(**args)
-        @locales = Array(args[:locales].presence)
-        @platforms = args[:platforms].blank? ? SUPPORTED_PLATFORMS : Array(args[:platforms])
-        @csv_paths = Array(args[:csv_paths])
-        @g_spreadsheet_options = args[:g_spreadsheet_options]
-        @verbose = args[:verbose].presence || false
-        @output_path = Pathname.new(args[:output_path].presence || DEFAULT_EXPORT_FOLDER)
-        if @csv_paths.size > 1 || @g_spreadsheet_options&.has_multiple_sheets?
-          @merge_policy = MergePolicy.new(policy: args[:merge_policy].presence || MergePolicy::DEFAULT_POLICY)
-        else
-          @merge_policy = nil
-        end
-      end
+      DEFAULTS = {
+        locales: [],
+        bypass_empty_values: false,
+        csv_paths: [],
+        merge_policy: Interactors::MergeWordings::DEFAULT_POLICY,
+        output_path: Pathname.new('exports'),
+        spreadsheet_id: nil,
+        sheet_ids: %w[0],
+        export_all: false,
+        verbose: false,
+        platforms: Entities::Platform::SUPPORTED_PLATFORMS,
+        downloaded_csvs: []
+      }
+
+      attr_accessor :output_dir
 
       attr_reader(
         :locales,
-        :platforms,
-        :g_spreadsheet_options,
+        :bypass_empty_values,
+        :csv_paths,
+        :merge_policy,
         :output_path,
+        :platforms,
+        :spreadsheet_id,
+        :sheet_ids,
+        :export_all,
         :verbose,
-        :merge_policy
+        :downloaded_csvs
       )
 
-      attr_accessor(:csv_paths)
+      def initialize
+        @locales = DEFAULTS[:locales]
+        @bypass_empty_values = DEFAULTS[:bypass_empty_values]
+        @csv_paths = DEFAULTS[:csv_paths]
+        @merge_policy = DEFAULTS[:merge_policy]
+        @output_path = DEFAULTS[:output_path]
+        @platforms = DEFAULTS[:platforms]
+        @spreadsheet_id = DEFAULTS[:spreadsheet_id]
+        @sheet_ids = DEFAULTS[:sheet_ids]
+        @export_all = DEFAULTS[:export_all]
+        @verbose = DEFAULTS[:verbose]
+        @downloaded_csvs = DEFAULTS[:downloaded_csvs]
+      end
+
+      def locales=(value)
+        return unless value.is_a? Array
+
+        @locales = value.compact
+      end
+
+      def bypass_empty_values=(value)
+        @bypass_empty_values = [true, 'true'].include?(value)
+      end
+
+      def csv_paths=(value)
+        return unless value.is_a? Array
+
+        @csv_paths = value.compact.map { |path| Pathname.new(path) }
+      end
 
-      def has_csv_files?
-        !@csv_paths.blank? && @csv_paths.all? { |csv_path| File.exist?(csv_path) && is_csv?(path: csv_path) }
+      def merge_policy=(value)
+        @merge_policy = value unless value.blank?
       end
 
-      def has_empty_files?
-        !@csv_paths.blank? && @csv_paths.all? { |csv_path| File.exist?(csv_path) && is_empty?(path: csv_path) }
+      def output_path=(value)
+        @output_path = Pathname.new(value) unless value.blank?
       end
 
-      def has_g_spreadsheet_options?
-        @g_spreadsheet_options.present?
+      def platforms=(value)
+        return unless value.is_a? Array
+
+        @platforms = value.compact & DEFAULTS[:platforms]
+      end
+
+      def spreadsheet_id=(value)
+        @spreadsheet_id = value unless value.blank?
       end
 
-      def multiple_platforms?
-        @platforms.size > 1
+      def sheet_ids=(value)
+        return unless value.is_a? Array
+
+        @sheet_ids = value.compact
       end
 
-      def valid?
-        valid_platforms? && (valid_csv_options? || valid_g_spreadsheet_options?)
+      def export_all=(value)
+        @export_all = [true, 'true'].include?(value)
       end
 
-      def verbose?
-        verbose
+      def verbose=(value)
+        @verbose = [true, 'true'].include?(value)
       end
 
-      private
+      def downloaded_csvs=(value)
+        return unless value.is_a? Array
 
-      def valid_csv_options?
-        has_csv_files? && (@csv_paths.size == 1 || (@csv_paths.size > 1 && @merge_policy&.valid?))
+        @downloaded_csvs = value.compact
       end
 
-      def valid_platforms?
-        @platforms.size.positive? && (@platforms & SUPPORTED_PLATFORMS).size == @platforms.size
+      def has_sheets?
+        spreadsheet_id.present?
       end
 
-      def is_csv?(path:)
-        CSV_CONTENT_TYPES.include? content_type(path: path)
+      def has_csv_paths?
+        all_csv_paths.present?
       end
 
-      def is_empty?(path:)
-        content_type(path: path) == EMPTY_CONTENT_TYPE
+      def many_platforms?
+        platforms.size > 1
       end
 
-      def content_type(path:)
-        `file --brief --mime-type "#{path}"`.strip
+      def all_csv_paths
+        csv_paths + downloaded_csvs.map(&:path)
       end
 
-      def valid_g_spreadsheet_options?
-        return false if @g_spreadsheet_options.blank?
-        if @g_spreadsheet_options.has_multiple_sheets?
-          @g_spreadsheet_options.valid? && @merge_policy&.valid?
-        else
-          @g_spreadsheet_options.valid?
-        end
+      def to_s
+        "locales: #{locales}, " \
+          "bypass_empty_values: #{bypass_empty_values}, " \
+          "csv_paths: #{csv_paths}, " \
+          "merge_policy: #{merge_policy}, " \
+          "output_path: #{output_path}, " \
+          "spreadsheet_id: #{spreadsheet_id}, " \
+          "sheet_ids: #{sheet_ids}, " \
+          "export_all: #{export_all}, " \
+          "verbose: #{verbose}, " \
+          "platforms: #{platforms}, " \
+          "downloaded_csvs: #{downloaded_csvs}"
       end
     end
   end
-end
+end

data/lib/ad_localize/sanitizers/ios_sanitizer.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Sanitizers
+    class IOSSanitizer
+      def sanitize(value:)
+        return if value.blank?
+
+        value.gsub(/(?<!\\)\"/, "\\\"")
+      end
+    end
+  end
+end

data/lib/ad_localize/{mappers/android_translation_mapper.rb → sanitizers/ios_to_android_sanitizer.rb}

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
 module AdLocalize
-  module Mappers
-    class AndroidTranslationMapper < TranslationMapper
-      private
-
-      def sanitize_value(value:)
+  module Sanitizers
+    class IOSToAndroidSanitizer
+      def sanitize(value:)
         return if value.blank?
+
         processedValue = value.gsub(/(?<!\\)'/, '&#39;') # match ' unless there is a \ before
         processedValue = processedValue.gsub(/(?<!\\)\"/, '&#34;') # match " unless there is a \ before
         processedValue = processedValue.gsub(">", '&gt;')
@@ -13,9 +13,9 @@ module AdLocalize
         processedValue = processedValue.gsub(/(%(\d+\$)?@)/, '%\2s') # should match values like %1$s and %s
         hasFormatting = hasFormatting || processedValue.match(/(%((\d+\$)?(\d+)?)i)/)
         processedValue = processedValue.gsub(/(%((\d+\$)?(\d+)?)i)/, '%\2d') # should match values like %i, %3$i, %01i, %1$02i
-        # On Android, '%' must be escaped with a second '%' if and only if the string has at least one formatting pattern. In this specific case, 
+        # On Android, '%' must be escaped with a second '%' if and only if the string has at least one formatting pattern. In this specific case,
         # a Java formatting method will be used which interprets every non escaped '%' as the start of a formatting pattern.
-        if hasFormatting 
+        if hasFormatting
           processedValue = processedValue.gsub(/%(?!((\d+\$)?(s|(\d+)?d)))/, '%%') # negative lookahead: identifies when user really wants to display a %
         else
           processedValue = processedValue.gsub(/%(?!((\d+\$)?(s|(\d+)?d)))/, '%') # negative lookahead: identifies when user really wants to display a %
@@ -27,4 +27,4 @@ module AdLocalize
       end
     end
   end
-end
+end

data/lib/ad_localize/sanitizers/pass_through_sanitizer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Sanitizers
+    class PassThroughSanitizer
+      def sanitize(value:)
+        value
+      end
+    end
+  end
+end

data/lib/ad_localize/serializers/info_plist_serializer.rb

@@ -1,12 +1,11 @@
+# frozen_string_literal: true
 module AdLocalize
   module Serializers
-    class InfoPlistSerializer
-      include WithTemplate
-
+    class InfoPlistSerializer < TemplatedSerializer
       INFO_PLIST_FILENAME = "InfoPlist.strings".freeze
 
       def initialize
-        @translation_mapper = Mappers::IOSTranslationMapper.new
+        super(sanitizer: Sanitizers::IOSSanitizer.new)
       end
 
       private
@@ -15,13 +14,12 @@ module AdLocalize
         TEMPLATES_DIRECTORY + "/ios/#{INFO_PLIST_FILENAME}.erb"
       end
 
-      def hash_binding(locale_wording:)
-        { translations: map_translations(translations: locale_wording.info_plists) }
-      end
-
-      def map_translations(translations:)
-        translations.map { |translation| @translation_mapper.map(translation: translation) }
+      def variable_binding(locale_wording:)
+        translations = locale_wording.info_plists.map do |_, translation|
+          map_simple_wording(translation: translation)
+        end
+        { translations: translations }
       end
     end
   end
-end
+end

data/lib/ad_localize/serializers/json_serializer.rb

@@ -1,12 +1,10 @@
+# frozen_string_literal: true
 module AdLocalize
   module Serializers
     class JSONSerializer
-      def initialize
-        @locale_wording_to_hash = Mappers::LocaleWordingToHash.new
-      end
-
       def render(locale_wording:)
-        @locale_wording_to_hash.map(locale_wording: locale_wording).to_json
+        content = Mappers::LocaleWordingToHash.new.map(locale_wording: locale_wording)
+        content.to_json
       end
     end
   end

data/lib/ad_localize/serializers/localizable_strings_serializer.rb

@@ -1,12 +1,11 @@
+# frozen_string_literal: true
 module AdLocalize
   module Serializers
-    class LocalizableStringsSerializer
-      include WithTemplate
-
+    class LocalizableStringsSerializer < TemplatedSerializer
       LOCALIZABLE_STRINGS_FILENAME = "Localizable.strings".freeze
 
       def initialize
-        @translation_mapper = Mappers::IOSTranslationMapper.new
+        super(sanitizer: Sanitizers::IOSSanitizer.new)
       end
 
       private
@@ -15,13 +14,12 @@ module AdLocalize
         TEMPLATES_DIRECTORY + "/ios/#{LOCALIZABLE_STRINGS_FILENAME}.erb"
       end
 
-      def hash_binding(locale_wording:)
-        { translations: map_translations(translations: locale_wording.singulars) }
-      end
-
-      def map_translations(translations:)
-        translations.map { |translation| @translation_mapper.map(translation: translation) }
+      def variable_binding(locale_wording:)
+        translations = locale_wording.singulars.map do |_, translation|
+          map_simple_wording(translation: translation)
+        end
+        { translations: translations }
       end
     end
   end
-end
+end

data/lib/ad_localize/serializers/localizable_stringsdict_serializer.rb

@@ -1,13 +1,11 @@
+# frozen_string_literal: true
 module AdLocalize
   module Serializers
-    class LocalizableStringsdictSerializer
-      include WithTemplate
-
+    class LocalizableStringsdictSerializer < TemplatedSerializer
       LOCALIZABLE_STRINGSDICT_FILENAME = "Localizable.stringsdict".freeze
 
       def initialize
-        @translation_mapper = Mappers::IOSTranslationMapper.new
-        @translation_group_mapper = Mappers::TranslationGroupMapper.new(translation_mapper: @translation_mapper)
+        super(sanitizer: Sanitizers::IOSSanitizer.new)
       end
 
       private
@@ -16,20 +14,15 @@ module AdLocalize
         TEMPLATES_DIRECTORY + "/ios/#{LOCALIZABLE_STRINGSDICT_FILENAME}.erb"
       end
 
-      def hash_binding(locale_wording:)
-        {
-          plurals: map_plurals(plurals: locale_wording.plurals),
-          adaptives: map_adaptives(adaptives: locale_wording.adaptives)
-        }
-      end
-
-      def map_plurals(plurals:)
-        plurals.map { |label, translations| @translation_group_mapper.map(label: label, translations: translations) }
-      end
-
-      def map_adaptives(adaptives:)
-        adaptives.map { |label, translations| @translation_group_mapper.map(label: label, translations: translations) }
+      def variable_binding(locale_wording:)
+        plurals = locale_wording.plurals.map do |label, translations|
+          map_compound_wording(label: label, translations: translations)
+        end
+        adaptives = locale_wording.adaptives.map do |label, translations|
+          map_compound_wording(label: label, translations: translations)
+        end
+        { plurals: plurals, adaptives: adaptives }
       end
     end
   end
-end
+end

data/lib/ad_localize/serializers/properties_serializer.rb

@@ -1,10 +1,9 @@
+# frozen_string_literal: true
 module AdLocalize
   module Serializers
-    class PropertiesSerializer
-      include WithTemplate
-
+    class PropertiesSerializer < TemplatedSerializer
       def initialize
-        @translation_mapper = Mappers::TranslationMapper.new
+        super(sanitizer: Sanitizers::PassThroughSanitizer.new)
       end
 
       private
@@ -13,13 +12,12 @@ module AdLocalize
         TEMPLATES_DIRECTORY + "/properties/template.properties.erb"
       end
 
-      def hash_binding(locale_wording:)
-        { translations: map_translations(translations: locale_wording.singulars) }
-      end
-
-      def map_translations(translations:)
-        translations.map { |translation| @translation_mapper.map(translation: translation) }
+      def variable_binding(locale_wording:)
+        singulars = locale_wording.singulars.map do |_, translation|
+          map_simple_wording(translation: translation)
+        end
+        { translations: singulars }
       end
     end
   end
-end
+end