tryouts 3.0.0 → 3.1.1

data/lib/tryouts/test_case.rb

@@ -0,0 +1,192 @@
+# lib/tryouts/testcase.rb
+
+# Modern data structures using Ruby 3.2+ Data classes
+class Tryouts
+  # Core data structures
+  TestCase = Data.define(:description, :code, :expectations, :line_range, :path, :source_lines, :first_expectation_line) do
+    def empty?
+      code.empty?
+    end
+
+    def expectations?
+      !expectations.empty?
+    end
+
+    def exception_expectations?
+      expectations.any?(&:exception?)
+    end
+
+    def regular_expectations
+      expectations.filter(&:regular?)
+    end
+
+    def exception_expectations
+      expectations.filter(&:exception?)
+    end
+  end
+
+  Expectation = Data.define(:content, :type) do
+    def regular? = type == :regular
+    def exception? = type == :exception
+    def boolean? = type == :boolean
+    def true? = type == :true
+    def false? = type == :false
+    def result_type? = type == :result_type
+    def regex_match? = type == :regex_match
+    def performance_time? = type == :performance_time
+    def intentional_failure? = type == :intentional_failure
+    def output? = type == :output
+  end
+
+  # Special expectation type for output capturing with pipe information
+  OutputExpectation = Data.define(:content, :type, :pipe) do
+    def regular? = type == :regular
+    def exception? = type == :exception
+    def boolean? = type == :boolean
+    def true? = type == :true
+    def false? = type == :false
+    def result_type? = type == :result_type
+    def regex_match? = type == :regex_match
+    def performance_time? = type == :performance_time
+    def intentional_failure? = type == :intentional_failure
+    def output? = type == :output
+
+    def stdout? = pipe == 1
+    def stderr? = pipe == 2
+  end
+
+  Setup = Data.define(:code, :line_range, :path) do
+    def empty?
+      code.empty?
+    end
+  end
+
+  Teardown = Data.define(:code, :line_range, :path) do
+    def empty?
+      code.empty?
+    end
+  end
+
+  Testrun = Data.define(:setup, :test_cases, :teardown, :source_file, :metadata) do
+    def total_tests
+      test_cases.size
+    end
+
+    def empty?
+      test_cases.empty?
+    end
+  end
+
+  # Test case result packet for formatters
+  # Replaces the simple Hash aggregation with a rich, immutable data structure
+  # containing all execution context and results needed by formatters
+  TestCaseResultPacket = Data.define(
+    :test_case,          # TestCase object
+    :status,             # :passed, :failed, :error
+    :result_value,       # Actual execution result
+    :actual_results,     # Array of actual values from expectations
+    :expected_results,   # Array of expected values from expectations
+    :error,              # Exception object (if any)
+    :captured_output,    # Captured stdout/stderr content
+    :elapsed_time,       # Execution timing (future use)
+    :metadata            # Hash for future extensibility
+  ) do
+    def passed?
+      status == :passed
+    end
+
+    def failed?
+      status == :failed
+    end
+
+    def error?
+      status == :error
+    end
+
+    def has_output?
+      captured_output && !captured_output.empty?
+    end
+
+    def has_error?
+      !error.nil?
+    end
+
+    # Helper for formatter access to first actual/expected values
+    def first_actual
+      actual_results&.first
+    end
+
+    def first_expected
+      expected_results&.first
+    end
+
+    # Create a basic result packet for successful tests
+    def self.from_success(test_case, result_value, actual_results, expected_results, captured_output: nil, elapsed_time: nil, metadata: {})
+      new(
+        test_case: test_case,
+        status: :passed,
+        result_value: result_value,
+        actual_results: actual_results,
+        expected_results: expected_results,
+        error: nil,
+        captured_output: captured_output,
+        elapsed_time: elapsed_time,
+        metadata: metadata
+      )
+    end
+
+    # Create a result packet for failed tests
+    def self.from_failure(test_case, result_value, actual_results, expected_results, captured_output: nil, elapsed_time: nil, metadata: {})
+      new(
+        test_case: test_case,
+        status: :failed,
+        result_value: result_value,
+        actual_results: actual_results,
+        expected_results: expected_results,
+        error: nil,
+        captured_output: captured_output,
+        elapsed_time: elapsed_time,
+        metadata: metadata
+      )
+    end
+
+    # Create a result packet for error cases
+    def self.from_error(test_case, error, captured_output: nil, elapsed_time: nil, metadata: {})
+      error_message = error ? error.message : '<exception is nil>'
+
+      # Include backtrace in error message when in debug/verbose mode
+      error_display = if error && Tryouts.debug?
+        backtrace_preview = error.backtrace&.first(3)&.join("\n    ")
+        "(#{error.class}) #{error_message}\n    #{backtrace_preview}"
+      else
+        "(#{error.class}) #{error_message}"
+      end
+
+      new(
+        test_case: test_case,
+        status: :error,
+        result_value: nil,
+        actual_results: [error_display],
+        expected_results: [],
+        error: error,
+        captured_output: captured_output,
+        elapsed_time: elapsed_time,
+        metadata: metadata
+      )
+    end
+  end
+
+  # Enhanced error with context
+  class TryoutSyntaxError < StandardError
+    attr_reader :line_number, :context, :source_file
+
+    def initialize(message, line_number:, context:, source_file: nil)
+      @line_number = line_number
+      @context     = context
+      @source_file = source_file
+
+      location = source_file ? "#{source_file}:#{line_number}" : "line #{line_number}"
+      super("#{message} at #{location}: #{context}")
+    end
+  end
+end

