modpack_localizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 63164205d4e90427704614b77f5914731d2e12668e75ab278285c4b97cf8751d
+  data.tar.gz: fd7e1da351403590e3fff279007e35564400a497b58c525070dcd32374c182d7
+SHA512:
+  metadata.gz: 43d4533823a00d98e9fff70649ef1138581c0dc456fc7fa24341517adf0606570a06b62e5495c98dbc2781149974f5a51722116a7cfd65985f7aae521df4781f
+  data.tar.gz: 910c218922001d64db4d9cb5e4b865ecd7b7351178f0a9365a51a1591be781b3e1272a5439499eb49781c015bc865df8294c5508e37806fbb2792ceada70f533

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,52 @@
+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
+
+Metrics/ParameterLists:
+  Enabled: false
+
+require:
+  - rubocop-rake
+  - rubocop-rspec

data/CHANGELOG.md

@@ -0,0 +1,43 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-10-03
+
+- Initial release
+
+## [0.1.1] - 2024-10/8
+
+- バグ修正
+
+## [0.1.2] - 2024-10/8
+
+- 再帰的に処理できていなかったのを修正
+
+## [0.1.3] - 2024-10/8
+
+- バグ修正
+
+## [0.2.0] - 2024-10/9
+
+- 出力時のダブルクオート数、インデント数が崩れていたのを出来るだけ抑制
+- quests.snbtのパス名も変換されていたのを修正
+
+## [0.2.1] - 2024-10/10
+
+- \と;を削除する記号に追加
+
+## [0.3.0] - 2024-10/12
+
+- MODの翻訳機能を追加しやすいように、モジュールの構造を変更
+
+## [0.3.1] - 2024-10/25
+
+- 不要な空行が追加されるバグを修正
+
+## [0.3.2] - 2024-10/25
+
+- 簡単に実行するためのオプションを追加
+
+## [0.1.0] -2024-11/9
+
+- 名前をJpQuest -> ModpackLocalizerに変更
+- FTBQuestのみ翻訳化だったが、Modの翻訳も出来るようにしたため、名前が機能にそぐわなくなった

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

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,79 @@
+## ModpackLocalizer
+
+Translator for FTBQuest. (title, subtitle, description)  
+If you want to translate to other languages than Japanese,  
+please add the `language` option during initialization.  
+Can always get help with `ModpackLocalizer.help`
+
+#### Example
+
+`ModpackLocalizer::SNBT::Performer.new(language: "English")`  
+or if no specific configs required  
+`ModpackLocalizer.omakase(language: "English")`
+
+## Steps
+
+1. Download [release](https://github.com/milkeclair/modpack_localizer/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` or `quests` directory contents to `quests` directory
+6. Check `output` directory
+
+## ModpackLocalizer.omakase Options
+
+#### 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)**
+
+## 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)**
+
+#### 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)**

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"

data/dist/example.rb

@@ -0,0 +1,10 @@
+require_relative "../lib/modpack_localizer"
+
+file_path = "dist/mods"
+language = "japanese"
+country_name = "japan"
+
+performer = ModpackLocalizer::JAR::Performer.new(language: language, country: country_name, display_help: false)
+performer.perform_directory(dir_path: file_path)
+
+#ModpackLocalizer.omakase(language: "Japanese", country: "Japan", locale_code: nil, threadable: true)

data/dist/start.bat

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

data/lib/modpack_localizer/jar/performer.rb

@@ -0,0 +1,147 @@
+require "jp_translator_from_gpt"
+require "active_support/core_ext/string/inflections"
+require_relative "../util/help"
+require_relative "../util/error"
+require_relative "reader"
+require_relative "writer"
+
+module ModpackLocalizer
+  module JAR
+    # .jarの翻訳を実行するクラス
+    # JpTranslatorFromGptを使用して翻訳を行う
+    class Performer
+      # locale_codeを指定する場合、countryの指定は不要
+      #
+      # @param [Boolean] output_logs APIのログを出力するか
+      # @param [Array<String>] except_words 翻訳しない単語
+      # @param [String] language 言語
+      # @param [String] country 国
+      # @param [String] locale_code ロケールコード (例: "ja_jp")
+      # @param [Boolean] display_help ヘルプを表示するか
+      # @return [ModpackLocalizer::JAR::Performer]
+      def initialize(
+        output_logs: true, except_words: [], language: "Japanese",
+        country: "Japan", locale_code: nil, display_help: true
+      )
+        @translator = JpTranslatorFromGpt::Translator.new(
+          output_logs: output_logs,
+          except_words: except_words,
+          exchange_language: language
+        )
+        @language, @country_name, @locale_code = language, country, locale_code
+        @reader, @writer, @progress_bar, @loggable, @tierdown = nil
+
+        ModpackLocalizer.help if display_help
+      end
+
+      # .jarファイルを翻訳してリソースパックを作成する
+      #
+      # @param [String] file_path ファイルのパス
+      # @param [Boolean] loggable 翻訳ログを出力するか
+      # @param [Boolean] tierdown リソースパック作成後に不要なファイルを削除するか
+      # @return [void]
+      def perform(file_path, loggable: true, tierdown: true)
+        @loggable, @tierdown = loggable, tierdown
+        file_path = File.expand_path(file_path)
+        validate_path(file_path)
+
+        init_reader_and_writer(file_path)
+        lang_data = @reader.extract_lang_json_and_meta_data
+        init_progress_bar(file_path, lang_data.json.length) if @loggable
+
+        need_translation?(lang_data) ? translate(lang_data) : feedback_unnecessary_translation(lang_data)
+      end
+
+      # ディレクトリ内の.jarファイルを翻訳してリソースパックを作成する
+      #
+      # @param [String] dir_path ディレクトリのパス
+      # @param [Boolean] loggable 翻訳ログを出力するか
+      # @return [void]
+      def perform_directory(dir_path: "mods", loggable: true)
+        puts "Performing directory: #{dir_path}" unless loggable
+        dir_path = File.expand_path(dir_path)
+        validate_path(dir_path)
+
+        jar_files = Dir.glob("#{dir_path}/*.jar")
+        if jar_files.empty?
+          puts "JAR files not found in: #{dir_path}"
+          return
+        end
+
+        jar_files.each { |file_path| perform(file_path, loggable: loggable, tierdown: false) }
+        @writer.remove_before_zipping_directory
+      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
+
+      # ReaderとWriterを初期化する
+      #
+      # @params [String] file_path ファイルのパス
+      # @return [void]
+      def init_reader_and_writer(file_path)
+        @reader = ModpackLocalizer::JAR::Reader.new(file_path, @language, @country_name, @locale_code)
+        @writer = ModpackLocalizer::JAR::Writer.new
+      end
+
+      # プログレスバーを初期化する
+      #
+      # @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
+
+      # 翻訳が必要か判定する
+      #
+      # @param [LangData] lang_data Readerから取得したデータ
+      # @return [Boolean]
+      def need_translation?(lang_data)
+        lang_data.need_translation
+      end
+
+      # 翻訳を実行する
+      #
+      # @param [LangData] lang_data Readerから取得したデータ
+      # @return [void]
+      def translate(lang_data)
+        lang_data.json.each do |key, value|
+          lang_data.json[key] = @translator.translate(value)
+          @progress_bar.increment if @loggable
+        end
+
+        @writer.make_resource_pack(lang_data)
+        @writer.remove_before_zipping_directory if @tierdown
+        puts "Mod translation completed!"
+      end
+
+      # 翻訳が不要な場合のフィードバックを出力する
+      #
+      # @param [LangData] lang_data Readerから取得したデータ
+      # @return [void]
+      def feedback_unnecessary_translation(lang_data)
+        return unless @loggable
+
+        @progress_bar.finish
+        puts already_has_translated_file_message(lang_data)
+      end
+
+      # 既に翻訳済みのファイルが存在する旨のメッセージを出力する
+      #
+      # @param [LangData] lang_data Readerから取得したデータ
+      # @return [String]
+      def already_has_translated_file_message(lang_data)
+        "#{lang_data.mod_name.camelize} already has #{@reader.extract_file_name(lang_data.file_name)} file."
+      end
+    end
+  end
+end