ad_localize 3.6.0 → 4.0.0

data/lib/ad_localize/mappers/translation_group_mapper.rb

@@ -0,0 +1,14 @@
+module AdLocalize
+  module Mappers
+    class TranslationGroupMapper
+      def initialize(translation_mapper: TranslationMapper.new)
+        @translation_mapper = translation_mapper
+      end
+
+      def map(label:, translations:)
+        translation_view_models = translations.map { |translation| @translation_mapper.map(translation: translation) }
+        ViewModels::TranslationGroupViewModel.new(label: label, translation_view_models: translation_view_models)
+      end
+    end
+  end
+end

data/lib/ad_localize/mappers/translation_mapper.rb

@@ -0,0 +1,30 @@
+module AdLocalize
+  module Mappers
+    class TranslationMapper
+      def map(translation:)
+        ViewModels::TranslationViewModel.new(
+          label: translation.key.label,
+          key: key(translation: translation),
+          value: sanitize_value(value: translation.value),
+          comment: translation.comment
+        )
+      end
+
+      protected
+
+      def sanitize_value(value:)
+        value
+      end
+
+      private
+
+      def key(translation:)
+        if translation.key.plural?
+          translation.key.plural_key
+        elsif translation.key.adaptive?
+          translation.key.adaptive_key
+        end
+      end
+    end
+  end
+end

data/lib/ad_localize/mappers/value_range_to_wording.rb

@@ -0,0 +1,69 @@
+module AdLocalize
+  module Mappers
+    class ValueRangeToWording
+      def map(value_range:)
+        values = value_range.values
+        analyze_header(first_row: values.first)
+        return unless valid_header?
+
+        translations = map_rows(values: values)
+        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: @locale_mapping.keys.first)
+      end
+
+      private
+
+      def map_rows(values:)
+        translations = []
+        values[1..-1].each do |row|
+          row_translations = map_row(row: row)
+          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
+        translations
+      end
+
+      def analyze_header(first_row:)
+        @header = first_row
+        @key_index = first_row.index(Constant::CSV_WORDING_KEYS_COLUMN)
+        @locale_mapping = {}
+        first_row[@key_index.succ..-1].each_index do |relative_index|
+          absolute_index = @key_index.succ + relative_index
+          next if first_row[absolute_index].blank? || first_row[absolute_index].include?(Constant::COMMENT_KEY_COLUMN_IDENTIFIER)
+          @locale_mapping[first_row[absolute_index]] = { key_index: absolute_index }
+          comment_column_name = "#{Constant::COMMENT_KEY_COLUMN_IDENTIFIER} #{first_row[absolute_index]}"
+          @locale_mapping[first_row[absolute_index]][:comment_index] = first_row.index(comment_column_name)
+        end
+      end
+
+      def map_row(row:)
+        csv_wording_key = row[@key_index]
+        return if csv_wording_key.blank?
+        key = Entities::Key.new(label: csv_wording_key)
+        @locale_mapping.map do |locale, index_mapping|
+          comment = index_mapping[:comment_index].nil? ? nil : row[index_mapping[:comment_index]]
+          Entities::Translation.new(
+            locale: locale,
+            key: key,
+            value: row[index_mapping[:key_index]],
+            comment: comment
+          )
+        end
+      end
+
+      def valid_header?
+        @key_index.present? || @locale_mapping.keys.size.positive?
+      end
+    end
+  end
+end

data/lib/ad_localize/option_handler.rb

@@ -1,65 +1,38 @@
 module AdLocalize
   class OptionHandler
-    GOOGLE_DRIVE_DOCUMENT_ID = { length: 32, regexp: /\A[\w-]+\Z/ }
+    def self.parse!(options)
+      option_parser = OptionParser.new do |parser|
+        parser.banner = "Usage: exe/ad_localize [options] file(s)"
 
