translation_api 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9c1c9798882d3591828278748d1aa763227e85a2c37be0d7583859c78fc0013
-  data.tar.gz: ac5378596044a829e4f653e258ade5074e023b2ca0d3ccb1a55b603c8e707c5d
+  metadata.gz: 18aab159f877af05a07c70b365d022ac0531868db5a00dbcbd7e861d299137a9
+  data.tar.gz: d8fe14a44a14753e1b3c8ea22239dce5c845d1b97914c16305501caaf1ba1af0
 SHA512:
-  metadata.gz: 94379f1ffbd3741c72fc87289b7887b434eb65e3bb8fb55438a98fdede95e4220f473aae4f56aeed5a126099d95fdc7abde0d2b9fd05f53d8ec7286bb03af54a
-  data.tar.gz: 17d351d60dc25125577f5a9c8a43490e86a91a8d77420d795131c17de6c7b1a33e3f9050c5d836272fd87ec825846a25379fd44d42f1725580bde08b4fe5c06a
+  metadata.gz: 2d8f18647569f3b6d7f11be1f554efe08a23e834d7a626e2420c15119f29bdb526f0b73d6f888525b2f03c3e1f4f757c1ae099014807f2dd7ed11f63de28fdb2
+  data.tar.gz: ba509a11536d06ea663b43dee3c81615d1a4a8bf8ebcf496aa7f709b6523aaa710b22d4baef92f63347ffe6d4a04e43e9461a2f0933ae7a0bd7c064cedae6f38

data/CHANGELOG.md

@@ -37,5 +37,14 @@
 - OpenAIのモデル追加
 
 ## [1.0.0] - 2025-11-10
+
 - 全体的な設計を刷新
 - よりシンプルなインターフェースに変更
+
+## [1.1.0] - 2025-11-23
+
+- カスタムプロンプトを設定できる機能を追加
+
+## [1.1.1] - 2025-11-23
+
+- configの設定順序を逆に変更

data/example.rb

@@ -9,9 +9,11 @@ end
 
 text = ARGV.join(" ")
 TranslationAPI.configure do |config|
-  config.language     = "english"
-  config.provider     = :deepl
-  config.except_words = %w[hoge fuga]
+  config.language      = "english"
+  config.provider      = :openai
+  config.output_logs   = false
+  config.except_words  = %w[hoge fuga]
+  config.custom_prompt = "Please Samurai style."
 end
 
 translated_text = TranslationAPI.translate(text)

data/lib/translation_api/config.rb

@@ -6,18 +6,19 @@ class TranslationAPI
   class Config
     include Singleton
 
-    attr_accessor :language, :provider, :output_logs, :except_words, :deepl_pro
+    attr_accessor :language, :provider, :output_logs, :except_words, :custom_prompt, :deepl_pro
 
     def self.configure(&block)
       block.call(instance)
     end
 
     def initialize
-      @language     = "japanese"
-      @provider     = :openai
-      @output_logs  = true
-      @except_words = []
-      @deepl_pro    = false
+      @language      = "japanese"
+      @provider      = :openai
+      @output_logs   = true
+      @except_words  = []
+      @custom_prompt = nil
+      @deepl_pro     = false
     end
   end
 end

data/lib/translation_api/provider/openai.rb

@@ -17,13 +17,13 @@ class TranslationAPI
       MODEL_ERROR_MESSAGE =
         "Specified model is not supported. Please check the model name."
 
-      def initialize(output_logs:, except_words:, language:)
+      def initialize(output_logs:, except_words:, language:, custom_prompt: nil)
         validate_api_key!
 
         @client = init_client
         @output_logs   = output_logs
         @system_prompt = SYSTEM_PROMPT_BASE + except_option_text(except_words)
-        @user_prompt   = user_prompt_text(language)
+        @user_prompt   = user_prompt_text(language, custom_prompt)
       end
 
       def translate(text)
@@ -87,8 +87,9 @@ class TranslationAPI
         TEXT
       end
 
-      def user_prompt_text(language)
+      def user_prompt_text(language, custom_prompt)
         <<~TEXT
+          #{custom_prompt || ""}
           Please translate this text to #{language}:
         TEXT
       end

data/lib/translation_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class TranslationAPI
-  VERSION = "1.0.0"
+  VERSION = "1.1.1"
 end

data/lib/translation_api.rb

@@ -23,16 +23,11 @@ class TranslationAPI
     new(**).translate(text)
   end
 
-  def initialize(
-    language:     config.language,
-    provider:     config.provider,
-    output_logs:  config.output_logs,
-    except_words: config.except_words
-  )
-    @language     = language
-    @output_logs  = output_logs
-    @except_words = except_words
-    @provider     = init_provider(provider)
+  def initialize(**options)
+    use_default_options
+    use_provided_options(options)
+
+    @provider = init_provider(@provider)
   end
 
   def config
@@ -45,13 +40,27 @@ class TranslationAPI
 
   private
 
+  def use_provided_options(options)
+    options.each do |key, value|
+      instance_variable_set("@#{key}", value)
+    end
+  end
+
+  def use_default_options
+    self.class.config.instance_variables.each do |var|
+      key = var.to_s.delete_prefix("@").to_sym
+      instance_variable_set("@#{key}", self.class.config.send(key))
+    end
+  end
+
   def init_provider(provider)
     case provider
     when :openai
       Provider::OpenAI.new(
         output_logs: @output_logs,
         except_words: @except_words,
-        language: @language
+        language: @language,
+        custom_prompt: @custom_prompt
       )
     when :deepl
       Provider::DeepL.new(

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: translation_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - milkeclair