random_name_generator 1.2.2 → 2.0.0

data/README.md

@@ -6,14 +6,20 @@
 [![Coverage Status](https://coveralls.io/repos/github/folkengine/random_name_generator/badge.svg?branch=master)](https://coveralls.io/github/folkengine/random_name_generator?branch=master)
 [![Inline docs](http://inch-ci.org/github/folkengine/random_name_generator.svg?branch=master)](http://inch-ci.org/github/folkengine/random_name_generator)
 
-Ruby port of [java-random-name-generator](https://github.com/folkengine/java-random-name-generator), which in turn is a gradle enabled version of [Sinipull's GPL'd post on codecall.net](http://forum.codecall.net/topic/49665-java-random-name-generator/).
+Ruby port of
+[java-random-name-generator](https://github.com/folkengine/java-random-name-generator),
+which in turn is a gradle enabled version of
+[Sinipull's GPL'd post on codecall.net](http://forum.codecall.net/topic/49665-java-random-name-generator/).
 
-The big difference between this random name generator and others is that it allows you to create names in various
-custom styles such as Elven, and Roman. If you're looking for a quick name for a Goblin NPC, RandomNameGenerator is
-your gem.
+**For other languages see
+[RandomNameGeneratorHub](https://github.com/folkengine/RandomNameGeneratorHub)**.
 
-------
+The big difference between this random name generator and others is that
+it allows you to create names in various custom styles such as Elven,
+and Roman. If you're looking for a quick name for a Goblin NPC,
+RandomNameGenerator is your gem.
 
+------
 
 ## Installation
 
@@ -25,21 +31,24 @@ gem 'random_name_generator'
 
 And then execute:
 
-    $ bundle
+    $❯ bundle install
 
 Or install it yourself as:
 
-    $ gem install random_name_generator
+    $❯ gem install random_name_generator
 
 ## Usage
 
 RandomNameGenerator comes with several styles of syllable files:
-[Elven](https://github.com/folkengine/random_name_generator/blob/master/lib/random_name_generator/languages/elven.txt),
-[Fantasy](https://github.com/folkengine/random_name_generator/blob/master/lib/random_name_generator/languages/fantasy.txt),
-[Goblin](https://github.com/folkengine/random_name_generator/blob/master/lib/random_name_generator/languages/goblin.txt),
-and [Roman](https://github.com/folkengine/random_name_generator/blob/master/lib/random_name_generator/languages/roman.txt).
-By default it uses Fantasy. Instantiate RandomNameGenerator and then call compose on the object to generate a random name.
-If you don't pass in the number of syllables you want for your name  to compose, it will randomly pick between 3 and 6.
+[Elven](https://github.com/folkengine/random_name_generator/blob/master/lib/languages/elven.txt),
+[Fantasy](https://github.com/folkengine/random_name_generator/blob/master/lib/languages/fantasy.txt),
+[Goblin](https://github.com/folkengine/random_name_generator/blob/master/lib/languages/goblin.txt),
+and
+[Roman](https://github.com/folkengine/random_name_generator/blob/master/lib/languages/roman.txt).
+By default it uses Fantasy. Instantiate RandomNameGenerator and then
+call compose on the object to generate a random name. If you don't pass
+in the number of syllables you want for your name to compose, it will
+randomly pick between 3 and 6.
 
 ```ruby
 require 'random_name_generator'
@@ -48,14 +57,19 @@ rng = RandomNameGenerator.new
 puts rng.compose(3)
 ```
 
-Pass in a reference to specific syllable file to get different styles of random names:
+*Technically, `RandomNameGenerator.new` is a static factory method
+creating a RandomNameGenerator::Generator object.*
 
-```ruby
+Pass in a reference to specific syllable file to get different styles of
+random names:
+
+```
 rng = RandomNameGenerator.new(RandomNameGenerator::GOBLIN)
 puts rng.compose(3)
 ```
 
-Flip mode will create a RandomNameGenerator object, randomly assigning the syllable file for you.
+Flip mode will create a RandomNameGenerator object, randomly assigning
+the syllable file for you.
 
 ```ruby
 flip = RandomNameGenerator.flip_mode
@@ -63,49 +77,70 @@ puts flip.compose
 ```
 
 You can also pass in your own syllable files. See
-[RNGSyllable.rb](https://github.com/folkengine/random_name_generator/blob/master/lib/random_name_generator/rng_syllable.rb)
+[Syllable.rb](https://github.com/folkengine/random_name_generator/blob/master/lib/random_name_generator/syllable.rb)
 for the required specification.
 
-RandomNameGenerator also comes with a command line interface which will generate a first and last name for you:
+RandomNameGenerator also comes with a command line interface which will
+generate a first and last name for you:
 
-```ruby
+```
 bin/random_name_generator [-efgr?]
 ```
 
-Add the gem's bin directory to you path in order to have instant access to RandomNameGenerator.
+Add the gem's bin directory to you path in order to have instant access
+to RandomNameGenerator.
 
 ## Porting and Refactoring Notes
 
-The big refactoring over the original Java version is the creation of the RNGSyllable class. It takes 
-over most of the complexity of parsing each syllable, greatly simplifying the Random Name Generator code.
- 
-Part of the reason for working on this gem was to work on the following goals to improve my Ruby craft:
+The big refactoring over the original Java version is the creation of
+the Syllable class. It takes over most of the complexity of parsing each
+syllable, greatly simplifying the Random Name Generator code.
+
+Part of the reason for working on this gem was to work on the following
+goals to improve my Ruby craft:
+
+* Code confidently in the spirit of Advi Grimm's
+  [Confident Ruby](http://www.confidentruby.com/).
+* ~~Use
+  [Travis-CI](https://travis-ci.org/folkengine/random_name_generator)
+  for build validation.~~ Moved to GitHub Actions.
+* Use [Rubocop](https://github.com/bbatsov/rubocop) and
+  [Reek](https://github.com/troessner/reek) for code quality.
+* Deploy it to
+  [RubyGems.org](https://rubygems.org/gems/random_name_generator).
 
-* Code confidently in the spirit of Advi Grimm's [Confident Ruby](http://www.confidentruby.com/).
-* Use [Travis-CI](https://travis-ci.org/folkengine/random_name_generator) for build validation.
-* Use [Rubocop](https://github.com/bbatsov/rubocop) and [Reek](https://github.com/troessner/reek) for code quality. 
-* Deploy it to [RubyGems.org](https://rubygems.org/gems/random_name_generator).
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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](https://rubygems.org).
+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 the created tag, and
+push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Dependencies
+To run [Reek](https://github.com/troessner/reek) on the codebase, simply
+call `$❯ rake reek`
 
-* [Mocha](https://github.com/freerange/mocha)
-* [Reek](https://github.com/troessner/reek)
-* [Rubocop](https://github.com/bbatsov/rubocop)
+## Contributing
 
-## Alternatives
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/folkengine/random_name_generator. This project is
+intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the
+[code of conduct](https://github.com/folkengine/random_name_generator/blob/main/CODE_OF_CONDUCT.md).
 
-There are several other great name generator gems. They really aren't designed for fantasy style names.
+## License
 
-* [Faker](https://github.com/stympy/faker)
-* [Namey](https://github.com/muffinista/namey)
-* [How To Write A Name Generator (In Ruby)](http://www.skorks.com/2009/07/how-to-write-a-name-generator-in-ruby/)
+The gem is available as open source under the terms of the
+[GNU Lesser General Public License version 3](https://opensource.org/licenses/LGPL-3.0).
 
-## Contributing
+## Code of Conduct
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/folkengine/random_name_generator.
+Everyone interacting in the RandomNameGenerator project's codebases,
+issue trackers, chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/[USERNAME]/random_name_generator/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,26 +1,17 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-require 'reek/rake/task'
-require 'rubocop/rake_task'
+# frozen_string_literal: true
 
-task default: :test
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "reek/rake/task"
 
-Reek::Rake::Task.new do |t|
-  t.fail_on_error = false
-end
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/**/test*.rb']
-  t.verbose = true
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
 end
 
-task :boom do
-  Rake::Task['test'].execute
-  puts 'Running Reek...'
-  Rake::Task['reek'].execute
-  puts
-  Rake::Task['rubocop'].execute
-end
+task default: %i[spec rubocop]

data/bin/console

@@ -1,17 +1,16 @@
 #!/usr/bin/env ruby
 
-require 'bundler/setup'
-require 'random_name_generator'
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "random_name_generator"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-require 'pry'
+require "pry"
 
 # Override default value.inspect
 Pry.config.print = proc { |output, value| output.puts "=> #{value}" }
 Pry.start
-
-# require 'irb'
-# IRB.start

data/bin/run

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+ruby -Ilib/ exe/random_name_generator "$@"

data/{bin → exe}/random_name_generator

@@ -1,17 +1,20 @@
 #!/usr/bin/env ruby
 
-require 'slop'
-require_relative '../lib/random_name_generator'
+# frozen_string_literal: true
+
+require "random_name_generator"
+require "slop"
 
 lang = RandomNameGenerator::FANTASY
 
 opts = Slop.parse do |o|
-  o.bool '-e', '--elven', 'Use Elven eyllable file'
-  o.bool '-g', '--goblin', 'Use Goblin eyllable file'
-  o.bool '-r', '--roman', 'Use Roman eyllable file'
-  o.bool '-f', '--flipmode', 'Flip mode in effect'
-  o.bool '-c', '--cyrillic', 'Use Cyrillic mode'
-  o.bool '-?', '--help', 'How to'
+  o.bool "-e", "--elven", "Use Elven eyllable file"
+  o.bool "-g", "--goblin", "Use Goblin eyllable file"
+  o.bool "-r", "--roman", "Use Roman eyllable file"
+  o.bool "-f", "--flipmode", "Flip mode in effect"
+  o.bool "-c", "--cyrillic", "Use Cyrillic mode"
+  o.bool "-x", "--xrated", "Generate Curse words [NEEDS WORK]"
+  o.bool "-?", "--help", "How to"
 end
 
 if opts.cyrillic?
@@ -23,6 +26,7 @@ else
   lang = RandomNameGenerator::ELVEN if opts.elven?
   lang = RandomNameGenerator::GOBLIN if opts.goblin?
   lang = RandomNameGenerator::ROMAN if opts.roman?
+  lang = RandomNameGenerator::CURSE if opts.xrated?
 end
 
 if opts.flipmode?

data/lib/languages/experimental/curse.txt

@@ -0,0 +1,63 @@
+-ass
+-bast
+-bo
+-boll
+-bro
+-bugg
+-cho
+-choad
+-crap
+-crike +c
+-cunt
+-dick
+-eff
+-effing
+-frig
+-fuck
+-god
+-piss
+-rubb
+-shit
+-stuff
+-suck
+-tiddly
+-wank
+arse +c
+ass
+bro
+fuck
+ing
+shit
+wank
++ard
++arse
++atch
++ass
++bi
++bitch
++bro
++child
++cunt
++damn
++er
++erd
++fuck
++fucker
++hole
++ing
++ish
++ocks
++off
++root
++sav
++shag
++stuff
++stuffed
++suck
++twat
++uck
++wank
++wink
++wipe
++wit
++y

data/lib/languages/experimental/demonic.txt

@@ -0,0 +1,350 @@
+-a +c
+-æ +c
+-aa +c
+-ab
+-aby +c
+-ad
+-ae +c
+-ag
+-ahr +v
+-ai +c
+-ak +v
+-aka +c
+-ake +c
+-ako +c
+-al
+-all
+-am
+-an
+-anc
+-and +c
+-ang
+-anti
+-ap
+-ar
+-as
+-hab
+-mai
+-mal
+
+add -c +v
+al -c
+am -c
+ama -c +c
+ay -c
+ast -c
+bat
+dra +c
+dus
+ez -c +v
+ha -c +c
+i -c +c
+ia -c +c
+it -c
+loc +v
+ma +c
+mo -c +c
+oc
+olly -c +v
+or
+ra +c
+rat
+rax +v
+real
+roma -c +c
+sh
+sta
+su
+thi +c
+una -c +c
+za -v
+
++al
++akku -c
++as
++aroth
++b'el -c
++bou -v
++chon
++christ -v
++dai
++deus
++er -c
++es -c
++ias -c
++iel
++ka
++lat
++lech
++lius
++ma
++man
++mon
++nah
++nyu
++on -c
++phus -c
++ra -v
++rept -v
++res
++ros
++roth
++s -v
++sag
++sakku -v
++sura
++van
++xas -v
++y -c
++ym
++xu
++z'el -v
++zel -v
++zou
+
+# https://en.wikipedia.org/wiki/The_infernal_names
+
+Azi Dahaka/Dahak (Zoroastrianism)
+
+Ahpuch - Mayan devil
+Ahriman - Mazdean devil
+Angra Mainyu - Zoroasterism synonym for devil
+Apollyon - Greek synonym for Abaddon.
+Asmodeus - Hebrew devil of sensuality and luxury, originally "creature of judgment"
+Azazel - Taught man to make weapons of war (Hebrew)
+Baalberith - Canaanite Lord of the covenant who was later made a devil
+Balaam - Hebrew devil of avarice and greed
+Baphomet - symbolic of Satan
+Beelzebub - Lord of the Flies, taken from the symbolism of the scarab (Hebrew)
+Behemoth - Hebrew personification of Lucifer in the form of an elephant or hippopotamus
+Beherit - Syriac name for Satan
+Chemosh - National god of Moabites, later a devil
+Cimeries - Rides a black horse and rules Africa
+Dagon - Philistine avenging devil of the sea
+Demogorgon - a name so terrible as to not be known to mortals
+Diabolous - "Flowing downwards" (Greek)
+Dracula - Romanian name for son of the devil or dragon, which would also denote a "devilish" name—Romanian isn't too clear on which meaning, if not both, is correct.
+Euronymous - Greek Prince of Death (a misspelling, correct spelling Eurynomos)
+Gorgo - dim. of Demogorgon, see above
+Guayota - guanche devil
+Haborym - Hebrew synonym for Satan
+Iblis - Synonym for Shaitan
+Leviathan - Hebrew personification of Lucifer in the form of a great sea reptile (usually it represents the Antichrist; the beast of the sea)
+Lilith - Hebrew female devil, Adam's first wife who taught him lust
+Loki - Teutonic devil
+Mammon - Aramaic god of wealth and profit
+Marduk - god of the city of Babylon
+Mastema - Hebrew synonym for Satan
+Melek Taus - Yezidi devil
+Mephistopheles - he who shuns the light, q.v. Faust (Greek)
+Milcom - Ammonite devil
+Moloch - Phoenician and Canaanite devil
+Mormo - King of the Ghouls, consort of Hecate (Greek)
+Naamah - Hebrew female devil of seduction
+Nihasa - American Indian devil
+O-Yama - Japanese name for lord of death
+Pwcca - one of the myriad of fairy (faerie) folk
+Saitan - Enochian equivalent of Satan
+Samael - "Venom of God" (Hebrew)
+Samnu - Central Asian devil
+Sedit - American Nepali devil
+Shaitan - Arabic name for Satan
+T'an-mo - Chinese counterpart to the devil, covetousness, desire
+Tchort - Russian name for Satan, "black god"
+Typhon - Greek personification of devil
+Yama - The lord of death in Hinduism
+Yen-lo-Wang - Chinese ruler of Hell
+
+# https://en.wikipedia.org/wiki/List_of_theological_demons
+
+Baal/Bael (Christian demonology)
+Babi ngepet (Indonesian mythology)
+Bakasura (Hindu mythology)
+Balam (Christian demonology)
+Balberith (Jewish demonology)
+Bali Raj (Hindu mythology)
+Banshee (Irish mythology)
+Baphomet (Christian folklore)
+Barbas (Christian demonology)
+Barbatos (Christian demonology)
+Barong (Indonesian mythology)
+Bathin/Mathim/Bathym/Marthim (Christian demonology)
+Beelzebub (Jewish demonology, Christian demonology)
+Behemoth (Jewish demonology)
+Belial (Jewish demonology, Christian demonology)
+Beleth (Christian demonology)
+Belphegor (Christian demonology)
+Berith/Beherit (Phoenician mythology, Christian demonology)
+Bhūta (Sanskrit)
+Bifrons (Christian demonology)
+Boruta (Slavic mythology)
+Botis (Christian demonology)
+Buer (Christian demonology)
+Bukavac (Slavic mythology)
+Bune (Christian demonology)
+Bushyasta (Zoroastrianism)
+
+Cain/Canio (Christian demonology)
+Charun (Etruscan mythology)
+Chemosh (Moabite)
+Choronzon (Thelema)
+Cimejes/Kimaris/Cimeies (Christian demonology)
+Corson (Christian demonology)
+Crocell/Procell (Christian demonology)
+Culsu (Etruscan mythology)
+
+Daeva (Zoroastrianism demonology)
+Dagon (Semitic mythology)
+Dajjal (Islamic demonology)
+Dantalion (Christian demonology)
+Danjal (Jewish mythology)
+Davy Jones (nautical folklore)
+Decarabia (Christian demonology)
+Demiurge (Gnosticism)
+Demogorgon (Christian demonology)
+Devil (Christian demonology)
+Div-e Sepid (Persian mythology)
+Drekavac (Slavic mythology)
+Dzoavits (Native American mythology)
+
+Eblis (or Iblis) (Islamic demonology)
+Eligos (Christian demonology)
+Eisheth (Jewish demonology)
+
+Focalor (Christian demonology)
+Foras/Forcas/Forras/ (Christian demonology)
+Forneus (Christian demonology)
+Furcas/Forcas (Christian demonology)
+Furfur (Christian demonology)
+
+Gaap (Christian demonology)
+Gader'el (Jewish demonology)
+Gaki (Japanese mythology)
+Gamigin (Christian demonology)
+Ghoul (Arabian and several other mythologies)
+Glasya-Labolas/Caacrinolaas/Caassimolar/Classyalabolas/Glassia-labolis (Christian demonology)
+Gorgon (Greek mythology)
+Gremory/Gomory (Christian demonology)
+Grigori (Jewish demonology)
+Gualichu (Mapuche mythology)
+Guayota (Guanche)
+Gusion/Gusoin/Gusoyn
+
+Haagenti (Christian demonology)
+Halphas/Malthus (Christian demonology)
+Hantu Raya (Indonesian and Malaysian mythology)
+Haures/Flauros/Flavros/Hauras/Havres (Christian demonology)
+
+Ifrit (Islamic mythology)
+Incubus (Christian demonology, Chaldean mythology, Jewish folklore)
+Ipos/Ipes (Christian demonology)
+
+Jinn (Islamic demonology)
+Jikininki (Japanese mythology)
+
+Kabandha/Kabhanda (Hinduism)
+Kali (Hinduism)
+Kasadya (Jewish demonology)
+Kokabiel (Jewish demonology)
+Kroni (Ayyavazhi demonology)
+Krampus (Germanic-Christian Demonology)
+Killakee Cat (Hell Fire Club/Satanism)
+Kumbhakarna (Hinduism)
+L[edit]
+Legion (Christian demonology)
+Lechies (Slavic mythology)
+Leyak (Indonesian mythology)
+Lempo (Finnish mythology)
+Leraje/Leraie (Christian demonology)
+Leviathan (Jewish demonology, Christian demonology)
+Lili/Lilin/Lilim (Jewish demonology)
+Lilith (Sumerian mythology, Akkadian mythology, Jewish folklore)
+Lucifer (Christian demonology)
+Lucifuge Rofocale (Christian demonology)
+M[edit]
+Malphas (Christian demonology)
+Mammon (Christian demonology)
+Mara (Buddhist mythology)
+Maricha (Hindu mythology)
+Marax/Morax/Foraii (Christian demonology)
+Marchosias (Christian demonology)
+Masih ad-Dajjal/Ad-Dajjal/Dajjal (Islamic eschatology)
+Mastema (Jewish demonology)
+Mephistopheles (Christian folklore, German folklore)
+Merihem (Christian demonology)
+Moloch (Christian demonology)
+Murmur (Christian demonology)
+Morpheus (Greek mythology)
+N[edit]
+Naamah (Jewish demonology)
+Naberius/Cerbere/Naberus (Christian demonology)
+Ninurta (Sumerian mythology, Akkadian mythology)
+Namtar (Sumerian mythology)
+O[edit]
+Onoskelis (Testament of Solomon)
+Orcus (Roman mythology, later Christian demonology)
+Orias/Oriax (Christian demonology)
+Orobas (Christian demonology)
+Ose (Christian demonology)
+Ördög (Hungarian mythology)
+O Tokata (Indonesian mythology)
+P[edit]
+Paimon (Christian demonology)
+Pazuzu (Babylonian demonology)
+Pelesit (Indonesian and Malaysian mythology)
+Phenex (Christian demonology)
+Penemue (Jewish and Christian demonology)
+Pithius (Christian demonology)
+Pocong (Indonesian mythology)
+Pontianak (Indonesian and Malaysian mythology)
+Pruflas (Christian demonology)
+Puloman (Hindu demonology)
+R[edit]
+Rahab (Jewish folklore)
+Raum (Christian demonology)
+Ronove (Christian demonology)
+Rusalka (Slavic mythology)
+Rakshasa (Hinduism)
+Rangda (Hinduism in Indonesia)
+Ravan (Hinduism)
+S[edit]
+Sabnock (Christian demonology)
+Saleos (Christian demonology)
+Samael (Jewish demonology)
+Satan (or Shaytan) (Jewish demonology, Christian demonology, Islamic demonology)
+Seir (Christian demonology)
+Semyaz (Jewish demonology)
+Shax/Chax (Christian demonology)
+Shedim (Jewish folklore)
+Sitri (Christian demonology)
+Sthenno (Greek mythology)
+Stolas/Solas (Christian demonology)
+Suanggi (Indonesian mythology)
+Succubus (Sumerian mythology, Akkadian mythology, Jewish folklore, Christian demonology)
+Surgat (Christian demonology)
+
+Tannin (Jewish demonology)
+Toyol (Indonesian and Malaysian)
+Tuchulcha (Etruscan mythology)
+
+Ukobach (Christian demonology)
+
+Valac (Christian demonology)
+Valefar/Malaphar/Malephar (Christian demonology)
+Vanth (Etruscan mythology)
+Vapula (Christian demonology)
+Vassago (Christian demonology)
+Vepar (Christian demonology)
+Vine (Christian demonology)
+
+Wendigo (Algonquin)
+
+Xaphan (Christian demonology)
+Xezbeth (demonology)[clarification needed]
+
+Yeqon
+Yeter'el
+
+Zagan (Christian demonology)
+Zepar (Christian demonology)
+Ziminiar (Christian demonology)