Engine: Add helpers to compare compiled/rendered outputs of the Engine#774
Merged
Engine: Add helpers to compare compiled/rendered outputs of the Engine#774
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commit adds comprehensive tooling to compare
Herb::Engine's output againstErubi::Enginefor both the compiled templates and the rendered templates.It introduces three CLI tools:
bin/comparefor full comparisons,bin/compare-compilefor compiled source comparisons, andbin/compare-renderfor rendered output comparisons.All tools use
difftasticto provide rich diffs showing both string-level and semantic differences (Ruby AST for compiled code, HTML structure for rendered output).It also adds these helpers in
snapshot_utils.rbso we can also run the comparison for allassert_evaluated_snapshotandassert_compiled_snapshotin the test suite usingCOMPARE_WITH_ERUBI=trueErubi compatibility is critical for Herb's adoption. Erubi is the de facto standard ERB implementation used across the Ruby ecosystem, particularly in Rails.
These comparison helpers serve as both documentation and verification of our compatibility commitment. They help catch regressions during development and make it trivial to investigate any differences between implementations.