Project

faker-bot

0.09
No release in over 3 years
Low commit activity in last 3 years
Quickly look up Faker methods without leaving your terminal!
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 1.16
>= 0
~> 13.0
~> 3.0
~> 0.79.0
~> 0.12

Runtime

>= 0
~> 0.7.2
>= 0.20, < 1.1
 Project Readme

faker-bot

CI 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. See CONTRIBUTING.md. 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.