ask_chatgpt 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66462915e1e106d09ff5990c0e892e02401c8a157306705bff4a6338bf775f1d
-  data.tar.gz: a747d8a310b2861ccd088a1ac27accde74acd2e4732c2f41938ef6536bcdbc76
+  metadata.gz: 81b5ff785019505f049a92996ae9a8f2afbb6bda16375df14a9b101d110a4e3f
+  data.tar.gz: 0c4c037173a02db028500cf6dbafe67331b3f3b90b2bcd80327f3e0336e678e6
 SHA512:
-  metadata.gz: 287029104e1b14dd1f2f9b36e8cf11e55082424ebda4f88a767bd29088faccbdbadf79d3314075e9f0868bebbe38801cce9202c108147617c644454584162115
-  data.tar.gz: c1bc943ae6ae4e6195a1e98dd53e82d3d72afbcbbf170e9d8590b92fc62b740e2a6ca30b9a67698a9113b04c575eb74ed6bd57b1162ba78cd19f918777af4259
+  metadata.gz: e7d950e4d0cd28e23a37a1987ae6600d8627eea1974360ae138dadf556a9976ced78423afa69b6da94d5f7a6d7d6fac9c41d057d5f9c78b40419cc779a003e93
+  data.tar.gz: 3062aee654d3d3505af33762a2c781d02a02b6b50edd1539a6ab248914ffaac31169899c1eda184782683c14fbeacad361859ae4b2930f739d90055d71597ee6

data/README.md

@@ -5,10 +5,10 @@
 
 AI-Powered Assistant Gem right in your Rails console.
 
-![AskChatGPT](docs/gpt.gif)
+![AskChatGPT](docs/interactive.gif)
 
 A Gem that leverages the power of AI to make your development experience more efficient and enjoyable. With this gem, you can streamline your coding process, effortlessly refactor and improve your code, and even generate tests on the fly.
-
++
 See more [examples](#examples) below.
 
 ## Usage
@@ -33,8 +33,23 @@ Go to Rails console and run:
   }
 ```
 
+OR with CLI tool:
+
+```shell
+>ask_chatgpt -q "134*1245"
+166830
+
+>ask_chatgpt base64 this string "hello world"
+aGVsbG8gd29ybGQ=
+
+>ask_chatgpt decode base64 this string "aGVsbG8gd29ybGQ="
+hello world
+```
+
 See some examples below. You can also create your own prompts with just few lines of code [here](#options--configurations).
 
+Also you can use a CLI tool, [how to use it](#cli-tool).
+
 ## Examples
 
 Typical use-cases how you can use this plugin
@@ -88,14 +103,18 @@ And you can edit:
 ```ruby
   AskChatGPT.setup do |config|
     # config.access_token    = ENV["OPENAI_API_KEY"]
-    # config.debug           = false
-    # config.model           = "gpt-3.5-turbo"
-    # config.temperature     = 0.1
-    # config.max_tokens      = 3000 # or nil by default
-    # config.included_prompt = []
+
+    # async mode will use OpenAI streamming feature and will return results as they come
+    # config.mode             = :async # or :sync
+    # config.markdown         = true # try to output nicely Markdown response
+    # config.debug            = false
+    # config.model            = "gpt-3.5-turbo"
+    # config.temperature      = 0.1
+    # config.max_tokens       = 3000 # or nil by default
+    # config.included_prompts = []
 
     # Examples of custom prompts:
-    # you can use them `gpt.ask(:extract_email, "some string")`
+    # you can use them `gpt.extract_email("some string")`
 
     # config.register_prompt :extract_email do |arg|
     #   "Extract email from: #{arg} as JSON"
@@ -111,7 +130,15 @@ And you can edit:
   end
 ```
 
-Note: that you need to setup your API Key https://platform.openai.com/account/api-keys. You can store it in the .env or .bash_profile. BUT make sure it won't be committed to the Github. Is must be private.
+Note: that you need to setup your API Key https://platform.openai.com/account/api-keys. You can store it in the .env or .bash_profile.
+
+Example with `nano ~/.bash_profile`:
+
+```
+export OPENAI_API_KEY=key
+```
+
+BUT make sure it won't be committed to the Github. Is must be private.
 
 You can define you own prompts and use them using `.register_prompt`. For example:
 
@@ -122,7 +149,7 @@ You can define you own prompts and use them using `.register_prompt`. For exampl
 ```
 
 And later you can call it with `gpt.extract_email("some text with email@site.com, user@email.com")`.
