Class: Nameable::Latin

Inherits:
Object show all
Defined in:
lib/nameable/latin.rb,
lib/nameable/latin/patterns.rb

Defined Under Namespace

Modules: Patterns

Constant Summary collapse

@@first_names =
{}
@@last_names =
{}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Latin

Returns a new instance of Latin.



12
13
14
15
16
17
18
19
20
21
22
23
24
25
# File 'lib/nameable/latin.rb', line 12

def initialize(*args)
  if args.size == 1 && args.first.class == Hash
    parts = args.first
    @prefix = parts[:prefix]  ? parts[:prefix]  : nil
    @first  = parts[:first]   ? parts[:first]   : nil
    @middle = parts[:middle]  ? parts[:middle]  : nil
    @last   = parts[:last]    ? parts[:last]    : nil
    @suffix = parts[:suffix]  ? parts[:suffix]  : nil
  else
    @first = args.shift unless args.empty?
    @middle = args.shift if args.size >= 2 # Only grab a middle name if we've got a last name left
    @last = args.shift unless args.empty?
  end
end

Instance Attribute Details

#firstObject

Returns the value of attribute first.



10
11
12
# File 'lib/nameable/latin.rb', line 10

def first
  @first
end

#lastObject

Returns the value of attribute last.



10
11
12
# File 'lib/nameable/latin.rb', line 10

def last
  @last
end

#middleObject

Returns the value of attribute middle.



10
11
12
# File 'lib/nameable/latin.rb', line 10

def middle
  @middle
end

#prefixObject

Returns the value of attribute prefix.



10
11
12
# File 'lib/nameable/latin.rb', line 10

def prefix
  @prefix
end

#suffixObject

Returns the value of attribute suffix.



10
11
12
# File 'lib/nameable/latin.rb', line 10

def suffix
  @suffix
end

Instance Method Details

#ethnicityObject



188
189
190
191
192
193
# File 'lib/nameable/latin.rb', line 188

def ethnicity
  return @ethnicity if @ethnicity
  load_huge_ethnicity_table unless @@last_names && !@@last_names.empty?
  @ethnicity = @last && @@last_names[@last.downcase] ? @@last_names[@last.downcase] : :unknown
  @ethnicity
end

#extract_first(name) ⇒ Object

name is an Array



73
74
75
76
77
78
79
80
# File 'lib/nameable/latin.rb', line 73

def extract_first(name)
  return unless name && name.size >= 1

  @first = name.first
  name.delete_at(0)

  @first.capitalize! unless @first =~ /[a-z]/ && @first =~ /[A-Z]/
end

#extract_last(name) ⇒ Object

name is an Array



84
85
86
87
88
89
90
91
# File 'lib/nameable/latin.rb', line 84

