luogu 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dc8912fdf448f5a9cb2f27d32125bf5a82b5231a8c74f36c03c2269d3345a14
-  data.tar.gz: 9039e6a2ebf32390d96625e734e63c49a9fda770945d8240a4a11dc3d8af114b
+  metadata.gz: 1d415e44469be65939709764b50b5283da141d5e68663acf5e3c376044407970
+  data.tar.gz: 18846bbcd392e9581f6d9becff711b2e551983759460464b169824e14f3c05a1
 SHA512:
-  metadata.gz: bfc85f6ebf5dc6970243291b277654a86adc93d3a917e4c571f7e2a7b08bbc74fd7d20ee5fbacd4981ba8b983f9b1da05fe97a60da9b8a3b607a4fe5bf8b6b7b
-  data.tar.gz: e5b8db6cb68a539ec09f706fed396dfafccc352817f1072616b66db77843d95fea9c67374fda515407c75cb71273523d0c8ede5793387a4663ab8c8ca9848480
+  metadata.gz: 5eb13f0a6b90843366879a773f816d55dbcdba55f2cc6f06915f9e7f7dbc4a73ceb1916505d482a670755d8197519792d649f0731c12f53071fa87b131bcd62a
+  data.tar.gz: b25c5d0dfa8a2b4d4df66ec9695d226521551ddb77f674722d122ba8e9252546abcfa916d2d379a794f520fedf32247e1dcbeef575739675bdd84ddd705e78f5

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    luogu (0.1.1)
+    luogu (0.1.7)
       dotenv (~> 2.8, >= 2.8.1)
+      dry-cli (~> 1.0)
       ruby-openai (~> 3.7)
       tty-prompt (~> 0.23.1)
 
@@ -10,6 +11,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     dotenv (2.8.1)
+    dry-cli (1.0.0)
     httparty (0.21.0)
       mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)

data/README.md

