nomen 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02f10575d1beff1b8eacf5b2c0caf3a79cf9f244
+  data.tar.gz: 1ee6f8c5ab00ba4eaf0dad83721b5db4c32598cf
+SHA512:
+  metadata.gz: 7a6dd75a601cc5c1a647c80fa1652b0a8c6694ca618438c85b00f19102789eff8a30eef5181803366830d8ac7e03a72bae23e765be9a4b8dd69f5961303099b1
+  data.tar.gz: 798ac89b09e2d2995dd72a1510e6fab87adc50b68a2cc5ca2737383f27e1897ae6849e0c35a3fb3cc33c484aeb891285a5db502648d7431fbe3b43f5d519abb9

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+pkg/
+*.gem
+.bundle

data/.rspec

@@ -0,0 +1,2 @@
+--tty
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx-19mode
+  - ree

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Abe Voelker
+
+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,30 @@
+# Nomen [![Build Status](https://secure.travis-ci.org/abevoelker/nomen.png)](http://travis-ci.org/abevoelker/nomen)
+
+Simple library for formatting (and maybe later, parsing) human names.
+
+## Description
+
+The name is latin for "name"; no misandry intended. For now I'm only handling
+my current use case, which is very basic formatting of American-style names.
+
+I am aware of the [complexity of][patio11] human names.
+
+## Synopsis
+
+```ruby
+require 'nomen'
+
+n = Nomen::Name.new(first: 'Katya', middle: 'Verenice', last: 'Voelker', suffix: 'M.D.')
+n.format # => "Katya Verenice Voelker M.D."
+n.format(:inverted) # => "Voelker, Katya Verenice M.D."
+n.middle = nil
+n.format # => "Katya Voelker M.D."
+n.format(:inverted) # => "Voelker, Katya M.D."
+```
+
+## Copyright
+
+Copyright (c) 2013 Abe Voelker. Released under the terms of the MIT license.
+See LICENSE for details.
+
+[patio11]: http://www.kalzumeus.com/2010/06/17/falsehoods-programmers-believe-about-names/

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rspec/core/rake_task'
+require 'rake/testtask'
+require 'bundler'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << ["lib", "spec"]
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec
+
+Bundler::GemHelper.install_tasks

data/lib/nomen.rb

@@ -0,0 +1,3 @@
+require 'nomen/version'
+require 'nomen/name'
+require 'nomen/formatters'

data/lib/nomen/formatters.rb

@@ -0,0 +1,15 @@
+Dir[File.expand_path('../formatters/*.rb', __FILE__)].each {|file| require file }
+
+module Nomen
+  module Formatters
+    class UnknownFormatterError < StandardError; end
+
+    def self.lookup(type)
+      begin
+        const_get(type.to_s.split('_').map(&:capitalize).join)
+      rescue NameError
+        raise UnknownFormatterError, "unknown formatter '#{type}'"
+      end
+    end
+  end
+end

data/lib/nomen/formatters/full.rb

@@ -0,0 +1,24 @@
+module Nomen
+  module Formatters
+    class Full
+
+      def self.format(name)
+        String.new.tap do |str|
+          if name.first
+            str << name.first
+          end
+          if name.middle
+            str << (str.empty? ? name.middle : " #{name.middle}")
+          end
+          if name.last
+            str << (str.empty? ? name.last : " #{name.last}")
+          end
+          if name.suffix
+            str << (str.empty? ? name.suffix : " #{name.suffix}")
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/nomen/formatters/inverted.rb

@@ -0,0 +1,28 @@
+module Nomen
+  module Formatters
+    class Inverted
+
+      def self.format(name)
+        String.new.tap do |str|
+          if name.last
+            if [name.first, name.middle, name.suffix].reject(&:nil?).reject(&:empty?).any?
+              str << "#{name.last},"
+            else
+              str << name.last
+            end
+          end
+          if name.first
+            str << (str.empty? ? name.first : " #{name.first}")
+          end
+          if name.middle
+            str << (str.empty? ? name.middle : " #{name.middle}")
+          end
+          if name.suffix
+            str << (str.empty? ? name.suffix : " #{name.suffix}")
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/nomen/name.rb

