modpack_localizer 0.1.0

data/lib/modpack_localizer/jar/reader.rb

@@ -0,0 +1,158 @@
+require "zip"
+require "json"
+require "countries"
+require "iso-639"
+
+module ModpackLocalizer
+  module JAR
+    # .jarファイルから言語ファイルの内容とメタデータを抽出するクラス
+    class Reader
+      # 例: ja_jp
+      LOCALE_CODE_REGEX = /\A[a-z]{2,3}_[a-z]{2,3}\z/
+
+      # performerに渡すレスポンス
+      #
+      # @param [Boolean] need_translation 翻訳が必要か
+      # @param [Hash] json 言語ファイルの内容
+      # @param [String] file_name ファイル名
+      # @param [String] locale_code ロケールコード
+      # @param [String] mod_name mod名
+      # @return [LangData]
+      LangData = Struct.new(
+        :need_translation, :json, :file_name, :locale_code, :mod_name
+      )
+
+      # locale_codeが渡された場合、languageとcountry_nameは不要
+      #
+      # @param [String] file_path ファイルのパス
+      # @param [String] language 言語
+      # @param [String] country_name 国
+      # @param [String] locale_code ロケールコード
+      # @return [ModpackLocalizer::JAR::Reader]
+      def initialize(file_path, language, country_name, locale_code)
+        @file_path, @language, @country_name = file_path, language, country_name
+        @locale_code =
+          locale_code&.downcase || make_locale_code(get_language_code(language), get_country_code(country_name))
+        # 引数としてlocale_codeが渡された時はチェックしない
+        # brb(Netherlands)のような、正規表現にマッチしないlocale_codeが存在するため(brbはISO 639-3でqbr_NL)
+        validate_locale_code(@locale_code) unless locale_code
+      end
+
+      # 言語ファイルの内容とメタデータを抽出する
+      #
+      # @return [LangData] 言語ファイルの内容とメタデータ
+      # @raise [ModpackLocalizer::InvalidRegionCodeError] locale_codeが不正な場合
+      def extract_lang_json_and_meta_data
+        Zip::File.open(@file_path) do |jar|
+          # 対象の言語ファイルが存在する場合は翻訳が必要ない
+          target_lang_file = find_lang_json(jar, @locale_code)
+          if target_lang_file
+            return LangData.new(
+              false, {}, target_lang_file, nil, extract_mod_name(target_lang_file)
+            )
+          end
+
+          lang_file = find_lang_json(jar, "en_us")
+          raw_json = JSON.parse(lang_file.get_input_stream.read)
+
+          LangData.new(
+            true, except_comment(raw_json), lang_file, @locale_code, extract_mod_name(lang_file)
+          )
+        end
+      end
+
+      # フルパスからファイル名を抽出する
+      #
+      # @param [Zip::Entry] file ファイル
+      # @return [String] ファイル名
+      def extract_file_name(file)
+        file.name.split("/").last
+      end
+
+      private
+
+      # ロケールコードのバリデーション
+      #
+      # @param [String] locale_code ロケールコード
+      # @return [Boolean]
+      def validate_locale_code(locale_code)
+        return if locale_code.match(LOCALE_CODE_REGEX)
+
+        raise ModpackLocalizer::InvalidRegionCodeError.new(locale_code)
+      end
+
+      # .jar内の言語ファイルを取得する
+      #
+      # @param [Zip::File] opened_jar .jarファイル
+      # @param [String] locale_code ロケールコード
+      # @return [Zip::Entry] 言語ファイル
+      def find_lang_json(opened_jar, locale_code)
+        lang_files = opened_jar.glob("**/lang/*.json")
+
+        lang_files.find { |entry| target_locale_file?(entry, locale_code) }
+      end
+
+      # JSONからコメントを除外する
+      #
+      # @param [Hash] hash JSONのハッシュ
+      # @return [Hash] コメントを除外したハッシュ
+      def except_comment(hash)
+        hash.except("_comment")
+      end
+
+      # 対象の言語ファイルかどうか
+      #
+      # @param [Zip::Entry] file ファイル
+      # @param [String] locale_code ロケールコード
+      # @return [Boolean]
+      def target_locale_file?(file, locale_code)
+        file_name = extract_file_name(file)
+
+        file_name.include?("#{locale_code}.json")
+      end
+
+      # フルパスからmod名を抽出する
+      #
+      # @param [Zip::Entry] file ファイル
+      # @return [String] mod名
+      def extract_mod_name(file)
+        file.name.split("/").last(3).first
+      end
+
+      # ロケールコードを生成する
+      #
+      # @param [String] lang_code 言語コード
+      # @param [String] country_code 国コード
+      # @return [String] ロケールコード
+      def make_locale_code(lang_code, country_code)
+        "#{lang_code}_#{country_code}"
+      end
+
+      # 言語名から言語コードを取得する
+      #
+      # @param [String] language_name 言語名
+      # @return [String] 言語コード
+      def get_language_code(language_name)
+        result = ISO_639.find_by_english_name(optimize(language_name))
+        result&.alpha2&.downcase || result&.alpha3&.downcase
+      end
+
+      # 国名から国コードを取得する
+      #
+      # @param [String] country_name 国名
+      # @return [String] 国コード
+      def get_country_code(country_name)
+        result = ISO3166::Country.find_country_by_any_name(optimize(country_name))
+        result&.alpha2&.downcase || result&.alpha3&.downcase
+      end
+
+      # ISO関連のgemが受け付けられる形式に変換
+      #
+      # @param [String] str 文字列
+      # @return [String] 変換後の文字列
+      def optimize(str)
+        str.gsub("_", " ").split.map(&:capitalize).join(" ")
+      end
+    end
+  end
+end

