namie 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 440dea9bb74463fcf2fec7ceb3902107284cc2e7
+  data.tar.gz: b40cce711ac182df79785adc580a1f2e1b21d7b1
+SHA512:
+  metadata.gz: 1b344dbd9b7f32e62fd4e1ec82f0943334672a8fadd057587dd0033d4ad588c32cdce685c8489fbcb52e89b4a89d5fa84f30198a45518b840c6cee2f60cecbe5
+  data.tar.gz: 3232b7e12198c6dfb0e29067897e4e9f2d37b5ef34a5b646d97e987c749ec3eaf212de6cf27f98dd016e1a86af55262f1c364cab74f1d7c57643f36a57a4aff2

data/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+coverage
+rdoc
+pkg
+.bundle
+Gemfile.lock
+*.gem
+*.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in phonie-codes.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,26 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec feature)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+guard :minitest do
+  # with Minitest::Unit
+  # watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  # watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  # watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  watch(/^spec\/(.*)_spec\.rb$/)
+  watch(/^lib\/(.+)\.rb$/)         { 'spec' }
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  watch(/^spec\/spec_helper\.rb$/) { 'spec' }
+end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(/(?:.+\/)?\.rubocop\.yml$/) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -0,0 +1,57 @@
+
+                .-.
+                  ;  :                              .-.
+                .;:  :     .-.      . ,';.,';.      `-'    .-.
+               .;' \ :    ;   :     ;;  ;;  ;;     ;'    .;.-'
+           .:'.;    \:    `:::'-'  ';  ;;  ';   _.;:._.   `:::'
+          (__.'      `.           _;        `-'
+
+
+
+Names as first class citizens
+
+
+## Install
+
+
+    gem 'namie'
+
+
+## Use
+
+
+```
+name = Name.new('Jules Verne')
+name.first  # 'Jules'
+name.last   # 'Verne'
+name.to_s   # 'Jules Verne'
+```
+
+
+Accepts prefix, suffix and middlenames:
+
+```
+name = Name.new('Sir Arthur C. Clark')
+name.title  # 'Sir'
+name.first  # 'Arthur'
+name.last   # 'Clark'
+name.to_s("%l %m, %f")  # Clark C., Arthur
+```
+
+Accepts and detects company names and suffixes:
+
+```
+name = Name.new('ACME Corp LLC')
+name.first  # 'ACME'
+name.last   # 'Corp'
+name.suffix # 'LLC'
+```
+
+
+## ActiveModel
+
+Working on it:
+
+* to params hash
+* cached/customizable string
+* sanitized string

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+task default: [:test]

data/lib/namie/formatter.rb

@@ -0,0 +1,41 @@
+module Namie
+  # Format name
+  class Formatter
+    attr_accessor :out, :name, :format
+    FORMATS = {
+      default: '%t %f %m %l %s',
+      airport: '%t %l, %f %m %s',
+      strip: '%f %l'
+    }
+
+    ABBR = {
+      t: :title,
+      f: :first,
+      m: :middle,
+      l: :last,
+      s: :suffix
+    }
+
+    def initialize(name, format)
+      @name = name
+      format ||= :default
+      @format = format.is_a?(Symbol) ? FORMATS[format] : format
+      @out = @format.dup
+    end
+
+    #
+    # %t  Title
+    # %f  First Name
+    # %m  Middle Name(s)
+    # %l  Last Name
+    # %s  suffix
+    #
+    def to_s
+      ABBR.each do |k, v|
+        val = name.send(v)
+        out.gsub!("%#{k}", val || '')
+      end
+      out.gsub(/\s{2,}/, ' ').strip.chomp
+    end
+  end
+end

data/lib/namie/name.rb

@@ -0,0 +1,38 @@
+module Namie
+  # The Name!
+  class Name
+    attr_accessor :title, :first, :middle, :last, :suffix
+
+    def initialize(*args)
+      @title, @first, *@middle, @last, @suffix = Namie::Parser.new(args).args
+    end
+    alias_method :firstname, :first
+    alias_method :middlenames, :middle
+    alias_method :lastname, :last
+
+    def middle
+      return nil if @middle.reject(&:nil?).empty?
+      @middle.join(' ')
+    end
+
+    def valid?
+      !first.empty?
+    end
+
+    def ==(other)
+      fullname == other.fullname
+    end
+
+    def fullname
+      to_s
+    end
+
+    def shortname
+      to_s(:short)
+    end
+
+    def to_s(fmt = nil)
+      Namie::Formatter.new(self, fmt).to_s
+    end
+  end
+end

data/lib/namie/parser.rb

@@ -0,0 +1,39 @@
+module Namie
+  # Name parser
+  class Parser
+    TITLES = /^(Mister|Mr\.?|Sr\.?|Sir|Senhor|Dr\.?|Doutor|Sra\.?|Senhora)\b/i
+    JURIDIC = /\b(Ltd\.?|LTDA|Gmbh|LLC|S\/A)$/i
+    SUFFIXES = /\b(#{JURIDIC}|Junior|Jr\.?|Neto|II|III)$/i
+    attr_accessor :title, :first, :middle, :last, :suffix, :txt
+
+    def initialize(params)
+      hsh, txt = params.partition { |pm| pm.respond_to?(:key) }
+      hsh.each { |k, v| send("#{k}=", v) }
+      @txt = txt.map { |t| t.split(' ') }.flatten
+      remove_non_names
+      parse_name
+      normalize
+    end
+
+    def parse_name
+      @txt.push(@txt.shift.tr(',', '')) if txt.first  =~ /,/
+      @first, *@middle, @last = txt.size > 2 ? txt : txt.insert(1, nil)
+    end
+
+    def remove_non_names
+      @title, @txt = txt.partition { |a| a =~ TITLES }
+      @suffix, @txt = txt.partition { |a| a =~ SUFFIXES }
+    end
+
+    def normalize
+      [:title, :middle, :suffix].each do |v|
+        val =  send(v).reject(&:nil?).any? ? send(v).join(' ') : nil
+        instance_variable_set("@#{v}", val)
+      end
+    end
+
+    def args
+      [title, first, middle, last, suffix]
+    end
+  end
+end

data/lib/namie/version.rb

@@ -0,0 +1,4 @@
+# :nodoc:
+module Namie
+  VERSION = '0.0.1'
+end

data/lib/namie.rb

@@ -0,0 +1,9 @@
+require 'namie/name'
+require 'namie/parser'
+require 'namie/formatter'
+
+#
+# Names as first class citizens
+#
+module Namie
+end

data/namie.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'namie/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'namie'
+  s.version     = Namie::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Marcos Piccinini']
+  s.email       = ['nofxx@github.com']
+  s.homepage    = 'http://github.com/nofxx/namie'
+  s.summary     = 'Area codes for phonie'
+  s.description = 'Area codes for phonie'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'minitest', '~> 5.0'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rake'
+end

data/spec/namie/formatter_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Namie::Parser do
+  describe 'Simple name' do
+    let(:parse) { Namie::Name.new('Jules Verne') } # Jules Gabriel Verne
+
+    it 'should have a nice #to_s' do
+      parse.to_s.must_equal('Jules Verne')
+    end
+
+    it 'should have a nice #to_s(:symbol)' do
+      parse.to_s(:airport).must_equal('Verne, Jules')
+    end
+  end
+end

data/spec/namie/name_spec.rb

@@ -0,0 +1,158 @@
+require 'spec_helper'
+
+describe Namie::Name do
+  it 'should instantiate' do
+    Namie::Name.new('Isaac Asimov').must_be_instance_of(Namie::Name)
+  end
+
+  it 'should accept middle names' do
+    Namie::Name.new('John Edgard Smith').valid?.must_equal(true)
+  end
+
+  it 'should abbr middle names' do
+    Namie::Name.new('George S. Patton').must_be_instance_of(Namie::Name)
+  end
+
+  it 'should respond to alias method firstname' do
+    Namie::Name.new('Isaac Asimov').first.must_equal('Isaac')
+  end
+
+  it 'should respond to alias method lastname' do
+    Namie::Name.new('George S. Patton').lastname.must_equal('Patton')
+  end
+
+  describe 'Simple name' do
+    let(:nam) { Namie::Name.new('Jules Verne') } # Jules Gabriel Verne
+
+    it { nam.title.must_be_nil }
+    it { nam.first.must_equal('Jules') }
+    it { nam.middle.must_be_nil }
+    it { nam.last.must_equal('Verne') }
+    it { nam.fullname.must_equal('Jules Verne') }
+  end
+
+  describe 'Simple name' do
+    let(:nam) { Namie::Name.new('Douglas Adams') } # Jules Gabriel Verne
+
+    it { nam.first.must_equal('Douglas') }
+    it { nam.middle.must_be_nil }
+    it { nam.last.must_equal('Adams') }
+  end
+
+  describe 'Name with middle name' do
+    let(:nam) { Namie::Name.new('Alberto Santos Dumont') }
+
+    it { nam.title.must_be_nil }
+    it { nam.first.must_equal('Alberto') }
+    it { nam.middle.must_equal('Santos') }
+    it { nam.last.must_equal('Dumont') }
+    it { nam.suffix.must_be_nil }
+    it { nam.fullname.must_equal('Alberto Santos Dumont') }
+  end
+
+  describe 'Name with abbr middle name' do
+    let(:nam) { Namie::Name.new('Arthur C. Clark') }
+
+    it { nam.title.must_be_nil }
+    it { nam.first.must_equal('Arthur') }
+    it { nam.middle.must_equal('C.') }
+    it { nam.last.must_equal('Clark') }
+    it { nam.suffix.must_be_nil }
+  end
+
+  describe 'Name with lots of middle names' do
+    let(:nam) { Namie::Name.new('Isabel Cristina Leopoldina Augusta Micaela Gabriela Rafaela Gonzaga de Bragança e Bourbon') } # rubocop:disable Metrics/LineLength
+
+    it { nam.title.must_be_nil }
+    it { nam.first.must_equal('Isabel') }
+    it { nam.middle.size.must_equal(74) }
+    it { nam.last.must_equal('Bourbon') }
+    it { nam.suffix.must_be_nil }
+  end
+
+  describe 'Name with title' do
+    let(:nam) { Namie::Name.new('Sir Arthur C. Clark') }
+
+    it { nam.title.must_equal('Sir') }
+    it { nam.first.must_equal('Arthur') }
+    it { nam.middle.must_equal('C.') }
+    it { nam.last.must_equal('Clark') }
+    it { nam.fullname.must_equal('Sir Arthur C. Clark') }
+  end
+
+  describe 'Name with suffix' do
+    let(:nam) { Namie::Name.new('José Maria Jr.') }
+
+    it { nam.first.must_equal('José') }
+    it { nam.middle.must_be_nil }
+    it { nam.last.must_equal('Maria') }
+    it { nam.fullname.must_equal('José Maria Jr.') }
+    it { nam.suffix.must_equal('Jr.') }
+  end
+
+  describe 'Name with suffix' do
+    let(:nam) { Namie::Name.new('José Maria Neto') }
+
+    it { nam.first.must_equal('José') }
+    it { nam.middle.must_be_nil }
+    it { nam.last.must_equal('Maria') }
+    it { nam.fullname.must_equal('José Maria Neto') }
+    it { nam.suffix.must_equal('Neto') }
+  end
+
+  describe 'Company name with suffix' do
+    let(:nam) { Namie::Name.new('ACME Enterprises Ltd.') }
+
+    it { nam.first.must_equal('ACME') }
+    it { nam.middle.must_be_nil }
+    it { nam.last.must_equal('Enterprises') }
+    it { nam.fullname.must_equal('ACME Enterprises Ltd.') }
+    it { nam.suffix.must_equal('Ltd.') }
+  end
+
+  describe 'Company name with suffix' do
+    let(:nam) { Namie::Name.new('ACME Enterprises Ltda') }
+
+    it { nam.first.must_equal('ACME') }
+    it { nam.middle.must_be_nil }
+    it { nam.last.must_equal('Enterprises') }
+    it { nam.fullname.must_equal('ACME Enterprises Ltda') }
+    it { nam.suffix.must_equal('Ltda') }
+    it { nam.to_s('%f - %l').must_equal('ACME - Enterprises') }
+  end
+
+  describe 'Name with nickname style' do
+    let(:nam) { Namie::Name.new('Ian Fraser "Lemmy" Kilmister') }
+
+    it { nam.title.must_be_nil }
+    it { nam.first.must_equal('Ian') }
+    it { nam.middle.must_equal('Fraser "Lemmy"') }
+    it { nam.last.must_equal('Kilmister') }
+    it { nam.fullname.must_equal('Ian Fraser "Lemmy" Kilmister') }
+    it { nam.suffix.must_be_nil }
+  end
+
+  describe 'Name aiport style' do
+    let(:nam) { Namie::Name.new('Hendrix, Jimmi') }
+
+    it { nam.title.must_be_nil }
+    it { nam.first.must_equal('Jimmi') }
+    it { nam.middle.must_be_nil }
+    it { nam.last.must_equal('Hendrix') }
+    it { nam.fullname.must_equal('Jimmi Hendrix') }
+    it { nam.suffix.must_be_nil }
+    it { nam.to_s(:airport).must_equal('Hendrix, Jimmi') }
+  end
+
+  describe 'Name aiport style' do
+    let(:nam) { Namie::Name.new('Hendrix, Jimmi') }
+
+    it { nam.title.must_be_nil }
+    it { nam.first.must_equal('Jimmi') }
+    it { nam.middle.must_be_nil }
+    it { nam.last.must_equal('Hendrix') }
+    it { nam.fullname.must_equal('Jimmi Hendrix') }
+    it { nam.suffix.must_be_nil }
+    it { nam.to_s(:airport).must_equal('Hendrix, Jimmi') }
+  end
+end

data/spec/namie/parser_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Namie::Parser do
+  describe 'Simple name' do
+    let(:parse) { Namie::Parser.new(['Jules Verne']) } # Jules Gabriel Verne
+
+    it { parse.title.must_be_nil }
+    it { parse.first.must_equal('Jules') }
+    it { parse.middle.must_be_nil }
+    it { parse.last.must_equal('Verne') }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'minitest/autorun'
+require_relative '../lib/namie'
+
+include Namie

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: namie
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marcos Piccinini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Area codes for phonie
+email:
+- nofxx@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/namie.rb
+- lib/namie/formatter.rb
+- lib/namie/name.rb
+- lib/namie/parser.rb
+- lib/namie/version.rb
+- namie.gemspec
+- spec/namie/formatter_spec.rb
+- spec/namie/name_spec.rb
+- spec/namie/parser_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/nofxx/namie
+licenses: []
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Area codes for phonie
+test_files:
+- spec/namie/formatter_spec.rb
+- spec/namie/name_spec.rb
+- spec/namie/parser_spec.rb
+- spec/spec_helper.rb
+has_rdoc: