pull_request_ai 0.1.0

data/lib/pull_request_ai/openAi/client.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module PullRequestAi
+  module OpenAi
+    # A client to communicate with the OpenAI API.
+    class Client
+      attr_accessor :openai_api_key
+      attr_accessor :openai_api_endpoint
+      attr_accessor :api_version
+      attr_accessor :model
+      attr_accessor :temperature
+      attr_reader   :http_timeout
+
+      ##
+      # Initializes the client.
+      def initialize(
+        openai_api_key: nil,
+        openai_api_endpoint: nil,
+        api_version: nil,
+        model: nil,
+        temperature: nil
+      )
+        @openai_api_key = openai_api_key || PullRequestAi.openai_api_key
+        @openai_api_endpoint = openai_api_endpoint || PullRequestAi.openai_api_endpoint
+        @api_version = api_version || PullRequestAi.api_version
+        @model = model || PullRequestAi.model
+        @temperature = temperature || PullRequestAi.temperature
+        @http_timeout = PullRequestAi.http_timeout
+      end
+
+      ##
+      # Makes the completions request from the OpenAI API.
+      # Given a prompt, the model will return one or more predicted completions.
+      # https://platform.openai.com/docs/api-reference/chat
+      def predicted_completions(content)
+        url = build_url
+        request(:post, url, body(content))
+      end
+
+      private
+
+      def request(type, url, body)
+        response = HTTParty.send(
+          type, url, headers: headers, body: body, timeout: http_timeout
+        )
+        body = response.parsed_response
+
+        if response.success?
+          if body['choices'].nil? || body['choices'].empty?
+            Dry::Monads::Success('')
+          else
+            Dry::Monads::Success(body['choices'].first.dig('message', 'content'))
+          end
+        else
+          Error.failure(:failed_on_openai_api_endpoint, body.dig('error', 'message'))
+        end
+      rescue Net::ReadTimeout
+        Error.failure(:connection_timeout)
+      end
+
+      def build_url
+        "#{openai_api_endpoint}/#{api_version}/chat/completions"
+      end
+
+      def headers
+        {
+          'Content-Type' => 'application/json',
+          'Authorization' => "Bearer #{openai_api_key}"
+        }
+      end
+
+      def body(content)
+        {
+          model: model,
+          messages: [{ role: :user, content: content }],
+          temperature: temperature
+        }.to_json
+      end
+    end
+  end
+end

data/lib/pull_request_ai/openAi/interpreter.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PullRequestAi
+  module OpenAi
+    class Interpreter
+      def chat_message(feature_type, summary, current_changes)
+        result = ''.dup
+        unless summary.nil? || summary.strip.empty?
+          result << "Given the following summary for the changes made:\n"
+          result << "\"#{summary}\""
+          result << "\n\n"
+        end
+        result << "Write a #{feature_type} pull request description based on the following changes:\n"
+        result << current_changes
+        result.freeze
+      end
+    end
+  end
+end

data/lib/pull_request_ai/repo/client.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module PullRequestAi
+  module Repo
+    class Client
+      attr_reader   :http_timeout
+      attr_accessor :api_endpoint
+
+      ##
+      # Initializes the client.
+      def initialize(http_timeout, api_endpoint)
+        @http_timeout = http_timeout
+        @api_endpoint = api_endpoint
+      end
+
+      def opened_pull_requests(slug, head, base)
+        Error.failure(:project_not_configured)
+      end
+
+      def update_pull_request(slug, number, base, title, description)
+        Error.failure(:project_not_configured)
+      end
+
+      def open_pull_request(slug, head, base, title, description)
+        Error.failure(:project_not_configured)
+      end
+
+      class << self
+        def client_from_host(host)
+          result = host.success? ? host.success : ''
+          case result
+          when 'github.com'
+            PullRequestAi::GitHub::Client.new
+          when 'bitbucket.org'
+            PullRequestAi::Bitbucket::Client.new
+          else
+            PullRequestAi::Repo::Client.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pull_request_ai/repo/file.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PullRequestAi
+  module Repo
+    class File
+      attr_reader :name, :modified_lines
+
+      def initialize(name, modified_lines)
+        @name = name
+        @modified_lines = modified_lines
+      end
+
+      def trimmed_modified_lines
+        modified_lines.inject(name + "\n") do |result, line|
+          result << line.sub(/([+\-])\s*/) { ::Regexp.last_match(1) } + "\n"
+        end
+      end
+    end
+  end
+end

