jp_quest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 897794dabb7c1b722d1bcad7235c64e04c2ca449060278982774c7bcefc5f824
+  data.tar.gz: baaf02d4c32266a22178db399701b1b2bf5e0512401120e1a5a551de8fecfafd
+SHA512:
+  metadata.gz: 57396c508bc82648d1f18427e09445a7c8e82edcf21a4376b086c6fbea3845576907c6e268c09a37d084f3efaf908503b763887f0d22838e38dc9619c54e950a
+  data.tar.gz: 2e573574cf3731f8aefe7567aa57bc1fcc43b0b75fedc74f81455e4f1cc50dfdbb6168a62f1a1d2f6ae1e93e25e6368bcb936274dcc3522a0a33c418bf810c5d

data/.licensed.yml

@@ -0,0 +1,10 @@
+name: "jp_quest"
+
+allowed:
+  - mit
+  - other
+  - wtfpl
+  - apache-2.0
+
+# bundle exec licensed cache
+# bundle exec licensed status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,49 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  Exclude:
+    - "bin/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Metrics/MethodLength:
+  CountComments: true
+  Max: 20
+
+Lint/ScriptPermission:
+  Enabled: false
+
+Style/FetchEnvVar:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Lint/EmptyFile:
+  Enabled: false
+
+RSpec/BeNil:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/WhileUntilModifier:
+  Enabled: false
+
+require:
+  - rubocop-rake
+  - rubocop-rspec

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-10-03
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 milkeclair
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+## JpQuest
+
+Translator for `.snbt` files. (title, subtitle, description)
+If you want to translate to other languages than Japanese,
+please add the `exchange_language` option during initialization.
+Can always get help with `JpQuest.help`
+
+#### Example
+
+`JpQuest::Performer.new(exchange_language: "English")`
+
+## Steps
+
+1. Download [release](https://github.com/milkeclair/jp_quest/releases)
+2. Make `.env` file
+3. Add `OPENAI_API_KEY=your_api_key` to `.env`
+4. Optional: Add `OPENAI_MODEL=some_openai_model` to `.env` **(default: gpt-4o-mini)**
+5. Add `some.snbt` to `quests` directory
+6. Check `output` directory
+
+## Initialize Options
+
+#### output_logs
+
+Want to output OpenAI usage logs?
+**(default: true)**
+
+#### except_words
+
+Words that you don't want to translate
+**(default: empty array)**
+
+#### exchange_language
+
+Which language do you want to translate to?
+**(default: japanese)**
+
+#### display_help
+
+Want to display help?
+**(default: true)**

data/Rakefile

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+require "yard"
+require_relative "rake_helper"
+
+desc "analysis"
+task :analysis do
+  sh "bundle install"
+
+  RakeHelper.init_rake_tasks
+
+  puts "--- rspec ---"
+  Rake::Task[:spec].invoke
+
+  puts "--- rubocop ---"
+  Rake::Task[:rubocop].invoke
+
+  puts "--- yard ---"
+  Rake::Task[:yard].invoke
+end
+
+desc "push to github packages and rubygems"
+task :push do
+  sh "bundle install"
+
+  puts "--- build ---"
+  RakeHelper.build_gem
+
+  puts "--- push to github packages ---"
+  RakeHelper.push_to_github_packages
+
+  puts "--- push to rubygems ---"
+  RakeHelper.push_to_rubygems
+end
+
+task default: :analysis

data/dist/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "jp_quest", "~> 0.1.0"

data/dist/example.rb

@@ -0,0 +1,8 @@
+require_relative "../lib/jp_quest"
+
+performer = JpQuest::Performer.new
+
+# file_path = "some.snbt"
+# performer.perform(file_path)
+
+performer.perform_directory

data/dist/start.bat

@@ -0,0 +1,4 @@
+call gem install bundler
+call bundle install
+call bundle exec ruby example.rb
+pause

data/lib/jp_quest/error.rb

@@ -0,0 +1,35 @@
+module JpQuest
+  # 基底のエラークラス
+  class Error < StandardError; end
+
+  # パスが見つからない場合のエラークラス
+  class PathNotFoundError < Error
+    # ヒアドキュメントを使うと、先頭と末尾に空行が入る
+    # エラーメッセージも変更しやすいのでこうしている
+    DOES_NOT_EXIST = <<~TEXT.freeze
+      \n
+      Path does not exist: %s
+    TEXT
+
+    # @param [String] path パス
+    # @return [JpQuest::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 [JpQuest::InvalidLineCountError]
+    def initialize(expect_count, actual_count)
+      super(format(INVALID_LINE_COUNT, "Expected: #{expect_count}, Actual: #{actual_count}"))
+    end
+  end
+end

data/lib/jp_quest/extractor/description.rb

@@ -0,0 +1,112 @@
+module JpQuest
+  # SNBT形式のファイルからdescription: ["some description"]を抽出するモジュール
+  module DescriptionExtractor
+    # 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

data/lib/jp_quest/extractor/subtitle.rb

@@ -0,0 +1,26 @@
+module JpQuest
+  # SNBT形式のファイルからsubtitle: "some subtitle"を抽出するモジュール
+  module SubtitleExtractor
+    # 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

data/lib/jp_quest/extractor/title.rb

@@ -0,0 +1,26 @@
+module JpQuest
+  # SNBT形式のファイルからtitle: "some title"を抽出するモジュール
+  module TitleExtractor
+    # 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

data/lib/jp_quest/formatter.rb

@@ -0,0 +1,159 @@
+require_relative "indent_helper"
+
+module JpQuest
+  # 翻訳された内容をSNBT形式に整形するクラス
+  class Formatter
+    include IndentHelper
+
+    # 保存できるように整形
+    #
+    # @param [Hash] content コンテンツ
+    # @param [String] indent インデント
+    # @return [String] SNBT形式に整形したコンテンツ
+    def format_overwritable_lines(content, indent)
+      mid_indent = middle_indent(content[:indent])
+      indented_lines = add_indent_for_middle_lines(content, mid_indent)
+      formatted_lines = add_missing_lines(indented_lines, content, mid_indent)
+      format_for_snbt(formatted_lines, indent, content[:type])
+    end
+
+    # SNBT形式に整形
+    #
+    # @param [Array<String>] lines 行
+    # @param [String] indent インデント
+    # @param [Symbol] type コンテンツの種類
+    # @return [String] SNBT形式に整形した行
+    def format_for_snbt(lines, indent, type)
+      lines.map! { |line| delete_quotes(line) }
+      lines.map!(&:strip) unless type == :description
+
+      formatted_lines =
+        if lines.length == 1
+          type == :description ? "[#{lines[0].strip}]" : lines[0].strip.to_s
+        else
+          # description: [
+          #   "Hello"
+          #   "World"
+          # ]
+          "[\n#{lines.join("\n")}\n#{indent}]"
+        end
+
+      # "   description: ["hoge"]"のような形式にする
+      "#{indent}#{type}: #{formatted_lines}"
+    end
+
+    # 不足している行を追加
+    #
+    # @param [Array<String>] lines 行
+    # @param [Hash] content コンテンツ
+    # @param [String] middle_indent 中間行のインデント
+    # @return [void]
+    def add_missing_lines(lines, content, middle_indent)
+      required_lines = extract_required_line_counts(content)
+
+      while lines.length < required_lines
+        lines << empty_middle_line(middle_indent)
+      end
+
+      lines
+    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 [Hash] content コンテンツ
+    # @param [String] middle_indent 中間行のインデント
+    # @return [Array<String>] 中間行のインデントを追加した行
+    def add_indent_for_middle_lines(content, middle_indent)
+      content[:text].split("\n").map do |line|
+        "#{middle_indent}\"#{line}\""
+      end
+    end
+
+    # 中間行の空行を作成
+    #
+    # @param [String] middle_indent 中間行のインデント
+    # @return [String] 空行
+    def empty_middle_line(middle_indent)
+      "#{middle_indent}\"\""
+    end
+
+    # 不要な引用符を削除
+    #
+    # @param [String] line 行
+    # @return [String] 不要な引用符を削除した行
+    def delete_quotes(line)
+      line = delete_dup_quotes(line)
+      line = delete_jp_quotes(line)
+      delete_curved_quotes(line)
+    end
+
+    private
+
+    # 不要なダブルクオートを削除
+    #
+    # @param [String] line 行
+    # @return [String] 不要なダブルクオートを削除した行
+    def delete_dup_quotes(line)
+      # ""Hello""、""""
+      deletable_regs = [/"{2,}.+".*"/, /"{3,}/]
+      return line unless deletable_regs.any? { |reg| line.match?(reg) }
+
+      # ""
+      dup_reg = /"{2,}/
+      # """"に一致する場合は空白行なので、""に変換する
+      if line.strip.match?(deletable_regs[1])
+        line.gsub(dup_reg, '""')
+      else
+        # 行間にある余計なダブルクオートを削除するため、一度全てのダブルクオートを削除している
+        line = line.gsub('"', "")
+        # インデントの調整
+        indent_count = normalize_indent(line[/^\s*/].length)
+        line_start = /^(\s*)/
+        # 行頭にインデントとダブルクオートを追加
+        line = line.sub(line_start, "#{" " * indent_count}\"")
+        # 行末のダブルクオートを追加
+        "#{line}\""
+      end
+    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

data/lib/jp_quest/help.rb

@@ -0,0 +1,130 @@
+require "rainbow"
+
+module JpQuest
+  # JpQuest gemについてのヘルプを表示するクラス
+  class Help
+    # JpQuest gemについてのヘルプを表示する
+    #
+    # @return [void]
+    def self.help
+      puts <<~HELP
+        #{cyan("=== JpQuest 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")} files.
+          If you want to translate to other languages than Japanese,
+          please add the #{green("exchange_language")} option during initialization.
+          Example: #{green("JpQuest::Performer.new(exchange_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 jp_quest")} or #{green("gem \"jp_quest\"")}
+          6. Add #{green("require \"jp_quest\"")}
+          7. Add #{green("jp_quest = JpQuest::Performer.new")}
+          8. #{green("jp_quest.perform(\"file_path\")")} or
+             #{green("jp_quest.perform_directory(dir_path: \"dir_path\")")}
+          9. Check "output" directory
+      STEPS
+    end
+
+    # newメソッドのオプション
+    #
+    # @return [String]
+    def self.help_init_options
+      <<~OPTIONS
+        #{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)
+          exchange_language:
+            Which language do you want to translate to?
+            (default: japanese)
+          display_help:
+            Want to display help?
+            (default: true)
+      OPTIONS
+    end
+
+    # その他gemに関する情報
+    #
+    # @return [String]
+    def self.help_information
+      <<~INFORMATION
+        #{cyan("Information:").bold}
+          jp_quest:
+            #{link("https://github.com/milkeclair/jp_quest")}
+            current version: #{JpQuest::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/jp_quest/indent_helper.rb

@@ -0,0 +1,36 @@
+module JpQuest
+  # インデントを扱うモジュール
+  module IndentHelper
+    # インデントを作成
+    #
+    # @param [Integer] indent インデント数
+    # @return [String] インデント
+    def create_indent(indent)
+      "  " * indent
+    end
+
+    # 中間行のインデントを作成
+    #
+    # @param [Integer] indent インデント数
+    # @return [String] 中間行のインデント
+    def middle_indent(indent)
+      "  " * (indent + 1)
+    end
+
+    # インデントを調整
+    #
+    # @param [Integer] indent インデント数
+    # @return [Integer] 調整後のインデント数
+    def normalize_indent(indent)
+      dup_indent = 12
+      if indent > dup_indent
+        half = 2
+        half_indent = indent / half
+        # インデントの数は偶数にする
+        half_indent.even? ? half_indent : half_indent + 1
+      else
+        indent
+      end
+    end
+  end
+end

data/lib/jp_quest/performer.rb

@@ -0,0 +1,74 @@
+require "jp_translator_from_gpt"
+require_relative "help"
+require_relative "error"
+require_relative "reader"
+require_relative "writer"
+
+module JpQuest
+  # 翻訳を実行するクラス
+  # JpTranslatorFromGptを使用して翻訳を行う
+  class Performer
+    # @param [Boolean] output_logs ログを出力するか
+    # @param [Array<String>] except_words 翻訳しない単語
+    # @param [String] exchange_language どの言語に翻訳するか
+    # @param [Boolean] display_help ヘルプを表示するか
+    # @return [JpQuest::Performer]
+    def initialize(output_logs: true, except_words: [], exchange_language: "japanese", display_help: true)
+      @translator = JpTranslatorFromGpt::Translator.new(
+        output_logs: output_logs,
+        except_words: except_words,
+        exchange_language: exchange_language
+      )
+      @reader = nil
+      @writer = nil
+      @progress_bar = nil
+
+      JpQuest.help if display_help
+    end
+
+    # ファイルを翻訳して出力する
+    #
+    # @param [String] file_path ファイルのパス
+    # @return [void]
+    def perform(file_path)
+      file_path = File.expand_path(file_path)
+      validate_path(file_path)
+
+      @reader, @writer = JpQuest::Reader.new(file_path), JpQuest::Writer.new(file_path)
+      results = @reader.extract_all.flatten
+      @progress_bar = JpQuest.create_progress_bar(file_path, results.length)
+
+      results.each do |result|
+        result[:text] = @translator.translate(result[:text])
+        @writer.overwrites(result)
+        @progress_bar.increment
+      end
+
+      puts "Completed!"
+    end
+
+    # ディレクトリ内のファイルを翻訳して出力する
+    #
+    # @param [String] dir_path ディレクトリのパス
+    # @return [void]
+    def perform_directory(dir_path: "quests")
+      dir_path = File.expand_path(dir_path)
+      validate_path(dir_path)
+
+      # **でサブディレクトリも含めて取得
+      Dir.glob("#{dir_path}/**.snbt").each do |file_path|
+        perform(file_path)
+      end
+    end
+
+    # ファイルの存在を確認する
+    # 存在しない場合はPathNotFoundErrorを投げる
+    #
+    # @param [String] path ファイルのパス
+    # @return [void]
+    def validate_path(path)
+      path = File.expand_path(path)
+      raise JpQuest::PathNotFoundError.new(path) unless File.exist?(path)
+    end
+  end
+end

data/lib/jp_quest/reader.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require_relative "extractor/title"
+require_relative "extractor/subtitle"
+require_relative "extractor/description"
+
+module JpQuest
+  # SNBT形式のファイルからタイトル、サブタイトル、説明を抽出するクラス
+  class Reader
+    include TitleExtractor
+    include SubtitleExtractor
+    include DescriptionExtractor
+
+    DESC_START_LENGTH = 14
+    DESC_END_LENGTH = -2
+
+    # @param [String] file_path ファイルのパス
+    # @return [JpQuest::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
+
+    # インデントを数える
+    #
+    # @param [String] unstripped_line stripされていない行
+    # @return [Integer] インデントの数
+    def count_indent(unstripped_line)
+      unstripped_line.length - unstripped_line.lstrip.length
+    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

data/lib/jp_quest/version.rb

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

data/lib/jp_quest/writer.rb

@@ -0,0 +1,71 @@
+require_relative "error"
+require_relative "formatter"
+require_relative "indent_helper"
+
+module JpQuest
+  # 翻訳された内容を整形して出力するクラス
+  class Writer
+    include IndentHelper
+
+    # @param [String] file_path ファイルのパス
+    # @return [JpQuest::Writer]
+    def initialize(file_path)
+      @input_file_path = file_path
+      @output_file_path = file_path.gsub("quests", "output/quests")
+      @formatter = JpQuest::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 JpQuest::InvalidLineCountError.new(before_line_count, after_line_count)
+    end
+  end
+end

data/lib/jp_quest.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "ruby-progressbar"
+require_relative "jp_quest/version"
+require_relative "jp_quest/help"
+require_relative "jp_quest/performer"
+
+# SNBT形式のファイルを翻訳する
+# 翻訳できるプロパティ
+# - title
+# - subtitle
+# - description
+module JpQuest
+  # JpQuest gemについてのヘルプを表示する
+  #
+  # @return [void]
+  def self.help
+    JpQuest::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/jp_quest-#{JpQuest::VERSION}.gem".freeze
+
+  RUBYGEMS_PUSH_COMMAND =
+    "gem push --host https://rubygems.org " \
+    "pkg/jp_quest-#{JpQuest::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 JpQuest
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: jp_quest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- milkeclair
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jp_translator_from_gpt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: ftbquestを日本語化する
+email:
+- milkeclair.noreply@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".licensed.yml"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- dist/Gemfile
+- dist/example.rb
+- dist/start.bat
+- lib/jp_quest.rb
+- lib/jp_quest/error.rb
+- lib/jp_quest/extractor/description.rb
+- lib/jp_quest/extractor/subtitle.rb
+- lib/jp_quest/extractor/title.rb
+- lib/jp_quest/formatter.rb
+- lib/jp_quest/help.rb
+- lib/jp_quest/indent_helper.rb
+- lib/jp_quest/performer.rb
+- lib/jp_quest/reader.rb
+- lib/jp_quest/version.rb
+- lib/jp_quest/writer.rb
+- rake_helper.rb
+- sig/jp_quest.rbs
+homepage: https://github.com/milkeclair/jp_quest
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/milkeclair/jp_quest
+  source_code_uri: https://github.com/milkeclair/jp_quest/blob/main
+  changelog_uri: https://github.com/milkeclair/jp_quest/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.21
+signing_key: 
+specification_version: 4
+summary: translate to japanese for ftbquest
+test_files: []