ad_localize 3.6.0 → 4.0.0

data/ad_localize.gemspec

@@ -49,7 +49,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '>= 5.2', '< 7.0'
   spec.add_dependency 'nokogiri', '~> 1.10'
   spec.add_dependency 'colorize', '~> 0.8'
+  spec.add_dependency 'google-api-client', '~> 0.34'
   spec.add_dependency 'googleauth', '~> 0.12'
+  spec.add_dependency 'mime-types', '~> 3.3'
 
   spec.required_ruby_version = '~> 2.3'
 end

data/bin/console

@@ -2,6 +2,7 @@
 
 require "bundler/setup"
 require "ad_localize"
+require 'byebug'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/exe/ad_localize

@@ -1,3 +1,3 @@
 #! /usr/bin/env ruby
 require 'ad_localize'
-AdLocalize::Runner.new.run(ARGV)
+AdLocalize::CLI.start(args: ARGV)

data/lib/ad_localize.rb

@@ -7,24 +7,65 @@ require 'json'
 require 'csv'
 require 'logger'
 require 'colorize'
-require 'open-uri'
-require 'stringio'
-require 'googleauth'
 require 'optparse'
 require 'nokogiri'
+require 'mime/types'
+require 'erb'
+require 'googleauth'
+require 'google/apis/sheets_v4'
 
 require 'ad_localize/version'
 require 'ad_localize/ad_logger'
 require 'ad_localize/constant'
-require 'ad_localize/csv_file_manager'
-require 'ad_localize/csv_parser'
+require 'ad_localize/cli'
 require 'ad_localize/option_handler'
-require 'ad_localize/runner'
-require 'ad_localize/platform/platform_formatter'
-require 'ad_localize/platform/android_formatter'
-require 'ad_localize/platform/ios_formatter'
-require 'ad_localize/platform/json_formatter'
-require 'ad_localize/platform/yml_formatter'
+
+require 'ad_localize/repositories/g_sheets_repository'
+require 'ad_localize/repositories/file_system_repository'
+
+require 'ad_localize/view_models/translation_view_model'
+require 'ad_localize/view_models/translation_group_view_model'
+
+require 'ad_localize/mappers/options_to_export_request'
+require 'ad_localize/mappers/csv_path_to_wording'
+require 'ad_localize/mappers/locale_wording_to_hash'
+require 'ad_localize/mappers/value_range_to_wording'
+require 'ad_localize/mappers/translation_mapper'
+require 'ad_localize/mappers/translation_group_mapper'
+require 'ad_localize/mappers/android_translation_mapper'
+require 'ad_localize/mappers/ios_translation_mapper'
+
+require 'ad_localize/entities/key'
+require 'ad_localize/entities/translation'
+require 'ad_localize/entities/locale_wording'
+require 'ad_localize/entities/wording'
+
+require 'ad_localize/requests/g_spreadsheet_options'
+require 'ad_localize/requests/export_request'
+require 'ad_localize/requests/merge_policy'
+
+require 'ad_localize/interactors/merge_wordings'
+require 'ad_localize/interactors/execute_export_request'
+require 'ad_localize/interactors/export_csv_files'
+require 'ad_localize/interactors/export_g_spreadsheet'
+require 'ad_localize/interactors/export_wording'
+require 'ad_localize/interactors/platforms/export_android_locale_wording'
+require 'ad_localize/interactors/platforms/export_ios_locale_wording'
+require 'ad_localize/interactors/platforms/export_json_locale_wording'
+require 'ad_localize/interactors/platforms/export_yaml_locale_wording'
+require 'ad_localize/interactors/platforms/export_properties_locale_wording'
+require 'ad_localize/interactors/platforms/export_platform_factory'
+
+require 'ad_localize/serializers/with_template'
+require 'ad_localize/serializers/info_plist_serializer'
+require 'ad_localize/serializers/localizable_strings_serializer'
+require 'ad_localize/serializers/localizable_stringsdict_serializer'
+require 'ad_localize/serializers/strings_serializer'
+require 'ad_localize/serializers/properties_serializer'
+require 'ad_localize/serializers/json_serializer'
+require 'ad_localize/serializers/yaml_serializer'
+
+
 
 module AdLocalize
   class Error < StandardError; end

data/lib/ad_localize/ad_logger.rb

@@ -1,21 +1,28 @@
 module AdLocalize
   class AdLogger
-    SEVERITY = { debug: Logger::DEBUG , info: Logger::INFO, warn: Logger::WARN, error: Logger::ERROR, fatal: Logger::FATAL, unknown: Logger::UNKNOWN }
-    AUTHORIZED_COLORS  = [:black, :yellow, :red, :blue, :green]
-
     def initialize
       @logger = Logger.new(STDOUT)
       @logger.level = Logger::INFO
     end
 
-    def log(level, color, text)
-      exit unless text and level and color
+    def warn(text)
+      log(level: Logger::WARN, text: text.yellow)
+    end
+
+    def info(text)
+      log(level: Logger::INFO, text: text.blue)
+    end
 
-      level, color = [level, color].map(&:to_sym)
-      raise "Color not supported" unless AUTHORIZED_COLORS.include? color
-      raise "Invalid severity" unless SEVERITY.dig(level)
+    def error(text)
+      log(level: Logger::ERROR, text: text.red)
+    end
 
-      @logger.add(SEVERITY.dig(level), text.send(color))
+    def debug(text)
+      log(level: Logger::DEBUG, text: text.black)
+    end
+
+    def info!
+      @logger.level = Logger::INFO
     end
 
     def debug!
@@ -29,5 +36,11 @@ module AdLocalize
     def close
       @logger.close
     end
+
+    private
+
+    def log(level:, text:)
+      @logger.add(level, text)
+    end
   end
 end

