Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marioruiz/nice_hash
You can easily generate all the hashes you want following the criteria you specify. Many other features coming to Hash class like the methods 'bury' or select_key, access the keys like methods: my_hash.my_key.other_key. You will be able to generate thousands of different hashes just declaring one and test easily APIs based on JSON for example.
https://github.com/marioruiz/nice_hash
api generation hash json nicehash pattern random ruby ruby-gem string testing
Last synced: 11 days ago
JSON representation
You can easily generate all the hashes you want following the criteria you specify. Many other features coming to Hash class like the methods 'bury' or select_key, access the keys like methods: my_hash.my_key.other_key. You will be able to generate thousands of different hashes just declaring one and test easily APIs based on JSON for example.
- Host: GitHub
- URL: https://github.com/marioruiz/nice_hash
- Owner: MarioRuiz
- License: mit
- Created: 2018-05-21T15:22:45.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-19T12:50:47.000Z (8 months ago)
- Last Synced: 2024-10-04T17:59:23.315Z (about 1 month ago)
- Topics: api, generation, hash, json, nicehash, pattern, random, ruby, ruby-gem, string, testing
- Language: Ruby
- Homepage:
- Size: 154 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NiceHash
[](https://rubygems.org/gems/nice_hash)
[](https://github.com/MarioRuiz/nice_hash)
[](https://coveralls.io/github/MarioRuiz/nice_hash?branch=master)
NiceHash creates hashes following certain patterns so your testing will be much easier.
You can easily generate all the hashes you want following the criteria you specify.
Many other features coming to Hash class like the methods 'bury' or select_key, access the keys like methods: my_hash.my_key.other_key. You will be able to generate thousands of different hashes just declaring one and test easily APIs based on JSON for example.
You can also parse and filter a json string very easily.
To generate the strings following a pattern take a look at the documentation for string_pattern gem: https://github.com/MarioRuiz/string_pattern. Using string_pattern you can also generate Spanish or English words. We added support for generating strings from regular expressions but it is only working for the ´generate´ method, use it with caution since it is still on an early stage of development.
To use nice_hash on Http connections take a look at nice_http gem: https://github.com/MarioRuiz/nice_http
## Table of contents
- [Installation](#installation)
- [Usage](#usage)
* [How to access the different keys](#how-to-access-the-different-keys)
* [Change all values on the keys we specified](#change-all-values-on-the-keys-we-specified)
* [Filtering / Selecting an specific key on the hash and subhashes](#filtering---selecting-an-specific-key-on-the-hash-and-subhashes)
* [How to generate the hash with the criteria we want](#how-to-generate-the-hash-with-the-criteria-we-want)
* [How to generate the hash with wrong values for the string patterns specified on the hash](#how-to-generate-the-hash-with-wrong-values-for-the-string-patterns-specified-on-the-hash)
* [Return the select_fields or the pattern_fields](#return-the-select-fields-or-the-pattern-fields)
* [dig and bury Hash methods](#dig-and-bury-hash-methods)
* [Validating hashes](#validating-hashes)
* [Change only one value at a time and return an Array of Hashes](#change-only-one-value-at-a-time-and-return-an-array-of-hashes)
* [Adding other values on run time when calling `generate` method](#adding-other-values-on-run-time-when-calling--generate--method)
+ [Accessing other values of the hash on run time](#accessing-other-values-of-the-hash-on-run-time)
* [Compare the structure of a replica with the supplied structure](#compare-the-structure-of-a-replica-with-the-supplied-structure)
* [Other useful methods](#other-useful-methods)
+ [Time stamp](#time-stamp)
+ [Random dates](#random-dates)
+ [Deep copy of a hash](#deep-copy-of-a-hash)
+ [Nested deletion](#nested-deletion)
+ [Deep merge of two hashes](#deep-merge-of-two-hashes)
+ [Boolean class](#boolean-class)
* [Other tools integration](#other-tools-integration)
+ [Tabulo](#tabulo)
- [Contributing](#contributing)
- [License](#license)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'nice_hash'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install nice_hash
## Usage
Remember!! To generate the strings following a pattern take a look at the documentation for string_pattern gem: https://github.com/MarioRuiz/string_pattern. You can also generate Spanish or English words. We added support for generating strings from regular expressions but it is only working for the ´generate´ method, use it with caution since it is still on an early stage of development. All you have to do is to add to a key the value as a Regular expression, for example the key uuid in here will generate a random value like this: "E0BDE5B5-A738-49E6-83C1-9D1FFB313788"
```ruby
my_hash = {
uuid: /[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}/,
key: "Wsdf88888",
doomId: :"10:N"
}
```
This is the Hash we will be using on our examples:
```ruby
require 'nice_hash'
StringPattern.word_separator = ' '
my_hash={
loginame: :"5-10:/xn/",
[:pwd1, :pwd2, :pwd3] => :"5-10:L/n/",
name: :"10-20:T_/x/",
age: 18..120,
euros: 0.0..3000.0,
created: DateTime,
customer: Boolean,
draws: [
{
drawId: :"5:N",
drawName: :"10:Ln",
type: :"Weekely|Daily",
owner: {
default: 'admin',
correct: :"20:L"
}
},
{
drawId: :"5:N",
drawName: :"10:Ln",
type: :"Weekely|Daily",
owner: {
default: 'admin',
correct: :"20:L"
}
}
],
zip: {default: '00000', correct: :'5:N'},
address: "21 Doom Av",
city: {
default: "Madrid",
correct: "London|Rome"
},
wagers: ['34AAB', 'dfffDD', '33499A'],
country: {default: 'Spain', correct: ["Spain", "Iceland", "Serbia", "Denmark", "Canada", "Italy", "Austria"].join("|")}, #one of these values
mobilePhone: {default: '(987)654321', correct: ['(', :'3:N', ')', :'6-8:N']},
sex: :"male|female|other", #any of these values
display: true,
user_names: [ :'3-10:L' ]
}
```
Explanations of the different fields:
loginname: from 5 to 10 characters, mandatory to have lower letters and numbers
pwd, pwd2, pwd3: will have the same value. The value from 5 to 10 chars, optional capital and lower letters, necessary to contain numbers
name: from 10 to 20 chars. Optional national characters and space, necessary lower letters.
age: number from 18 to 120
euros: float number from 0.0 to 3000.0
created: Time stamp format, 2019-06-20T11:40:34.547Z
customer: Boolean, (true or false)
drawId: 5 numbers
drawName: 10 letters and/or numbers
type: 'Weekely' or 'Daily'
owner: correct: 20 letters
zip: correct: 5 numbers
city: correct: 'London' or 'Rome'
country: correct: one of these values "Spain", "Iceland", "Serbia", "Denmark", "Canada", "Italy", "Austria"
mobilePhone: correct: a sting pattern with one of the next: "(nnn) nnnnnn", "(nnn) nnnnnnn", "(nnn) nnnnnnnn"
sex: 'male' or 'female' or 'other'
user_names: array of strings from 3 to 10 letters
So in case you want to assign to a key a string pattern value like for example in loginame, you need to specify the string pattern as a symbol :"5-10:/xn/"
You can also supply an array of strings and string patterns, like on mobilePhone.correct: ['(', :'3:N', ')', :'6-8:N']}
Also you can specify to select one of the values you want by separating them with |, like for example on sex field: "male|female|other"
In case you want one pattern to be generated with unique values, so never repeat the same value for that particular pattern, use a symbol object pattern and add to the end of the pattern the symbol: &
```ruby
loginame: :"5-10:/xn/&",
```
Also if you have a JSON string you want to parse it and get the values of certain keys you can use the json method we added to nice_hash:
```ruby
my_json_string="{\"id\":344,\"customer\":{\"name\":\"Peter Smith\",\"phone\":334334333},\"tickets\":[{\"idt\":345,\"name\":\"myFavor1\"},{\"idt\":3123},{\"idt\":3145,\"name\":\"Special ticket\"}]}"
puts my_json_string.json(:idt)
#> [345, 3123, 3145]
puts my_json_string.json(:idt, :name)
#> {:name=>["Peter Smith", ["myFavor1", "Special ticket"]], :idt=>[345, 3123, 3145]}
```
To make easier to compare values by default it is setup SP_COMPARE_NUMBERS_AS_STRINGS = true, that will return true for example in these comparations:
* '300' == 300
* '300.12' == 300.12
* "" == nil
To avoid that set SP_COMPARE_NUMBERS_AS_STRINGS = false before `require 'nice_hash'`
Take in consideration certain libraries (fex 'net/ldap') are failing if `SP_COMPARE_NUMBERS_AS_STRINGS` is set to true. Since NiceHash is modifying the String class.
### How to access the different keys
You can access the keys of the hash like always, but now we added to the Hash class the posibility of accessing it using:
```ruby
puts my_hash[:address] # like usually is done
puts my_hash.address
my_hash.address = '99 Danish Street' #assignment
puts my_hash.loginame
puts my_hash.mobilePhone.correct
puts my_hash.draws[1].owner.correct
```
Also another way to access the different keys is by adding first underscore.
By doing it this way we are avoiding the cases where already exists a method with the same name on Hash class, for example: zip, display, default, select...
```ruby
puts my_hash._address
my_hash._address = '99 Danish Street' #assignment
my_hash._display = false #assignment
puts my_hash._loginame
puts my_hash._mobilePhone._correct
puts my_hash._draws[1]._owner._correct
puts my_hash._zip.correct #you can mix both also
```
By using the string_pattern gem you can generate single strings following the specific pattern on the field:
```ruby
puts my_hash.loginame.generate #>s93owuvkh
puts my_hash.mobilePhone.correct.generate #>(039)5669558
puts my_hash._zip._correct.gen # gen is an alias for generate method #>84584
```
If you want to search for all the values of one or more keys use get_values method:
```ruby
new_hash = my_hash.generate
puts new_hash.get_values(:address) #> {:address=>"21 Doom Av"}
puts new_hash.get_values(:address, :zip) #> {:zip=>{:default=>"00000", :correct=>"42782"}, :address=>"21 Doom Av"}
puts new_hash.get_values(:drawId) #> {:drawId=>["84914", "21158"]}
#using nested keys
puts new_hash.get_values(:'draws.drawId') #> {:'draws.drawId'=>["84914", "21158"]}
```
In case of an array of hashes, you will be able also to access the different keys, for example:
```ruby
my_array = [{name: 'Peter', city: 'Madrid'}, {name: 'Lola', city: 'NYC'}] :
my_array.city
#> ['Madrid', 'NYC']
my_array._name
#> ['Peter', 'Lola']
```
### Change all values on the keys we specified
Supply a hash with all the keys and the values you want to change on the hash, then it will return the hash/array with the values modified at any level.
```ruby
my_hash = {
path: "/api/users",
data: {
name: "morpheus",
job: "leader",
lab: {
doom: 'one',
beep: true,
name:'mario',
products: [
{
name: 'game',
price: 30
},
{
name: 'chair',
price: 130
}
]
}
}
}
# using NiceHash class
pp NiceHash.set_values(my_hash, { price: 75, beep: false } )
# using the Hash class
pp my_hash.set_values({ price: 75, beep: false })
# setting specific nested keys
pp my_hash.set_values({'data.lab.products.price': 75, 'data.lab.beep': false})
```
### Filtering / Selecting an specific key on the hash and subhashes
In case you supply different possibilities to be used like for example on fields: owner, zip, city and mobilePhone, and you one to use a concrete one, use the method select_key
```ruby
#using NiceHash class
new_hash = NiceHash.select_key(my_hash, :correct)
#using select_key method on Hash class
new_hash = my_hash.select_key(:correct)
default_hash = my_hash.select_key(:default)
```
On this example new_hash will contain:
```ruby
{
loginame: :"5-10:/xn/",
[:pwd1, :pwd2, :pwd3] => :"5-10:L/n/",
name: :"10-20:T_/x/",
age: 18..120,
euros: 0.0..3000.0,
created: DateTime,
customer: Boolean,
draws: [
{
drawId: :"5:N",
drawName: :"10:Ln",
type: :"Weekely|Daily",
owner: :"20:L"
},
{
drawId: :"5:N",
drawName: :"10:Ln",
type: :"Weekely|Daily",
owner: :"20:L"
}
],
zip: :'5:N',
address: "21 Doom Av",
city: "London|Rome",
wagers: ['34AAB', 'dfffDD', '33499A'],
country: ["Spain", "Iceland", "Serbia", "Denmark", "Canada", "Italy", "Austria"].join("|"), #one of these values
mobilePhone: ['(', :'3:N', ')', :'6-8:N'],
sex: :"male|female|other", #any of these values
display: true,
user_names: [ :'3-10:L' ]
}
```
Also you can filter the hash you want and return only the speficied keys by using the `nice_filter` method
```ruby
my_hash = { user: {
address: {
city: 'Madrid',
country: 'Spain'
},
name: 'Peter',
age: 33,
customers: [{name: 'Peter', currency: 'Euro'}, {name:'John', currency: 'Euro'}]
},
customer: true
}
pp my_hash.nice_filter([:'user.address.city', :'customer', :'user.customers.name'])
#> {:user=>
#> {:address=>{:city=>"Madrid"},
#> :customers=>[{:name=>"Peter"}, {:name=>"John"}]
#> },
#> :customer=>true
#> }
```
### How to generate the hash with the criteria we want
You can use the 'generate' method and everytime will be generated a different hash with different values.
Remember you can filter/select by a hash key
Using the NiceHash class:
```ruby
#without filtering
new_hash = NiceHash.generate(my_hash)
#filtering by a key passing the key on parameters
new_hash = NiceHash.generate(my_hash, :correct)
```
Using Hash class (you can use the alias 'gen' for 'generate'):
```ruby
#without filtering
new_hash = my_hash.generate
#filtering by a key passing the key on parameters
new_hash = my_hash.generate(:correct)
#filtering by a key using select_key method
new_hash = my_hash.select_key(:correct).generate
```
In case of filtering by :correct new_hash would have a value like this for example:
```ruby
{:loginame=>"s45x029o",
:pwd1=>"E6hz9YS7",
:pwd2=>"E6hz9YS7",
:pwd3=>"E6hz9YS7",
:name=>"OyTQNfEyPOzVYMxPym",
:age=> 19,
:euros=> 2133.34,
:created=> "2019-06-20T11:40:34.547Z",
:customer=> true,
:draws=>
[{:drawId=>"54591",
:drawName=>"cr5Q7pq4G8",
:type=>"Weekely",
:owner=>"nKEasYWInPGJxxElBZUB"},
{:drawId=>"73307",
:drawName=>"FnHPM4CsRC",
:type=>"Weekely",
:owner=>"cNGpHDhDLcxSFbOGqvNy"}],
:zip=>"47537",
:address=>"21 Doom Av",
:city=>"London",
:wagers=>["34AAB", "dfffDD", "33499A"],
:country=>"Denmark",
:mobilePhone=>"(707)8782080",
:sex=>"male",
:display=>true,
:user_names=>["FFrriNdw", "ACc"]
}
```
In case no filtering you will get all the values for all keys
### How to generate the hash with wrong values for the string patterns specified on the hash
We can generate wrong values passing the keyword argument: expected_errors (alias: errors)
The possible values you can specify is one or more of these ones: :length, :min_length, :max_length, :value, :required_data, :excluded_data, :string_set_not_allowed
:length: wrong length, minimum or maximum
:min_length: wrong minimum length
:max_length: wrong maximum length
:value: wrong resultant value
:required_data: the output string won't include all necessary required data. It works only if required data supplied on the pattern.
:excluded_data: the resultant string will include one or more characters that should be excluded. It works only if excluded data supplied on the pattern.
:string_set_not_allowed: it will include one or more characters that are not supposed to be on the string.
Examples:
```ruby
wrong_values = my_hash.generate(:correct, expected_errors: [:value])
wrong_max_length = my_hash.generate(:correct, errors: :max_length)
wrong_min_length = my_hash.generate(:correct, expected_errors: :min_length)
wrong_min_length = my_hash.select_key(:correct).generate(errors: :min_length)
valid_values = my_hash.generate(:correct)
```
On this example wrong_min_length will contain something like:
```ruby
{:loginame=>"0u",
:pwd1=>"4XDx",
:pwd2=>"4XDx",
:pwd3=>"4XDx",
:name=>"bU",
:age=> 5,
:euros=> -452.311,
:created=> "2019-06-20T11:40:34.547",
:customer=> true,
:draws=>
[{:drawId=>"", :drawName=>"P03AgdMqV", :type=>"Dail", :owner=>"dYzLRMCnVc"},
{:drawId=>"", :drawName=>"qw", :type=>"Dail", :owner=>"zkHhTEzM"}],
:zip=>"7168",
:address=>"21 Doom Av",
:city=>"Rom",
:wagers=>["34AAB", "dfffDD", "33499A"],
:country=>"Spai",
:mobilePhone=>"(237)17640431",
:sex=>"mal",
:display=>true,
:user_names=>["FF"]
}
```
### Return the select_fields or the pattern_fields
If you need a list of select fields or pattern fields that exist on your hash you can use the methods: select_fields and pattern_fields
It will return an array with all the fields found. On every entry of the array you will see keys to the field.
```ruby
all_select_fields = my_hash.select_fields
select_fields_on_correct = my_hash.select_fields(:correct)
all_pattern_fields = my_hash.pattern_fields
pattern_fields_on_correct = my_hash.pattern_fields(:correct)
```
all_select_fields contains:
```ruby
[[:draws, 0, :type],
[:draws, 1, :type],
[:city, :correct],
[:country, :correct],
[:sex]]
```
select_fields_on_correct contains:
```ruby
[[:draws, 0, :type],
[:draws, 1, :type],
[:city],
[:country],
[:sex]]
```
all_pattern_fields contains:
```ruby
[[:loginame],
[[:pwd1, :pwd2, :pwd3]],
[:name],
[:draws, 0, :drawId],
[:draws, 0, :drawName],
[:draws, 0, :owner, :correct],
[:draws, 1, :drawId],
[:draws, 1, :drawName],
[:draws, 1, :owner, :correct],
[:zip, :correct],
[:mobilePhone, :correct]],
[:user_names]
```
pattern_fields_on_correct contains:
```ruby
[[:loginame],
[[:pwd1, :pwd2, :pwd3]],
[:name],
[:draws, 0, :drawId],
[:draws, 0, :drawName],
[:draws, 0, :owner],
[:draws, 1, :drawId],
[:draws, 1, :drawName],
[:draws, 1, :owner],
[:zip],
[:mobilePhone]],
[:user_names]
```
### dig and bury Hash methods
In case you want to access the values on a hash structure by using the key array location, you can use the 'dig' method on the Hash class:
```ruby
min_length_error = my_hash.generate :correct, errors: :min_length
patterns = my_hash.pattern_fields :correct
patterns.each{|key|
if key[0].kind_of?(Array) # same values, like in pwd1, pwd2 and pwd3
puts "#{key} same values"
value = min_length_error.dig(key[0][0])
else
value = min_length_error.dig(*key)
end
pattern = my_hash.select_key(:correct).dig(*key)
puts "the value: '#{value}' was generated from the key: #{key} with pattern: #{pattern}"
}
```
This returns something like:
```
the value: '5z' was generated from the key: [:loginame] with pattern: 5-10:/xn/
[[:pwd1, :pwd2, :pwd3]] same values
the value: '5' was generated from the key: [[:pwd1, :pwd2, :pwd3]] with pattern: 5-10:L/n/
the value: 'KshiYAmp' was generated from the key: [:name] with pattern: 10-20:T_/x/
the value: '722' was generated from the key: [:draws, 0, :drawId] with pattern: 5:N
the value: '4' was generated from the key: [:draws, 0, :drawName] with pattern: 10:Ln
the value: 'jhVZkII' was generated from the key: [:draws, 0, :owner] with pattern: 20:L
the value: '260' was generated from the key: [:draws, 1, :drawId] with pattern: 5:N
the value: 'ssty8hlnJ' was generated from the key: [:draws, 1, :drawName] with pattern: 10:Ln
the value: 'zPvcwOyyXvWSgNHsuv' was generated from the key: [:draws, 1, :owner] with pattern: 20:L
the value: '242' was generated from the key: [:zip] with pattern: 5:N
the value: '(91)7606' was generated from the key: [:mobilePhone] with pattern: ["(", :"3:N", ")", :"6-8:N"]
```
Ruby Hash class doesn't have a method to allocate a value using the key array location so we added to Hash class a method for that purpose, the 'bury' method.
```ruby
default_values = my_hash.generate :default
default_values.bury([:draws, 0, :drawName], "FirstDraw")
```
After using the bury method default_values will contain:
```ruby
{:loginame=>"i0v2jy",
:pwd1=>"x33exx",
:pwd2=>"x33exx",
:pwd3=>"x33exx",
:name=>"HdmsjLxlEgYIFY",
:age=> 20,
:euros=> 155.11,
:created=>"2019-06-20T11:40:34.547Z",
:customer=> false,
:draws=>
[{:drawId=>"12318",
:drawName=>"FirstDraw",
:type=>"Weekely",
:owner=>"admin"},
{:drawId=>"18947",
:drawName=>"LPgf2ZQvkG",
:type=>"Weekely",
:owner=>"admin"}],
:zip=>"00000",
:address=>"21 Doom Av",
:city=>"Madrid",
:wagers=>["34AAB", "dfffDD", "33499A"],
:country=>"Spain",
:mobilePhone=>"(987)654321",
:sex=>"male",
:display=>true,
:user_names=>["FFrriNdw", "ACc"]
}
```
### Validating hashes
If you have a Hash that should follow the patterns you specified (in this example declared on my_hash) and you want to validate, then use the 'validate' method.
This is specially useful to test REST APIs responses in JSON
If we have a hash with these values:
```ruby
values = {
:loginame=>"rdewvqur",
:pwd1=>"d3ulo",
:pwd2=>"d3ulo",
:pwd3=>"d3ulo",
:name=>"LTqVKxxFCTqpkdjFkxU",
:age=> 20,
:euros=> 155.11,
:created=>"2019-06-20T11:40:34.547Z",
:customer=> false,
:draws=>
[{:drawId=>"54a43",
:drawName=>"h3F24yjMWp",
:type=>"Daily",
:owner=>"abIZMRxTDsWjQcpdspZt"},
{:drawId=>"13010",
:drawName=>"NurCEAtE1M",
:type=>"Daily",
:owner=>"vSVoqtSzHkbvRNyJoYGz"}],
:zip=>"30222",
:address=>"21 Doom Av",
:city=>"New York",
:wagers=>["34AAB", "dfffDD", "33499A"],
:country=>"Iceland",
:mobilePhone=>"(441)97037845",
:sex=>"male",
:display=>true,
:user_names=>['ddfdsa']
}
```
To validate those values against the patterns defined on my_hash:
```ruby
results_all_fields = my_hash.validate :correct, values
results_pattern_fields = my_hash.validate_patterns :correct, values
```
results_all_fields will contain all the validation errors:
```ruby
{:loginame=>[:value, :required_data],
:draws=>[{:drawId=>[:value, :string_set_not_allowed]}],
:city=>false}
```
and results_pattern_fields will contain only the validation errors for the fields containing patterns:
```ruby
{:loginame=>[:value, :required_data],
:draws=>[{:drawId=>[:value, :string_set_not_allowed]}]}
```
The possible validation values returned:
:length: wrong length, minimum or maximum
:min_length: wrong minimum length
:max_length: wrong maximum length
:value: wrong resultant value
:required_data: the output string won't include all necessary required data. It works only if required data supplied on the pattern.
:excluded_data: the resultant string will include one or more characters that should be excluded. It works only if excluded data supplied on the pattern.
:string_set_not_allowed: it will include one or more characters that are not supposed to be on the string.
You can also supply nested pattern keys for the patterns to be more specific: `{'draws.drawId': :"4:N"}`
### Change only one value at a time and return an Array of Hashes
Let's guess we need to test a typical registration REST service and the service has many fields with many validations but we want to test it one field at a time.
Then the best thing you can do is to use the method NiceHash.change_one_by_one.
```ruby
wrong_min_length_hash = my_hash.generate(:correct, errors: :min_length)
array_of_hashes = NiceHash.change_one_by_one([my_hash, :correct], wrong_min_length_hash)
array_of_hashes.each {|hash_with_one_wrong_field|
#Here your code to send through http the JSON data stored in hash_with_one_wrong_field
#if you want to know which field is the one that is wrong:
res = my_hash.validate(:correct, hash_with_one_wrong_field)
}
```
Take a look at a full example: https://gist.github.com/MarioRuiz/824d7a462b62fd85f02c1a09455deefb
### Adding other values on run time when calling `generate` method
If you need a value to be supplied for your key on run time every time you call the `generate` method you can use `lambda`
```ruby
my_hash = {
loginname: :"10:Ln",
datetime: lambda {
Time.now.stamp
},
other: Time.now.stamp
}
pp my_hash.gen
sleep 0.3
pp my_hash.gen
```
AS you can see in this example the value of the field `datetime` is different every time we generate the hash, but the value of the field `other` is generated the first time and it doesn't change later.
This is the output:
```
{:loginname=>"dQ1gwPvHHZ",
:datetime=>"2019-01-02T13:41:05.536",
:other=>"2019-01-02T13:41:05.536"}
{:loginname=>"WUCnWJmm0o",
:datetime=>"2019-01-02T13:41:05.836",
:other=>"2019-01-02T13:41:05.536"}
```
#### Accessing other values of the hash on run time
If you need for example to access another value of the key to generate a value on run time you can use `NiceHash.values`
Take a look at this example:
```ruby
my_hash = {
loginname: :"10:Ln",
send_email: :"true|false",
email: lambda {
if NiceHash.values._send_email=='true'
:"30-50:@".gen
else
""
end
}
}
pp my_hash.gen
pp my_hash.gen
pp my_hash.gen
```
This code will generate a hash where `send_email` can be `true` or `false`. In case it is `true` it will generate a value for the key `email` from 30 to 50 characters valid email, in case it is `false` it will contain empty string.
This is a possible output of the previous code:
```ruby
{:loginname=>"jnazA9iGN3",
:send_email=>"true",
:email=>"[email protected]"}
{:loginname=>"2CjT9wLMxq", :send_email=>"false", :email=>""}
{:loginname=>"XlMpgNPlLR", :send_email=>"false", :email=>""}
```
### Compare the structure of a replica with the supplied structure
By using the NiceHash.compare_structure method you can analyze the supplied replica and verify that the structure follows the one supplied on structure. It supports nested combination of arrays and hashes. It will return true if the comparison is successful.
```ruby
require 'nice_hash'
my_structure = [
{ name: 'xxx',
zip: 'yyyy',
customer: true,
product_ids: [1]
}
]
my_replica = [ {name: 'Peter Ben', zip: '1121A', customer: false, product_ids: []},
{name: 'John Woop', zip: '74014', customer: true, product_ids: [10,120,301]}]
NiceHash.compare_structure(my_structure, my_replica)
#>true
```
Another example that will return false since customer key is missing on first value in replica and the product_ids in the second value of replica contains an string instead of an integer.
```ruby
my_structure = [
{ name: 'xxx',
zip: 'yyyy',
customer: true,
product_ids: [1]
}
]
my_replica = [ {name: 'Peter Ben', zip: '1121A', product_ids: []},
{name: 'John Woop', zip: '74014', customer: true, product_ids: [10,'120',301]}]
NiceHash.compare_structure(my_structure, my_replica)
#>false
```
Also you can use a third parameter, compare_only_if_exist_key (Boolean), by default false. If true, in case an element exist on structure but doesn't exist on replica won't be verified.
The last parameter (patterns) allow you to add verification of data values following the patterns supplied on a one level hash.
Valid patterns:
- a regular expression
- any string_pattern, more info: string_pattern project: https://github.com/MarioRuiz/string_pattern
- array of a string_pattern:
- [ :'10-20:L' ]
- Boolean: specifying Boolean will check if the value is TrueClass or FalseClass
- ranges: Any kind of numeric ranges, for example:
- 10..400
- -20..50
- 60.0..500.0
- 10.. (from 10 to infinite) Only from Ruby 2.6
- DateTime: it will verify if the value is following Time stamp string '2019-06-20T12:01:09.971Z' or if the object is a Time, Date or DateTime class
- selectors, one of the values. Example: "uno|dos|tres"
### Other useful methods
#### Time stamp
In case you need the time stamp, we added the method `stamp` to the `Time` class
```ruby
puts Time.now.stamp
#> 2019-01-02T11:03:23.620Z
```
#### Random dates
In class `Date` we added a very handy `random` method you can use to generate random dates.
```ruby
# random date from today to 60 days after
puts Date.today.random(60)
# random date from 01-09-2005 to 100 days later
puts Date.strptime('01-09-2005', '%d-%m-%Y').random(100)
# random date from 2003/10/31 to today
puts Date.new(2003,10,31).random(Date.today)
```
#### Deep copy of a hash
If you need a clean copy of a hash use the method `deep_copy`
```ruby
my_hash = {one: 1, two: 2, three: {car: 'seat'}}
my_new_hash = my_hash.deep_copy # using deep_copy method
my_new_hash[:three][:car] = 'changed'
my_new_hash[:two] = 'changed'
p my_hash
# my_hash doesn't change
#>{:one=>1, :two=>2, :three=>{:car=>"seat"}}
my_new_hash = my_hash.clone # using clone or dup or direct assignment
my_new_hash[:three][:car] = 'changed'
my_new_hash[:two] = 'changed'
p my_hash
# my_hash changed!
#>{:one=>1, :two=>2, :three=>{:car=>"changed"}}
```
#### Nested deletion
If you want to delete a key on a nested hash you can use `delete_nested` and supply the key you want:
```ruby
my_hash = { user: {
address: {
city: 'Madrid',
country: 'Spain'
},
name: 'Peter',
age: 33
},
customer: true
}
NiceHash.delete_nested(my_hash, 'user.address.city')
#>{:user=>{:address=>{:country=>"Spain"}, :name=>"Peter", :age=>33}, :customer=>true}
```
#### Deep merge of two hashes
If you need to merge multidimensional hashes
```ruby
my_hash = {one: 1, two: 2, three: {car: 'seat'}}
other_hash = {one: 11, four: 44, three: {car: 'ferrari', model: 'unknown'}}
p my_hash.nice_merge(other_hash)
#>{:one=>11, :two=>2, :three=>{:car=>"ferrari", :model=>"unknown"}, :four=>44}
```
#### Boolean class
We added the possibility to check if a value is boolean or not since in Ruby doesn't exist, just TrueClass and FalseClass
```ruby
value = true
text = 'true'
value.is_a?(Boolean) #> true
text.is_a?(Boolean) #> false
```
#### in?(array)
Added method in? to all objects that accepts array as a parameter.
```ruby
'uno'.in?(['uno','dos']) #> true
:uno.in? [:uno, :dos] #> true
5.in? [1,2,3,4,6] #> false
```
### Other tools integration
#### Tabulo
You can use tabulo (https://github.com/matt-harvey/tabulo) and nice_hash together:
```ruby
require 'nice_hash'
require 'tabulo'
my_data = [
{id:'1', name: 'Peter', city: 'London', account: '112124', client: true },
{id:'2', name: 'Ann', city: 'Madrid', account: '4454656', client: true },
{id:'3', name: 'John', city: 'New York', account: '5645666', client: false }
]
puts Tabulo::Table.new(my_data, :id, :name, :city, :client, border: :modern).pack
```
It will generate:
```
┌────┬───────┬──────────┬────────┐
│ id │ name │ city │ client │
├────┼───────┼──────────┼────────┤
│ 1 │ Peter │ London │ true │
│ 2 │ Ann │ Madrid │ true │
│ 3 │ John │ New York │ false │
└────┴───────┴──────────┴────────┘
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/marioruiz/nice_hash.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).