Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thisismydesign/ndhash
N-dimension hash creation and utilities for Ruby
https://github.com/thisismydesign/ndhash
Last synced: 8 days ago
JSON representation
N-dimension hash creation and utilities for Ruby
- Host: GitHub
- URL: https://github.com/thisismydesign/ndhash
- Owner: thisismydesign
- License: mit
- Created: 2016-04-03T16:27:56.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-10-09T21:52:20.000Z (about 8 years ago)
- Last Synced: 2024-12-01T01:27:27.623Z (24 days ago)
- Language: Ruby
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Ndhash
N-dimension hash creation and utilities. Useful for testing multi-level hash and JSON processing.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'ndhash'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install ndhash
## Usage
```ruby
require 'ndhash'
# Generate hash with custom number of levels, number of key-value pairs and hashes per level
NDHash.generate(levels:2, values_per_level:2, hashes_per_level:2)
```
```json
{
"level_1_key_1": "level_1_value_1",
"level_1_key_2": "level_1_value_2",
"level_1_pointer_1": {
"level_2_key_1": "level_2_value_1",
"level_2_key_2": "level_2_value_2"
},
"level_1_pointer_2": {
"level_2_key_1": "level_2_value_1",
"level_2_key_2": "level_2_value_2"
}
}
```
```ruby
NDHash.generate(levels:2, values_per_level:0, hashes_per_level:2)
```
```json
{
"level_1_pointer_1": {},
"level_1_pointer_2": {}
}
```
```ruby
# Count number of nested levels per hash
NDHash.count_levels({key:{}}})
# => 2
```
Check the unit tests for more examples.
## Feedback
Any feedback is much appreciated.
I can only tailor this project to fit use-cases I know about - which are usually my own ones. If you find that this might be the right direction to solve your problem too but you find that it's suboptimal or lacks features don't hesitate to contact me.
Please let me know if you make use of this project so that I can prioritize further efforts.
## Development
After checking out the repo, run `bin/setup` to install dependencies. 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/csapagyi/ndhash. 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](http://opensource.org/licenses/MIT).