ask_chatgpt 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a5ccd11d62b51d4422562be281edcf67254e9829f551edf2f91acd970fd091b
-  data.tar.gz: 1328f4ffedb742cce8c330de2fedf7bca4632610a5e95e0215a6dabc6dc3d50d
+  metadata.gz: 1bc7b02b4d83823e029b13324c8b66abd9f4e291303d9a203963b3be1817aee9
+  data.tar.gz: 70c3c8987e5a1e4d2ead1b86f9de132e8834ca1ca256bbcecdd28cb351e34536
 SHA512:
-  metadata.gz: 869bb402cb40bbaa8d0e60a4c0c9e3247a155a18b60d805c3943baa2b0c90d1ccf8471de4359df5ca63a6e5197231cca1cbae5398716e49ed0ecd0c14b2e45fe
-  data.tar.gz: 83c04d9f695e3772ec35351b4de6e019d2f866023421045ec8f6dc2decdaded75f3feb9c70947caf1837b3942333ab69c23b4e02ca7e9efe87c77c7b248fb8af
+  metadata.gz: c73917306f9dfc1acf2f5ba6275ea8c0123253e07ba1f774eacea5e15658d00eb1166555c3c6714e1ad0d3c0860d029f1c8d17612d206e679676d0f64c5be536
+  data.tar.gz: 9b6bfd8026eccb6dac490ddc7ae39366153dcf48c84cd95956fe724241cfe7e89c17a0bdc2f78fc6fb6641b53aebae6de0e89b581aaf3c55103f0a76cdfa2048

data/README.md

@@ -5,6 +5,8 @@
 
 AI-Powered Assistant Gem right in your Rails console.
 
+NEW UPDATE: Voice input using your microphone, demo: https://youtu.be/uBR0wnQvKao
+
 ![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.
@@ -18,6 +20,8 @@ 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.with_code("User.get_report", Project).ask "make it better" # with_class alias for with_code
+  gpt.with_class(User).ask "make it better"
   gpt.payload(json).ask("extract emails from json")
   gpt.refactor("User.get_report")
   gpt.improve("User.get_report")
@@ -258,11 +262,25 @@ How to use:
 
 ```
   ask_chatgpt -q "How to parse JSON file in Ruby?"
+  ask_chatgpt -t 0.7 -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"
+  ask_chatgpt -m 3.5 -q "How to parse JSON file in Ruby?"
+  ask_chatgpt -m 4 -q "Why Ruby is the best language?"
+```
+
+You can also create an alias "a" or "q" for example:
+
+Edit file: `nano ~/.bash_profile`
+
+```bash
+alias a='ask_chatgpt'
+alias q='ask_chatgpt'
 ```
 
+and now you can use `q "how to unzip file with Ruby"`
+
 ## Streaming (async vs sync mode)
 
 Control the mode from a console. Or, from the initializer, using `config.mode = :async` (or sync).
@@ -272,6 +290,23 @@ Control the mode from a console. Or, from the initializer, using `config.mode =
   gpt.sync!
 ```
 
+## Random Tips
+
+![AskChatGPT](docs/random_facts.png)
+
+Surprise yourself with random facts and useful tips. To use just call `gpt.random` (or `gpt.tip`, `gpt.random_tip`).
+
+By default it's using Ruby/Rails topics (see `RandomTip` class).
+
+But you can also use other topics, e.g.:
+
+```ruby
+  gpt.tip
+  gpt.tip("active record")
+  gpt.tip("sidekiq")
+  gpt.tip("security")
+```
+
 ## Markdown
 
 Try to format response from Markdown and print it nicely in the console.
@@ -300,6 +335,7 @@ end
 - refactor voice input code :) as first version it's fine
 - can we discover audio device ID?
 - use tempfile for audio, instead of output.wav
+- handle case when empty response is returned in CLI (when for example non-existing model is specified)
 
 ## Contributing
 

data/bin/ask_chatgpt

@@ -21,11 +21,15 @@ parser = OptionParser.new do |opts|
 
     Examples:
       ask_chatgpt -q "How to parse JSON file in Ruby?"
+      ask_chatgpt -t 0.5 -q "How to parse JSON file in Ruby?"
+      ask_chatgpt -m gpt-4 -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"
       ask_chatgpt -s 1"
 
+    To specify model you can use shorter version: -m 4, -m 4.0, -m 3.5.
+
     Version: #{AskChatGPT::VERSION}
 
   USAGE
@@ -42,6 +46,14 @@ parser = OptionParser.new do |opts|
     options[:file_path] = file
   end
 
+  opts.on("-m", "--model MODEL", String, "Specify the ChatGPT model. Uses \"gpt-3.5-turbo\" by default") do |model|
+    options[:model] = model
+  end
+
+  opts.on("-t", "--temperature 0.7", String, "Specify a temperature. Uses \"#{AskChatGPT.temperature}\" by default") do |temperature|
+    options[:temperature] = temperature
+  end
+
   opts.on("-d", "--debug", "Output request/response") do |debug|
     options[:debug] = true
   end
@@ -56,6 +68,20 @@ parser.parse!
 
 AskChatGPT.debug = !!options[:debug]
 
+if options[:model].present?
+  model = options[:model].to_s
+  disctionary = {
+    "4" => "gpt-4",
+    "4.0" => "gpt-4",
+    "40" => "gpt-4",
+    "3.5t" => "gpt-3.5-turbo",
+    "3.5" => "gpt-3.5-turbo",
+    "35" => "gpt-3.5-turbo",
+  }
+  model = disctionary[model.downcase] || model
+  AskChatGPT.model = model
+end
+
 options[:prompt] = ARGV.join(" ") if options[:prompt].blank?
 
 if options[:prompt].blank? &&  options[:audio_device_id].blank?
