ad_localize 4.1.1 → 6.0.0

data/lib/ad_localize/entities/wording.rb

@@ -1,24 +0,0 @@
-module AdLocalize
-  module Entities
-    class Wording
-      attr_reader(:default_locale, :locale_wordings)
-
-      def initialize(locale_wordings:, default_locale:)
-        @locale_wordings = locale_wordings
-        @default_locale = default_locale
-      end
-
-      def translations_for(locale:)
-        @locale_wordings.find { |locale_wording| locale_wording.locale == locale }
-      end
-
-      def locales
-        @locale_wordings.map(&:locale)
-      end
-
-      def default_locale?(locale:)
-        locale == @default_locale
-      end
-    end
-  end
-end

data/lib/ad_localize/interactors/execute_export_request.rb

@@ -1,43 +0,0 @@
-module AdLocalize
-  module Interactors
-    class ExecuteExportRequest
-      def initialize(csv_path_to_wording: nil, value_range_to_wording: nil)
-        @csv_path_to_wording = csv_path_to_wording
-        @value_range_to_wording = value_range_to_wording
-      end
-
-      def call(export_request:)
-        export_request.verbose? ? LOGGER.debug! : LOGGER.info!
-        print_export_request(export_request: export_request) if export_request.verbose?
-        LOGGER.debug("Checking request validity")
-        return unless export_request.valid?
-        if export_request.has_csv_files?
-          ExportCSVFiles.new(csv_path_to_wording: @csv_path_to_wording).call(export_request: export_request)
-        elsif export_request.has_g_spreadsheet_options?
-          ExportGSpreadsheet.new(value_range_to_wording: @value_range_to_wording).call(export_request: export_request)
-        end
-        LOGGER.debug("End of export request execution")
-      end
-
-      private
-
-      def print_export_request(export_request:)
-        LOGGER.debug("Export Request info")
-        LOGGER.debug("locales : #{export_request.locales.to_sentence}")
-        LOGGER.debug("platforms : #{export_request.platforms.to_sentence}")
-        LOGGER.debug("output_path : #{export_request.output_path}")
-        LOGGER.debug("verbose : #{export_request.verbose}")
-        LOGGER.debug("merge_policy : #{export_request.merge_policy&.policy}")
-        LOGGER.debug("csv_paths : #{export_request.csv_paths.to_sentence}")
-        if export_request.has_g_spreadsheet_options?
-          g_options = export_request.g_spreadsheet_options
-          LOGGER.debug("spreadsheet_id : #{g_options.spreadsheet_id}")
-          LOGGER.debug("sheet_ids : #{g_options.sheet_ids.to_sentence}")
-          LOGGER.debug("export_all: #{g_options.export_all}")
-          LOGGER.debug("service_account: #{g_options.service_account_config.present?}")
-        end
-        LOGGER.debug("End Export Request info")
-      end
-    end
-  end
-end

data/lib/ad_localize/interactors/export_csv_files.rb

@@ -1,17 +0,0 @@
-module AdLocalize
-  module Interactors
-    class ExportCSVFiles
-      def initialize(csv_path_to_wording: nil)
-        @csv_path_to_wording = csv_path_to_wording.presence || Mappers::CSVPathToWording.new
-        @merge_wordings = MergeWordings.new
-      end
-
-      def call(export_request:)
-        LOGGER.debug("Starting export csv files : #{export_request.csv_paths.to_sentence}")
-        wordings = export_request.csv_paths.map { |csv_path| @csv_path_to_wording.map(csv_path: csv_path) }
-        wording = @merge_wordings.call(wordings: wordings.compact, merge_policy: export_request.merge_policy)
-        ExportWording.new.call(export_request: export_request, wording: wording)
-      end
-    end
-  end
-end

data/lib/ad_localize/interactors/export_g_spreadsheet.rb