data/lib/ad_localize/cli.rb

@@ -0,0 +1,10 @@
+module AdLocalize
+  class CLI
+    def self.start(args:)
+      options = OptionHandler.parse!(args)
+      export_request = Mappers::OptionsToExportRequest.new.map(options: options)
+      export_request.csv_paths = options[:csv_paths]
+      Interactors::ExecuteExportRequest.new.call(export_request: export_request)
+    end
+  end
+end

data/lib/ad_localize/constant.rb

@@ -1,25 +1,6 @@
 module AdLocalize
   module Constant
-    SUPPORTED_PLATFORMS = %w(ios android yml json)
-    PLURAL_KEY_SYMBOL = :plural
-    ADAPTIVE_KEY_SYMBOL = :adaptive
-    SINGULAR_KEY_SYMBOL = :singular
-    COMMENT_KEY_SYMBOL = :comment
-    INFO_PLIST_KEY_SYMBOL = :info_plist
-    COMMENT_KEY_COLUMN_IDENTIFIER = "comment"
-    DEFAULT_CONFIG = {
-      platforms: {
-        export_directory_names: {
-          ios: "%{locale}.lproj",
-          android: "values%{locale}"
-        }
-      }
-    }
-    CONFIG = YAML.load_file(Pathname::pwd + 'config.yml').deep_symbolize_keys rescue DEFAULT_CONFIG
-    EXPORT_FOLDER = 'exports'
-    IOS_SINGULAR_EXPORT_FILENAME = "Localizable.strings"
-    IOS_INFO_PLIST_EXPORT_FILENAME = "InfoPlist.strings"
-    IOS_PLURAL_EXPORT_FILENAME = "Localizable.stringsdict"
-    ANDROID_EXPORT_FILENAME = "strings.xml"
+    COMMENT_KEY_COLUMN_IDENTIFIER = 'comment'.freeze
+    CSV_WORDING_KEYS_COLUMN = 'key'.freeze
   end
 end

data/lib/ad_localize/entities/key.rb

@@ -0,0 +1,74 @@
+module AdLocalize
+  module Entities
+    class Key
+      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)/.freeze
+
+      def initialize(label:)
+        @label = label
+      end
+
+      def plural_key
+        @plural_key ||= compute_plural_key
+      end
+
+      def plural?
+        plural_key.present?
+      end
+
+      def adaptive?
+        adaptive_key.present?
+      end
+
+      def adaptive_key
+        @adaptive_key ||= compute_adaptive_key
+      end
+
+      def info_plist?
+        @label.match(INFO_PLIST_KEY_REGEXP).present?
+      end
+
+      def singular?
+        !(plural? || adaptive? || info_plist?)
+      end
+
+      def label
+        compute_label.strip
+      end
+
+      def raw_label
+        @label
+      end
+
+      def same_as?(key:)
+        raw_label == key.raw_label
+      end
+
+      private
+
+      def compute_label
+        if plural?
+          @label.gsub(PLURAL_KEY_REGEXP, '')
+        elsif adaptive?
+          @label.gsub(ADAPTIVE_KEY_REGEXP, '')
+        else
+          @label
+        end
+      end
+
+      def compute_plural_key
+        match = @label.match(PLURAL_KEY_REGEXP)
+        return unless match
+        match.captures.first
+      end
+
+      def compute_adaptive_key
+        match = @label.match(ADAPTIVE_KEY_REGEXP)
+        return unless match
+        match.captures.first
+      end
+    end
+  end
+end

data/lib/ad_localize/entities/locale_wording.rb

@@ -0,0 +1,60 @@
+module AdLocalize
+  module Entities
+    class LocaleWording
+      attr_reader(:locale, :translations)
+
+      def initialize(locale:, translations:)
+        @locale = locale
+        @translations = translations
+      end
+
+      def has_plural_keys?
+        plurals.present?
+      end
+
+      def has_info_plist_keys?
+        info_plists.present?
+      end
+
+      def has_singular_keys?
+        singulars.present?
+      end
+
+      def has_adaptive_keys?
+        adaptives.present?
+      end
+
+      def plurals
+        @plurals ||= @translations.select { |translation| translation.key.plural? }.group_by { |translation| translation.key.label }
+      end
+
+      def info_plists
+        @info_plists ||= @translations.select { |translation| translation.key.info_plist? }
+      end
+
+      def singulars
+        @singulars ||= @translations.select { |translation| translation.key.singular? }
+      end
+
+      def adaptives
+        @adaptives ||= @translations.select { |translation| translation.key.adaptive? }.group_by { |translation| translation.key.label }
+      end
+
+      def add_translation(translation:)
+        @translations.push(translation)
+      end
+
+      def keys
+        @translations.map(&:key)
+      end
+
+      def has_key?(key:)
+        translation_for(key: key).present?
+      end
+
+      def translation_for(key:)
+        @translations.find { |translation| translation.key.same_as?(key: key) }
+      end
+    end
+  end
+end

data/lib/ad_localize/entities/translation.rb

@@ -0,0 +1,20 @@
+module AdLocalize
+  module Entities
+    class Translation
+      attr_reader(
+        :locale,
+        :key,
+        :comment
+      )
+
+      attr_accessor(:value)
+
+      def initialize(locale:, key:, value:, comment: nil)
+        @locale = locale
+        @key = key
+        @value = value
+        @comment = comment
+      end
+    end
+  end
+end

data/lib/ad_localize/entities/wording.rb

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

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

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

@@ -0,0 +1,55 @@
+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)
+          downloaded_files.select { |downloaded_file| File.exist?(downloaded_file.path) }.each do |downloaded_file|
+            downloaded_file.close
+            downloaded_file.unlink
+          end
+        else
+          LOGGER.error("invalid export request. check the spreadsheet share configuration")
+        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