pokemon_name_generator 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dace6223beff530ba095999c1b125be0424b9e8c687db59d030af29da70ef9bc
-  data.tar.gz: 2572ca6470688f12f27bff8fbdbc3f338fdb90b029c94cd826c88ca83b52851b
+  metadata.gz: 9edb273da4cdabb9557232e24699f3f82e926676974c2ef1c81cce52b6e871cf
+  data.tar.gz: f4e6bef343c36aca003243b4b0cbfbc50ad1afeabdd9cf1e5e7ceba8f3a95209
 SHA512:
-  metadata.gz: e840d9af23209bc86dd8dd0b7ab01286a7cee778bbd6f8fe02e4484f2e21834d969061c8f07344ffa6c6153cf2579b504a82e32009203be3a9d0fe542e27dc26
-  data.tar.gz: 0d85cc4e43d26c4745d9c28d1eb6c74f5930b58052a2f60e0a4d5c36aacc888814e537e367d743c125d5bd3e19b75512d3e6452378372fd97c827ebf757d9198
+  metadata.gz: f404f12c3cb2d950e1e9c971bddf78e6aa428d1c2429859787661facdfe2da88b40688ea7c14740e79e07c051f23a3d234a5167252ee1384841e29be099b6268
+  data.tar.gz: 20fc66d841cda24aac7b971b676a2ceaaa9479ae63201d7a9fb2ea819b88408a98946d6d99bb66b521ec33316610906fe6690a1ac74e73705aaa681cac3c11de

data/README.md

@@ -1,5 +1,9 @@
 # Pokémon Name Generator
 
