nomener 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 176b7021c647d20b310c915afe0ad2ba591ef2b1
+  data.tar.gz: 72632691751109bf8a34e5ea2c96ced5178d80eb
+SHA512:
+  metadata.gz: 5371ba96a7d39ba43d6779c9d0a1cd019d4fa81ef2456f8479ceee404d0dc94cd86076fc1ea36cd2aada1759fe96c27466bcc7ba0dcc18f2b9bcab3545b9486c
+  data.tar.gz: d3e867f148e23a8be082534509b5c0c00509d14d8f00ddc474601aba5f11bb0ce606091f44ff1cc565b3aae078cac76579e1bc5aa42bc61fc4938ea11e547e3e

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.rspec
+.bundle
+.config
+.yardoc
+.DS_Store
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.sublime*

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Dante Piombino
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# Nomener
+
+Nomener assists with parsing peoples names that they give themselves (or other people). Nomener is a fork of [People](https://github.com/dan-ding/people) as it uses some code contributed there. It's currently geared towards western style name formatting, however other cultural name formatting is (or would like to be supported).Currently it attempts to parse names through pattern matching without using dictionary/library/data files (except for name decorations and suffixes, see usage). It may not be possible to do without such in all languages.
+
+If you didn't know, parsing names can be much more difficult than it seems it should be.
+
+## Requirements
+
+Requires Ruby 2.1 or higher (or equivalent).
+To use with 1.9 or 2.0 you'll need to install either [https://github.com/hsbt/string-scrub](string-scrub) or [https://github.com/jrochkind/scrub_rb](scrub_rb).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nomener'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nomener
+
+## Basic Usage
+
+Use Nomener directly:
+```ruby
+name = Nomener.parse "Joe Smith" # <Nomener::Name first="Joe" last="Smith">
+```
+
+Create a new instance:
+```ruby
+name = Nomener::Name.new "Joe Smith" # <Nomener::Name >
+name.parse                           # <Nomener::Name first="Joe" last="Smith">
+name.first                           # Joe
+name.name                            # Joe Smith
+"Hi #{name}!"                        # Hi Joe Smith!
+```
+
+## TODO
+* optionally use web service api data to assist (and create the web service!)
+* fantasy prefixes/suffixes
+* multiple names from one string
+* specifying formats to parse by
+* many other things
+* better non-english support
+
+## References
+* [http://en.wikipedia.org/wiki/Personal_name](http://en.wikipedia.org/wiki/Personal_name)
+* [http://en.wikipedia.org/wiki/Surname](http://en.wikipedia.org/wiki/Surname)
+* [http://en.wikipedia.org/wiki/Title](http://en.wikipedia.org/wiki/Title)
+* [http://www.w3.org/International/questions/qa-personal-names](http://www.w3.org/International/questions/qa-personal-names)
+* [http://heraldry.sca.org/titles.html](http://heraldry.sca.org/titles.html)
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/nomener/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Ensure adequate tests (rspec) on your branch
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+## Other similar projects (and inspiration)
+* [People](https://github.com/dan-ding/people) [Original](https://github.com/mericson/people)
+* [Namae](https://github.com/berkmancenter/namae) (Racc based token)
+* [Nameable](https://github.com/chorn/nameable)
+* [Person-name](https://github.com/matthijsgroen/person-name)
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/nomener/compounders.rb

@@ -0,0 +1,73 @@
+module Nomener
+  module Compounders
+
+    # Internal: Regex last name prefixes.
+    COMPOUNDS = %r!(?<part>(?:
+      Ab
+      | Ap
+      | Abu
+      | Al
+      | Bar
+      | Bath?
+      | Bet
+      | Bint?
+      | Da
+      | De\p{Blank}Ca
+      | De\p{Blank}La
+      | De\p{Blank}Los
+      | de\p{Blank}De\p{Blank}la
+      | Degli
+      | De[lnrs]?
+      | Dele
+      | Dell[ae]
+      | D[iu]t?
+      | Dos
+      | El
+      | Fitz
+      | Gil
+      | Het
+      | in
+      | in\p{Blank}het
+      | Ibn
+      | Kil
+      | L[aeo]
+      | M[ai\']?c?
+      | Mhic
+      | Maol
+      | M[au]g
+      | Naka
+      | 中
+      | Neder
+      | N[ií]'?[cgn]?
+      | Nord
+      | Norr
+      | Ny
+      | Ó
+      | Øst
+      | Öfver
+      | Öst
+      | Öster
+      | Över
+      | Öz
+      | Pour
+      | St\.?
+      | San
+      | Stor
+      | Söder
+      | Ter?
+      | Tre
+      | U[ií]?
+      | Vd
+      | V[ao]n
+      | V[ao]n
+      | Ved\.?
+      | Vda\.?
+      | Vest
+      | Väst
+      | Väster
+      | Zu
+      | (?-i:y)
+      | 't
+    )\p{Blank}\g<part>*)*!xi
+  end
+end

data/lib/nomener/helper.rb

@@ -0,0 +1,35 @@
+module Nomener
+  module Helper
+
+    # Internal: Clean up a given string. Quotes from http://en.wikipedia.org/wiki/Quotation_mark
+    #  Needs to be fixed up for matching and non-english quotes
+    #
+    # name - the string to clean
+    # leftleft - the left double quote to use when replacing others
+    # rightright - the right double quote to use when replacing others
+    # left - the single left quote to use when replacing others
+    # right - the single left quote to use when replacing others
+    #
+    # Returns a string which is (ideally) pretty much the same as it was given.
+    def self.reformat(name, leftleft = '"', rightright = '"', left = "'", right = "'")
+      n = name.dup
+      n.scrub! # remove illegal characters
+
+      # translate fullwidth to typewriter
+      n.tr!("\uFF02\uFF07", "\u0022\u0027")
+
+      n.tr!("\u0022\u00AB\u201C\u201E\u2036\u300E\u301D\u301F\uFE43", leftleft) # replace left double quotes
+      n.tr!("\u0022\u00BB\u201D\u201F\u2033\u300F\u301E\uFE44", rightright) # replace right double quotes
+
+      n.tr!("\u0027\u2018\u201A\u2035\u2039\u300C\uFE41\uFF62", left) # replace left single quotes
+      n.tr!("\u0027\u2019\u201B\u2032\u203A\u300D\uFE42\uFF62", right) # replace left single quotes
+
+      n.gsub!(/[^\p{Alpha}\-\.&\/ \,#{leftleft}#{rightright}#{left}#{right}]/, "") # what others may be in a name?
+      n.gsub!(/\p{Blank}+/, " ") # compress whitespace
+      n.strip! # trim space
+
+      n
+    end
+
+  end
+end

data/lib/nomener/name.rb

@@ -0,0 +1,144 @@
+require "nomener/parser"
+
+module Nomener
+  class Name < Struct.new :title, :first, :middle, :nick, :last, :suffix
+
+    # we don't want to change what we were instantiated with
+    attr_reader :original
+
+    # Public: Create an instance!
+    def initialize(nomen = '')
+      @original = Nomener::Helper.reformat(nomen.kind_of?(String) ? nomen : "")
+    end
+
+    # Public: Break down a string into parts of a persons name
+    #
+    # name - A string of name to parse
+    #
+    # Returns self populated with name or empty
+    def parse
+      parsed = Parser.parse(@original.dup)
+      merge(parsed) unless parsed.nil?
+      self
+    end
+
+    # Public: make the name proper case-like, suffix and nickname ignored
+    #
+    # Returns a string of the full name in a proper (western) case
+    def properlike
+      f = (first || "").capitalize
+      n = (nick.nil? || nick.empty?) ? "" : "\"#{nick}\""
+      m = (middle || "").capitalize
+      l = capit(last || "")
+      t = (title || "").capitalize
+      "#{t} #{f} #{n} #{m} #{l} #{suffix}".strip.gsub(/\p{Blank}+/, ' ')
+    end
+
+    # Internal: try to capitalize last names with Mac and Mc and D' and such
+    #
+    # last - string of the name to capitalize
+    #
+    # Returns a string of the capitalized name
+    def capit(last)
+      return "" if last.nil? || last.empty?
+
+      fix = last.dup
+
+      # if there are multiple last names separated by spaces
+      fix = fix.split(" ").map { |v| v.capitalize }.join " "
+
+      # if there are multiple last names separated by a dash
+      if !fix.index("-").nil?
+        fix = fix.split("-").map { |v|
+          v.split(" ").map { |w| w.capitalize }.join " "
+        }.join "-"
+      end
+
+      # anything begining with Mac and not ending in [aciozj]
+      if m = fix.match(/Mac([\p{Alpha}]{2,}[^aciozj])/i)
+        unless m[1].match(%r!^
+          hin|
+          hlen|
+          har|
+          kle|
+          klin|
+          kie|
+          hado|     # Portugese
+          evicius|  # Lithuanian
+          iulis|    # Lithuanian
+          ias       # Lithuanian
+        !x)
+          fix.sub!(/Mac#{m[1]}/, "Mac#{m[1].capitalize}")
+        end
+      elsif m = fix.match(/Mc([\p{Alpha}]{2,})/i) # anything beginning with Mc
+        fix.sub!(/Mc#{m[1]}/, "Mc#{m[1].capitalize}")
+      elsif fix.match(/'\p{Alpha}/) # names like D'Angelo or Van 't Hooft
+        fix.gsub!(/('\p{Alpha})/) { |s| (s[-1] != 't') ? s.upcase : s } #no cap 't
+      end
+
+      fix
+    end
+
+    # Public: Make inspect ... informative
+    #
+    # Returns a nicely formatted string
+    def inspect
+      "#<Nomener::Name #{each_pair.map { |k,v| [k,v.inspect].join('=') if (!v.nil? && !v.empty?) }.compact.join(' ')}>"
+    end
+
+    # Public: Make the name a string.
+    #
+    # format - a string using symboles specifying the format of the name to return
+    #   defaults to "%f %l"
+    #     %f -> first name
+    #     %l -> last/surname/family name
+    #     %m -> middle name
+    #     %n -> nick name
+    #     %m -> middle name
+    #     %s -> suffix
+    #     %t -> title/prefix
+    #
+    # propercase - boolean on whether to (try to) fix the case of the name
+    #   defaults to true
+    #
+    # Returns the name as a string
+    def name(format = "%f %l", propercase = true)
+      nomen = to_h
+      nomen[:nick] = (nick.nil? || nick.empty?) ? "" : "\"#{nick}\""
+      format.gsub! /\%f/, '%{first}'
+      format.gsub! /\%l/, '%{last}'
+      format.gsub! /\%m/, '%{middle}'
+      format.gsub! /\%n/, '%{nick}'
+      format.gsub! /\%s/, '%{suffix}'
+      format.gsub! /\%t/, '%{title}'
+      (format % nomen).strip.gsub /\p{Blank}+/, " "
+    end
+
+    # Public: Shortcut for name format
+    #   can also be called by the method fullname
+    #
+    # Returns the full name
+    def full
+      name("%f %m %l")
+    end
+    alias :fullname :full
+
+    # Public: See name
+    #
+    # Returns the name as a string
+    def to_s
+      name("%f %l")
+    end
+
+    # Internal: merge another Nomener::Name to this one
+    #
+    # other - hash to merge into self
+    #
+    # Returns nothing
+    def merge(other)
+      return self unless other.kind_of?(Hash)
+      each_pair { |k, v| self[k] = other[k] }
+    end
+
+  end
+end

data/lib/nomener/parser.rb

@@ -0,0 +1,141 @@
+require "nomener/name"
+require "nomener/titles"
+require "nomener/suffixes"
+require "nomener/compounders"
+require "nomener/helper"
+
+module Nomener
+  class Parser
+    include Nomener::Titles
+    include Nomener::Suffixes
+    include Nomener::Compounders
+
+    # Public: parse a string into name parts
+    #
+    # name - a string to get the name from
+    # format - a hash of options to parse name (default {:order => :fl, :spacelimit => 0})
+    #   :order - format the name. defaults to "last first" of the available
+    #     :fl - presumes the name is in the format of "first last"
+    #     :lf - presumes the name is in the format of "last first"
+    #     :lcf - presumes the name is in the format of "last, first"
+    #   :spacelimit - the number of spaces to consider in the first name
+    #
+    # Returns a Nomener::Name object hopefully a parsed name of the string or nil
+    def self.parse(name, format = {:order => :fl, :spacelimit => 0})
+      begin
+        self.parse!(name, format)
+      rescue
+        nil
+      end
+    end
+
+    # Public: parse a string into name parts
+    #
+    # name - string to parse a name from
+    # format - has of options to parse name. See parse()
+    #
+    # Returns a hash of name parts or nil
+    # Raises ArgumentError if 'name' is not a string or is empty
+    def self.parse!(name, format = {:order => :fl, :spacelimit => 1})
+      raise ArgumentError, 'Name to parse not provided' unless (name.kind_of?(String) && !name.empty?)
+
+      name = Nomener::Helper.reformat(name)
+
+      title = self.parse_title(name)
+      suffix = self.parse_suffix(name)
+      nick = self.parse_nick(name)
+      last = self.parse_last(name, format[:order])
+      first, middle = self.parse_first(name, format[:spacelimit])
+
+      {
+        :title => title,
+        :suffix => suffix,
+        :nick => nick,
+        :first => first,
+        :last => last,
+        :middle => middle
+      }
+    end
+
+    # Internal: pull off a title if we can
+    #
+    # nm - string of the name to parse
+    #
+    # Returns string of the title found or and empty string
+    def self.parse_title(nm)
+      title = ""
+      if m = TITLES.match(nm)
+        title = m[1].strip
+        nm.sub!(title, "").strip!
+        title.gsub!('.', '')
+      end
+      title
+    end
+
+    # Internal: pull off what suffixes we can
+    #
+    # nm - string of the name to parse
+    #
+    # Returns string of the suffixes found or and empty string
+    def self.parse_suffix(nm)
+      suffixes = []
+      suffixes = nm.scan(SUFFIXES).flatten
+      suffixes.each { |s|
+        nm.gsub!(/#{s}/, "").strip!
+        s.strip!
+      }
+      suffixes.join " "
+    end
+
+    # Internal: parse nickname out of string. presuming it's in quotes
+    #
+    # nm - string of the name to parse
+    #
+    # Returns string of the nickname found or and empty string
+    def self.parse_nick(nm)
+      nicks = []
+      nicks = nm.scan(/([\(\"][\p{Alpha}\-\ ']+[\)\"])/).flatten
+      nicks.each { |n|
+        nm.gsub!(/#{n}/, "").strip!
+        n.gsub!(/["\(\)]/, ' ')
+      }
+      nicks.join(" ").strip
+    end
+
+    # Internal: parse last name from string
+    #
+    # nm - string to get the last name from
+    # format - symbol defaulting to "first last". See parse()
+    #
+    # Returns string of the last name found or an empty string
+    def self.parse_last(nm, format = :fl)
+      last = ''
+      if format == :fl && n = nm.match(/\p{Blank}(?<fam>#{COMPOUNDS}[\p{L}\-\']+)\z/i)
+        last = n[:fam]
+        nm.sub!(last, "").strip!
+      elsif format == :lf && n = nm.match(/\A(?<fam>#{COMPOUNDS}[\p{Alpha}\-\']+)\p{Blank}/i)
+        last = n[:fam]
+        nm.sub!(last, "").strip!
+      elsif format == :lcf && n = nm.match(/\A(?<fam>#{COMPOUNDS}[\p{Alpha}\-\'\p{Blank}]+),/i)
+        last = n[:fam]
+        nm.sub!(last, "").strip!
+        nm.sub!(',', "").strip!
+      end
+      last
+    end
+
+    # Internal: parse the first name, and middle name if any
+    #
+    # nm - the string to get the first name from
+    # namecount - the number of spaces in the first name to consider
+    #
+    # Returns an array containing the first name and middle name if any
+    def self.parse_first(nm, namecount = 0)
+      nm.tr! '.', ' '
+      first, middle = nm.split ' ', namecount
+
+      [first || "", middle || ""]
+    end
+
+  end
+end

data/lib/nomener/suffixes.rb

@@ -0,0 +1,33 @@
+module Nomener
+  module Suffixes
+
+    # Internal: Regex to match suffixes or honorifics after names
+    SUFFIXES  = %r!\b(?:
+      AB                                                  # Bachelor of Arts
+      | APC
+      | Attorney[\p{Blank}\-]at[\p{Blank}\-]Law\.?        # Attorney at Law, Attorney-at-Law
+      | B[AS]c?                                           # Bachelor of Arts, Bachelor of Science
+      | C\.?P\.?A\.?
+      | CHB
+      | D\.?[DMOPV]\.?[SMD]?\.?                           # DMD, DO, DPM, DDM, DVM
+      | DSC
+      | Esq(?:\.|uire\.?)?                                # Esq, Esquire
+      | FAC(?:P|S)                                        # FACP, FACS
+      | [(?:X{1,3})(?:IX|IV|V)(?:I{0,3})]{1,}\b      # roman numbers I - XXXXVIII, if they're written proper
+      | Jn?r\.?
+      | Junior
+      | LLB
+      | M\.?[BDS]\.?ed?                                   # MB, MD, MS, MSed
+      | MPH
+      | P\.?\p{Blank}?A\.?
+      | PC
+      | Ph\.?\p{Blank}?D\.?
+      | RN
+      | SC
+      | Sn?r\.?                                           # Snr, Sr
+      | Senior
+      | V\.?M\.?D\.?
+    )!xi
+  end
+end
+

data/lib/nomener/titles.rb

@@ -0,0 +1,100 @@
+module Nomener
+  module Titles
+    
+    # Internal: Regex for matching name prefixes such as honorifics and other formalities
+    TITLES = %r!(
+      خانم                                                        # Persian Mrs ?
+      | (?:רעב|'ר)                                               # Yiddish Mr.
+      | አቶ                                                      # Amharic Mr.
+      | Air\p{Blank}(?:Commander|Commodore|Marshall)            # Air Commander, Commodore, Marshall
+      | Ald(?:erman|\.)?
+      | (?:Arch)?Du(?:ke|chess)                                 # Duke, Archduke, Duchess, Archduchess
+      | Ato                                                     # Amharic Mr.
+      | Baron(?:ess)?
+      | Bishop
+      | Brig(?:adier)?
+      | Brother
+      | Capt(?:ain|\.)?
+      | Cdr\.?                                                  # Commander
+      | Chaplain
+      | Colonel
+      | Comm(?:ander|odore)                                     # Commander, Commodore
+      | Count(?:ess)?
+      | Dame
+      | Det\.?
+      | Dhr\.?
+      | Doctor
+      | Dr\.?
+      | Dona
+      | Do[mn]                                                  # Dom, Don
+      | Erzherzog(?:in)?                                        # Erzherzog, Erzherzogin
+      | Father
+      | Field\p{Blank}Marshall
+      | Flt?\.?(?:\p{Blank}(?:Lt|Off)\.?)                       # Fl Lt, Flt Lt, Fl Off, Flt Off
+      | Flight(?:\p{Blank}(?:Lieutenant|Officer))               # Flight Lieutenant, Flight Officer
+      | Frau
+      | Fr\.?
+      | Gen(?:eral|\.)?                                         # General
+      | H[äe]rra                                                # Estonian, Finnish Mr
+      | Herr
+      | Hra?\.?                                                 # Finnish
+      | (?:Rt\.?|Right)?\p{Blank}?Hon\.?(?:ourable)?            # Honourable, Right Honourable
+      | Insp\.?(?:ector)?                                       # Inspector
+      | Judge
+      | Justice
+      | Khaanom                                                 # Persian Mrs
+      | Lady
+      | Lieutenant(?:\p{Blank}(?:Commander|Colonel|General))?   # Lieutenant, Lieutenant Commander, Lieutenant Colonel, Lieutenant General
+      | Lt\.?(?:\p{Blank}(?:Cdr|Col|Gen)\.?)?                   # Lt, Lt Col, Lt Cdr, Lt Gen
+      | (?:Lt|Leut|Lieut)\.?
+      | Lord
+      | Madam(?:e)?
+      | Maid
+      | Major(?:\p{Blank}General)?                              # Major, Major General
+      | Maj\.?(?:\p{Blank}Gen\.?)?                              # Maj, Maj Gen
+      | (?:Master|Technical|Staff)?\p{Blank}?Sergeant
+      | [MTS]?Sgt\.?                                            # Master, Staff, Technical, or just Sergeant
+      | Mast(?:er|\.)?
+      | Matron
+      | Menina
+      | Messrs
+      | Meneer
+      | Miss\.?
+      | Mister
+      | Mn[er]\.?                                               # Mne (Mnr) Afrikaans Mr.
+      | Mons(?:ignor|\.?)                                       # Monsignor
+      | Most\p{Blank}Rever[e|a]nd
+      | Mother(?:\p{Blank}Superior)?                            # Mother, Mother Superior
+      | Mrs?\.?
+      | Msgr\.?                                                 # Monsignor
+      | M\/?s\.?                                                # Ms, M/s
+      | Mt\.?\p{Blank}Revd?\.?
+      | Mx\.?
+      | (?-i:ông)                                               # Vietnamese Mr. must be lowercase
+      | Pastor
+      | Private
+      | Prof(?:essor|\.)?                                       # Professor, Prof
+      | Pte\.?                                                  # Private
+      | Pvt\.?                                                  # Private
+      | PFC                                                     # Private first class
+      | Rabbi
+      | Reb\.?                                                  # Yiddish Mr.
+      | Rever[e|a]nd
+      | Revd?\.?
+      | Se[nñ]h?orita                                           # senorita, señorita, senhorita
+      | Se[nñ]h?ora                                             # senora, señora, senhora
+      | Se[nñ][hy]?or(?:\p{Blank}Dom)?                          # senor, señor, senhor, senyor, senor dom
+      | Sénher
+      | Seigneur
+      | Signor(?:a|e)
+      | Sig(?:a|ra)?\.?
+      | Sioro                                                   # Ido Mr.
+      | Sro\.?                                                  # Ido Mr.
+      | Sir
+      | Sister
+      | Sr(?:a|ta)?\.?
+      | V\.?\ Revd?\.?
+      | Very\ Rever[e|a]nd
+    )!xi
+  end
+end

data/lib/nomener/version.rb

@@ -0,0 +1,3 @@
+module Nomener
+  VERSION = "0.1.3"
+end

data/lib/nomener.rb

@@ -0,0 +1,16 @@
+require "nomener/version"
+require "nomener/name"
+require "nomener/parser"
+
+module Nomener
+
+  # Public: Convenience method to parse a name
+  #
+  # name - a string of a name to parse
+  #
+  # Returns a <Nomener::Name> or nil if it couldn't be parsed
+  def self.parse(name)
+    Name.new(name).parse
+  end
+
+end