name_splitter 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 5d05cc3d9587b91069a47798847a24657c1a36ad
4
+ data.tar.gz: 6fe97f7a5dd434a716b7a7d801cb8a8b74395edd
5
+ SHA512:
6
+ metadata.gz: 5037901eb57e39068a2a7200abbb13169e7f054783165e8d32deee5e4e83bde3d7f867c1dd9e123337f300aef8c610b1700b815d0607bcb7033fe170529e38a8
7
+ data.tar.gz: 48e6c6ac3cc6d029f6dd756a0e22c4e3800776bb3f0dfa03da71776e805b5e3fda058bdf2356c681bee595f67c254a706e88141e8a46c46d13435b44a1a4e29d
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 1.9.3
4
+ before_install: gem install bundler -v 1.10.6
@@ -0,0 +1,13 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4
+
5
+ We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
6
+
7
+ Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
8
+
9
+ Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
10
+
11
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12
+
13
+ This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in name_splitter.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Tom Hoen
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,47 @@
1
+ # NameSplitter
2
+
3
+ The NameSplitter gem takes in a full name and spits out salutation, first name, middle name (initial), last name, and suffix.
4
+
5
+ It does its best to guess whether a middle name is really part of the last name (as in 'Manny del Rio').
6
+ ## Installation
7
+
8
+ Add this line to your application's Gemfile:
9
+
10
+ ```ruby
11
+ gem 'name_splitter'
12
+ ```
13
+
14
+ And then execute:
15
+
16
+ $ bundle
17
+
18
+ Or install it yourself as:
19
+
20
+ $ gem install name_splitter
21
+
22
+ ## Usage
23
+
24
+ NameSplitter is pretty simple to use. Just pass in the full name string and it will return an object that responds to salutation, first_name, last_name, middle_name, and suffix.
25
+
26
+ ````ruby
27
+ names = NameSplitter::Splitter.call("Ms. Mary Beth Farmer")
28
+ names.first_name # Mary Beth
29
+ names.last_name # Farmer
30
+ names.salutation # Ms.
31
+ ````
32
+
33
+ ## Development
34
+
35
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
36
+
37
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
38
+
39
+ ## Contributing
40
+
41
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/name_splitter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
42
+
43
+
44
+ ## License
45
+
46
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
47
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "name_splitter"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,100 @@
1
+ require "name_splitter/version"
2
+
3
+ module NameSplitter
4
+ class Splitter
5
+ attr_accessor :suffixes, :first_name, :last_name, :middle_name, :last_name_prefix, :salutation, :suffix
6
+ attr_reader :name
7
+
8
+ def self.call(fullname)
9
+ new(fullname)
10
+ end
11
+
12
+ def initialize(fullname = "")
13
+ self.salutation = ""
14
+ self.first_name = ""
15
+ self.middle_name = ""
16
+ self.last_name = ""
17
+ self.suffix = ""
18
+ self.name = fullname if fullname and !fullname.to_s.empty?
19
+ end
20
+
21
+ def name
22
+ first_name + " " + last_name + (suffix.to_s.empty? ? "" : ", " + suffix)
23
+ end
24
+
25
+ def name=(fullname)
26
+ name_arr = fullname.split(" ")
27
+ if name_arr.length == 1
28
+ self.first_name = name_arr.shift
29
+ elsif name_arr.length == 2 and contains_salutation(name_arr[0])
30
+ self.salutation = name_arr.shift
31
+ self.last_name = name_arr.shift
32
+ else
33
+ self.salutation = name_arr.shift if contains_salutation(name_arr[0])
34
+ self.first_name = name_arr.shift
35
+ self.first_name = first_name + " " + name_arr.shift if is_second_first_name?(name_arr[0])
36
+ self.first_name = first_name + " " + name_arr.shift + " " + name_arr.shift if anded_first_names?(name_arr[0])
37
+
38
+ self.middle_name = name_arr.shift if contains_middle_name(name_arr)
39
+ self.last_name_check(name_arr)
40
+ end
41
+ end
42
+
43
+ def last_name_check(last_name_arr)
44
+ #accepts either a string or an array
45
+ if last_name_arr.class.name == "String"
46
+ last_name_arr = last_name_arr.split(" ")
47
+ end
48
+ return false if last_name_arr.empty?
49
+ self.suffix = last_name_arr.pop if contains_suffix(last_name_arr)
50
+ self.last_name = last_name_arr.join(" ").gsub(/[.,]+/, "")
51
+ end
52
+
53
+ def contains_middle_name(name_arr)
54
+ #checks whether the array of names passed in contains a likely middle name
55
+ (name_arr.length == 2 and
56
+ !(contains_suffix(name_arr) or contains_last_name_prefix(name_arr))) or
57
+ (name_arr.length == 3 and
58
+ !(contains_suffix(name_arr) and contains_last_name_prefix(name_arr))) or
59
+ name_arr.length > 3
60
+ end
61
+
62
+ def is_second_first_name?(this_name)
63
+ second_first_names.collect { |x| x.upcase }.include?(this_name.upcase)
64
+ end
65
+
66
+ def anded_first_names?(this_name)
67
+ this_name == "and"
68
+ end
69
+
70
+ def contains_salutation(this_name)
71
+ salutations.collect { |x| x.upcase }.include?(this_name.gsub(/[.,;']+/, "").upcase)
72
+ end
73
+
74
+ def contains_last_name_prefix(name_arr)
75
+ last_name_prefix.collect { |x| x.upcase }.include?(name_arr.first.upcase)
76
+ end
77
+
78
+ def contains_suffix(name_arr)
79
+ raise "contains_suffix must receive an array" if !name_arr.class.name == "Array"
80
+ return false if name_arr.length == 1
81
+ suffixes.collect { |x| x.upcase }.include?(name_arr.last.gsub(/[.,;']+/, "").upcase)
82
+ end
83
+
84
+ def suffixes
85
+ %w{Jr Sr II III IV V VI MD PHD}
86
+ end
87
+
88
+ def last_name_prefix
89
+ %w(al de da la du del dei vda. dello della degli delle el van von der den heer ten ter vande vanden vander voor ver aan mac mc ben).freeze
90
+ end
91
+
92
+ def salutations
93
+ %w{Mr Mrs Ms Miss Dr Prof Rev}
94
+ end
95
+
96
+ def second_first_names
97
+ %w{Beth Catherine Louise}
98
+ end
99
+ end
100
+ end
@@ -0,0 +1,3 @@
1
+ module NameSplitter
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,33 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'name_splitter/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "name_splitter"
8
+ spec.version = NameSplitter::VERSION
9
+ spec.authors = ["Tom Hoen"]
10
+ spec.email = ["thoen@edgevaleinteractive.com"]
11
+
12
+ spec.summary = %q{Gem for splitting full names into the component parts}
13
+ spec.description = %q{Takes a full name and gives back an object with salutation, first name, middle name, last name and prefix}
14
+ spec.homepage = "https://github.com/hoenth/name_splitter"
15
+ spec.license = "MIT"
16
+
17
+ # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
18
+ # delete this section to allow pushing this gem to any host.
19
+ if spec.respond_to?(:metadata)
20
+ spec.metadata['allowed_push_host'] = "https://rubygems.org"
21
+ else
22
+ raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
23
+ end
24
+
25
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
26
+ spec.bindir = "exe"
27
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
28
+ spec.require_paths = ["lib"]
29
+
30
+ spec.add_development_dependency "bundler", "~> 1.10"
31
+ spec.add_development_dependency "rake", "~> 10.0"
32
+ spec.add_development_dependency "rspec", "~> 3.0"
33
+ end
metadata ADDED
@@ -0,0 +1,101 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: name_splitter
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Tom Hoen
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-02-21 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.10'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.10'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ description: Takes a full name and gives back an object with salutation, first name,
56
+ middle name, last name and prefix
57
+ email:
58
+ - thoen@edgevaleinteractive.com
59
+ executables: []
60
+ extensions: []
61
+ extra_rdoc_files: []
62
+ files:
63
+ - ".gitignore"
64
+ - ".rspec"
65
+ - ".travis.yml"
66
+ - CODE_OF_CONDUCT.md
67
+ - Gemfile
68
+ - LICENSE.txt
69
+ - README.md
70
+ - Rakefile
71
+ - bin/console
72
+ - bin/setup
73
+ - lib/name_splitter.rb
74
+ - lib/name_splitter/version.rb
75
+ - name_splitter.gemspec
76
+ homepage: https://github.com/hoenth/name_splitter
77
+ licenses:
78
+ - MIT
79
+ metadata:
80
+ allowed_push_host: https://rubygems.org
81
+ post_install_message:
82
+ rdoc_options: []
83
+ require_paths:
84
+ - lib
85
+ required_ruby_version: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ required_rubygems_version: !ruby/object:Gem::Requirement
91
+ requirements:
92
+ - - ">="
93
+ - !ruby/object:Gem::Version
94
+ version: '0'
95
+ requirements: []
96
+ rubyforge_project:
97
+ rubygems_version: 2.5.2
98
+ signing_key:
99
+ specification_version: 4
100
+ summary: Gem for splitting full names into the component parts
101
+ test_files: []