data/lib/modpack_localizer/jar/writer.rb

@@ -0,0 +1,121 @@
+require "zip"
+
+module ModpackLocalizer
+  module JAR
+    # .jarファイルを翻訳してリソースパックを作成するクラス
+    class Writer
+      # 1.19.2
+      PACK_FORMAT = 9
+
+      # @return [ModpackLocalizer::JAR::Writer]
+      def initialize
+        @output_path_base = "output/mods/modpack_localizer"
+        @output_path = nil
+      end
+
+      # リソースパックを作成する
+      #
+      # @param [ModpackLocalizer::JAR::Reader::LangData] results 言語ファイルの内容とメタデータ
+      # @return [void]
+      def make_resource_pack(results)
+        results.file_name = replace_default_locale_code(results.file_name.name, results.locale_code)
+        @output_path = merge_base_path(results.file_name)
+
+        make_file(@output_path, results.json)
+        mcmeta_info = mcmeta(PACK_FORMAT, results.locale_code)
+        make_file(mcmeta_info[:file_path], mcmeta_info[:meta_data])
+
+        zipping_resource_pack
+      end
+
+      # zipにする前に作成したリソースパックを削除する
+      # return [void]
+      def remove_before_zipping_directory
+        FileUtils.rm_rf(@output_path_base)
+      end
+
+      private
+
+      # ファイル名のロケールコードを指定のロケールコードに置き換える
+      #
+      # @param [String] file_name ファイル名
+      # @param [String] locale_code ロケールコード
+      # @return [String] ロケールコードが置き換わったファイル名
+      def replace_default_locale_code(file_name, locale_code)
+        file_name.gsub("en_us", locale_code)
+      end
+
+      # ファイルの出力先のパスを生成する
+      #
+      # @param [String] file_name ファイル名
+      # @return [String] ファイルの出力先のパス
+      def merge_base_path(file_name)
+        "#{@output_path_base}/#{file_name}"
+      end
+
+      # ファイルを作成する
+      #
+      # @param [String] path ファイルのパス
+      # @param [Hash] data ファイルに書き込むデータ
+      # @return [void]
+      def make_file(path, data = nil)
+        expand_path = File.expand_path(path)
+        dir_path = File.dirname(expand_path)
+
+        FileUtils.mkdir_p(dir_path) unless File.directory?(dir_path)
+
+        File.open(expand_path, "w") do |file|
+          file.puts(data.nil? ? "" : JSON.pretty_generate(data))
+        end
+      end
+
+      # rubocop:disable Lint/SymbolConversion
+      # pack.mcmetaを作成するための情報
+      #
+      # @param [Integer] pack_format リソースパックのバージョン
+      # @param [String] locale_code ロケールコード
+      # @return [Hash] pack.mcmetaの情報
+      def mcmeta(pack_format, locale_code)
+        meta_data = {
+          "pack": {
+            "pack_format": pack_format,
+            "description": "Localized for #{locale_code} by ModpackLocalizer"
+          }
+        }
+
+        file_path = "#{@output_path_base}/pack.mcmeta"
+        { file_path: file_path, meta_data: meta_data }
+      end
+      # rubocop:enable Lint/SymbolConversion
+
+      # リソースパックをzipにする
+      #
+      # @return [void]
+      def zipping_resource_pack
+        Zip::File.open("#{@output_path_base}.zip", create: true) do |zip|
+          extract_inner_files { |file| add_file_to_zip(zip, file) }
+        end
+      end
+
+      # ディレクトリ内のファイルをzipに追加する
+      #
+      # @yield [String] file ファイル
+      # @return [void]
+      def extract_inner_files(&block)
+        Dir.glob("#{@output_path_base}/**/*").each do |file|
+          block.call(file)
+        end
+      end
+
+      # ファイルをzipに追加する
+      #
+      # @param [Zip::File] zip zipファイル
+      # @param [String] file ファイル
+      # @return [void]
+      def add_file_to_zip(zip, file)
+        entry_name = file.sub("#{@output_path_base}/", "")
+        zip.add(entry_name, file) unless zip.find_entry(entry_name)
+      end
+    end
+  end
+end

