Skip to content

Commit b9f9353

Browse files
committed
📝 Documentation updates
1 parent 227b8db commit b9f9353

File tree

2 files changed

+22
-9
lines changed

2 files changed

+22
-9
lines changed

CHANGELOG.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,21 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
66

77
## [Unreleased]
88
### Added
9+
### Changed
10+
### Fixed
11+
### Removed
12+
13+
## [2.0.2] - 2025-05-21 ([tag][2.0.2t])
14+
### Added
915
- Gem is signed by 20-year cert (@pboling)
1016
- Expires 2045-04-29
1117
- Gemspec metadata updates (@pboling)
1218
- Documentation updates (@pboling)
1319
- CI covering all code, and all key versions of runtime dependencies (@pboling)
20+
- Including Hashie v0, v1, v2, v3, v4, v5, and HEAD
1421
- [gh2](https://github.com/oauth-xx/snaky_hash/pull/2) - Serializer option (@pboling)
15-
### Changed
16-
### Fixed
17-
### Removed
22+
- [gh3](https://github.com/oauth-xx/snaky_hash/pull/3) - Serializer Extensions (@pboling)
23+
- Documentation site at [snaky-hash.galtzo.com](https://snaky-hash.galtzo.com)
1824

1925
## [2.0.1] - 2022-09-23 ([tag][2.0.1t])
2026
### Added
@@ -48,7 +54,9 @@ end
4854
### Added
4955
- Initial release
5056

51-
[Unreleased]: https://gitlab.com/oauth-xx/snaky_hash/-/compare/v2.0.1...main
57+
[Unreleased]: https://gitlab.com/oauth-xx/snaky_hash/-/compare/v2.0.2...main
58+
[2.0.21]: https://gitlab.com/oauth-xx/snaky_hash/-/compare/v2.0.1...v2.0.2
59+
[2.0.2t]: https://gitlab.com/oauth-xx/snaky_hash/-/releases/tag/v2.0.2
5260
[2.0.1]: https://gitlab.com/oauth-xx/snaky_hash/-/compare/v2.0.0...v2.0.1
5361
[2.0.1t]: https://gitlab.com/oauth-xx/snaky_hash/-/releases/tag/v2.0.1
5462
[2.0.0]: https://gitlab.com/oauth-xx/snaky_hash/-/compare/v1.0.1...v2.0.0

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
1-
# SnakyHash
1+
# 🐍 SnakyHash
22

33
[![Version][👽versioni]][👽version] [![License: MIT][📄license-img]][📄license-ref] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![Open Source Helpers][👽oss-helpi]][👽oss-help] [![Depfu][🔑depfui♻️]][🔑depfu] [![Coveralls Test Coverage][🔑coveralls-img]][🔑coveralls] [![QLTY Test Coverage][🔑qlty-covi♻️]][🔑qlty-cov] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Runtime Dependencies @ HEAD][🚎12-crh-wfi]][🚎12-crh-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI Truffle Ruby][🚎9-t-wfi]][🚎9-t-wf] [![CI JRuby][🚎10-j-wfi]][🚎10-j-wf] [![CI Supported][🚎6-s-wfi]][🚎6-s-wf] [![CI Legacy][🚎4-lg-wfi]][🚎4-lg-wf] [![CI Unsupported][🚎7-us-wfi]][🚎7-us-wf] [![CI Ancient][🚎1-an-wfi]][🚎1-an-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![CodeQL][🖐codeQL-img]][🖐codeQL]
44

55
---
66

77
[![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate to my FLOSS or refugee efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS or refugee efforts using Patreon][🖇patreon-img]][🖇patreon]
88

9-
This library is similar in purpose to the HashWithIndifferentAccess that is famously used in Rails.
9+
This library is similar in purpose to the HashWithIndifferentAccess that is famously used in Rails, but does a lot more.
1010

1111
This gem is used by `oauth` and `oauth2` gems to normalize hash keys to `snake_case` and lookups,
1212
and provide a nice psuedo-object interface.
1313

14-
It can be thought of as a mashup, with upgrades, to the `Rash` (specifically the [`rash_alt`](https://github.com/shishi/rash_alt) flavor), which is a special `Mash`, made popular by the `hashie` gem, and the `serialized_hashie` [gem by krystal](https://github.com/krystal/serialized-hashie).
14+
It can be thought of as a mashup of:
1515

16-
Classes that include `SnakyHash::Snake` should inherit from `Hashie::Mash`.
16+
* `Rash` (specifically the [`rash_alt`](https://github.com/shishi/rash_alt) flavor), which is a special `Mash`, made popular by the `hashie` gem, and
17+
* `serialized_hashie` [gem by krystal](https://github.com/krystal/serialized-hashie)
18+
19+
Classes that `include SnakyHash::Snake.new` should inherit from `Hashie::Mash`.
1720

1821
## New for v2.0.2: Serialization Support
1922

@@ -29,6 +32,8 @@ class MyStringKeyedHash < Hashie::Mash
2932
end
3033
```
3134

35+
✨ Also new dump & load plugin extensions to control the way your data is dumped and loaded.
36+
3237
| Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
3338
|-----------------------------------------------|-------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|
3439
| 🧪 [oauth-xx/snaky_hash on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜wiki] | 🏀 Tiny Matrix ||
@@ -187,7 +192,7 @@ That is indeed the point of this library, so not a bug.
187192

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

192197
### Extensions
193198

0 commit comments

Comments
 (0)