+![Lint](https://github.com/tony-rowan/pokemon-name-generator/actions/workflows/lint.yml/badge.svg)
+![Test](https://github.com/tony-rowan/pokemon-name-generator/actions/workflows/test.yml/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/pokemon_name_generator.svg)](https://badge.fury.io/rb/pokemon_name_generator)
+
 A command line ruby utility to generate fake (and sometimes accidentally real)
 Pokémon names.
 
@@ -38,7 +42,7 @@ You can also produce a number of names at once.
 Useful for exporting to other apps.
 
 ```bash
-$ pokeng generate --algorithm=markov --context=3 --number=100000 > generated_names.txt
+$ pokeng generate --algorithm=markov --context=3 --number=100000 --quiet > generated_names.txt
 ```
 
 The default options are chosen to produce the most realistic names.

data/lib/pokemon_name_generator/algorithm/factory.rb

@@ -0,0 +1,33 @@
+module PokemonNameGenerator
+  module Algorithm
+    class Factory
+      def initialize(training_data: Corpus::Names.as_letters, **options)
+        @training_data = training_data
+        @options = options
+      end
+
+      def build_algorithm
+        case options.fetch(:algorithm)
+        when "naive" then Naive.new(training_data)
+        when "markov" then Markov.new(training_data, chain_length: context)
+        end
+      end
+
+      private
+
+      attr_reader :training_data, :options
+
+      def context
+        value = begin
+          options.fetch(:context).to_i
+        rescue
+          raise InvalidContextError
+        end
+
+        raise InvalidContextError unless value > 0
+
+        value
+      end
+    end
+  end
+end

data/lib/pokemon_name_generator/algorithm/markov.rb

@@ -0,0 +1,68 @@
+module PokemonNameGenerator
+  module Algorithm
+    class Markov
+      def initialize(training_data, chain_length:)
+        @training_data = training_data
+        @chain_length = chain_length
+      end
+
+      def name
+        "Markov[#{@chain_length}]"
+      end
+
+      def generate_name
+        pokemon_name = ""
+        context = []
+        current_phoneme = statistics[context].sample
+
+        loop do
+          break if current_phoneme.nil?
+
+          pokemon_name << current_phoneme
+          context << current_phoneme
+          context = context.drop(1) if context.size > chain_length
+          current_phoneme = statistics[context].sample
+        end
+
+        pokemon_name
+      end
+
+      private
+
+      attr_reader :training_data, :chain_length
+
+      def statistics
+        @statistics ||= load_statistics
+      end
+
+      def load_statistics
+        markov_statistics = {}
+
+        training_data.each do |this_pokemon_phonemes|
+          context = []
+
+          this_pokemon_phonemes.each do |this_pokemon_phoneme|
+            if markov_statistics[context]
+              markov_statistics[context] << this_pokemon_phoneme
+            else
+              markov_statistics[context] = [this_pokemon_phoneme]
+            end
+
+            context = [context, this_pokemon_phoneme].flatten
+            context = context.drop(1) if context.size > chain_length
+          end
+
+          if markov_statistics[context]
+            markov_statistics[context] << nil
+          else
+            markov_statistics[context] = [nil]
+          end
+        end
+
+        markov_statistics[[]] = markov_statistics[[]].uniq
+
+        markov_statistics
+      end
+    end
+  end
+end

data/lib/pokemon_name_generator/algorithm/naive.rb

@@ -0,0 +1,32 @@
+module PokemonNameGenerator
+  module Algorithm
+    class Naive
+      def initialize(training_data)
+        @training_data = training_data
+      end
+
+      def name
+        "Naïve"
+      end
+
+      def generate_name
+        statistics[:phoneme_count_distribution].sample.times.map { statistics[:phoneme_distribution].sample }.join
+      end
+
+      private
+
+      attr_reader :training_data, :context_length
+
+      def statistics
+        @statistics ||= load_statistics
+      end
+
+      def load_statistics
+        {
+          phoneme_count_distribution: training_data.map(&:count),
+          phoneme_distribution: training_data.flatten
+        }
+      end
+    end
+  end
+end

data/lib/pokemon_name_generator/algorithm.rb

@@ -0,0 +1,9 @@
+module PokemonNameGenerator
+  module Algorithm
+    class InvalidContextError < StandardError; end
+
+    require "pokemon_name_generator/algorithm/factory"
+    require "pokemon_name_generator/algorithm/markov"
+    require "pokemon_name_generator/algorithm/naive"
+  end
+end

data/lib/pokemon_name_generator/cli/commands/generate.rb

@@ -0,0 +1,37 @@
+require "dry/cli"
+
+module PokemonNameGenerator
+  module CLI
+    module Commands
+      class Generate < Dry::CLI::Command
+        desc "Generate one or more Pokémon Names"
+
+        option :algorithm, default: "markov", values: %w[naive markov], desc: "Algorithm to use"
+
+        option :context, type: :integer, default: 3, desc: "Number of links in the Markov Chain"
+
+        option :number, type: :integer, default: 1, desc: "Number of names to generate"
+
+        option :quiet, type: :boolean, default: false, desc: "Only print the names, nothing else"
+
+        def call(**options)
+          algorithm = Algorithm::Factory.new(**options).build_algorithm
+
+          unless options.fetch(:quiet)
+            puts "============================="
+            puts "🧪 Generator: #{algorithm.name}"
+            puts "============================="
+            puts ""
+
+            if options.fetch(:number).to_i > 1
+              puts "Generating #{options.fetch(:number)} names..."
+              puts ""
+            end
+          end
+
+          options.fetch(:number).to_i.times { puts algorithm.generate_name }
+        end
+      end
+    end
+  end
+end

data/lib/pokemon_name_generator/cli/commands/test.rb

@@ -0,0 +1,59 @@
+require "dry/cli"
+
+module PokemonNameGenerator
+  module CLI
+    module Commands
+      class Test < Dry::CLI::Command
+        desc "Test an algorithm"
+
+        option :algorithm, required: true, values: %w[naive markov], desc: "Algorithm to test"
+
+        option :context, required: true, type: :integer, desc: "Number of links in the Markov Chain"
+
+        option :sample, type: :integer, default: 10_000, desc: "Number of names to generate"
+
+        option :show_names, type: :boolean, default: false, desc: "Show the new and actual generated names in the sample"
+
+        def call(**options)
+          actual_pokemon = Corpus::Data.new.load_pokemon_names
+          all_data = Corpus::Names.as_letters.shuffle
+
+          mid_point = (all_data.size + 1) / 2
+          training_data = all_data[..mid_point]
+          test_data = all_data[mid_point..]
+
+          algorithm = Algorithm::Factory.new(training_data: training_data, **options).build_algorithm
+
+          puts "============================="
+          puts "🧪 Generator: #{algorithm.name}"
+          puts "============================="
+
+          puts "Generating #{options.fetch(:sample)} names..."
+
+          generated_names = options.fetch(:sample).to_i.times.map { algorithm.generate_name }
+
+          unique_pokemon_generated = generated_names.uniq
+          training_pokemon_generated = unique_pokemon_generated.intersection(training_data.map(&:join))
+          test_pokemon_generated = unique_pokemon_generated.intersection(test_data.map(&:join))
+          new_pokemon_generated = unique_pokemon_generated - actual_pokemon
+
+          upper_limit = actual_pokemon.max_by(&:size).size
+          lower_limit = actual_pokemon.min_by(&:size).size
+
+          puts "Done."
+          puts ""
+          puts "Unique Names: #{unique_pokemon_generated.size}"
+          puts "Training Pokémon: #{training_pokemon_generated.size}"
+          puts training_pokemon_generated.to_s if options.fetch(:show_names, false)
+          puts "Test Pokémon: #{test_pokemon_generated.size}"
+          puts test_pokemon_generated.to_s if options.fetch(:show_names, false)
+          puts "New Pokémon: #{new_pokemon_generated.size}"
+          puts "  Too Long: #{new_pokemon_generated.count { |x| x.size > upper_limit }}"
+          puts "  Too Short: #{new_pokemon_generated.count { |x| x.size < lower_limit }}"
+          puts new_pokemon_generated.to_s if options.fetch(:show_names, false)
+          puts ""
+        end
+      end
+    end
+  end
+end

data/lib/pokemon_name_generator/cli/commands/version.rb

@@ -0,0 +1,15 @@
+require "dry/cli"
+
+module PokemonNameGenerator
+  module CLI
+    module Commands
+      class Version < Dry::CLI::Command
+        desc "Print version"
+
+        def call(*)
+          puts PokemonNameGenerator::VERSION
+        end
+      end
+    end
+  end
+end

data/lib/pokemon_name_generator/cli/commands.rb

@@ -4,81 +4,11 @@ require "dry/cli"
 module PokemonNameGenerator
   module CLI
     module Commands
-      extend Dry::CLI::Registry
-
-      class Version < Dry::CLI::Command
-        desc "Print version"
-
-        def call(*)
-          puts PokemonNameGenerator::VERSION
-        end
-      end
-
-      class Generate < Dry::CLI::Command
-        desc "Generate one or more Pokémon Names"
-
-        option :algorithm, default: "markov", values: %w[naive markov], desc: "Algorithm to use"
-
-        option :context, type: :integer, default: 3, desc: "Number of links in the Markov Chain"
-
-        option :number, type: :integer, default: 1, desc: "Number of names to generate"
-
-        def call(**options)
-          corpus = Corpus.new
-
-          algorithm = case options.fetch(:algorithm)
-          when "naive" then Naive.new(corpus.pokemon_phonemes)
-          when "markov" then Markov.new(corpus.pokemon_phonemes, context_length: options.fetch(:context).to_i)
-          end
-
-          options.fetch(:number).to_i.times { puts algorithm.generate_name }
-        end
-      end
-
-      class Test < Dry::CLI::Command
-        desc "Test an algorithm"
+      require "pokemon_name_generator/cli/commands/version"
+      require "pokemon_name_generator/cli/commands/generate"
+      require "pokemon_name_generator/cli/commands/test"
 
-        option :algorithm, required: true, values: %w[naive markov], desc: "Algorithm to test"
-
-        option :context, required: true, type: :integer, desc: "Number of links in the Markov Chain"
-
-        option :number, type: :integer, default: 10_000, desc: "Number of names to generate"
-
-        def call(**options)
-          corpus = Corpus.new
-          actual_pokemon = corpus.pokemon
-          all_data = corpus.pokemon_phonemes.shuffle
-
-          longest_name = actual_pokemon.max_by(&:length)
-          shortest_name = actual_pokemon.min_by(&:length)
-
-          mid_point = (all_data.size + 1) / 2
-          training_data = all_data[..mid_point]
-          test_data = all_data[mid_point..]
-
-          algorithm = case options.fetch(:algorithm)
-          when "naive" then Naive.new(training_data)
-          when "markov" then Markov.new(training_data, context_length: options.fetch(:context).to_i)
-          end
-
-          puts "============================="
-          puts "🧪 Generator: #{algorithm.name}"
-          puts "============================="
-
-          generated_names = options.fetch(:number).to_i.times.map { algorithm.generate_name }
-
-          puts "Training Data: #{training_data.size}"
-          puts "Test Data: #{test_data.size}"
-          puts "Generated Names: #{generated_names.size}"
-          puts "Unique Generated Names: #{generated_names.uniq.size}"
-          puts "Training Data Names Generated: #{training_data.map { |datum| datum.join("") }.intersection(generated_names.uniq).size}"
-          puts "Test Data Names Generated: #{test_data.map { |datum| datum.join("") }.intersection(generated_names.uniq).size}"
-          puts "Test Data Names Generated: #{test_data.map { |datum| datum.join("") }.intersection(generated_names.uniq)}"
-          puts "Overly Short Names: #{generated_names.count { |name| name.size < shortest_name.size }}"
-          puts "Overly Long Names: #{generated_names.count { |name| name.size > longest_name.size }}"
-          puts ""
-        end
-      end
+      extend Dry::CLI::Registry
 
       register "version", Version, aliases: ["-v", "--version"]
       register "generate", Generate, aliases: ["g", "generate"]

data/lib/pokemon_name_generator/corpus/data.rb

@@ -0,0 +1,19 @@
+module PokemonNameGenerator
+  module Corpus
+    class Data
+      DATA_FILE_PATH = File.expand_path("../../../../data/pokemon.txt", __FILE__)
+
+      attr_reader :file
+
+      def initialize(file: DATA_FILE_PATH)
+        @file = file
+      end
+
+      def load_pokemon_names
+        File.readlines(file, chomp: true)
+          .map { |line| line[5..] } # drop the number
+          .map(&:downcase)
+      end
+    end
+  end
+end

data/lib/pokemon_name_generator/corpus/names.rb

@@ -0,0 +1,9 @@
+module PokemonNameGenerator
+  module Corpus
+    module Names
+      def self.as_letters(data: Data.new)
+        data.load_pokemon_names.map(&:chars)
+      end
+    end
+  end
+end

data/lib/pokemon_name_generator/corpus.rb

@@ -1,46 +1,6 @@
-require_relative "./phoneme"
-require_relative "./pokemon"
-
-class Corpus
-  def pokemon_letters
-    @pokemon_letters ||= load_pokemon_letters.values
-  end
-
-  def pokemon_phonemes
-    @pokemon_phonemes ||= load_pokemon_phonemes.values
-  end
-
-  def phonemes
-    @phonemes ||= Phoneme.load_data
-  end
-
-  def pokemon
-    @pokemon ||= Pokemon.load_data
-  end
-
-  private
-
-  # This generates a hash so we can debug it easily
-  def load_pokemon_letters
-    pokemon.map { |name| [name, name.chars] }.to_h
-  end
-
-  # This generates a hash so we can debug it easily
-  def load_pokemon_phonemes
-    pokemon.map do |this_pokemon_name|
-      remaining_pokemon_name = this_pokemon_name
-      this_pokemon_phonemes = []
-
-      loop do
-        break if remaining_pokemon_name.empty?
-
-        phoneme = phonemes.find { |phoneme| remaining_pokemon_name.start_with?(phoneme) }
-
-        this_pokemon_phonemes << phoneme
-        remaining_pokemon_name = remaining_pokemon_name.sub(phoneme, "")
-      end
-
-      [this_pokemon_name, this_pokemon_phonemes]
-    end.to_h
+module PokemonNameGenerator
+  module Corpus
+    require "pokemon_name_generator/corpus/data"
+    require "pokemon_name_generator/corpus/names"
   end
 end

data/lib/pokemon_name_generator/version.rb

@@ -1,3 +1,3 @@
 module PokemonNameGenerator
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/pokemon_name_generator.rb

@@ -1,9 +1,6 @@
 module PokemonNameGenerator
+  require "pokemon_name_generator/algorithm"
   require "pokemon_name_generator/cli"
   require "pokemon_name_generator/corpus"
-  require "pokemon_name_generator/markov"
-  require "pokemon_name_generator/naive"
-  require "pokemon_name_generator/phoneme"
-  require "pokemon_name_generator/pokemon"
   require "pokemon_name_generator/version"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pokemon_name_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Tony Rowan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-14 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -75,16 +89,20 @@ extra_rdoc_files: []
 files:
 - README.md
 - bin/pokeng
-- data/phonemes.txt
 - data/pokemon.txt
 - lib/pokemon_name_generator.rb
+- lib/pokemon_name_generator/algorithm.rb
+- lib/pokemon_name_generator/algorithm/factory.rb
+- lib/pokemon_name_generator/algorithm/markov.rb
+- lib/pokemon_name_generator/algorithm/naive.rb
 - lib/pokemon_name_generator/cli.rb
 - lib/pokemon_name_generator/cli/commands.rb
+- lib/pokemon_name_generator/cli/commands/generate.rb
+- lib/pokemon_name_generator/cli/commands/test.rb
+- lib/pokemon_name_generator/cli/commands/version.rb
 - lib/pokemon_name_generator/corpus.rb
-- lib/pokemon_name_generator/markov.rb
-- lib/pokemon_name_generator/naive.rb
-- lib/pokemon_name_generator/phoneme.rb
-- lib/pokemon_name_generator/pokemon.rb
+- lib/pokemon_name_generator/corpus/data.rb
+- lib/pokemon_name_generator/corpus/names.rb
 - lib/pokemon_name_generator/version.rb
 homepage: https://github.com/tony-rowan/pokemon-name-generator
 licenses:

data/data/phonemes.txt

@@ -1,130 +0,0 @@
-aigh
-augh
-ayer
-eigh
-ngue
-ough
-air
-are
-dge
-ear
-eau
-eer
-eir
-ere
-ier
-igh
-oar
-oew
-oor
-ore
-our
-sci
-tch
-uoy
-ure
-ae
-ai
-ar
-au
-aw
-ay
-bb
-cc
-ce
-ch
-ci
-ck
-dd
-di
-ea
-ed
-ee
-ei
-eo
-er
-et
-ew
-ey
-ff
-ft
-ge
-gg
-gh
-gn
-ho
-ie
-ir
-is
-lf
-lk
-ll
-lm
-mb
-mm
-mn
-ng
-nn
-oa
-oe
-oi
-oo
-or
-ou
-ow
-oy
-ph
-pn
-pp
-ps
-qu
-rh
-rr
-sc
-se
-sh
-si
-ss
-st
-te
-th
-ti
-tt
-tu
-ue
-ui
-ur
-uy
-ve
-wh
-wr
-ye
-yr
-ze
-zz
-a
-b
-c
-d
-e
-f
-g
-h
-i
-j
-k
-l
-m
-n
-o
-p
-q
-r
-s
-t
-u
-v
-w
-x
-y
-z

data/lib/pokemon_name_generator/markov.rb

@@ -1,64 +0,0 @@
-class Markov
-  def initialize(training_data, context_length:)
-    @training_data = training_data
-    @context_length = context_length
-  end
-
-  def name
-    "Markov[#{@context_length}]"
-  end
-
-  def generate_name
-    pokemon_name = ""
-    context = []
-    current_phoneme = statistics[context].sample
-
-    loop do
-      break if current_phoneme.nil?
-
-      pokemon_name << current_phoneme
-      context << current_phoneme
-      context = context.drop(1) if context.size > context_length
-      current_phoneme = statistics[context].sample
-    end
-
-    pokemon_name
-  end
-
-  private
-
-  attr_reader :training_data, :context_length
-
-  def statistics
-    @statistics ||= load_statistics
-  end
-
-  def load_statistics
-    markov_statistics = {}
-
-    training_data.each do |this_pokemon_phonemes|
-      context = []
-
-      this_pokemon_phonemes.each do |this_pokemon_phoneme|
-        if markov_statistics[context]
-          markov_statistics[context] << this_pokemon_phoneme
-        else
-          markov_statistics[context] = [this_pokemon_phoneme]
-        end
-
-        context = [context, this_pokemon_phoneme].flatten
-        context = context.drop(1) if context.size > context_length
-      end
-
-      if markov_statistics[context]
-        markov_statistics[context] << nil
-      else
-        markov_statistics[context] = [nil]
-      end
-    end
-
-    markov_statistics[[]] = markov_statistics[[]].uniq
-
-    markov_statistics
-  end
-end

data/lib/pokemon_name_generator/naive.rb

@@ -1,28 +0,0 @@
-class Naive
-  def initialize(training_data)
-    @training_data = training_data
-  end
-
-  def name
-    "Naïve"
-  end
-
-  def generate_name
-    statistics[:phoneme_count_distribution].sample.times.map { statistics[:phoneme_distribution].sample }.join
-  end
-
-  private
-
-  attr_reader :training_data, :context_length
-
-  def statistics
-    @statistics ||= load_statistics
-  end
-
-  def load_statistics
-    {
-      phoneme_count_distribution: training_data.map(&:count),
-      phoneme_distribution: training_data.flatten
-    }
-  end
-end

data/lib/pokemon_name_generator/phoneme.rb

@@ -1,7 +0,0 @@
-module Phoneme
-  DATA = File.expand_path('../../../data/phonemes.txt', __FILE__)
-
-  def self.load_data
-    File.readlines(DATA, chomp: true)
-  end
-end

data/lib/pokemon_name_generator/pokemon.rb

@@ -1,10 +0,0 @@
-module Pokemon
-  DATA = File.expand_path('../../../data/pokemon.txt', __FILE__)
-
-  def self.load_data
-    File.readlines(DATA, chomp: true)
-      .map { |line| line[5..] } # drop the number
-      .map(&:downcase)
-      .reject { |name| name =~ /[♀♂.'2\-é:\ ]/ } # don't deal with special characters yet
-  end
-end