richat 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90dc1c0cb9c1069b11e432d7164fe8b17d0095e19a82ea5830ba1f57fd98511c
-  data.tar.gz: 11b9948cc323b52f14f3d89e0d2ca392988130c284c95e5b2e44df3c0e2ce356
+  metadata.gz: 9b76efa6dcbdfe7a9f2184c7823b6c0292a6ce8b35ed44378679c06b0c847503
+  data.tar.gz: cda10863c00442ecd0a5c24c5758251bcfa1bb04b84f623843c2b6df30d1ead5
 SHA512:
-  metadata.gz: 3c4171cad77ca01fa510cda74a1a8ff08c7a9db288d7172c16bf6d31219f4436f8e228b10bd735369bdf2f3f7b0b7782ebfcf003df86572941b7bc0add8e1abc
-  data.tar.gz: e37cd9b94f2e2346d8412627be3538453922c1ce0b0bd1b165451861f6060b13781a7cde6f4cc399f1096d128238549508e0449326a739d5e14b8d2fb4c3b69a
+  metadata.gz: 3251caa055e0e5e60b9cac6981e81b52c083eebf06c5c5a4d4e2f115171f4445ed79142694ef514c1f067aed13276f0e03230f85896e8fce425804abb2cbbd16
+  data.tar.gz: '04008b119d99774c298f20f3d631a938221be60951df86e8e1c0eb6630060f3762561cfc62798f6cfa65746465c1b704febf63f1834dda82da248679d5adc6ea'

data/exe/richat

@@ -1,36 +1,76 @@
 #!/usr/bin/env ruby
 
-require 'bundler/setup'
+require 'optparse'
 require 'richat'
 
-log_dir = File.expand_path(Richat::Config.get("log", "log_dir"))
-FileUtils.mkdir_p(log_dir) unless File.directory?(log_dir)
+cli_opts = {}
 
-prompt_dir = File.expand_path(Richat::Config.get("prompt", "prompt_dir"))
-FileUtils.mkdir_p(prompt_dir) unless File.directory?(prompt_dir)
+OptionParser.new do |opts|
+  opts.banner = %q{Usage: richat [options] [chat content]
+richat will enter shell mode if chat content is empty}
+  opts.version = Richat::VERSION
+  opts.program_name = "richat"
 
-chat_config = {
-  api_key: Richat::Config.get("chatgpt", "api_key"),
-  model: Richat::Config.get("chatgpt", "model"),
-  temperature: Richat::Config.get("chatgpt", "temperature"),
-  stream: true
-}
+  opts.separator "\nOptions:"
+
+  opts.on("-l", "--logfile=LOG FILE", "Set log file path") do |l|
+    cli_opts["log"] = { "log_file" => l }
+  end
+
+  opts.on_tail("-h", "--help", "Print help") do
+    puts opts
+    puts "\nFurther help: https://github.com/fzdp/richat"
+    exit
+  end
 
-if chat_config[:api_key].nil? || chat_config[:api_key].empty?
+  opts.on_tail("-v", "--version", "Version") do
+    puts "richat " + Richat::VERSION
+    exit
+  end
+end.parse!
+
+Richat::Config.override_with(cli_opts) unless cli_opts.empty?
+
+api_key = Richat::Config.get("chatgpt", "api_key")
+if api_key.nil? || api_key.empty?
   puts "OpenAI API key not set, refer https://github.com/fzdp/richat#usage for more info."
   exit
 end
 
 if Richat::Config.get("log", "enable")
-  logger = Richat::Logger.new(log_file: "#{log_dir}/#{Time.now.strftime('%Y%m%d')}.md")
+  log_dir = File.expand_path(Richat::Config.get("log", "log_dir"))
+  log_file = Richat::Config.get("log", "log_file")
+
+  if log_file.nil? || log_file.empty?
+    log_file = File.join(log_dir, "#{Time.now.strftime('%Y%m%d')}.md")
+  elsif log_file.start_with? "~/"
+    log_file = File.expand_path(log_file)
+  elsif !Richat::Utils.absolute_path?(log_file)
+    log_file = File.join(log_dir, log_file)
+  end
+
+  Richat::Utils.ensure_dir_exist(File.dirname(log_file))
+  logger = Richat::Logger.new(log_file: log_file)
 else
   logger = Richat::Logger.empty_logger
 end
 
-if ARGV.size.zero?
+prompt_dir = File.expand_path(Richat::Config.get("prompt", "prompt_dir"))
+Richat::Utils.ensure_dir_exist(prompt_dir)
+
+user_content = ARGV.join(" ")
+
+chat_config = {
+  api_key: Richat::Config.get("chatgpt", "api_key"),
+  model: Richat::Config.get("chatgpt", "model"),
+  temperature: Richat::Config.get("chatgpt", "temperature"),
+  stream: true
+}
+
+if user_content.empty?
   client = Openai::Chat.new(chat_config)
   Richat::Shell.new(chat_client: client, logger: logger).call
 else
   client = Openai::Chat.new(chat_config.merge(stream: false))
