Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akabiru/faker-bot
A tool to make it easier to pick the right Faker methods to generate the fake data you need. 🔍
https://github.com/akabiru/faker-bot
faker faker-bot faker-cli faker-gem
Last synced: 1 day ago
JSON representation
A tool to make it easier to pick the right Faker methods to generate the fake data you need. 🔍
- Host: GitHub
- URL: https://github.com/akabiru/faker-bot
- Owner: akabiru
- License: mit
- Created: 2017-12-11T20:23:12.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T23:51:31.000Z (4 months ago)
- Last Synced: 2024-12-05T11:13:04.479Z (7 days ago)
- Topics: faker, faker-bot, faker-cli, faker-gem
- Language: Ruby
- Homepage:
- Size: 255 KB
- Stars: 205
- Watchers: 5
- Forks: 21
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-ruby-cli-apps - faker-bot - Looks up [Faker](https://github.com/faker-ruby/faker) methods. (Awesome Ruby CLIs / Search)
README
# faker-bot
[](https://badge.fury.io/rb/faker-bot)
[](https://www.codetriage.com/faker-ruby/faker-bot)
[](https://codeclimate.com/github/faker-ruby/faker-bot/maintainability)
[](https://codeclimate.com/github/faker-ruby/faker-bot/test_coverage)
> Quickly look up [Faker](https://github.com/faker-ruby/faker) methods without leaving your terminal!
:book: [Code Documentation](https://www.rubydoc.info/github/faker-ruby/faker-bot)
## Installation
```bash
$ gem install faker-bot
```
## Usage
1.) Run a quick lookup
```bash
$ faker search name
# Faker::SwordArtOnline
# └── real_name
# └── game_name
# Faker::Superhero
# └── name
# ....
```
2.) List methods
```sh
$ faker list
# Faker::BackToTheFuture
# ├── quote
# ├── date
# └── character
# Faker::Finance
# └── credit_card
# ....
```
`faker` also includes an option to display sample output via the `--verbose` or `-v` flag. :wink:
3.)
```sh
$ faker list -v
# Faker::Appliance
# ├── brand=> Whirlpool
# └── equipment=> Sump pump
# Faker::UmphreysMcgee
# └── song=> Headphones & Snowcones
$ faker search name -v
# Faker::App
# └── name=> Subin
# Faker::Address
# └── street_name=> Percy Landing
# ....
```
## 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).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/faker-ruby/faker-bot. See [CONTRIBUTING.md](https://github.com/faker-ruby/faker-bot/blob/master/CONTRIBUTING.md).
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.
## Credits
Terminal awesomeness made easy by the [TTY Toolkit](http://piotrmurach.github.io/tty/). :beer:
## 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 faker-bot project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/faker-ruby/faker-bot/blob/master/CODE_OF_CONDUCT.md).