random_name_generator 0.0.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c959fbffdb7ee309edcc01531d7bb7be83f4f025
-  data.tar.gz: 0f7aa83bf9afaceb275a2f4f2e08c934057f6a49
+  metadata.gz: ef97eac73bd01cde0aacdd9342b7514ffa29788d
+  data.tar.gz: 97dd28a80b0d73b84f8f00e2dc6103930fab19c2
 SHA512:
-  metadata.gz: f68dcd0cb6733521769618c73e3f2ce18ef454e2381c9205c40a9da7183a188af1b196df3dda0bb9bfb1da395c60d6dd5212d542dff650f9af19ff97b14d5310
-  data.tar.gz: 5480e195c271c543c83c7adb4952a82bb1246f8f554b90e3fc8c5441fdff2f1b647629641f04ed12056e0760afe8efc0f8bb9ba802c7efe9fe8ea507b7c33dda
+  metadata.gz: 40bb462a879adb4a844ed64b9443d5ded04f7c2f26a96355398501dbfb724b1e336d8e781391163ae3a33a9716fe6d2721af11c2993ee38958e3a2efa775f5b9
+  data.tar.gz: 46a06d12ab64b94ace324d895c4fd08a75acacbb02f35ee5ab1e7f14f603a87628a1e5d086c8c1aebd63b25e87a7810bd2d5c8e27606181688ab67812fc3fec2

data/.codeclimate.yml

@@ -0,0 +1,18 @@
+engines:
+  bundler-audit:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.rb"
+exclude_paths:
+- test/

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.rubocop.yml

@@ -1,6 +1,6 @@
 Metrics/AbcSize:
   Enabled: true
-  Max: 16
+  Max: 22
 
 Metrics/ClassLength:
   Description: 'Avoid classes longer than 100 lines of code.'

data/Gemfile

@@ -14,3 +14,6 @@ group :development do
   gem 'reek'
   gem 'rubocop'
 end
+
+gem 'codeclimate-test-reporter', group: :test, require: nil
+gem 'coveralls', require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    random_name_generator (0.0.7)
+    random_name_generator (1.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -15,11 +15,20 @@ GEM
     builder (3.2.2)
     codeclimate-engine-rb (0.3.1)
       virtus (~> 1.0)
+    codeclimate-test-reporter (0.5.0)
+      simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.1)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
+    coveralls (0.8.13)
+      json (~> 1.8)
+      simplecov (~> 0.11.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.1.5)
     equalizer (0.0.11)
     ffi (1.9.10)
     guard (1.4.0)
@@ -30,6 +39,7 @@ GEM
       guard-compat (~> 1.2)
       minitest (>= 3.0)
     ice_nine (0.11.2)
+    json (1.8.3)
     listen (3.0.6)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9.7)
@@ -66,9 +76,17 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.7.5)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     slop (3.6.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
     thor (0.19.1)
     thread_safe (0.3.5)
+    tins (1.6.0)
     unicode-display_width (1.0.2)
     virtus (1.0.5)
       axiom-types (~> 0.1)
@@ -81,6 +99,8 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.11)
+  codeclimate-test-reporter
+  coveralls
   guard
   guard-minitest
   minitest

data/README.md

@@ -1,6 +1,11 @@
 # RandomNameGenerator
 
