https://github.com/torokmark/kovacs
:person_with_blond_hair: :woman: Simple fake person generator
https://github.com/torokmark/kovacs
Last synced: about 1 year ago
JSON representation
:person_with_blond_hair: :woman: Simple fake person generator
- Host: GitHub
- URL: https://github.com/torokmark/kovacs
- Owner: torokmark
- License: mit
- Created: 2018-11-30T21:10:36.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-05T10:09:02.000Z (over 7 years ago)
- Last Synced: 2025-01-28T18:31:13.562Z (over 1 year ago)
- Language: Ruby
- Homepage: https://torokmark.github.io/kovacs/
- Size: 40 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Kovacs
[](https://travis-ci.org/torokmark/kovacs)
[](https://badge.fury.io/rb/kovacs)
Kovacs is one of the most common surnames in Eastern Europe from Slovakia to Hungary to Croatia. (This is the Hungarian form). It means blacksmith in English. With this gem we can smith names based on nationalities.
Kovacs is a simple gem that helps you generate fake data for a person entity based on real life names, nationalities and sex.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'kovacs'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install kovacs
## Usage
### 1. Simpliest
Just simply generate a person. It takes a nationality from the listed nationalities placed inside the `resources` folder. (nationality has to be a folder as well.)
Then it generates a sex and based on these two, it generates names.
```ruby
p Kovacs.generate
# => #
p Kovacs.generate.to_h
# => {:nationality=>:slovak, :sex=>:male, :forename=>"Miroslav", :middle_name=>"Jan", :surname=>"Cvikota"}
```
### 2. Generate just one of the attributes
```ruby
p Kovacs.forename(['Jancsi', 'Julcsi'])
# => "Jancsi"
```
### 3. Generate via config
```ruby
person = Kovacs.config do |config|
config.surname = :hungarian
config.forename = 'Elek'
config.middle_name = ['Karoly', 'Erno', 'Ervin']
config.sex = :male
config.nationality = [:hungarian, :slovak]
end.generate
p person
# => #
```
### 4. Acceptable arguments
1. *None*: will be generated based on the nationalities, sex and list of names placed in `resources`.
```ruby
Kovacs.forename
```
2. *Simple String*: the value will be the string argument itself.
```ruby
Kovacs.forename('Jancsi')
```
3. *Symbol*: symbol represents the nationality. Value will be generated based on the specified nationality, and sex which is randomly generated.
```ruby
Kovacs.forename(:hungarian)
```
4. *Nationality and sex*: Value will be generated based on the spedified nationality and the specified sex.
```ruby
Kovacs.forename(:hungarian, :male)
```
5. *Array of Strings*: One of them will be taken randomly.
```ruby
Kovacs.forename(['Jancsi', 'Julcsi'])
```
6. *Array of Symbols*: One of them will be taken randomly, name is taken randomly based on that nationality.
```ruby
Kovacs.forename([:hungarian, :slovak])
```
7. *Array of Symbols and sex*: Nationality will be taken randomly, name is taken randomly based on that nationality and specified sex.
```ruby
Kovacs.forename([:hungarian, :slovak], :female)
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
## Plugin for names
1. Create a folder inside the `resources` folder. (from this time, this is considered as nationality, whichever name you would pick for it)
2. Place the following files in the newly created folder:
* `male_forename.txt`
* `female_forename.txt`
* `surname.txt`
3. Content of these files is considered as forenames and surnames grouped as female and male names.
4. You can refere to this nationality by using symbols.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/torokmark/kovacs. 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.
## Code of Conduct
Everyone interacting in the Kovacs project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/torokmark/kovacs/blob/master/CODE_OF_CONDUCT.md).