data/lib/modpack_localizer/snbt/description_extractor.rb

@@ -0,0 +1,118 @@
+require_relative "../util/indent_helper"
+
+module ModpackLocalizer
+  module SNBT
+    # SNBT形式のファイルからdescription: ["some description"]を抽出するモジュール
+    module DescriptionExtractor
+      include IndentHelper
+
+      # description: ["some description"]を抽出する
+      #
+      # @param [String] file_path ファイルのパス
+      # @return [Array<Hash>] 説明、開始行番号、終了行番号の配列
+      def extract_descriptions(file_path)
+        lines = File.readlines(file_path)
+        extract_from_file(lines)
+      end
+
+      private
+
+      # ファイルから説明を抽出する
+      #
+      # @param [Array<String>] lines 行の配列
+      # @return [Array<Hash>] 説明、開始行番号、終了行番号、インデントのハッシュの配列
+      def extract_from_file(lines)
+        descs = []
+        desc_content = []
+        start_line = nil
+
+        lines.each_with_index do |line, index|
+          indent = count_indent(line)
+
+          # 1行の説明の場合はそのままハッシュに変換
+          # 複数行の場合は、開始行と終了行の間の説明を抽出する
+          if oneline?(line)
+            descs << build_oneline(line, index, indent)
+          elsif start_line?(line)
+            start_line = index
+          elsif middle_line?(line, start_line)
+            desc_content << line.strip
+          elsif end_line?(line, start_line)
+            descs << build_multiline(desc_content, start_line, index, indent)
+            start_line = nil
+            desc_content = []
+          end
+        end
+
+        descs
+      end
+
+      # 1行かどうか
+      #
+      # @param [String] line 行
+      # @return [Boolean]
+      def oneline?(line)
+        oneline_description?(line)
+      end
+
+      # 開始行かどうか
+      #
+      # @param [String] line 行
+      # @return [Boolean]
+      def start_line?(line)
+        start_of?(line, key: :description)
+      end
+
+      # 終了行かどうか
+      #
+      # @param [String] line 行
+      # @param [Integer] start_line 開始行番号
+      # @return [Boolean]
+      def end_line?(line, start_line)
+        line.strip.end_with?("]") && start_line
+      end
+
+      # 中間行かどうか
+      #
+      # @param [String] line 行
+      # @param [Integer] start_line 開始行番号
+      # @return [Boolean]
+      def middle_line?(line, start_line)
+        line.strip != "]" && start_line
+      end
+
+      # 1行の処理
+      #
+      # @param [String] line 行
+      # @param [Integer] index 行番号
+      # @param [Integer] indent インデント
+      # @return [Hash] 説明、開始行番号、終了行番号、インデントのハッシュ
+      def build_oneline(line, index, indent)
+        {
+          type: :description,
+          text: extract_oneline(line, is_desc: true),
+          start_line: index,
+          end_line: index,
+          indent: indent
+        }
+      end
+
+      # 複数行の処理
+      #
+      # @param [Array<String>] content 説明の配列
+      # @param [Integer] start_line 開始行番号
+      # @param [Integer] index 行番号
+      # @param [Integer] indent インデント
+      # @return [Hash] 説明、開始行番号、終了行番号、インデントのハッシュ
+      def build_multiline(content, start_line, index, indent)
+        {
+          type: :description,
+          text: content.join("\n"),
+          start_line: start_line,
+          end_line: index,
+          indent: indent
+        }
+      end
+    end
+  end
+end

data/lib/modpack_localizer/snbt/formatter.rb

