igata 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78199aa96fa495664cb461c46bbabdce3afa9a21f3083e5f49e41cb47e66f909
-  data.tar.gz: e2a0d35b071882c6b28ea13d1b88f846e3bb74adcf1ca92d7700aa7be635ee44
+  metadata.gz: 67e0f333dc1a9f2e7088ca132ab093f1d94c54da84fb74f68875e6712fd6914c
+  data.tar.gz: b2f6a8ea974699fcedfe03b5d67fa53af10a8973d38141fca304fa08b015ad16
 SHA512:
-  metadata.gz: 4c5b75401c77c515dfdcb5968d44c7c4e8569ed10ebc03c5e7a7a8ab7e8225aa086cabcb66c99c7519f3c35fc5fb9f2789409d56d5d4961995c07ae79192df94
-  data.tar.gz: eb80ea990597cda4110a8b7e431d41d6c19c8af8bf5387e2e8ad270ea273e1b39f913107069ec8da2c8b836dbbe1efe8fe885aae9fc07afb26a53568efb49f26
+  metadata.gz: 191413d88a85822e823cd5a858b5e37b22c435debf020994184375aa0c34f8257285f0c8b85483f9be7deaf22aec045ee8146607a92d1e81d91c16e57e4577f9
+  data.tar.gz: 3daba51294a26df61cab417a5885a35e0d9a8cc63e7d584a5f379ce9ff20dc65e59247bd68e519feb049faee0a6affc22f46dd17ac14326f4383e283d581f060

data/CHANGELOG.md

@@ -1,5 +1,98 @@
 ## [Unreleased]
 
+## [0.3.0] - 2025-11-29
+
+### Added
+
+- Method argument information in generated tests:
+  - Test methods now display argument information for each method
+  - Shows argument names, types, and default values
+  - Supports all argument types: required, optional, keyword, required keyword, variable length (*args), keyword variable length (**kwargs), and block (&block)
+  - Arguments are displayed at the top of test methods before other analysis information
+  - Example: `# Arguments: - name (required), - age (optional, default: 18)`
+  - Fully compatible with all formatters (Minitest, RSpec, Minitest Spec)
+- Integration test tasks for real-world Rails applications
+  - `rake integration:setup`: Clone test repositories (Rails, Discourse, Mastodon, GitLab)
+  - `rake integration:test`: Run Igata against all Ruby files in repositories
+  - `rake integration:clean`: Remove cloned repositories
+  - `rake integration:update`: Update cloned repositories
+- Minitest Spec formatter support
+  - New `-f minitest_spec` option for generating Minitest Spec style tests
+  - Uses Minitest's built-in RSpec-style DSL (minitest/spec)
+  - Generates `describe`/`it` blocks instead of class-based tests
+  - Fully compatible with all existing analysis features (branches, comparisons, exceptions, boundary values)
+- Added exception and error handling analysis:
+  - `Extractors::ExceptionAnalyzer`: Detects `raise` statements and `rescue` clauses in methods
+  - `Values::ExceptionInfo`: Value object for exception information (type, class, message, context)
+  - Generates test comments showing:
+    - Exceptions raised: Shows exception class and message (e.g., `ArgumentError ("Invalid amount")`)
+    - Exceptions rescued: Shows caught exception classes (e.g., `PaymentError`)
+  - Supports both Minitest and RSpec formats
+- Added boundary value test case suggestions:
+  - `Extractors::BoundaryValueGenerator`: Automatically generates boundary value suggestions from comparison operators
+  - `Values::BoundaryValueInfo`: Value object for boundary value information (comparison, test_values, description)
+  - Generates test comments showing suggested test values for various types:
+    - Numeric values: `age >= 18` → Test with `[17 (below), 18 (boundary), 19 (above)]`
+    - String literals: `name == "Alice"` → Test with `["Alice", "different_string"]`
+    - Nil values: `value == nil` → Test with `[nil, "some_value"]`
+    - Boolean values: `flag == true` → Test with `[true, false]`
+    - Symbol values: `status == :active` → Test with `[":active", ":other_symbol"]`
+  - Supports all comparison operators: `>=`, `>`, `<=`, `<`, `==`, `!=`
+  - Supports both Minitest and RSpec formats
+  - Skips boundary value generation for variable references and method calls
+
+### Changed
+
+- CLI now supports three formatters: `minitest` (default), `rspec`, and `minitest_spec`
+- Updated `Values::MethodInfo` to include `exceptions` field (default: [])
+- Updated `Values::MethodInfo` to include `boundary_values` field (default: [])
+- Updated `Extractors::MethodNames` to automatically run `BoundaryValueGenerator` for each method
+- Updated Minitest and RSpec formatters to include exception information in generated test comments
+- Updated Minitest and RSpec formatters to include boundary value suggestions in generated test comments
+- Updated Kanayago dependency from ~> 0.3.0 to ~> 0.6.1
+  - `Kanayago.parse` now returns `Kanayago::ParseResult` instead of AST node directly
+  - Updated all test cases to use `.ast` accessor
+  - This enables future enhancements:
+    - Syntax error handling for invalid Ruby code
+    - Method argument extraction using script_lines
+  - see: https://github.com/S-H-GAMELINKS/kanayago/blob/master/CHANGELOG.md#060
+
+### Documentation
+
+- Added Minitest Spec examples to README.md
+- Added Minitest Spec usage guide to QUICKSTART.md
+- Updated USAGE.md with Minitest Spec details
+
+### Fixed
+
+- Fixed BlockNode and BeginNode handling for real-world Ruby code
+  - Fixed BlockNode handling: When `require` statements or constants appear before class definitions, the AST creates a BlockNode wrapper
+    - Added `find_class_node` method in `Extractors::ConstantPath` to search for ClassNode within BlockNode
+    - Example: `backup_service.rb` with `require 'zip'` at the top
+  - Fixed BeginNode handling: Empty classes or classes with special structures create BeginNode that lack the `find` method
+    - Added `respond_to?` checks in `find_deepest_class_node` to safely handle these cases
+    - Returns `nil` for BeginNode structures
+  - Added test cases for both scenarios (`class_with_require` and `class_with_no_methods`) to prevent regression
+  - Verified with all 69 Mastodon service classes (100% success rate)
+- Fixed StringNode value extraction to use `ptr` instead of `val` in `BranchAnalyzer` and `ComparisonAnalyzer`
+  - Kanayago 0.4.0 changed the API: string values are now stored in `ptr` field instead of `val`
+  - Added integration tests for string literal comparisons and branches to prevent regression
+- Fixed `undefined method 'cpath' for nil` error when processing files without class/module definitions
+  - Updated `find_class_node` to return `nil` when no ClassNode or ModuleNode is found
+  - Added guard clause in `extract` method to handle `nil` class nodes
+  - Updated `Igata#generate` to return empty string when no class/module is found
+  - This allows Igata to gracefully handle configuration files, scripts, and other Ruby files without class definitions
+
+## [0.2.1] - 2025-10-26
+
+### Added
+
+- Added Kanayago (~> 0.3.0) as runtime dependency to ensure automatic installation
+
+### Fixed
+
+- Fixed LoadError when Kanayago is not manually installed by adding it as gemspec dependency
+
 ## [0.2.0] - 2025-10-26
 
 ### Added

