ad_localize 5.0.0 → 6.0.0

data/ad_localize.gemspec

@@ -1,4 +1,4 @@
-
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ad_localize/version'
@@ -7,7 +7,6 @@ Gem::Specification.new do |spec|
   spec.name          = 'ad_localize'
   spec.version       = AdLocalize::VERSION
   spec.license       = 'MIT'
-  spec.date          = '2018-04-18'
   spec.authors       = [
     'Edouard Siegel',
     'Patrick Nollet',
@@ -24,11 +23,11 @@ Gem::Specification.new do |spec|
     'Satyan Jacquens',
     'Thomas Esterlin'
   ]
-  spec.email         = %w(joanna.vigne@fabernovel.com pierre.felgines@fabernovel.com edouard.siegel@fabernovel.com)
+  spec.email         = %w[joanna.vigne@fabernovel.com pierre.felgines@fabernovel.com edouard.siegel@fabernovel.com]
 
-  spec.summary       = %q{AdLocalize helps with mobile and web applications wording}
-  spec.description   = %q{AdLocalize produces localization files from platform agnostic wording.
-                          Supported wording format : CSV. Supported export format: iOS, Android, JSON and YAML}
+  spec.summary       = %q(AdLocalize helps with mobile and web applications wording)
+  spec.description   = %q(AdLocalize produces localization files from platform agnostic wording.
+                          Supported wording format : CSV. Supported export format: iOS, Android, JSON and YAML)
   spec.homepage      = 'https://github.com/applidium/ad_localize'
 
   # Specify which files should be added to the gem when it is released.
@@ -45,12 +44,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.11'
   spec.add_development_dependency 'minitest-reporters', '~> 1.3'
   spec.add_development_dependency 'diffy', '~> 3.3'
+  spec.add_development_dependency 'debug', ">= 1.0.0", '< 2.0'
+  spec.add_development_dependency 'rubocop', "~> 1.0"
 
   spec.add_dependency 'activesupport', '>= 6.1.3.2', '< 8.0'
-  spec.add_dependency 'nokogiri', '~> 1.10'
   spec.add_dependency 'colorize', '~> 0.8'
-  spec.add_dependency 'googleauth', '~> 0.12'
   spec.add_dependency 'google-apis-sheets_v4', '~> 0.9'
+  spec.add_dependency 'google-apis-drive_v3', '~> 0.33.0'
 
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 2.7', '< 4.0'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "ad_localize"

data/exe/ad_localize

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

data/lib/ad_localize/ad_logger.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module AdLocalize
   class AdLogger
     def initialize
@@ -6,19 +7,19 @@ module AdLocalize
     end
 
     def warn(text)
-      log(level: Logger::WARN, text: text.yellow)
+      @logger.warn(text.yellow)
     end
 
     def info(text)
-      log(level: Logger::INFO, text: text.blue)
+      @logger.info(text.blue)
     end
 
     def error(text)
-      log(level: Logger::ERROR, text: text.red)
+      @logger.error(text.red)
     end
 
     def debug(text)
-      log(level: Logger::DEBUG, text: text)
+      @logger.debug(text)
     end
 
     def info!
@@ -36,11 +37,5 @@ 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

@@ -1,10 +1,17 @@
+# frozen_string_literal: true
 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)
+      LOGGER.debug("Export request options : #{export_request}")
+      export_request.downloaded_csvs = Interactors::DownloadSpreadsheets.new.call(export_request: export_request) if export_request.has_sheets?
+      Interactors::ProcessExportRequest.new.call(export_request: export_request)
+    ensure
+      export_request&.downloaded_csvs&.each do |file|
+        file.close
+        file.unlink
+      end
     end
   end
-end
+end

data/lib/ad_localize/entities/key.rb

@@ -1,79 +1,6 @@
+# frozen_string_literal: true
 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)|NFCReaderUsageDescription/.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