@@ -0,0 +1,196 @@
+require_relative "../util/indent_helper"
+
+module ModpackLocalizer
+  module SNBT
+    # 翻訳された内容をSNBT形式に整形するクラス
+    class Formatter
+      include IndentHelper
+
+      # 保存できるように整形
+      #
+      # @param [Hash] content コンテンツ
+      # @param [String] indent インデント
+      # @return [String] SNBT形式に整形したコンテンツ
+      def format_overwritable_lines(content, indent)
+        full_lines = adjust_line_length(content)
+        format_for_snbt(full_lines, indent, content)
+      end
+
+      # SNBT形式に整形
+      #
+      # @param [Array<String>] lines 行
+      # @param [String] indent インデント
+      # @param [Hash] content コンテンツ
+      # @return [String] SNBT形式に整形した行
+      def format_for_snbt(lines, indent, content)
+        lines = prepare_lines_for_snbt(lines, content)
+        formatted_lines = format_lines(lines, indent, content)
+        "#{indent}#{content[:type]}: #{formatted_lines}"
+      end
+
+      # 行数をstart_line~end_lineと一致させる
+      #
+      # @param [Hash] content コンテンツ
+      # @return [void]
+      def adjust_line_length(content)
+        required_lines = extract_required_line_counts(content)
+        lines = content[:text].split("\n")
+
+        delete_over_lines(lines, required_lines)
+        add_missing_lines(lines, required_lines, content[:indent])
+
+        lines
+      end
+
+      private
+
+      # 不要な文字を削除する
+      #
+      # @param [String] lines 行
+      # @param [Hash] content コンテンツ
+      # @return [Array<String>] 不要な文字を削除した行
+      def prepare_lines_for_snbt(lines, content)
+        lines.map! { |line| delete_unwanted_symbols(line) }
+        lines.map!(&:strip) unless content[:type] == :description
+        lines
+      end
+
+      # SNBT形式に変換しやすい形に整形
+      #
+      # @param [Array<String>] lines 行
+      # @param [String] indent インデント
+      # @param [Hash] content コンテンツ
+      # @return [String] SNBT形式に変換しやすく整形した行
+      def format_lines(lines, indent, content)
+        if lines.length == 1
+          content[:type] == :description ? "[#{lines[0].strip}]" : lines[0].strip.to_s
+        else
+          # [
+          #   "Hello"
+          #   "World"
+          # ]
+          mid_indent = middle_indent(content[:indent])
+          lines = lines.map { |line| "#{mid_indent}#{line.strip}" }
+          "[\n#{lines.join("\n")}\n#{indent}]"
+        end
+      end
+
+      # 必要な行数を抽出
+      #
+      # @param [Hash] content コンテンツ
+      # @return [Integer] 必要な行数
+      def extract_required_line_counts(content)
+        # start_lineが1、end_lineが5の場合、必要な行数はブラケットを抜いて3行
+        # そのため、(end(5) - start(1)) + 1行 - ブラケット2行 = 3行となる
+        line_offset, without_brackets = 1, 2
+
+        (content[:end_line] - content[:start_line]) + line_offset - without_brackets
+      end
+
+      # 不要な行を削除
+      #
+      # @param [Array<String>] lines 行
+      # @param [Integer] required_lines 必要な行数
+      # @return [void]
+      def delete_over_lines(lines, required_lines)
+        return unless lines.length > required_lines
+
+        gap_length = lines.length - required_lines
+        gap_length.times do
+          index = lines.index("")
+          lines.delete_at(index) if index
+        end
+      end
+
+      # 不足している行を追加
+      #
+      # @param [Array<String>] lines 行
+      # @param [Integer] required_lines 必要な行数
+      # @param [String] indent インデント
+      # @return [void]
+      def add_missing_lines(lines, required_lines, indent)
+        return unless lines.length < required_lines
+
+        while lines.length < required_lines
+          lines << empty_middle_line(indent)
+        end
+      end
+
+      # 中間行の空行を作成
+      #
+      # @return [String] 空行
+      def empty_middle_line(indent)
+        middle_indent(indent).to_s
+      end
+
+      # 不要な記号を削除
+      #
+      # @param [String] line 行
+      # @return [String] 不要な記号を削除した行
+      def delete_unwanted_symbols(line)
+        line = delete_backslash(line)
+        line = delete_semicolon(line)
+        line = delete_dup_quotes(line)
+        line = delete_jp_quotes(line)
+        delete_curved_quotes(line)
+      end
+
+      # 不要なバックスラッシュを削除
+      #
+      # @param [String] line 行
+      # @return [String] 不要なバックスラッシュを削除した行
+      def delete_backslash(line)
+        line.gsub("\\", "")
+      end
+
+      # 不要なセミコロンを削除
+      #
+      # @param [String] line 行
+      # @return [String] 不要なセミコロンを削除した行
+      def delete_semicolon(line)
+        line.gsub(";", "")
+      end
+
+      # 不要なダブルクオートを削除
+      #
+      # @param [String] line 行
+      # @return [String] 不要なダブルクオートを削除した行
+      def delete_dup_quotes(line)
+        # 行間にある余計なダブルクオートを削除するため、一度全てのダブルクオートを削除している
+        # 全て削除したあと、行頭、行末にダブルクオートを追加する
+        line = line.gsub('"', "")
+        line_start = /^(\s*)/
+        line = line.sub(line_start, "\"")
+        "#{line}\""
+      end
+
+      # 不要な鍵括弧を削除
+      #
+      # @param [String] line 行
+      # @return [String] 不要な鍵括弧を削除した行
+      def delete_jp_quotes(line)
+        # 「Hello」
+        deletable_reg = /「.*」/
+        return line unless line.match?(deletable_reg)
+
+        jp_quotes = [/「/, /」/]
+        jp_quotes.each { |quo| line = line.gsub(quo, "") }
+        line
+      end
+
+      # 不要な曲がった引用符を削除
+      #
+      # @param [String] line 行
+      # @return [String] 不要な曲がった引用符を削除した行
+      def delete_curved_quotes(line)
+        # “Hello”
+        deletable_reg = /“.*”/
+        return line unless line.match?(deletable_reg)
+
+        curved_quotes = [/“/, /”/]
+        curved_quotes.each { |quo| line = line.gsub(quo, "") }
+        line
+      end
+    end
+  end
+end

