ask_chatgpt 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66ad01c3932f32f34589d4d2eaf742c28dcd607543d98ec886e3fe56da3c655b
-  data.tar.gz: 1a7609890b8fc4ea6249ea2b563ab29ebfca0528f4255ffc4e00a3f1db0b806f
+  metadata.gz: bac19fcd064226b0e1b2b87ebb215547d8e49b59233fc6c6b17440ac4df751a0
+  data.tar.gz: 6a53484fdcdb4a872b768322a09b517807f62f17df5fc4ba3dbcfc133b65f4c7
 SHA512:
-  metadata.gz: e07712c65e13c713271127dcf539a3007763c03fe5e8afa7523820b31a003e442414d22f4fc218fa82f2f9294c3dd2679ab7ef9fcc4070635e58c05e50db62f8
-  data.tar.gz: a3564f0aecca1cea800486aa93758f46747d10cc5a185b66be43036dbc05797d92bc7f71566db652b191b1d9375790be5f3239f99f73c5f573105edcbeac23ca
+  metadata.gz: d8e51c4918ed071863f6ee2fc7ca559782e13394fd508c9422cd914ec9604eccb1b4d25455c4b3c30228dcc0caef7796d6b5eb2481c83f0c3669503ffe149a34
+  data.tar.gz: 791ecab6cfb6220b81e2943f78512e5b35c95720b212591d4bbb2c0367c9fe9090f8d368cc780c7d0951439c9480a3544126d06fe566fdc56d7af0bcd620e057

data/README.md

