markly-merge 7.0.0 → 7.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/LICENSE.md +13 -0
- data/README.md +444 -0
- data/lib/markly/merge/backend.rb +288 -0
- data/lib/markly/merge/comment_tracker.rb +7 -0
- data/lib/markly/merge/debug_logger.rb +26 -0
- data/lib/markly/merge/file_analysis.rb +39 -0
- data/lib/markly/merge/freeze_node.rb +7 -0
- data/lib/markly/merge/partial_template_merger.rb +20 -0
- data/lib/markly/merge/smart_merger.rb +69 -0
- data/lib/markly/merge/version.rb +5 -3
- data/lib/markly/merge.rb +178 -146
- data/lib/markly-merge.rb +7 -1
- data/sig/markly/merge.rbs +8 -0
- data.tar.gz.sig +0 -0
- metadata +256 -13
- metadata.gz.sig +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 80562d2ee0b6e1d0e22b523b72cf0d2a6300d6d942b347a10edd7cf9a1651dd1
|
|
4
|
+
data.tar.gz: afa143c1b6e01ddb26ff22d3dcf46d10a9ce1e20afe4ee4f947ecfb6b6996b5d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 200e5f95de4b0b05d0e3c6eb2140c7f1a96a96522e95a7ebf58b749b14852be3508b274da72b570d429cf4c0ba6943097fec5655b6337f864fc38d956b53afcb
|
|
7
|
+
data.tar.gz: 02632f63e82870b679879739b81ebc03b1afe4cda1b7696ba9719773892871df6048565406dd25a18003f6e76f0dfefc7d8272d71de0bef19970ae8f45557af6
|
checksums.yaml.gz.sig
CHANGED
|
Binary file
|
data/LICENSE.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# License
|
|
2
|
+
|
|
3
|
+
This project is made available under the following licenses.
|
|
4
|
+
Choose the option that best fits your use case:
|
|
5
|
+
|
|
6
|
+
- [AGPL-3.0-only](https://github.com/structuredmerge/structuredmerge-ruby/blob/main/AGPL-3.0-only.md)
|
|
7
|
+
- [PolyForm-Small-Business-1.0.0](https://github.com/structuredmerge/structuredmerge-ruby/blob/main/PolyForm-Small-Business-1.0.0.md)
|
|
8
|
+
|
|
9
|
+
If none of the above licenses fit your use case, please [contact us](mailto:floss@galtzo.com) to discuss a custom commercial license.
|
|
10
|
+
|
|
11
|
+
## Copyright Notice
|
|
12
|
+
|
|
13
|
+
- Required Notice: Copyright (c) 2026 Peter H. Boling
|
data/README.md
ADDED
|
@@ -0,0 +1,444 @@
|
|
|
1
|
+
<a href="https://github.com/structuredmerge"><img alt="structuredmerge Logo by GitHub" src="https://github.com/structuredmerge.png?size=192" width="14%" align="right"/></a>
|
|
2
|
+
|
|
3
|
+
# ☯️ Markly::Merge
|
|
4
|
+
|
|
5
|
+
[![Version][👽versioni]][👽version] [![Ruby Users Forum][✉️ruby-forum-top-img]][✉️ruby-forum] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: AGPL-3.0-only OR PolyForm-Small-Business-1.0.0][📄license-img]][📄license] [![Total downloads][👽dl-ranki]][👽dl-rank] [![CI Current][🚎11-c-wfi]][🚎11-c-wf]
|
|
6
|
+
|
|
7
|
+
`if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know on Discord][✉️discord-invite] or [RubyForum][✉️ruby-forum], as I may have missed the notification.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
`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.
|
|
12
|
+
|
|
13
|
+
[![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate at ko-fi.com][🖇kofi-img]][🖇kofi]
|
|
14
|
+
|
|
15
|
+
<details markdown="1">
|
|
16
|
+
<summary>👣 How will this project approach the September 2025 hostile takeover of RubyGems? 🚑️</summary>
|
|
17
|
+
|
|
18
|
+
I've summarized my thoughts in [this blog post](https://dev.to/galtzo/hostile-takeover-of-rubygems-my-thoughts-5hlo).
|
|
19
|
+
|
|
20
|
+
</details>
|
|
21
|
+
|
|
22
|
+
## 🌻 Synopsis <a href="https://discord.gg/3qme4XHNKN"><img alt="Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0" src="https://logos.galtzo.com/assets/images/galtzo-floss/avatar-128px.svg" width="8%" align="right"/></a> <a href="https://ruby-toolbox.com"><img alt="ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5" src="https://logos.galtzo.com/assets/images/ruby-lang/avatar-128px.svg" width="8%" align="right"/></a>
|
|
23
|
+
|
|
24
|
+
`markly-merge` is a thin wrapper around [markdown-merge][markdown-merge] that provides:
|
|
25
|
+
|
|
26
|
+
- **Hard dependency on Markly** - Ensures the libcmark-gfm (C) parser is installed
|
|
27
|
+
- **Markly-specific defaults** - Freeze token: `"markly-merge"`, `inner_merge_code_blocks: true`
|
|
28
|
+
- **Markly parse options** - Pass `flags:` and `extensions:` parameters
|
|
29
|
+
For an alternative using Comrak (Rust), see [commonmarker-merge][commonmarker-merge].
|
|
30
|
+
|
|
31
|
+
### Features (via markdown-merge)
|
|
32
|
+
|
|
33
|
+
- **Markly-Powered**: Uses libcmark-gfm for accurate CommonMark + GFM parsing
|
|
34
|
+
- **Structure-Aware**: Understands headings, lists, code blocks, tables, and more
|
|
35
|
+
- **Intelligent**: Matches sections by heading structure and content signatures
|
|
36
|
+
- **Comment-Preserving**: HTML comments are preserved in context
|
|
37
|
+
- **Freeze Block Support**: Respects freeze markers (default: `markly-merge:freeze` / `markly-merge:unfreeze`) for merge control - customizable to match your project's conventions
|
|
38
|
+
- **Type Normalization**: Canonical node types work across all markdown backends
|
|
39
|
+
- **Full Provenance**: Tracks origin of every node
|
|
40
|
+
- **Inner-Merge Code Blocks**: Enabled by default - merges fenced code blocks using language-specific mergers
|
|
41
|
+
- **Customizable**:
|
|
42
|
+
- `signature_generator` - callable custom signature generators
|
|
43
|
+
- `preference` - setting of `:template`, `:destination`, or a Hash for per-node-type preferences
|
|
44
|
+
- `add_template_only_nodes` - setting to retain sections that do not exist in destination
|
|
45
|
+
- `freeze_token` - customize freeze block markers (default: `"markly-merge"`)
|
|
46
|
+
- `flags` - Markly parse flags (e.g., `Markly::FOOTNOTES`, `Markly::SMART`)
|
|
47
|
+
- `extensions` - GFM extensions (`:table`, `:strikethrough`, `:autolink`, `:tagfilter`, `:tasklist`)
|
|
48
|
+
|
|
49
|
+
### Removal Mode Scope
|
|
50
|
+
|
|
51
|
+
`remove_template_missing_nodes: true` in `markly-merge` follows the shared `markdown-merge` full-document contract:
|
|
52
|
+
|
|
53
|
+
- removes **top-level destination-only structural blocks**
|
|
54
|
+
- preserves **standalone HTML comment-only fragments**, **link reference definitions**, and **freeze blocks**
|
|
55
|
+
- preserves **one separator blank line** when removed structural content collapses around a kept standalone HTML comment fragment
|
|
56
|
+
- does **not** yet define generic inline-comment promotion or recursive/nested section-removal semantics
|
|
57
|
+
|
|
58
|
+
Section-local `replace_mode` / partial-template behavior still follows its own conservative Markdown rules and should not be assumed to inherit the same recursive removal contract as full-document smart merge.
|
|
59
|
+
|
|
60
|
+
### Supported Node Types
|
|
61
|
+
|
|
62
|
+
| Node Type | Signature Format | Matching Behavior |
|
|
63
|
+
|----------------|---------------------------------|----------------------------------------------------|
|
|
64
|
+
| Heading | `[:heading, level, text]` | Headings match by level and text content |
|
|
65
|
+
| Paragraph | `[:paragraph, text_hash]` | Paragraphs match by content hash |
|
|
66
|
+
| List | `[:list, type, item_count]` | Lists match by type (bullet/ordered) and structure |
|
|
67
|
+
| List Item | `[:list_item, content_sig]` | Items match by content signature |
|
|
68
|
+
| Code Block | `[:code_block, language, info]` | Code blocks match by language and info string |
|
|
69
|
+
| Block Quote | `[:block_quote, content_sig]` | Block quotes match by content signature |
|
|
70
|
+
| Table | `[:table, header_sig]` | Tables match by header structure |
|
|
71
|
+
| HTML Block | `[:html_block, content]` | HTML blocks match by content |
|
|
72
|
+
| Thematic Break | `[:thematic_break]` | Horizontal rules always match |
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
|
|
76
|
+
```ruby
|
|
77
|
+
require "markly/merge"
|
|
78
|
+
|
|
79
|
+
template = File.read("template.md")
|
|
80
|
+
destination = File.read("destination.md")
|
|
81
|
+
|
|
82
|
+
merger = Markly::Merge::SmartMerger.new(template, destination)
|
|
83
|
+
result = merger.merge
|
|
84
|
+
|
|
85
|
+
File.write("merged.md", result.to_markdown)
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
[markdown-merge]: https://github.com/structuredmerge/structuredmerge-ruby/tree/main/gems/markdown-merge
|
|
89
|
+
[commonmarker-merge]: https://github.com/structuredmerge/structuredmerge-ruby/tree/main/gems/commonmarker-merge
|
|
90
|
+
|
|
91
|
+
## 💡 Info you can shake a stick at
|
|
92
|
+
|
|
93
|
+
| Tokens to Remember | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace] |
|
|
94
|
+
|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
95
|
+
| Works with MRI Ruby 4 | [![Ruby current Compat][💎ruby-c-i]][🚎11-c-wf]|
|
|
96
|
+
| Support & Community | [![Join Me on Daily.dev's RubyFriends][✉️ruby-friends-img]][✉️ruby-friends] [![Get help from RubyForum][✉️ruby-forum-img]][✉️ruby-forum] [![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] |
|
|
97
|
+
| Source | [![Source on GitLab.com][📜src-gl-img]][📜src-gl] [![Source on CodeBerg.org][📜src-cb-img]][📜src-cb] [![Source on GitHub.com][📜src-gh-img]][📜src-gh] [![The best SHA: dQw4w9WgXcQ!][🧮kloc-img]][🧮kloc] |
|
|
98
|
+
| Documentation | [![Current release on RubyDoc.info][📜docs-cr-rd-img]][🚎yard-current] [![YARD on Galtzo.com][📜docs-head-rd-img]][🚎yard-head] [![Maintainer Blog][🚂maint-blog-img]][🚂maint-blog] [![GitLab Wiki][📜gl-wiki-img]][📜gl-wiki] [![GitHub Wiki][📜gh-wiki-img]][📜gh-wiki] |
|
|
99
|
+
| Compliance | [![License: AGPL-3.0-only OR PolyForm-Small-Business-1.0.0][📄license-img]][📄license] [![Apache license compatibility: Category X][📄license-compat-img]][📄license-compat] [![📄ilo-declaration-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
|
|
100
|
+
| Style | [![Enforced Code Style Linter][💎rlts-img]][💎rlts] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog] [![Gitmoji Commits][📌gitmoji-img]][📌gitmoji] [![Compatibility appraised by: appraisal2][💎appraisal2-img]][💎appraisal2] |
|
|
101
|
+
| Maintainer 🎖️ | [![Follow Me on LinkedIn][💖🖇linkedin-img]][💖🖇linkedin] [![Follow Me on Ruby.Social][💖🐘ruby-mast-img]][💖🐘ruby-mast] [![Follow Me on Bluesky][💖🦋bluesky-img]][💖🦋bluesky] [![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact] [![My technical writing][💖💁🏼♂️devto-img]][💖💁🏼♂️devto] |
|
|
102
|
+
| `...` 💖 | [![Find Me on WellFound:][💖✌️wellfound-img]][💖✌️wellfound] [![Find Me on CrunchBase][💖💲crunchbase-img]][💖💲crunchbase] [![My LinkTree][💖🌳linktree-img]][💖🌳linktree] [![More About Me][💖💁🏼♂️aboutme-img]][💖💁🏼♂️aboutme] [🧊][💖🧊berg] [🐙][💖🐙hub] [🛖][💖🛖hut] [🧪][💖🧪lab] |
|
|
103
|
+
|
|
104
|
+
### Compatibility
|
|
105
|
+
|
|
106
|
+
Compatible with MRI Ruby 4.0.0+, and concordant releases of JRuby, and TruffleRuby.
|
|
107
|
+
CI workflows and Appraisals are generated for MRI Ruby 4.0.0+.
|
|
108
|
+
This test floor is configured by `ruby.test_minimum` in `.kettle-jem.yml` and
|
|
109
|
+
may be higher than the gem's runtime compatibility floor when legacy Rubies are
|
|
110
|
+
not practical for the current toolchain.
|
|
111
|
+
|
|
112
|
+
<a href="https://github.com/kettle-dev"><img alt="kettle-dev Logo by Aboling0, CC BY-SA 4.0" src="https://logos.galtzo.com/assets/images/kettle-dev/avatar-128px.svg" width="14%" align="right"/></a>
|
|
113
|
+
|
|
114
|
+
The _amazing_ test matrix is powered by the kettle-dev stack.
|
|
115
|
+
|
|
116
|
+
<details markdown="1">
|
|
117
|
+
<summary>How kettle-dev manages complexity in tests</summary>
|
|
118
|
+
|
|
119
|
+
| Gem | Source | Role | Total downloads |
|
|
120
|
+
|-----|--------|------|---------------------|
|
|
121
|
+
| [appraisal2](https://clickgems.clickhouse.com/dashboard/appraisal2) | [GitHub](https://github.com/appraisal-rb/appraisal2) | multi-dependency Appraisal matrix generation | [](https://clickgems.clickhouse.com/dashboard/appraisal2) |
|
|
122
|
+
| [appraisal2-rubocop](https://clickgems.clickhouse.com/dashboard/appraisal2-rubocop) | [GitHub](https://github.com/appraisal-rb/appraisal2-rubocop) | RuboCop Appraisal generator integration | [](https://clickgems.clickhouse.com/dashboard/appraisal2-rubocop) |
|
|
123
|
+
| [kettle-dev](https://clickgems.clickhouse.com/dashboard/kettle-dev) | [GitHub](https://github.com/kettle-dev/kettle-dev) | development, release, and CI workflow tooling | [](https://clickgems.clickhouse.com/dashboard/kettle-dev) |
|
|
124
|
+
| [kettle-jem](https://clickgems.clickhouse.com/dashboard/kettle-jem) | [GitHub](https://github.com/kettle-dev/kettle-jem) | Appraisals & CI workflow templates | [](https://clickgems.clickhouse.com/dashboard/kettle-jem) |
|
|
125
|
+
| [kettle-soup-cover](https://clickgems.clickhouse.com/dashboard/kettle-soup-cover) | [GitHub](https://github.com/kettle-dev/kettle-soup-cover) | SimpleCov coverage policy and reporting | [](https://clickgems.clickhouse.com/dashboard/kettle-soup-cover) |
|
|
126
|
+
| [kettle-test](https://clickgems.clickhouse.com/dashboard/kettle-test) | [GitHub](https://github.com/kettle-dev/kettle-test) | standard test runner and coverage harness | [](https://clickgems.clickhouse.com/dashboard/kettle-test) |
|
|
127
|
+
| [rubocop-lts](https://clickgems.clickhouse.com/dashboard/rubocop-lts) | [GitHub](https://github.com/rubocop-lts/rubocop-lts) | Ruby-version-aware linting | [](https://clickgems.clickhouse.com/dashboard/rubocop-lts) |
|
|
128
|
+
| [turbo_tests2](https://clickgems.clickhouse.com/dashboard/turbo_tests2) | [GitHub](https://github.com/galtzo-floss/turbo_tests2) | parallel test execution | [](https://clickgems.clickhouse.com/dashboard/turbo_tests2) |
|
|
129
|
+
|
|
130
|
+
</details>
|
|
131
|
+
|
|
132
|
+
## ✨ Installation
|
|
133
|
+
|
|
134
|
+
Install the gem and add to the application's Gemfile by executing:
|
|
135
|
+
|
|
136
|
+
```console
|
|
137
|
+
bundle add markly-merge
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
If bundler is not being used to manage dependencies, install the gem by executing:
|
|
141
|
+
|
|
142
|
+
```console
|
|
143
|
+
gem install markly-merge
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
## ⚙️ Configuration
|
|
147
|
+
|
|
148
|
+
```ruby
|
|
149
|
+
merger = Markly::Merge::SmartMerger.new(
|
|
150
|
+
template_content,
|
|
151
|
+
dest_content,
|
|
152
|
+
# Which version to prefer when nodes match
|
|
153
|
+
# :destination (default) - keep destination content
|
|
154
|
+
# :template - use template content
|
|
155
|
+
preference: :destination,
|
|
156
|
+
|
|
157
|
+
# Whether to add template-only nodes to the result
|
|
158
|
+
# false (default) - only include sections that exist in destination
|
|
159
|
+
# true - include all template sections
|
|
160
|
+
add_template_only_nodes: false,
|
|
161
|
+
|
|
162
|
+
# Token for freeze block markers
|
|
163
|
+
# Default: "markly-merge"
|
|
164
|
+
# Looks for: <!-- markly-merge:freeze --> / <!-- markly-merge:unfreeze -->
|
|
165
|
+
freeze_token: "markly-merge",
|
|
166
|
+
|
|
167
|
+
# Custom signature generator (optional)
|
|
168
|
+
# Receives a node, returns a signature array or nil
|
|
169
|
+
signature_generator: ->(node) { [:heading, node.header_level, node.string_content] if node.type == :heading },
|
|
170
|
+
)
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
## 🔧 Basic Usage
|
|
174
|
+
|
|
175
|
+
### Simple Merge
|
|
176
|
+
|
|
177
|
+
````ruby
|
|
178
|
+
require "markly/merge"
|
|
179
|
+
|
|
180
|
+
# Template defines the structure
|
|
181
|
+
template = <<~MD
|
|
182
|
+
# My Project
|
|
183
|
+
|
|
184
|
+
## How to Install
|
|
185
|
+
|
|
186
|
+
Run `gem install my-project`.
|
|
187
|
+
|
|
188
|
+
## How to Use
|
|
189
|
+
|
|
190
|
+
Instructions here.
|
|
191
|
+
|
|
192
|
+
## Contributing
|
|
193
|
+
|
|
194
|
+
Please read CONTRIBUTING.md.
|
|
195
|
+
MD
|
|
196
|
+
|
|
197
|
+
# Destination has customizations
|
|
198
|
+
destination = <<~MD
|
|
199
|
+
# My Project
|
|
200
|
+
|
|
201
|
+
## How to Install
|
|
202
|
+
|
|
203
|
+
Use bundler for better dependency management:
|
|
204
|
+
|
|
205
|
+
```bash
|
|
206
|
+
bundle add my-project
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
## Custom Section
|
|
210
|
+
|
|
211
|
+
This section only exists in destination.
|
|
212
|
+
MD
|
|
213
|
+
|
|
214
|
+
merger = Markly::Merge::SmartMerger.new(template, destination)
|
|
215
|
+
result = merger.merge
|
|
216
|
+
puts result.to_markdown
|
|
217
|
+
````
|
|
218
|
+
|
|
219
|
+
### Using Freeze Blocks
|
|
220
|
+
|
|
221
|
+
Freeze blocks protect sections from being overwritten during merge:
|
|
222
|
+
|
|
223
|
+
````markdown
|
|
224
|
+
# My Project
|
|
225
|
+
|
|
226
|
+
## How to Install
|
|
227
|
+
|
|
228
|
+
<!-- markly-merge:freeze Custom install instructions -->
|
|
229
|
+
This installation section has been customized and will be preserved
|
|
230
|
+
during template merges, regardless of what the template contains.
|
|
231
|
+
<!-- markly-merge:unfreeze -->
|
|
232
|
+
|
|
233
|
+
## How to Use
|
|
234
|
+
|
|
235
|
+
Standard usage section from template.
|
|
236
|
+
````
|
|
237
|
+
|
|
238
|
+
Content between `<!-- markly-merge:freeze -->` and `<!-- markly-merge:unfreeze -->` markers is preserved from the destination file.
|
|
239
|
+
|
|
240
|
+
### Adding Template-Only Sections
|
|
241
|
+
|
|
242
|
+
```ruby
|
|
243
|
+
merger = Markly::Merge::SmartMerger.new(
|
|
244
|
+
template,
|
|
245
|
+
destination,
|
|
246
|
+
add_template_only_nodes: true,
|
|
247
|
+
)
|
|
248
|
+
result = merger.merge
|
|
249
|
+
# Result includes sections from template that don't exist in destination
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
### Freeze Blocks
|
|
253
|
+
|
|
254
|
+
Freeze blocks protect sections from being modified during merges. They are marked
|
|
255
|
+
with HTML comments that are invisible when the Markdown is rendered:
|
|
256
|
+
|
|
257
|
+
```markdown
|
|
258
|
+
<!-- markdown-merge:freeze -->
|
|
259
|
+
|
|
260
|
+
# Some Markdown in here!
|
|
261
|
+
|
|
262
|
+
<!-- markdown-merge:unfreeze -->
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
## 🔐 Security
|
|
266
|
+
|
|
267
|
+
See [SECURITY.md][🔐security].
|
|
268
|
+
|
|
269
|
+
## 🤝 Contributing
|
|
270
|
+
|
|
271
|
+
If you need some ideas of where to help, you could work on adding more code coverage,
|
|
272
|
+
or if it is already 💯 (see [below](#code-coverage)) check [issues][🤝gh-issues] or [PRs][🤝gh-pulls],
|
|
273
|
+
or use the gem and think about how it could be better.
|
|
274
|
+
|
|
275
|
+
We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
|
|
276
|
+
|
|
277
|
+
See [CONTRIBUTING.md][🤝contributing] for more detailed instructions.
|
|
278
|
+
|
|
279
|
+
### Code Coverage
|
|
280
|
+
|
|
281
|
+
<details markdown="1">
|
|
282
|
+
<summary>Coverage service badges</summary>
|
|
283
|
+
|
|
284
|
+
</details>
|
|
285
|
+
|
|
286
|
+
## 📌 Versioning
|
|
287
|
+
|
|
288
|
+
This library follows [![Semantic Versioning 2.0.0][📌semver-img]][📌semver] for its public API where practical.
|
|
289
|
+
For most applications, prefer the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
|
|
290
|
+
|
|
291
|
+
For example:
|
|
292
|
+
|
|
293
|
+
```ruby
|
|
294
|
+
spec.add_dependency("markly-merge", "~> 7.0")
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
<details markdown="1">
|
|
298
|
+
<summary>📌 Is "Platform Support" part of the public API? More details inside.</summary>
|
|
299
|
+
|
|
300
|
+
Dropping support for a platform can be a breaking change for affected users.
|
|
301
|
+
If a release changes supported platforms, it should be called out clearly in the changelog and versioned with that impact in mind.
|
|
302
|
+
|
|
303
|
+
To get a better understanding of how SemVer is intended to work over a project's lifetime,
|
|
304
|
+
read this article from the creator of SemVer:
|
|
305
|
+
|
|
306
|
+
- ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]
|
|
307
|
+
|
|
308
|
+
</details>
|
|
309
|
+
|
|
310
|
+
See [CHANGELOG.md][📌changelog] for a list of releases.
|
|
311
|
+
|
|
312
|
+
## 📄 License
|
|
313
|
+
|
|
314
|
+
The gem is available under the following licenses: [AGPL-3.0-only](https://github.com/structuredmerge/structuredmerge-ruby/blob/main/AGPL-3.0-only.md), [PolyForm-Small-Business-1.0.0](https://github.com/structuredmerge/structuredmerge-ruby/blob/main/PolyForm-Small-Business-1.0.0.md).
|
|
315
|
+
See [LICENSE.md][📄license] for details.
|
|
316
|
+
|
|
317
|
+
If none of the available licenses suit your use case, please [contact us](mailto:floss@galtzo.com) to discuss a custom commercial license.
|
|
318
|
+
|
|
319
|
+
[⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
|
|
320
|
+
[⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
|
|
321
|
+
[⛳liberapay]: https://liberapay.com/pboling/donate
|
|
322
|
+
[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
|
|
323
|
+
[🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
|
|
324
|
+
[🖇sponsor]: https://github.com/sponsors/pboling
|
|
325
|
+
[🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
|
|
326
|
+
[🖇kofi]: https://ko-fi.com/pboling
|
|
327
|
+
[🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
|
|
328
|
+
[🖇buyme-img]: https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20latte&emoji=&slug=pboling&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff
|
|
329
|
+
[🖇buyme]: https://www.buymeacoffee.com/pboling
|
|
330
|
+
[🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
|
|
331
|
+
[🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
|
|
332
|
+
[🖇paypal]: https://www.paypal.com/paypalme/peterboling
|
|
333
|
+
[🖇floss-funding.dev]: https://floss-funding.dev
|
|
334
|
+
[🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
|
|
335
|
+
[✉️discord-invite]: https://discord.gg/3qme4XHNKN
|
|
336
|
+
[✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge&logo=discord
|
|
337
|
+
[✉️ruby-friends-img]: https://img.shields.io/badge/daily.dev-%F0%9F%92%8E_Ruby_Friends-0A0A0A?style=for-the-badge&logo=dailydotdev&logoColor=white
|
|
338
|
+
[✉️ruby-friends]: https://app.daily.dev/squads/rubyfriends
|
|
339
|
+
[✉️ruby-forum-top-img]: https://img.shields.io/discourse/topics?server=https%3A%2F%2Fwww.rubyforum.org&style=flat&logo=discourse&label=Ruby%20Users%20Forum
|
|
340
|
+
[✉️ruby-forum-img]: https://img.shields.io/discourse/topics?server=https%3A%2F%2Fwww.rubyforum.org&style=for-the-badge&logo=discourse&label=Ruby%20Users%20Forum
|
|
341
|
+
[✉️ruby-forum]: https://www.rubyforum.org/tag/structuredmerge
|
|
342
|
+
[✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
|
|
343
|
+
[⛳️gem-namespace]: https://github.com/structuredmerge/structuredmerge-ruby/tree/main/gems/markly-merge
|
|
344
|
+
[⛳️namespace-img]: https://img.shields.io/badge/namespace-Markly::Merge-3C2D2D.svg?style=square&logo=ruby&logoColor=white
|
|
345
|
+
[⛳️gem-name]: https://clickgems.clickhouse.com/dashboard/markly-merge
|
|
346
|
+
[⛳️name-img]: https://img.shields.io/badge/name-markly--merge-3C2D2D.svg?style=square&logo=rubygems&logoColor=red
|
|
347
|
+
[⛳️tag-img]: https://img.shields.io/github/tag/structuredmerge/structuredmerge-ruby.svg
|
|
348
|
+
[⛳️tag]: https://github.com/structuredmerge/structuredmerge-ruby/releases
|
|
349
|
+
[🚂maint-blog]: http://www.railsbling.com/tags/markly-merge
|
|
350
|
+
[🚂maint-blog-img]: https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange
|
|
351
|
+
[🚂maint-contact]: http://www.railsbling.com/contact
|
|
352
|
+
[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
|
|
353
|
+
[💖🖇linkedin]: http://www.linkedin.com/in/peterboling
|
|
354
|
+
[💖🖇linkedin-img]: https://img.shields.io/badge/LinkedIn-Profile-0B66C2?style=flat&logo=newjapanprowrestling
|
|
355
|
+
[💖✌️wellfound]: https://wellfound.com/u/peter-boling
|
|
356
|
+
[💖✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound
|
|
357
|
+
[💖💲crunchbase]: https://www.crunchbase.com/person/peter-boling
|
|
358
|
+
[💖💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=flat&logo=crunchbase
|
|
359
|
+
[💖🐘ruby-mast]: https://ruby.social/@galtzo
|
|
360
|
+
[💖🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https://ruby.social&style=flat&logo=mastodon&label=Ruby%20@galtzo
|
|
361
|
+
[💖🦋bluesky]: https://bsky.app/profile/galtzo.com
|
|
362
|
+
[💖🦋bluesky-img]: https://img.shields.io/badge/@galtzo.com-0285FF?style=flat&logo=bluesky&logoColor=white
|
|
363
|
+
[💖🌳linktree]: https://linktr.ee/galtzo
|
|
364
|
+
[💖🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=flat&logo=linktree
|
|
365
|
+
[💖💁🏼♂️devto]: https://dev.to/galtzo
|
|
366
|
+
[💖💁🏼♂️devto-img]: https://img.shields.io/badge/dev.to-0A0A0A?style=flat&logo=devdotto&logoColor=white
|
|
367
|
+
[💖💁🏼♂️aboutme]: https://about.me/peter.boling
|
|
368
|
+
[💖💁🏼♂️aboutme-img]: https://img.shields.io/badge/about.me-0A0A0A?style=flat&logo=aboutme&logoColor=white
|
|
369
|
+
[💖🧊berg]: https://codeberg.org/pboling
|
|
370
|
+
[💖🐙hub]: https://github.org/pboling
|
|
371
|
+
[💖🛖hut]: https://sr.ht/~galtzo/
|
|
372
|
+
[💖🧪lab]: https://gitlab.com/pboling
|
|
373
|
+
[👨🏼🏫expsup-upwork]: https://www.upwork.com/freelancers/~014942e9b056abdf86?mp_source=share
|
|
374
|
+
[👨🏼🏫expsup-upwork-img]: https://img.shields.io/badge/UpWork-13544E?style=for-the-badge&logo=Upwork&logoColor=white
|
|
375
|
+
[👨🏼🏫expsup-codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
|
|
376
|
+
[👨🏼🏫expsup-codementor-img]: https://img.shields.io/badge/CodeMentor-Get_Help-1abc9c?style=for-the-badge&logo=CodeMentor&logoColor=white
|
|
377
|
+
[🏙️entsup-tidelift]: https://tidelift.com/subscription/pkg/rubygems-markly-merge?utm_source=rubygems-markly-merge&utm_medium=referral&utm_campaign=readme
|
|
378
|
+
[🏙️entsup-tidelift-img]: https://img.shields.io/badge/Tidelift_and_Sonar-Enterprise_Support-FD3456?style=for-the-badge&logo=sonar&logoColor=white
|
|
379
|
+
[🏙️entsup-tidelift-sonar]: https://blog.tidelift.com/tidelift-joins-sonar
|
|
380
|
+
[💁🏼♂️peterboling]: http://www.peterboling.com
|
|
381
|
+
[🚂railsbling]: http://www.railsbling.com
|
|
382
|
+
[📜src-gl-img]: https://img.shields.io/badge/GitLab-FBA326?style=for-the-badge&logo=Gitlab&logoColor=orange
|
|
383
|
+
[📜src-gl]: https://gitlab.com/structuredmerge/structuredmerge-ruby/-/tree/main/gems/markly-merge
|
|
384
|
+
[📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
|
|
385
|
+
[📜src-cb]: https://codeberg.org/structuredmerge/structuredmerge-ruby/src/branch/main/gems/markly-merge
|
|
386
|
+
[📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=GitHub&logoColor=green
|
|
387
|
+
[📜src-gh]: https://github.com/structuredmerge/structuredmerge-ruby/tree/main/gems/markly-merge
|
|
388
|
+
[📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
|
389
|
+
[📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
|
390
|
+
[📜gl-wiki]: https://gitlab.com/structuredmerge/structuredmerge-ruby/-/wikis/home
|
|
391
|
+
[📜gh-wiki]: https://github.com/structuredmerge/structuredmerge-ruby/wiki
|
|
392
|
+
[📜gl-wiki-img]: https://img.shields.io/badge/wiki-gitlab-943CD2.svg?style=for-the-badge&logo=gitlab&logoColor=white
|
|
393
|
+
[📜gh-wiki-img]: https://img.shields.io/badge/wiki-github-943CD2.svg?style=for-the-badge&logo=github&logoColor=white
|
|
394
|
+
[👽dl-rank]: https://clickgems.clickhouse.com/dashboard/markly-merge
|
|
395
|
+
[👽dl-ranki]: https://img.shields.io/gem/dt/markly-merge.svg
|
|
396
|
+
[👽version]: https://clickgems.clickhouse.com/dashboard/markly-merge
|
|
397
|
+
[👽versioni]: https://img.shields.io/gem/v/markly-merge.svg
|
|
398
|
+
[🚎11-c-wf]: https://github.com/structuredmerge/structuredmerge-ruby/actions/workflows/current.yml
|
|
399
|
+
[🚎11-c-wfi]: https://github.com/structuredmerge/structuredmerge-ruby/actions/workflows/current.yml/badge.svg
|
|
400
|
+
[💎ruby-c-i]: https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green
|
|
401
|
+
[🤝gh-issues]: https://github.com/structuredmerge/structuredmerge-ruby/issues
|
|
402
|
+
[🤝gh-pulls]: https://github.com/structuredmerge/structuredmerge-ruby/pulls
|
|
403
|
+
[🤝gl-issues]: https://gitlab.com/structuredmerge/structuredmerge-ruby/-/issues
|
|
404
|
+
[🤝gl-pulls]: https://gitlab.com/structuredmerge/structuredmerge-ruby/-/merge_requests
|
|
405
|
+
[🤝cb-issues]: https://codeberg.org/structuredmerge/structuredmerge-ruby/issues
|
|
406
|
+
[🤝cb-pulls]: https://codeberg.org/structuredmerge/structuredmerge-ruby/pulls
|
|
407
|
+
[🤝cb-donate]: https://donate.codeberg.org/
|
|
408
|
+
[🤝contributing]: https://github.com/structuredmerge/structuredmerge-ruby/blob/main/CONTRIBUTING.md
|
|
409
|
+
[🖐contrib-rocks]: https://contrib.rocks
|
|
410
|
+
[🖐contributors]: https://github.com/structuredmerge/structuredmerge-ruby/graphs/contributors
|
|
411
|
+
[🖐contributors-img]: https://contrib.rocks/image?repo=structuredmerge/structuredmerge-ruby
|
|
412
|
+
[🪇conduct]: https://github.com/structuredmerge/structuredmerge-ruby/blob/main/CODE_OF_CONDUCT.md
|
|
413
|
+
[🪇conduct-img]: https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg
|
|
414
|
+
[📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
|
|
415
|
+
[📌semver]: https://semver.org/spec/v2.0.0.html
|
|
416
|
+
[📌semver-img]: https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat
|
|
417
|
+
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
|
418
|
+
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
419
|
+
[📌changelog]: https://github.com/structuredmerge/structuredmerge-ruby/blob/main/CHANGELOG.md
|
|
420
|
+
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
421
|
+
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat
|
|
422
|
+
[📌gitmoji]: https://gitmoji.dev
|
|
423
|
+
[📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
|
|
424
|
+
[🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
|
|
425
|
+
[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.217-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
|
|
426
|
+
[🔐security]: https://github.com/structuredmerge/structuredmerge-ruby/blob/main/SECURITY.md
|
|
427
|
+
[🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
|
|
428
|
+
[📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
|
|
429
|
+
[📄license]: LICENSE.md
|
|
430
|
+
[📄license-ref]: LICENSE.md
|
|
431
|
+
[📄license-img]: https://img.shields.io/badge/License-AGPL--3.0--only_OR_PolyForm--Small--Business--1.0.0-259D6C.svg
|
|
432
|
+
[📄license-compat]: https://www.apache.org/legal/resolved.html#category-x
|
|
433
|
+
[📄license-compat-img]: https://img.shields.io/badge/Apache_Incompatible:_Category_X-%E2%9C%97-C0392B.svg?style=flat&logo=Apache
|
|
434
|
+
[📄ilo-declaration]: https://www.ilo.org/declaration/lang--en/index.htm
|
|
435
|
+
[📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-259D6C.svg?style=flat
|
|
436
|
+
[🚎yard-current]: http://rubydoc.info/gems/markly-merge
|
|
437
|
+
[🚎yard-head]: https://markly-merge.galtzo.com
|
|
438
|
+
[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
|
|
439
|
+
[💎SHA_checksums]: https://gitlab.com/structuredmerge/structuredmerge-ruby/-/tree/main/checksums
|
|
440
|
+
[💎rlts]: https://github.com/rubocop-lts/rubocop-lts
|
|
441
|
+
[💎rlts-img]: https://img.shields.io/badge/code_style_&_linting-rubocop--lts-34495e.svg?plastic&logo=ruby&logoColor=white
|
|
442
|
+
[💎appraisal2]: https://github.com/appraisal-rb/appraisal2
|
|
443
|
+
[💎appraisal2-img]: https://img.shields.io/badge/appraised_by-appraisal2-34495e.svg?plastic&logo=ruby&logoColor=white
|
|
444
|
+
[💎d-in-dvcs]: https://railsbling.com/posts/dvcs/put_the_d_in_dvcs/
|