data/lib/tryouts/test_executor.rb

@@ -1,6 +1,6 @@
 # lib/tryouts/test_executor.rb
 
-require_relative 'testbatch'
+require_relative 'test_batch'
 
 class Tryouts
   class TestExecutor
@@ -38,6 +38,7 @@ class Tryouts
         global_tally: @global_tally,
       )
 
+      # TestBatch handles file output, so don't duplicate it here
       unless @options[:verbose]
         context_mode = @options[:shared_context] ? 'shared' : 'fresh'
         @output_manager.file_execution_start(@file, @testrun.total_tests, context_mode)
@@ -49,15 +50,16 @@ class Tryouts
         test_results << last_result if last_result
       end
 
-      file_failed_count                 = test_results.count { |r| r[:status] == :failed }
-      file_error_count                  = test_results.count { |r| r[:status] == :error }
-      @global_tally[:total_tests]      += batch.size
+      file_failed_count                 = test_results.count { |r| r.failed? }
+      file_error_count                  = test_results.count { |r| r.error? }
+      executed_test_count               = test_results.size
+      @global_tally[:total_tests]      += executed_test_count
       @global_tally[:total_failed]     += file_failed_count
       @global_tally[:total_errors]     += file_error_count
       @global_tally[:successful_files] += 1 if success
 
       duration = Time.now.to_f - @file_start.to_f
-      @output_manager.file_success(@file, batch.size, file_failed_count, file_error_count, duration)
+      @output_manager.file_success(@file, executed_test_count, file_failed_count, file_error_count, duration)
 
       # Combine failures and errors to determine the exit code.
       success ? 0 : (file_failed_count + file_error_count)

data/lib/tryouts/test_runner.rb

@@ -1,7 +1,7 @@
 # lib/tryouts/test_runner.rb
 
 require_relative 'prism_parser'
-require_relative 'testbatch'
+require_relative 'test_batch'
 require_relative 'translators/rspec_translator'
 require_relative 'translators/minitest_translator'
 require_relative 'file_processor'
@@ -79,7 +79,7 @@ class Tryouts
     def process_files
       failure_count = 0
 
-      @files.each do |file|
+      @files.each_with_index do |file, idx|
         result         = process_file(file)
         failure_count += result unless result.zero?
         status         = result.zero? ? Console.color(:green, 'PASS') : Console.color(:red, 'FAIL')

data/lib/tryouts/translators/minitest_translator.rb

@@ -2,6 +2,44 @@
 
 class Tryouts
   module Translators
