| 📍 NOTE |
|---|
| RubyGems (the GitHub org, not the website) suffered a hostile takeover in September 2025. |
| Ultimately 4 maintainers were hard removed and a reason has been given for only 1 of those, while 2 others resigned in protest. |
| It is a complicated story which is difficult to parse quickly. |
| Simply put - there was active policy for adding or removing maintainers/owners of rubygems and bundler, and those policies were not followed. |
| I'm adding notes like this to gems because I don't condone theft of repositories or gems from their rightful owners. |
| If a similar theft happened with my repos/gems, I'd hope some would stand up for me. |
| Disenfranchised former-maintainers have started gem.coop. |
| Once available I will publish there exclusively; unless RubyCentral makes amends with the community. |
| The "Technology for Humans: Joel Draper" podcast episode by reinteractive is the most cogent summary I'm aware of. |
| See here, here and here for more info on what comes next. |
| What I'm doing: A (WIP) proposal for bundler/gem scopes, and a (WIP) proposal for a federated gem server. |
☯️ Prism::Merge
if ci_badges.map(&:color).detect { it != "green"} ☝️ let me know, as I may have missed the discord notification.
if ci_badges.map(&:color).all? { it == "green"} 👇️ send money so I can do more of this. FLOSS maintenance is now my full-time job.
🌻 Synopsis
Prism::Merge is a standalone Ruby module that intelligently merges two versions of a Ruby file using Prism AST analysis. It's like a smart "git merge" specifically designed for Ruby code. I wrote this to aid in my comprehensive gem templating tool kettle-dev.
Key Features
- AST-Aware: Uses Prism parser to understand Ruby structure
- Intelligent: Matches nodes by structural signatures
- Recursive Merge: Automatically merges class and module bodies recursively, intelligently combining nested methods and constants
- Comment-Preserving: Comments are properly attached to relevant nodes and/or placement
- Freeze Block Support: Respects freeze markers (default:
prism-merge:freeze/prism-merge:unfreeze) for template merge control - customizable to match your project's conventions - Full Provenance: Tracks origin of every line
- Standalone: No dependencies other than
prismandversion_gem(which is a tiny tool all my gems depend on) - Customizable:
signature_generator- callable custom signature generatorssignature_match_preference- setting of:templateor:destinationadd_template_only_nodes- setting to retain nodes that do not exist in destinationfreeze_token- customize freeze block markers (default:"prism-merge")
Example
require "prism/merge"
template = File.read("template.rb")
destination = File.read("destination.rb")
merger = Prism::Merge::SmartMerger.new(template, destination)
result = merger.merge
File.write("merged.rb", result)
💡 Info you can shake a stick at
| Tokens to Remember | |
|---|---|
| Works with JRuby | |
| Works with Truffle Ruby | |
| Works with MRI Ruby 3 | |
| Works with MRI Ruby 2 | |
| Support & Community | |
| Source | |
| Documentation | |
| Compliance | |
| Style | |
| Maintainer 🎖️ | |
... 💖 |
Compatibility
Compatible with MRI Ruby 2.7.0+, and concordant releases of JRuby, and TruffleRuby.
| 🚚 Amazing test matrix was brought to you by | 🔎 appraisal2 🔎 and the color 💚 green 💚 |
|---|---|
| 👟 Check it out! | ✨ github.com/appraisal-rb/appraisal2 ✨ |
Federated DVCS
Find this repo on federated forges (Coming soon!)
| Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions | |-------------------------------------------------|-----------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------| | 🧪 [kettle-rb/prism-merge on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix | ➖ | | 🧊 [kettle-rb/prism-merge on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix | ➖ | | 🐙 [kettle-rb/prism-merge on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix | [💚][gh-discussions] | | 🎮️ [Discord Server][✉️discord-invite] | [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] | [Let's][✉️discord-invite] | [talk][✉️discord-invite] | [about][✉️discord-invite] | [this][✉️discord-invite] | [library!][✉️discord-invite] |Enterprise Support 
Available as part of the Tidelift Subscription.
Need enterprise-level guarantees?
The maintainers of this and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. [![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift] - 💡Subscribe for support guarantees covering _all_ your FLOSS dependencies - 💡Tidelift is part of [Sonar][🏙️entsup-tidelift-sonar] - 💡Tidelift pays maintainers to maintain the software you depend on!📊`@`Pointy Haired Boss: An [enterprise support][🏙️entsup-tidelift] subscription is "[never gonna let you down][🧮kloc]", and *supports* open source maintainers Alternatively: - [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] - [![Get help from me on Upwork][👨🏼🏫expsup-upwork-img]][👨🏼🏫expsup-upwork] - [![Get help from me on Codementor][👨🏼🏫expsup-codementor-img]][👨🏼🏫expsup-codementor]
✨ Installation
Install the gem and add to the application's Gemfile by executing:
bundle add prism-merge
If bundler is not being used to manage dependencies, install the gem by executing:
gem install prism-merge
🔒 Secure Installation
For Medium or High Security Installations
This gem is cryptographically signed, and has verifiable [SHA-256 and SHA-512][💎SHA_checksums] checksums by [stone_checksums][💎stone_checksums]. Be sure the gem you install hasn’t been tampered with by following the instructions below. Add my public key (if you haven’t already, expires 2045-04-29) as a trusted certificate: ```console gem cert --add <(curl -Ls https://raw.github.com/galtzo-floss/certs/main/pboling.pem) ``` You only need to do that once. Then proceed to install with: ```console gem install prism-merge -P HighSecurity ``` The `HighSecurity` trust profile will verify signed gems, and not allow the installation of unsigned dependencies. If you want to up your security game full-time: ```console bundle config set --global trust-policy MediumSecurity ``` `MediumSecurity` instead of `HighSecurity` is necessary if not all the gems you use are signed. NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.⚙️ Configuration
Prism::Merge works out of the box with zero configuration, but offers customization options for advanced use cases.
Signature Match Preference
Control which version to use when nodes have matching signatures but different content:
# Use template version (for version files, configs where template has updates)
merger = Prism::Merge::SmartMerger.new(
template,
destination,
signature_match_preference: :template,
)
# Use destination version (for Appraisals, configs with customizations)
merger = Prism::Merge::SmartMerger.new(
template,
destination,
signature_match_preference: :destination, # This is the default
)
When to use each:
:template- Template contains canonical/updated values- Version files (
VERSION = "2.0.0"should replaceVERSION = "1.0.0") - Configuration updates (
API_ENDPOINTshould be updated) - Conditional bodies (
if ENV["DEBUG"]should use template's implementation)
- Version files (
:destination(default) - Destination contains customizations- Appraisals files (destination has project-specific gem versions)
- Project-specific configurations
- Custom implementations
Template-Only Nodes
Control whether to add nodes that only exist in the template:
# Add template-only nodes (for merging new features/constants)
merger = Prism::Merge::SmartMerger.new(
template,
destination,
add_template_only_nodes: true,
)
# Skip template-only nodes (for templates with placeholder content)
merger = Prism::Merge::SmartMerger.new(
template,
destination,
add_template_only_nodes: false, # This is the default
)
When to use each:
true- Template has new content to add- New constants (
NAME = "myapp"should be added to destination) - New methods/classes from template
- Required configuration options
- New constants (
false(default) - Template has placeholder/example content- Appraisals templates with ruby version blocks not in destination
- Example configurations that shouldn't be added
- Template-only nodes would create unwanted additions
Combined Configuration
For different merge scenarios:
# Scenario 1: Version file merge (template wins, add new constants)
merger = Prism::Merge::SmartMerger.new(
template_content,
dest_content,
signature_match_preference: :template,
add_template_only_nodes: true,
)
# Result: VERSION updated to template value, NAME constant added
# Scenario 2: Appraisals merge (destination wins, skip template-only blocks)
merger = Prism::Merge::SmartMerger.new(
template_content,
dest_content,
signature_match_preference: :destination, # default
add_template_only_nodes: false, # default
)
# Result: Destination gem versions preserved, template-only ruby blocks skipped
# Scenario 3: Config merge (mix and match)
merger = Prism::Merge::SmartMerger.new(
template_content,
dest_content,
signature_match_preference: :destination, # Keep custom values
add_template_only_nodes: true, # But add new required configs
)
# Result: Existing configs keep destination values, new configs added from template
Recursion Depth Limit
Prism::Merge automatically detects when block bodies contain only literals or simple expressions (no mergeable statements) and treats them atomically. However, as a safety valve for edge cases, you can limit recursion depth:
# Limit recursive merging to 3 levels deep
merger = Prism::Merge::SmartMerger.new(
template,
destination,
max_recursion_depth: 3,
)
# Disable recursive merging entirely (treat all nodes atomically)
merger = Prism::Merge::SmartMerger.new(
template,
destination,
max_recursion_depth: 0,
)
When to use:
Float::INFINITY(default) - Normal operation, recursion terminates naturally based on content analysis.- NOTE: If you get
stack level too deep (SystemStackError), please file a bug!
- NOTE: If you get
- Finite value - Safety valve if you encounter edge cases with unexpected deep recursion
0- Disable recursive merging entirely; all matching nodes are treated atomically
Custom Signature Generator
By default, Prism::Merge uses intelligent structural signatures to match nodes. The signature determines how nodes are matched between template and destination files.
Default Signature Matching
| Node Type | Signature Format | Matching Behavior |
|---|---|---|
DefNode |
[:def, name, params] |
Methods match by name and parameter names |
ClassNode |
[:class, name] |
Classes match by name |
ModuleNode |
[:module, name] |
Modules match by name |
SingletonClassNode |
[:singleton_class, expr] |
Singleton classes match by expression (class << self) |
ConstantWriteNode |
[:const, name] |
Constants match by name only (not value) |
ConstantPathWriteNode |
[:const, target] |
Namespaced constants match by full path |
LocalVariableWriteNode |
[:local_var, name] |
Local variables match by name |
InstanceVariableWriteNode |
[:ivar, name] |
Instance variables match by name |
ClassVariableWriteNode |
[:cvar, name] |
Class variables match by name |
GlobalVariableWriteNode |
[:gvar, name] |
Global variables match by name |
MultiWriteNode |
[:multi_write, targets] |
Multiple assignment matches by target names |
IfNode / UnlessNode |
[:if, condition] |
Conditionals match by condition expression |
CaseNode |
[:case, predicate] |
Case statements match by the expression being switched |
CaseMatchNode |
[:case_match, predicate] |
Pattern matching cases match by expression |
WhileNode / UntilNode |
[:while, condition] |
Loops match by condition |
ForNode |
[:for, index, collection] |
For loops match by index variable and collection |
BeginNode |
[:begin, first_stmt] |
Begin blocks match by first statement (partial) |
CallNode (regular) |
[:call, name, first_arg] |
Method calls match by name and first argument |
CallNode (assignment) |
[:call, :method=, receiver] |
Assignment calls (x.y = z) match by receiver, not value |
CallNode (with block) |
[:call_with_block, name, first_arg] |
Block calls match by name and first argument |
SuperNode |
[:super, :with_block] |
Super calls match by presence of block |
LambdaNode |
[:lambda, params] |
Lambdas match by parameter signature |
PreExecutionNode |
[:pre_execution, line] |
BEGIN blocks match by line number |
PostExecutionNode |
[:post_execution, line] |
END blocks match by line number |
Recursive Merge Support
The following node types support recursive body merging, where nested content is intelligently combined:
ClassNode- class bodies are recursively mergedModuleNode- module bodies are recursively mergedSingletonClassNode- singleton class bodies are recursively mergedCallNodewith block - block bodies are recursively merged only when the body contains mergeable statements (e.g.,describe do ... endwith nesteditblocks). Blocks containing only literals or simple expressions (likegit_source(:github) { |repo| "https://..." }) are treated atomically.BeginNode- begin/rescue/ensure blocks are recursively merged
Custom Signature Generator
You can provide a custom signature generator to control how nodes are matched between template and destination files. The signature generator is a callable (lambda/proc) that receives a Prism::Node (or FreezeNode) and returns one of three types of values:
| Return Value | Behavior |
|---|---|
Array (e.g., [:gem, "foo"]) |
Used as the node's signature for matching. Nodes with identical signatures are considered matches. |
nil |
The node gets no signature and won't be matched by signature. Useful for nodes you want to skip or handle specially. |
Prism::Node or FreezeNode |
Falls through to the default signature computation using the returned node. Return the original node unchanged for simple fallthrough, or return a modified node to influence default matching. |
Basic Example
signature_generator = lambda do |node|
case node
when Prism::CallNode
# Match method calls by name only, ignoring arguments
[:call, node.name]
when Prism::DefNode
# Match method definitions by name and parameters
[:def, node.name, node.parameters&.slice]
when Prism::ClassNode
# Match classes by name
[:class, node.constant_path.slice]
else
# Default matching - return node to fall through
node
end
end
Fallthrough Example (Recommended Pattern)
The fallthrough pattern allows you to customize only specific node types while delegating everything else to the built-in signature logic:
signature_generator = ->(node) {
# Only customize CallNode signatures for specific methods
if node.is_a?(Prism::CallNode)
# source() calls - match by method name only (there's usually just one)
return [:source] if node.name == :source
# gem() calls - match by gem name (first argument)
if node.name == :gem
first_arg = node.arguments&.arguments&.first
if first_arg.is_a?(Prism::StringNode)
return [:gem, first_arg.unescaped]
end
end
end
# Return the node to fall through to default signature computation
# This preserves correct handling for FreezeNodes, classes, modules, etc.
node
}
merger = Prism::Merge::SmartMerger.new(
template_content,
destination_content,
signature_generator: signature_generator,
signature_match_preference: :template,
add_template_only_nodes: true,
)
Why Fallthrough Matters
When you provide a custom signature generator, it's called for all node types, including internal types like FreezeNode. If your generator returns nil for node types it doesn't recognize, those nodes won't be matched properly:
# ❌ Bad: Returns nil for unrecognized nodes
signature_generator = ->(node) {
return unless node.is_a?(Prism::CallNode) # FreezeNodes get nil!
[:call, node.name]
}
# ✅ Good: Falls through for unrecognized nodes
signature_generator = ->(node) {
if node.is_a?(Prism::CallNode)
return [:call, node.name]
end
node # FreezeNodes and others use default signatures
}
Freeze Blocks
Protect sections in the destination file from being overwritten by the template using freeze markers.
By default, Prism::Merge uses prism-merge as the freeze token:
# In your destination.rb file
# prism-merge:freeze
gem "custom-gem", path: "../custom"
# Add any custom configuration you want to preserve
# prism-merge:unfreeze
You can customize the freeze token to match your project's conventions:
# Use a custom freeze token (e.g., for kettle-dev projects)
merger = Prism::Merge::SmartMerger.new(
template,
destination,
freeze_token: "kettle-dev", # Now uses # kettle-dev:freeze / # kettle-dev:unfreeze
)
Freeze blocks are always preserved from the destination file during merge, regardless of template content. They can be placed inside:
- Class and module bodies (
class Foo ... end,module Bar ... end) - Singleton class bodies (
class << self ... end) - Method definitions (
def method_name ... end) - Lambda/proc bodies (
-> { ... }) - Block-based DSLs (e.g., RSpec
describe/contextblocks)
This allows you to protect entire methods, portions of method implementations, or sections within DSL blocks.
Integration with Existing Systems
If you're integrating with an existing system that has its own signature logic:
# Use your existing signature function
my_signature_func = ->(node) { MySystem.calculate_signature(node) }
merger = Prism::Merge::SmartMerger.new(
template,
destination,
signature_generator: my_signature_func,
)
🔧 Basic Usage
Simple Merge
The most basic usage merges two Ruby files:
require "prism/merge"
template = File.read("template.rb")
destination = File.read("destination.rb")
merger = Prism::Merge::SmartMerger.new(template, destination)
result = merger.merge
File.write("merged.rb", result)
Understanding the Merge
Prism::Merge intelligently combines files by:
- Finding Anchors: Identifies matching sections between files
- Detecting Boundaries: Locates areas where files differ
- Resolving Conflicts: Uses structural signatures to merge differences
- Preserving Context: Maintains comments and freeze blocks
Example:
# template.rb
VERSION = "2.0.0"
def greet(name)
puts "Hello, #{name}!"
end
# destination.rb
VERSION = "1.0.0"
def greet(name)
puts "Hello, #{name}!"
end
def custom_method
# This is destination-only
end
# After merge:
# - VERSION from template (2.0.0) replaces destination (1.0.0)
# - greet method matches, template version kept
# - custom_method is preserved (destination-only)
How Prism::Merge Compares to Other Merge Strategies
Prism::Merge uses a single-pass, AST-aware algorithm that differs fundamentally from line-based merge tools like git merge and IDE smart merges:
| Aspect | Git Merge (3-way) | IDE Smart Merge | Prism::Merge |
|---|---|---|---|
| Input | 3 files (base, ours, theirs) | 2-3 files | 2 files (template, destination) |
| Unit of comparison | Lines of text | Lines + some syntax awareness | AST nodes (Ruby structures) |
| Passes | Multi-pass (LCS algorithm) | Multi-pass | Single-pass with anchors |
| Conflict handling | Manual resolution with markers (<<<<<<<) |
Interactive resolution | Automatic via signature matching |
| Language awareness | None (text-only) | Basic (indentation, brackets) | Full Ruby AST understanding |
| Comment handling | Treated as text | Treated as text | Attached to relevant nodes |
| Structural matching | Line equality only | Line + heuristics | Node signatures (type + identifier) |
| Recursive merge | No | Sometimes | Yes (class/module bodies) |
| Freeze blocks | No | No | Yes (preserve destination sections) |
Key Differences Explained
Git Merge (3-way merge):
- Requires a common ancestor (base) to detect changes from each side
- Uses Longest Common Subsequence (LCS) algorithm in multiple passes
- Produces conflict markers when both sides modify the same lines
- Language-agnostic: treats Ruby, Python, and prose identically
IDE Smart Merge:
- Often uses 3-way merge as foundation
- Adds heuristics for common patterns (moved blocks, reformatting)
- May understand basic syntax for better conflict detection
- Still fundamentally line-based with enhancements
Prism::Merge:
- Uses 2 files: template (source of truth) and destination (customized version)
- Single-pass algorithm that builds a timeline of anchors (matches) and boundaries (differences)
- Matches by structural signature (e.g.,
[:def, :method_name]), not line content - Automatically resolves conflicts based on configurable preference
- Never produces conflict markers - always produces valid, runnable Ruby
When to Use Each
| Scenario | Best Tool |
|---|---|
| Merging git branches with divergent changes | Git Merge |
| Resolving complex conflicts interactively | IDE Smart Merge |
| Updating project files from a template | Prism::Merge |
| Maintaining customizations across template updates | Prism::Merge |
| Merging non-Ruby files | Git Merge / IDE |
With Debug Information
Get detailed information about merge decisions:
merger = Prism::Merge::SmartMerger.new(template, destination)
debug_result = merger.merge_with_debug
puts debug_result[:content] # Final merged content
puts debug_result[:statistics] # Decision counts
puts debug_result[:debug] # Line-by-line provenance
The debug output shows:
debug_result[:statistics]
# => {
# kept_template: 42, # Lines from template (no conflict)
# kept_destination: 8, # Lines from destination (no conflict)
# replaced: 5, # Template replaced matching destination
# appended: 3, # Destination-only content added
# freeze_block: 2 # Lines from freeze blocks
# }
Error Handling
Prism::Merge raises exceptions when files have syntax errors:
begin
merger = Prism::Merge::SmartMerger.new(template, destination)
result = merger.merge
rescue Prism::Merge::TemplateParseError => e
puts "Template has syntax errors"
puts "Content: #{e.content}"
puts "Parse errors: #{e.parse_result.errors}"
rescue Prism::Merge::DestinationParseError => e
puts "Destination has syntax errors"
puts "Content: #{e.content}"
puts "Parse errors: #{e.parse_result.errors}"
end
Validating Before Merge
Check if files are valid before attempting a merge:
template_analysis = Prism::Merge::FileAnalysis.new(template_content)
dest_analysis = Prism::Merge::FileAnalysis.new(dest_content)
if template_analysis.valid? && dest_analysis.valid?
merger = Prism::Merge::SmartMerger.new(template_content, dest_content)
result = merger.merge
else
puts "Files have syntax errors" unless template_analysis.valid?
puts "Cannot merge"
end
Working with Freeze Blocks
Protect custom sections from template updates:
# destination.rb
class MyApp
# prism-merge:freeze
CUSTOM_CONFIG = {
api_key: ENV.fetch("API_KEY"),
endpoint: "https://custom.example.com",
}
# prism-merge:unfreeze
VERSION = "1.0.0"
end
# template.rb
class MyApp
CUSTOM_CONFIG = {} # Template wants to reset this
VERSION = "2.0.0"
end
# Merge with default freeze token
merger = Prism::Merge::SmartMerger.new(template, destination)
result = merger.merge
# Or use a custom freeze token if your project uses a different convention
merger = Prism::Merge::SmartMerger.new(
template,
destination,
freeze_token: "kettle-dev", # for kettle-dev projects
)
result = merger.merge
# After merge, CUSTOM_CONFIG keeps destination values
# but VERSION is updated to 2.0.0
Advanced: Inspect Merge Components
For debugging or understanding the merge process:
# Analyze files separately
template_analysis = Prism::Merge::FileAnalysis.new(template)
dest_analysis = Prism::Merge::FileAnalysis.new(destination)
puts "Template statements: #{template_analysis.statements.length}"
puts "Template freeze blocks: #{template_analysis.freeze_blocks.length}"
# See what anchors and boundaries are found
aligner = Prism::Merge::FileAligner.new(template_analysis, dest_analysis)
boundaries = aligner.align
puts "Anchors (matching sections): #{aligner.anchors.length}"
aligner.anchors.each do |anchor|
puts " Lines #{anchor.template_start}-#{anchor.template_end} match"
end
puts "Boundaries (differences): #{boundaries.length}"
boundaries.each do |boundary|
puts " Template #{boundary.template_range} vs Dest #{boundary.dest_range}"
end
Integration Example
Use Prism::Merge in your own templating system:
class MyTemplateEngine
def merge_ruby_file(template_path, destination_path)
template = File.read(template_path)
destination = File.exist?(destination_path) ? File.read(destination_path) : ""
merger = Prism::Merge::SmartMerger.new(template, destination)
merged_content = merger.merge
File.write(destination_path, merged_content)
# Return statistics for reporting
debug_result = merger.merge_with_debug
debug_result[:statistics]
rescue Prism::Merge::Error => e
puts "Merge failed: #{e.}"
# Fall back to template only
File.write(destination_path, template)
nil
end
end
Testing Your Merges
Example RSpec test:
require "prism/merge"
RSpec.describe("Ruby file merging") do
it "updates VERSION from template" do
template = <<~RUBY
VERSION = "2.0.0"
def hello; end
RUBY
destination = <<~RUBY
VERSION = "1.0.0"
def hello; end
def custom; end
RUBY
merger = Prism::Merge::SmartMerger.new(template, destination)
result = merger.merge
# Template version wins
expect(result).to(include('VERSION = "2.0.0"'))
# Destination-only method preserved
expect(result).to(include("def custom"))
end
it "preserves freeze blocks" do
template = <<~RUBY
CONFIG = {}
RUBY
destination = <<~RUBY
# prism-merge:freeze
CONFIG = { key: "secret" }
# prism-merge:unfreeze
RUBY
merger = Prism::Merge::SmartMerger.new(template, destination)
result = merger.merge
# Freeze block content preserved
expect(result).to(include('CONFIG = { key: "secret" }'))
end
it "works with custom freeze tokens" do
template = <<~RUBY
CONFIG = {}
RUBY
destination = <<~RUBY
# my-app:freeze
CONFIG = { key: "secret" }
# my-app:unfreeze
RUBY
merger = Prism::Merge::SmartMerger.new(
template,
destination,
freeze_token: "my-app", # Match your project's freeze token
)
result = merger.merge
# Freeze block content preserved
expect(result).to(include('CONFIG = { key: "secret" }'))
end
end
🦷 FLOSS Funding
While kettle-rb tools are free software and will always be, the project would benefit immensely from some funding. Raising a monthly budget of... "dollars" would make the project more sustainable.
We welcome both individual and corporate sponsors! We also offer a wide array of funding channels to account for your preferences (although currently Open Collective is our preferred funding platform).
If you're working in a company that's making significant use of kettle-rb tools we'd appreciate it if you suggest to your company to become a kettle-rb sponsor.
You can support the development of kettle-rb tools via GitHub Sponsors, Liberapay, PayPal, Open Collective and Tidelift.
| 📍 NOTE |
|---|
| If doing a sponsorship in the form of donation is problematic for your company from an accounting standpoint, we'd recommend the use of Tidelift, where you can get a support-like subscription instead. |
Open Collective for Individuals
Support us with a monthly donation and help us continue our activities. [Become a backer]
NOTE: kettle-readme-backers updates this list every day, automatically.
No backers yet. Be the first!
Open Collective for Organizations
Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]
NOTE: kettle-readme-backers updates this list every day, automatically.
No sponsors yet. Be the first!
Another way to support open-source
I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions. I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈 cats).
If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in bundle fund.
I’m developing a new library, floss_funding, designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.
Floss-Funding.dev: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags
🔐 Security
See SECURITY.md.
🤝 Contributing
If you need some ideas of where to help, you could work on adding more code coverage, or if it is already 💯 (see below) check reek, issues, or PRs, or use the gem and think about how it could be better.
We so if you make changes, remember to update it.
See CONTRIBUTING.md for more detailed instructions.
🚀 Release Instructions
See CONTRIBUTING.md.
Code Coverage
🪇 Code of Conduct
Everyone interacting with this project's codebases, issue trackers,
chat rooms and mailing lists agrees to follow the .
🌈 Contributors
Made with contributors-img.
Also see GitLab Contributors: https://gitlab.com/kettle-rb/prism-merge/-/graphs/main
📌 Versioning
This Library adheres to .
Violations of this scheme should be reported as bugs.
Specifically, if a minor or patch version is released that breaks backward compatibility,
a new version should be immediately released that restores compatibility.
Breaking changes to the public API will only be introduced with new major versions.
dropping support for a platform is both obviously and objectively a breaking change
—Jordan Harband (@ljharb, maintainer of SemVer) in SemVer issue 716
I understand that policy doesn't work universally ("exceptions to every rule!"), but it is the policy here. As such, in many cases it is good to specify a dependency on this library using the Pessimistic Version Constraint with two digits of precision.
For example:
spec.add_dependency("prism-merge", "~> 1.0")
📌 Is "Platform Support" part of the public API? More details inside.
SemVer should, IMO, but doesn't explicitly, say that dropping support for specific Platforms is a *breaking change* to an API, and for that reason the bike shedding is endless. To get a better understanding of how SemVer is intended to work over a project's lifetime, read this article from the creator of SemVer: - ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]See CHANGELOG.md for a list of releases.
📄 License
The gem is available as open source under the terms of
the MIT License .
See LICENSE.txt for the official Copyright Notice.
© Copyright
-
Copyright (c) 2025 Peter H. Boling, of
Galtzo.com
, and prism-merge contributors.
🤑 A request for help
Maintainers have teeth and need to pay their dentists. After getting laid off in an RIF in March, and encountering difficulty finding a new one, I began spending most of my time building open source tools. I'm hoping to be able to pay for my kids' health insurance this month, so if you value the work I am doing, I need your support. Please consider sponsoring me or the project.
To join the community or get help 👇️ Join the Discord.
To say "thanks!" ☝️ Join the Discord or 👇️ send money.
Please give the project a star ⭐ ♥.
Thanks for RTFM. ☺️