tash 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab6c85df581e13d681640252f50c00910b817aaca27d74b335fb4e576d179556
+  data.tar.gz: 648d5676b1adb47290843bb4ad988e81ee645c9b118805ca4619785f42b91730
+SHA512:
+  metadata.gz: 9caea4c41ed62bdd53689f115b3af4eb4f807aa77175f88f45287598bf18e3a0a44e0f51123ade2a32c52d459c8392535f72a2a2f6827d5b1f081de0494de09e
+  data.tar.gz: 46f8610b260a5777eaa993c63436bdf46f247b18734310ab5766d6ad00e0d9ac1fadb61a5f8f81c1eceaa27b47fd750fbd701b5a59b7c9ef3e720b21b4b56955

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# [1.0.0][] (2022-06-25)
+
+Initial release.
+
+Support is available for all instance methods that exist on Hash except for `transform_keys` and `transform_keys!`.
+
+[1.0.0]: https://github.com/AaronLasseigne/tash/compare/v0.0.0...v1.0.0

data/CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Contributing
+
+The goal of Tash is to provide an interface that is as close to Hash as possible.
+Anything that adds additional functionality to an existing method will likely be rejected since it might conflict with future changes to Hash.
+Feel free to open a [discussion][] to talk through a new feature.
+
+The goal of Tash is to be fast.
+Any changes to speed it up are welcome.
+Please provide [benchmark-ips][] comparisons of before an after.
+An easy way to do this is to duplicate the method with a postfix of `_fast` and run it in a script or in `bin/console`.
+
+Example:
+
+``` rb
+t = Tash[...]
+
+Benchmark.ips do |x|
+  x.report('some_method') do
+    ...
+  end
+
+  x.report('some_method_fast') do
+    ...
+  end
+
+  x.compare!
+end
+```
+
+## Steps
+
+1. [Fork][] the repo.
+2. Add a breaking test for your change.
+3. Make the tests pass.
+4. Push your fork.
+5. Submit a pull request.
+
+## Code Style
+
+Running the tests using `rake` (with no args) will also check for style issues in the code.
+If you have a failure you cannot figure out push the PR and ask for help.
+
+[fork]: https://github.com/AaronLasseigne/tash/fork
+[discussion]: https://github.com/AaronLasseigne/tash/discussions/categories/ideas
+[benchmark-ips]: https://rubygems.org/gems/benchmark-ips

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Aaron Lasseigne
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,112 @@
+# [Tash][]
+
+Tash is a hash that allows for transformation of its keys.
+A transformation block is given to change the key.
+Keys can be looked up with any value that transforms into the same key.
+This means a hash can be string/symbol insensitive, case insensitive, can convert camel case JSON keys to snake case Ruby keys, or anything else based on the block you provide.
+
+[![Version](https://img.shields.io/gem/v/tash.svg?style=flat-square)](https://rubygems.org/gems/tash)
+[![Test](https://img.shields.io/github/workflow/status/AaronLasseigne/tash/Test?label=Test&style=flat-square)](https://github.com/AaronLasseigne/tash/actions?query=workflow%3ATest)
+
+---
+
+## Installation
+
+Add it to your Gemfile:
+
+``` rb
+gem 'tash', '~> 1.0'
+```
+
+Or install it manually:
+
+``` sh
+$ gem install tash --version '~> 1.0'
+```
+
+This project uses [Semantic Versioning][].
+Check out [GitHub releases][] for a detailed list of changes.
+
+## Usage
+
+Let's say that you wanted to have a hash where the keys are accessible as strings or symbols (i.e. `ActiveSupport::HashWithIndifferentAccess`).
+
+``` rb
+t = Tash[one: 1, two: 2, &:to_s]
+# => {"one"=>1, "two"=>2}
+
+t[:one]
+# => 1
+
+t['one']
+# => 1
+
+t[:three] = 9 # oops
+# => 9
+
+t['three'] = 3
+# => 3
+
+t[:three]
+# => 3
+
+t['three']
+# => 3
+```
+
+Lets say that you recieve a series of camel case JSON keys from an API call but want to access the information with Rubys typical snake case style and symbolized.
+
+``` rb
+json = { "firstName" => "Adam", "lastName" => "DeCobray" }
+
+t = Tash[json] do |key|
+  key
+    .to_s
+    .gsub(/(?<!\A)([A-Z])/, '_\1')
+    .downcase
+    .to_sym
+end
+
+t[:first_name]
+# => "Adam"
+
+t['firstName']
+# => "Adam"
+```
+
+This also works with pattern matching:
+
+``` rb
+t = Tash[ONE: 1, MORE: 200, &:downcase]
+
+case t
+in { One: 1, More: more }
+  more
+else
+  nil
+end
+# => 200
+```
+
+Tash implements `to_hash` for implicit hash conversion making it usable nearly everywhere you use a hash.
+
+Tash has every instance method Hash has except for `transform_keys` and `transform_keys!`.
+
+[API Documentation][]
+
+## Contributing
+
+If you want to contribute to Tash, please read [our contribution guidelines][].
+A [complete list of contributors][] is available on GitHub.
+
+## License
+
+Tash is licensed under [the MIT License][].
+
+[Tash]: https://github.com/AaronLasseigne/tash
+[semantic versioning]: http://semver.org/spec/v2.0.0.html
+[GitHub releases]: https://github.com/AaronLasseigne/tash/releases
+[API Documentation]: http://rubydoc.info/github/AaronLasseigne/tash
+[our contribution guidelines]: CONTRIBUTING.md
+[complete list of contributors]: https://github.com/AaronLasseigne/tash/graphs/contributors
+[the mit license]: LICENSE.txt

data/lib/tash/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Tash
+  VERSION = '1.0.0'
+end