+    # Translates Tryouts test files to Minitest format
+    #
+    # IMPORTANT: Context Mode Differences
+    # ==================================
+    #
+    # Tryouts supports two context modes that behave differently than Minitest:
+    #
+    # 1. Tryouts Shared Context (default):
+    #    - Setup runs once, all tests share the same context object
+    #    - Tests can modify variables/state and affect subsequent tests
+    #    - Behaves like a Ruby script executing top-to-bottom
+    #    - Designed for documentation-style tests where examples build on each other
+    #
+    # 2. Tryouts Fresh Context (--no-shared-context):
+    #    - Setup @instance_variables are copied to each test's fresh context
+    #    - Tests are isolated but inherit setup state
+    #    - Similar to Minitest's setup method but with setup state inheritance
+    #
+    # Minitest Translation Behavior:
+    # ==============================
+    # - Uses setup method which runs before each test (Minitest standard)
+    # - Each test method gets fresh context (Minitest standard)
+    # - Tests that rely on shared state between test cases WILL FAIL
+    # - This is intentional and reveals inappropriate test dependencies
+    #
+    # Example that works in Tryouts shared mode but fails in Minitest:
+    #   ## TEST 1
+    #   @counter = 1
+    #   @counter
+    #   #=> 1
+    #
+    #   ## TEST 2
+    #   @counter += 1  # Will be reset to 1 by setup, then fail
+    #   @counter
+    #   #=> 2
+    #
+    # Recommendation: Write tryouts tests that work in fresh context mode
+    # if you plan to use Minitest translation.
     class MinitestTranslator
       def initialize
         require 'minitest/test'
@@ -27,11 +65,24 @@ class Tryouts
 
             method_name = "test_#{index.to_s.rjust(3, '0')}_#{parameterize(test_case.description)}"
             define_method(method_name) do
-              result = instance_eval(test_case.code) unless test_case.code.strip.empty?
-
-              test_case.expectations.each do |expectation|
-                expected_value = instance_eval(expectation)
-                assert_equal expected_value, result
+              if test_case.exception_expectations?
+                # Handle exception expectations
+                assert_raises(StandardError) do
+                  instance_eval(test_case.code) unless test_case.code.strip.empty?
+                end
+
+                test_case.exception_expectations.each do |expectation|
+                  result = instance_eval(expectation.content)
+                  assert result, "Exception expectation failed: #{expectation.content}"
+                end
+              else
+                # Handle regular expectations
+                result = instance_eval(test_case.code) unless test_case.code.strip.empty?
+
+                test_case.regular_expectations.each do |expectation|
+                  expected_value = instance_eval(expectation.content)
+                  assert_equal expected_value, result
+                end
               end
             end
           end
@@ -72,15 +123,31 @@ class Tryouts
 
           method_name = "test_#{index.to_s.rjust(3, '0')}_#{parameterize(test_case.description)}"
           lines << "  def #{method_name}"
-          unless test_case.code.strip.empty?
-            lines << '    result = begin'
-            test_case.code.lines.each { |line| lines << "      #{line.chomp}" }
+
+          if test_case.exception_expectations?
+            # Handle exception expectations
+            lines << '    error = assert_raises(StandardError) do'
+            unless test_case.code.strip.empty?
+              test_case.code.lines.each { |line| lines << "      #{line.chomp}" }
+            end
             lines << '    end'
-          end
 
-          test_case.expectations.each do |expectation|
-            lines << "    assert_equal #{expectation}, result"
+            test_case.exception_expectations.each do |expectation|
+              lines << "    assert #{expectation}, \"Exception expectation failed: #{expectation}\""
+            end
+          else
+            # Handle regular expectations
+            unless test_case.code.strip.empty?
+              lines << '    result = begin'
+              test_case.code.lines.each { |line| lines << "      #{line.chomp}" }
+              lines << '    end'
+            end
+
+            test_case.expectations.each do |expectation|
+              lines << "    assert_equal #{expectation}, result"
+            end
           end
+
           lines << '  end'
           lines << ''
         end

data/lib/tryouts/translators/rspec_translator.rb

@@ -2,6 +2,44 @@
 
 class Tryouts
   module Translators
