Skip to content

Ruby gem that provides fake sentences, questions, etc, based on famous texts

License

Notifications You must be signed in to change notification settings

sliuu/personal_faker

Repository files navigation

PersonalFaker

Build Status

This gem allows you to create fake sentences, questions, etc based on a famous text of your choosing.

On initialization, a table is created that matches each word in the text with the frequencies of words that come after it. The algorithm then loops through one word at a time, picking randomnly a word that comes after it in the text. If no word comes after it (i.e. the end of the text is reached, a random word from the text is chosen).

Installation

Add this line to your application's Gemfile:

gem 'personal_faker'

And then execute:

$ bundle

Or install it yourself as:

$ gem install personal_faker

Usage

Initialize the faker with your chosen text

my_faker = PersonalFaker::Base.new('macbeth')

Then you can create sentences that are based on the text

my_faker.sentence # "Wild snow and one fell enter three witches dance and Macbeth."

my_faker.text(3) # "Find mingle with drum and something wicked this great a heath. Thyself ourselves again banquo's buried he not for this downy sleep. Lesser ye go to scorn here I know it had else."

my_faker.word # "assistance"

my_faker.words(4) # "gentlewoman foot thou macduff's"

my_faker.question # "Chuck room in deed without our nights watched with you lack?"

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake rspec 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/sliuu/personal_faker. 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.

License

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

About

Ruby gem that provides fake sentences, questions, etc, based on famous texts

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published