Skip to content
πŸ”A tool to make it easier to pick the right Faker methods to generate the fake data you need.
Ruby Other
  1. Ruby 99.0%
  2. Other 1.0%
Branch: master
Clone or download

README.md

faker-bot

Build Status Gem Version Open Source Helpers Maintainability Test Coverage

Quickly look up Faker methods without leaving your terminal!

faker-bot-demo

πŸ“– Code Documentation

Installation

$ gem install faker-bot

Usage

1.) Run a quick lookup

$ faker search name
# Faker::SwordArtOnline
# └── real_name
# └── game_name
# Faker::Superhero
# └── name
# ....

2.) List methods

$ 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. πŸ˜‰

3.)

$ 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/faker-ruby/faker-bot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Credits

Terminal awesomeness made easy by the TTY Toolkit. 🍺

License

The gem is available as open source under the terms of the MIT License.

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.

You can’t perform that action at this time.