Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/schmich/spicy-proton
Generate a random English adjective-noun word pair in Ruby
https://github.com/schmich/spicy-proton
adjective adverb fun generator names noun random ruby verb
Last synced: 13 days ago
JSON representation
Generate a random English adjective-noun word pair in Ruby
- Host: GitHub
- URL: https://github.com/schmich/spicy-proton
- Owner: schmich
- License: mit
- Created: 2017-01-28T05:54:06.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-08-19T21:52:46.000Z (about 1 year ago)
- Last Synced: 2024-04-14T07:44:37.179Z (7 months ago)
- Topics: adjective, adverb, fun, generator, names, noun, random, ruby, verb
- Language: Ruby
- Homepage: https://rubygems.org/gems/spicy-proton
- Size: 504 KB
- Stars: 98
- Watchers: 4
- Forks: 21
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Spicy::Proton
Generate a random English adjective-noun word pair. Works with Ruby 1.9.x and newer.
[](http://rubygems.org/gems/spicy-proton)
[](https://travis-ci.org/schmich/spicy-proton)
## Quick Start
`gem install spicy-proton`
```ruby
require 'spicy-proton'
puts Spicy::Proton.pair
# => "decadent-inquisition"
```
## Usage
**Option 1: Class methods**
When generating single or infrequent specimens, class methods are faster and use less memory.
```ruby
require 'spicy-proton'
Spicy::Proton.adjective # => "extreme"
Spicy::Proton.noun # => "loan"
Spicy::Proton.pair # => "opportune-spacesuit"
Spicy::Proton.pair(':') # => "hip:squash"
Spicy::Proton.adverb # => "energetically"
Spicy::Proton.verb # => "refrained"
Spicy::Proton.format('%a/%a/%n') # => "dapper/festive/fedora"
Spicy::Proton.format('%b %v') # => "artfully stained"
# With length constraints.
Spicy::Proton.adjective(max: 5) # => "dank"
Spicy::Proton.noun(min: 10) # => "interpolation"
Spicy::Proton.adjective(length: 8) # => "medieval"
Spicy::Proton.noun(min: 5, max: 7) # => "dolphin"
Spicy::Proton.adverb(min: 0) # => "prophetically"
Spicy::Proton.verb(max: 100) # => "sparkles"
```
**Option 2: Instance methods**
When generating multiple specimens, instance methods are faster. The instance keeps the word corpus in memory. The instance methods are the same as their class method counterparts.
```ruby
require 'spicy-proton'
gen = Spicy::Proton.new
1000.times do
gen.adjective
gen.noun(min: 7)
gen.pair
gen.pair('.')
gen.adverb(length: 6)
gen.verb(max: 5)
gen.format('The %a %n %b %v the %n.')
end
```
Instances also provide raw word lists in length-alphabetic order:
```ruby
gen.adjectives # => ["aft", "apt", "bad", "big", ...]
gen.nouns # => ["ad", "ax, "ox", "pi", ...]
gen.adverbs # => ["no", "aft", "ago", "all", ...]
gen.verbs # => ["am", "be", "do", "go", ...]
```
## Credits
Inspired by [btford/adj-noun](https://github.com/btford/adj-noun). Thanks to [NLTK](http://www.nltk.org/) for the word corpus.
## License
Copyright © 2017 Chris Schmich
MIT License. See [LICENSE](LICENSE) for details.