def extract_last(name)
  return unless name && name.size >= 1

  @last = name.last.gsub(/['`"]+/, "'").gsub(/-+/, '-')
  name.delete_at(name.size - 1)

  @last.capitalize! unless @last =~ /[a-z]/ && @last =~ /[A-Z]/
end

#extract_middle(name) ⇒ Object

name is an Array



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/nameable/latin.rb', line 95

def extract_middle(name)
  return unless name && name.size >= 1

  (name.size - 1).downto(0) do |n|
    next unless name[n]

    if name[n] =~ Nameable::Latin::Patterns::LAST_NAME_PRE_DANGLERS
      @last = "#{name[n]} #{@last}"
    elsif name[n] =~ Nameable::Latin::Patterns::O_LAST_NAME_PRE_CONCATS
      @last = "O'#{@last}"
    elsif name[n] =~ /\-/ && n > 0 && name[n - 1]
      @last = "#{name[n - 1].delete('-')}-#{@last}"
      name[n - 1] = nil
    else
      @middle = @middle ? "#{name[n]} #{@middle}" : name[n]
    end

    name.delete_at(n)
  end

  @middle.capitalize! if @middle && !(@middle =~ /[a-z]/ && @middle =~ /[A-Z]/)
  @middle = "#{@middle}." if @middle && @middle.size == 1
end

#extract_prefix(name) ⇒ Object

name is an Array



29
30
31
32
33
34
35
36
37
# File 'lib/nameable/latin.rb', line 29

def extract_prefix(name)
  return unless name && name.size > 1 && @prefix.nil? && @first.nil?
  Nameable::Latin::Patterns::PREFIX.each do |pretty, regex|
    next unless name.first =~ regex
    @prefix = pretty
    name.delete(name.first)
    break
  end
end

#extract_suffix(name) ⇒ Object

name is an Array



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/nameable/latin.rb', line 41

def extract_suffix(name)
  return unless name && name.size >= 3

  (name.size - 1).downto(2) do |n|
    suff = nil

    Nameable::Latin::Patterns::SUFFIX.each_pair do |pretty, regex|
      suff = pretty if name[n] =~ regex
    end

    if name[n] =~ Nameable::Latin::Patterns::SUFFIX_ACADEMIC ||
       name[n] =~ Nameable::Latin::Patterns::SUFFIX_PROFESSIONAL ||
       name[n] =~ Nameable::Latin::Patterns::SUFFIX_GENERATIONAL_ROMAN
      suff = name[n].upcase.delete('.')
    end

    if !suff &&
       name.join != name.join.upcase &&
       name[n].length > 1 &&
       name[n] =~ Nameable::Latin::Patterns::SUFFIX_ABBREVIATION
      suff = name[n].upcase.delete('.')
    end

    if suff
      @suffix = @suffix ? "#{suff}, #{@suffix}" : suff
      name.delete_at(n)
    end
  end
end

#female?Boolean

Returns:

  • (Boolean)


199
200
201
# File 'lib/nameable/latin.rb', line 199

def female?
  gender == :female
end

#genderObject



181
182
183
184
185
186
# File 'lib/nameable/latin.rb', line 181

def gender
  return @gender if @gender
  load_huge_gender_table unless @@first_names && !@@first_names.empty?
  @gender = @@first_names[@first.to_s.downcase] ? @@first_names[@first.to_s.downcase] : :unknown
  @gender
end

#load_huge_ethnicity_tableObject



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
# File 'lib/nameable/latin.rb', line 165

def load_huge_ethnicity_table
  CSV.read(File.expand_path(File.join('..', '..', '..', 'data', 'app_c.csv'), __FILE__)).each do |name, rank, count, _prop100k, _cum_prop100k, pctwhite, pctblack, pctapi, pctaian, pct2prace, pcthispanic|
    next if name == 'name'
    @@last_names[name.downcase] = {
      rank: rank.to_i,
      count: count.to_i,
      percent_white: pctwhite.to_f,
      percent_black: pctblack.to_f,
      percent_asian_pacific_islander: pctapi.to_f,
      percent_american_indian_alaska_native: pctaian.to_f,
      percent_two_or_more_races: pct2prace.to_f,
      percent_hispanic: pcthispanic.to_f
    }
  end
end

#load_huge_gender_table(gender_table = Nameable::Assets::GENDER_TABLE) ⇒ Object



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/nameable/latin.rb', line 143

def load_huge_gender_table(gender_table = Nameable::Assets::GENDER_TABLE)
  ranked = {}

  CSV.read(gender_table).each do |first, gender, rank|
    first.downcase!
    gender.downcase!
    ranked[first] = {} unless ranked[first]
    ranked[first][gender] = rank.to_i
  end

  ranked.each do |first, ranks|
    if ranks['m'] && !ranks['f']
      @@first_names[first] = :male
    elsif !ranks['m'] && ranks['f']
      @@first_names[first] = :female
    elsif ranks['m'] && ranks['f']
      @@first_names[first] = ranks['m'] > ranks['f'] ? :male : :female
    end
  end
end

#male?Boolean

Returns:

  • (Boolean)


195
196
197
# File 'lib/nameable/latin.rb', line 195

def male?
  gender == :male
end

#parse(name) ⇒ Object

Raises:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# File 'lib/nameable/latin.rb', line 119

def parse(name)
  raise InvalidNameError unless name
  if name.class == String
    if name.index(',')
      name = "#{Regexp.last_match(2)} #{Regexp.last_match(1)}" if name =~ /^([a-z]+)\s*,\s*,*([^,]*)/i
    end

    name = name.strip.split(/\s+/)
  end

  name = name.first.split(/[^[:alnum:]]+/) if name.size == 1 && name.first.split(/[^[:alnum:]]+/)

  extract_prefix(name)
  extract_suffix(name)
  extract_first(name)
  extract_last(name)
  extract_middle(name)

  raise InvalidNameError, "A parseable name was not found. #{name.inspect}" unless @first

  self
end

#to_firstnameObject



219
220
221
# File 'lib/nameable/latin.rb', line 219

def to_firstname
  @first
end

#to_fullnameObject



211
212
213
# File 'lib/nameable/latin.rb', line 211

def to_fullname
  to_s
end

#to_hashObject



239
240
241
242
243
244
245
246
247
# File 'lib/nameable/latin.rb', line 239

def to_hash
  {
    prefix: @prefix,
    first: @first,
    middle: @middle,
    last: @last,
    suffix: @suffix
  }
end

#to_lastnameObject



223
224
225
# File 'lib/nameable/latin.rb', line 223

def to_lastname
  @last
end

#to_middlenameObject



227
228
229
# File 'lib/nameable/latin.rb', line 227

def to_middlename
  @middle
end

#to_nameObject



207
208
209
# File 'lib/nameable/latin.rb', line 207

def to_name
  to_nameable
end

#to_nameableObject



235
236
237
# File 'lib/nameable/latin.rb', line 235

def to_nameable
  [@first, @last].compact.join(' ')
end

#to_prefixObject



215
216
217
# File 'lib/nameable/latin.rb', line 215

def to_prefix
  @prefix
end

#to_sObject



203
204
205
# File 'lib/nameable/latin.rb', line 203

def to_s
  [@prefix, @first, @middle, @last].compact.join(' ') + (@suffix ? ", #{@suffix}" : '')
end

#to_suffixObject



231
232
233
# File 'lib/nameable/latin.rb', line 231

def to_suffix
  @suffix
end