-If you believe your custom promts will be useful - create a PR for this gem.
+If you believe your custom prompt will be useful - create a PR for this gem.
 
 If you want to get source code use this helper `AskChatGPT::Helpers.extract_source(str)`.
 
@@ -136,6 +163,8 @@ You can pass:
   AskChatGPT::Helpers.extract_source("a = b")
 ```
 
+By default when you use in Rails app default one prompt is included (`.included_prompts`) which is sending Ruby/Rails versions, and name of the database adapter.
+
 ## Debug Mode
 
 You can enable debug mode to see request/response from the OpenAI using two ways:
@@ -144,21 +173,65 @@ You can enable debug mode to see request/response from the OpenAI using two ways
 AskChatGPT.setup do |config|
   config.debug = false
 end
+
+# or
+
+# gpt.on!(:debug)
+# gpt.off!(:debug)
 ```
 
 or directly in console `gpt.debug!` (and finish `gpt.debug!(:off)`)
 
+## CLI Tool
+
+Example 1:
+![AskChatGPT](docs/unzip.gif)
+
+Example 2:
+![AskChatGPT](docs/avg_user_age_json.gif)
+
+How to use:
+
+```
+  ask_chatgpt -q "How to parse JSON file in Ruby?"
+  ask_chatgpt -f app/models/user.rb -q "find a bug in this Rails model"
+  ask_chatgpt -f app/models/user.rb -q "create RSpec spec for this model"
+  ask_chatgpt -f test/dummy/Gemfile -q "sort Ruby gems alphabetically"
+```
+
+## Streaming (async vs sync mode)
+
+Control the mode from a console. Or, from the initializer, using `config.mode = :async` (or sync).
+
+```ruby
+  gpt.async!
+  gpt.sync!
+```
+
+## Markdown
+
+Try to format response from Markdown and print it nicely in the console.
+
+```ruby
+AskChatGPT.setup do |config|
+  config.markdown = true
+end
+
+# or
+
+# gpt.on!(:markdown)
+# gpt.off!(:markdown)
+```
+
 ## TODO
 
-- cli app? `ask_gpt <something> --file <file>` ...
+- better CLI?
 - more prompts (cover controllers, sql, etc?), e.g. `with_controller`, `with_class`, ...
 - tests(rspec, vcr)
-- CI (but first specs)
 - can it be used with pry/byebug/etc?
 - print tokens usage? `.with_usage`
 - support org_id? in the configs
 - use `gpt` in the code of the main app (e.g. model/controller)
-- remove dependency on `ruby-openai` and just do a `Net::HTTP` call
 
 ## Contributing
 

data/bin/ask_chatgpt

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'active_support'
+
+require_relative "../lib/ask_chatgpt"
+
+AskChatgpt.setup do |config|
+  config.included_prompts = []
+end
+
+options = {}
+
+parser = OptionParser.new do |opts|
+  opts.banner = <<-USAGE
+    Usage: ask_chatgpt [options]"
+
+    Make sure you have set OPENAI_API_KEY environment variable.
+    You can put it in your ~/.bashrc, ~/.bash_profile, ~/.zshrc file or using plenty of other options.
+
+    Examples:
+      ask_chatgpt -q "How to parse JSON file in Ruby?"
+      ask_chatgpt -f app/models/user.rb -q "find a bug in this Rails model"
+      ask_chatgpt -f app/models/user.rb -q "create RSpec spec for this model"
+      ask_chatgpt -f test/dummy/Gemfile -q "sort Ruby gems alphabetically"
+
+  USAGE
+
+  opts.on("-q", "--question \"Your Prompt\"", String, "Specify your prompt with full context, language, etc.") do |prompt|
+    options[:prompt] = prompt
+  end
+
+  opts.on("-f", "--file FILE", String, "Specify file with prompt") do |file|
+    options[:file_path] = file
+  end
+
+  opts.on("-d", "--debug", "Output request/response") do |debug|
+    options[:debug] = true
+  end
+
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end
+
+parser.parse!
+
+AskChatGPT.debug = !!options[:debug]
+
+options[:prompt] = ARGV.join(" ") if options[:prompt].blank?
+
+if options[:prompt].blank?
+  puts parser
+  exit
+end
+
+include AskChatGPT::Console
+
+instance = gpt.ask(options[:prompt])
+instance = instance.payload(File.read(options[:file_path])) if options[:file_path].present?
+
+puts instance.inspect