+[![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).
 
@@ -70,6 +75,18 @@ bin/random_name_generator [-efgr?]
 
 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:
+
+* 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.
@@ -84,6 +101,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Alternatives
 
+There are several other great name generator gems. They really aren't designed for fantasy style names.
+
 * [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/)

data/lib/random_name_generator/languages/demonic.txt

@@ -16,6 +16,7 @@
 -am
 -an
 -anc
+-and +c
 -ang
 -anti
 -ap
@@ -30,8 +31,10 @@ 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 -v
@@ -43,6 +46,7 @@ or
 ra +c
 rat
 rax +v
+real
 sh
 thi +c
 
@@ -53,6 +57,7 @@ thi +c
 +es -c
 +ias -c
 +iel
++ka
 +lat
 +lech
 +ma
@@ -63,6 +68,7 @@ thi +c
 +on -c
 +rept -v
 +res
++s -v
 +van
 +xas -v
 +y -c
@@ -71,9 +77,6 @@ thi +c
 
 # https://en.wikipedia.org/wiki/The_infernal_names
 
-
-Andhaka (Hindu mythology)
-Andras (Christian demonology)
 Andrealphus (Christian demonology)
 Andromalius (Christian demonology)
 Antichrist (Christian demonology)

data/lib/random_name_generator/random_name_generator.rb

@@ -1,5 +1,17 @@
 require_relative 'rng_syllable'
 
+# RandomNameGenerator:
+#
+# Examples
+#
+#   rng = RandomNameGenerator.new(RandomNameGenerator::GOBLIN)
+#   puts rng.compose(3)
+#
+# By default RandomNameGenerator uses the Fantasy syllable file and creates a name with between 2 and 5 syllables.
+#
+#   rng = RandomNameGenerator.new
+#   puts rng.compose
+#
 class RandomNameGenerator
   dirname = File.dirname(__FILE__)
 
@@ -19,6 +31,7 @@ class RandomNameGenerator
     refresh
   end
 
+  # Public: Static factory method that instantiates a RandomNameGenerator in a random language.
   def self.flip_mode
     langs = [RandomNameGenerator::FANTASY,
              RandomNameGenerator::ELVEN,
@@ -36,6 +49,16 @@ class RandomNameGenerator
     name.map(&:to_s).join.capitalize
   end
 
+  def self.pick_number_of_syllables
+    [2, 2, 2, 2, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 4, 4, 4, 5].sample
+  end
+
+  def to_s
+    "NameGenerator (#{@file.path})"
+  end
+
+  private
+
   def determine_middle_syllables(count, pre)
     determine_next_syllables(count, pre, @mid_syllables)
   end
@@ -76,13 +99,4 @@ class RandomNameGenerator
       end
     end
   end
-
-  def self.pick_number_of_syllables
-    distribution = [2, 2, 2, 2, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 4, 4, 4, 5]
-    distribution.sample
-  end
-
-  def to_s
-    "NameGenerator (#{@file.path})"
-  end
 end

data/lib/random_name_generator/rng_syllable.rb

@@ -1,3 +1,18 @@
+# RNGSyllable: Class for managing properties of individual syllables with in language name file. Each line within a file
+# translates into a syllable object. The reason behind this class is to take over most of the complexity of parsing each
+# syllable, greatly simplifying the work done by RandomNameGenerator. This code is not meant to be called directly as a
+# part of standard usage.
+#
+# Examples
+#
+#   syllable = RNGSyllable.new('-foo +c')
+#
+# This creates a foo syllable object that needs to be the first syllable and followed by a constant.
+#
+# For testing purposes, passing in another RNGSyllable object will create a clone:
+#
+#   syllable_clone = RNGSyllable.new(syllable)
+#
 # SYLLABLE CLASSIFICATION:
 # Name is usually composed from 3 different class of syllables, which include prefix, middle part and suffix.
 # To declare syllable as a prefix in the file, insert "-" as a first character of the line.
@@ -18,7 +33,6 @@
 # 2) +c means that next syllable must definitely start with a consonant.
 # 3) -v means that this syllable can only be added to another syllable, that ends with a vocal.
 # 4) -c means that this syllable can only be added to another syllable, that ends with a consonant.
-
 class RNGSyllable
   attr_reader :raw, :syllable, :next_syllable_requirement, :previous_syllable_requirement
 

data/random_name_generator.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'random_name_generator'
-  spec.version       = '0.0.7'
+  spec.version       = '1.0.0'
   spec.authors       = ['folkengine']
   spec.email         = ['gaoler@electronicpanopticon.com']
   spec.licenses      = ['GPL-3.0']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: random_name_generator
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 1.0.0
 platform: ruby
 authors:
 - folkengine
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-21 00:00:00.000000000 Z
+date: 2016-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,6 +46,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".coveralls.yml"
 - ".gitignore"
 - ".overcommit.yml"
 - ".rubocop.yml"
@@ -88,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Random Name Generator