@@ -1,59 +0,0 @@
-module AdLocalize
-  module Interactors
-    class ExportGSpreadsheet
-      def initialize(value_range_to_wording: nil)
-        @value_range_to_wording = value_range_to_wording.presence || Mappers::ValueRangeToWording.new
-        @g_sheets_repository = Repositories::GSheetsRepository.new
-      end
-
-      def call(export_request:)
-        LOGGER.debug("Starting export google spreadsheet")
-        if export_request.g_spreadsheet_options.service_account_config
-          export_with_service_account(export_request: export_request)
-        else
-          export_without_service_account(export_request: export_request)
-        end
-      end
-
-      private
-
-      def export_with_service_account(export_request:)
-        LOGGER.debug("Using service account")
-        value_ranges = @g_sheets_repository.get_sheets_values(g_spreadsheet_options: export_request.g_spreadsheet_options)
-        wordings = value_ranges.map { |value_range| @value_range_to_wording.map(value_range: value_range) }
-        wording = MergeWordings.new.call(wordings: wordings.compact, merge_policy: export_request.merge_policy)
-        ExportWording.new.call(export_request: export_request, wording: wording)
-      end
-
-      def export_without_service_account(export_request:)
-        LOGGER.debug("Using direct access to spreadsheet")
-        downloaded_files = export_request.g_spreadsheet_options.public_download_urls.map do |sheet_download_url|
-          download_public_sheet(url: sheet_download_url)
-        end
-        export_request.csv_paths = downloaded_files.map(&:path)
-        if export_request.has_csv_files?
-          ExportCSVFiles.new.call(export_request: export_request)
-        elsif export_request.has_empty_files?
-          # When downloading an empty spreadsheet, the content type of the downloaded file is "inode/x-empty"
-          LOGGER.warn("Your spreadsheet is empty. Add content and retry.")
-        else
-          # When shared configuration is misconfigured, the content type of the downloaded file is "text/html"
-          LOGGER.error("Invalid export request. Check the spreadsheet share configuration")
-        end
-        downloaded_files.select { |downloaded_file| File.exist?(downloaded_file.path) }.each do |downloaded_file|
-          downloaded_file.close
-          downloaded_file.unlink
-        end
-      end
-
-      def download_public_sheet(url:)
-        tempfile = Tempfile.new
-        URI.open(url) do |uri_io|
-          tempfile.write uri_io.read
-          tempfile.rewind
-        end
-        tempfile
-      end
-    end
-  end
-end

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

@@ -1,43 +0,0 @@
-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
-
-        def should_export_locale_by_locale?
-          true
-        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_csv_locale_wording.rb

@@ -1,25 +0,0 @@
-module AdLocalize
-  module Interactors
-    module Platforms
-      class ExportCSVLocaleWording
-        def initialize
-          @file_system_repository = Repositories::FileSystemRepository.new
-        end
-
-        def call(export_request:, platform_dir:)
-          LOGGER.debug("Starting export CSV wording")
-          @file_system_repository.create_directory(path: platform_dir)
-          export_request.csv_paths.each_with_index do |csv_path, i|
-            file = File.basename("localization_#{i}.csv")
-            FileUtils.cp(csv_path, platform_dir.join(file.to_s))
-          end
-          LOGGER.debug("CSV wording export done !")
-        end
-
-        def should_export_locale_by_locale?
-          false
-        end
-      end
-    end
-  end
-end

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

@@ -1,66 +0,0 @@
-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
-
-        def should_export_locale_by_locale?
-          true
-        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

@@ -1,27 +0,0 @@
-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
-
-        def should_export_locale_by_locale?
-          true
-        end
-      end
-    end
-  end
-end

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

@@ -1,50 +0,0 @@
-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
-          when 'csv'
-            csv_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
-
-        def csv_builder
-          @csv_builder ||= ExportCSVLocaleWording.new
-        end
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-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
-
-        def should_export_locale_by_locale?
-          true
-        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

@@ -1,27 +0,0 @@
-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
-
-        def should_export_locale_by_locale?
-          true
-        end
-      end
-    end
-  end
-end

data/lib/ad_localize/mappers/csv_path_to_wording.rb

@@ -1,73 +0,0 @@
-module AdLocalize
-  module Mappers
-    class CSVPathToWording
-      def map(csv_path:)
-        @headers = CSV.foreach(csv_path).first
-        return unless valid?(csv_path: csv_path)
-        translations = []
-        validator = Validators::KeyValidator.new
-
-        CSV.foreach(csv_path, headers: true, skip_blanks: true) do |row|
-          row_translations = map_row(row: row, locales: locales)
-          next if row_translations.blank?
-
-          current_key = row_translations.first.key
-          next if validator.has_warnings?(current_key)
-
-          translations.concat(row_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

@@ -1,12 +0,0 @@
-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/translation_group_mapper.rb

@@ -1,14 +0,0 @@
-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

@@ -1,30 +0,0 @@
-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

@@ -1,67 +0,0 @@
-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 = []
-        validator = Validators::KeyValidator.new
-
-        values[1..-1].each do |row|
-          row_translations = map_row(row: row)
-          next if row_translations.blank?
-
-          current_key = row_translations.first.key
-          next if validator.has_warnings?(current_key)
-
-          translations.concat(row_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/repositories/g_sheets_repository.rb

@@ -1,44 +0,0 @@
-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.to_s)
-          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