https://github.com/sayantam/deep_hash_struct
Converts a (possibly nested) Hash to a (nested) Struct.
https://github.com/sayantam/deep_hash_struct
ruby
Last synced: over 1 year ago
JSON representation
Converts a (possibly nested) Hash to a (nested) Struct.
- Host: GitHub
- URL: https://github.com/sayantam/deep_hash_struct
- Owner: sayantam
- License: mit
- Created: 2020-07-18T20:13:09.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-21T19:33:59.000Z (almost 6 years ago)
- Last Synced: 2024-04-25T00:34:01.001Z (about 2 years ago)
- Topics: ruby
- Language: Ruby
- Homepage:
- Size: 23.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# DeepHashStruct
Utility function to convert a Hash to a Struct. The Hash can be arbitrarily nested, the corresponding
object will have same level of nesting.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'deep_hash_struct'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install deep_hash_struct
## Usage
```ruby
include DeepHashStruct
```
### Example 1
```ruby
input = { x: 1, y: { z: 2 } }
point = deep_struct(input)
point.x #=> 1
point.y.z #=> 2
```
### Example 2
```ruby
input = { foo: [{ x: [{ y: { z: 1 } }] }] }
obj = deep_struct(input)
obj.foo[0].x[0].y.z #=> 1
```
### Example 3
```ruby
input = { foo: { bar: [{ x: 1 }]} }
obj = deep_struct(input)
obj.foo.bar[0].x #=> 1
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/sayantam/deep_struct. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the DeepStruct project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sayantam/deep_struct/blob/master/CODE_OF_CONDUCT.md).