name_of_person 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b03a84a4207dc1c212ede9e467ece80d14b4d73b889ad93c9665e177c1a744c0
+  data.tar.gz: 8e8420b6460848be39581db10a64b8b2a7dfa4504ad5b355cfae98cfda5366d8
+SHA512:
+  metadata.gz: 3f0be6604bb1a94775c009cbba1bb34d6369747cdd9466b35ae24385da15bbbcf4f00605913456b9360464dc26ffd8779183c1506567dc8a9eb3ee7becf28060
+  data.tar.gz: e31dc4fb63ae0dc3387d343842b6e5aae1348863fc6b6c82ce8770247157ef95ff47bed6dfca50c6d6d32d7f80666f7014108560fc687c09d063451002de36e6

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'byebug'

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    name_of_person (0.1.0)
+      activesupport (>= 5.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    byebug (10.0.2)
+    concurrent-ruby (1.0.5)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (12.3.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel (>= 5.2.0)
+  bundler (~> 1.15)
+  byebug
+  name_of_person!
+  rake
+
+BUNDLED WITH
+   1.16.3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Basecamp
+
+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,37 @@
+# Name of Person
+
+Presenting names for English-language applications where a basic model of first and last name(s) combined is sufficient. This approach is not meant to cover all possible naming cases, deal with other languages, or even titulations. Just the basics.
+
+## Examples
+
+```ruby
+# Relies on Person having a schema with first_name and last_name columns.
+class Person < ApplicationRecord
+  has_person_name
+end
+
+# Saves a new record using { first_name: "David", last_name: "Heinemeier Hansson" }
+person = Person.create! name: "David Heinemeier Hansson"
+
+person.name.full        # => "David Heinemeier Hansson"
+person.name.first       # => "David"
+person.name.last        # => "Heinemeier Hansson"
+person.name.initials    # => "DHH"
+person.name.familiar    # => "David H."
+person.name.abbreviated # => "D. Heinemeier Hansson"
+person.name.sorted      # => "Heinemeier Hansson, David"
+person.name.mentionable # => "davidh"
+person.name.possessive  # => "David Heinemeier Hansson's"
+
+# Use directly
+name = NameOfPerson::PersonName.full("David Heinemeier Hansson")
+name.first # => "David"
+```
+
+## Maintenance Expectations
+
+This library is an extraction from Basecamp that's been sufficient in almost unaltered form for over 10 years. While contributions are always welcome, do not expect a lot of feature evolution beyond the basics. Feel free to fork this library if you'd like to add large upgrades like titulations or different accomodations for other languages.
+
+## License
+
+Name of Person is released under the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |test|
+  test.libs << "test"
+  test.test_files = FileList["test/*_test.rb"]
+  test.warning = false
+end
+
+task default: :test

data/lib/name_of_person.rb

@@ -0,0 +1,5 @@
+module NameOfPerson
+end
+
+require 'name_of_person/loaders/active_model_has_person_name'
+require 'name_of_person/loaders/active_record_has_person_name'

data/lib/name_of_person/assignable_name.rb

@@ -0,0 +1,16 @@
+require 'name_of_person/person_name'
+
+module NameOfPerson
+  module AssignableName
+    # Assigns first_name and last_name attributes as extracted from a supplied full name.
+    def name=(name)
+      full_name = NameOfPerson::PersonName.full(name)
+      self.first_name, self.last_name = full_name.try(:first), full_name.try(:last)
+    end
+
+    # Returns a PersonName object created from the first_name and last_name attributes.
+    def name
+      NameOfPerson::PersonName.new(first_name, last_name) if first_name
+    end
+  end
+end

data/lib/name_of_person/has_person_name.rb

@@ -0,0 +1,14 @@
+require 'name_of_person/assignable_name'
+
+module NameOfPerson
+  module HasPersonName
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # Defines the instance methods name/name= from AssignableName.
+      def has_person_name
+        include NameOfPerson::AssignableName
+      end
+    end
+  end
+end

data/lib/name_of_person/loaders/active_model_has_person_name.rb

@@ -0,0 +1,9 @@
+begin
+  require 'active_model'
+  require 'name_of_person/has_person_name'
+
+  require 'active_model/model'
+  ActiveModel::Model.send :include, NameOfPerson::HasPersonName
+rescue LoadError
+  # Active Model won't be auto-configured with has_person_name
+end

data/lib/name_of_person/loaders/active_record_has_person_name.rb

@@ -0,0 +1,8 @@
+begin
+  require 'active_record'
+  require 'name_of_person/has_person_name'
+
+  ActiveRecord::Base.send :include, NameOfPerson::HasPersonName
+rescue LoadError
+  # Active Record won't be auto-configured with has_person_name
+end

data/lib/name_of_person/person_name.rb

@@ -0,0 +1,58 @@
+require 'active_support/core_ext/string'
+
+module NameOfPerson
+  class PersonName < String
+    attr_reader :first, :last
+
+    def self.full(full_name)
+      first, last = full_name.to_s.strip.split(/\s+/, 2)
+      new(first, last) if first.present?
+    end
+
+    def initialize(first, last = nil)
+      raise ArgumentError, "First name is required" unless first.present?
+      @first, @last = first, last
+      super full
+    end
+
+    # Returns first + last, such as "Jason Fried".
+    def full
+      @full ||= last.present? ? "#{first} #{last}" : first
+    end
+
+    # Returns first + last initial, such as "Jason F.".
+    def familiar
+      @familiar ||= last.present? ? "#{first} #{last.first}." : first
+    end
+
+    # Returns first initial + last, such as "J. Fried".
+    def abbreviated
+      @abbreviated ||= last.present? ? "#{first.first}. #{last}" : first
+    end
+
+    # Returns last + first for sorting.
+    def sorted
+      @sorted ||= last.present? ? "#{last}, #{first}" : first
+    end
+
+    # Returns full name with with trailing 's or ' if name ends in s.
+    def possessive
+      @possessive ||= "#{self}'#{"s" unless end_with?("s")}"
+    end
+
+    # Returns just the initials.
+    def initials
+      @initials ||= scan(/\b(\S)\S*/).join
+    end
+
+    # Returns a mentionable version of the familiar name
+    def mentionable
+      @mentionable ||= familiar.chop.delete(' ').downcase
+    end
+
+    # Override to_yaml to serialize as a plain string.
+    def encode_with(coder)
+      coder.represent_scalar nil, to_s
+    end
+  end
+end

data/name_of_person.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name     = 'name_of_person'
+  s.version  = '1.0.0'
+  s.authors  = 'David Heinemeier Hansson'
+  s.email    = 'david@basecamp.com'
+  s.summary  = 'Presenting names of people in full, familiar, abbreviated, and initialized forms (but without titulation etc)'
+  s.homepage = 'https://github.com/basecamp/name_of_person'
+  s.license  = 'MIT'
+
+  s.required_ruby_version = '>= 2.4.0'
+
+  s.add_dependency 'activesupport', '>= 5.2.0'
+
+  s.add_development_dependency 'activemodel', '>= 5.2.0'
+  s.add_development_dependency 'bundler', '~> 1.15'
+
+  s.files      = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- test/*`.split("\n")
+end

data/test/assignable_name_test.rb

@@ -0,0 +1,25 @@
+require 'active_support'
+require 'active_support/testing/autorun'
+
+require 'name_of_person/assignable_name'
+
+class StructPerson < Struct.new(:first_name, :last_name)
+  include NameOfPerson::AssignableName
+end
+
+class AssignableNameTest < ActiveSupport::TestCase
+  include NameOfPerson
+
+  setup do
+    @person = StructPerson.new("David", "Heinemeier Hansson")
+  end
+
+  test "reading name" do
+    assert_equal PersonName.new("David", "Heinemeier Hansson"), @person.name
+  end
+
+  test "writing name" do
+    @person.name = PersonName.new("Jason", "Fried")
+    assert_equal PersonName.new("Jason", "Fried"), @person.name
+  end
+end

data/test/has_person_name_test.rb

@@ -0,0 +1,28 @@
+require 'active_support'
+require 'active_support/testing/autorun'
+
+require 'name_of_person/loaders/active_model_has_person_name'
+
+class ModelPerson
+  include ActiveModel::Model
+  attr_accessor :first_name, :last_name
+
+  has_person_name
+end
+
+class HasPersonNameTest < ActiveSupport::TestCase
+  include NameOfPerson
+
+  setup do
+    @person = ModelPerson.new(first_name: "David", last_name: "Heinemeier Hansson")
+  end
+
+  test "reading name" do
+    assert_equal PersonName.new("David", "Heinemeier Hansson"), @person.name
+  end
+
+  test "writing name" do
+    @person.name = PersonName.new("Jason", "Fried")
+    assert_equal PersonName.new("Jason", "Fried"), @person.name
+  end
+end

data/test/person_name_test.rb

@@ -0,0 +1,104 @@
+require 'active_support'
+require 'active_support/testing/autorun'
+require 'yaml'
+
+require 'name_of_person/person_name'
+
+class PersonNameTest < ActiveSupport::TestCase
+  include NameOfPerson
+
+  setup do
+    @name  = PersonName.new('Foo', 'Bar')
+    @first = PersonName.new('Baz')
+  end
+
+  test "first is required" do
+    assert_raise ArgumentError do
+      PersonName.new(nil)
+    end
+  end
+
+  test "last may be omitted" do
+    assert_nothing_raised do
+      PersonName.new('Foo', nil)
+    end
+  end
+
+  test "first and last" do
+    assert_equal 'Foo', @name.first
+    assert_equal 'Bar', @name.last
+
+    assert_equal 'Baz', @first.first
+    assert_nil @first.last
+  end
+
+  test "full name" do
+    assert_equal 'Foo Bar', @name.full
+    assert_equal 'Foo Bar', @name
+
+    assert_equal @first.first, @first.full
+    assert_equal @first.first, @first
+  end
+
+  test "abbreviations" do
+    assert_equal 'Foo B.', @name.familiar
+    assert_equal 'F. Bar', @name.abbreviated
+    assert_equal 'Bar, Foo', @name.sorted
+
+    assert_equal @first.first, @first.familiar
+    assert_equal @first.first, @first.abbreviated
+    assert_equal @first.first, @first.sorted
+  end
+
+  test "possessive" do
+    assert_equal "#{@name.full}'s", @name.possessive
+    assert_equal "#{@first.full}'s", @first.possessive
+    assert_equal "Foo Bars'", PersonName.new('Foo', 'Bars').possessive
+  end
+
+  test "from full name" do
+    name = PersonName.full('Will St. Clair')
+    assert_equal 'Will', name.first
+    assert_equal 'St. Clair', name.last
+
+    first = PersonName.full('Will')
+    assert_equal 'Will', first.first
+    assert_nil first.last
+
+    assert_nil PersonName.full(nil)
+    assert_nil PersonName.full('')
+  end
+
+  test "blank last name behaves the same as nil" do
+    name = PersonName.new('Baz', '')
+    assert_equal @first.full, name.full
+    assert_equal @first.familiar, name.familiar
+    assert_equal @first.abbreviated, name.abbreviated
+    assert_equal @first.sorted, name.sorted
+    assert_equal @first.possessive, name.possessive
+  end
+
+  test "mentionable" do
+    assert_equal 'foob', @name.mentionable
+  end
+
+  test "mentionable with three names" do
+    name = PersonName.full('Will St. Clair')
+    assert_equal 'wills', name.mentionable
+  end
+
+  test "familiar" do
+    assert_equal 'Foo B.', @name.familiar
+  end
+
+  test "familiar with three names" do
+    name = PersonName.full('Will St. Clair')
+    assert_equal 'Will S.', name.familiar
+  end
+
+  test "serialize yaml" do
+    assert_equal @name, YAML.load(YAML.dump(@name))
+    assert_equal @first, YAML.load(YAML.dump(@first))
+    assert_equal String, YAML.load(YAML.dump(@name)).class
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: name_of_person
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- David Heinemeier Hansson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+description: 
+email: david@basecamp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/name_of_person.rb
+- lib/name_of_person/assignable_name.rb
+- lib/name_of_person/has_person_name.rb
+- lib/name_of_person/loaders/active_model_has_person_name.rb
+- lib/name_of_person/loaders/active_record_has_person_name.rb
+- lib/name_of_person/person_name.rb
+- name_of_person.gemspec
+- test/assignable_name_test.rb
+- test/has_person_name_test.rb
+- test/person_name_test.rb
+homepage: https://github.com/basecamp/name_of_person
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Presenting names of people in full, familiar, abbreviated, and initialized
+  forms (but without titulation etc)
+test_files:
+- test/assignable_name_test.rb
+- test/has_person_name_test.rb
+- test/person_name_test.rb