ask_chatgpt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 66ad01c3932f32f34589d4d2eaf742c28dcd607543d98ec886e3fe56da3c655b
+  data.tar.gz: 1a7609890b8fc4ea6249ea2b563ab29ebfca0528f4255ffc4e00a3f1db0b806f
+SHA512:
+  metadata.gz: e07712c65e13c713271127dcf539a3007763c03fe5e8afa7523820b31a003e442414d22f4fc218fa82f2f9294c3dd2679ab7ef9fcc4070635e58c05e50db62f8
+  data.tar.gz: a3564f0aecca1cea800486aa93758f46747d10cc5a185b66be43036dbc05797d92bc7f71566db652b191b1d9375790be5f3239f99f73c5f573105edcbeac23ca

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Igor Kasyanchuk
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+# AskChatGPT
+
+[![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)
+
+AI-Powered Assistant Gem right in your Rails console.
+
+![AskChatGPT](docs/gpt.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.
+
+We are welcoming you to propose new prompts or adjust existing ones!
+
+## Usage
+
+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.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')
+```
+
+## Examples
+
+Ask for code ideas:
+![AskChatGPT](docs/gpt1.png)
+
+Do you need help to write rspec test?
+![AskChatGPT](docs/gpt2.png)
+
+What about unit tests?
+![AskChatGPT](docs/gpt3.png)
+
+Ask ChatGPT to improve your code:
+![AskChatGPT](docs/gpt4.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "ask_chatgpt"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install ask_chatgpt
+```
+
+## Options
+
+Run `rails g ask_chatgpt initializer`.
+
+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
+  end
+```
+
+## TODO
+
+- cli app?
+- more prompts (cover controllers, sql, etc?)
+- tests
+- can it be used with pry/byebug/etc?
+- print tokens usage?
+- support org_id?
+
+## Contributing
+
+You are welcome to contribute.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/ask_chatgpt/core.rb

@@ -0,0 +1,8 @@
+module AskChatgpt
+  class Core
+    def self.call
+      client = OpenAI::Client.new(access_token: AskChatGPT.access_token)
+      AskChatgpt::Executor.new(client)
+    end
+  end
+end

data/lib/ask_chatgpt/executor.rb

@@ -0,0 +1,70 @@
+require_relative "prompts/base"
+require_relative "prompts/improve"
+Dir[File.join(__dir__, "prompts", "*.rb")].each do |file|
+  require file
+end
+
+# for inspiration:
+# https://www.greataiprompts.com/chat-gpt/best-coding-prompts-for-chat-gpt/
+
+module AskChatgpt
+  class Executor
+    attr_reader :scope, :client
+
+    def initialize(client)
+      @scope = [AskChatGPT::Prompts::App.new]
+      @client = client
+    end
+
+    def with_model(*models)
+      models.each do |model|
+        @scope << AskChatGPT::Prompts::Model.new(model)
+      end
+      self
+    end
+
+    alias :with_models :with_model
+
+    [:improve, :refactor, :question, :find_bug, :code_review, :rspec_test, :unit_test].each do |method|
+      define_method(method) do |*args|
+        @scope << AskChatGPT::Prompts.const_get(method.to_s.camelize).new(*args)
+        self
+      end
+    end
+
+    alias :ask :question
+    alias :how :question
+    alias :find :question
+    alias :review :code_review
+
+    def inspect
+      puts(call); nil
+    end
+
+    def call
+      pp parameters if AskChatGPT.debug
+
+      return puts("No prompts given") if scope.size == 1 # only App prompt
+
+      spinner = TTY::Spinner.new(format: :classic)
+      spinner.auto_spin
+
+      response = client.chat(parameters: parameters)
+      content = response.dig("choices", 0, "message", "content")
+      spinner.stop
+
+      parsed = TTY::Markdown.parse(content)
+      parsed
+    ensure
+      spinner.stop if spinner.spinning?
+    end
+
+    def parameters
+      {
+        model: AskChatGPT.model,
+        messages: scope.map { |e| { role: "user", content: e.content } },
+        temperature: AskChatGPT.temperature,
+      }
+    end
+  end
+end

data/lib/ask_chatgpt/prompts/app.rb

@@ -0,0 +1,28 @@
+module AskChatgpt
+  module Prompts
+    class App < Base
+      def content
+        [
+          general_info,
+          version_info,
+          database_info
+        ].compact_blank.join(", ")
+      end
+
+      private
+
+      def general_info
+        "I have a Ruby on Rails Application"
+      end
+
+      def database_info
+        db_name = ActiveRecord::Base.connection_db_config.configuration_hash[:database] rescue nil
+        "Database: #{db_name}" if db_name
+      end
+
+      def version_info
+        "Version #{Rails.version}, Ruby Version: #{RUBY_VERSION}"
+      end
+    end
+  end
+end

data/lib/ask_chatgpt/prompts/base.rb

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

data/lib/ask_chatgpt/prompts/code_review.rb

@@ -0,0 +1,9 @@
+module AskChatgpt
+  module Prompts
+    class CodeReview < Improve
+      private def action_info
+        "Analyze the given Ruby code for code smells and suggest improvements:"
+      end
+    end
+  end
+end

data/lib/ask_chatgpt/prompts/find_bug.rb

@@ -0,0 +1,9 @@
+module AskChatgpt
+  module Prompts
+    class FindBug < Improve
+      private def action_info
+        "Locate any logic errors in the following Ruby code snippet:"
+      end
+    end
+  end
+end

data/lib/ask_chatgpt/prompts/improve.rb

@@ -0,0 +1,66 @@
+module AskChatgpt
+  module Prompts
+    class Improve < Base
+      attr_reader :method
+
+      def initialize(method)
+        @method = method
+      end
+
+      def content
+        [
+          action_info,
+          method_info,
+        ].compact_blank.join("\n")
+      end
+
+      private
+
+      def action_info
+        "Analyze the given Ruby on Rails code for code smells and suggest improvements"
+      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
+      end
+
+    end
+  end
+end

data/lib/ask_chatgpt/prompts/model.rb

@@ -0,0 +1,47 @@
+module AskChatgpt
+  module Prompts
+    class Model < Base
+      attr_reader :model
+
+      def initialize(model)
+        @model = model
+      end
+
+      def content
+        [
+          summary_info,
+          schema_info,
+          associations_info,
+          instructions_info
+        ].compact_blank.join("\n\n")
+      end
+
+      private
+
+      def summary_info
+        "Model: #{model.name}, table name: #{model.table_name}"
+      end
+
+      def schema_info
+        "Schema: #{model.table_name}\n" +
+        model.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|
+          [
+            "#{reflection.macro} :#{name}",
+            reflection.options.inject("") { |h, (k, v)| h += "#{k}: #{v}" }
+          ].join(', ')
+        end.join("\n")
+      end
+
+      def instructions_info
+        "Use relations and associations, pay attention to the foreign keys. Read models and their associations."
+      end
+    end
+  end
+end

data/lib/ask_chatgpt/prompts/question.rb

@@ -0,0 +1,6 @@
+module AskChatgpt
+  module Prompts
+    class Question < Base
+    end
+  end
+end

data/lib/ask_chatgpt/prompts/refactor.rb

@@ -0,0 +1,9 @@
+module AskChatgpt
+  module Prompts
+    class Refactor < Improve
+      private def action_info
+        "Suggest refactoring improvements for the following Ruby code:"
+      end
+    end
+  end
+end

data/lib/ask_chatgpt/prompts/rspec_test.rb

@@ -0,0 +1,9 @@
+module AskChatgpt
+  module Prompts
+    class RspecTest < Improve
+      private def action_info
+        "Write a rspec test for the given Ruby on Rails code:"
+      end
+    end
+  end
+end

data/lib/ask_chatgpt/prompts/unit_test.rb

@@ -0,0 +1,9 @@
+module AskChatgpt
+  module Prompts
+    class UnitTest < Improve
+      private def action_info
+        "Write a unit test for the given Ruby on Rails code:"
+      end
+    end
+  end
+end

data/lib/ask_chatgpt/railtie.rb

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

data/lib/ask_chatgpt/version.rb

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

data/lib/ask_chatgpt.rb

@@ -0,0 +1,48 @@
+require "ask_chatgpt/version"
+require "ask_chatgpt/railtie"
+require "net/http"
+require "json"
+require "openai"
+require "tty-markdown"
+require "tty-spinner"
+
+require_relative "ask_chatgpt/executor"
+require_relative "ask_chatgpt/core"
+
+module AskChatgpt
+  mattr_accessor :debug
+  @@debug = false
+
+  # https://platform.openai.com/docs/models
+  mattr_accessor :model
+  @@model = "gpt-3.5-turbo"
+
+  # https://platform.openai.com/docs/api-reference/completions/create#completions/create-temperature
+  mattr_accessor :temperature
+  @@temperature = 0.1
+
+  # use your own API key (local per set in initializer or ENV)
+  mattr_accessor :access_token
+  @@access_token = ENV["OPENAI_API_KEY"]
+
+  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)
+    end
+  end
+
+  extend ConsoleMethods
+end
+
+AskChatGPT = AskChatgpt

data/lib/generators/ask_chatgpt/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generate configuration file.
+
+Example:
+    rails generate ask_chatgpt initializer
+
+    This will create:
+        config/ask_chatgpt.rb

data/lib/generators/ask_chatgpt/ask_chatgpt_generator.rb

@@ -0,0 +1,7 @@
+class AskChatgptGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_initializer
+    template 'template.rb', 'config/initializers/ask_chatgpt.rb'
+  end
+end

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

@@ -0,0 +1,6 @@
+AskChatGPT.setup do |config|
+  # config.access_token = ENV["OPENAI_API_KEY"]
+  # config.debug = false
+  # config.model = "gpt-3.5-turbo"
+  # config.temperature = 0.1
+end

data/lib/tasks/ask_chatgpt_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ask_chatgpt do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: ask_chatgpt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Kasyanchuk
+- Liubomyr Manastyretskyi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: ruby-openai
+  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: tty-markdown
+  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: tty-spinner
+  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: wrapped_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: AI-Powered Assistant Gem right in your Rails console.
+email:
+- igorkasyanchuk@gmail.com
+- manastyretskyi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/ask_chatgpt.rb
+- lib/ask_chatgpt/core.rb
+- lib/ask_chatgpt/executor.rb
+- lib/ask_chatgpt/prompts/app.rb
+- lib/ask_chatgpt/prompts/base.rb
+- lib/ask_chatgpt/prompts/code_review.rb
+- lib/ask_chatgpt/prompts/find_bug.rb
+- lib/ask_chatgpt/prompts/improve.rb
+- lib/ask_chatgpt/prompts/model.rb
+- lib/ask_chatgpt/prompts/question.rb
+- lib/ask_chatgpt/prompts/refactor.rb
+- lib/ask_chatgpt/prompts/rspec_test.rb
+- lib/ask_chatgpt/prompts/unit_test.rb
+- lib/ask_chatgpt/railtie.rb
+- lib/ask_chatgpt/version.rb
+- lib/generators/ask_chatgpt/USAGE
+- lib/generators/ask_chatgpt/ask_chatgpt_generator.rb
+- lib/generators/ask_chatgpt/templates/template.rb
+- lib/tasks/ask_chatgpt_tasks.rake
+homepage: https://github.com/railsjazz.com/ask_chatgpt
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/railsjazz.com/ask_chatgpt
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: AI-Powered Assistant Gem right in your Rails console.
+test_files: []