FakerBot

Quickly look up Faker methods without leaving your terminal!

Motivation

I'm a huge fan of the Faker Gem and use it everywhere. However, sometimes I find myself digging through Faker's ReadMe when I'm unsure of a method's namespace or I'm just not sure what's available. :see_no_evil: I've always wished I had some way to search for the method names without leaving my terminal.

Installation

$ gem install fakerbot

Usage

1.) Run a quick lookup

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

2.) List methods

$ fakerbot list
# Faker::BackToTheFuture
# ├── quote
# ├── date
# └── character
# Faker::Finance
# └── credit_card
# ....

fakerbot also includes an option to display sample output via the --verbose or -v flag. :wink:

3.)

$ fakerbot list -v
# Faker::Appliance
# ├── brand=> Whirlpool
# └── equipment=> Sump pump
# Faker::UmphreysMcgee
# └── song=> Headphones & Snowcones
$ fakerbot search name -v
# Faker::App
# └── name=> Subin
# Faker::Address
# └── street_name=> Percy Landing
# ....

New Features! :sunglasses: :dancers:

[x] List classes with methods E.g. Faker::FunnyName should list .name,.first_name e.t.c.
[x] Expand search to Faker::Base sub classes
[x] Paginate results :book:

screen shot 2018-08-13 at 23 33 51

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/akabiru/fakerbot. 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. :beer:

License

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

Code of Conduct

Everyone interacting in the FakerBot project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.