-
-      def ==(o)
-        o.class == self.class &&
-        o.raw_label == 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
+    Key = Struct.new(:id, :label, :variant_name, :type, keyword_init: true)
   end
-end
+end

data/lib/ad_localize/entities/locale_wording.rb

@@ -1,60 +1,40 @@
+# frozen_string_literal: true
 module AdLocalize
   module Entities
     class LocaleWording
-      attr_reader(:locale, :translations)
+      attr_reader :locale, :is_default, :singulars, :plurals, :adaptives, :info_plists
 
-      def initialize(locale:, translations:)
+      def initialize(locale:, is_default:)
         @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) }
+        @is_default = is_default
+        @singulars = {} # label => SimpleWording
+        @info_plists = {} # label => SimpleWording
+        @plurals = Hash.new { |hash, key| hash[key] = {} } # label: String => { variant_name: String => SimpleWording }
+        @adaptives = Hash.new { |hash, key| hash[key] = {} } # label: String => { variant_name: String => SimpleWording }
+      end
+
+      def add_wording(key:, value:, comment:)
+        wording = SimpleWording.new(key: key, value: value, comment: comment)
+
+        case key.type
+        when WordingType::PLURAL
+          @plurals[key.label][key.variant_name] = wording
+        when WordingType::ADAPTIVE
+          @adaptives[key.label][key.variant_name] = wording
+        when WordingType::INFO_PLIST
+          @info_plists[key.label] = wording
+        else
+          @singulars[key.label] = wording
+        end
+      end
+
+      def to_s
+        "Locale\nis default: #{is_default}\n==========\n" +
+          "Singulars\n#{singulars}\n==========\n" +
+          "InfoPlists\n#{info_plists}\n==========\n" +
+          "Plurals\n#{plurals}\n==========\n" +
+          "Adaptives\n#{adaptives}\n==========\n"
       end
     end
   end
-end
+end

data/lib/ad_localize/entities/platform.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Entities
+    module Platform
+      IOS = 'ios'
+      ANDROID = 'android'
+      YML = 'yml'
+      JSON = 'json'
+      PROPERTIES = 'properties'
+      SUPPORTED_PLATFORMS = [IOS, ANDROID, YML, JSON, PROPERTIES]
+    end
+  end
+end

data/lib/ad_localize/entities/simple_wording.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Entities
+    SimpleWording = Struct.new(:key, :value, :comment, keyword_init: true)
+  end
+end

data/lib/ad_localize/entities/wording_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Entities
+    module WordingType
+      SINGULAR = 'singular'
+      PLURAL = 'plural'
+      INFO_PLIST = 'info_plist'
+      ADAPTIVE = 'adaptive'
+    end
+  end
+end

data/lib/ad_localize/interactors/base_generate_files.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class BaseGenerateFiles
+      def initialize(serializer:)
+        @serializer = serializer
+        raise MissingArgument.new('Missing Serializer') unless serializer
+
+        @file_system_repository = Repositories::FileSystemRepository.new
+      end
+
+      def call(wording:, export_request:)
+        wording.each do |locale, locale_wording|
+          next unless has_wording?(locale_wording: locale_wording)
+
+          path = output_path(locale_wording: locale_wording, export_request: export_request)
+          filename = path.basename
+          LOGGER.debug("[#{locale}] Generating #{filename}")
+          @file_system_repository.create_directory(path: path.dirname)
+          content = @serializer.render(locale_wording: locale_wording)
+          @file_system_repository.write(content: content, path: path)
+          LOGGER.debug("[#{locale}] #{filename} done !")
+        end
+      end
+
+      protected
+
+      def has_wording?(locale_wording:)
+        raise 'override me!'
+      end
+
+      def output_path(locale_wording:, export_request:)
+        raise 'override me!'
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/download_spreadsheets.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class DownloadSpreadsheets
+      def initialize
+        @drive_repository = Repositories::DriveRepository.new
+      end
+
+      def call(export_request:)
+        LOGGER.debug("Downloading spreadsheets")
+        if export_request.export_all
+          @drive_repository.download_all_sheets(spreadsheet_id: export_request.spreadsheet_id)
+        else
+          @drive_repository.download_sheets_by_id(spreadsheet_id: export_request.spreadsheet_id,
+                                                  sheet_ids: export_request.sheet_ids)
+        end
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/export_wording.rb