data/lib/ask_chatgpt/default_behavior.rb

@@ -0,0 +1,31 @@
+module AskChatgpt
+  module DefaultBehavior
+    DEFAULT_PROMPTS = [:improve, :refactor, :question, :find_bug, :code_review, :rspec_test, :unit_test, :explain]
+
+    def with_model(*models)
+      self.tap do
+        models.each do |model|
+          add_prompt AskChatGPT::Prompts::Model.new(model)
+        end
+      end
+    end
+    alias :with_models :with_model
+
+    DEFAULT_PROMPTS.each do |method|
+      define_method(method) do |*args|
+        # camelize method name and get constant from AskChatGPT::Prompts
+        add_prompt(AskChatGPT::Prompts.const_get(ActiveSupport::Inflector.camelize(method.to_s)).new(*args))
+      end
+    end
+    alias :ask :question
+    alias :payload :question
+    alias :how :question
+    alias :find :question
+    alias :review :code_review
+
+    def add_prompt(prompt)
+      scope << prompt
+      self
+    end
+  end
+end

data/lib/ask_chatgpt/executor.rb

@@ -1,5 +1,8 @@
+require_relative "sugar"
 require_relative "prompts/base"
 require_relative "prompts/improve"
+require_relative "default_behavior"
+
 Dir[File.join(__dir__, "prompts", "*.rb")].each do |file|
   require file
 end
@@ -8,70 +11,93 @@ end
 # https://www.greataiprompts.com/chat-gpt/best-coding-prompts-for-chat-gpt/
 
 module AskChatgpt
+  class InputError < StandardError; end
+
   class Executor
-    DEFAULT_PROMPTS = [:improve, :refactor, :question, :find_bug, :code_review, :rspec_test, :unit_test, :explain]
+    include AskChatgpt::Sugar, AskChatgpt::DefaultBehavior
 
-    attr_reader :scope, :client
+    attr_reader :scope, :client, :spinner, :cursor
 
     def initialize(client)
-      @scope = AskChatGPT.included_prompt.dup
-      @client = client
+      @scope   = AskChatGPT.included_prompts.dup
+      @client  = client
+      @spinner = TTY::Spinner.new(format: :classic)
+      @cursor  = TTY::Cursor
     end
 
-    def debug!(mode = :on)
-      AskChatGPT.debug = mode == :on
-    end
-
-    def with_model(*models)
-      self.tap do
-        models.each do |model|
-          add_prompt AskChatGPT::Prompts::Model.new(model)
-        end
-      end
-    end
-    alias :with_models :with_model
-
-    DEFAULT_PROMPTS.each do |method|
-      define_method(method) do |*args|
-        add_prompt(AskChatGPT::Prompts.const_get(method.to_s.camelize).new(*args))
-      end
-    end
-    alias :ask :question
-    alias :payload :question
-    alias :how :question
-    alias :find :question
-    alias :review :code_review
-
     def inspect
       pp(executor_parameters) if AskChatGPT.debug
-      puts(call); nil
+      call_with_validations do
+        case AskChatGPT.mode
+        when :async
+          call_async
+        else
+          call_sync
+        end
+      end
+    rescue InputError => e
+      puts e.message
     rescue StandardError => e
       puts e.message
       puts e.backtrace.take(5).join("\n")
+    ensure
       nil
     end
 
-    def call
+    private
+
+    def call_with_validations
       if scope.empty? || (scope.size == 1 && scope.first.is_a?(AskChatGPT::Prompts::App))
-        return puts("No prompts given")
+        raise InputError, "No prompts given"
       end
-
-      spinner = TTY::Spinner.new(format: :classic)
+      print cursor.save
       spinner.auto_spin
-      response = client.chat(parameters: executor_parameters)
-      spinner.stop
+      yield
+    ensure
+      spinner.stop if spinner&.spinning?
+    end
+
+    # we will collect all chunks and print them at once later with Markdown
+    def call_async
+      content = []
+      response = client.chat(parameters: executor_parameters.merge({
+        stream: proc do |chunk, _bytesize|
+          spinner.stop if spinner&.spinning?
+          content_part = chunk.dig("choices", 0, "delta", "content")
+          content << content_part
+          print content_part
+        end
+      }))
+      if AskChatGPT.markdown
+        # re-draw the screen
+        # go back to the top by the number of new lines previously printed
+        print cursor.clear_lines(content.compact.join.split("\n").size + 1, :up)
+        # print cursor.restore
+        # print cursor.down
+        # print cursor.clear_screen_down
+        # $content = content.compact.join
+        puts(TTY::Markdown.parse(content.compact.join))
+      else
+        # nothing, content is already printed in the stream
+      end
+    end
 
