ad_localize 5.0.0 → 6.0.0

data/lib/ad_localize/requests/export_request.rb

@@ -1,96 +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
-        @non_empty_values = args[:non_empty_values].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,
-        :non_empty_values,
-        :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
 
-      def has_csv_files?
-        !@csv_paths.blank? && @csv_paths.all? { |csv_path| File.exist?(csv_path) && is_csv?(path: csv_path) }
+        @csv_paths = value.compact.map { |path| Pathname.new(path) }
       end
 
-      def has_empty_files?
-        !@csv_paths.blank? && @csv_paths.all? { |csv_path| File.exist?(csv_path) && is_empty?(path: csv_path) }
+      def merge_policy=(value)
+        @merge_policy = value unless value.blank?
       end
 
-      def has_g_spreadsheet_options?
-        @g_spreadsheet_options.present?
+      def output_path=(value)
+        @output_path = Pathname.new(value) unless value.blank?
       end
 
-      def multiple_platforms?
-        @platforms.size > 1
+      def platforms=(value)
+        return unless value.is_a? Array
+
+        @platforms = value.compact & DEFAULTS[:platforms]
       end
 
-      def valid?
-        valid_platforms? && (valid_csv_options? || valid_g_spreadsheet_options?)
+      def spreadsheet_id=(value)
+        @spreadsheet_id = value unless value.blank?
+      end
+
+      def sheet_ids=(value)
+        return unless value.is_a? Array
+
+        @sheet_ids = value.compact
       end
 
-      def verbose?
-        verbose
+      def export_all=(value)
+        @export_all = [true, 'true'].include?(value)
       end
 
-      def non_empty_values?
-        non_empty_values
+      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,31 +1,25 @@
+# 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
 
-      attr_accessor(
-        :bypass_empty_values
-      )
-
       private
 
       def template_path
         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.select(&:has_value?).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,41 +1,28 @@
+# 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
 
-      attr_accessor(
-        :bypass_empty_values
-      )
-
       private
 
       def template_path
         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.select(&:has_value?)) }