-  Richat::Cli.new(chat_client: client, logger: logger, user_content: ARGV.join(" ")).call
+  Richat::Cli.new(chat_client: client, logger: logger, user_content: user_content).call
 end

data/lib/richat/command.rb

@@ -3,19 +3,21 @@ module Richat
     EXIT_CODE = 0
     NEXT_CODE = 1
     PROMPT_CHANGED_CODE = 2
+    SYS_CMD_CODE = 3
+    SYS_CHAT_CODE = 4
 
     class << self
       attr_reader :prompt, :prompt_id
 
-      def call(user_input)
+      def call(user_input, sys_cmd_mode=false)
         user_input = user_input.strip
+        return handle_system_command(user_input, sys_cmd_mode) if user_input.start_with?(*Config.get("sys_cmd", "activate_keywords"))
+        return handle_exit if Config.get("shell", "exit_keywords").include?(user_input)
         return unless user_input.start_with?("/")
         if user_input == "/help"
           handle_help
         elsif user_input == "/config"
           handle_config
-        elsif user_input == "/exit"
-          handle_exit
         elsif user_input =~ /^\/prompt\s*/
           if user_input == "/prompt"
             handle_prompt
@@ -25,6 +27,25 @@ module Richat
         end
       end
 
+      def handle_system_command(user_input, sys_cmd_mode)
+        Config.get("sys_cmd", "activate_keywords").each do |sub_str|
+          if user_input.start_with?(sub_str)
+            cmd = user_input[sub_str.length..-1].strip
+            return SYS_CHAT_CODE if Config.get("sys_cmd", "deactivate_keywords").include?(cmd) && sys_cmd_mode
+            if (match = /^cd\s?(.*)$/.match(cmd))
+              Dir.chdir(File.expand_path(match[1].empty? ? "~" : match[1]))
+            else
+              system(cmd)
+            end
+            if sys_cmd_mode
+              return NEXT_CODE
+            else
+              return SYS_CMD_CODE, sub_str
+            end
+          end
+        end
+      end
+
       def handle_exit
         puts "Bye"
         EXIT_CODE
@@ -32,11 +53,12 @@ module Richat
 
       def handle_config
         puts "\e[32mConfiguration file path is #{File.expand_path("~/.richat/config.json")}\e[0m"
-        puts JSON.pretty_generate(Config.config)
+        puts JSON.pretty_generate(Config.get_config)
         NEXT_CODE
       end
 
       def handle_help
+        puts "Version #{VERSION}"
         puts "\e[32m/exit\e[0m exit Richat"
         puts "\e[32m/config\e[0m show configuration"
         puts "\e[32m/prompt\e[0m show prompt list"

