Igata(鋳型)

Generate test code from AST node produces by Ruby's Parser

📚 Quick Start Guide | Full Documentation | Changelog

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add igata

If bundler is not being used to manage dependencies, install the gem by executing:

gem install igata

Usage

Basic Usage

Generate Minitest tests (default):

bundle exec igata lib/user.rb > test/test_user.rb

Generate RSpec tests:

bundle exec igata lib/user.rb -f rspec > spec/user_spec.rb
# or
bundle exec igata lib/user.rb --formatter rspec > spec/user_spec.rb

Generate Minitest Spec tests:

bundle exec igata lib/user.rb -f minitest_spec > test/user_spec.rb
# or
bundle exec igata lib/user.rb --formatter minitest_spec > test/user_spec.rb

Supported Formatters

minitest (default): Generates Minitest-style tests (class-based)
rspec: Generates RSpec-style tests
minitest_spec: Generates Minitest Spec-style tests (RSpec-style DSL with Minitest)

Example

Given a Ruby class:

class User
  def initialize(name, age)
    @name = name
    @age = age
  end

  def adult?
    @age >= 18
  end
end

Minitest output:

# frozen_string_literal: true

require "test_helper"

class UserTest < Minitest::Test
  def test_initialize
    # Arguments:
    #   - name (required)
    #   - age (required)
    skip "Not implemented yet"
  end

  def test_adult?
    # Comparisons: >= (@age >= 18)
    # Boundary value suggestions:
    #   @age >= 18: [17 (below), 18 (boundary), 19 (above)]
    skip "Not implemented yet"
  end
end

RSpec output:

# frozen_string_literal: true

require "spec_helper"

RSpec.describe User do
  describe "#initialize" do
    # Arguments:
    #   - name (required)
    #   - age (required)
    it "works correctly" do
      pending "Not implemented yet"
    end
  end

  describe "#adult?" do
    # Comparisons: >= (@age >= 18)
    # Boundary value suggestions:
    #   @age >= 18: [17 (below), 18 (boundary), 19 (above)]
    it "works correctly" do
      pending "Not implemented yet"
    end
  end
end

Minitest Spec output:

# frozen_string_literal: true

require "test_helper"
require "minitest/spec"

describe User do
  describe "#initialize" do
    # Arguments:
    #   - name (required)
    #   - age (required)
    it "works correctly" do
      skip "Not implemented yet"
    end
  end

  describe "#adult?" do
    # Comparisons: >= (@age >= 18)
    # Boundary value suggestions:
    #   @age >= 18: [17 (below), 18 (boundary), 19 (above)]
    it "works correctly" do
      skip "Not implemented yet"
    end
  end
end

Exception Handling Detection

Igata detects exception handling patterns and generates helpful test comments:

class PaymentProcessor
  def process_payment(amount)
    raise ArgumentError, "Invalid amount" if amount <= 0

    charge_card(amount)
  rescue PaymentError => e
    log_error(e)
    false
  end
end

Generated Minitest output:

class PaymentProcessorTest < Minitest::Test
  def test_process_payment
    # Branches: if (amount <= 0)
    # Comparisons: <= (amount <= 0)
    # Exceptions raised: ArgumentError ("Invalid amount")
    # Exceptions rescued: PaymentError
    skip "Not implemented yet"
  end
end

Features

✅ Argument Analysis: Displays method argument information (types, default values)
✅ Branch Analysis: Detects if, elsif, else, unless, and case statements
✅ Comparison Analysis: Detects comparison operators (>=, <=, >, <, ==, !=)
✅ Boundary Value Suggestions: Automatically suggests boundary test values for comparisons
✅ Exception Analysis: Detects raise statements and rescue clauses
✅ Multiple Formatters: Supports Minitest, RSpec, and Minitest Spec test generation
✅ AST-based: Uses Kanayago parser for accurate Ruby code analysis

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. 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.

Integration Tests

Run integration tests against real-world Rails applications (Rails, Discourse, Mastodon, GitLab):

# Run integration tests (automatically clones repositories on first run)
bundle exec rake integration:test

# Manually setup/update/clean repositories
bundle exec rake integration:setup   # Clone repositories
bundle exec rake integration:update  # Update repositories
bundle exec rake integration:clean   # Remove repositories

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/S-H-GAMELINKS/igata.

License

The gem is available as open source under the terms of the MIT License.

igata

Runtime