@@ -0,0 +1,23 @@
+module Nomen
+  class Name
+    attr_accessor :first, :middle, :last, :suffix
+
+    def initialize(opts={})
+      name_opts = opts.select{|k,v| [:first, :middle, :last, :suffix].include?(k)}
+      name_opts.each{|k,v| send("#{k}=".to_sym, v)}
+      self
+    end
+
+    def format(type=:full)
+      Nomen::Formatters.lookup(type).format(self)
+    end
+
+    def ==(other)
+      [:first, :middle, :last, :suffix].each do |m|
+        return false if self.send(m) != other.send(m)
+      end
+      true
+    end
+
+  end
+end

data/lib/nomen/version.rb

@@ -0,0 +1,3 @@
+module Nomen
+  VERSION = "0.0.1"
+end

data/nomen.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/nomen/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "nomen"
+  s.version     = Nomen::VERSION
+  s.authors     = ['Abe Voelker']
+  s.email       = 'abe@abevoelker.com'
+  s.homepage    = 'https://github.com/abevoelker/nomen'
+  s.summary     = %q{Simple human name formatter}
+  s.description = %q{Simple human name formatter}
+  s.license     = 'MIT'
+
+  s.add_development_dependency "bundler",    "~> 1.3"
+  s.add_development_dependency "rspec",      "~> 2.14"
+  s.add_development_dependency "rake",       "~> 10.1"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = ['test','spec','features'].map{|d| `git ls-files -- #{d}/*`.split("\n")}.flatten
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/formatters/formatters_helper.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/../spec_helper'

data/spec/formatters/full_spec.rb

@@ -0,0 +1,159 @@
+require File.dirname(__FILE__) + '/formatters_helper'
+
+describe Nomen::Formatters::Full do
+  context 'formatting a name' do
+
+    # name segment combinations were generated with
+    # s = [:first, :middle, :last, :suffix]; s.size.downto(1).map{|i| s.combination(i).to_a}.flatten(1)
+
+    context 'with [:first, :middle, :last, :suffix]' do
+      before do
+        @name = Nomen::Name.new(first: 'Katya', middle: 'Verenice', last: 'Voelker', suffix: 'M.D.')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Full.format(@name)).to eq('Katya Verenice Voelker M.D.')
+      end
+    end
+
+    context 'with [:first, :middle, :last]' do
+      before do
+        @name = Nomen::Name.new(first: 'Katya', middle: 'Verenice', last: 'Voelker')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Full.format(@name)).to eq('Katya Verenice Voelker')
+      end
+    end
+
+    context 'with [:first, :middle, :suffix]' do
+      before do
+        @name = Nomen::Name.new(first: 'Katya', middle: 'Verenice', suffix: 'M.D.')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Full.format(@name)).to eq('Katya Verenice M.D.')
+      end
+    end
+
+    context 'with [:first, :last, :suffix]' do
+      before do
+        @name = Nomen::Name.new(first: 'Katya', last: 'Voelker', suffix: 'M.D.')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Full.format(@name)).to eq('Katya Voelker M.D.')
+      end
+    end
+
+    context 'with [:middle, :last, :suffix]' do
+      before do
+        @name = Nomen::Name.new(middle: 'Verenice', last: 'Voelker', suffix: 'M.D.')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Full.format(@name)).to eq('Verenice Voelker M.D.')
+      end
+    end
+
+    context 'with [:first, :middle]' do
+      before do
+        @name = Nomen::Name.new(first: 'Katya', middle: 'Verenice')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Full.format(@name)).to eq('Katya Verenice')
+      end
+    end
+
+    context 'with [:first, :last]' do
+      before do
+        @name = Nomen::Name.new(first: 'Katya', last: 'Voelker')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Full.format(@name)).to eq('Katya Voelker')
+      end
+    end
+
+    context 'with [:first, :suffix]' do
+      before do
+        @name = Nomen::Name.new(first: 'Katya', suffix: 'M.D.')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Full.format(@name)).to eq('Katya M.D.')
+      end
+    end
+
+    context 'with [:middle, :last]' do
+      before do
+        @name = Nomen::Name.new(middle: 'Verenice', last: 'Voelker')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Full.format(@name)).to eq('Verenice Voelker')
+      end
+    end
+
+    context 'with [:middle, :suffix]' do
+      before do
+        @name = Nomen::Name.new(middle: 'Verenice', suffix: 'M.D.')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Full.format(@name)).to eq('Verenice M.D.')
+      end
+    end
+
+    context 'with [:last, :suffix]' do
+      before do
+        @name = Nomen::Name.new(last: 'Voelker', suffix: 'M.D.')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Full.format(@name)).to eq('Voelker M.D.')
+      end
+    end
+
+    context 'with [:first]' do
+      before do
+        @name = Nomen::Name.new(first: 'Katya')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Full.format(@name)).to eq('Katya')
+      end
+    end
+
+    context 'with [:middle]' do
+      before do
+        @name = Nomen::Name.new(middle: 'Verenice')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Full.format(@name)).to eq('Verenice')
+      end
+    end
+
+    context 'with [:last]' do
+      before do
+        @name = Nomen::Name.new(last: 'Voelker')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Full.format(@name)).to eq('Voelker')
+      end
+    end
+
+    context 'with [:suffix]' do
+      before do
+        @name = Nomen::Name.new(suffix: 'M.D.')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Full.format(@name)).to eq('M.D.')
+      end
+    end
+  end
+end