-    class << self
-      def parse
-        args = { debug: false, only: nil}
-
-        opt_parser = OptionParser.new do |opts|
-          opts.banner = "Usage: ruby bin/export [options] file(s)"
-
-
-          opts.on("-h", "--help", "Prints help") do
-            puts opts
-            exit
-          end
-          opts.on("-d", "--debug", "Run in debug mode") do
-            args[:debug] = true
-            LOGGER.debug!
-          end
-          opts.on("-k", "--drive-key #{GOOGLE_DRIVE_DOCUMENT_ID.dig(:length)}_characters", String, "Use google drive spreadsheets") do |key|
-            is_valid_drive_key = !!(key =~ GOOGLE_DRIVE_DOCUMENT_ID.dig(:regexp)) && (key.size >= GOOGLE_DRIVE_DOCUMENT_ID.dig(:length))
-            raise ArgumentError.new("Invalid google drive spreadsheet key \"#{key}\"") unless is_valid_drive_key
-            args[:drive_key] = key
-          end
-          opts.on("-s", "--drive-sheet SHEET_ID", String, "Use a specific sheet id for Google Drive spreadsheets with several sheets") do |value|
-            args[:sheet_id] = value
-          end
-          opts.on("-a", "--use-service-account", "Use a Google Cloud Service Account to access the file. An GCLOUD_CLIENT_SECRET environment variable containting the client_secret.json content is needed.") do
-            args[:use_service_account] = true
-          end
-          opts.on("-o", "--only platform1,platform2", Array, "Only generate localisation files for the specified platforms. Supported platforms : #{Constant::SUPPORTED_PLATFORMS.join(', ')}") do |platforms|
-            args[:only] = filter_option_args("-o", platforms) { |platform| !!Constant::SUPPORTED_PLATFORMS.index(platform) }
-          end
-          opts.on("-t", "--target-dir PATH", String, "Path to the target directory") do |output_path|
-            pn = Pathname.new(output_path)
-            if pn.directory? and pn.readable? and pn.writable?
-              args[:output_path] = output_path
-            else
-              raise ArgumentError.new("Invalid target directory. Check the permissions")
-            end
-          end
+        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
+          puts parser
+          exit
         end
-
-        begin
-          opt_parser.parse!
-        rescue OptionParser::MissingArgument => e
-          LOGGER.log(:error, :red, "Missing argument for option #{e.args.join(',')}")
-        rescue ArgumentError => e
-          LOGGER.log(:error, :red, e.message)
-          raise e
-        end
-        args
+        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
 
-      private
-      def filter_option_args(option, args)
-        result = args.select { |arg| yield(arg) }
-        invalid_args = args - result
-        LOGGER.log(:debug, :red, "Invalid arg(s) for option #{option}: #{invalid_args.join(', ')}") unless invalid_args.empty?
-        result
-      end
+      args = {}
+      option_parser.parse!(options, into: args)
+      args[:csv_paths] = options
+      return args
     end
   end
-end
+end

data/lib/ad_localize/repositories/file_system_repository.rb

@@ -0,0 +1,13 @@
+module AdLocalize
+  module Repositories
+    class FileSystemRepository
+      def create_directory(path:)
+        path.mkpath unless path.directory?
+      end
+
+      def write(content:, path:)
+        path.open("w") { |file| file.write content }
+      end
+    end
+  end
+end

data/lib/ad_localize/repositories/g_sheets_repository.rb

@@ -0,0 +1,44 @@
+module AdLocalize
+  module Repositories
+    class GSheetsRepository
+      SCOPES = [Google::Apis::SheetsV4::AUTH_SPREADSHEETS_READONLY]
+      ROWS_MAJOR_DIMENSION = 'ROWS'.freeze
+      SPREADSHEET_APPLICATION_NAME = 'ad_localize'.freeze
+
+      def initialize
+        @service = Google::Apis::SheetsV4::SheetsService.new
+        @service.client_options.application_name = SPREADSHEET_APPLICATION_NAME
+      end
+
+      def get_sheets_values(g_spreadsheet_options:)
+        configure(json_configuration: g_spreadsheet_options.service_account_config) if @service.authorization.nil?
+        spreadsheet = @service.get_spreadsheet(g_spreadsheet_options.spreadsheet_id)
+        if g_spreadsheet_options.export_all
+          spreadsheet.sheets.map { |sheet| get_sheet_values(spreadsheet_id: g_spreadsheet_options.spreadsheet_id, sheet: sheet) }
+        elsif g_spreadsheet_options.sheet_ids.nil? || g_spreadsheet_options.sheet_ids.size.zero?
+          spreadsheet.sheets[0..0].map { |sheet| get_sheet_values(spreadsheet_id: g_spreadsheet_options.spreadsheet_id, sheet: sheet) }
+        else
+          spreadsheet.sheets.select do |sheet|
+            g_spreadsheet_options.sheet_ids.include?(sheet.properties.sheet_id)
+          end.map do |sheet|
+            get_sheet_values(spreadsheet_id: g_spreadsheet_options.spreadsheet_id, sheet: sheet)
+          end
+        end
+      end
+
+      private
+
+      def configure(json_configuration:)
+        raise ArgumentError.new('No service account configuration') if json_configuration.blank?
+        json_key_io = StringIO.new(json_configuration)
+        authorizer = Google::Auth::ServiceAccountCredentials.make_creds(json_key_io: json_key_io, scope: SCOPES)
+        @service.authorization = authorizer
+      end
+
+      def get_sheet_values(spreadsheet_id:, sheet:)
+        range = sheet.properties.title
+        @service.get_spreadsheet_values(spreadsheet_id, range, major_dimension: ROWS_MAJOR_DIMENSION)
+      end
+    end
+  end
+end

