Module: NameBank::PoolSchema

Defined in:
lib/name_bank/pool_schema.rb

Overview

The pool-key schema: the base YAML keys, how native-script keys are named, and how a gender maps to its key. One home for the key names, shared by the runtime NameBank and the build-time SplitScripts tool.

Supported public API from 0.2.0 on, documented in the README — callers building pool files for NameBank.new(data_dir:) address them through here. The constants and their values are therefore covered by semantic versioning: changing a key name is a breaking change.

Constant Summary collapse

GIVEN_MALE = 
"firstnames_male"
GIVEN_FEMALE = 
"firstnames_female"
SURNAMES = 
"lastnames"
KEYS = 
[GIVEN_MALE, GIVEN_FEMALE, SURNAMES].freeze

Class Method Summary collapse

Class Method Details

.gender_key(gender) ⇒ Object 



28
29
30
31
32
33
34
 
# File 'lib/name_bank/pool_schema.rb', line 28

def gender_key(gender)
  case gender
  when :male then GIVEN_MALE
  when :female then GIVEN_FEMALE
  else raise UnknownGender, "gender must be :male or :female, got #{gender.inspect}"
  end
end

.native_key(key) ⇒ Object 



24
25
26
 
# File 'lib/name_bank/pool_schema.rb', line 24

def native_key(key)
  "#{key}_native"
end