Cryptozoologist Build Status

Cryptozoologist is a fun little gem written as part of the Gem guide project.

Cryptozoologist generates random strings from animal, clothing item, and color pairings. You could get something like "orange-clownfish-turtleneck" or "magenta-three-toed-sloth-shoe-horn". It's fun and silly - it's also very simple, which is why it is used as an example for the Gem guide project.

This gem is still in active devemopment; complete documentation will be added as the gem (and the Gem guide) progress!

(No, really, it will be added: it's part of the guide!)

Installation

Add this line to your application's Gemfile:

gem 'cryptozoologist'

And then execute:

$ bundle

Or install it yourself as:

$ gem install cryptozoologist

Usage

Right now, this gem doesn't do much of anything except over architect a series of word lists.

Available word lists

  • colors
  • animals
  • clothing
  • quantity

Configuration options

Exclude:

  • animals:
    • :common, :mythical
  • colors:
    • :paint, :web

Note: you can only exclude one of each or you won't have any words in your list!

Example

  Cryptozoologist.configure do |config|
    config.exclude = [:common]
  end

  dictionary = Cryptozoologist::Dictionary.new
  animals = dictionary.animals
  animals.sample # => "crumple horned snorkack"

Get a random animal

  dictionary = Cryptozoologist::Dictionary.new
  animals = dictionary.animals
  animals.sample # => "sun bear"

Get a random color

  dictionary = Cryptozoologist::Dictionary.new
  colors = dictionary.colors
  colors.sample # => "pink"

Get a random measure of quantity

  dictionary = Cryptozoologist::Dictionary.new
  quantity = dictionary.quantity
  quantity.sample # => "limitless"

Get a random item of clothing

  dictionary = Cryptozoologist::Dictionary.new
  clothing = dictionary.clothing
  clothing.sample # => "suspenders"