ghostest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a4a9310232014fdaa2d5e34849f9c13ded1299abd8a387aa328b8a2b61bc038
+  data.tar.gz: 0dff83e6d82516c850c0cc4fae7ca9d80e9646e359bce5a2d0cd5f56f33584c1
+SHA512:
+  metadata.gz: 03cc41ffe2425f76e538ad3453576dc3c76a129810e7ad736e9df3402cd4ecc8ef200b2fd9a2e85dde169e5bd36170829e11f075eee9aa1029d08939460f4bec
+  data.tar.gz: 610c551d9d65f45aa0facb75949aa930ef401c85e2aaebbbb4a3b4b21361a0c677ea156b3dc1513887cc8e4f40dd6ff325ecdd48d537ca66ec385d4945626f9b

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="rbenv: 3.1.0" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/ghostest.iml" filepath="$PROJECT_DIR$/.idea/ghostest.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/.rubocop.yml

@@ -0,0 +1,236 @@
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2.1
+  DisabledByDefault: true
+  DisplayCopNames: true
+
+########################
+# Indentation
+########################
+
+# [MUST] Use two spaces for 1-level of indent. Do not use the horizontal tab character.
+Layout/IndentationStyle:
+  EnforcedStyle: spaces
+Layout/IndentationWidth:
+  Enabled: true
+Layout/IndentationConsistency:
+  Enabled: true
+Layout/InitialIndentation:
+  Enabled: true
+Layout/CommentIndentation:
+  Enabled: true
+
+########################
+# Whitespace
+########################
+
+# [MUST] Do not put whitespace at the end of a line.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+########################
+# Empty lines
+########################
+
+# [MUST] Leave exactly one newline at the end of a file.
+Layout/TrailingEmptyLines:
+  EnforcedStyle: final_newline
+
+########################
+# Numbers
+########################
+
+# [SHOULD] Use underscores to separate every three-digits when writing long numbers.
+Style/NumericLiterals:
+  MinDigits: 7
+  Strict: true
+
+########################
+# Strings
+########################
+
+# [SHOULD] Use `''` to write empty strings.
+Style/EmptyLiteral:
+  Enabled: true
+
+# [SHOULD] Use parentheses to write strings by `%` notation.  You can use any kind of parentheses.  In the following cases you can use non-parentheses characters for punctuations.
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+# [MUST] Do not write only `Object#to_s` in string interpolation, such as `"#{obj.to_s}"`.
+Style/RedundantInterpolation:
+  Enabled: true
+
+########################
+# Arrays
+########################
+
+# [MUST] If you write an array literal just after an assignment operator such as `=`, obey the following form denoted as "good".
+Layout/MultilineArrayBraceLayout:
+  EnforcedStyle: symmetrical
+
+# [SHOULD] In the multi-line array literal, put `,` after the last item.
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+# [SHOULD] Use general delimited input (percent) syntax `%w(...)` or `%W(...)` for word arrays.
+Style/WordArray:
+  EnforcedStyle: percent
+
+########################
+# Hashes
+########################
+
+# [MUST] Put whitespaces between `{` and the first key, and between the last value and `}` when writing hash literals on a single line.
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+
+# [MUST] Use new hash syntax in Ruby 1.9+ (`{ foo: 42 }`) if all keys can be written in that syntax:
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+
+# [MUST] If you write a hash literal just after an assignment operator, such as `=`, obey the following form denoted as "good".
+# [SHOULD] In the multi line hash literal, put `,` after the last item.
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+# [SHOULD] (Ruby 1.9+) If all the keys of hash literals are Symbol literals, use the form of `{ key: value }`.  Put whitespace after `:`.
+Layout/SpaceAfterColon:
+  Enabled: true
+
+########################
+# Operations
+########################
+
+# [SHOULD] Put whitespace around operators, except for `**`.
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+# [MUST] Do not use `and`, `or`, and `not`.
+Style/AndOr:
+  Enabled: true
+
+# [MUST] Do not nest conditional operators.
+Style/NestedTernaryOperator:
+  Enabled: true
+
+# [MUST] Do not write conditional operators over multiple lines.
+Style/MultilineTernaryOperator:
+  Enabled: true
+
+########################
+# Assignments
+########################
+
+# [MUST] Parallel assignments can only be used for assigning literal values or results of methods without arguments, and for exchanging two variables or attributes.
+Style/ParallelAssignment:
+  Enabled: true
+
+########################
+# Control structures
+########################
+
+# [SHOULD] Use `unless condition`, instead of `if !condition`.
+Style/NegatedIf:
+  Enabled: true
+
+# [SHOULD] Use `until condition`, instead of `while !condition`.
+Style/NegatedWhile:
+  Enabled: true
+
+# [SHOULD] Do not use `else` for `unless`.
+Style/UnlessElse:
+  Enabled: true
+
+# [MUST] Do not use `then` and `:` for the condition clause of `if`, `unless`, and `case`.
+Style/WhenThen:
+  Enabled: true
+
+# [MUST] Do not use `do` and `:` for the condition clause of `while` and `until`.
+Style/WhileUntilDo:
+  Enabled: true
+
+# [SHOULD] Do not write a logical expressions combined by `||` in the condition clause of `unless` and `until`.
+# [SHOULD] Use modifier forms, if conditions and bodies are short.
+Style/WhileUntilModifier:
+  Enabled: true
+
+########################
+# Method calls
+########################
+
+# [MUST] Use brace block for a method call written in one line.
+Style/BlockDelimiters:
+  EnforcedStyle: line_count_based
+
+# [MUST] Put a whitespace before `{` of brace blocks.
+Layout/SpaceBeforeBlockBraces:
+  EnforcedStyle: space
+
+# [MUST] For a brace block written in one line, put whitespace between `{`, `}` and the inner contents.
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+
+########################
+# BEGIN AND END
+########################
+
+# [MUST] Do not use `BEGIN` and `END` blocks.
+Style/BeginBlock:
+  Enabled: true
+Style/EndBlock:
+  Enabled: true
+
+########################
+# Module and Class definitions
+########################
+
+# [MUST] Use `alias_method` instead of `alias` to define aliases of methods.
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+# [MUST] use `attr_accessor`, `attr_reader`, and `attr_writer` to define accessors instead of `attr`.
+Style/Attr:
+  Enabled: true
+
+# [MUST] In definitions of class methods, use `self.` prefix of method name to reduce the indentation level. However, it is fine to use `class << self` when you want to define both public and private class methods.
+Style/ClassMethods:
+  Enabled: true
+
+# [MUST] If you use `private`, `protected`, and `public` without any arguments, align the lines of these method calls to their associated method definition. Put empty lines around the visibility-change methods.
+Style/TrailingBodyOnMethodDefinition:
+  Enabled: true
+
+########################
+# Method definitions
+########################
+
+# [MUST] On method definition, do not omit parentheses of parameter list, except for methods without parameters.
+Style/MethodDefParentheses:
+  Enabled: true
+
+# [MUST] Do not put whitespace between method name and the parameter list.
+Layout/SpaceAfterMethodName:
+  Enabled: true
+
+########################
+# Variables
+########################
+
+# [MUST] Do not introduce new global variables (`$foo`) for any reason.
+Style/GlobalVars:
+  Enabled: true
+
+# [MUST] Do not use class variables (`@@foo`) for any reasons.  Use `class_attribute` instead.
+Style/ClassVars:
+  Enabled: true
+
+Lint/Debugger:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Layout/CaseIndentation:
+  EnforcedStyle: end