@@ -10,10 +10,14 @@
 - 如果需要在终端显示markdown，需要 [glow](https://github.com/charmbracelet/glow)
 
 ### 使用
-- luogu build <file> 编译成对应的json
-- luogu run <file> 测试prompt
-- luogu gen <prompt.json file> <target.md> 用来逆向生成md文件的命令
-- luogu test <file> <yml> 用来跑自动化测试 yaml 一行一句话
+```Bash
+Commands:
+  luogu build PROMPT_FILE [TARGET_FILE]                      # 编译 Prompt.md 成能够提交给 ChatGPT API 的 messages. 默认输出为 <同文件名>.json
+  luogu generate JSON_FILE [PROMPT_FILE]                     # 根据 ChatGPT messages JSON 来生成 Prompt.md
+  luogu run PROMPT_FILE                                      # 编译 Prompt.md 成能够提交给 ChatGPT API 的 messages. 默认输出为 <同文件名>.json
+  luogu test [PROMPT_FILE] [TEST_FILE]                       # 测试 Prompt 文件
+  luogu version                                              # 打印版本
+```
 
 你可以在项目目录的.env中设置下面的环境变量，或者直接系统设置
 ```

data/lib/luogu/chatgpt.rb

@@ -1,26 +1,50 @@
 module Luogu
   class ChatGPT
-    def initialize(file)
+
+    attr_accessor :template, :limit_history, :prompt, :row_history, :history, :temperature, :model_name
+
+    def initialize(file, history_path='.', plugin_file_path=nil)
+      @plugin_file_path = plugin_file_path || file.sub(File.extname(file), ".plugin.rb")
+
+      if File.exist?(@plugin_file_path)
+        @plugin = Plugin.new(@plugin_file_path).load()
+      else
+        @plugin = Plugin.new(@plugin_file_path)
+      end
+
       @temperature = ENV.fetch('OPENAI_TEMPERATURE', '0.7').to_f
       @limit_history = ENV.fetch('OPENAI_LIMIT_HISTORY', '6').to_i * 2
+      @model_name = "gpt-3.5-turbo"
       
+      @history_path = history_path
+      @prompt_file = file
+
       @prompt = PromptParser.new(file)
       @row_history = []
       @history = HistoryQueue.new @limit_history
+
+      @plugin.setup_proc.call(self) if @plugin.setup_proc
     end
 
     def request(messages)
-      response = client.chat(
-        parameters: {
-            model: "gpt-3.5-turbo",
-            messages: messages,
-            temperature: 0.7,
-        })
+      params = {
+        model: @model_name,
+        messages: messages,
+        temperature: @temperature,
+      }
+      
+      params = @plugin.before_request_proc.call(self, params) if @plugin.before_request_proc
+      response = client.chat(parameters: params)
+      @plugin.after_request_proc.call(self, response) if @plugin.after_request_proc
+
       response.dig("choices", 0, "message", "content")
     end
 
     def chat(user_message)
+      user_message = @plugin.before_input_proc.call(self, user_message) if @plugin.before_input_proc
       messages = (@prompt.render + @history.to_a) << {role: "user", content: user_message}
+      @plugin.after_input_proc.call(self, messages) if @plugin.after_input_proc
+
       assistant_message = self.request(messages)
       
       self.push_row_history(user_message, assistant_message)
@@ -28,6 +52,8 @@ module Luogu
       if @prompt.ruby_code
         puts "执行文档中的callback"
         instance_eval @prompt.ruby_code, @prompt.file_path, @prompt.ruby_code_line
+      elsif @plugin.before_save_history_proc
+        @plugin.before_save_history_proc.call(self, user_message, assistant_message)
       else
         puts "执行默认的历史记录"
         self.push_history(user_message, assistant_message)
@@ -44,6 +70,7 @@ module Luogu
     def push_history(user_message, assistant_message)
       @history.enqueue({role: "user", content: user_message})
       @history.enqueue({role: "assistant", content: assistant_message})
+      @plugin.after_save_history_proc.call(self, user_message, assistant_message) if @plugin.after_save_history_proc
     end
 
     def ask(message)
@@ -70,8 +97,9 @@ module Luogu
         # 根据用户输入执行相应的操作
         case input
         when "save"
-          self.class.save @row_history, "./prompt.row_history.md"
-          self.class.save @history.to_a, "./prompt.history.md"
+          file_name = File.basename(@prompt_file, ".*")
+          self.class.save @row_history, File.join(@history_path, "#{file_name}.row_history.md")
+          self.class.save @history.to_a, File.join(@history_path, "#{file_name}.history.md")
         when "row history"
           p @row_history
         when "history"
@@ -91,8 +119,10 @@ module Luogu
         self.puts self.chat(message)
       end
       now = Time.now.to_i
-      self.class.save @row_history, "./prompt.row_history.test-#{now}.md"
-      self.class.save @history.to_a, "./prompt.history.test-#{now}.md"
+      file_name = File.basename(@prompt_file, ".*")
+
+      self.class.save @row_history, File.join(@history_path, "#{file_name}-#{now}.row_history.md")
+      self.class.save @history.to_a, File.join(@history_path, "#{file_name}-#{now}.history.md")
     end
 
     class << self
@@ -105,6 +135,7 @@ module Luogu
           text += item[:content]
           text += "\n\n"
         end
+        FileUtils.mkdir_p(File.dirname(file_path))
         File.open(file_path, 'w') do |f|
           f.write(text)
         end

data/lib/luogu/cli.rb

@@ -1,58 +1,90 @@
 module Luogu
-  module_function
-  def cli
-    options = {}
-    subcommands = {}
-
-    OptionParser.new do |opts|
-      opts.banner = "Usage: luogu [command]"
-
-      opts.on("-h", "--help", "Prints help") do
-        puts """
-        luogu build <file> -> 编译prompt
-        luogu run <file> -> 测试 prompt
-        luogu gen <file> <target> -> 根据 json 生成 prompt 文件
-        luogu test <file> <test_file.yml> -> 根据 yaml 来对 prompt 进行测试
-        """
-        exit
+  module CLI
+    module Commands
+      extend Dry::CLI::Registry
+      
+      class Version < Dry::CLI::Command
+        desc "打印版本"
+
+        def call(*)
+          puts Luogu::VERSION
+        end
       end
 
-    end.parse!
+      class Build < Dry::CLI::Command
+
+        desc "编译 Prompt.md 成能够提交给 ChatGPT API 的 messages. 默认输出为 <同文件名>.json"
+        argument :prompt_file, type: :string, required: true, deec: "Prompt文件, 使用markdown书写"
+        argument :target_file, type: :string, required: false, deec: "输出 JSON 文件"
+
+        def call(prompt_file: nil, target_file: nil, **)
+          target_file ||=  prompt_file.sub(File.extname(prompt_file), ".json")
+          data = PromptParser.new(prompt_file).to_json
+          File.open(target_file, 'w') do |f|
+            f.write(data)
+          end
+        end
 
-   
-    subcommands['build'] = Proc.new do |args|
-      data = PromptParser.new(args.first).to_json
-      target_path = args[1] || "./prompt.json"
-      File.open(target_path, 'w') do |f|
-        f.write(data)
       end
-    end
 
-    subcommands['run'] = Proc.new do |args|
-      chatgpt = ChatGPT.new(args.first)
-      chatgpt.run
-    end
+      class Run < Dry::CLI::Command
 
-    subcommands['gen'] = Proc.new do |args|
-      json = JSON.parse File.read(args.first), symbolize_names: true   
-      chatgpt = ChatGPT.save(json, args.last)
-    end
+        desc "编译 Prompt.md 成能够提交给 ChatGPT API 的 messages. 默认输出为 <同文件名>.json"
+        argument :prompt_file, type: :string, required: true, desc: "Prompt文件, 使用markdown书写"
+        option :out, type: :string, default: ".", desc: "保存历史时存放的目录，默认为当前目录"
+        option :plugin, type: :string, desc: "运行的时候载入对应的插件"
 
-    subcommands['test'] = Proc.new do |args|
-      promtpt_file = args.first
-      promtpt_test_file = args.last
+        def call(prompt_file: nil, **options)
+          chatgpt = ChatGPT.new(prompt_file, options.fetch(:out), options.fetch(:plugin, nil))
+          chatgpt.run
+        end
 
-      chatgpt = ChatGPT.new(args.first)
+      end
 
-      messages = YAML.load_file(promtpt_test_file)
-      chatgpt.playload messages
-    end
+      class Generate < Dry::CLI::Command
+
+        desc "根据 ChatGPT messages JSON 来生成 Prompt.md"
+        argument :json_file, type: :string, required: true, deec: "ChatGPT 生成的 messages json 文件"
+        argument :prompt_file, type: :string, required: false, deec: "要输出的Prompt文件路径, 默认生成 <同名>.md"
+
+        def call(json_file: nil, prompt_file: nil, **)
+          json = JSON.parse(File.read(json_file), symbolize_names: true)
+          prompt_file ||=  json_file.sub(File.extname(json_file), ".md")
+
+          chatgpt = ChatGPT.save(json, prompt_file)
+        end
+
+      end
+
+      class Test < Dry::CLI::Command
+
+        desc "测试 Prompt 文件"
+        argument :prompt_file, type: :string, require: true, desc: "输出 Prompt 文件"
+        argument :test_file, type: :string, require: false, desc: "测试文件, 使用 YAML 文件, 一个字符串数组。默认为 同名.test.yml"
+        option :out, type: :string, default: ".", desc: "保存测试历史时存放的目录，默认为当前目录"
+        option :plugin, type: :string, desc: "运行的时候载入对应的插件"
+
+        def call(prompt_file: nil, test_file:nil, **options)
+          test_file ||= prompt_file.sub(File.extname(prompt_file), ".test.yml")
+
+          chatgpt = ChatGPT.new(prompt_file, options.fetch(:out), options.fetch(:plugin, nil))
+          messages = YAML.load_file(test_file)
+          chatgpt.playload messages
+        end
+
+      end
+
+      register "version", Version, aliases: ["v", "-v", "--version"]
+      register "build", Build, aliases: ["b"]
+      register "run", Run, aliases: ["r"]
+      register "generate", Generate, aliases: ["g"]
+      register "test", Test, aliases: ["t"]
 
-    if subcommands.key?(ARGV.first)
-      subcommands[ARGV.first].call(ARGV[1..-1])
-    else
-      puts "Invalid command. Use -h or --help for usage information."
     end
+  end
 
+  module_function
+  def cli
+    Dry::CLI.new(Luogu::CLI::Commands).call
   end
-end
+end

data/lib/luogu/init.rb

@@ -3,8 +3,10 @@ require 'dotenv/load'
 require "tty-prompt"
 require 'json'
 require 'yaml'
-require 'optparse'
+require "dry/cli"
+require 'fileutils'
 
+require_relative 'plugin'
 require_relative 'history_queue'
 require_relative "prompt_parser"
 require_relative "chatgpt"

data/lib/luogu/plugin.rb

@@ -0,0 +1,52 @@
+module Luogu
+  class Plugin
+    attr_reader :before_input_proc, :before_save_history_proc, :after_input_proc, :after_save_history_proc,
+     :setup_proc, :before_request_proc, :after_request_proc
+
+    def initialize(plugin_file_path)
+      @plugin_file_path = plugin_file_path
+
+      @before_input_proc = nil
+      @before_save_history_proc = nil
+
+      @after_input_proc = nil
+      @after_save_history_proc = nil
+
+      @setup_proc = nil
+    end
+
+    def before_input(&block)
+      @before_input_proc = block
+    end
+
+    def before_save_history(&block)
+      @before_save_history_proc = block
+    end
+
+    def after_input(&block)
+      @after_input_proc = block
+    end
+
+    def after_save_history(&block)
+      @after_save_history_proc = block
+    end
+
+    def setup(&block)
+      @setup_proc = block
+    end
+
+    def before_request(&block)
+      @before_request_proc = block
+    end
+
+    def after_request(&block)
+      @after_request_proc = block
+    end
+
+    def load()
+      self.instance_eval File.read(@plugin_file_path)
+      self
+    end
+    
+  end
+end

data/lib/luogu/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Luogu
-  VERSION = "0.1.6"
+  VERSION = "0.1.8"
 end

data/luogu.gemspec

@@ -35,6 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'ruby-openai', '~> 3.7'
   spec.add_dependency 'dotenv', '~> 2.8', '>= 2.8.1'
   spec.add_dependency 'tty-prompt', '~> 0.23.1'
+  spec.add_dependency 'dry-cli', '~> 1.0'
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: luogu
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - MJ
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-09 00:00:00.000000000 Z
+date: 2023-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
@@ -58,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.23.1
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: 使用markdown来快速实现 Prompt工程研发
 email:
 - tywf91@gmail.com
@@ -76,6 +90,7 @@ files:
 - lib/luogu/cli.rb
 - lib/luogu/history_queue.rb
 - lib/luogu/init.rb
+- lib/luogu/plugin.rb
 - lib/luogu/prompt_parser.rb
 - lib/luogu/version.rb
 - luogu.gemspec