random_name_generator 1.0.1 → 2.0.0

data/README.md

@@ -3,18 +3,23 @@
 [![Gem Version](https://badge.fury.io/rb/random_name_generator.svg)](https://badge.fury.io/rb/random_name_generator)
 [![Build Status](https://travis-ci.org/folkengine/random_name_generator.svg?branch=master)](https://travis-ci.org/folkengine/random_name_generator)
 [![Code Climate](https://codeclimate.com/github/folkengine/random_name_generator/badges/gpa.svg)](https://codeclimate.com/github/folkengine/random_name_generator)
-[![Dependency Status](https://gemnasium.com/folkengine/random_name_generator.svg)](https://gemnasium.com/folkengine/random_name_generator)
 [![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).
+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
 
@@ -26,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'
@@ -49,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
@@ -64,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,18 +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 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/exe/random_name_generator

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+# 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 "-x", "--xrated", "Generate Curse words [NEEDS WORK]"
+  o.bool "-?", "--help", "How to"
+end
+
+if opts.cyrillic?
+  lang = RandomNameGenerator::FANTASY_RU
+  lang = RandomNameGenerator::ELVEN_RU if opts.elven?
+  lang = RandomNameGenerator::GOBLIN_RU if opts.goblin?
+  lang = RandomNameGenerator::ROMAN_RU if opts.roman?
+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?
+  if opts.cyrillic?
+    puts "#{RandomNameGenerator.flip_mode_cyrillic.compose} #{RandomNameGenerator.flip_mode_cyrillic.compose}"
+  else
+    puts "#{RandomNameGenerator.flip_mode.compose} #{RandomNameGenerator.flip_mode.compose}"
+  end
+elsif opts.help?
+  puts opts
+else
+  rndgen = RandomNameGenerator.new(lang)
+  puts "#{rndgen.compose} #{rndgen.compose}"
+end

data/lib/{random_name_generator/languages → languages}/demonic.txt

@@ -1,3 +1,4 @@
+-a +c
 -æ +c
 -aa +c
 -ab
@@ -20,6 +21,8 @@
 -ang
 -anti
 -ap
+-ar
+-as
 -hab
 -mai
 -mal
@@ -40,6 +43,7 @@ ia -c +c
 it -c -v
 loc +v
 ma +c
+mo -c +c
 oc
 olly -c +v
 or
@@ -47,12 +51,20 @@ ra +c
 rat
 rax +v
 real
+roma -c +c
 sh
 thi +c
+una -c +c
 
 +al
++akku -c
 +as
++b'el -c
 +bou -v
++chon
++christ -v
++dai
++deus
 +er -c
 +es -c
 +ias -c
@@ -60,34 +72,30 @@ thi +c
 +ka
 +lat
 +lech
++lius
 +ma
 +man
 +mon
 +nah
 +nyu
 +on -c
++phus -c
 +rept -v
 +res
++ros
 +s -v
++sag
++sakku -v
++sura
 +van
 +xas -v
 +y -c
 +ym
 +zou
++xu
 
 # https://en.wikipedia.org/wiki/The_infernal_names
 
-Andrealphus (Christian demonology)
-Andromalius (Christian demonology)
-Antichrist (Christian demonology)
-Anzu (Sumerian mythology)
-Armaros (Jewish demonology)
-Archon (Gnosticism)
-Arunasura [Hindu mythology]
-Asag (Sumerian demonology)
-Asakku (Babylonian mythology)
-Asb'el (Jewish mythology)
-Asmodai/Asmodeus (Jewish folklore and Christian demonology)
 Astaroth (Christian demonology)
 Asura (Hindu mythology)
 Azazel / Azaz'el (Jewish demonology)

data/lib/languages/elven-ru.txt

@@ -0,0 +1,84 @@
+-Аэль
+-Аэр
+-аф
+-а
+-ам
+-ама
+-ан
+-анг +v
+-анср +v
+-каэль
+-даэ +c
+-до
+-ейр
+-фи
+-фир
+-ла
+-се
+-сел
+-ев
+-фис
+-ху
+-ха
+-гфр
+-гил
+-ка
+-кан
+-я
+-за
+-зи
+-мара
+-маи +c
+-луэ +c
+-ни
+-ше
+-сум
+-сил
+аэ +c -c
+аэл -c
+дар
+дэт +v
+дре -v
+дрим -v
+дул
+эан -c
+эл
+эмар
+хал
+иат -c
+ма
+тэн
+куэ -v +c
+риа
+риал
+тэр
+тус
+ти
+сан
++аэль -c
++дар
++дэт
++дре
++дрим
++дул
++эан -c
++эл
++эиар
++нэс
++нин
++от
++хал
++иат
++ма
++тэн
++тэр
++тус
++ти
++ран
++ат
++эсс
++сан
++ит
++лас
++лиан
++эвар