modpack_localizer 0.1.0

data/lib/modpack_localizer/snbt/reader.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative "../util/indent_helper"
+require_relative "title_extractor"
+require_relative "subtitle_extractor"
+require_relative "description_extractor"
+
+module ModpackLocalizer
+  module SNBT
+    # .snbtファイルからタイトル、サブタイトル、説明を抽出するクラス
+    class Reader
+      include TitleExtractor
+      include SubtitleExtractor
+      include DescriptionExtractor
+
+      DESC_START_LENGTH = 14
+      DESC_END_LENGTH = -2
+
+      # @param [String] file_path ファイルのパス
+      # @return [ModpackLocalizer::SNBT::Reader]
+      def initialize(file_path)
+        @file_path = file_path
+      end
+
+      # タイトル、サブタイトル、説明を抽出する
+      #
+      # @return [Array<Array<Hash>>] タイトル、サブタイトル、説明の配列
+      def extract_all
+        titles = extract_titles
+        subtitles = extract_subtitles
+        descriptions = extract_descriptions
+
+        [titles, subtitles, descriptions]
+      end
+
+      # タイトルを抽出する
+      #
+      # @return [Array<Hash>] タイトル、行番号、インデントの配列
+      def extract_titles
+        super(@file_path)
+      end
+
+      # サブタイトルを抽出する
+      #
+      # @return [Array<Hash>] サブタイトル、行番号、インデントの配列
+      def extract_subtitles
+        super(@file_path)
+      end
+
+      # 説明を抽出する
+      #
+      # @return [Array<Hash>] 説明、開始行、終了行、インデントの配列
+      def extract_descriptions
+        super(@file_path)
+      end
+
+      # title: "some title"のような形式から、"some title"を抽出する
+      # 説明の場合は、description: ["some description"]のような形式から、"some description"を抽出する
+      #
+      # @param [String] line 行
+      # @param [Boolean] is_desc 説明かどうか
+      # @return [String] タイトル or サブタイトル or 説明
+      def extract_oneline(line, is_desc: false)
+        stripped_line = line.strip
+        return stripped_line.split(":", 2)[1] unless is_desc
+
+        if oneline_description?(line)
+          stripped_line[DESC_START_LENGTH..DESC_END_LENGTH]
+        elsif start_of?(line, key: :description)
+          stripped_line.split("[", 2)[1]
+        else
+          stripped_line.split("]", 2)[0]
+        end
+      end
+
+      # 1行の説明かどうか
+      #
+      # @param [String] line 行
+      # @return [Boolean]
+      def oneline_description?(line)
+        stripped_line = line.strip
+        start_of?(line, key: :description) && stripped_line.end_with?("]")
+      end
+
+      # どのコンテンツの開始行か
+      #
+      # @param [String] line 行
+      # @param [Symbol] key コンテンツの種類
+      # @return [Boolean]
+      def start_of?(line, key:)
+        stripped_line = line.strip
+        sections = {
+          title: "title:",
+          subtitle: "subtitle:",
+          description: "description: ["
+        }
+
+        stripped_line.start_with?(sections[key])
+      end
+    end
+  end
+end

data/lib/modpack_localizer/snbt/subtitle_extractor.rb

@@ -0,0 +1,32 @@
+require_relative "../util/indent_helper"
+
+module ModpackLocalizer
+  module SNBT
+    # SNBT形式のファイルからsubtitle: "some subtitle"を抽出するモジュール
+    module SubtitleExtractor
+      include IndentHelper
+
+      # subtitle: "some subtitle"を抽出する
+      #
+      # @param [String] file_path ファイルのパス
+      # @return [Array<Hash>] サブタイトルと行番号の配列
+      def extract_subtitles(file_path)
+        subtitles = []
+        lines = File.readlines(file_path)
+        lines.each_with_index do |line, index|
+          next unless start_of?(line, key: :subtitle)
+
+          subtitles << {
+            type: :subtitle,
+            text: extract_oneline(line),
+            start_line: index,
+            end_line: index,
+            indent: count_indent(line)
+          }
+        end
+
+        subtitles
+      end
+    end
+  end
+end

data/lib/modpack_localizer/snbt/title_extractor.rb

@@ -0,0 +1,32 @@
+require_relative "../util/indent_helper"
+
+module ModpackLocalizer
+  module SNBT
+    # SNBT形式のファイルからtitle: "some title"を抽出するモジュール
+    module TitleExtractor
+      include IndentHelper
+
+      # title: "some title"を抽出する
+      #
+      # @param [String] file_path ファイルのパス
+      # @return [Array<Hash>] タイトルと行番号の配列
+      def extract_titles(file_path)
+        titles = []
+        lines = File.readlines(file_path)
+        lines.each_with_index do |line, index|
+          next unless start_of?(line, key: :title)
+
+          titles << {
+            type: :title,
+            text: extract_oneline(line),
+            start_line: index,
+            end_line: index,
+            indent: count_indent(line)
+          }
+        end
+
+        titles
+      end
+    end
+  end
+end