+    # wait for the whole response and print it at once
+    def call_sync
+      response = client.chat(parameters: executor_parameters)
       pp(response) if AskChatGPT.debug
+      spinner&.stop
 
       if response["error"]
-        puts response["error"]["message"]
+        puts(response["error"]["message"])
       else
         content = response.dig("choices", 0, "message", "content")
-        parsed = TTY::Markdown.parse(content)
-        parsed
+        if AskChatGPT.markdown
+          puts(TTY::Markdown.parse(content))
+        else
+          puts(content)
+        end
       end
-    ensure
-      spinner.stop if spinner&.spinning?
     end
 
     def executor_parameters
@@ -80,13 +106,7 @@ module AskChatgpt
         temperature: AskChatGPT.temperature,
         max_tokens: AskChatGPT.max_tokens,
         messages: scope.map { |e| { role: "user", content: e.content } }.reject { |e| e[:content].blank? },
-      }.compact_blank
-    end
-
-    def add_prompt(prompt)
-      @scope << prompt
-      self
+      }.reject { |_, v| v.blank? }
     end
-
   end
 end

data/lib/ask_chatgpt/prompts/app.rb

@@ -6,7 +6,7 @@ module AskChatgpt
           general_info,
           version_info,
           database_info
-        ].compact_blank.join(", ")
+        ].reject { |v| v.blank? }.join(", ")
       end
 
       private

data/lib/ask_chatgpt/prompts/code_review.rb

@@ -2,7 +2,7 @@ module AskChatgpt
   module Prompts
     class CodeReview < Improve
       private def action_info
-        "Analyze the given Ruby code for code smells and suggest improvements:"
+        "Analyze the given Ruby code for code smells and suggest improvements, use Markdown for code snippets:"
       end
     end
   end

data/lib/ask_chatgpt/prompts/explain.rb

@@ -2,7 +2,7 @@ module AskChatgpt
   module Prompts
     class Explain < Improve
       private def action_info
-        "Explain me this Ruby code snippet:"
+        "Explain me this Ruby code snippet, use Markdown for code snippets:"
       end
     end
   end

data/lib/ask_chatgpt/prompts/improve.rb

@@ -6,7 +6,7 @@ module AskChatgpt
         [
           action_info,
           method_info,
-        ].compact_blank.join("\n")
+        ].reject { |v| v.blank? }.join("\n")
       end
 
       private

data/lib/ask_chatgpt/prompts/model.rb

@@ -7,7 +7,7 @@ module AskChatgpt
           schema_info,
           associations_info,
           instructions_info
-        ].compact_blank.join("\n\n")
+        ].reject { |v| v.blank? }.join("\n\n")
       end
 
       private

data/lib/ask_chatgpt/prompts/rspec_test.rb

@@ -2,7 +2,7 @@ module AskChatgpt
   module Prompts
     class RspecTest < Improve
       private def action_info
-        "Write a rspec test for the given Ruby on Rails code:"
+        "Write a rspec test for the given Ruby on Rails code in Ruby code, return as Markdown:"
       end
     end
   end

data/lib/ask_chatgpt/prompts/unit_test.rb

@@ -2,7 +2,7 @@ module AskChatgpt
   module Prompts
     class UnitTest < Improve
       private def action_info
-        "Write a unit test for the given Ruby on Rails code:"
+        "Write a unit test for the given Ruby on Rails code in Ruby code, return as Markdown:"
       end
     end
   end

data/lib/ask_chatgpt/sugar.rb