+    # Translates Tryouts test files to RSpec format
+    #
+    # IMPORTANT: Context Mode Differences
+    # ==================================
+    #
+    # Tryouts supports two context modes that behave differently than RSpec:
+    #
+    # 1. Tryouts Shared Context (default):
+    #    - Setup runs once, all tests share the same context object
+    #    - Tests can modify variables/state and affect subsequent tests
+    #    - Behaves like a Ruby script executing top-to-bottom
+    #    - Designed for documentation-style tests where examples build on each other
+    #
+    # 2. Tryouts Fresh Context (--no-shared-context):
+    #    - Setup @instance_variables are copied to each test's fresh context
+    #    - Tests are isolated but inherit setup state
+    #    - Similar to RSpec's before(:each) but with setup state inheritance
+    #
+    # RSpec Translation Behavior:
+    # ===========================
+    # - Uses before(:all) for setup code (closest equivalent to shared context)
+    # - Each 'it' block gets fresh context (RSpec standard)
+    # - Tests that rely on shared state between test cases WILL FAIL
+    # - This is intentional and reveals inappropriate test dependencies
+    #
+    # Example that works in Tryouts shared mode but fails in RSpec:
+    #   ## TEST 1
+    #   @counter = 1
+    #   @counter
+    #   #=> 1
+    #
+    #   ## TEST 2
+    #   @counter += 1  # Will be nil in RSpec, causing failure
+    #   @counter
+    #   #=> 2
+    #
+    # Recommendation: Write tryouts tests that work in fresh context mode
+    # if you plan to use RSpec translation.
     class RSpecTranslator
       def initialize
         require 'rspec/core'
@@ -16,7 +54,7 @@ class Tryouts
           # Setup before all tests
           if testrun.setup && !testrun.setup.empty?
             before(:all) do
-              instance_eval(testrun.setup.code)
+              instance_eval(testrun.setup.code, testrun.source_file)
             end
           end
 
@@ -25,11 +63,27 @@ class Tryouts
             next if test_case.empty? || !test_case.expectations?
 
             it test_case.description do
-              result = instance_eval(test_case.code) unless test_case.code.strip.empty?
+              if test_case.exception_expectations?
+                # Handle exception expectations
+                error = nil
+                expect do
+                  instance_eval(test_case.code, testrun.source_file) unless test_case.code.strip.empty?
+                end.to raise_error do |caught_error|
+                  error = caught_error
+                end
 
-              test_case.expectations.each do |expectation|
-                expected_value = instance_eval(expectation)
-                expect(result).to eq(expected_value)
+                test_case.exception_expectations.each do |expectation|
+                  expected_value = instance_eval(expectation.content, testrun.source_file)
+                  expect(expected_value).to be_truthy
+                end
+              else
+                # Handle regular expectations
+                result = instance_eval(test_case.code, testrun.source_file) unless test_case.code.strip.empty?
+
+                test_case.regular_expectations.each do |expectation|
+                  expected_value = instance_eval(expectation.content, testrun.source_file)
+                  expect(result).to eq(expected_value)
+                end
               end
             end
           end
@@ -37,7 +91,7 @@ class Tryouts
           # Teardown after all tests
           if testrun.teardown && !testrun.teardown.empty?
             after(:all) do
-              instance_eval(testrun.teardown.code)
+              instance_eval(testrun.teardown.code, testrun.source_file)
             end
           end
         end
@@ -61,15 +115,34 @@ class Tryouts
           next if test_case.empty? || !test_case.expectations?
 
           lines << "  it '#{test_case.description}' do"
-          unless test_case.code.strip.empty?
-            lines << '    result = begin'
-            test_case.code.lines.each { |line| lines << "      #{line.chomp}" }
+
+          if test_case.exception_expectations?
+            # Handle exception expectations
+            lines << '    error = nil'
+            lines << '    expect {'
+            unless test_case.code.strip.empty?
+              test_case.code.lines.each { |line| lines << "      #{line.chomp}" }
+            end
+            lines << '    }.to raise_error do |caught_error|'
+            lines << '      error = caught_error'
             lines << '    end'
-          end
 
-          test_case.expectations.each do |expectation|
-            lines << "    expect(result).to eq(#{expectation})"
+            test_case.exception_expectations.each do |expectation|
+              lines << "    expect(#{expectation.content}).to be_truthy"
+            end
+          else
+            # Handle regular expectations
+            unless test_case.code.strip.empty?
+              lines << '    result = begin'
+              test_case.code.lines.each { |line| lines << "      #{line.chomp}" }
+              lines << '    end'
+            end
+
+            test_case.regular_expectations.each do |expectation|
+              lines << "    expect(result).to eq(#{expectation.content})"
+            end
           end