data/lib/modpack_localizer/snbt/writer.rb

@@ -0,0 +1,74 @@
+require_relative "../util/error"
+require_relative "../util/indent_helper"
+require_relative "formatter"
+
+module ModpackLocalizer
+  module SNBT
+    # .snbtファイルの翻訳された内容を整形して出力するクラス
+    class Writer
+      include IndentHelper
+
+      # @param [String] file_path ファイルのパス
+      # @return [ModpackLocalizer::SNBT::Writer]
+      def initialize(file_path)
+        @input_file_path = file_path
+        # questsとすると、quests.snbtも変換されてしまうので、quests/とする
+        @output_file_path = file_path.gsub("quests/", "output/quests/")
+        @formatter = ModpackLocalizer::SNBT::Formatter.new
+      end
+
+      # 翻訳された内容でoutput_file_pathを上書きする
+      #
+      # @param [Hash] translated_contents 翻訳された内容
+      # @return [void]
+      def overwrites(translated_contents)
+        # ディレクトリが存在しない場合は作成
+        FileUtils.mkdir_p(File.dirname(@output_file_path))
+
+        # 一度上書きしている場合は上書き後のファイルを読み込む
+        # 常に上書き前のファイルを読み込むと、前回の上書きが消えてしまう
+        lines = File.readlines(first_overwrite? ? @input_file_path : @output_file_path)
+        formatted_lines = overwrite_lines(lines, translated_contents)
+
+        File.open(@output_file_path, "w") do |file|
+          file.puts formatted_lines
+        end
+
+        handle_line_count_error(@output_file_path, lines.length)
+      end
+
+      private
+
+      # 行を上書きする
+      #
+      # @param [Array<String>] lines 行
+      # @param [Hash] content コンテンツ
+      # @return [Array<String>] 上書きされた行
+      def overwrite_lines(lines, content)
+        indent = create_indent(content[:indent])
+        overwritable_lines = @formatter.format_overwritable_lines(content, indent)
+        lines[content[:start_line]..content[:end_line]] = overwritable_lines.split("\n")
+        lines
+      end
+
+      # 最初の上書きかどうか
+      #
+      # @return [Boolean] 最初の上書きかどうか
+      def first_overwrite?
+        !File.exist?(@output_file_path)
+      end
+
+      # 翻訳前と翻訳後の行数が異なる場合はエラーを発生させる
+      #
+      # @param [String] output_file_path 出力ファイルのパス
+      # @param [Integer] before_line_count 翻訳前の行数
+      # @return [void]
+      def handle_line_count_error(output_file_path, before_line_count)
+        after_line_count = File.readlines(output_file_path).length
+        return if before_line_count == after_line_count
+
+        raise ModpackLocalizer::InvalidLineCountError.new(before_line_count, after_line_count)
+      end
+    end
+  end
+end

data/lib/modpack_localizer/util/error.rb

@@ -0,0 +1,47 @@
+module ModpackLocalizer
+  # 基底のエラークラス
+  class Error < StandardError; end
+
+  # パスが見つからない場合のエラークラス
+  class PathNotFoundError < Error
+    # ヒアドキュメントを使うと、先頭と末尾に空行が入る
+    # エラーメッセージも変更しやすいのでこうしている
+    DOES_NOT_EXIST = <<~TEXT.freeze
+      \n
+      Path does not exist: %s
+    TEXT
+
+    # @param [String] path パス
+    # @return [ModpackLocalizer::PathNotFoundError]
+    def initialize(path)
+      super(format(DOES_NOT_EXIST, path))
+    end
+  end
+
+  # 行数が異なる場合のエラークラス
+  class InvalidLineCountError < Error
+    INVALID_LINE_COUNT = <<~TEXT.freeze
+      \n
+      Invalid line count: %s
+    TEXT
+
+    # @param [Integer] expect_count 期待する行数
+    # @param [Integer] actual_count 実際の行数
+    # @return [ModpackLocalizer::InvalidLineCountError]
+    def initialize(expect_count, actual_count)
+      super(format(INVALID_LINE_COUNT, "Expected: #{expect_count}, Actual: #{actual_count}"))
+    end
+  end
+
+  class InvalidRegionCodeError < Error
+    INVALID_LOCALE_CODE = <<~TEXT.freeze
+      \n
+      %s is an invalid region code.
+      Please specify a valid language or country or region code.
+    TEXT
+
+    def initialize(locale_code)
+      super(format(INVALID_LOCALE_CODE, locale_code))
+    end
+  end
+end