@@ -0,0 +1,47 @@
+module AskChatgpt
+  module Sugar
+
+    def debug!(mode = :on)
+      AskChatGPT.debug = mode == :on
+    end
+
+    def sync!
+      AskChatGPT.mode = :sync
+    end
+
+    def async!
+      AskChatGPT.mode = :async
+    end
+
+    def on!(feature)
+      case feature
+      when :markdown
+        AskChatGPT.markdown = true
+      when :debug
+        AskChatGPT.debug = true
+      when :async
+        AskChatGPT.mode = :async
+      when :sync
+        AskChatGPT.mode = :sync
+      else
+        raise InputError, "Unknown feature: #{feature}"
+      end
+    end
+
+    def off!(feature)
+      case feature
+      when :markdown
+        AskChatGPT.markdown = false
+      when :debug
+        AskChatGPT.debug = false
+      when :async
+        AskChatGPT.mode = :sync
+      when :sync
+        AskChatGPT.mode = :async
+      else
+        raise InputError, "Unknown feature: #{feature}"
+      end
+    end
+
+  end
+end

data/lib/ask_chatgpt/version.rb

@@ -1,3 +1,3 @@
 module AskChatgpt
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/ask_chatgpt.rb

@@ -1,10 +1,14 @@
-require "ask_chatgpt/version"
-require "ask_chatgpt/railtie"
+# to make sure we have good gem version
+gem "ruby-openai", '>= 4.0.0'
+
+require_relative "ask_chatgpt/version"
+require "ask_chatgpt/railtie" if defined?(Rails)
 require "net/http"
 require "json"
 require "openai"
 require "tty-markdown"
 require "tty-spinner"
+require "tty-cursor"
 
 require_relative "ask_chatgpt/console"
 require_relative "ask_chatgpt/executor"
@@ -14,6 +18,13 @@ require_relative "ask_chatgpt/core"
 module AskChatgpt
   ::AskChatGPT = AskChatgpt
 
+  # async mode will use OpenAI streamming feature and will return results as they come
+  mattr_accessor :mode
+  @@mode = :async # or :sync
+
+  mattr_accessor :markdown
+  @@markdown = true
+
   mattr_accessor :debug
   @@debug = false
 
@@ -35,8 +46,8 @@ module AskChatgpt
 
   # this prompt is always included
   # it constain info that you have Rails app and Rails/Ruby versions, and DB adapter name
-  mattr_accessor :included_prompt
-  @@included_prompt = [AskChatGPT::Prompts::App.new]
+  mattr_accessor :included_prompts
+  @@included_prompts = [AskChatGPT::Prompts::App.new]
 
   def self.setup
     yield(self)

data/lib/generators/ask_chatgpt/templates/template.rb

@@ -1,10 +1,14 @@
 AskChatGPT.setup do |config|
   # config.access_token    = ENV["OPENAI_API_KEY"]
-  # config.debug           = false
-  # config.model           = "gpt-3.5-turbo"
-  # config.max_tokens      = 3000 # or nil by default
-  # config.temperature     = 0.1
-  # config.included_prompt = []
+
+  # async mode will use OpenAI streamming feature and will return results as they come
+  # config.mode             = :async # or :sync
+  # config.markdown         = true # try to convert response if Markdown
+  # config.debug            = false
+  # config.model            = "gpt-3.5-turbo"
+  # config.max_tokens       = 3000 # or nil by default
+  # config.temperature      = 0.1
+  # config.included_prompts = []
 
   # Examples of custom prompts:
   # you can use them `gpt.ask(:extract_email, "some string")`

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ask_chatgpt
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Igor Kasyanchuk
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-26 00:00:00.000000000 Z
+date: 2023-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: tty-markdown
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +67,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-cursor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: irb
   requirement: !ruby/object:Gem::Requirement
@@ -113,16 +127,19 @@ description: AI-Powered Assistant Gem right in your Rails console.
 email:
 - igorkasyanchuk@gmail.com
 - manastyretskyi@gmail.com
-executables: []
+executables:
+- ask_chatgpt
 extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- bin/ask_chatgpt
 - lib/ask_chatgpt.rb
 - lib/ask_chatgpt/console.rb
 - lib/ask_chatgpt/core.rb
+- lib/ask_chatgpt/default_behavior.rb
 - lib/ask_chatgpt/executor.rb
 - lib/ask_chatgpt/helpers.rb
 - lib/ask_chatgpt/prompts/app.rb
@@ -138,6 +155,7 @@ files:
 - lib/ask_chatgpt/prompts/rspec_test.rb
 - lib/ask_chatgpt/prompts/unit_test.rb
 - lib/ask_chatgpt/railtie.rb
+- lib/ask_chatgpt/sugar.rb
 - lib/ask_chatgpt/version.rb
 - lib/generators/ask_chatgpt/USAGE
 - lib/generators/ask_chatgpt/ask_chatgpt_generator.rb