SWAMPy

✎ CARVE FLESH

EDITING: i18n_import.rb

# frozen_string_literal: true

#
# Copyright (C) 2014 - present Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.

module I18nTasks
  class I18nImport
    attr_reader :source_translations, :new_translations, :language

MisMatch = Struct.new(:key, :expected, :actual) do
      def to_s
        "#{key}: expected #{expected.inspect}, got #{actual.inspect}"
      end
    end

def initialize(source_translations, new_translations)
      @source_translations = init_source(source_translations)
      @language = init_language(new_translations)
      Utf8Cleaner.recursively_strip_invalid_utf8!(new_translations, true)
      @new_translations = new_translations[language].flatten_keys
    end

def compare_translations
      [
        [missing_keys, "missing translations"],
        [unexpected_keys, "unexpected translations"]
      ].each do |keys, description|
        next unless keys.present?

case (action = yield(keys.sort, description))
        when :abort
          throw(:abort)
        when :discard,
             :accept
          :ok # <-discard and accept are the same in this case
        else
          raise "don't know how to handle #{action}"
        end
      end
    end

def compare_mismatches
      # Important to populate @placeholder_mismatches and @markdown_mismatches first
      find_mismatches

[
        [@placeholder_mismatches, "placeholder mismatches"],
        [@markdown_mismatches, "markdown/wrapper mismatches"],
      ].each do |mismatches, description|
        next if mismatches.empty?

case (action = yield(mismatches, description))
        when :abort
          throw(:abort)
        when :discard
          @new_translations.delete_if do |k, _v|
            mismatches.any? { |m| m.key == k }
          end
        when :accept
          :ok
        else
          raise "don't know how to handle #{action}"
        end
      end
    end

def compile_complete_translations(&)
      catch(:abort) do
        compare_translations(&)
        compare_mismatches(&)
        complete_translations
      end
    end

def complete_translations
      I18n.available_locales
      base = I18n.backend.send(:translations)[language.to_sym] || {}
      translations = base.flatten_keys.merge(new_translations)
      fix_plural_keys(translations)
      translations.expand_keys
    end

def fix_plural_keys(flat_hash)
      other_keys = flat_hash.keys.grep(/\.other$/)
      other_keys.each do |other_key|
        one_key = other_key.gsub(/other$/, "one")
        if flat_hash[one_key].nil?
          flat_hash[one_key] = flat_hash[other_key]
        end
      end
    end

def missing_keys
      source_translations.keys - new_translations.keys
    end

def unexpected_keys
      new_translations.keys - source_translations.keys
    end

def find_mismatches
      @placeholder_mismatches = []
      @markdown_mismatches = []
      new_translations.each_key do |key|
        next unless source_translations[key]

p1 = placeholders(source_translations[key].to_s)
        p2 = placeholders(new_translations[key].to_s)
        @placeholder_mismatches << MisMatch.new(key, p1, p2) if p1 != p2

m1 = markdown_and_wrappers(source_translations[key].to_s)
        m2 = markdown_and_wrappers(new_translations[key].to_s)
        @markdown_mismatches << MisMatch.new(key, m1, m2) if m1 != m2
      end
    end

LIST_ITEM_PATTERN = /^ {0,3}(\d+\.|\*|\+|-)\s/

def markdown_and_wrappers(str)
      # Since underscores can be wrappers, and underscores can also be inside
      # placeholders (as placeholder names) we need to be unambiguous about
      # underscores in placeholders:
      dashed_str = str.gsub(/%\{([^}]+)\}/) { |x| x.tr("_", "-") }
      # some stuff this doesn't check (though we don't use):
      #   blockquotes, e.g. "> some text"
      #   reference links, e.g. "[an example][id]"
      #   indented code
      matches = scan_and_report(dashed_str, /\\[\\`*_{}\[\]()#+\-.!]/) # escaped special char
                .concat(wrappers(dashed_str))
                .concat(scan_and_report(dashed_str, /(!?\[)[^\]]+\]$([^)"']+).*?$/).map { |m| "link:#{m.last}" }) # links

# only do fancy markdown checks on multi-line strings
      if dashed_str.include?("\n")
        matches.concat(scan_and_report(dashed_str, /^(\#{1,6})\s+[^#]*#*$/).map { |m| "h#{m.first.size}" }) # headings
               .concat(scan_and_report(dashed_str, /^[^=\-\n]+\n^(=+|-+)$/).map { |m| (m.first[0] == "=") ? "h1" : "h2" }) # moar headings
               .concat(scan_and_report(dashed_str, /^((\s*\*\s*){3,}|(\s*-\s*){3,}|(\s*_\s*){3,})$/).map { "hr" })
               .concat(scan_and_report(dashed_str, LIST_ITEM_PATTERN).map { |m| /\d/.match?(m.first) ? "1." : "*" })
      end
      matches.uniq.sort
    end

# return array of balanced wrappers in the source string, e.g.
    # "* **ohai** * user, *welcome*!" => ["**-wrap", "*-wrap"]
    def wrappers(str)
      pattern = /\*+|\++|`+/
      str = str.gsub(LIST_ITEM_PATTERN, "") # ignore markdown lists
      parts = scan_and_report(str, pattern)
      stack = []
      result = []
      parts.each do |part|
        next unless part&.match?(pattern)

if stack.last == part
          result << "#{part}-wrap"
          stack.pop
        else
          stack << part
        end
      end
      result.uniq
    end

def placeholders(str)
      str.scan(/%h?\{[^}]+\}/).sort
    rescue ArgumentError => e
      puts "Unable to scan string: #{str.inspect}"
      raise e
    end

def scan_and_report(str, re)
      str.scan(re)
    rescue ArgumentError => e
      puts "Unable to scan string: #{str.inspect}"
      raise e
    end

private

def init_source(translations)
      raise "Source does not have any English strings" unless translations.key?("en")

translations["en"].flatten_keys
    end

def init_language(translations)
      raise "Translation file contains multiple languages" if translations.size > 1

language = translations.keys.first
      raise "Translation file appears to have only English strings" if language == "en"

language
    end
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 csv_backend.rb	RB	1.1 KB	2023-09-24 03:36	EDIT
📄 environment.rb	RB	1.9 KB	2023-09-24 03:36	EDIT
📄 extract.rb	RB	2.5 KB	2023-09-24 03:36	EDIT
📄 generate_js.rb	RB	2.3 KB	2023-09-24 03:36	EDIT
📄 hash_extensions.rb	RB	1.4 KB	2023-09-24 03:36	EDIT
📄 i18n_import.rb	RB	6.6 KB	2023-09-24 03:36	EDIT
📄 lolcalize.rb	RB	2.2 KB	2023-09-24 03:36	EDIT
📄 railtie.rb	RB	877 B	2023-09-24 03:36	EDIT