File: README — Documentation by YARD 0.9.44

# 🔮 SnakyHash

`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.

👣 How will this project approach the September 2025 hostile takeover of RubyGems? 🚑️
I've summarized my thoughts in [this blog post](https://dev.to/galtzo/hostile-takeover-of-rubygems-my-thoughts-5hlo).

## 🌻 Synopsis

## 💡 Info you can shake a stick at

Tokens to Remember |
--- | ---
Works with JRuby |
Works with Truffle Ruby |
Works with MRI Ruby 4 |
Works with MRI Ruby 3 |
Works with MRI Ruby 2 |
Support & Community |
Source |
Documentation |
Compliance |
Style |
Maintainer 🎖️ |
`...` 💖 | 🧊 🐙 🛖 🧪

### Compatibility

Compatible with MRI Ruby 2.2.0+, and concordant releases of JRuby, and TruffleRuby.
CI workflows and Appraisals are generated for MRI Ruby 2.4+.
This test floor is configured by `ruby.test_minimum` in `.kettle-jem.yml` and
may be higher than the gem’s runtime compatibility floor when legacy Rubies are
not practical for the current toolchain.

🚚 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 Repository | Status | Issues | PRs | Wiki | CI | Discussions
--- | --- | --- | --- | --- | --- | ---
🧪 ruby-oauth/snaky_hash on GitLab | The Truth | 💚 | 💚 | 💚 | 🐭 Tiny Matrix | ➖
🧊 ruby-oauth/snaky_hash on CodeBerg | An Ethical Mirror (Donate) | 💚 | 💚 | ➖ | ⭕️ No Matrix | ➖
🐙 ruby-oauth/snaky_hash on GitHub | Another Mirror | 💚 | 💚 | 💚 | 💯 Full Matrix | 💚
🎮️ Discord Server |  | Let’s | talk | about | this | library!

### 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.

- 💡Subscribe for support guarantees covering all your FLOSS dependencies
- 💡Tidelift is part of Sonar
- 💡Tidelift pays maintainers to maintain the software you depend on!
  📊`@`Pointy Haired Boss: An enterprise support subscription is “never gonna let you down”, and supports open source maintainers

Alternatively:

## ✨ Installation

Install the gem and add to the application’s Gemfile by executing:

    bundle add snaky_hash

If bundler is not being used to manage dependencies, install the gem by executing:

    gem install snaky_hash

## ⚙️ Configuration

## 🔧 Basic Usage

    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'

Note above that you can access the values via the string, or symbol.
The `key_type` determines how the key is actually stored, but the hash acts as “indifferent”.
Note also that keys which do not respond to `to_sym`, because they don’t have a natural conversion to a Symbol,
are left as-is.

### Serialization

    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'

Note that the key `VeryFineHat` changed to `very_fine_hat`.
That is indeed the point of this library, so not a bug.

Note that the key `2` changed to `"2"` (because JSON keys are strings).
When the JSON dump was reloaded it did not know to restore it as `2` instead of `"2"`.
This is also not a bug, though if you need different behavior, there is a solution in the next section.

### Extensions

You can write your own arbitrary extensions:

- “Hash Load” extensions operate on the hash and nested hashes
  - use `::load_hash_extensions.add(:extension_name) { |hash| }`
  - since v2.0.2, bugs fixed in v2.0.3
- “Value Load” extensions operate on the values, and nested hashes’ values, if any
  - use `::load_value_extensions.add(:extension_name) { |value| }`
  - since v2.0.2, bugs fixed in v2.0.3
- “Hash Dump” extensions operate on the hash and nested hashes
  - use `::dump_hash_extensions.add(:extension_name) { |value| }`
  - since v2.0.3
- “Value Dump” extensions operate on the values, and nested hashes’ values, if any
  - use `::dump_value_extensions.add(:extension_name) { |value| }`
  - since v2.0.2, bugs fixed in v2.0.3

#### Example

Let’s say I want to really smash up my hash and make it more food-like.

    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"}

See the specs for more examples.

### Bad Ideas

I don’t recommend using these features… but they exist (for now).

Show me what I should *not* do!
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' ```

### 🚀 Release Instructions

See CONTRIBUTING.md.

## 🦷 FLOSS Funding

While ruby-oauth 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.
Currently, Open Collective is our preferred funding platform.

If you’re working in a company that’s making significant use of ruby-oauth tools we’d
appreciate it if you suggest to your company to become a ruby-oauth sponsor.

You can support the development of ruby-oauth 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 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

Coverage service badges

### 🪇 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/ruby-oauth/snaky_hash/-/graphs/main

⭐️ Star History

## 📌 Versioning

This library follows for its public API where practical.
For most applications, prefer the Pessimistic Version Constraint with two digits of precision.

For example:

    spec.add_dependency("snaky_hash", "~> 2.0")

📌 Is "Platform Support" part of the public API? More details inside.

Dropping support for a platform can be a breaking change for affected users. If a release changes supported platforms, it should be called out clearly in the changelog and versioned with that impact in mind.

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”

See CHANGELOG.md for a list of releases.

## 📄 License

The gem is available as open source under the terms of
the MIT .

### © Copyright

See LICENSE.md for the official copyright notice.

Copyright holders

- Copyright (c) 2022, 2025-2026 Peter H. Boling

## 🤑 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 ⭐ ♥.

Many parts of this project are actively managed by a kettle-jem smart template utilizing StructuredMerge.org merge contracts.

Thanks for RTFM. ☺️

| Field | Value |
|—|—|
| Package | snaky_hash |
| Description | 🔮 A Hashie::Mash joint to make #snakelife better |
| Homepage | https://github.com/ruby-oauth/snaky_hash |
| Source | https://github.com/ruby-oauth/snaky_hash/tree/v2.0.5 |
| License | `MIT` |
| Funding | https://github.com/sponsors/pboling, https://issuehunt.io/u/pboling, https://ko-fi.com/pboling, https://liberapay.com/pboling/donate, https://opencollective.com/ruby-oauth, https://patreon.com/galtzo, https://polar.sh/pboling, https://thanks.dev/u/gh/pboling, https://tidelift.com/funding/github/rubygems/snaky_hash, https://www.buymeacoffee.com/pboling |