@@ -1,4 +1,4 @@
-# AskChatGPT
+# Ask ChatGPT
 
 [![RailsJazz](https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/my_other.svg?raw=true)](https://www.railsjazz.com)
 [![Listed on OpenSource-Heroes.com](https://opensource-heroes.com/badge-v1.svg)](https://opensource-heroes.com/o/railsjazz)
@@ -9,7 +9,7 @@ AI-Powered Assistant Gem right in your Rails console.
 
 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.
 
-We are welcoming you to propose new prompts or adjust existing ones!
+See more [examples](#examples) below.
 
 ## Usage
 
@@ -18,16 +18,28 @@ Go to Rails console and run:
 ```ruby
   gpt.ask("how to get max age of user with projects from Ukraine").with_model(User, Project, Country)
   gpt.ask("convert json to xml")
+  gpt.payload(json).ask("extract emails from json")
   gpt.refactor("User.get_report")
   gpt.improve("User.get_report")
   gpt.rspec_test(User)
   gpt.unit_test(User)
   gpt.code_review(User.method(:get_report))
-  gpt.find_bug('User.full_name')
+  gpt.find_bug('User#full_name')
+  gpt.explain(User)
+  gpt.improve %Q{
+    def full_name
+      [first_name, last_name].join
+    end
+  }
 ```
 
+See some examples below. You can also create your own prompts with just few lines of code [here](#options--configurations).
+
 ## Examples
 
+Typical use-cases how you can use this plugin
+![AskChatGPT](docs/gpt6.png)
+
 Ask for code ideas:
 ![AskChatGPT](docs/gpt1.png)
 
@@ -40,6 +52,15 @@ What about unit tests?
 Ask ChatGPT to improve your code:
 ![AskChatGPT](docs/gpt4.png)
 
+Ask ChatGPT to parse you JSON:
+![AskChatGPT](docs/gpt7.png)
+
+Or it can encode in Base64 your string:
+![AskChatGPT](docs/gpt8.png)
+
+Create I18n YAML for your Model (custom prompt):
+![AskChatGPT](docs/gpt5.png)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -58,7 +79,7 @@ Or install it yourself as:
 $ gem install ask_chatgpt
 ```
 
-## Options
+## Options & Configurations
 
 Run `rails g ask_chatgpt initializer`.
 
@@ -66,25 +87,83 @@ 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.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 = []
+
+    # Examples of custom prompts:
+    # you can use them `gpt.ask(:extract_email, "some string")`
+
+    # config.register_prompt :extract_email do |arg|
+    #   "Extract email from: #{arg} as JSON"
+    # end
+
+    # config.register_prompt :extract_constants do |arg|
+    #   "Extract constants from class: #{AskChatGPT::Helpers.extract_source(arg)}"
+    # end
+
+    # config.register_prompt :i18n do |code|
+    #   "Use I18n in this code:\n#{AskChatGPT::Helpers.extract_source(code)}"
+    # end
   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.
+
+You can define you own prompts and use them using `.register_prompt`. For example:
+
+```ruby
+  config.register_prompt :extract_email do |arg|
+    "Extract email from: #{arg} as JSON"
+  end
+```
+
+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 want to get source code use this helper `AskChatGPT::Helpers.extract_source(str)`.
+
+You can pass:
+
+```ruby
+  AskChatGPT::Helpers.extract_source('User.some_class_method')
+  AskChatGPT::Helpers.extract_source('User#instance_method')
+  AskChatGPT::Helpers.extract_source('User')
+  AskChatGPT::Helpers.extract_source(User)
+  AskChatGPT::Helpers.extract_source("a = b")
+```
+
+## Debug Mode
+
+You can enable debug mode to see request/response from the OpenAI using two ways:
+
+```ruby
+AskChatGPT.setup do |config|
+  config.debug = false
+end
+```
+
+or directly in console `gpt.debug!` (and finish `gpt.debug!(:off)`)
+
 ## TODO
 
-- cli app?
-- more prompts (cover controllers, sql, etc?)
-- tests
+- cli app? `ask_gpt <something> --file <file>` ...
+- 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?
-- support org_id?
+- print tokens usage? `.with_usage`
+- support org_id? in the configs
+- use `gpt` in the code of the main app (e.g. model/controller)
 
 ## Contributing
 
-You are welcome to contribute.
+We are welcoming you to propose new prompts or adjust existing ones!
+
+To start just clone this repo. Run bundle, and go to `cd test/dummy/`. Start `rails c` and test your prompts.
 
 ## License
 

data/lib/ask_chatgpt/console.rb

@@ -0,0 +1,14 @@
+module AskChatgpt
+  module Console
+    def gpt
+      AskChatGPT::Core.call
+    end
+
+    alias :chatgpt :gpt
+    alias :chat_gpt :gpt
+
+    def run(*args)
+      gpt(*args)
+    end
+  end
+end

data/lib/ask_chatgpt/executor.rb

@@ -9,62 +9,84 @@ end
 
 module AskChatgpt
   class Executor
+    DEFAULT_PROMPTS = [:improve, :refactor, :question, :find_bug, :code_review, :rspec_test, :unit_test, :explain]
+
     attr_reader :scope, :client
 
     def initialize(client)
-      @scope = [AskChatGPT::Prompts::App.new]
+      @scope = AskChatGPT.included_prompt.dup
       @client = client
     end
 
+    def debug!(mode = :on)
+      AskChatGPT.debug = mode == :on
+    end
+
     def with_model(*models)
-      models.each do |model|
-        @scope << AskChatGPT::Prompts::Model.new(model)
+      self.tap do
+        models.each do |model|
+          add_prompt AskChatGPT::Prompts::Model.new(model)
+        end
       end
-      self
     end
-
     alias :with_models :with_model
 
-    [:improve, :refactor, :question, :find_bug, :code_review, :rspec_test, :unit_test].each do |method|
+    DEFAULT_PROMPTS.each do |method|
       define_method(method) do |*args|
-        @scope << AskChatGPT::Prompts.const_get(method.to_s.camelize).new(*args)
-        self
+        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
+    rescue StandardError => e
+      puts e.message
+      puts e.backtrace.take(5).join("\n")
+      nil
     end
 
     def call
-      pp parameters if AskChatGPT.debug
-
-      return puts("No prompts given") if scope.size == 1 # only App prompt
+      if scope.empty? || (scope.size == 1 && scope.first.is_a?(AskChatGPT::Prompts::App))
+        return puts("No prompts given")
+      end
 
       spinner = TTY::Spinner.new(format: :classic)
       spinner.auto_spin
-
-      response = client.chat(parameters: parameters)
-      content = response.dig("choices", 0, "message", "content")
+      response = client.chat(parameters: executor_parameters)
       spinner.stop
 
-      parsed = TTY::Markdown.parse(content)
-      parsed
+      pp(response) if AskChatGPT.debug
+
+      if response["error"]
+        puts response["error"]["message"]
+      else
+        content = response.dig("choices", 0, "message", "content")
+        parsed = TTY::Markdown.parse(content)
+        parsed
+      end
     ensure
       spinner.stop if spinner.spinning?
     end
 
-    def parameters
-      {
+    def executor_parameters
+      @executor_parameters ||= {
         model: AskChatGPT.model,
-        messages: scope.map { |e| { role: "user", content: e.content } },
         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
+    end
+
   end
 end

data/lib/ask_chatgpt/helpers.rb

@@ -0,0 +1,49 @@
+module AskChatgpt
+  class Helpers
+    class << self
+      def extract_source(method_or_class_or_str)
+        case method_or_class_or_str
+        when ::Proc, ::Method, ::UnboundMethod
+          method_or_class_or_str.source
+        when Module, Class, String
+          str = capture_io do
+            IRB.CurrentContext.main.irb_show_source(method_or_class_or_str.to_s)
+          end.join("\n")
+          # check if source was extracted
+          if str.include?("locate a definition for")
+            method_or_class_or_str.to_s
+          else
+            str
+          end
+        else
+          raise "Not supported parameter"
+        end
+      end
+
+      private
+
+      # from  https://github.com/minitest/minitest/blob/master/lib/minitest/assertions.rb#L542
+      def capture_io
+        _synchronize do
+          begin
+            captured_stdout, captured_stderr = StringIO.new, StringIO.new
+
+            orig_stdout, orig_stderr = $stdout, $stderr
+            $stdout, $stderr         = captured_stdout, captured_stderr
+
+            yield
+
+            return captured_stdout.string, captured_stderr.string
+          ensure
+            $stdout = orig_stdout
+            $stderr = orig_stderr
+          end
+        end
+      end
+
+      def _synchronize
+        yield
+      end
+    end
+  end
+end

data/lib/ask_chatgpt/prompts/app.rb

@@ -16,12 +16,12 @@ module AskChatgpt
       end
 
       def database_info
-        db_name = ActiveRecord::Base.connection_db_config.configuration_hash[:database] rescue nil
+        db_name = ActiveRecord::Base.connection_db_config.configuration_hash[:adapter] rescue nil
         "Database: #{db_name}" if db_name
       end
 
       def version_info
-        "Version #{Rails.version}, Ruby Version: #{RUBY_VERSION}"
+        "Rails Version #{Rails.version}, Ruby Version: #{RUBY_VERSION}"
       end
     end
   end

data/lib/ask_chatgpt/prompts/base.rb

@@ -1,14 +1,14 @@
 module AskChatgpt
   module Prompts
     class Base
-      attr_reader :str
+      attr_reader :record
 
-      def initialize(str = nil)
-        @str = str
+      def initialize(record = nil)
+        @record = record
       end
 
       def content
-        str
+        record
       end
     end
   end

data/lib/ask_chatgpt/prompts/custom.rb

@@ -0,0 +1,16 @@
+module AskChatgpt
+  module Prompts
+    class Custom < Base
+      attr_reader :args, :block
+
+      def initialize(*args, block)
+        @args = args
+        @block = block
+      end
+
+      def content
+        instance_exec(*args, &block)
+      end
+    end
+  end
+end

data/lib/ask_chatgpt/prompts/explain.rb

@@ -0,0 +1,9 @@
+module AskChatgpt
+  module Prompts
+    class Explain < Improve
+      private def action_info
+        "Explain me this Ruby code snippet:"
+      end
+    end
+  end
+end

data/lib/ask_chatgpt/prompts/improve.rb

@@ -1,11 +1,6 @@
 module AskChatgpt
   module Prompts
     class Improve < Base
-      attr_reader :method
-
-      def initialize(method)
-        @method = method
-      end
 
       def content
         [
@@ -21,44 +16,7 @@ module AskChatgpt
       end
 
       def method_info
-        case method
-        when ::Proc, ::Method, ::UnboundMethod
-          "Method source\n: #{method.source}"
-        when Module, Class, String
-          str = capture_io do
-            IRB.CurrentContext.main.irb_show_source(method.to_s)
-          end.join("\n")
-          if str.include?("locate a definition for")
-            method.to_s
-          else
-            str
-          end
-        else
-          raise "Not supported parameter, pass a Method object (example: method(:foo)))"
-        end
-      end
-
-      # from  https://github.com/minitest/minitest/blob/master/lib/minitest/assertions.rb#L542
-      def capture_io
-        _synchronize do
-          begin
-            captured_stdout, captured_stderr = StringIO.new, StringIO.new
-
-            orig_stdout, orig_stderr = $stdout, $stderr
-            $stdout, $stderr         = captured_stdout, captured_stderr
-
-            yield
-
-            return captured_stdout.string, captured_stderr.string
-          ensure
-            $stdout = orig_stdout
-            $stderr = orig_stderr
-          end
-        end
-      end
-
-      def _synchronize
-        yield
+        AskChatGPT::Helpers.extract_source(record)
       end
 
     end

data/lib/ask_chatgpt/prompts/model.rb

@@ -1,12 +1,6 @@
 module AskChatgpt
   module Prompts
     class Model < Base
-      attr_reader :model
-
-      def initialize(model)
-        @model = model
-      end
-
       def content
         [
           summary_info,
@@ -19,19 +13,19 @@ module AskChatgpt
       private
 
       def summary_info
-        "Model: #{model.name}, table name: #{model.table_name}"
+        "Active Record Model: #{record.name}, table name: #{record.table_name}"
       end
 
       def schema_info
-        "Schema: #{model.table_name}\n" +
-        model.columns.map do |column|
+        "Schema: #{record.table_name}\n" +
+        record.columns.map do |column|
           "#{column.name}: #{column.type}"
         end.join("\n")
       end
 
       def associations_info
-        "#{model.name} Associations and Relations: \n" +
-        model.reflections.map do |name, reflection|
+        "#{record.name} Associations and Relations: \n" +
+        record.reflections.map do |name, reflection|
           [
             "#{reflection.macro} :#{name}",
             reflection.options.inject("") { |h, (k, v)| h += "#{k}: #{v}" }

data/lib/ask_chatgpt/prompts/question.rb

@@ -1,6 +1,9 @@
 module AskChatgpt
   module Prompts
     class Question < Base
+      def initialize(record)
+        @record = record.is_a?(String) ? record : record.to_json
+      end
     end
   end
 end

data/lib/ask_chatgpt/railtie.rb

@@ -1,7 +1,7 @@
 module AskChatgpt
   class Railtie < ::Rails::Railtie
     console do
-      TOPLEVEL_BINDING.eval('self').extend AskChatGPT::ConsoleMethods
+      TOPLEVEL_BINDING.eval('self').extend AskChatGPT::Console
     end
   end
 end

data/lib/ask_chatgpt/version.rb

@@ -1,3 +1,3 @@
 module AskChatgpt
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/ask_chatgpt.rb

@@ -6,10 +6,14 @@ require "openai"
 require "tty-markdown"
 require "tty-spinner"
 
+require_relative "ask_chatgpt/console"
 require_relative "ask_chatgpt/executor"
+require_relative "ask_chatgpt/helpers"
 require_relative "ask_chatgpt/core"
 
 module AskChatgpt
+  ::AskChatGPT = AskChatgpt
+
   mattr_accessor :debug
   @@debug = false
 
@@ -21,28 +25,32 @@ module AskChatgpt
   mattr_accessor :temperature
   @@temperature = 0.1
 
+  # default max tokens will be defined by the model
+  mattr_accessor :max_tokens
+  @@max_tokens = nil
+
   # use your own API key (local per set in initializer or ENV)
   mattr_accessor :access_token
   @@access_token = ENV["OPENAI_API_KEY"]
 
+  # 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]
+
   def self.setup
     yield(self)
   end
 
-  module ConsoleMethods
-    def gpt
-      AskChatGPT::Core.call
-    end
-
-    alias :chatgpt :gpt
-    alias :chat_gpt :gpt
-
-    def run(*args)
-      gpt(*args)
+  def self.register_prompt(name, &block)
+    # i want to create a module and include it into a class, with method name and code from block
+    AskChatGPT::Executor.class_eval do
+      define_method(name) do |*args|
+        @scope << AskChatGPT::Prompts::Custom.new(*args, block)
+        self
+      end
     end
   end
 
-  extend ConsoleMethods
+  extend AskChatGPT::Console
 end
-
-AskChatGPT = AskChatgpt

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

@@ -1,6 +1,23 @@
 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.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 = []
+
+  # Examples of custom prompts:
+  # you can use them `gpt.ask(:extract_email, "some string")`
+
+  # config.register_prompt :extract_email do |arg|
+  #   "Extract email from: #{arg} as JSON"
+  # end
+
+  # config.register_prompt :extract_constants do |arg|
+  #   "Extract constants from class: #{AskChatGPT::Helpers.extract_source(arg)}"
+  # end
+
+  # config.register_prompt :i18n do |code|
+  #   "Use I18n in this code:\n#{AskChatGPT::Helpers.extract_source(code)}"
+  # end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ask_chatgpt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Igor Kasyanchuk
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-22 00:00:00.000000000 Z
+date: 2023-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -107,11 +107,15 @@ files:
 - README.md
 - Rakefile
 - lib/ask_chatgpt.rb
+- lib/ask_chatgpt/console.rb
 - lib/ask_chatgpt/core.rb
 - lib/ask_chatgpt/executor.rb
+- lib/ask_chatgpt/helpers.rb
 - lib/ask_chatgpt/prompts/app.rb
 - lib/ask_chatgpt/prompts/base.rb
 - lib/ask_chatgpt/prompts/code_review.rb
+- lib/ask_chatgpt/prompts/custom.rb
+- lib/ask_chatgpt/prompts/explain.rb
 - lib/ask_chatgpt/prompts/find_bug.rb
 - lib/ask_chatgpt/prompts/improve.rb
 - lib/ask_chatgpt/prompts/model.rb