data/lib/modpack_localizer/snbt/performer.rb

@@ -0,0 +1,92 @@
+require "jp_translator_from_gpt"
+require_relative "../util/help"
+require_relative "../util/error"
+require_relative "reader"
+require_relative "writer"
+
+module ModpackLocalizer
+  module SNBT
+    # .snbtの翻訳を実行するクラス
+    # JpTranslatorFromGptを使用して翻訳を行う
+    class Performer
+      # @param [Boolean] output_logs APIのログを出力するか
+      # @param [Array<String>] except_words 翻訳しない単語
+      # @param [String] language 言語
+      # @param [Boolean] display_help ヘルプを表示するか
+      # @return [ModpackLocalizer::SNBT::Performer]
+      def initialize(output_logs: true, except_words: [], language: "Japanese", display_help: true)
+        @translator = JpTranslatorFromGpt::Translator.new(
+          output_logs: output_logs,
+          except_words: except_words,
+          exchange_language: language
+        )
+        @reader, @writer, @progress_bar, @loggable = nil
+
+        ModpackLocalizer.help if display_help
+      end
+
+      # .snbtファイルを翻訳して出力する
+      #
+      # @param [String] file_path ファイルのパス
+      # @param [Boolean] loggable 翻訳ログを出力するか
+      # @return [void]
+      def perform(file_path, loggable: true)
+        @loggable = loggable
+        file_path = File.expand_path(file_path)
+        validate_path(file_path)
+
+        @reader, @writer = ModpackLocalizer::SNBT::Reader.new(file_path), ModpackLocalizer::SNBT::Writer.new(file_path)
+        results = @reader.extract_all.flatten
+        init_progress_bar(file_path, results.length) if @loggable
+
+        results.each do |result|
+          result[:text] = @translator.translate(result[:text])
+          @writer.overwrites(result)
+          @progress_bar.increment if @loggable
+        end
+
+        puts "Quest translation completed!"
+      end
+
+      # ディレクトリ内の.snbtファイルを翻訳して出力する
+      #
+      # @param [String] dir_path ディレクトリのパス
+      # @param [Boolean] loggable 翻訳ログを出力するか
+      # @return [void]
+      def perform_directory(dir_path: "quests", loggable: true)
+        puts "Performing directory: #{dir_path}" unless loggable
+        dir_path = File.expand_path(dir_path)
+        validate_path(dir_path)
+
+        # **でサブディレクトリも含めて取得
+        snbt_files = Dir.glob("#{dir_path}/**/*.snbt")
+        if snbt_files.empty?
+          puts "SNBT files not found in: #{dir_path}"
+          return
+        end
+
+        snbt_files.each { |file_path| perform(file_path, loggable: loggable) }
+      end
+
+      # ファイルの存在性のバリデーション
+      #
+      # @param [String] path ファイルのパス
+      # @return [void]
+      def validate_path(path)
+        path = File.expand_path(path)
+        raise ModpackLocalizer::PathNotFoundError.new(path) unless File.exist?(path)
+      end
+
+      private
+
+      # プログレスバーを初期化する
+      #
+      # @param [String] file_path ファイルのパス
+      # @param [Integer] length プログレスバーの長さ
+      # @return [void]
+      def init_progress_bar(file_path, length)
+        @progress_bar = ModpackLocalizer.create_progress_bar(file_path, length)
+      end
+    end
+  end
+end