haikunate
Generate Heroku-like memorable random names like adorable-ox-1234.
Installation
Add this line to your application's Gemfile:
gem "haikunate"And then execute:
$ bundle install
Or install it yourself as:
$ gem install haikunate
Usage
You generate random haiku names by calling Haikunate.call (or its alias
Haiku.call).
Haiku.call
#=> satisfied-eagle-7977You can change the joiner string by provider the option joiner.
Haiku.call(joiner: ".")
#=> passionate.alpaca.7619A haiku composed by adjective-noun-variant, where variant is a random number
within 1000..9999 range. You can override the range by setting
Haiku.default_range.
Haiku.default_range = 10_000..99_999
#=> abundant-panda-57702Alternatively, you can provide a variant option, which can be any object that
responds to .call().
require "securerandom"
Haiku.call(variant: -> { SecureRandom.alphanumeric(5).downcase })
#=> tidy-skunk-s8ln0To override the dictionary list, use Haiku.adjectives=(list) and
Haiku.nouns=(list).
Haiku.adjectives = %w[awful terrible crazy]
Haiku.nouns = %w[lawyer judge politician]
Haiku.call
#=> terrible-politician-8116If you're planning to use a haiku as some unique value on your database, you can
use Haiku.next(options, &block); a new haiku will be generated until
block.call(haiku) returns false. For instance, this is how you'd use it with
ActiveRecord:
site = Site.new
site.slug = Haiku.next {|slug| Site.where(slug: slug).exists? }
site.save!That can be a problem for databases with lots and lots of records. If that's the case, you can then use a more random variant like 6 random alphanumeric characters.
You can override the default variant generator by setting
Haiku.default_variant=(new_variant).
Haiku.default_variant = -> { SecureRandom.alphanumeric(6).downcase }Maintainer
Contributors
Contributing
For more details about how to contribute, please read https://github.com/fnando/haikunate/blob/main/CONTRIBUTING.md.
License
The gem is available as open source under the terms of the MIT License. A copy of the license can be found at https://github.com/fnando/haikunate/blob/main/LICENSE.md.
Code of Conduct
Everyone interacting in the haikunate project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.