data/QUICKSTART.md

@@ -111,6 +111,43 @@ RSpec.describe User do
 end
 ```
 
+### 4. Generate Minitest Spec
+
+```bash
+igata user.rb -f minitest_spec > test/user_spec.rb
+```
+
+Output:
+
+```ruby
+# frozen_string_literal: true
+
+require "test_helper"
+require "minitest/spec"
+
+describe User do
+  describe "#initialize" do
+    it "works correctly" do
+      skip "Not implemented yet"
+    end
+  end
+
+  describe "#adult?" do
+    # Comparisons: >= (@age >= 18)
+    it "works correctly" do
+      skip "Not implemented yet"
+    end
+  end
+
+  describe "#greeting" do
+    # Branches: if (@name)
+    it "works correctly" do
+      skip "Not implemented yet"
+    end
+  end
+end
+```
+
 ## Common Usage Patterns
 
 ### Generate from stdin

data/README.md

@@ -36,10 +36,19 @@ bundle exec igata lib/user.rb -f rspec > spec/user_spec.rb
 bundle exec igata lib/user.rb --formatter rspec > spec/user_spec.rb
 ```
 
+Generate Minitest Spec tests:
+
+```bash
+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
+- `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
 
@@ -67,11 +76,16 @@ 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
@@ -86,6 +100,9 @@ require "spec_helper"
 
 RSpec.describe User do
   describe "#initialize" do
+    # Arguments:
+    #   - name (required)
+    #   - age (required)
     it "works correctly" do
       pending "Not implemented yet"
     end
@@ -93,6 +110,8 @@ RSpec.describe User do
 
   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
