Class: NameTamer::Name

Inherits:
Object
  • Object
show all
Defined in:
lib/name_tamer/name.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#name ⇒ Object (readonly)

References: www.w3.org/International/questions/qa-personal-names github.com/berkmancenter/namae github.com/mericson/people en.wikipedia.org/wiki/Types_of_business_entity en.wikipedia.org/wiki/List_of_post-nominal_letters_(USA) en.wikipedia.org/wiki/List_of_post-nominal_letters_(United_Kingdom) en.wikipedia.org/wiki/Nobiliary_particle en.wikipedia.org/wiki/Spanish_naming_customs linguistlist.org/pubs/tocs/JournalUnifiedStyleSheet2007.pdf [PDF]



13
14
15
 
# File 'lib/name_tamer/name.rb', line 13

def name
  @name
end

Instance Method Details

#array ⇒ Object 



63
64
65
 
# File 'lib/name_tamer/name.rb', line 63

def array
  @array ||= slug.split(SLUG_DELIMITER)
end

#contact_type ⇒ Object 



67
68
69
70
 
# File 'lib/name_tamer/name.rb', line 67

def contact_type
  nice_name # make sure we've done the bit which infers contact_type
  contact_type_best_effort
end

#contact_type=(new_contact_type) ⇒ Object 



72
73
74
75
76
77
78
79
80
 
# File 'lib/name_tamer/name.rb', line 72

def contact_type=(new_contact_type)
  ct_as_sym = new_contact_type.to_sym

  unless @contact_type.nil? || @contact_type == ct_as_sym
    puts "Changing contact type of #{@name} from #{@contact_type} to #{new_contact_type}"
  end

  @contact_type = ct_as_sym
end

#each_word(&block) ⇒ Object

Useful method for iterating through the words in the name



83
84
85
86
 
# File 'lib/name_tamer/name.rb', line 83

def each_word(&block)
  @words ||= slug.split(SLUG_DELIMITER)
  @words.each(&block)
end

#nice_name ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/name_tamer/name.rb', line 29

def nice_name
  unless @nice_name
    @nice_name = tidy_name.dup # Start with the tidied name

    remove_adfixes # prefixes and suffixes: "Smith, John, Jr." -> "Smith, John"
    fixup_last_name_first # "Smith, John" -> "John Smith"
    fixup_mismatched_braces # "Ceres (AZ" -> "Ceres (AZ)"
    remove_adfixes # prefixes and suffixes: "Mr John Smith Jr." -> "John Smith"
    name_wrangle # proper name case and non-breaking spaces
    use_nonbreaking_spaces_in_compound_names
  end

  @nice_name
end

#simple_name ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/name_tamer/name.rb', line 44

def simple_name
  unless @simple_name
    @simple_name = nice_name.dup # Start with nice name

    remove_initials # "John Q. Doe" -> "John Doe"
    remove_middle_names # "Philip Seymour Hoffman" -> "Philip Hoffman"
    remove_periods_from_initials # "J.P.R. Williams" -> "JPR Williams"
    standardize_words # "B&Q Intl" -> "B and Q International"

    @simple_name.whitespace_to!(ASCII_SPACE)
  end

  @simple_name
end

#slug ⇒ Object 



59
60
61
 
# File 'lib/name_tamer/name.rb', line 59

def slug
  @slug ||= NameTamer.parameterize simple_name.dup # "John Doe" -> "john-doe"
end

#tidy_name ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/name_tamer/name.rb', line 15

def tidy_name
  unless @tidy_name
    @tidy_name = name.dup # Start with the name we've received

    unescape # Unescape percent-encoded characters and fix UTF-8 encoding
    remove_zero_width # remove zero-width characters
    tidy_spacing # " John   Smith " -> "John Smith"
    fix_encoding_errors # "Ren\u00c3\u00a9 Descartes" -> "Ren\u00e9 Descartes"
    consolidate_initials # "I. B. M." -> "I.B.M."
  end

  @tidy_name
end