ask_chatgpt 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8d16800c079df0252e84b7448b7633ed07b4bdf1580a06bb76ba4e27292764e
-  data.tar.gz: 9233fd8f8bbbcfd3cea1db3745be6633b710585d77eaf056ee6681c5b202d65c
+  metadata.gz: cc8c5b18804764ced049d50e8a55668634e0c8945a3d8b752b4632e79e3b42b2
+  data.tar.gz: 76af549756fbddcc287ab8fda259731d306ab871483ad37a3e9b1a1954da6338
 SHA512:
-  metadata.gz: 9586b20bda0e6c3a485e1ac6e1eebf91a37ac8728a1e949c917a9ab972cdc1ee8a0b16aa8f76a700e5540ac15aa8f453d06315fdb1d418ba3de6b010504d9b07
-  data.tar.gz: 5516576d94f71d473545b77083990d005157138c97aba1e5992faf8215592b7c2025932b1d9ea74bfcea86b016370e8e00bd1502fb34934968f04f2395a97a84
+  metadata.gz: aa76ea7a0467618c1d9b4ba756593c71ba9823c76ea442cf19ceee8669af9da0abf7849f771a21254daaa853b194cb310fe5bdc864ab1fc59f68ec6da6dfef3e
+  data.tar.gz: 33aac07b57f6d0bccca715de24686a06090ac0e805b79ed4bf5e5a56f65bf54c63126d1b5c7d4f7a37b50065208da04cc2b194f8e791e74c6540ccdac4fcdc27

data/README.md

@@ -20,7 +20,7 @@ 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, Project).ask "make it better" # with_class alias for with_code
+  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")
@@ -262,6 +262,7 @@ 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"
@@ -269,6 +270,17 @@ How to use:
   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).
@@ -278,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.

data/bin/ask_chatgpt

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'optparse'
-require 'active_support'
 require 'irb'
 
 require_relative "../lib/ask_chatgpt"
@@ -21,6 +20,7 @@ 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"
@@ -49,6 +49,10 @@ parser = OptionParser.new do |opts|
     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
@@ -86,6 +90,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, :with_code, :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
@@ -23,6 +24,8 @@ module AskChatgpt
     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/version.rb

@@ -1,3 +1,3 @@
 module AskChatgpt
-  VERSION = "0.5.0"
+  VERSION = "0.6.1"
 end

data/lib/ask_chatgpt.rb

@@ -11,6 +11,8 @@ require "tty-spinner"
 require "tty-cursor"
 require "irb"
 
+require "active_support/all"
+
 require_relative "ask_chatgpt/console"
 require_relative "ask_chatgpt/executor"
 require_relative "ask_chatgpt/helpers"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ask_chatgpt
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Igor Kasyanchuk
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-13 00:00:00.000000000 Z
+date: 2023-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -164,6 +164,7 @@ 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
@@ -196,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.