jp_quest 0.2.0 → 0.3.0

data/lib/jp_quest/{indent_helper.rb → util/indent_helper.rb}

@@ -1,6 +1,14 @@
 module JpQuest
   # インデントを扱うモジュール
   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 インデント数
@@ -16,21 +24,5 @@ module JpQuest
     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/{version.rb → util/version.rb}

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

data/lib/jp_quest.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require "ruby-progressbar"
-require_relative "jp_quest/version"
-require_relative "jp_quest/help"
-require_relative "jp_quest/performer"
+require_relative "jp_quest/util/version"
+require_relative "jp_quest/util/help"
+require_relative "jp_quest/snbt/performer"
 
 # SNBT形式のファイルを翻訳する
 # 翻訳できるプロパティ

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jp_quest
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - milkeclair
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-09 00:00:00.000000000 Z
+date: 2024-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jp_translator_from_gpt
@@ -70,17 +70,17 @@ files:
 - 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
+- lib/jp_quest/snbt/description_extractor.rb
+- lib/jp_quest/snbt/formatter.rb
+- lib/jp_quest/snbt/performer.rb
+- lib/jp_quest/snbt/reader.rb
+- lib/jp_quest/snbt/subtitle_extractor.rb
+- lib/jp_quest/snbt/title_extractor.rb
+- lib/jp_quest/snbt/writer.rb
+- lib/jp_quest/util/error.rb
+- lib/jp_quest/util/help.rb
+- lib/jp_quest/util/indent_helper.rb
+- lib/jp_quest/util/version.rb
 - rake_helper.rb
 - sig/jp_quest.rbs
 homepage: https://github.com/milkeclair/jp_quest

data/lib/jp_quest/extractor/description.rb

@@ -1,112 +0,0 @@
-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

@@ -1,26 +0,0 @@
-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

@@ -1,26 +0,0 @@
-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

@@ -1,148 +0,0 @@
-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)
-      full_lines = add_missing_lines(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
-
-    # 不足している行を追加
-    #
-    # @param [Hash] content コンテンツ
-    # @return [void]
-    def add_missing_lines(content)
-      required_lines = extract_required_line_counts(content)
-      lines = content[:text].split("\n")
-
-      while lines.length < required_lines
-        lines << empty_middle_line(content[:indent])
-      end
-
-      lines
-    end
-
-    private
-
-    # 不要な文字を削除する
-    #
-    # @param [String] lines 行
-    # @param [Hash] content コンテンツ
-    # @return [Array<String>] 不要な文字を削除した行
-    def prepare_lines_for_snbt(lines, content)
-      lines.map! { |line| delete_quotes(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
-
-    # 中間行の空行を作成
-    #
-    # @return [String] 空行
-    def empty_middle_line(indent)
-      middle_indent(indent).to_s
-    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
-
-    # 不要なダブルクオートを削除
-    #
-    # @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

data/lib/jp_quest/performer.rb

@@ -1,74 +0,0 @@
-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

@@ -1,107 +0,0 @@
-# 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/writer.rb

@@ -1,72 +0,0 @@
-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
-      # questsとすると、quests.snbtも変換されてしまうので、quests/とする
-      @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