data/.ruby-version

@@ -0,0 +1 @@
+3.2.1

data/README.md

@@ -0,0 +1,31 @@
+# Ghostest
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ghostest`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ghostest.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/exe/ghostest

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "i18n"
+config = File.expand_path('../config', __dir__)
+I18n.load_path += Dir["#{config}/locales/**/*.yml"]
+
+require 'ghostest'
+require 'optparse'
+require 'fileutils'
+
+$stdout.sync = true
+$stderr.sync = true
+
+config_path = nil
+
+options = {
+  llm: :open_ai,
+  debug: false,
+}
+
+ARGV.options do |opt|
+  opt.on('-c', '--config') { |v| config_path = v }
+  opt.on('-a', '--use-azure') { options[:llm] = :azure_open_ai }
+  opt.on('', '--debug') { options[:debug] = true }
+
+  opt.on('-v', '--version') do
+    puts Ghostest::VERSION
+    exit
+  end
+
+  opt.on('-h', '--help') do
+    puts opt.help
+    exit 0
+  end
+
+  opt.parse!
+
+rescue StandardError => e
+  warn("[#{e.class.name}] #{e.message}")
+  puts "\t" + e.backtrace.join("\n\t") unless e.is_a?(OptionParser::ParseError)
+  exit 1
+end
+
+begin
+  required_envs = case options[:llm]
+                  when :azure_open_ai
+                    %w[AZURE_API_VERSION AZURE_OPENAI_API_KEY AZURE_API_BASE AZURE_DEPLOYMENT_NAME]
+                  when :open_ai
+                    %w[OPENAI_API_VERSION OPENAI_API_KEY]
+                  end
+  required_envs.each do |required_env|
+    if ENV[required_env].nil? || ENV[required_env].empty?
+      warn("[ERROR] #{required_env} is required as a environment variable")
+      exit 1
+    end
+  end
+  logger = Ghostest::Logger.instance
+  logger.debug = options[:debug]
+  client = Ghostest::Manager.new(Ghostest::Config.load(config_path, options))
+  client.start_work!
+rescue StandardError => e
+  if options[:debug]
+    raise e
+  else
+    warn("[ERROR] #{[e.message, e.backtrace.first].join("\n\t")}")
+    exit 1
+  end
+end
+
+exit 0

data/ghostest.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ghostest/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ghostest"
+  spec.version = Ghostest::VERSION
+  spec.authors = ["ryooo"]
+  spec.email = ["ryooo.321@gmail.com"]
+
+  spec.summary = "Test code generator by llm"
+  spec.description = "Output test code using LLM agents."
+  spec.homepage = "https://github.com/ryooo/ghostest"
+  # spec.required_ruby_version = ">= 3.2.1"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ryooo/ghostest"
+  spec.metadata["changelog_uri"] = "https://github.com/ryooo/ghostest"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ config/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = ['ghostest']
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_dependency 'ruby-openai'
+  spec.add_dependency 'html2markdown'
+  spec.add_dependency 'addressable'
+  spec.add_dependency 'baran'
+  spec.add_dependency 'tiktoken_ruby'
+  spec.add_dependency 'google-apis-customsearch_v1'
+  spec.add_dependency 'colorize'
+  spec.add_dependency 'i18n'
+  spec.add_dependency 'indifference'
+
+end

data/lib/ghostest/attr_reader.rb

@@ -0,0 +1,11 @@
+module AttrReader
+  private
+  def attr_reader(*args)
+    args.each do |name|
+      define_method name do
+        return instance_variable_get "@#{name}"
+      end
+    end
+    nil
+  end
+end

data/lib/ghostest/config/agent.rb

@@ -0,0 +1,30 @@
+require 'ghostest/attr_reader'
+require 'ghostest/config'
+module Ghostest
+  class Config::Agent
+    include AttrReader
+    attr_reader :name, :occupation, :system_prompt, :color, :role
+
+    def initialize(name, hash, global_config)
+      @global_config = global_config
+      @name = name
+      @role = hash[:role] || raise(ConfigError.new("Agent role is required"))
+
+      @system_prompt = hash[:system_prompt] || raise(ConfigError.new("Agent system_prompt is required"))
+      @color = hash[:color] || raise(ConfigError.new("Agent color is required"))
+    end
+
+    def role_klass
+      case @role.to_sym
+      when :test_designer
+        return Llm::Agents::TestDesigner
+      when :test_programmer
+        return Llm::Agents::TestProgrammer
+      when :reviewer
+        return Llm::Agents::Reviewer
+      else
+        raise ConfigError.new("Unknown agent role #{@role}")
+      end
+    end
+  end
+end

data/lib/ghostest/config.rb

@@ -0,0 +1,65 @@
+module Ghostest
+  class Config
+    include AttrReader
+    attr_reader :llm, :debug, :max_token, :watch_files, :agents, :language
+
+    def initialize(hash, options)
+      @llm = options[:llm]
+      @debug = options[:debug]
+
+      @max_token = hash[:max_token] || 32000
+      @language = (hash[:language] || raise(ConfigError.new("Language is required"))).to_sym
+      @watch_files = hash[:watch_files] || raise(ConfigError.new("Watch files are required"))
+      agents = hash[:agents] || []
+      @agents = Hash[agents.map { |k, h| [k, Agent.new(k, h, self)] }].with_indifferent_access
+      raise(ConfigError.new("2 Agents are required")) if @agents.size < 2
+    end
+
+    def llm_klass
+      case @llm&.to_sym
+      when :azure_open_ai
+        return Llm::Clients::AzureOpenAi
+      else
+        raise ConfigError.new("Unknown llm #{@llm}")
+      end
+    end
+
+    def language_klass
+      case self.language
+      when :ruby
+        return Ghostest::Languages::Ruby
+      else
+        raise ConfigError.new("Unknown language #{self.language}")
+      end
+    end
+
+    class << self
+      def load(config_path, options)
+        options = options.with_indifferent_access
+        default_config = parse_config_file(File.expand_path('config/ghostest.yml'))
+        if config_path.nil?
+          Config.new(default_config.with_indifferent_access, options)
+        elsif File.exist?(config_path)
+          Config.new(default_config.merge(parse_config_file(config_path)).with_indifferent_access, options)
+        elsif (expanded = File.expand_path(config_path)) && File.exist?(expanded)
+          Config.new(default_config.merge(parse_config_file(expanded)).with_indifferent_access, options)
+        else
+          raise ConfigError.new("Config file #{config_path} not found")
+        end
+      end
+
+      private
+
+      def parse_config_file(path)
+        yaml = ERB.new(File.read(path)).result
+
+        YAML.safe_load(
+          yaml,
+          permitted_classes: [Symbol],
+          permitted_symbols: [],
+          aliases: true
+        )
+      end
+    end
+  end
+end

data/lib/ghostest/config_error.rb

@@ -0,0 +1,5 @@
+module Ghostest
+  class ConfigError < StandardError
+
+  end
+end

data/lib/ghostest/error.rb

@@ -0,0 +1,5 @@
+module Ghostest
+  class Error < StandardError
+
+  end
+end

data/lib/ghostest/languages/ruby.rb

@@ -0,0 +1,21 @@
+module Ghostest
+  module Languages
+    class Ruby
+      def self.convert_source_path_to_test_path(source_path)
+        # .rbで終わるファイルパスを前提とする
+        "spec/#{source_path}".gsub(/\.rb$/, '_spec.rb')
+      end
+
+      def self.test_condition_yml_path
+        "spec/ghostest_condition.yml"
+      end
+
+      def self.create_functions
+        [
+          Llm::Functions::ExecRspecTest.new,
+          Llm::Functions::GetGemFilesList.new,
+        ]
+      end
+    end
+  end
+end

data/lib/ghostest/logger.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Ghostest
+  class Logger < ::Logger
+    include Singleton
+    def verbose
+      @verbose ||= false
+    end
+
+    def verbose=(value)
+      @verbose = value
+    end
+
+    def initialize
+      super($stdout)
+
+      self.formatter = proc do |_severity, _datetime, _progname, msg|
+        "#{msg}\n"
+      end
+
+      self.level = Logger::INFO
+    end
+
+    def verbose_info(msg)
+      info(msg) if verbose
+    end
+
+    def debug=(value)
+      self.level = value ? Logger::DEBUG : Logger::INFO
+    end
+  end
+end

data/lib/ghostest/manager.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Ghostest
+  class Manager
+    include AttrReader
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+      @should_work_paths = []
+      @test_condition = Ghostest::TestCondition.new(@config.language_klass)
+    end
+
+    # skip test for this method
+    def start_work!
+      logger = Ghostest::Logger.instance
+
+      loop do
+        wait_for_update(@config.watch_files)
+        next if @should_work_paths.empty?
+
+        @should_work_paths.each do |source_path, test_path|
+          agents = @config.agents.map do |name, agent_config|
+            agent_config.role_klass.new(name, @config, logger)
+          end
+
+          assignee = agents.first
+          switch_assignee_function = Llm::Functions::SwitchAssignee.new(assignee, agents)
+          i = 0
+          while i < 10
+            i += 1
+            assignee.work(source_path:, test_path:, switch_assignee_function:)
+            break if assignee.respond_to?('lgtm?') && assignee.lgtm?
+            assignee = switch_assignee_function.assignee
+          end
+          if assignee.respond_to?('lgtm?') && assignee.lgtm?
+            @test_condition.save_as_updated!(source_path)
+          else
+            raise Ghostest::Error, "Workers couldn't finish the work. "
+          end
+        end
+      end
+    end
+
+    # skip test for this method
+    def wait_for_update(watch_files)
+      loop do
+        sleep(3)
+        should_work_paths = []
+        watch_files.each do |watch_file|
+          file_paths = Dir.glob(watch_file)
+
+          file_paths.each do |source_path|
+            if @test_condition.should_update_test?(source_path)
+              test_path = @config.language_klass.convert_source_path_to_test_path(source_path)
+              if File.exist?(test_path)
+                should_work_paths << [source_path, test_path]
+              else
+                should_work_paths << [source_path, nil]
+              end
+            end
+          end
+        end
+
+        unless should_work_paths.empty?
+          @should_work_paths = should_work_paths
+          break
+        end
+      end
+    end
+  end
+end