@@ -1,34 +1,40 @@
+# frozen_string_literal: true
 module AdLocalize
   module Interactors
     class ExportWording
-      def initialize
-        @export_platform_factory = Platforms::ExportPlatformFactory.new
-      end
-
       def call(export_request:, wording:)
-        LOGGER.debug("Starting export wording")
         export_request.platforms.each do |platform|
-          platform_interactor = @export_platform_factory.build(platform: platform)
-          options = build_export_wording_options(wording: wording, export_request: export_request, platform: platform)
-          platform_interactor.call(export_wording_options: options)
+          configure_output_directory(platform: platform, export_request: export_request)
+          LOGGER.debug("[#{platform}] Start exporting in #{export_request.output_dir}")
+          export_platform(wording: wording, platform: platform, export_request: export_request)
+          LOGGER.debug("[#{platform}] done !")
         end
       end
 
       private
 
-      def build_export_wording_options(wording:, export_request:, platform:)
-        platform_output_directory = export_request.output_path
-        platform_output_directory = platform_output_directory.join(platform.to_s) if export_request.multiple_platforms?
-        locales = export_request.locales.size.zero? ? wording.locales : wording.locales & export_request.locales
+      def configure_output_directory(platform:, export_request:)
+        if export_request.many_platforms?
+          export_request.output_dir = export_request.output_path.join(platform)
+        else
+          export_request.output_dir = export_request.output_path
+        end
+      end
 
-        Requests::ExportWordingOptions.new(
-          locales: locales,
-          wording: wording,
-          platform_output_directory: platform_output_directory,
-          bypass_empty_values: export_request.non_empty_values,
-          csv_paths: export_request.csv_paths
-        )
+      def export_platform(wording:, platform:, export_request:)
+        case platform
+        when Entities::Platform::IOS
+          GenerateIOSFiles.new.call(wording: wording, export_request: export_request)
+        when Entities::Platform::ANDROID
+          GenerateStrings.new.call(wording: wording, export_request: export_request)
+        when Entities::Platform::YML
+          GenerateYAML.new.call(wording: wording, export_request: export_request)
+        when Entities::Platform::JSON
+          GenerateJSON.new.call(wording: wording, export_request: export_request)
+        when Entities::Platform::PROPERTIES
+          GenerateProperties.new.call(wording: wording, export_request: export_request)
+        end
       end
     end
   end
-end
+end

