ad_localize 5.0.0 → 6.0.0

data/lib/ad_localize.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'active_support'
 require 'active_support/core_ext'
 require 'fileutils'
@@ -8,56 +9,49 @@ require 'csv'
 require 'logger'
 require 'colorize'
 require 'optparse'
-require 'nokogiri'
 require 'erb'
 require 'googleauth'
 require 'google/apis/sheets_v4'
+require 'google/apis/drive_v3'
 
-require 'ad_localize/version'
-require 'ad_localize/ad_logger'
-require 'ad_localize/constant'
-require 'ad_localize/cli'
-require 'ad_localize/option_handler'
-
-require 'ad_localize/repositories/g_sheets_repository'
+require 'ad_localize/repositories/drive_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/view_models/simple_wording_view_model'
+require 'ad_localize/view_models/compound_wording_view_model'
+
+require 'ad_localize/parsers/key_parser'
+require 'ad_localize/parsers/csv_parser'
 
 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/export_wording_options'
-require 'ad_localize/requests/merge_policy'
+require 'ad_localize/entities/platform'
+require 'ad_localize/entities/simple_wording'
+require 'ad_localize/entities/wording_type'
 
+require 'ad_localize/interactors/base_generate_files'
+require 'ad_localize/interactors/process_export_request'
+require 'ad_localize/interactors/parse_csv_files'
+require 'ad_localize/interactors/download_spreadsheets'
 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_csv_locale_wording'
-require 'ad_localize/interactors/platforms/export_platform_factory'
+require 'ad_localize/interactors/generate_info_plist'
+require 'ad_localize/interactors/generate_ios_files'
+require 'ad_localize/interactors/generate_json'
+require 'ad_localize/interactors/generate_localizable_strings'
+require 'ad_localize/interactors/generate_localizable_strings_dict'
+require 'ad_localize/interactors/generate_properties'
+require 'ad_localize/interactors/generate_strings'
+require 'ad_localize/interactors/generate_yaml'
+
+require 'ad_localize/sanitizers/ios_sanitizer'
+require 'ad_localize/sanitizers/ios_to_android_sanitizer'
+require 'ad_localize/sanitizers/pass_through_sanitizer'
 
-require 'ad_localize/serializers/with_template'
+require 'ad_localize/serializers/templated_serializer'
 require 'ad_localize/serializers/info_plist_serializer'
 require 'ad_localize/serializers/localizable_strings_serializer'
 require 'ad_localize/serializers/localizable_stringsdict_serializer'
@@ -66,7 +60,11 @@ require 'ad_localize/serializers/properties_serializer'
 require 'ad_localize/serializers/json_serializer'
 require 'ad_localize/serializers/yaml_serializer'
 
-require 'ad_localize/validators/key_validator'
+require 'ad_localize/requests/export_request'
+require 'ad_localize/option_handler'
+require 'ad_localize/cli'
+require 'ad_localize/version'
+require 'ad_localize/ad_logger'
 
 module AdLocalize
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ad_localize
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Edouard Siegel
@@ -21,7 +21,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-04-18 00:00:00.000000000 Z
+date: 2023-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,39 +106,59 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.3.2
+        version: 1.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
-  type: :runtime
+        version: '2.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.3.2
+        version: 1.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :runtime
+        version: '1.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.3.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.3.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -154,33 +174,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: googleauth
+  name: google-apis-sheets_v4
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: google-apis-sheets_v4
+  name: google-apis-drive_v3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.33.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.33.0
 description: |-
   AdLocalize produces localization files from platform agnostic wording.
                             Supported wording format : CSV. Supported export format: iOS, Android, JSON and YAML
@@ -195,6 +215,8 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -211,59 +233,57 @@ files:
 - lib/ad_localize.rb
 - lib/ad_localize/ad_logger.rb
 - lib/ad_localize/cli.rb
-- lib/ad_localize/constant.rb
 - lib/ad_localize/entities/key.rb
 - lib/ad_localize/entities/locale_wording.rb
-- lib/ad_localize/entities/translation.rb
-- lib/ad_localize/entities/wording.rb
-- lib/ad_localize/interactors/execute_export_request.rb
-- lib/ad_localize/interactors/export_csv_files.rb
-- lib/ad_localize/interactors/export_g_spreadsheet.rb
+- lib/ad_localize/entities/platform.rb
+- lib/ad_localize/entities/simple_wording.rb
+- lib/ad_localize/entities/wording_type.rb
+- lib/ad_localize/interactors/base_generate_files.rb
+- lib/ad_localize/interactors/download_spreadsheets.rb
 - lib/ad_localize/interactors/export_wording.rb
+- lib/ad_localize/interactors/generate_info_plist.rb
+- lib/ad_localize/interactors/generate_ios_files.rb
+- lib/ad_localize/interactors/generate_json.rb
+- lib/ad_localize/interactors/generate_localizable_strings.rb
+- lib/ad_localize/interactors/generate_localizable_strings_dict.rb
+- lib/ad_localize/interactors/generate_properties.rb
+- lib/ad_localize/interactors/generate_strings.rb
+- lib/ad_localize/interactors/generate_yaml.rb
 - lib/ad_localize/interactors/merge_wordings.rb
