markov_namegen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2dec254a68e0493aa04c93b7dad2e00b9d9474c65304e66df20fae6993d6c139
+  data.tar.gz: 765c7b003a772fc3ce40ca1db7803b3b7cd3320f86f4c33c30e33c59a4a6ac13
+SHA512:
+  metadata.gz: 527030aa7309fe90b4a31a73f823daa8433f023d54ba1e30cb9b6b649af5a4e0dcaa727dd88c3a11580a553f241c20702822a317931798ef0dc9b4f2fce3d830
+  data.tar.gz: 9530192c4a57b2a0aba69128e811dd891292292678c59a724a8e16f6c020a3ae6f030d61573e687f2683bb2a6a2261261f80c482df21411edb5a5769b520bd12

data/lib/markov_namegen.rb

@@ -0,0 +1,88 @@
+# frozen-string-literal: false
+
+# Creates a dictionary with prefixes as keys, and an array of possible suffixes
+# as values, to be used by MarkovNameGen class
+class MarkovDict
+  def initialize
+    @dict = {}
+  end
+
+  def add_key(prefix, suffix)
+    @dict.include?(prefix) ? @dict[prefix].push(suffix) : @dict[prefix] = [suffix]
+  end
+
+  def fetch_suffix(prefix)
+    @dict[prefix].sample
+  end
+end
+
+# Builds a new name by constructing a MarkovDict from an array of namees.
+# New instances take 2 parameters:
+#   names(array): list of source names
+#   chainlength(num 1-10): determines order of markov chain, defaulted to 2 for best mix of
+#     readability and uniqueness. Note: with a small source list, values of 3 or higher
+#     return names too similar to input
+#
+# To generate a name after creating an instance of MarkovNameGen, call #new_name/1
+# #new_name(unique:) takes a single boolean parameter, defaulted to true.
+#   if true: only output names that are not in the original list
+#   if false: will output names even if they match names in original list
+class MarkovNameGen
+  CHAIN_ERROR = 'Chain length must be between 1 and 10.'.freeze
+  DATA_ERROR = 'Invalid name data.'.freeze
+
+  def initialize(names, chainlength = 2)
+    @mdict = MarkovDict.new
+    @source_names = []
+    @chainlen = chainlength
+    build_dict(names)
+  end
+
+  def build_dict(names)
+    raise CHAIN_ERROR unless @chainlen.between?(1, 10)
+    raise DATA_ERROR unless names.instance_of? Array
+
+    names.each do |name|
+      name = name.strip
+      namelen = name.length
+      @source_names.push(name)
+      str = ' ' * @chainlen + name
+
+      add_keys(str, namelen)
+    end
+  end
+
+  def add_keys(str, namelen)
+    0.upto(namelen - 1) { |i| @mdict.add_key(str[i..i + @chainlen - 1], str[i + @chainlen]) }
+    @mdict.add_key(str[namelen..namelen + @chainlen - 1], "\n")
+  end
+
+  def build_name
+    prefix = ' ' * @chainlen
+    name = ''
+    suffix = ''
+
+    loop do
+      suffix = @mdict.fetch_suffix(prefix)
+      return namecase(name) if suffix == "\n" || name.length > 9
+
+      name += suffix
+      prefix = prefix[1..] + suffix
+    end
+    namecase(name)
+  end
+
+  def new_name(unique: true)
+    name = build_name
+    return name unless unique
+
+    @source_names.include?(name) ? new_name : name
+  end
+
+  # Credit: vol7ron @ https://stackoverflow.com/a/28288071/19434324
+  def namecase(string)
+    string.downcase.split(/(\s)/).map.with_index{ |x, i|
+      i.zero? || x.match(/^(?:a|is|of|the|and)$/).nil? ? x.capitalize : x
+    }.join
+  end
+end

metadata

@@ -0,0 +1,43 @@
+--- !ruby/object:Gem::Specification
+name: markov_namegen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jack Kellenberger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-03 00:00:00.000000000 Z
+dependencies: []
+description: Uses Markov chains to generate new, similar names from a array of names.
+email: jackson@kellenberger.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/markov_namegen.rb
+homepage: https://rubygems.org/gems/markov_namegen
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A Markov Name Generator
+test_files: []