data/spec/formatters/inverted_spec.rb

@@ -0,0 +1,159 @@
+require File.dirname(__FILE__) + '/formatters_helper'
+
+describe Nomen::Formatters::Inverted do
+  context 'formatting a name' do
+
+    # name segment combinations were generated with
+    # s = [:first, :middle, :last, :suffix]; s.size.downto(1).map{|i| s.combination(i).to_a}.flatten(1)
+
+    context 'with [:first, :middle, :last, :suffix]' do
+      before do
+        @name = Nomen::Name.new(first: 'Katya', middle: 'Verenice', last: 'Voelker', suffix: 'M.D.')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Inverted.format(@name)).to eq('Voelker, Katya Verenice M.D.')
+      end
+    end
+
+    context 'with [:first, :middle, :last]' do
+      before do
+        @name = Nomen::Name.new(first: 'Katya', middle: 'Verenice', last: 'Voelker')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Inverted.format(@name)).to eq('Voelker, Katya Verenice')
+      end
+    end
+
+    context 'with [:first, :middle, :suffix]' do
+      before do
+        @name = Nomen::Name.new(first: 'Katya', middle: 'Verenice', suffix: 'M.D.')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Inverted.format(@name)).to eq('Katya Verenice M.D.')
+      end
+    end
+
+    context 'with [:first, :last, :suffix]' do
+      before do
+        @name = Nomen::Name.new(first: 'Katya', last: 'Voelker', suffix: 'M.D.')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Inverted.format(@name)).to eq('Voelker, Katya M.D.')
+      end
+    end
+
+    context 'with [:middle, :last, :suffix]' do
+      before do
+        @name = Nomen::Name.new(middle: 'Verenice', last: 'Voelker', suffix: 'M.D.')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Inverted.format(@name)).to eq('Voelker, Verenice M.D.')
+      end
+    end
+
+    context 'with [:first, :middle]' do
+      before do
+        @name = Nomen::Name.new(first: 'Katya', middle: 'Verenice')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Inverted.format(@name)).to eq('Katya Verenice')
+      end
+    end
+
+    context 'with [:first, :last]' do
+      before do
+        @name = Nomen::Name.new(first: 'Katya', last: 'Voelker')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Inverted.format(@name)).to eq('Voelker, Katya')
+      end
+    end
+
+    context 'with [:first, :suffix]' do
+      before do
+        @name = Nomen::Name.new(first: 'Katya', suffix: 'M.D.')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Inverted.format(@name)).to eq('Katya M.D.')
+      end
+    end
+
+    context 'with [:middle, :last]' do
+      before do
+        @name = Nomen::Name.new(middle: 'Verenice', last: 'Voelker')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Inverted.format(@name)).to eq('Voelker, Verenice')
+      end
+    end
+
+    context 'with [:middle, :suffix]' do
+      before do
+        @name = Nomen::Name.new(middle: 'Verenice', suffix: 'M.D.')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Inverted.format(@name)).to eq('Verenice M.D.')
+      end
+    end
+
+    context 'with [:last, :suffix]' do
+      before do
+        @name = Nomen::Name.new(last: 'Voelker', suffix: 'M.D.')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Inverted.format(@name)).to eq('Voelker, M.D.')
+      end
+    end
+
+    context 'with [:first]' do
+      before do
+        @name = Nomen::Name.new(first: 'Katya')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Inverted.format(@name)).to eq('Katya')
+      end
+    end
+
+    context 'with [:middle]' do
+      before do
+        @name = Nomen::Name.new(middle: 'Verenice')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Inverted.format(@name)).to eq('Verenice')
+      end
+    end
+
+    context 'with [:last]' do
+      before do
+        @name = Nomen::Name.new(last: 'Voelker')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Inverted.format(@name)).to eq('Voelker')
+      end
+    end
+
+    context 'with [:suffix]' do
+      before do
+        @name = Nomen::Name.new(suffix: 'M.D.')
+      end
+
+      it 'should format correctly' do
+        expect(Nomen::Formatters::Inverted.format(@name)).to eq('M.D.')
+      end
+    end
+  end
+end