data/lib/ad_localize/requests/export_request.rb

@@ -0,0 +1,77 @@
+module AdLocalize
+  module Requests
+    class ExportRequest
+      SUPPORTED_PLATFORMS = %w(ios android yml json properties).freeze
+      DEFAULT_EXPORT_FOLDER = 'exports'.freeze
+      CSV_CONTENT_TYPES = %w(text/csv text/plain).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
+
+      attr_reader(
+        :locales,
+        :platforms,
+        :g_spreadsheet_options,
+        :output_path,
+        :verbose,
+        :merge_policy
+      )
+
+      attr_accessor(:csv_paths)
+
+      def has_csv_files?
+        !@csv_paths.blank? && @csv_paths.all? { |csv_path| File.exist?(csv_path) && is_csv?(path: csv_path) }
+      end
+
+      def has_g_spreadsheet_options?
+        @g_spreadsheet_options.present?
+      end
+
+      def multiple_platforms?
+        @platforms.size > 1
+      end
+
+      def valid?
+        valid_platforms? && (valid_csv_options? || valid_g_spreadsheet_options?)
+      end
+
+      def verbose?
+        verbose
+      end
+
+      private
+
+      def valid_csv_options?
+        has_csv_files? && (@csv_paths.size == 1 || (@csv_paths.size > 1 && @merge_policy&.valid?))
+      end
+
+      def valid_platforms?
+        @platforms.size.positive? && (@platforms & SUPPORTED_PLATFORMS).size == @platforms.size
+      end
+
+      def is_csv?(path:)
+        (MIME::Types.of(path).map(&:content_type) & CSV_CONTENT_TYPES).present?
+      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
+      end
+    end
+  end
+end

data/lib/ad_localize/requests/g_spreadsheet_options.rb

@@ -0,0 +1,47 @@
+module AdLocalize
+  module Requests
+    class GSpreadsheetOptions
+      attr_accessor(
+        :spreadsheet_id,
+        :sheet_ids,
+        :export_all,
+        :service_account_config
+      )
+
+      def initialize(**args)
+        @spreadsheet_id = args[:spreadsheet_id]
+        @sheet_ids = Array(args[:sheet_ids])
+        @export_all = args[:export_all] || false
+        @service_account_config = args[:service_account_config].presence
+      end
+
+      def valid?
+        (spreadsheet_id && !export_all) || (spreadsheet_id && service_account_config.present?)
+      end
+
+      def public_download_urls
+        return [] if @service_account_config
+        if @sheet_ids.size.zero?
+          [public_download_url(sheet_id: nil)]
+        else
+          @sheet_ids.map { |sheet_id| public_download_url(sheet_id: sheet_id) }
+        end
+      end
+
+      def has_multiple_sheets?
+        export_all || @sheet_ids.size > 1
+      end
+
+      private
+
+      def public_download_url(sheet_id:)
+        query_id = sheet_id.blank? ? "id=#{@spreadsheet_id}" : "gid=#{sheet_id}"
+        "https://docs.google.com/spreadsheets/d/#{@spreadsheet_id}/export?format=csv&#{query_id}"
+      end
+
+      def valid_export_all_config
+        export_all && service_account_config.present?
+      end
+    end
+  end
+end

data/lib/ad_localize/requests/merge_policy.rb

@@ -0,0 +1,28 @@
+module AdLocalize
+  module Requests
+    class MergePolicy
+      REPLACE_POLICY = 'replace'.freeze
+      KEEP_POLICY = 'keep'.freeze
+      MERGE_POLICIES = [KEEP_POLICY, REPLACE_POLICY]
+      DEFAULT_POLICY = KEEP_POLICY
+
+      attr_reader(:policy)
+
+      def initialize(policy:)
+        @policy = policy
+      end
+
+      def keep?
+        @policy == KEEP_POLICY
+      end
+
+      def replace?
+        @policy == REPLACE_POLICY
+      end
+
+      def valid?
+        @policy.present? && MERGE_POLICIES.include?(@policy)
+      end
+    end
+  end
+end

data/lib/ad_localize/serializers/info_plist_serializer.rb

@@ -0,0 +1,27 @@
+module AdLocalize
+  module Serializers
+    class InfoPlistSerializer
+      include WithTemplate
+
+      INFO_PLIST_FILENAME = "InfoPlist.strings".freeze
+
+      def initialize
+        @translation_mapper = Mappers::IOSTranslationMapper.new
+      end
+
+      private
+
+      def template_path
+        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) }
+      end
+    end
+  end
+end