omochi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a34b2f4942b833cad4251d39b655591949025be459aa5433e352ec5daa467cd
+  data.tar.gz: 381bd6ca1e03d74e26e76773d1a9d61c14c0521f6b026230a4558652e9984d10
+SHA512:
+  metadata.gz: 582c88432f47a69d2822f92f1b8a4ccd4c3c1bae42f072bb2fa85d296d7ec6cc613f8451781f5d59b449b66b43e3a13a08cca2b036a96650666be934e69bd1c0
+  data.tar.gz: 5d1515d85ac400cf4b029bd04e0082b6bb48c8273e47028786e4e7b9f231b3652ecd50d026f2b774acad6991192ebe8344a6333f4e20b3a27fe2b328fb043d49

data/DESIGN.md

@@ -0,0 +1,7 @@
+This library has 5 major steps.
+
+1. Fetch Ruby files from diffs, including spec files
+2. Parse them to AST
+3. Get all methods and spec `describe`s and compare
+4. If every method is covered, successfully return, otherwise print their names
+5. If `--create` option is given, generate skeletons for missing specs

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omochi.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Hashino Mikiko
+
+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,189 @@
+# Omochi
+
+Omochi is a CLI tool to support Ruby on Rails development with RSpec. It detects methods uncovered by tests and prints the test code generated by LLM.
+
+There are two advantages of using Omochi. We can make sure every method is covered by tests with GitHub Actions support. We can also generate spec files for uncovered methods so that we can reduce time to write them manually.
+
+## Installation
+
+```
+$ gem specific_install -l https://github.com/mikik0/omochi.git
+```
+
+## Usage
+
+```
+$ omochi --help
+Commands:
+  omochi help [COMMAND]     # Describe available commands or one specific command
+  omochi verify local_path  # verify spec created for all of new methods and functions
+```
+
+## Commands
+### verify
+
+When you execute Omochi locally, you can confirm that you have spec coverage for uncommitted diff.
+
+```
+# Local
+$ omochi verify local_path
+```
+
+You can skip check with ignore comment.
+
+```ruby
+#omochi:ignore:
+```
+
+### --create option
+
+You can generate spec files with LLM by giving `-c` or `--create` option. It outputs to STDOUT.
+
+```
+# Generate spec files
+$ omochi verify local_path -c
+# Or
+$ omochi verify local_path --create
+```
+
+### --github option
+
+With `-h` option you can check uncovered methods against given Pull Request with GitHub Actions.
+It uses `gh pr diff` command internally.
+
+```
+$ omochi verify local_path -h
+# Or
+$ omochi verify local_path --github
+```
+
+## Samples
+
+```
+$ omochi verify -c
+"Verify File List: [\"lib/omochi/cli.rb\", \"lib/omochi/util.rb\"]"
+"specファイルあり"
+"There are spec files."
+===================================================================
+verifyのテストを以下に表示します。
+We will show the test of verify below.
+require 'rspec'
+
+describe 'exit_on_failure?' do
+  it 'returns true' do
+    expect(exit_on_failure?).to eq(true)
+  end
+end
+======= RESULT: lib/omochi/cli.rb =======
+- exit_on_failure?
+"specファイルなし"
+======= RESULT: lib/omochi/util.rb =======
+- local_diff_path
+- github_diff_path
+- remote_diff_path
+- get_ast
+- dfs
+- find_spec_file
+- get_pure_function_name
+- dfs_describe
+- print_result
+- get_ignore_methods
+- create_spec_by_bedrock
+===================================================================
+lib/omochi/util.rbのテストを以下に表示します。
+We will show the test of lib/omochi/util.rb below.
+require "spec_helper"
+
+describe "local_diff_path" do
+  it "returns array of diff paths from git" do
+    allow(Open3).to receive(:capture3).with("git diff --name-only", any_args).and_return(["path1", "path2"], "", double(success?: true))
+    expect(local_diff_path).to eq(["path1", "path2"])
+  end
+
+  it "returns empty array if git command fails" do
+    allow(Open3).to receive(:capture3).with("git diff --name-only", any_args).and_return("", "error", double(success?: false))
+    expect(local_diff_path).to eq([])
+  end
+end
+
+describe "github_diff_path" do
+  it "returns array of diff paths from gh" do
+    allow(Open3).to receive(:capture3).with("gh pr diff --name-only", any_args).and_return(["path1", "path2"], "", double(success?: true))
+    expect(github_diff_path).to eq(["path1", "path2"])
+  end
+
+  it "returns empty array if gh command fails" do
+    allow(Open3).to receive(:capture3).with("gh pr diff --name-only", any_args).and_return("", "error", double(success?: false))
+    expect(github_diff_path).to eq([])
+  end
+end
+
+describe "remote_diff_path" do
+  it "returns array of diff paths from remote" do
+    allow(Open3).to receive(:capture3).with(/git diff --name-only .*${{ github\.sha }}/, any_args).and_return(["path1", "path2"], "", double(success?: true))
+    expect(remote_diff_path).to eq(["path1", "path2"])
+  end
+
+  it "returns empty array if git command fails" do
+    allow(Open3).to receive(:capture3).with(/git diff --name-only .*${{ github\.sha }}/, any_args).and_return("", "error", double(success?: false))
+    expect(remote_diff_path).to eq([])
+  end
+end
+
+describe "get_ast" do
+  it "returns AST for given file" do
+    allow(File).to receive(:read).with("file.rb").and_return("code")
+    allow(Parser::CurrentRuby).to receive(:parse_with_comments).with("code").and_return(["ast"], ["comments"])
+    expect(get_ast("file.rb")).to eq([{ast: "ast", filename: "file.rb"}])
+  end
+end
+
+describe "dfs" do
+  let(:node) { double(:node, type: :def, children: [double(:child, children: ["name"])]) }
+  let(:result) { {} }
+
+  it "traverses node and captures def names" do
+    dfs(node, "file.rb", result)
+    expect(result).to eq({"name" => "def name\nend"})
+  end
+end
+
+describe "find_spec_file" do
+  before do
+    allow(File).to receive(:exist?).with("spec/app/file_spec.rb").and_return(true)
+  end
+
+  it "returns spec file path if exists" do
+    expect(find_spec_file("app/file.rb")).to eq("spec/app/file_spec.rb")
+  end
+
+  it "returns nil if spec file does not exist" do
+    allow(File).to receive(:exist?).with("spec/app/file_spec.rb").and_return(false)
+    expect(find_spec_file("app/file.rb")).to be_nil
+  end
+end
+
+# similarly test other functions
+```
+
+## Contributing
+
+Bug reports and Pull Requests are accepted on GitHub (https://github.com/mikik0/omochi).
+This project should be a safe place for collaboration.
+
+### Design
+
+See [DESIGN.md](https://github.com/mikik0/omochi/blob/master/DESIGN.md)
+
+### Development
+
+#### Requirement
+
+- ruby3.x
+- AWS Credentials (for `--create`)
+
+```
+git clone https://github.com/mikik0/omochi.git
+bundle install
+bundle exec bin/omochi verify
+```

data/Rakefile

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

data/exe/omochi

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'omochi'
+
+Omochi::CLI.start

data/lib/omochi/cli.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'omochi'
+require 'thor'
+require 'omochi/util'
+require 'yaml'
+require 'aws-sdk-bedrockruntime'
+require 'dotenv/load'
+require 'unparser'
+
+module Omochi
+  class CLI < Thor
+    include Omochi::Util
+
+    class << self
+      def exit_on_failure?
+        true
+      end
+    end
+
+    desc 'verify local_path', 'verify spec created for all of new methods and functions'
+    method_option :github, aliases: '-h', desc: 'Running on GitHub Action'
+    method_option :create, aliases: '-c', desc: 'Create Spec for Untested Method'
+    def verify
+      is_gh_action = options[:github] == 'github'
+      is_gl_ci_runner = false
+      create_spec = options[:create] == 'create'
+      perfect = true
+
+      diff_paths = case [is_gh_action, is_gl_ci_runner]
+                   when [true, false]
+                     github_diff_path
+                   when [false, true]
+                     remote_diff_path
+                   when [false, false]
+                     local_diff_path
+                   end
+
+      # Ruby 以外のファイル(yamlやmdなど)を除外 specファイルも除外(テストにはテストない)
+      diff_paths.reject! { |s| !s.end_with?('.rb') || s.end_with?('_spec.rb') }
+      p "Verify File List: #{diff_paths}"
+
+      # diff_paths 例: ["lib/omochi/cli.rb", "lib/omochi/util.rb"]
+      diff_paths.each do |diff_path|
+        if find_spec_file(diff_path)
+          p 'specファイルあり'
+          p 'There are spec files.'
+          perfect = process_spec_file(diff_path, create_spec, perfect)
+        else
+          p 'specファイルなし'
+          p 'There is no spec file.'
+          perfect = process_missing_spec_file(diff_path, create_spec, perfect)
+        end
+      end
+      exit(perfect ? 0 : 1)
+    end
+  end
+end

data/lib/omochi/util.rb

@@ -0,0 +1,257 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'parser/current'
+require 'json'
+require 'nokogiri'
+
+module Omochi
+  module Util
+    include AST::Processor::Mixin
+
+    def local_diff_path
+      # Gitがインストールされているか確認
+      unless system('git --version > /dev/null 2>&1')
+        puts 'Error: Git is not installed. Please install Git.'
+        return []
+      end
+
+      # ローカルのdiffを取得する
+      diff_command = 'git diff --diff-filter=d --name-only'
+      diff_output, _diff_error, _diff_status = Open3.capture3(diff_command, chdir: '.')
+
+      # エラーチェック
+      unless _diff_status.success?
+        puts "Error: Failed to run 'git diff' command."
+        return []
+      end
+
+      # 取得したdiffのpathを返却する
+      diff_output.split("\n")
+    end
+
+    def github_diff_path
+      diff_command = 'gh pr diff --name-only'
+      diff_output, _diff_error, _diff_status = Open3.capture3(diff_command, chdir: '.')
+
+      # エラーチェック
+      unless _diff_status.success?
+        puts "Error: Failed to run 'gh pr diff' command."
+        return []
+      end
+      # 取得したdiffのpathを返却する
+      diff_output.split("\n")
+    end
+
+    def remote_diff_path
+      # リモートのdiffを取得する
+      diff_command = 'git diff --name-only origin/${{ github.event.pull_request.base.ref }}..${{ github.sha }}'
+      diff_output, _diff_error, _diff_status = Open3.capture3(diff_command, chdir: '.')
+
+      # エラーチェック
+      unless _diff_status.success?
+        puts "Error: Failed to run 'git diff' command."
+        return []
+      end
+
+      # 取得したdiffのpathを返却する
+      diff_output.split("\n")
+    end
+
+    def find_spec_file(diff_path)
+      spec_path = File.join('spec', diff_path.gsub(/\.rb$/, '_spec.rb').gsub('app/', ''))
+      File.exist?(spec_path) ? spec_path : nil
+    end
+
+    def process_spec_file(diff_path, create_spec, perfect)
+      # 対応するSpecファイルが存在した場合のロジック
+      result = {}
+      spec_def_name_arr = []
+      spec_file_path = find_spec_file(diff_path)
+      # スペックファイルがあれば、specfileの中身を確認していく。
+      # defメソッド名だけ切り出す {:call => {code}, :verify => {code}, ....}
+      # ASTを再帰的に探索し、メソッド名とコードを取得
+      get_ast(diff_path).each do |expr|
+        dfs(expr[:ast], expr[:filename], result)
+      end
+      result = result.transform_keys(&:to_s)
+      # describeメソッド [call]
+      # []の中にastが入る
+      get_ast(spec_file_path).each do |expr|
+        spec_def_name_arr = dfs_describe(expr[:ast], expr[:filename], spec_def_name_arr)
+      end
+
+      # resultのHashでSpecが存在するものをTrueに更新
+      spec_def_name_arr.each do |spec_def_name|
+        next unless result.key?(spec_def_name)
+
+        result[spec_def_name] = true
+
+        next unless create_spec
+
+        method_code = result[spec_def_name]
+        puts '==================================================================='
+        puts "#{spec_def_name} のテストを以下に表示します。"
+        puts "We will show the test of #{spec_def_name} below."
+        create_spec_by_bedrock(method_code)
+      end
+
+      get_ignore_methods(diff_path).each do |def_name|
+        result[def_name] = true if result.key?(def_name)
+      end
+
+      return perfect = false if print_result(diff_path, result).size > 0
+    end
+
+    def process_missing_spec_file(diff_path, create_spec, perfect)
+      # 対応するSpecファイルが存在しない場合のロジック
+      result = {}
+      ignored_def_names = get_ignore_methods(diff_path)
+      get_ast(diff_path).each do |expr|
+        dfs(expr[:ast], expr[:filename], result)
+      end
+      result = result.transform_keys(&:to_s)
+
+      ignored_def_names.each do |def_name|
+        result[def_name] = true if result.key?(def_name)
+      end
+
+      if create_spec
+        # exprs[0] の AST からメソッド内のコードを生成
+        ast_code = get_ast(diff_path)[0][:ast]
+        method_code = Unparser.unparse(ast_code)
+
+        puts '==================================================================='
+        puts "#{diff_path} のテストを以下に表示します。"
+        puts "We will show the test of #{diff_path} below."
+        create_spec_by_bedrock(method_code)
+      end
+      return perfect = false if print_result(diff_path, result).size > 0
+    end
+
+    private
+
+    def get_ast(diff_path)
+      exprs = []
+      ast = Parser::CurrentRuby.parse(File.read(diff_path))
+      exprs << { ast: ast, filename: diff_path }
+    end
+
+    def dfs(node, filename, result)
+      return unless node.is_a?(Parser::AST::Node)
+
+      # ノードの種類に応じて処理を実行
+      case node.type
+      when :def
+        # :def ノードの場合、メソッド定義に関する処理を実行
+        # ファイル名とメソッド名をつめてます。
+        child_value = node.children[0]
+        code = Unparser.unparse(node)
+        result[child_value] = code
+      end
+
+      # 子ノードに対して再帰的に深さ優先探索
+      node.children.each { |child| dfs(child, filename, result) }
+    end
+
+    # rspecのdescribeでは、通常 # または . の直後に関数名を書くため
+    def get_pure_function_name(str)
+      if str.start_with?('#', '.')
+        str[1..-1] # 2番目以降の文字列を返す
+      else
+        str # 変更が不要な場合はそのまま返す
+      end
+    end
+
+    def dfs_describe(node, filename, def_name_arr)
+      return unless node.is_a?(Parser::AST::Node)
+
+      # ノードの種類に応じて処理を実行
+      case node.type
+      when :send
+        method_node = node.children[1]
+        if node.children[1] == :describe
+          def_name = node.children[2].children[0] # "Omochi::CLI"
+          if !def_name.nil? && def_name.is_a?(String)
+            def_name = get_pure_function_name(def_name)
+            def_name_arr.push(def_name)
+          end
+        end
+      end
+
+      # 子ノードに対して再帰的に深さ優先探索
+      node.children.each { |child| dfs_describe(child, filename, def_name_arr) }
+      def_name_arr
+    end
+
+    def print_result(filename, result)
+      puts "\e[31m======= RESULT: #{filename} =======\e[0m"
+      method_list = result.reject { |_key, value| value == true }.keys
+      method_list.each do |file|
+        puts "- \e[32m#{file}\e[0m"
+      end
+
+      method_list
+    end
+
+    def get_ignore_methods(diff_path)
+      ignore_methods = []
+      code = File.open(diff_path, 'r').read
+      lines = code.split("\n")
+      ignore_next_function = false
+
+      lines.each do |line|
+        if line.match(/omochi:ignore:*/) && line.strip.start_with?('#')
+          ignore_next_function = true
+          next
+        end
+
+        if ignore_next_function && line.match(/\s*def\s+(\w+)/)
+          ignore_methods << Regexp.last_match(1)
+          ignore_next_function = false
+        end
+      end
+
+      ignore_methods
+    end
+
+    def create_spec_by_bedrock(code)
+      # 必要な関数だけ渡すのと比較する。
+      bedrock_client = Aws::BedrockRuntime::Client.new(region: 'us-east-1')
+      comment = "You are a brilliant Ruby programmer.
+You have been assigned to a project to automate QA testing for a system.
+Please write the Ruby function you want to test inside the <code> XML tags.
+Write the tests using RSpec to cover all branches of the function comprehensively.
+Include many test cases to thoroughly verify the function.
+You must output the test code inside the <test> XML tags absolutely.
+Do not include any content besides the test code. <code> #{code} </code>"
+      body_data = {
+        "anthropic_version": 'bedrock-2023-05-31',
+        "max_tokens": 4000,
+        "temperature": 0.0,
+        "messages": [
+          {
+            "role": 'user',
+            "content": "#{comment}"
+          }
+        ]
+      }
+      response = bedrock_client.invoke_model({
+        accept: '*/*',
+        content_type: 'application/json',
+        body: body_data.to_json,
+        model_id: 'anthropic.claude-3-sonnet-20240229-v1:0'
+      })
+
+      string_io_object = response.body
+      data = JSON.parse(string_io_object.string)
+      code_html = data['content'][0]['text']
+
+      # nokogiri を使用して HTML を解析し、<test> タグの中身を取得
+      doc = Nokogiri::HTML(code_html)
+      code_content = doc.at('test').content.strip
+
+      puts code_content
+    end
+  end
+end

data/lib/omochi/version.rb

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

data/lib/omochi.rb

@@ -0,0 +1,5 @@
+require_relative 'omochi/version'
+require_relative 'omochi/cli'
+
+module Omochi
+end

data/sig/omochi.rbs

@@ -0,0 +1,4 @@
+module Omochi
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: omochi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mikiko.hashino
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-bedrockruntime
+  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: dotenv
+  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: nokogiri
+  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: parser
+  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: rspec
+  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: thor
+  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: unparser
+  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'
+description: Omochi is a CLI tool to support Ruby on Rails development with RSpec.
+email:
+- mikko.1222.u@gmail.com
+executables:
+- omochi
+extensions: []
+extra_rdoc_files: []
+files:
+- DESIGN.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- exe/omochi
+- lib/omochi.rb
+- lib/omochi/cli.rb
+- lib/omochi/util.rb
+- lib/omochi/version.rb
+- sig/omochi.rbs
+homepage: https://github.com/mikik0/omochi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mikik0/omochi
+  source_code_uri: https://github.com/mikik0/omochi
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Omochi is a CLI tool to support Ruby on Rails development with RSpec.
+test_files: []