-- lib/ad_localize/interactors/platforms/export_android_locale_wording.rb
-- lib/ad_localize/interactors/platforms/export_csv_locale_wording.rb
-- lib/ad_localize/interactors/platforms/export_ios_locale_wording.rb
-- lib/ad_localize/interactors/platforms/export_json_locale_wording.rb
-- lib/ad_localize/interactors/platforms/export_platform_factory.rb
-- lib/ad_localize/interactors/platforms/export_properties_locale_wording.rb
-- lib/ad_localize/interactors/platforms/export_yaml_locale_wording.rb
-- lib/ad_localize/mappers/android_translation_mapper.rb
-- lib/ad_localize/mappers/csv_path_to_wording.rb
-- lib/ad_localize/mappers/ios_translation_mapper.rb
+- lib/ad_localize/interactors/parse_csv_files.rb
+- lib/ad_localize/interactors/process_export_request.rb
 - lib/ad_localize/mappers/locale_wording_to_hash.rb
 - lib/ad_localize/mappers/options_to_export_request.rb
-- lib/ad_localize/mappers/translation_group_mapper.rb
-- lib/ad_localize/mappers/translation_mapper.rb
-- lib/ad_localize/mappers/value_range_to_wording.rb
 - lib/ad_localize/option_handler.rb
+- lib/ad_localize/parsers/csv_parser.rb
+- lib/ad_localize/parsers/key_parser.rb
+- lib/ad_localize/repositories/drive_repository.rb
 - lib/ad_localize/repositories/file_system_repository.rb
-- lib/ad_localize/repositories/g_sheets_repository.rb
 - lib/ad_localize/requests/export_request.rb
-- lib/ad_localize/requests/export_wording_options.rb
-- lib/ad_localize/requests/g_spreadsheet_options.rb
-- lib/ad_localize/requests/merge_policy.rb
+- lib/ad_localize/sanitizers/ios_sanitizer.rb
+- lib/ad_localize/sanitizers/ios_to_android_sanitizer.rb
+- lib/ad_localize/sanitizers/pass_through_sanitizer.rb
 - lib/ad_localize/serializers/info_plist_serializer.rb
 - lib/ad_localize/serializers/json_serializer.rb
 - lib/ad_localize/serializers/localizable_strings_serializer.rb
 - lib/ad_localize/serializers/localizable_stringsdict_serializer.rb
 - lib/ad_localize/serializers/properties_serializer.rb
 - lib/ad_localize/serializers/strings_serializer.rb
-- lib/ad_localize/serializers/with_template.rb
+- lib/ad_localize/serializers/templated_serializer.rb
 - lib/ad_localize/serializers/yaml_serializer.rb
 - lib/ad_localize/templates/android/strings.xml.erb
 - lib/ad_localize/templates/ios/InfoPlist.strings.erb
 - lib/ad_localize/templates/ios/Localizable.strings.erb
 - lib/ad_localize/templates/ios/Localizable.stringsdict.erb
 - lib/ad_localize/templates/properties/template.properties.erb
-- lib/ad_localize/validators/key_validator.rb
 - lib/ad_localize/version.rb
-- lib/ad_localize/view_models/translation_group_view_model.rb
-- lib/ad_localize/view_models/translation_view_model.rb
+- lib/ad_localize/view_models/compound_wording_view_model.rb
+- lib/ad_localize/view_models/simple_wording_view_model.rb
 homepage: https://github.com/applidium/ad_localize
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -273,13 +293,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '2.7'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: AdLocalize helps with mobile and web applications wording

data/lib/ad_localize/constant.rb

@@ -1,6 +0,0 @@
-module AdLocalize
-  module Constant
-    COMMENT_KEY_COLUMN_IDENTIFIER = 'comment'.freeze
-    CSV_WORDING_KEYS_COLUMN = 'key'.freeze
-  end
-end

data/lib/ad_localize/entities/translation.rb

@@ -1,32 +0,0 @@
-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
-
-      def ==(o)
-        o.class == self.class &&
-        o.locale == locale &&
-        o.key == key &&
-        o.value == value &&
-        o.comment == comment
-      end
-
-      def has_value?
-        value.present?
-      end
-    end
-  end
-end

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,45 +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("non_empty_values : #{export_request.non_empty_values}")
-        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,20 +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
-        @export_wording = ExportWording.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) }.compact
-        return if wordings.blank?
-
-        wording = @merge_wordings.call(wordings: wordings, merge_policy: export_request.merge_policy)
-        @export_wording.call(export_request: export_request, wording: wording)
-      end
-    end
-  end
-end

data/lib/ad_localize/interactors/export_g_spreadsheet.rb

@@ -1,64 +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
-        @export_wording = ExportWording.new
-        @merge_wordings = MergeWordings.new
-        @export_csv_files = ExportCSVFiles.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) }.compact
-        return if wordings.blank?
-
-        wording = @merge_wordings.call(wordings: wordings, merge_policy: export_request.merge_policy)
-        @export_wording.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?
-          @export_csv_files.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,44 +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(export_wording_options:)
-          platform_dir = export_wording_options.platform_output_directory
-          wording = export_wording_options.wording
-
-          export_wording_options.locales.each do |locale|
-            LOGGER.debug("Starting export Android wording for locale #{locale}")
-            locale_wording = export_wording_options.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
-        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,22 +0,0 @@
-module AdLocalize
-  module Interactors
-    module Platforms
-      class ExportCSVLocaleWording
-        def initialize
-          @file_system_repository = Repositories::FileSystemRepository.new
-        end
-
-        def call(export_wording_options:)
-          LOGGER.debug("Starting export CSV wording")
-          @file_system_repository.create_directory(path: export_wording_options.platform_output_directory)
-          export_wording_options.csv_paths.each_with_index do |csv_path, i|
-            file = File.basename("localization_#{i}.csv")
-            output_path = export_wording_options.platform_output_directory.join(file.to_s)
-            FileUtils.cp(csv_path, output_path)
-          end
-          LOGGER.debug("CSV wording export done !")
-        end
-      end
-    end
-  end
-end