data/lib/modpack_localizer/util/help.rb

@@ -0,0 +1,156 @@
+require "rainbow"
+
+module ModpackLocalizer
+  # ModpackLocalizer gemについてのヘルプを表示するクラス
+  class Help
+    # ModpackLocalizer gemについてのヘルプを表示する
+    #
+    # @return [void]
+    def self.help
+      puts <<~HELP
+        #{cyan("=== ModpackLocalizer Help ==========================================================").bold}\n
+        #{help_warning}
+        #{help_intro}
+        #{help_steps}
+        #{help_init_options}
+        #{help_information}
+        #{cyan("====================================================================================").bold}
+      HELP
+    end
+
+    # 警告
+    #
+    # @return [String]
+    def self.help_warning
+      <<~WARNING
+        #{red("Warning:").bold} Please be careful your OpenAI API usage cost.
+      WARNING
+    end
+
+    # gemの説明
+    #
+    # @return [String]
+    def self.help_intro
+      <<~INTRO
+        #{cyan("Introduction:").bold}
+          Translator for #{green(".snbt")} and #{green(".jar")} files.
+          If you want to translate to other languages than Japanese,
+          please add the #{green("language")} option during initialization.
+          Example:
+            #{green("ModpackLocalizer::SNBT::Performer.new(language: \"English\")")}
+            #{green("ModpackLocalizer::JAR::Performer.new(language: \"English\")")}
+            or if no specific configs required
+            #{green("ModpackLocalizer.omakase(language: \"English\")")}
+      INTRO
+    end
+
+    # 使用手順
+    #
+    # @return [String]
+    def self.help_steps
+      <<~STEPS
+        #{cyan("Steps:").bold}
+          1. exec #{green("touch .env")} bash command
+          2. Add #{green("OPENAI_API_KEY=your_api_key")} to .env
+          3. Optional: Add #{green("OPENAI_MODEL=some_openai_model")} to .env (default: gpt-4o-mini)
+          4. Add "quests" directory to your project
+          5. #{green("gem install modpack_localizer")} or #{green("gem \"modpack_localizer\"")}
+          6. Add #{green("require \"modpack_localizer\"")}
+          7. Add #{green("modpack_localizer = ModpackLocalizer::SNBT::Performer.new")}
+          8. #{green("modpack_localizer.perform(\"file_path\")")} or
+             #{green("modpack_localizer.perform_directory(dir_path: \"dir_path\")")}
+          9. Check "output" directory
+      STEPS
+    end
+
+    # newメソッドのオプション
+    #
+    # @return [String]
+    def self.help_init_options
+      <<~OPTIONS
+        #{cyan("ModpackLocalizer.omakase Options:").bold}
+          language:
+            Which language do you want to translate to?
+            (default: Japanese)
+          country:
+            Your country name
+            (default: Japan)
+          locale_code:
+            Which locale code do you want to use?
+            If you specified this, you don't need to specify the country.
+            (default: nil)
+          threadable:
+            Do you want to exec in parallel?
+            (default: false)
+        #{cyan("Initialize Options:").bold}
+          output_logs:
+            Want to output OpenAI usage logs?
+            (default: true)
+          except_words:
+            Words that you don't want to translate
+            (default: empty array)
+          language:
+            Which language do you want to translate to?
+            (default: Japanese)
+          display_help:
+            Want to display help?
+            (default: true)
+        Only for jar performer:
+          country:
+            Your country name
+            (default: Japan)
+          locale_code:
+            Which locale code do you want to use?
+            If you specified this, you don't need to specify the country.
+            (default: nil)
+      OPTIONS
+    end
+
+    # その他gemに関する情報
+    #
+    # @return [String]
+    def self.help_information
+      <<~INFORMATION
+        #{cyan("Information:").bold}
+          modpack_localizer:
+            #{link("https://github.com/milkeclair/modpack_localizer")}
+            current version: #{ModpackLocalizer::VERSION}
+          translator:
+            #{link("https://github.com/milkeclair/jp_translator_from_gpt")}
+            current version: #{JpTranslatorFromGpt::VERSION}
+      INFORMATION
+    end
+
+    # 出力を青色にする
+    #
+    # @param [String] str
+    # @return [String]
+    def self.cyan(str)
+      Rainbow(str).cyan
+    end
+
+    # 出力を緑色にする
+    #
+    # @param [String] str
+    # @return [String]
+    def self.green(str)
+      Rainbow(str).green
+    end
+
+    # 出力を赤色にする
+    #
+    # @param [String] str
+    # @return [String]
+    def self.red(str)
+      Rainbow(str).red
+    end
+
+    # 出力をリンクのスタイルにする
+    #
+    # @param [String] str
+    # @return [String]
+    def self.link(str)
+      Rainbow(str).underline.bright
+    end
+  end
+end

