1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
|
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
File: README
— Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" />
<link rel="stylesheet" href="css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "README";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="file_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index</a> »
<span class="title">File: README</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><div id='filecontents'><h1 id="-snakyhash">🐍 SnakyHash</h1>
<p><a href="https://rubygems.org/gems/snaky_hash"><img src="https://img.shields.io/gem/v/snaky_hash.svg" alt="Version"></a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-259D6C.svg" alt="License: MIT"></a> <a href="https://rubygems.org/gems/snaky_hash"><img src="https://img.shields.io/gem/rd/snaky_hash.svg" alt="Downloads Rank"></a> <a href="https://www.codetriage.com/oauth-xx/snaky_hash"><img src="https://www.codetriage.com/oauth-xx/snaky_hash/badges/users.svg" alt="Open Source Helpers"></a> <a href="https://depfu.com/github/oauth-xx/snaky_hash?project_id=63073"><img src="https://badges.depfu.com/badges/7019dcf43672ba8c0e77e7fdd1063398/count.svg" alt="Depfu"></a> <a href="https://coveralls.io/github/oauth-xx/snaky_hash?branch=main"><img src="https://coveralls.io/repos/github/oauth-xx/snaky_hash/badge.svg?branch=main" alt="Coveralls Test Coverage"></a> <a href="https://qlty.sh/gh/oauth-xx/projects/snaky_hash"><img src="https://qlty.sh/badges/84e960b2-4ed2-4b47-9913-02c32680ec98/test_coverage.svg" alt="QLTY Test Coverage"></a> <a href="https://qlty.sh/gh/oauth-xx/projects/snaky_hash"><img src="https://qlty.sh/badges/84e960b2-4ed2-4b47-9913-02c32680ec98/maintainability.svg" alt="QLTY Maintainability"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/heads.yml"><img src="https://github.com/oauth-xx/snaky_hash/actions/workflows/heads.yml/badge.svg" alt="CI Heads"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/current-runtime-heads.yml"><img src="https://github.com/oauth-xx/snaky_hash/actions/workflows/current-runtime-heads.yml/badge.svg" alt="CI Runtime Dependencies @ HEAD"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/current.yml"><img src="https://github.com/oauth-xx/snaky_hash/actions/workflows/current.yml/badge.svg" alt="CI Current"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/truffle.yml"><img src="https://github.com/oauth-xx/snaky_hash/actions/workflows/truffle.yml/badge.svg" alt="CI Truffle Ruby"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/jruby.yml"><img src="https://github.com/oauth-xx/snaky_hash/actions/workflows/jruby.yml/badge.svg" alt="CI JRuby"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/supported.yml"><img src="https://github.com/oauth-xx/snaky_hash/actions/workflows/supported.yml/badge.svg" alt="CI Supported"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/legacy.yml"><img src="https://github.com/oauth-xx/snaky_hash/actions/workflows/legacy.yml/badge.svg" alt="CI Legacy"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/unsupported.yml"><img src="https://github.com/oauth-xx/snaky_hash/actions/workflows/unsupported.yml/badge.svg" alt="CI Unsupported"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/ancient.yml"><img src="https://github.com/oauth-xx/snaky_hash/actions/workflows/ancient.yml/badge.svg" alt="CI Ancient"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/coverage.yml"><img src="https://github.com/oauth-xx/snaky_hash/actions/workflows/coverage.yml/badge.svg" alt="CI Test Coverage"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/style.yml"><img src="https://github.com/oauth-xx/snaky_hash/actions/workflows/style.yml/badge.svg" alt="CI Style"></a> <a href="https://github.com/oauth-xx/snaky_hash/security/code-scanning"><img src="https://github.com/oauth-xx/snaky_hash/actions/workflows/codeql-analysis.yml/badge.svg" alt="CodeQL"></a></p>
<hr>
<p><a href="https://liberapay.com/pboling/donate"><img src="https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay" alt="Liberapay Goal Progress"></a> <a href="https://github.com/sponsors/pboling"><img src="https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github" alt="Sponsor Me on Github"></a> <a href="https://www.buymeacoffee.com/pboling"><img src="https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-yellow.svg?style=flat" alt="Buy me a coffee"></a> <a href="https://polar.sh/pboling"><img src="https://img.shields.io/badge/polar-donate-yellow.svg" alt="Donate on Polar"></a> <a href="https://ko-fi.com/O5O86SNP4"><img src="https://img.shields.io/badge/a_more_different_coffee-%E2%9C%93-yellow.svg" alt="Donate to my FLOSS or refugee efforts at ko-fi.com"></a> <a href="https://patreon.com/galtzo"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Donate to my FLOSS or refugee efforts using Patreon"></a></p>
<p>This library is similar in purpose to the HashWithIndifferentAccess that is famously used in Rails, but does a lot more.</p>
<p>This gem is used by <code>oauth</code> and <code>oauth2</code> gems to normalize hash keys to <code>snake_case</code> and lookups,<br>
and provide a nice psuedo-object interface.</p>
<p>It can be thought of as a mashup of:</p>
<ul>
<li>
<code>Rash</code> (specifically the <a href="https://github.com/shishi/rash_alt"><code>rash_alt</code></a> flavor), which is a special <code>Mash</code>, made popular by the <code>hashie</code> gem, and</li>
<li>
<code>serialized_hashie</code> <a href="https://github.com/krystal/serialized-hashie">gem by krystal</a>, rewritten, with some behavior changes</li>
</ul>
<p>Classes that <code>include SnakyHash::Snake.new</code> should inherit from <code>Hashie::Mash</code>.</p>
<h2 id="new-for-v202-serialization-support">New for v2.0.2: Serialization Support</h2>
<p>The serialization support is set to <code>false</code> by default, for backwards compatibility, but may be switched to <code>true</code> in the next major release, which will be v3. Example:</p>
<pre class="code language-ruby"><code class="language-ruby"># This class has `dump` and `load` abilities!
class MyStringKeyedHash < Hashie::Mash
include SnakyHash::Snake.new(
key_type: :string,
serializer: true,
)
end
</code></pre>
<p>✨ Also new dump & load plugin extensions to control the way your data is dumped and loaded.</p>
<h3 id="note-for-use-with-oauth2-gem">Note for use with oauth2 gem</h3>
<p>The serializer is being introduced as a disabled option for backwards compatibility.<br>
In snaky_hash v3 it will default to <code>true</code>.<br>
If you want to start using the serializer immediately, reopen the <code>SnakyHash::StringKeyed</code> class and add the <code>SnakyHash::Serializer</code> module like this:</p>
<pre class="code language-ruby"><code class="language-ruby">SnakyHash::StringKeyed.class_eval do
extend SnakyHash::Serializer
end
</code></pre>
<p>or you can create a custom class</p>
<pre class="code language-ruby"><code class="language-ruby">class MyHash < Hashie::Mash
include SnakyHash::Snake.new(key_type: :string, serializer: true)
# Which is the same as:
# include SnakyHash::Snake.new(key_type: :string)
# extend SnakyHash::Serializer
end
</code></pre>
<p>You can then add serialization extensions as needed. See <a href="#serialization">serialization</a> and <a href="#extensions">extensions</a> for more.</p>
<table>
<thead>
<tr>
<th>Federated <a href="https://railsbling.com/posts/dvcs/put_the_d_in_dvcs/">DVCS</a> Repository</th>
<th>Status</th>
<th>Issues</th>
<th>PRs</th>
<th>Wiki</th>
<th>CI</th>
<th>Discussions</th>
</tr>
</thead>
<tbody>
<tr>
<td>🧪 <a href="https://gitlab.com/oauth-xx/snaky_hash/">oauth-xx/snaky_hash on GitLab</a>
</td>
<td>The Truth</td>
<td><a href="https://gitlab.com/oauth-xx/snaky_hash/-/issues">💚</a></td>
<td><a href="https://gitlab.com/oauth-xx/snaky_hash/-/merge_requests">💚</a></td>
<td><a href="https://gitlab.com/oauth-xx/snaky_hash/-/wikis/home">💚</a></td>
<td>🏀 Tiny Matrix</td>
<td>➖</td>
</tr>
<tr>
<td>🧊 <a href="https://codeberg.org/oauth-xx/snaky_hash">oauth-xx/snaky_hash on CodeBerg</a>
</td>
<td>An Ethical Mirror (<a href="https://donate.codeberg.org/">Donate</a>)</td>
<td>➖</td>
<td><a href="https://codeberg.org/oauth-xx/snaky_hash/pulls">💚</a></td>
<td>➖</td>
<td>⭕️ No Matrix</td>
<td>➖</td>
</tr>
<tr>
<td>🐙 <a href="https://github.com/oauth-xx/snaky_hash">oauth-xx/snaky_hash on GitHub</a>
</td>
<td>A Dirty Mirror</td>
<td><a href="https://github.com/oauth-xx/snaky_hash/issues">💚</a></td>
<td><a href="https://github.com/oauth-xx/snaky_hash/pulls">💚</a></td>
<td>➖</td>
<td>💯 Full Matrix</td>
<td>➖</td>
</tr>
<tr>
<td>🤼 <a href="https://groups.google.com/g/oauth-ruby">OAuth Ruby Google Group</a>
</td>
<td>“Active”</td>
<td>➖</td>
<td>➖</td>
<td>➖</td>
<td>➖</td>
<td><a href="https://groups.google.com/g/oauth-ruby">💚</a></td>
</tr>
<tr>
<td>🎮️ <a href="https://discord.gg/3qme4XHNKN">Discord Server</a>
</td>
<td><a href="https://discord.gg/3qme4XHNKN"><img src="https://img.shields.io/discord/1373797679469170758?style=for-the-badge" alt="Live Chat on Discord"></a></td>
<td><a href="https://discord.gg/3qme4XHNKN">Let’s</a></td>
<td><a href="https://discord.gg/3qme4XHNKN">talk</a></td>
<td><a href="https://discord.gg/3qme4XHNKN">about</a></td>
<td><a href="https://discord.gg/3qme4XHNKN">this</a></td>
<td><a href="https://discord.gg/3qme4XHNKN">library!</a></td>
</tr>
</tbody>
</table>
<h2 id="upgrading-runtime-gem-dependencies">Upgrading Runtime Gem Dependencies</h2>
<p>Due to oauth and oauth2 gems depending on this gem,<br>
this project sits underneath a large portion of the authorization systems on the internet.</p>
<p>That means it is painful for the Ruby community when this gem forces updates to its runtime dependencies.</p>
<p>As a result, great care, and a lot of time, have been invested to ensure this gem is working with all the<br>
leading versions per each minor version of Ruby of all the runtime dependencies it can install with.</p>
<p>What does that mean specifically for the runtime dependencies?</p>
<p>We have 100% test coverage of lines and branches, and this test suite runs across a large matrix<br>
covering the latest patch for each of the following minor versions:</p>
<ul>
<li>MRI Ruby @ v2.3, v2.4, v2.5, v2.6, v2.7, v3.0, v3.1, v3.2, v3.3, v3.4, HEAD
<ul>
<li>NOTE: This gem will still install on ruby v2.2, but vanilla GitHub Actions no longer supports testing against it, so YMMV.</li>
</ul>
</li>
<li>JRuby @ v9.2, v9.3, v9.4, v10.0, HEAD</li>
<li>TruffleRuby @ v23.1, v23.2, HEAD</li>
<li>gem <code>hashie</code> @ v0, v1, v2, v3, v4, v5, HEAD ⏩️ <a href="https://github.com/hashie/hashie">hashie/hashie</a>
</li>
<li>gem <code>version_gem</code> - @v1, HEAD ⏩️ <a href="https://gitlab.com/oauth-xx/version_gem">oauth-xx/version_gem</a>
</li>
</ul>
<p>NOTE: <code>version_gem</code>, and this library, were both extracted from the ouaht2 gem. They are part of the <code>oauth-xx</code> org,<br>
and are developed in tight collaboration with the oauth and oauth2 gems.</p>
<h3 id="you-should-upgrade-this-gem-with-confidence">You should upgrade this gem with confidence*.</h3>
<ul>
<li>This gem follows a <em>strict & correct</em> (according to the maintainer of SemVer; <a href="#-is-platform-support-part-of-the-public-api">more info</a>) interpretation of SemVer.
<ul>
<li>Dropping support for <strong>any</strong> of the runtime dependency versions above will be a major version bump.</li>
<li>If you aren’t on one of the minor versions above, make getting there a priority.</li>
</ul>
</li>
<li>You should upgrade the dependencies of this gem with confidence*.</li>
<li>Please do upgrade, and then, when it goes smooth as butter <a href="https://github.com/sponsors/pboling">please sponsor me</a>. Thanks!</li>
</ul>
<p>* MIT license; I am unable to make guarantees.</p>
<table>
<thead>
<tr>
<th>🚚 Test matrix brought to you by</th>
<th>🔎 appraisal++</th>
</tr>
</thead>
<tbody>
<tr>
<td>Adds back support for old Rubies</td>
<td>✨ <a href="https://github.com/thoughtbot/appraisal/pull/250">appraisal PR #250</a>
</td>
</tr>
<tr>
<td>Adds support for <code>eval_gemfile</code>
</td>
<td>✨ <a href="https://github.com/thoughtbot/appraisal/pull/248">appraisal PR #248</a>
</td>
</tr>
<tr>
<td>Please review</td>
<td>my PRs!</td>
</tr>
</tbody>
</table>
<h2 id="-info-you-can-shake-a-stick-at">💡 Info you can shake a stick at</h2>
<table>
<thead>
<tr>
<th>Tokens to Remember</th>
<th>
<a href="https://rubygems.org/gems/snaky_hash"><img src="https://img.shields.io/badge/name-snaky_hash-brightgreen.svg?style=flat&logo=rubygems&logoColor=red" alt="Gem name"></a> <a href="https://github.com/oauth-xx/snaky_hash"><img src="https://img.shields.io/badge/namespace-OAuth2-brightgreen.svg?style=flat&logo=ruby&logoColor=white" alt="Gem namespace"></a>
</th>
</tr>
</thead>
<tbody>
<tr>
<td>Works with JRuby</td>
<td>
<a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/jruby.yml"><img src="https://img.shields.io/badge/JRuby-9.2-FBE742?style=for-the-badge&logo=ruby&logoColor=red" alt="JRuby 9.2 Compat"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/jruby.yml"><img src="https://img.shields.io/badge/JRuby-9.3-FBE742?style=for-the-badge&logo=ruby&logoColor=red" alt="JRuby 9.3 Compat"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/jruby.yml"><img src="https://img.shields.io/badge/JRuby-9.4-FBE742?style=for-the-badge&logo=ruby&logoColor=red" alt="JRuby 9.4 Compat"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/current.yml"><img src="https://img.shields.io/badge/JRuby-current-FBE742?style=for-the-badge&logo=ruby&logoColor=green" alt="JRuby 10.0 Compat"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/heads.yml"><img src="https://img.shields.io/badge/JRuby-HEAD-FBE742?style=for-the-badge&logo=ruby&logoColor=blue" alt="JRuby HEAD Compat"></a>
</td>
</tr>
<tr>
<td>Works with Truffle Ruby</td>
<td>
<a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/truffle.yml"><img src="https://img.shields.io/badge/Truffle_Ruby-23.1-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink" alt="Truffle Ruby 23.1 Compat"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/current.yml"><img src="https://img.shields.io/badge/Truffle_Ruby-current-34BCB1?style=for-the-badge&logo=ruby&logoColor=green" alt="Truffle Ruby 24.1 Compat"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/heads.yml"><img src="https://img.shields.io/badge/Truffle_Ruby-HEAD-34BCB1?style=for-the-badge&logo=ruby&logoColor=blue" alt="Truffle Ruby HEAD Compat"></a>
</td>
</tr>
<tr>
<td>Works with MRI Ruby 3</td>
<td>
<a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/legacy.yml"><img src="https://img.shields.io/badge/Ruby-3.0-CC342D?style=for-the-badge&logo=ruby&logoColor=white" alt="Ruby 3.0 Compat"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/supported.yml"><img src="https://img.shields.io/badge/Ruby-3.1-CC342D?style=for-the-badge&logo=ruby&logoColor=white" alt="Ruby 3.1 Compat"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/supported.yml"><img src="https://img.shields.io/badge/Ruby-3.2-CC342D?style=for-the-badge&logo=ruby&logoColor=white" alt="Ruby 3.2 Compat"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/supported.yml"><img src="https://img.shields.io/badge/Ruby-3.3-CC342D?style=for-the-badge&logo=ruby&logoColor=white" alt="Ruby 3.3 Compat"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/current.yml"><img src="https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green" alt="Ruby 3.4 Compat"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/heads.yml"><img src="https://img.shields.io/badge/Ruby-HEAD-CC342D?style=for-the-badge&logo=ruby&logoColor=blue" alt="Ruby HEAD Compat"></a>
</td>
</tr>
<tr>
<td>Works with MRI Ruby 2</td>
<td>
<a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/ancient.yml"><img src="https://img.shields.io/badge/Ruby-2.3-DF00CA?style=for-the-badge&logo=ruby&logoColor=white" alt="Ruby 2.3 Compat"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/ancient.yml"><img src="https://img.shields.io/badge/Ruby-2.4-DF00CA?style=for-the-badge&logo=ruby&logoColor=white" alt="Ruby 2.4 Compat"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/ancient.yml"><img src="https://img.shields.io/badge/Ruby-2.5-DF00CA?style=for-the-badge&logo=ruby&logoColor=white" alt="Ruby 2.5 Compat"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/unsupported.yml"><img src="https://img.shields.io/badge/Ruby-2.6-DF00CA?style=for-the-badge&logo=ruby&logoColor=white" alt="Ruby 2.6 Compat"></a> <a href="https://github.com/oauth-xx/snaky_hash/actions/workflows/unsupported.yml"><img src="https://img.shields.io/badge/Ruby-2.7-DF00CA?style=for-the-badge&logo=ruby&logoColor=white" alt="Ruby 2.7 Compat"></a>
</td>
</tr>
<tr>
<td>Source</td>
<td>
<a href="https://gitlab.com/oauth-xx/snaky_hash/"><img src="https://img.shields.io/badge/GitLab-FBA326?style=for-the-badge&logo=Gitlab&logoColor=orange" alt="Source on GitLab.com"></a> <a href="https://codeberg.org/oauth-xx/snaky_hash"><img src="https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue" alt="Source on CodeBerg.org"></a> <a href="https://github.com/oauth-xx/snaky_hash"><img src="https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=Github&logoColor=green" alt="Source on Github.com"></a> <a href="https://www.youtube.com/watch?v=dQw4w9WgXcQ"><img src="https://img.shields.io/badge/KLOC-0.132-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue" alt="The best SHA: dQw4w9WgXcQ!"></a>
</td>
</tr>
<tr>
<td>Documentation</td>
<td>
<a href="https://groups.google.com/g/oauth-ruby"><img src="https://img.shields.io/badge/google-group-0093D0.svg?style=for-the-badge&logo=google&logoColor=orange" alt="Discussion"></a> <a href="http://rubydoc.info/gems/snaky_hash"><img src="https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white" alt="Current release on RubyDoc.info"></a> <a href="https://snaky_hash.galtzo.com"><img src="https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white" alt="HEAD on RubyDoc.info"></a> <a href="http://www.railsbling.com/tags/snaky_hash"><img src="https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange" alt="BDFL Blog"></a> <a href="https://gitlab.com/oauth-xx/snaky_hash/-/wikis/home"><img src="https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=Wiki&logoColor=white" alt="Wiki"></a>
</td>
</tr>
<tr>
<td>Compliance</td>
<td>
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-259D6C.svg" alt="License: MIT"></a> <a href="https://www.ilo.org/declaration/lang--en/index.htm"><img src="https://img.shields.io/badge/ILO_Fundamental_Principles-%E2%9C%93-259D6C.svg?style=flat" alt="📄ilo-declaration-img"></a> <a href="file.SECURITY.html" title="<img src="https://img.shields.io/badge/security-policy-259D6C.svg?style=flat" alt="Security Policy">"><img src="https://img.shields.io/badge/security-policy-259D6C.svg?style=flat" alt="Security Policy"></a> <a href="file.CODE_OF_CONDUCT.html" title="<img src="https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg" alt="Contributor Covenant 2.1">"><img src="https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg" alt="Contributor Covenant 2.1"></a> <a href="https://semver.org/spec/v2.0.0.html"><img src="https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat" alt="SemVer 2.0.0"></a>
</td>
</tr>
<tr>
<td>Style</td>
<td>
<a href="https://github.com/rubocop-lts/rubocop-lts"><img src="https://img.shields.io/badge/code_style_%26_linting-rubocop--lts-34495e.svg?plastic&logo=ruby&logoColor=white" alt="Enforced Code Style Linter"></a> <a href="https://keepachangelog.com/en/1.0.0/"><img src="https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat" alt="Keep-A-Changelog 1.0.0"></a> <a href="https://gitmoji.dev"><img src="https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square" alt="Gitmoji Commits"></a>
</td>
</tr>
<tr>
<td>Support</td>
<td>
<a href="https://discord.gg/3qme4XHNKN"><img src="https://img.shields.io/discord/1373797679469170758?style=for-the-badge" alt="Live Chat on Discord"></a> <a href="https://www.upwork.com/freelancers/~014942e9b056abdf86?mp_source=share"><img src="https://img.shields.io/badge/UpWork-13544E?style=for-the-badge&logo=Upwork&logoColor=white" alt="Get help from me on Upwork"></a> <a href="https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github"><img src="https://img.shields.io/badge/CodeMentor-Get_Help-1abc9c?style=for-the-badge&logo=CodeMentor&logoColor=white" alt="Get help from me on Codementor"></a>
</td>
</tr>
<tr>
<td>Enterprise Support</td>
<td>
<a href="https://tidelift.com/subscription"><img src="https://img.shields.io/badge/Tidelift_and_Sonar-Enterprise_Support-FD3456?style=for-the-badge&logo=sonar&logoColor=white" alt="Get help from me on Tidelift"></a><br>💡Subscribe for support guarantees covering <em>all</em> FLOSS dependencies!<br>💡Tidelift is part of <a href="https://blog.tidelift.com/tidelift-joins-sonar">Sonar</a>!<br>💡Tidelift pays maintainers to maintain the software you depend on!<br>📊<code>@</code>Pointy Haired Boss: An <a href="https://tidelift.com/subscription">enterprise support</a> subscription is “<a href="https://www.youtube.com/watch?v=dQw4w9WgXcQ">never gonna let you down</a>”, and <em>supports</em> open source maintainers!</td>
</tr>
<tr>
<td>Comrade BDFL 🎖️</td>
<td>
<a href="http://www.linkedin.com/in/peterboling"><img src="https://img.shields.io/badge/PeterBoling-LinkedIn-0B66C2?style=flat&logo=newjapanprowrestling" alt="Follow Me on LinkedIn"></a> <a href="https://ruby.social/@galtzo"><img src="https://img.shields.io/mastodon/follow/109447111526622197?domain=https%3A%2F%2Fruby.social&style=flat&logo=mastodon&label=Ruby%20%40galtzo" alt="Follow Me on Ruby.Social"></a> <a href="https://bsky.app/profile/galtzo.com"><img src="https://img.shields.io/badge/@galtzo.com-0285FF?style=flat&logo=bluesky&logoColor=white" alt="Follow Me on Bluesky"></a> <a href="http://www.railsbling.com/contact"><img src="https://img.shields.io/badge/Contact-BDFL-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red" alt="Contact BDFL"></a> <a href="https://dev.to/galtzo"><img src="https://img.shields.io/badge/dev.to-0A0A0A?style=flat&logo=devdotto&logoColor=white" alt="My technical writing"></a>
</td>
</tr>
<tr>
<td>
<code>...</code> 💖</td>
<td>
<a href="https://angel.co/u/peter-boling"><img src="https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound" alt="Find Me on WellFound:"></a> <a href="https://www.crunchbase.com/person/peter-boling"><img src="https://img.shields.io/badge/peter--boling-purple?style=flat&logo=crunchbase" alt="Find Me on CrunchBase"></a> <a href="https://linktr.ee/galtzo"><img src="https://img.shields.io/badge/galtzo-purple?style=flat&logo=linktree" alt="My LinkTree"></a> <a href="https://about.me/peter.boling"><img src="https://img.shields.io/badge/about.me-0A0A0A?style=flat&logo=aboutme&logoColor=white" alt="More About Me"></a> <a href="https://codeberg.org/pboling">🧊</a> <a href="https://github.org/pboling">🐙</a> <a href="https://sr.ht/~galtzo/">🛖</a> <a href="https://gitlab.com/pboling">🧪</a>
</td>
</tr>
</tbody>
</table>
<h2 id="-installation">✨ Installation</h2>
<p>Install the gem and add to the application’s Gemfile by executing:</p>
<pre class="code ruby"><code class="ruby">$ bundle add snaky_hash
</code></pre>
<p>If bundler is not being used to manage dependencies, install the gem by executing:</p>
<pre class="code ruby"><code class="ruby">$ gem install snaky_hash
</code></pre>
<h3 id="-secure-installation">🔒 Secure Installation</h3>
<p><code>snaky_hash</code> is cryptographically signed, and has verifiable <a href="https://gitlab.com/oauth-xx/snaky_hash/-/tree/main/checksums">SHA-256 and SHA-512</a> checksums by<br>
<a href="https://github.com/pboling/stone_checksums">stone_checksums</a>. Be sure the gem you install hasn’t been tampered with<br>
by following the instructions below.</p>
<p>Add my public key (if you haven’t already, expires 2045-04-29) as a trusted certificate:</p>
<pre class="code language-shell"><code class="language-shell">gem cert --add <(curl -Ls https://raw.github.com/oauth-xx/snaky_hash/main/certs/pboling.pem)
</code></pre>
<p>You only need to do that once. Then proceed to install with:</p>
<pre class="code language-shell"><code class="language-shell">gem install snaky_hash -P MediumSecurity
</code></pre>
<p>The <code>MediumSecurity</code> trust profile will verify signed gems, but allow the installation of unsigned dependencies.</p>
<p>This is necessary because not all of <code>snaky_hash</code>’s dependencies are signed, so we cannot use <code>HighSecurity</code>.</p>
<p>If you want to up your security game full-time:</p>
<pre class="code language-shell"><code class="language-shell">bundle config set --global trust-policy MediumSecurity
</code></pre>
<p>NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.</p>
<h2 id="-basic-usage">🔧 Basic Usage</h2>
<pre class="code language-ruby"><code class="language-ruby">class MySnakedHash < Hashie::Mash
include SnakyHash::Snake.new(key_type: :string) # or :symbol
end
snake = MySnakedHash.new(:a => "a", "b" => "b", 2 => 2, "VeryFineHat" => "Feathers")
snake.a # => 'a'
snake.b # => 'b'
snake[2] # => 2
snake["2"] # => nil, note that this gem only affects string / symbol keys.
snake.very_fine_hat # => 'Feathers'
snake[:very_fine_hat] # => 'Feathers'
snake["very_fine_hat"] # => 'Feathers'
</code></pre>
<p>Note above that you can access the values via the string, or symbol.<br>
The <code>key_type</code> determines how the key is actually stored, but the hash acts as “indifferent”.<br>
Note also that keys which do not respond to <code>to_sym</code>, because they don’t have a natural conversion to a Symbol,<br>
are left as-is.</p>
<h3 id="serialization">Serialization</h3>
<pre class="code language-ruby"><code class="language-ruby">class MySerializedSnakedHash < Hashie::Mash
include SnakyHash::Snake.new(
key_type: :symbol, # default :string
serializer: true, # default: false
)
end
snake = MySerializedSnakedHash.new(:a => "a", "b" => "b", 2 => 2, "VeryFineHat" => "Feathers") # => {a: "a", b: "b", 2 => 2, very_fine_hat: "Feathers"}
dump = MySerializedSnakedHash.dump(snake) # => "{\"a\":\"a\",\"b\":\"b\",\"2\":2,\"very_fine_hat\":\"Feathers\"}"
hydrated = MySerializedSnakedHash.load(dump) # => {a: "a", b: "b", "2": 2, very_fine_hat: "Feathers"}
hydrated.class # => MySerializedSnakedHash
hydrated.a # => 'a'
hydrated.b # => 'b'
hydrated[2] # => nil # NOTE: this is the opposite of snake[2] => 2
hydrated["2"] # => 2 # NOTE: this is the opposite of snake["2"] => nil
hydrated.very_fine_hat # => 'Feathers'
hydrated[:very_fine_hat] # => 'Feathers'
hydrated["very_fine_hat"] # => 'Feathers'
</code></pre>
<p>Note that the key <code>VeryFineHat</code> changed to <code>very_fine_hat</code>.<br>
That is indeed the point of this library, so not a bug.</p>
<p>Note that the key <code>2</code> changed to <code>"2"</code> (because JSON keys are strings).<br>
When the JSON dump was reloaded it did not know to restore it as <code>2</code> instead of <code>"2"</code>.<br>
This is also not a bug, though if you need different behavior, there is a solution in the <a href="#extensions">next section</a>.</p>
<h3 id="extensions">Extensions</h3>
<p>You can write your own arbitrary extensions:</p>
<ul>
<li>“Hash Load” extensions operate on the hash and nested hashes
<ul>
<li>use <code>::load_hash_extensions.add(:extension_name) { |hash| }</code>
</li>
<li>since v2.0.2, bugs fixed in v2.0.3</li>
</ul>
</li>
<li>“Value Load” extensions operate on the values, and nested hashes’ values, if any
<ul>
<li>use <code>::load_value_extensions.add(:extension_name) { |value| }</code>
</li>
<li>since v2.0.2, bugs fixed in v2.0.3</li>
</ul>
</li>
<li>“Hash Dump” extensions operate on the hash and nested hashes
<ul>
<li>use <code>::dump_hash_extensions.add(:extension_name) { |value| }</code>
</li>
<li>since v2.0.3</li>
</ul>
</li>
<li>“Value Dump” extensions operate on the values, and nested hashes’ values, if any
<ul>
<li>use <code>::dump_value_extensions.add(:extension_name) { |value| }</code>
</li>
<li>since v2.0.2, bugs fixed in v2.0.3</li>
</ul>
</li>
</ul>
<h4 id="example">Example</h4>
<p>Let’s say I want to really smash up my hash and make it more food-like.</p>
<pre class="code language-ruby"><code class="language-ruby">class MyExtSnakedHash < Hashie::Mash
include SnakyHash::Snake.new(
key_type: :symbol, # default :string
serializer: true, # default: false
)
end
# We could swap all values with indexed apples (obliteraating nested data!)
MyExtSnakedHash.dump_hash_extensions.add(:to_apple) do |value|
num = 0
value.transform_values do |_key|
key = "apple-#{num}"
num += 1
key
end
end
# And then when loading the dump we could convert the yum to pear
MyExtSnakedHash.load_hash_extensions.add(:apple_to_pear) do |value|
value.transform_keys do |key|
key.to_s.sub("yum", "pear")
end
end
# We could swap all index numbers "beet-<number>"
MyExtSnakedHash.dump_value_extensions.add(:to_beet) do |value|
value.to_s.sub(/(\d+)/) { |match| "beet-#{match[0]}" }
end
# And then when loading the dump we could convert beet to corn
MyExtSnakedHash.load_value_extensions.add(:beet_to_corn) do |value|
value.to_s.sub("beet", "corn")
end
snake = MyExtSnakedHash.new({"YumBread" => "b", "YumCake" => {"b" => "b"}, "YumBoba" => [1, 2, 3]})
snake # => {yum_bread: "b", yum_cake: {b: "b"}, yum_boba: [1, 2, 3]}
snake.yum_bread # => "b"
snake.yum_cake # => {b: "b"}
snake.yum_boba # => [1, 2, 3]
dump = snake.dump
dump # => "{\"yum_bread\":\"apple-beet-0\",\"yum_cake\":\"apple-beet-1\",\"yum_boba\":\"apple-beet-2\"}"
hydrated = MyExtSnakedHash.load(dump)
hydrated # => {pear_bread: "apple-corn-0", pear_cake: "apple-corn-1", pear_boba: "apple-corn-2"}
</code></pre>
<p>See the specs for more examples.</p>
<h3 id="bad-ideas">Bad Ideas</h3>
<p>I don’t recommend using these features… but they exist (for now).</p>
<details>
<summary>Show me what I should *not* do!</summary>
You can still access the original un-snaked camel keys.
And through them you can even use un-snaked camel methods.
But don't.
```ruby
snake = SnakyHash::StringKeyed["VeryFineHat" => "Feathers"]
snake.key?("VeryFineHat") # => true
snake["VeryFineHat"] # => 'Feathers'
snake.VeryFineHat # => 'Feathers', PLEASE don't do this!!!
snake["VeryFineHat"] = "pop" # Please don't do this... you'll get a warning, and it works (for now), but no guarantees.
# WARN -- : You are setting a key that conflicts with a built-in method MySnakedHash#VeryFineHat defined in MySnakedHash. This can cause unexpected behavior when accessing the key as a property. You can still access the key via the #[] method.
# => "pop"
```
Since you are reading this, here's what to do instead.
```ruby
snake.very_fine_hat = "pop" # => 'pop', do this instead!!!
snake.very_fine_hat # => 'pop'
snake[:very_fine_hat] = "moose" # => 'moose', or do this instead!!!
snake.very_fine_hat # => 'moose'
snake["very_fine_hat"] = "cheese" # => 'cheese', or do this instead!!!
snake.very_fine_hat # => 'cheese'
```
</details>
<h3 id="-release-instructions">🚀 Release Instructions</h3>
<p>See <a href="file.CONTRIBUTING.html" title="CONTRIBUTING.md">CONTRIBUTING.md</a>.</p>
<h2 id="-security">🔐 Security</h2>
<p>See <a href="file.SECURITY.html" title="SECURITY.md">SECURITY.md</a>.</p>
<h2 id="-contributing">🤝 Contributing</h2>
<p>If you need some ideas of where to help, you could work on adding more code coverage,<br>
or if it is already 💯 (see <a href="#code-coverage">below</a>) check <a href="https://github.com/oauth-xx/snaky_hash/issues">issues</a>, or <a href="https://github.com/oauth-xx/snaky_hash/pulls">PRs</a>,<br>
or use the gem and think about how it could be better.</p>
<p>We <a href="https://keepachangelog.com/en/1.0.0/"><img src="https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat" alt="Keep A Changelog"></a> so if you make changes, remember to update it.</p>
<p>See <a href="file.CONTRIBUTING.html" title="CONTRIBUTING.md">CONTRIBUTING.md</a> for more detailed instructions.</p>
<h3 id="code-coverage">Code Coverage</h3>
<p><a href="https://coveralls.io/github/oauth-xx/snaky_hash?branch=main"><img src="https://coveralls.io/repos/github/oauth-xx/snaky_hash/badge.svg?branch=main" alt="Coveralls Test Coverage"></a><br>
<a href="https://qlty.sh/gh/oauth-xx/projects/snaky_hash"><img src="https://qlty.sh/badges/84e960b2-4ed2-4b47-9913-02c32680ec98/test_coverage.svg" alt="QLTY Test Coverage"></a></p>
<h3 id="-code-of-conduct">🪇 Code of Conduct</h3>
<p>Everyone interacting in this project’s codebases, issue trackers,<br>
chat rooms and mailing lists is expected to follow the <a href="file.CODE_OF_CONDUCT.html" title="<img src="https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg" alt="Contributor Covenant 2.1">"><img src="https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg" alt="Contributor Covenant 2.1"></a>.</p>
<h2 id="-contributors">🌈 Contributors</h2>
<p><a href="https://github.com/oauth-xx/snaky_hash/graphs/contributors"><img src="https://contrib.rocks/image?repo=oauth-xx/snaky_hash" alt="Contributors"></a></p>
<p>Made with <a href="https://contrib.rocks">contributors-img</a>.</p>
<p>Also see GitLab Contributors: <a href="https://gitlab.com/oauth-xx/snaky_hash/-/graphs/main">https://gitlab.com/oauth-xx/snaky_hash/-/graphs/main</a></p>
<h2 id="️-star-history">⭐️ Star History</h2>
<p><a href="https://star-history.com/#oauth-xx/snaky_hash&Date"></a></p>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=oauth-xx/snaky_hash&type=Date&theme=dark"></source>
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=oauth-xx/snaky_hash&type=Date"></source>
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=oauth-xx/snaky_hash&type=Date">
</picture>
<p></a></p>
<h2 id="-versioning">📌 Versioning</h2>
<p>This Library adheres to <a href="https://semver.org/spec/v2.0.0.html"><img src="https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat" alt="Semantic Versioning 2.0.0"></a>.<br>
Violations of this scheme should be reported as bugs.<br>
Specifically, if a minor or patch version is released that breaks backward compatibility,<br>
a new version should be immediately released that restores compatibility.<br>
Breaking changes to the public API will only be introduced with new major versions.</p>
<h3 id="-is-platform-support-part-of-the-public-api">📌 Is “Platform Support” part of the public API?</h3>
<p>Yes. But I’m obligated to include notes…</p>
<p>SemVer should, but doesn’t explicitly, say that dropping support for specific Platforms<br>
is a <em>breaking change</em> to an API.<br>
It is obvious to many, but not all, and since the spec is silent, the bike shedding is endless.</p>
<blockquote>
<p>dropping support for a platform is both obviously and objectively a breaking change</p>
</blockquote>
<ul>
<li>Jordan Harband (@ljharb, maintainer of SemVer) <a href="https://github.com/semver/semver/issues/716#issuecomment-869336139">in SemVer issue 716</a>
</li>
</ul>
<p>To get a better understanding of how SemVer is intended to work over a project’s lifetime,<br>
read this article from the creator of SemVer:</p>
<ul>
<li><a href="https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html">“Major Version Numbers are Not Sacred”</a></li>
</ul>
<p>As a result of this policy, and the interpretive lens used by the maintainer,<br>
you can (and should) specify a dependency on these libraries using<br>
the <a href="http://guides.rubygems.org/patterns/#pessimistic-version-constraint">Pessimistic Version Constraint</a> with two digits of precision.</p>
<p>For example:</p>
<pre class="code language-ruby"><code class="language-ruby">spec.add_dependency("snaky_hash", "~> 2.0")
</code></pre>
<p>See <a href="file.CHANGELOG.html" title="CHANGELOG.md">CHANGELOG.md</a> for list of releases.</p>
<h2 id="-license">📄 License</h2>
<p>The gem is available as open source under the terms of<br>
the <a href="file.LICENSE.html" title="MIT License">MIT License</a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-259D6C.svg" alt="License: MIT"></a>.<br>
See <a href="file.LICENSE.html" title="LICENSE.txt">LICENSE.txt</a> for the official <a href="https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year">Copyright Notice</a>.</p>
<h3 id="-copyright">© Copyright</h3>
<ul>
<li>
2022, 2025 Peter H. Boling, of
<a href="https://railsbling.com">
RailsBling.com
<picture>
<img alt="Rails Bling" height="20" src="https://railsbling.com/images/logos/RailsBling-TrainLogo.svg">
</picture>
</a>, and snaky_hash contributors
</li>
</ul>
<h2 id="-one-more-thing">🤑 One more thing</h2>
<p>You made it to the bottom of the page,<br>
so perhaps you’ll indulge me for another 20 seconds.<br>
I maintain many dozens of gems, including this one,<br>
because I want Ruby to be a great place for people to solve problems, big and small.<br>
Please consider supporting my efforts via the giant yellow link below,<br>
or one of the others at the head of this README.</p>
<p><a href="https://www.buymeacoffee.com/pboling"><img src="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" alt="Buy me a latte"></a></p>
<details>
<summary>Deprecated Badges</summary>
CodeCov currently fails to parse the coverage upload.
[![CodeCov Test Coverage][🔑codecovi♻️]][🔑codecov]
[![Coverage Graph][🔑codecov-g♻️]][🔑codecov]
</details>
</div></div>
<div id="footer">
Generated on Fri May 23 09:32:07 2025 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.4.3).
</div>
</div>
</body>
</html>
|