+
           lines << '  end'
           lines << ''
         end

data/lib/tryouts/version.rb

@@ -1,5 +1,5 @@
 # lib/tryouts/version.rb
 
 class Tryouts
-  VERSION = '3.0.0'
+  VERSION = '3.1.1'
 end

data/lib/tryouts.rb

@@ -3,11 +3,12 @@
 
 
 require 'stringio'
+require 'timeout'
 
 TRYOUTS_LIB_HOME = __dir__ unless defined?(TRYOUTS_LIB_HOME)
 
 require_relative 'tryouts/console'
-require_relative 'tryouts/testbatch'
+require_relative 'tryouts/test_batch'
 require_relative 'tryouts/version'
 require_relative 'tryouts/prism_parser'
 require_relative 'tryouts/cli'
@@ -47,6 +48,47 @@ class Tryouts
       prefix = ('  ' * indent) + Console.color(:dim, 'TRACE')
       warn "#{prefix} #{msg}"
     end
+
+    def debug(msg, indent: 0)
+      return unless debug?
+
+      prefix = ('  ' * indent) + Console.color(:cyan, 'DEBUG')
+      warn "#{prefix} #{msg}"
+    end
+
+    # Error classification for resilient error handling
+    def classify_error(exception)
+      case exception
+      when SystemExit, SignalException
+        :non_recoverable_exit
+      when Timeout::Error
+        :transient
+      when Errno::ENOENT, Errno::EACCES, Errno::EPERM
+        :file_system
+      when LoadError, NameError, NoMethodError
+        :code_structure
+      when SecurityError, NoMemoryError, SystemStackError
+        :system_resource
+      when SyntaxError, TryoutSyntaxError
+        :syntax
+      when StandardError
+        :recoverable
+      else
+        :unknown
+      end
+    end
+
+    # Determine if an error should stop batch execution
+    def batch_stopping_error?(exception)
+      classification = classify_error(exception)
+      [:non_recoverable_exit, :system_resource, :syntax].include?(classification)
+    end
+
+    # Determine if an error should stop individual test execution
+    def test_stopping_error?(exception)
+      classification = classify_error(exception)
+      [:non_recoverable_exit, :system_resource].include?(classification)
+    end
   end
 
   extend ClassMethods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tryouts
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Delano Mandelbaum
@@ -83,12 +83,25 @@ files:
 - lib/tryouts/cli/modes/inspect.rb
 - lib/tryouts/cli/opts.rb
 - lib/tryouts/console.rb
+- lib/tryouts/expectation_evaluators/base.rb
+- lib/tryouts/expectation_evaluators/boolean.rb
+- lib/tryouts/expectation_evaluators/exception.rb
+- lib/tryouts/expectation_evaluators/expectation_result.rb
+- lib/tryouts/expectation_evaluators/false.rb
+- lib/tryouts/expectation_evaluators/intentional_failure.rb
+- lib/tryouts/expectation_evaluators/output.rb
+- lib/tryouts/expectation_evaluators/performance_time.rb
+- lib/tryouts/expectation_evaluators/regex_match.rb
+- lib/tryouts/expectation_evaluators/registry.rb
+- lib/tryouts/expectation_evaluators/regular.rb
+- lib/tryouts/expectation_evaluators/result_type.rb
+- lib/tryouts/expectation_evaluators/true.rb
 - lib/tryouts/file_processor.rb
 - lib/tryouts/prism_parser.rb
+- lib/tryouts/test_batch.rb
+- lib/tryouts/test_case.rb
 - lib/tryouts/test_executor.rb
 - lib/tryouts/test_runner.rb
-- lib/tryouts/testbatch.rb
-- lib/tryouts/testcase.rb
 - lib/tryouts/translators/minitest_translator.rb
 - lib/tryouts/translators/rspec_translator.rb
 - lib/tryouts/version.rb
@@ -104,14 +117,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.4'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby tests that read like documentation.
 test_files: []