data/lib/modpack_localizer/util/indent_helper.rb

@@ -0,0 +1,28 @@
+module ModpackLocalizer
+  # インデントを扱うモジュール
+  module IndentHelper
+    # インデントを数える
+    #
+    # @param [String] unstripped_line stripされていない行
+    # @return [Integer] インデントの数
+    def count_indent(unstripped_line)
+      unstripped_line.length - unstripped_line.lstrip.length
+    end
+
+    # インデントを作成
+    #
+    # @param [Integer] indent インデント数
+    # @return [String] インデント
+    def create_indent(indent)
+      "  " * indent
+    end
+
+    # 中間行のインデントを作成
+    #
+    # @param [Integer] indent インデント数
+    # @return [String] 中間行のインデント
+    def middle_indent(indent)
+      "  " * (indent + 1)
+    end
+  end
+end

data/lib/modpack_localizer/util/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ModpackLocalizer
+  VERSION = "0.1.0"
+end

data/lib/modpack_localizer.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "ruby-progressbar"
+require_relative "modpack_localizer/util/version"
+require_relative "modpack_localizer/util/help"
+require_relative "modpack_localizer/snbt/performer"
+require_relative "modpack_localizer/jar/performer"
+
+# SNBT形式のファイルを翻訳する
+# 翻訳できるプロパティ
+# - title
+# - subtitle
+# - description
+module ModpackLocalizer
+  # quests, mods配下のファイルを全て翻訳する
+  # locale_codeを指定する場合、countryの指定は不要
+  #
+  # @param [String] language 言語
+  # @param [String] country 国
+  # @param [String] locale_code ロケールコード(例: "ja_jp")
+  # @param [Boolean] threadable quests, modsの翻訳を並列で行うか
+  # @return [void]
+  def self.omakase(language: "Japanese", country: "Japan", locale_code: nil, threadable: false)
+    performers = [] << ModpackLocalizer::SNBT::Performer.new(language: language)
+    performers << ModpackLocalizer::JAR::Performer.new(
+      language: language, country: country, locale_code: locale_code, display_help: false
+    )
+
+    if threadable
+      threads = performers.map { |pfm| Thread.new { pfm.perform_directory(loggable: false) } }
+      threads.each(&:join)
+    else
+      performers.each(&:perform_directory)
+    end
+  end
+
+  # ModpackLocalizer gemについてのヘルプを表示する
+  #
+  # @return [void]
+  def self.help
+    ModpackLocalizer::Help.help
+  end
+
+  # プログレスバーを生成する
+  #
+  # @param [String] file_path ファイルのパス
+  # @param [Integer] total プログレスバーの合計数
+  # @return [ProgressBar::Base] プログレスバー
+  def self.create_progress_bar(file_path, total)
+    # パスの内、カレントディレクトリ配下のパス以外は邪魔なので削除
+    # 例: /Users/user/quests/some.snbt -> /quests/some.snbt
+    puts "\nFile path: #{file_path.gsub(Dir.pwd, "")}"
+
+    ProgressBar.create(
+      title: "Translating...",
+      total: total,
+      progress_mark: "#",
+      format: "%t [%B]",
+      length: 80,
+      projector: {
+        type: "smoothed",
+        strength: 0.1
+      }
+    )
+  end
+end

data/rake_helper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class RakeHelper
+  GITHUB_PACKAGES_PUSH_COMMAND =
+    "gem push --key github --host https://rubygems.pkg.github.com/milkeclair " \
+    "pkg/modpack_localizer-#{ModpackLocalizer::VERSION}.gem".freeze
+
+  RUBYGEMS_PUSH_COMMAND =
+    "gem push --host https://rubygems.org " \
+    "pkg/modpack_localizer-#{ModpackLocalizer::VERSION}.gem".freeze
+
+  def self.init_rake_tasks
+    RSpec::Core::RakeTask.new(:spec) { |task| task.verbose = false }
+    RuboCop::RakeTask.new
+    YARD::Rake::YardocTask.new
+  end
+
+  def self.build_gem
+    abort("gemのビルドに失敗しました") unless system("rake build")
+  end
+
+  def self.push_to_github_packages
+    abort("githubへのgemのpushに失敗しました") unless system(GITHUB_PACKAGES_PUSH_COMMAND)
+  end
+
+  def self.push_to_rubygems
+    abort("rubygemsへのgemのpushに失敗しました") unless system(RUBYGEMS_PUSH_COMMAND)
+  end
+end

data/sig/jp_quest.rbs

@@ -0,0 +1,4 @@
+module ModpackLocalizer
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end