data/lib/ad_localize/interactors/generate_info_plist.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class GenerateInfoPlist < BaseGenerateFiles
+      INFO_PLIST_FILENAME = "InfoPlist.strings".freeze
+      LOCALE_DIRECTORY_CONVENTION = "%{locale}.lproj".freeze
+
+      def initialize
+        super(serializer: Serializers::InfoPlistSerializer.new)
+      end
+
+      private
+
+      def has_wording?(locale_wording:)
+        locale_wording.info_plists.any?
+      end
+
+      def output_path(locale_wording:, export_request:)
+        locale_directory_name = LOCALE_DIRECTORY_CONVENTION % { locale: locale_wording.locale }
+        export_request.output_dir.join(locale_directory_name, INFO_PLIST_FILENAME)
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/generate_ios_files.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class GenerateIOSFiles
+      def call(wording:, export_request:)
+        GenerateInfoPlist.new.call(wording: wording, export_request: export_request)
+        GenerateLocalizableStrings.new.call(wording: wording, export_request: export_request)
+        GenerateLocalizableStringsDict.new.call(wording: wording, export_request: export_request)
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/generate_json.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class GenerateJSON < BaseGenerateFiles
+      def initialize
+        super(serializer: Serializers::JSONSerializer.new)
+      end
+
+      private
+
+      def has_wording?(locale_wording:)
+        locale_wording.singulars.any? || locale_wording.plurals.any?
+      end
+
+      def output_path(locale_wording:, export_request:)
+        export_request.output_dir.join("#{locale_wording.locale}.json")
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/generate_localizable_strings.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class GenerateLocalizableStrings < BaseGenerateFiles
+      LOCALIZABLE_STRINGS_FILENAME = "Localizable.strings".freeze
+      LOCALE_DIRECTORY_CONVENTION = "%{locale}.lproj".freeze
+
+      def initialize
+        super(serializer: Serializers::LocalizableStringsSerializer.new)
+      end
+
+      private
+
+      def has_wording?(locale_wording:)
+        locale_wording.singulars.any?
+      end
+
+      def output_path(locale_wording:, export_request:)
+        locale_directory_name = LOCALE_DIRECTORY_CONVENTION % { locale: locale_wording.locale }
+        export_request.output_dir.join(locale_directory_name, LOCALIZABLE_STRINGS_FILENAME)
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/generate_localizable_strings_dict.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class GenerateLocalizableStringsDict < BaseGenerateFiles
+      LOCALIZABLE_STRINGSDICT_FILENAME = "Localizable.stringsdict".freeze
+      LOCALE_DIRECTORY_CONVENTION = "%{locale}.lproj".freeze
+
+      def initialize
+        super(serializer: Serializers::LocalizableStringsdictSerializer.new)
+      end
+
+      private
+
+      def has_wording?(locale_wording:)
+        locale_wording.plurals.any? || locale_wording.adaptives.any?
+      end
+
+      def output_path(locale_wording:, export_request:)
+        locale_directory_name = LOCALE_DIRECTORY_CONVENTION % { locale: locale_wording.locale }
+        export_request.output_dir.join(locale_directory_name, LOCALIZABLE_STRINGSDICT_FILENAME)
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/generate_properties.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class GenerateProperties < BaseGenerateFiles
+      def initialize
+        super(serializer: Serializers::PropertiesSerializer.new)
+      end
+
+      private
+
+      def has_wording?(locale_wording:)
+        locale_wording.singulars.any?
+      end
+
+      def output_path(locale_wording:, export_request:)
+        export_request.output_dir.join("#{locale_wording.locale}.properties")
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/generate_strings.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class GenerateStrings < BaseGenerateFiles
+      STRINGS_FILENAME = 'strings.xml'.freeze
+      LOCALE_DIRECTORY_CONVENTION = "values".freeze
+
+      def initialize
+        super(serializer: Serializers::StringsSerializer.new)
+      end
+
+      private
+
+      def has_wording?(locale_wording:)
+        locale_wording.singulars.any? || locale_wording.plurals.any?
+      end
+
+      def output_path(locale_wording:, export_request:)
+        locale_dir = LOCALE_DIRECTORY_CONVENTION
+        locale_dir += "-#{locale_wording.locale}" if !locale_wording.is_default
+        export_request.output_dir.join(locale_dir, STRINGS_FILENAME)
+      end
+    end
+  end
+end

data/lib/ad_localize/interactors/generate_yaml.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module AdLocalize
+  module Interactors
+    class GenerateYAML < BaseGenerateFiles
+      def initialize
+        super(serializer: Serializers::YAMLSerializer.new)
+      end
+
+      private
+
+      def has_wording?(locale_wording:)
+        locale_wording.singulars.any? || locale_wording.plurals.any?
+      end
+
+      def output_path(locale_wording:, export_request:)
+        export_request.output_dir.join("#{locale_wording.locale}.yml")
+      end
+    end
+  end
+end