data/spec/formatters_spec.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Nomen::Formatters do
+  context 'formatter lookup' do
+    it 'should return formatter object reference' do
+      expect(Nomen::Formatters.lookup(:full)).to eq(Nomen::Formatters::Full)
+    end
+
+    it 'should raise an error if a formatter cannot be found' do
+      expect{Nomen::Formatters.lookup(:unknown)}.to raise_error
+    end
+  end
+end

data/spec/name_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Nomen::Name do
+  context 'initialization' do
+    it 'should accept no parameters' do
+      expect{Nomen::Name.new}.not_to raise_error
+    end
+
+    it 'should ignore non-name segment hash parameters' do
+      name = Nomen::Name.new(first: 'Katya', foo: 'bar')
+      expect(name).to eq(Nomen::Name.new(first: 'Katya'))
+    end
+
+    it 'should only accept one parameter' do
+      expect{Nomen::Name.new({last: 'Voelker'}, 'foo')}.to raise_error
+    end
+  end
+
+  context 'equality' do
+    it 'should match equality based on name segment matching' do
+      a = Nomen::Name.new(first: 'Katya',  middle: 'Verenice', last: 'Voelker')
+      b = Nomen::Name.new(last: 'Voelker', middle: 'Verenice', first: 'Katya')
+      expect(a).to eq(b)
+      expect(b).to eq(a)
+      a.suffix = "M.D."
+      expect(a).not_to eq(b)
+      expect(b).not_to eq(a)
+    end
+  end
+
+  context 'formatting' do
+    it 'should defer formatting to the proper format object' do
+      a = Nomen::Name.new(first: 'Katya', middle: 'Verenice', last: 'Voelker', suffix: 'M.D.')
+      expect(a.format(:inverted)).to eq(Nomen::Formatters::Inverted.format(a))
+    end
+
+    it 'should default to the :full formatter' do
+      a = Nomen::Name.new(first: 'Katya', middle: 'Verenice', last: 'Voelker', suffix: 'M.D.')
+      expect(a.format).to eq(a.format(:full))
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rspec/autorun'
+require 'nomen'
+
+RSpec.configure do |config|
+  # disable the "should" syntax (planned to be deprecated in RSpec 3.0)
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: nomen
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Abe Voelker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+description: Simple human name formatter
+email: abe@abevoelker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/nomen.rb
+- lib/nomen/formatters.rb
+- lib/nomen/formatters/full.rb
+- lib/nomen/formatters/inverted.rb
+- lib/nomen/name.rb
+- lib/nomen/version.rb
+- nomen.gemspec
+- spec/formatters/formatters_helper.rb
+- spec/formatters/full_spec.rb
+- spec/formatters/inverted_spec.rb
+- spec/formatters_spec.rb
+- spec/name_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/abevoelker/nomen
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Simple human name formatter
+test_files:
+- spec/formatters/formatters_helper.rb
+- spec/formatters/full_spec.rb
+- spec/formatters/inverted_spec.rb
+- spec/formatters_spec.rb
+- spec/name_spec.rb
+- spec/spec_helper.rb