@@ -100,12 +119,96 @@ RSpec.describe User do
 end
 ```
 
+Minitest Spec output:
+
+```ruby
+# 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:
+
+```ruby
+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:
+
+```ruby
+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](https://rubygems.org).
 
+### Integration Tests
+
+Run integration tests against real-world Rails applications (Rails, Discourse, Mastodon, GitLab):
+
+```bash
+# 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.

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "minitest/test_task"
+require "fileutils"
 
 Minitest::TestTask.create
 
@@ -10,3 +11,137 @@ require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
 task default: %i[test rubocop]
+
+INTEGRATION_TEST_TARGET_REPOS_DIR = File.expand_path("tmp/integration_repos", __dir__)
+INTEGRATION_TEST_TARGET_REPOSITORIES = {
+  "rails" => {
+    url: "https://github.com/rails/rails.git",
+    branch: "main",
+    depth: 1
+  },
+  "discourse" => {
+    url: "https://github.com/discourse/discourse.git",
+    branch: "main",
+    depth: 1
+  },
+  "mastodon" => {
+    url: "https://github.com/mastodon/mastodon.git",
+    branch: "main",
+    depth: 1
+  },
+  "gitlab" => {
+    url: "https://gitlab.com/gitlab-org/gitlab.git",
+    branch: "master",
+    depth: 1
+  }
+}.freeze
+
+namespace :integration do # rubocop:disable Metrics/BlockLength
+  desc "Setup integration test repositories"
+  task :setup do
+    FileUtils.mkdir_p(INTEGRATION_TEST_TARGET_REPOS_DIR)
+
+    INTEGRATION_TEST_TARGET_REPOSITORIES.each do |name, config|
+      repo_path = File.join(INTEGRATION_TEST_TARGET_REPOS_DIR, name)
+
+      if File.directory?(repo_path)
+        puts "Repository #{name} already exists at #{repo_path}"
+        next
+      end
+
+      puts "Cloning #{name} from #{config[:url]}..."
+      system("git clone --depth #{config[:depth]} --branch #{config[:branch]} #{config[:url]} #{repo_path}")
+
+      if $?.success? # rubocop:disable Style/SpecialGlobalVars
+        puts "Successfully cloned #{name}"
+      else
+        puts "Failed to clone #{name}"
+      end
+    end
+
+    puts "\nIntegration test repositories setup complete!"
+  end
+
+  desc "Clean integration test repositories"
+  task :clean do
+    if File.directory?(INTEGRATION_TEST_TARGET_REPOS_DIR)
+      puts "Removing integration test repositories at #{INTEGRATION_TEST_TARGET_REPOS_DIR}..."
+      FileUtils.rm_rf(INTEGRATION_TEST_TARGET_REPOS_DIR)
+      puts "Done!"
+    else
+      puts "No integration test repositories found"
+    end
+  end
+
+  desc "Update integration test repositories"
+  task :update do
+    unless File.directory?(INTEGRATION_TEST_TARGET_REPOS_DIR)
+      puts "No repositories found. Run 'rake integration:setup' first."
+      next
+    end
+
+    INTEGRATION_TEST_TARGET_REPOSITORIES.each_key do |name|
+      repo_path = File.join(INTEGRATION_TEST_TARGET_REPOS_DIR, name)
+
+      unless File.directory?(repo_path)
+        puts "Repository #{name} not found, skipping..."
+        next
+      end
+
+      puts "Updating #{name}..."
+      Dir.chdir(repo_path) do
+        system("git pull")
+      end
+    end
+
+    puts "\nIntegration test repositories updated!"
+  end
+
+  desc "Run integration tests against real-world repositories"
+  task test: :setup do # rubocop:disable Metrics/BlockLength
+    require_relative "lib/igata"
+
+    success = true
+
+    INTEGRATION_TEST_TARGET_REPOSITORIES.each_key do |name| # rubocop:disable Metrics/BlockLength
+      repo_path = File.join(INTEGRATION_TEST_TARGET_REPOS_DIR, name)
+
+      unless File.directory?(repo_path)
+        puts "Repository #{name} not found, skipping..."
+        next
+      end
+
+      puts "\n#{"=" * 60}"
+      puts "Testing #{name}..."
+      puts "=" * 60
+
+      ruby_files = Dir.glob(File.join(repo_path, "**", "*.rb"))
+      puts "Found #{ruby_files.size} Ruby files"
+
+      failed_files = []
+      ruby_files.each_with_index do |file, index|
+        print "\r  Processing #{index + 1}/#{ruby_files.size}: #{File.basename(file)}".ljust(80)
+
+        begin
+          source = File.read(file)
+          Igata.new(source).generate
+        rescue StandardError => e
+          failed_files << { file: file, error: e.message }
+        end
+      end
+
+      puts "\n  Completed: #{ruby_files.size - failed_files.size}/#{ruby_files.size} files passed"
+
+      next if failed_files.empty?
+
+      puts "  Failed files:"
+      failed_files.first(10).each do |f|
+        puts "    - #{f[:file]}: #{f[:error]}"
+      end
+      puts "    ... and #{failed_files.size - 10} more" if failed_files.size > 10
+      success = false
+    end
+
+    exit(1) unless success
+  end
+end