nameable_record 0.2.0 → 1.0.0

data/spec/lib/nameable_record/name_spec.rb

@@ -0,0 +1,239 @@
+require 'spec_helper'
+
+describe NameableRecord::Name do
+
+  subject { name }
+
+  let :name do
+    described_class.new *name_parts
+  end
+
+  let :another_name do
+    described_class.new *name_parts
+  end
+
+  it 'should be frozen after initialization' do
+    subject.should be_frozen
+  end
+
+  it 'should know when it is equal to another Name' do
+    subject.eql?( another_name ).should be_true
+    subject.==( another_name ).should be_true
+  end
+
+  context 'PREDEFINED_PATTERNS' do
+
+    subject { described_class::PREDEFINED_PATTERNS }
+
+    it { should == {
+          :full => "%l, %f %s",
+          :full_with_middle => "%l, %f %m %s",
+          :full_with_prefix => "%l, %p %f %s",
+          :full_sentence => "%p %f %l %s",
+          :full_sentence_with_middle => "%p %f %m %l %s"
+       }
+    }
+
+  end
+
+  context 'PATTERN_MAP' do
+
+    subject { described_class::PATTERN_MAP }
+
+    it { should == {
+           /%l/ => :last,
+           /%f/ => :first,
+           /%m/ => :middle,
+           /%p/ => :prefix,
+           /%s/ => :suffix
+       }
+    }
+
+  end
+
+  context 'PREFIX_BASE' do
+
+    subject { described_class::PREFIX_BASE.sort }
+
+    it { should == %w(Mr Mrs Miss Dr General).sort }
+
+  end
+
+  context 'SUFFIX_BASE' do
+
+    subject { described_class::SUFFIX_BASE.sort }
+
+    it { should == %w(Jr III IV V Esq).sort }
+
+  end
+
+  context 'PREFIXES' do
+
+    subject { described_class::PREFIXES }
+
+    it { should == ["DR", "DR.", "Dr", "Dr.", "GENERAL", "GENERAL.", "General", "General.", "MISS", "MISS.", "MR", "MR.", "MRS", "MRS.", "Miss", "Miss.", "Mr", "Mr.", "Mrs", "Mrs.", "dr", "dr.", "general", "general.", "miss", "miss.", "mr", "mr.", "mrs", "mrs."] }
+
+  end
+
+  context 'SUFFIXES' do
+
+    subject { described_class::SUFFIXES }
+
+    it { should == ["ESQ", "ESQ.", "Esq", "Esq.", "III", "III", "III.", "III.", "IV", "IV", "IV.", "IV.", "JR", "JR.", "Jr", "Jr.", "V", "V", "V.", "V.", "esq", "esq.", "iii", "iii.", "iv", "iv.", "jr", "jr.", "v", "v."] }
+
+  end
+
+  context '#to_s' do
+
+    subject { name.to_s }
+
+    it { should == 'Smith, John' }
+
+    context 'when given a default pattern' do
+
+      context ':full' do
+
+        subject { name.to_s :full }
+
+        it { should == 'Smith, John III' }
+
+      end
+
+      context ':full' do
+
+        subject { name.to_s :full_with_middle }
+
+        it { should == 'Smith, John Jacob III' }
+
+      end
+
+      context ':full' do
+
+        subject { name.to_s :full_with_prefix }
+
+        it { should == 'Smith, Mr. John III' }
+
+      end
+
+      context ':full' do
+
+        subject { name.to_s :full_sentence }
+
+        it { should == 'Mr. John Smith III' }
+
+      end
+
+      context ':full' do
+
+        subject { name.to_s :full_sentence_with_middle }
+
+        it { should == 'Mr. John Jacob Smith III' }
+
+      end
+
+    end
+
+    context 'when given a pattern' do
+
+      context "'%f %l'" do
+
+        subject { name.to_s '%f %l' }
+
+        it { should == 'John Smith' }
+
+      end
+
+      context "'%p %f %l'" do
+
+        subject { name.to_s '%p %f %l' }
+
+        it { should == 'Mr. John Smith' }
+
+      end
+
+      context "'%p %f %l %s'" do
+
+        subject { name.to_s '%p %f %l %s' }
+
+        it { should == 'Mr. John Smith III' }
+
+      end
+
+      context "'%p %f %m %l %s'" do
+
+        subject { name.to_s '%p %f %m %l %s' }
+
+        it { should == 'Mr. John Jacob Smith III' }
+
+      end
+
+    end
+
+  end
+
+  # context 'parsing' do
+
+  #   context 'a string name' do
+
+  #     context 'John Smith' do
+
+  #       subject { described_class.parse( 'John Smith' ) }
+
+  #       it { should == described_class.new( 'Smith', 'John' ) }
+
+  #     end
+
+  #     context 'John Jacob Smith' do
+
+  #       subject { described_class.parse( 'John Jacob Smith' ) }
+
+  #       it { should == described_class.new( 'Smith', 'John', nil, 'Jacob' ) }
+
+  #     end
+
+  #     context 'Mr. John Smith' do
+
+  #       subject { described_class.parse( 'Mr. John Smith' ) }
+
+  #       it { should == described_class.new( 'Smith', 'John', 'Mr.' ) }
+
+  #     end
+
+  #     context 'Mr. John Jacob Smith' do
+
+  #       subject { described_class.parse( 'Mr. John Jacob Smith' ) }
+
+  #       it { should == described_class.new( 'Smith', 'John', 'Mr.', 'Jacob' ) }
+
+  #     end
+
+  #     context 'John Jacob Smith Jr.' do
+
+  #       subject { described_class.parse( 'John Jacob Smith Jr.' ) }
+
+  #       it { should == described_class.new( 'Smith', 'John', nil, 'Jacob', 'Jr' ) }
+
+  #     end
+
+  #     context 'Mr. John Smith Jr' do
+
+  #       subject { described_class.parse( 'Mr. John Smith Jr' ) }
+
+  #       it { should == described_class.new( 'Smith', 'John', 'Mr.', nil, 'Jr' ) }
+
+  #     end
+
+  #     context 'Mr John Jacob Smith III' do
+
+  #       subject { described_class.parse( 'Mr John Jacob Smith III' ) }
+
+  #       it { should == described_class.new( 'Smith', 'John', 'Mr.', 'Jacob', 'III' ) }
+
+  #     end
+
+  #   end
+
+  # end
+
+end
+