-        .select(&:has_translations?)
-      end
-
-      def map_adaptives(adaptives:)
-        adaptives.map { |label, translations| @translation_group_mapper.map(label: label, translations: translations.select(&:has_value?)) }
-        .select(&:has_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

data/lib/ad_localize/serializers/strings_serializer.rb

@@ -1,11 +1,9 @@
+# frozen_string_literal: true
 module AdLocalize
   module Serializers
-    class StringsSerializer
-      include WithTemplate
-
+    class StringsSerializer < TemplatedSerializer
       def initialize
-        @translation_mapper = Mappers::AndroidTranslationMapper.new
-        @translation_group_mapper = Mappers::TranslationGroupMapper.new(translation_mapper: @translation_mapper)
+        super(sanitizer: Sanitizers::IOSToAndroidSanitizer.new)
       end
 
       private
@@ -14,22 +12,15 @@ module AdLocalize
         TEMPLATES_DIRECTORY + "/android/strings.xml.erb"
       end
 
-      def hash_binding(locale_wording:)
-        {
-          singulars: map_singulars(translations: locale_wording.singulars),
-          plurals: map_plurals(plurals: locale_wording.plurals)
-        }
-      end
-
-      def map_singulars(translations:)
-        translations.select(&:has_value?).map { |translation| @translation_mapper.map(translation: translation) }
-      end
-
-      def map_plurals(plurals:)
-        plurals
-        .map { |label, translations| @translation_group_mapper.map(label: label, translations: translations.select(&:has_value?)) }
-        .select(&:has_translations?)
+      def variable_binding(locale_wording:)
+        singulars = locale_wording.singulars.map do |_, translation|
+          map_simple_wording(translation: translation)
+        end
+        plurals = locale_wording.plurals.map do |label, translations|
+          map_compound_wording(label: label, translations: translations)
+        end
+        { singulars: singulars, plurals: plurals }
       end
     end
   end
-end
+end

data/lib/ad_localize/serializers/templated_serializer.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Serializers
+    class TemplatedSerializer
+      def initialize(sanitizer:)
+        @sanitizer = sanitizer
+      end
+
+      def render(locale_wording:)
+        variable_binding = variable_binding(locale_wording: locale_wording)
+        return unless variable_binding
+
+        render_template(template_path: template_path, variable_binding: variable_binding)
+      end
+
+      protected
+
+      TEMPLATES_DIRECTORY = __dir__ + "/../templates"
+
+      def template_path
+        raise 'Override me!'
+      end
+
+      def variable_binding(locale_wording:)
+        raise 'override me!'
+      end
+
+      private
+
+      def map_simple_wording(translation:)
+        SimpleWordingViewModel.new(
+          label: translation.key.label,
+          value: @sanitizer.sanitize(value: translation.value),
+          comment: translation.comment,
+          variant_name: translation.key.variant_name
+        )
+      end
+
+      def map_compound_wording(label:, translations:)
+        variants = translations.map { |_, translation| map_simple_wording(translation: translation) }
+        CompoundWordingViewModel.new(label: label, variants: variants)
+      end
+
+      def render_template(template_path:, variable_binding:)
+        template = File.read(template_path)
+        renderer = ERB.new(template, trim_mode: '-')
+        renderer.result_with_hash(variable_binding)
+      end
+    end
+  end
+end

data/lib/ad_localize/serializers/yaml_serializer.rb

@@ -1,13 +1,11 @@
+# frozen_string_literal: true
 module AdLocalize
   module Serializers
     class YAMLSerializer
-      def initialize
-        @locale_wording_to_hash = Mappers::LocaleWordingToHash.new
-      end
-
       def render(locale_wording:)
-        @locale_wording_to_hash.map(locale_wording: locale_wording).to_yaml
+        content = Mappers::LocaleWordingToHash.new.map(locale_wording: locale_wording)
+        content.to_yaml
       end
     end
   end
-end
+end

data/lib/ad_localize/templates/android/strings.xml.erb

@@ -6,13 +6,13 @@
     <%- end -%>
     <string name="<%= single_translation.label %>"><%= single_translation.value %></string>
     <%- end -%>
-    <%- plurals.each do |translation_group| -%>
-    <plurals name="<%= translation_group.label %>">
-        <%- translation_group.translation_view_models.each do |translation_view_model| -%>
-        <%- if translation_view_model.comment -%>
-        <!-- <%= translation_view_model.comment %> -->
+    <%- plurals.each do |plural_group| -%>
+    <plurals name="<%= plural_group.label %>">
+        <%- plural_group.variants.each do |variant| -%>
+        <%- if variant.comment -%>
+        <!-- <%= variant.comment %> -->
         <%- end -%>
-        <item quantity="<%= translation_view_model.key %>"><%= translation_view_model.value %></item>
+        <item quantity="<%= variant.variant_name %>"><%= variant.value %></item>
         <%- end -%>
     </plurals>
     <%- end -%>

data/lib/ad_localize/templates/ios/Localizable.stringsdict.erb

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <plist>
     <dict>
-        <%- plurals.each do |translation_group| -%>
-        <key><%= translation_group.label %></key>
+        <%- plurals.each do |plural_group| -%>
+        <key><%= plural_group.label %></key>
         <dict>
             <key>NSStringLocalizedFormatKey</key>
             <string>%#@key@</string>
@@ -12,27 +12,27 @@
                 <string>NSStringPluralRuleType</string>
                 <key>NSStringFormatValueTypeKey</key>
                 <string>d</string>
-                <%- translation_group.translation_view_models.each do |translation_view_model| -%>
-                <%- if translation_view_model.comment -%>
-                <!-- <%= translation_view_model.comment %> -->
+                <%- plural_group.variants.each do |variant| -%>
+                <%- if variant.comment -%>
+                <!-- <%= variant.comment %> -->
                 <%- end -%>
-                <key><%= translation_view_model.key -%></key>
-                <string><%= translation_view_model.value -%></string>
+                <key><%= variant.variant_name -%></key>
+                <string><%= variant.value -%></string>
                 <%- end -%>
             </dict>
         </dict>
         <%- end -%>
-        <%- adaptives.each do |translation_group| -%>
-        <key><%= translation_group.label %></key>
+        <%- adaptives.each do |adaptive_group| -%>
+        <key><%= adaptive_group.label %></key>
         <dict>
             <key>NSStringVariableWidthRuleType</key>
             <dict>
-                <%- translation_group.translation_view_models.each do |translation_view_model| -%>
-                <%- if translation_view_model.comment -%>
-                <!-- <%= translation_view_model.comment %> -->
+                <%- adaptive_group.variants.each do |variant| -%>
+                <%- if variant.comment -%>
+                <!-- <%= variant.comment %> -->
                 <%- end -%>
-                <key><%= translation_view_model.key %></key>
-                <string><%= translation_view_model.value %></string>
+                <key><%= variant.variant_name %></key>
+                <string><%= variant.value %></string>
                 <%- end -%>
             </dict>
         </dict>

data/lib/ad_localize/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module AdLocalize
-  VERSION = "5.0.0"
+  VERSION = "6.0.0"
 end

data/lib/ad_localize/view_models/compound_wording_view_model.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+CompoundWordingViewModel = Struct.new(:label, :variants, keyword_init: true)

data/lib/ad_localize/view_models/simple_wording_view_model.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+SimpleWordingViewModel = Struct.new(:label, :value, :comment, :variant_name, keyword_init: true)