data/lib/richat/config.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module Richat
   class Config
     DEFAULT_CONFIG = {
@@ -9,6 +11,7 @@ module Richat
       "log" => {
         "enable" => true,
         "log_dir" => "~/.richat/logs",
+        "log_file" => nil,
         "user_role" => "USR",
         "ai_role" => "GPT",
         "system_role" => "SYS"
@@ -17,7 +20,12 @@ module Richat
         "save_shell_history" => true,
         "enable_chat_context" => true,
         "show_welcome_info" => true,
-        "shell_history_file" => "~/.richat/history.txt"
+        "shell_history_file" => "~/.richat/history.txt",
+        "exit_keywords" => ["/exit", "q", "quit", "exit"]
+      },
+      "sys_cmd" => {
+        "activate_keywords" => [">", "!"],
+        "deactivate_keywords" => ["q", "quit", "exit"]
       },
       "prompt" => {
         "prompt_dir" => "~/.richat/prompts",
@@ -28,8 +36,16 @@ module Richat
     class << self
       attr_reader :config
 
+      def get_config
+        (@config ||= merge_config)
+      end
+
       def get(*keys)
-        (@config ||= merge_config).dig(*keys)
+        get_config.dig(*keys)
+      end
+
+      def override_with(other_config)
+        @config = Utils.deep_merge_hash(get_config, other_config)
       end
     end
 
@@ -41,7 +57,7 @@ module Richat
                     else
                       {}
                     end
-      DEFAULT_CONFIG.deep_merge(user_config)
+      Utils.deep_merge_hash(DEFAULT_CONFIG, user_config)
     end
   end
 end

data/lib/richat/shell.rb

@@ -33,17 +33,21 @@ module Richat
       end
 
       Command.print_welcome if Config.get("shell", "show_welcome_info")
+      sys_cmd_mode = false
+      current_cmd_prefix = nil
 
       begin
-        while (user_content = Readline.readline("\e[32m#{Command.prompt_id&.+" "}\e[0m\e[33m>> \e[0m", true))
+        while (user_content = Readline.readline(shell_prompt(sys_cmd_mode, current_cmd_prefix), true))
           if user_content.empty?
             Readline::HISTORY&.pop
             next
           end
 
+          user_content = current_cmd_prefix + user_content if sys_cmd_mode
           File.open(history_path, 'a') { |f| f.puts(user_content) } if enable_full_completion
 
-          if (code = Command.call(user_content))
+          code, _ = Command.call(user_content, sys_cmd_mode)
+          if code
             if code == Command::NEXT_CODE
               next
             elsif code == Command::EXIT_CODE
@@ -51,6 +55,13 @@ module Richat
             elsif code == Command::PROMPT_CHANGED_CODE
               context_messages = [{ role: 'system', content: Command.prompt }]
               next
+            elsif code == Command::SYS_CMD_CODE
+              sys_cmd_mode = true
+              current_cmd_prefix = _
+              next
+            elsif code == Command::SYS_CHAT_CODE
+              sys_cmd_mode = false
+              next
             end
           end
 
@@ -84,5 +95,15 @@ module Richat
         Command.handle_exit
       end
     end
+
+    private
+
+    def shell_prompt(sys_cmd_mode, current_cmd_prefix)
+      if sys_cmd_mode
+        "\e[32m#{Command.prompt_id&.+" "}\e[0m\e[33m>>\e[0m \e[32m#{current_cmd_prefix}\e[0m"
+      else
+        "\e[32m#{Command.prompt_id&.+" "}\e[0m\e[33m>> \e[0m"
+      end
+    end
   end
 end

data/lib/richat/utils.rb

@@ -0,0 +1,33 @@
+module Richat
+  class Utils
+    class << self
+      def deep_merge_hash(hs1, hs2)
+        result = hs1.dup
+
+        hs2.each do |key, value|
+          if value.is_a?(Hash) && hs1[key].is_a?(Hash)
+            result[key] = deep_merge_hash(result[key], value)
+          else
+            result[key] = value
+          end
+        end
+
+        result
+      end
+
+      def absolute_path?(fp)
+        File.expand_path(fp) == fp
+      end
+
+      def ensure_dir_exist(*dirs)
+        dirs.each do |dir_name|
+          if dir_name.nil? || dir_name.empty?
+            puts "invalid directory"
+            exit
+          end
+          FileUtils.mkdir_p(dir_name) unless File.directory?(dir_name)
+        end
+      end
+    end
+  end
+end

data/lib/richat/version.rb

@@ -1,3 +1,3 @@
 module Richat
-  VERSION = "0.2.4"
+  VERSION = "0.3.0"
 end

data/lib/richat.rb

@@ -1,6 +1,6 @@
 require "richat/version"
 
-require_relative 'extension/hash'
+require_relative 'richat/utils'
 require_relative 'richat/config'
 require_relative 'richat/command'
 require_relative 'openai/chat'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: richat
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - fzdp
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-04 00:00:00.000000000 Z
+date: 2023-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -67,8 +67,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.12'
 description: Richat is a command-line ChatGPT tool implemented in Ruby that supports
-  highly customizable configuration. It can save chat logs, performs fuzzy searches
-  on historical inputs, allows for prompt customization and switching at any time
+  highly customizable configuration. It can save chat contents, performs fuzzy searches
+  on historical inputs, allows for prompt switching at any time and can event act
+  as Linux terminal.
 email:
 - fzdp01@gmail.com
 executables:
@@ -77,7 +78,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - exe/richat
-- lib/extension/hash.rb
 - lib/openai/chat.rb
 - lib/richat.rb
 - lib/richat/cli.rb
@@ -85,6 +85,7 @@ files:
 - lib/richat/config.rb
 - lib/richat/logger.rb
 - lib/richat/shell.rb
+- lib/richat/utils.rb
 - lib/richat/version.rb
 homepage: https://github.com/fzdp/richat
 licenses:
@@ -107,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Richat is a command-line ChatGPT tool

data/lib/extension/hash.rb

@@ -1,15 +0,0 @@
-class Hash
-  def deep_merge(other_hash)
-    result = self.dup
-
-    other_hash.each do |key, value|
-      if value.is_a?(Hash) && self[key].is_a?(Hash)
-        result[key] = result[key].deep_merge(value)
-      else
-        result[key] = value
-      end
-    end
-
-    result
-  end
-end