richat 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9d0ef493fcedb52399b88baee0ef20c11d90fdf258c5aa4f8df2caca0e2ec23
-  data.tar.gz: caf49bffd8f470ba54bcfd27d639899a10068a4a7ba696eab2e3bcba8416a755
+  metadata.gz: a6a6598af5c6e17f582012237108fdb8476d3c8c2b015114a8f2e5b72fcd8e02
+  data.tar.gz: 2103424385ccbc8342beca1be859faeb2c42a5f15ae4188b8253651d18a438d1
 SHA512:
-  metadata.gz: 207d40655ca0be10eb68a2409943206ba1ef42d946a70553d8f0db4260d415486e8922fa9da578eb9b9634622d77b7d68f9c2496a9f3cfaebfcf476759b13e29
-  data.tar.gz: 9d4091ce31a3783ddd50cc5f1a00844ac1baa61937e8edcbf5b21f3e03ccfd909854212da22b4d284073104c6894b8472c4ac5ad1ff996117a7fe84f5cb9a697
+  metadata.gz: e6a3aad954fb88a24cf79e9f334d5912fd0fac875b74c4e585d4fa10626179ce22c0912686b8b7e2ac4642ed77fdab7962b2a63a5fbca8c0df4ebf821e4ecad4
+  data.tar.gz: c4012e6a086e7bddfdcc1e65a488f4248254e4ab3d814319806cd53725f12e8b4f5ac6eff78b1df5203398e34d82825f3082ccc0a96823b891e295a779e70510

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

@@ -32,7 +32,7 @@ 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
 
@@ -123,7 +123,13 @@ module Richat
             @prompt_id = nil
             return
           end
-          File.read(File.join(File.expand_path(Config.get("prompt", "prompt_dir")), @prompt_id))
+
+          begin
+            File.read(File.join(File.expand_path(Config.get("prompt", "prompt_dir")), @prompt_id))
+          rescue => e
+            print_exception(e.message)
+            exit
+          end
         end
       end
     end

data/lib/richat/config.rb

@@ -9,6 +9,7 @@ module Richat
       "log" => {
         "enable" => true,
         "log_dir" => "~/.richat/logs",
+        "log_file" => nil,
         "user_role" => "USR",
         "ai_role" => "GPT",
         "system_role" => "SYS"
@@ -28,8 +29,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 +50,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/logger.rb

@@ -6,12 +6,12 @@ module Richat
 
     def initialize(options = {})
       original_log_header = ::Logger::LogDevice.instance_method(:add_log_header)
-      ::Logger::LogDevice.define_method(:add_log_header) {|file|}
+      ::Logger::LogDevice.send(:define_method, :add_log_header) { |_file| nil }
 
-       @logger = ::Logger.new(options[:log_file])
-      ::Logger::LogDevice.define_method(original_log_header.name, original_log_header)
+      @logger = ::Logger.new(options[:log_file])
+      ::Logger::LogDevice.send(:define_method, original_log_header.name, original_log_header)
 
-      @logger.formatter = proc do |severity, datetime, role, msg|
+      @logger.formatter = proc do |_severity, datetime, role, msg|
         "[#{role}] #{datetime.strftime('%Y-%m-%d %H:%M:%S')}\n\n#{msg}\n\n"
       end
     end

data/lib/richat/shell.rb

@@ -11,7 +11,7 @@ module Richat
       @ai_role = Config.get("log", "ai_role")
       @system_role = Config.get("log", "system_role")
       @history_path = File.expand_path(Config.get("shell", "shell_history_file"))
-      File.open(@history_path, 'w') {} unless File.exists?(@history_path)
+      File.open(@history_path, 'w') {} unless File.exist?(@history_path)
     end
 
     def call

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.3"
+  VERSION = "0.2.5"
 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.3
+  version: 0.2.5
 platform: ruby
 authors:
 - fzdp
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-31 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.4.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.4.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        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
@@ -77,7 +77,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 +84,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:
@@ -100,14 +100,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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