data/lib/pull_request_ai/repo/prompt.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module PullRequestAi
+  module Repo
+    class Prompt
+      def configured?
+        %x(git rev-parse --is-inside-work-tree > /dev/null 2>&1)
+        $CHILD_STATUS.exitstatus == 0
+      end
+
+      def current_branch
+        name = %x(git rev-parse --abbrev-ref HEAD).chomp
+        name == 'HEAD' ? %x(git rev-parse --short HEAD).chomp : name
+      end
+
+      def remote_name
+        %x(git remote).strip
+      end
+
+      def remote_url(name)
+        %x(git config --get remote.#{name}.url).strip
+      end
+
+      def remote_branches
+        %x(git branch --remotes --no-color).split("\n")
+      end
+
+      def changes_between(branch1, branch2)
+        %x(git diff --patch #{branch1}..#{branch2}).strip
+      end
+    end
+  end
+end

data/lib/pull_request_ai/repo/reader.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module PullRequestAi
+  module Repo
+    class Reader
+      include Dry::Monads[:result]
+
+      attr_accessor :prompt
+
+      def initialize(prompt: Prompt.new)
+        @prompt = prompt
+      end
+
+      def current_branch
+        prompt.configured? ? Success(prompt.current_branch) : Error.failure(:project_not_configured)
+      end
+
+      def remote_name
+        prompt.configured? ? Success(prompt.remote_name) : Error.failure(:project_not_configured)
+      end
+
+      def repository_slug
+        remote_uri.bind do |uri|
+          regex = %r{\A/?(?<slug>.*?)(?:\.git)?\Z}
+          match = regex.match(uri.path)
+          match ? Success(match[:slug]) : Error.failure(:invalid_repository_url)
+        end
+      end
+
+      def repository_host
+        remote_uri.bind do |uri|
+          Success(uri.host)
+        end
+      end
+
+      def remote_uri
+        remote_name.bind do |name|
+          url = prompt.remote_url(name)
+          uri = GitCloneUrl.parse(url)
+          Success(uri)
+        end
+      rescue URI::InvalidComponentError
+        Error.failure(:invalid_repository_url)
+      end
+
+      def remote_branches
+        remote_name.bind do |name|
+          branches = prompt.remote_branches
+            .reject { !_1.strip.start_with?(name) }
+            .map { _1.strip.sub(%r{\A#{name}/}, '') }
+            .reject(&:empty?)
+          Success(branches)
+        end
+      end
+
+      def destination_branches
+        current_branch.bind do |current|
+          remote_branches.bind do |branches|
+            if branches.include?(current)
+              Success(branches.reject { _1 == current || _1.start_with?('HEAD') })
+            else
+              Error.failure(:current_branch_not_pushed)
+            end
+          end
+        end
+      end
+
+      def current_changes(to_base)
+        current_branch.bind do |current|
+          changes_between(to_base, current)
+        end
+      end
+
+      def flatten_current_changes(to_base)
+        current_changes(to_base).bind do |changes|
+          Success(changes.inject(''.dup) { |result, file| result << file.trimmed_modified_lines })
+        end
+      end
+
+      private
+
+      def changes_between(branch1, branch2)
+        if prompt.configured? == false
+          Error.failure(:project_not_configured)
+        else
+          diff_output = prompt.changes_between(branch1, branch2)
+          changes = []
+
+          file_name = nil
+          modified_lines = []
+          diff_output.each_line do |line|
+            line = line.chomp
+            if line.start_with?('diff --git')
+              if file_name && file_name.end_with?('.lock') == false
+                changes << PullRequestAi::Repo::File.new(file_name, modified_lines)
+              end
+              file_name = line.split(' ')[-1].strip
+              file_name = file_name.start_with?('b/') ? file_name[2..-1] : file_name
+              modified_lines = []
+            elsif line.start_with?('--- ') || line.start_with?('+++ ')
+              next
+            elsif line.start_with?('-') && line.strip != '-'
+              modified_lines << line
+            elsif line.start_with?('+') && line.strip != '+'
+              modified_lines << line
+            end
+          end
+
+          if file_name
+            changes << PullRequestAi::Repo::File.new(file_name, modified_lines)
+          end
+
+          Success(changes)
+        end
+      end
+    end
+  end
+end

data/lib/pull_request_ai/util/configuration.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module PullRequestAi
+  module Util
+    class Configuration
+      attr_accessor :openai_api_key
+      attr_accessor :github_access_token
+      attr_accessor :bitbucket_app_password
+      attr_accessor :bitbucket_username
+
+      attr_accessor :openai_api_endpoint
+      attr_accessor :github_api_endpoint
+      attr_accessor :bitbucket_api_endpoint
+
+      attr_accessor :model
+      attr_accessor :temperature
+      attr_accessor :http_timeout
+
+      attr_reader :api_version
+      attr_reader :rrtools_grouped_gems
+
+      def initialize
+        @api_version = 'v1'
+
+        @openai_api_key = ENV['OPENAI_API_KEY']
+        @github_access_token = ENV['GITHUB_ACCESS_TOKEN']
+        @bitbucket_app_password = ENV['BITBUCKET_APP_PASSWORD']
+        @bitbucket_username = ENV['BITBUCKET_USERNAME']
+
+        @openai_api_endpoint = 'https://api.openai.com'
+        @github_api_endpoint = 'https://api.github.com'
+        @bitbucket_api_endpoint = 'https://api.bitbucket.org'
+
+        @model = 'gpt-3.5-turbo'
+        @temperature = 0.6
+        @http_timeout = 60
+
+        @rrtools_grouped_gems = Rails.application.routes.routes.select do |prop|
+          prop.defaults[:group] == 'RRTools'
+        end.collect do |route|
+          {
+            name: route.name,
+            path: route.path.build_formatter.instance_variable_get('@parts').join
+          }
+        end || []
+      end
+    end
+  end
+end

data/lib/pull_request_ai/util/error.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module PullRequestAi
+  class Error
+    attr_reader :symbol, :message
+
+    def initialize(symbol, message = nil)
+      @symbol = symbol
+      @message = message
+    end
+
+    def description
+      error_desc = SYMBOL_DETAILS[symbol]
+      if error_desc
+        error_desc + (message ? " #{message}" : '')
+      else
+        message || symbol.to_s
+      end
+    end
+
+    class << self
+      def failure(symbol, message = nil)
+        new_instance = new(symbol, message)
+        Dry::Monads::Failure(new_instance)
+      end
+    end
+  end
+end

data/lib/pull_request_ai/util/symbol_details.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module PullRequestAi
+  SYMBOL_DETAILS = {
+    project_not_configured: 'Your project doesn\'t have a GitHub repository configured.',
+    invalid_repository_url: 'Couldn\'t read the remote URL from the repository.',
+    current_branch_not_pushed: 'The current branch has not yet been pushed into the remote.',
+    connection_timeout: 'Connection timeout.',
+    failed_on_openai_api_endpoint: 'Failed to communicate with openAI API.',
+    failed_on_github_api_endpoint: 'Failed to communicate with GitHub API.',
+    failed_on_bitbucket_api_endpoint: 'Failed to communicate with Bitbucket API.',
+    no_changes_btween_branches: 'No changes between branches. Please check the destination branch.'
+  }
+end

data/lib/pull_request_ai/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PullRequestAi
+  VERSION = '0.1.0'
+end

data/lib/pull_request_ai.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'httparty'
+require 'dry/monads'
+require 'rack/attack'
+require 'git_clone_url'
+
+require 'pull_request_ai/client'
+require 'pull_request_ai/version'
+require 'pull_request_ai/engine'
+
+require 'pull_request_ai/util/configuration'
+require 'pull_request_ai/util/symbol_details'
+require 'pull_request_ai/util/error'
+
+require 'pull_request_ai/openAi/client'
+require 'pull_request_ai/openAi/interpreter'
+
+require 'pull_request_ai/repo/client'
+require 'pull_request_ai/repo/reader'
+require 'pull_request_ai/repo/prompt'
+require 'pull_request_ai/repo/file'
+
+require 'pull_request_ai/bitbucket/client'
+require 'pull_request_ai/github/client'
+
+module PullRequestAi
+  extend SingleForwardable
+  def_delegators :configuration, :github_api_endpoint
+  def_delegators :configuration, :github_access_token, :github_access_token=
+  def_delegators :configuration, :bitbucket_api_endpoint
+  def_delegators :configuration, :bitbucket_app_password, :bitbucket_app_password=
+  def_delegators :configuration, :bitbucket_username, :bitbucket_username=
+  def_delegators :configuration, :openai_api_key, :openai_api_key=
+  def_delegators :configuration, :openai_api_endpoint
+  def_delegators :configuration, :api_version
+  def_delegators :configuration, :model, :model=
+  def_delegators :configuration, :temperature, :temperature=
+  def_delegators :configuration, :http_timeout
+
+  class << self
+    def configure(&block)
+      yield configuration
+    end
+
+    # Returns an existing configuration object or instantiates a new one
+    def configuration
+      @configuration ||= Util::Configuration.new
+    end
+  end
+end

data/lib/tasks/pull_request_ai_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :pull_request_ai do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: pull_request_ai
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Runtime Revolution
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: git_clone_url
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: rack-attack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.6'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description: Rails Engine that provides pull requests descriptions generated by ChatGPT.
+email:
+- info@runtime-revolution.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/pull_request_ai_manifest.js
+- app/assets/javascripts/application.js
+- app/assets/javascripts/notifications.js
+- app/assets/stylesheets/pull_request_ai/application.css
+- app/assets/stylesheets/pull_request_ai/blocs.css
+- app/assets/stylesheets/pull_request_ai/helpers.css
+- app/assets/stylesheets/pull_request_ai/inputs.css
+- app/assets/stylesheets/pull_request_ai/notification.css
+- app/assets/stylesheets/pull_request_ai/spinner.css
+- app/controllers/pull_request_ai/application_controller.rb
+- app/controllers/pull_request_ai/pull_request_ai_controller.rb
+- app/helpers/pull_request_ai/application_helper.rb
+- app/models/pull_request_ai/application_record.rb
+- app/views/layouts/pull_request_ai/application.html.erb
+- app/views/pull_request_ai/pull_request_ai/new.html.erb
+- config/initializers/rack_attack.rb
+- config/routes.rb
+- lib/pull_request_ai.rb
+- lib/pull_request_ai/bitbucket/client.rb
+- lib/pull_request_ai/client.rb
+- lib/pull_request_ai/engine.rb
+- lib/pull_request_ai/github/client.rb
+- lib/pull_request_ai/openAi/client.rb
+- lib/pull_request_ai/openAi/interpreter.rb
+- lib/pull_request_ai/repo/client.rb
+- lib/pull_request_ai/repo/file.rb
+- lib/pull_request_ai/repo/prompt.rb
+- lib/pull_request_ai/repo/reader.rb
+- lib/pull_request_ai/util/configuration.rb
+- lib/pull_request_ai/util/error.rb
+- lib/pull_request_ai/util/symbol_details.rb
+- lib/pull_request_ai/version.rb
+- lib/tasks/pull_request_ai_tasks.rake
+homepage: https://www.runtime-revolution.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://www.runtime-revolution.com
+  source_code_uri: https://github.com/runtimerevolution/pull_request_ai
+  changelog_uri: https://github.com/runtimerevolution/pull_request_ai
+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.4.10
+signing_key:
+specification_version: 4
+summary: Rails Engine that provides pull requests descriptions generated by ChatGPT.
+test_files: []