canon 0.3.26 → 0.3.28

data/lib/canon/rspec_matchers.rb

@@ -4,6 +4,9 @@ require "canon" unless defined?(Canon)
 require "canon/comparison"
 require "canon/diff_formatter"
 require "canon/config"
+require "canon/rebaseliner"
+require "canon/pretty_printer/xml"
+require "canon/pretty_printer/html"
 
 begin
   require "rspec/expectations"
@@ -88,60 +91,135 @@ module Canon
       end
 
       def matches?(target)
+        # Capture caller_locations only when rebaseliner is enabled so that
+        # passing assertions don't pay for stack walking.
+        @rebaseliner_caller = caller_locations(1, 12) if Canon::Rebaseliner.enabled?
+        equivalent = compute_equivalent(target)
+        return true if equivalent
+
+        attempt_rebaseline
+      end
+
+      # Skip the rebaseliner path for `.not_to`. RSpec invokes
+      # `does_not_match?` if defined, instead of negating `matches?`.
+      def does_not_match?(target)
+        !compute_equivalent(target)
+      end
+
+      def failure_message
+        "expected #{format_name} to be equivalent\n\n#{diff_output}"
+      end
+
+      def failure_message_when_negated
+        "expected #{format_name} not to be equivalent"
+      end
+
+      def expected
+        @expected
+      end
+
+      def actual
+        @target
+      end
+
+      def diffable # rubocop:disable Naming/PredicateMethod
+        false
+      end
+
+      private
+
+      # Run the actual comparison and set @target / @comparison_result.
+      # Returns the boolean equivalence result.
+      def compute_equivalent(target)
         @target = target
 
-        # Build comparison options from config and matcher params
         opts = build_comparison_options
-
-        # Add format hint if explicitly provided
         opts[:format] = @format if @format
 
-        # Delegate to Canon::Comparison.equivalent? - the SINGLE source of truth
-        # Comparison handles format detection, HTML parsing, and all business logic
         @comparison_result = Canon::Comparison.equivalent?(
           @expected,
           @target,
           opts,
         )
 
-        # When verbose: true, result is a ComparisonResult object
-        # Use the equivalent? method to check for normative differences
         case @comparison_result
         when Canon::Comparison::ComparisonResult
           @comparison_result.equivalent?
         when Hash
-          # Legacy format - Hash with :differences array and :preprocessed strings
           @comparison_result[:differences].empty?
         when Array
-          # Legacy format - XML/JSON/YAML returns []
           @comparison_result.empty?
         else
-          # Boolean result
           @comparison_result
         end
       end
 
-      def failure_message
-        "expected #{format_name} to be equivalent\n\n#{diff_output}"
-      end
+      # When the rebaseliner env var is on and the comparison failed, try to
+      # rewrite the heredoc that backs the expected value. Returns `true` to
+      # the matcher (so the assertion is treated as passing) when a rewrite
+      # succeeded; otherwise `false` so the normal failure path runs.
+      def attempt_rebaseline
+        return false unless Canon::Rebaseliner.enabled?
+        return false unless @rebaseliner_caller
 
-      def failure_message_when_negated
-        "expected #{format_name} not to be equivalent"
-      end
+        frame = first_user_frame(@rebaseliner_caller)
+        return false unless frame
 
-      def expected
-        @expected
+        prettyprinted = pretty_print_actual
+        return false unless prettyprinted
+
+        status = Canon::Rebaseliner.rewrite!(
+          spec_path: frame.absolute_path || frame.path,
+          line: frame.lineno,
+          prettyprinted_actual: prettyprinted,
+        )
+        status == :rewritten
+      rescue StandardError => e
+        Canon::Rebaseliner::Logger.log(
+          :error,
+          spec_path: frame&.path.to_s,
+          line: frame&.lineno.to_i,
+          detail: "#{e.class}: #{e.message}",
+        )
+        false
       end
 
-      def actual
-        @target
+      # Drop frames inside RSpec internals and canon itself; the first
+      # remaining is the user's spec file.
+      def first_user_frame(locations)
+        locations.find do |loc|
+          path = loc.absolute_path || loc.path
+          next false unless path
+          next false if %r{/gems/rspec-(expectations|core|mocks|support)-}.match?(path)
+          next false if %r{/lib/rspec/(expectations|core|mocks|support)/}.match?(path)
+          next false if path.include?("/canon/lib/canon/")
+          next false if path.end_with?("/lib/canon/rspec_matchers.rb")
+
+          true
+        end
       end
 
-      def diffable # rubocop:disable Naming/PredicateMethod
-        false
+      # Format the actual value with the appropriate pretty-printer for the
+      # heredoc rewrite. Returns nil when no prettyprinter is wired (e.g.
+      # JSON/YAML in v1).
+      def pretty_print_actual
+        fmt = @format || detect_format
+        case fmt
+        when :xml
+          Canon::PrettyPrinter::Xml.new.format(@target.to_s)
+        when :html, :html4, :html5
+          # fixture_ready: true emits actually-indented XHTML-shaped
+          # output suitable for direct paste into a heredoc.
+          Canon::PrettyPrinter::Html.new(fixture_ready: true)
+            .format(@target.to_s)
+        end
       end
 
-      private
+      def detect_format
+        Canon::Comparison::FormatDetector.detect(@expected)
+      rescue StandardError
+        nil
+      end
 
       def format_name
         # Use explicitly provided format if available

data/lib/canon/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Canon
-  VERSION = "0.3.26"
+  VERSION = "0.3.28"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canon
 version: !ruby/object:Gem::Version
-  version: 0.3.26
+  version: 0.3.28
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-09-07 00:00:00.000000000 Z
+date: 2026-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs
@@ -187,6 +187,7 @@ files:
 - docs/features/match-options/index.adoc
 - docs/features/match-options/pretty-printed-fixtures.adoc
 - docs/features/performance.adoc
+- docs/features/regenerate-expected.adoc
 - docs/getting-started/index.adoc
 - docs/getting-started/quick-start.adoc
 - docs/guides/choosing-configuration.adoc
@@ -342,6 +343,13 @@ files:
 - lib/canon/pretty_printer/json.rb
 - lib/canon/pretty_printer/xml.rb
 - lib/canon/pretty_printer/xml_normalized.rb
+- lib/canon/rebaseliner.rb
+- lib/canon/rebaseliner/atomic_writer.rb
+- lib/canon/rebaseliner/call_site_resolver.rb
+- lib/canon/rebaseliner/heredoc_locator.rb
+- lib/canon/rebaseliner/heredoc_rewriter.rb
+- lib/canon/rebaseliner/heredoc_target.rb
+- lib/canon/rebaseliner/logger.rb
 - lib/canon/rspec_matchers.rb
 - lib/canon/tree_diff.rb
 - lib/canon/tree_diff/adapters.rb