@@ -65,6 +91,10 @@ end
 
 include AskChatGPT::Console
 
+if options[:temperature].present?
+  AskChatGPT.temperature = options[:temperature].to_f
+end
+
 if options[:audio_device_id].present?
   AskChatGPT.voice_enabled = true
   AskChatGPT.voice_max_duration = 20

data/lib/ask_chatgpt/default_behavior.rb

@@ -1,6 +1,7 @@
 module AskChatgpt
   module DefaultBehavior
-    DEFAULT_PROMPTS = [:improve, :refactor, :question, :find_bug, :code_review, :rspec_test, :unit_test, :explain]
+    DEFAULT_PROMPTS = [:improve, :refactor, :question, :random_tip,
+      :with_code, :find_bug, :code_review, :rspec_test, :unit_test, :explain]
 
     def with_model(*models)
       self.tap do
@@ -22,6 +23,9 @@ module AskChatgpt
     alias :how :question
     alias :find :question
     alias :review :code_review
+    alias :with_class :with_code
+    alias :random :random_tip
+    alias :tip :random_tip
 
     def add_prompt(prompt)
       scope << prompt

data/lib/ask_chatgpt/executor.rb

@@ -127,11 +127,25 @@ module AskChatgpt
 
     def executor_parameters
       @executor_parameters ||= {
-        model: AskChatGPT.model,
-        temperature: AskChatGPT.temperature,
-        max_tokens: AskChatGPT.max_tokens,
+        model: model,
+        temperature: temperature,
+        max_tokens: max_tokens,
         messages: scope.map { |e| { role: "user", content: e.content } }.reject { |e| e[:content].blank? },
       }.reject { |_, v| v.blank? }
     end
+
+    def temperature
+      # see RandomFact class for example
+      new_temperature = scope.map { |e| e.class.const_get("TEMPERATURE") rescue nil }.compact.first
+      new_temperature.presence || AskChatGPT.temperature
+    end
+
+    def model
+      AskChatGPT.model
+    end
+
+    def max_tokens
+      AskChatGPT.max_tokens
+    end
   end
 end

data/lib/ask_chatgpt/prompts/random_tip.rb

@@ -0,0 +1,54 @@
+module AskChatgpt
+  module Prompts
+    class RandomTip < Question
+      TEMPERATURE = 0.8
+      TOPIC = <<~TOPIC
+      - Ruby
+      - Ruby on Rails
+      - Active Record
+      - Active Record Migrations
+      - Active Record Validations
+      - Active Record Callbacks
+      - Active Record Associations
+      - Active Record Query Interface
+      - Active Support Core Extensions
+      - Action Mailer
+      - Active Job
+      - Active Storage
+      - Action Cable
+      - Layouts and Rendering in Rails
+      - Action View Form Helpers
+      - Action Controller Overview
+      - Rails Routing from the Outside In
+      - Rails Internationalization (I18n)
+      - Testing Rails Applications
+      - Securing Rails Applications
+      - Debugging Rails Applications
+      - Configuring Rails Applications
+      - The Rails Command Line
+      - The Asset Pipeline
+      - Autoloading and Reloading Constants
+      - Classic to Zeitwerk
+      - Caching with Rails: An Overview
+      - Using Rails for API-only Applications
+      - Multiple Databases with Active Record
+      - Ruby-related gems
+      - Ruby, Rails open-source projects
+    TOPIC
+
+      def initialize(topic = TOPIC)
+        prompt_text = <<~PROMPT
+          Tell me interesting or useful tips,facts,method,code,etc for any of:
+          #{topic}
+
+          Answer with direct answer and no other text.
+          Try to be shoft by informative and clear.
+          Code examples reply in markdown format.
+
+          Level of difficulty: ADVANCED
+        PROMPT
+        super(prompt_text)
+      end
+    end
+  end
+end

data/lib/ask_chatgpt/prompts/with_code.rb

@@ -0,0 +1,25 @@
+module AskChatgpt
+  module Prompts
+    class WithCode < Base
+
+      attr_reader :args
+
+      def initialize(*args)
+        @args = args
+      end
+
+      def content
+        code_info.reject { |v| v.blank? }.join("\n")
+      end
+
+      private
+
+      def code_info
+        args.compact.map do |arg|
+          AskChatGPT::Helpers.extract_source(arg)
+        end
+      end
+
+    end
+  end
+end

data/lib/ask_chatgpt/version.rb

@@ -1,3 +1,3 @@
 module AskChatgpt
-  VERSION = "0.4.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ask_chatgpt
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Igor Kasyanchuk
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -164,9 +164,11 @@ files:
 - lib/ask_chatgpt/prompts/improve.rb
 - lib/ask_chatgpt/prompts/model.rb
 - lib/ask_chatgpt/prompts/question.rb
+- lib/ask_chatgpt/prompts/random_tip.rb
 - lib/ask_chatgpt/prompts/refactor.rb
 - lib/ask_chatgpt/prompts/rspec_test.rb
 - lib/ask_chatgpt/prompts/unit_test.rb
+- lib/ask_chatgpt/prompts/with_code.rb
 - lib/ask_chatgpt/railtie.rb
 - lib/ask_chatgpt/sugar.rb
 - lib/ask_chatgpt/version.rb
@@ -195,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: AI-Powered Assistant Gem right in your Rails console.