data/spec/lib/nameable_record_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe "NameableRecord" do
+
+
+
+end
+

data/spec/rails_spec_helper.rb

@@ -0,0 +1,3 @@
+ActiveRecord::Base.send :include, NameableRecord::ActiveRecordExtensions
+require File.dirname(__FILE__) + '/../script/environment'
+

data/spec/spec_helper.rb

@@ -1,9 +1,29 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'active_record'
+require 'rails'
+require 'bundler/setup'
+
 require 'nameable_record'
-require 'spec'
-require 'spec/autorun'
 
-Spec::Runner.configure do |config|
-  
+RSpec.configure do |config|
+
+  config.mock_with :rspec
+
+end
+
+def name_parts
+  %w(Smith John Mr. Jacob III)
 end
+
+class Hash
+  # for excluding keys
+  def except(*exclusions)
+    self.reject { |key, value| exclusions.include? key.to_sym }
+  end
+
+  # for overriding keys
+  def with(overrides = {})
+    self.merge overrides
+  end
+end
+

metadata

@@ -2,68 +2,110 @@
 name: nameable_record
 version: !ruby/object:Gem::Version 
   hash: 23
-  prerelease: false
+  prerelease: 
   segments: 
+  - 1
   - 0
-  - 2
   - 0
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors: 
-- C. Jason Harrelson
+- Jason Harrelson
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-10-02 00:00:00 -05:00
+date: 2011-11-08 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: gem-dandy
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 3
         segments: 
-        - 1
-        - 2
-        - 9
-        version: 1.2.9
+        - 0
+        version: "0"
   type: :development
   version_requirements: *id001
-description: Encapsulates the composed of pattern for names into any easy to use library.
-email: jason@lookforwardenterprises.com
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Abstracts the ActiveRecord composed_of pattern for names.  Also provides other convenience utilieis for working with human names.
+email: 
+- jason@lookforwardenterprises.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
 - .document
 - .gitignore
-- LICENSE
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- Guardfile
 - README.rdoc
 - Rakefile
-- VERSION
 - lib/nameable_record.rb
 - lib/nameable_record/active_record_extensions.rb
+- lib/nameable_record/data/given-names.txt
+- lib/nameable_record/data/surnames.txt
 - lib/nameable_record/name.rb
+- lib/nameable_record/name_recognition.rb
+- lib/nameable_record/name_recognizer.rb
+- lib/nameable_record/railtie.rb
+- lib/nameable_record/version.rb
 - nameable_record.gemspec
-- spec/nameable_record_spec.rb
-- spec/spec.opts
+- script/environment.rb
+- spec/database.yml
+- spec/lib/nameable_record/active_record_extensions_spec.rb
+- spec/lib/nameable_record/name_recognition_sharedspec.rb
+- spec/lib/nameable_record/name_recognition_spec.rb
+- spec/lib/nameable_record/name_recognizer_spec.rb
+- spec/lib/nameable_record/name_spec.rb
+- spec/lib/nameable_record_spec.rb
+- spec/rails_spec_helper.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/midas/nameable_record
+homepage: https://github.com/midas/nameable_record
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -86,11 +128,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.7
+rubyforge_project: nameable_record
+rubygems_version: 1.6.0
 signing_key: 
 specification_version: 3
-summary: Encapsulates the composed of pattern for names into any easy to use library.
+summary: Abstracts the ActiveRecord composed_of pattern for names.
 test_files: 
-- spec/nameable_record_spec.rb
+- spec/database.yml
+- spec/lib/nameable_record/active_record_extensions_spec.rb
+- spec/lib/nameable_record/name_recognition_sharedspec.rb
+- spec/lib/nameable_record/name_recognition_spec.rb
+- spec/lib/nameable_record/name_recognizer_spec.rb
+- spec/lib/nameable_record/name_spec.rb
+- spec/lib/nameable_record_spec.rb
+- spec/rails_spec_helper.rb
 - spec/spec_helper.rb

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2009 Jason Harrelson (midas)
-
-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/VERSION

@@ -1 +0,0 @@
-0.2.0

data/spec/nameable_record_spec.rb

@@ -1,7 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "NameableRecord" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
-  end
-end

data/spec/spec.opts

@@ -1 +0,0 @@
---color