pluginaweek-has_phone_numbers 0.2.0

data/CHANGELOG.rdoc

@@ -0,0 +1,37 @@
+== master
+
+== 0.2.0 / 2009-04-19
+
+* Add the ability to parse raw values [Matt Lightner]
+* Validate that the country code is known
+* Validate number lengths on a per-country code basis
+* Add the list of available country codes
+* Remove PhoneNumber#display_value in favor of using the Rails helper
+* Add dependency on Rails 2.3
+* Remove dependency on plugins_plus
+
+== 0.1.0 / 2008-12-14
+
+* Remove the PluginAWeek namespace
+
+== 0.0.5 / 2008-10-26
+
+* Change how the base module is included to prevent namespacing conflicts
+* Change PhoneNumber#to_s to PhoneNumber#display_value
+
+== 0.0.4 / 2008-06-22
+
+* Remove log files from gems
+
+== 0.0.3 / 2008-05-05
+
+* Updated documentation
+
+== 0.0.2 / 2007-09-26
+
+* Move test fixtures out of the test application root directory
+
+== 0.0.1 / 2007-08-21
+
+* Added documentation
+* Removed dependency on has_association_helper

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2009 Aaron Pfeifer
+
+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.rdoc

@@ -0,0 +1,71 @@
+= has_phone_numbers
+
++has_phone_numbers+ demonstrates a reference implementation for handling phone numbers.
+
+== Resources
+
+API
+
+* http://api.pluginaweek.org/has_phone_numbers
+
+Bugs
+
+* http://pluginaweek.lighthouseapp.com/projects/13275-has_phone_numbers
+
+Development
+
+* http://github.com/pluginaweek/has_phone_numbers
+
+Source
+
+* git://github.com/pluginaweek/has_phone_numbers.git
+
+== Description
+
+A phone number is a simple model whose data and functionality should be
+standardized across multiple applications.  Phone numbers are minimalistic in
+terms of the type of data it represents.  Both U.S. and international formats
+are supported.
+
+== Usage 
+
+Note that this is a reference implementation and, most likely, will be
+modified for your own usage.
+
+=== Example
+
+Building with individual segments:
+
+  PhoneNumber.create(:phoneable => user, :country_code => '1', :number => '1234567890', :extension => '123')
+  # #<PhoneNumber id: 1, phoneable_id: 1, phoneable_type: "User", country_code: "1", number: "1234567890", extension: "123", created_at: "2009-01-01 00:00:00", updated_at: "2009-01-01 00:00:00">
+
+Parsing raw values:
+
+  PhoneNumber.create(:phoneable => user, :content => '1 1234567890 ext. 123')
+  # #<PhoneNumber id: 1, phoneable_id: 1, phoneable_type: "User", country_code: "1", number: "1234567890", extension: "123", created_at: "2009-01-01 00:00:00", updated_at: "2009-01-01 00:00:00">
+  
+  PhoneNumber.create(:phoneable => user, :content => '231 331 996 x4621')
+  # #<PhoneNumber id: 1, phoneable_id: 1, phoneable_type: "User", country_code: "231", number: "331996", extension: "4621", created_at: "2009-01-01 00:00:00", updated_at: "2009-01-01 00:00:00">
+  
+  PhoneNumber.create(:phoneable => user, :content => '+ 386 1 5853 449')
+  # #<PhoneNumber id: 1, phoneable_id: 1, phoneable_type: "User", country_code: "386", number: "15853449", extension: nil, created_at: "2009-01-01 00:00:00", updated_at: "2009-01-01 00:00:00">
+  
+  PhoneNumber.create(:phoneable => user, :content => '+39-02-4823001')
+  # #<PhoneNumber id: 1, phoneable_id: 1, phoneable_type: "User", country_code: "39", number: "024823001", extension: nil, created_at: "2009-01-01 00:00:00", updated_at: "2009-01-01 00:00:00">
+
+== Testing
+
+Before you can run any tests, the following gem must be installed:
+* plugin_test_helper[http://github.com/pluginaweek/plugin_test_helper]
+
+To run against a specific version of Rails:
+
+  rake test RAILS_FRAMEWORK_ROOT=/path/to/rails
+
+== Dependencies
+
+* Rails 2.3 or later
+
+== References
+
+* Casey West - {Parse-PhoneNumber}[http://search.cpan.org/~cwest/Parse-PhoneNumber-1.1]

data/Rakefile

@@ -0,0 +1,96 @@
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/contrib/sshpublisher'
+
+spec = Gem::Specification.new do |s|
+  s.name              = 'has_phone_numbers'
+  s.version           = '0.2.0'
+  s.platform          = Gem::Platform::RUBY
+  s.summary           = 'Demonstrates a reference implementation for handling phone numbers in ActiveRecord'
+  s.description       = s.summary
+  
+  s.files             = FileList['{app,db,lib,test}/**/*'] + %w(CHANGELOG.rdoc init.rb LICENSE Rakefile README.rdoc) - FileList['test/app_root/{log,log/*,script,script/*}']
+  s.require_path      = 'lib'
+  s.has_rdoc          = true
+  s.test_files        = Dir['test/**/*_test.rb']
+  
+  s.author            = 'Aaron Pfeifer'
+  s.email             = 'aaron@pluginaweek.org'
+  s.homepage          = 'http://www.pluginaweek.org'
+  s.rubyforge_project = 'pluginaweek'
+end
+  
+desc 'Default: run all tests.'
+task :default => :test
+
+desc "Test the #{spec.name} plugin."
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.test_files = spec.test_files
+  t.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  namespace :test do
+    desc "Test the #{spec.name} plugin with Rcov."
+    Rcov::RcovTask.new(:rcov) do |t|
+      t.libs << 'lib'
+      t.test_files = spec.test_files
+      t.rcov_opts << '--exclude="^(?!lib/|app/)"'
+      t.verbose = true
+    end
+  end
+rescue LoadError
+end
+
+desc "Generate documentation for the #{spec.name} plugin."
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = spec.name
+  rdoc.template = '../rdoc_template.rb'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc', 'CHANGELOG.rdoc', 'LICENSE', 'lib/**/*.rb', 'app/**/*.rb')
+end
+
+desc 'Generate a gemspec file.'
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_ruby
+  end
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+desc 'Publish the beta gem.'
+task :pgem => [:package] do
+  Rake::SshFilePublisher.new('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/gems', 'pkg', "#{spec.name}-#{spec.version}.gem").upload
+end
+
+desc 'Publish the API documentation.'
+task :pdoc => [:rdoc] do
+  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{spec.name}", 'rdoc').upload
+end
+
+desc 'Publish the API docs and gem'
+task :publish => [:pgem, :pdoc, :release]
+
+desc 'Publish the release files to RubyForge.'
+task :release => [:gem, :package] do
+  require 'rubyforge'
+  
+  ruby_forge = RubyForge.new.configure
+  ruby_forge.login
+  
+  %w(gem tgz zip).each do |ext|
+    file = "pkg/#{spec.name}-#{spec.version}.#{ext}"
+    puts "Releasing #{File.basename(file)}..."
+    
+    ruby_forge.add_release(spec.rubyforge_project, spec.name, spec.version, file)
+  end
+end

data/app/models/phone_number.rb

@@ -0,0 +1,131 @@
+# Represents a phone number split into multiple parts:
+# * +country_code+ - Uniquely identifiers the country to which the number belongs.
+#   This value is based on the E.164 standard (http://en.wikipedia.org/wiki/E.164)
+# * +number+ - The subscriber number (10 digits in length)
+# * +extension+ - A number that can route to different phones at a location
+# 
+# This phone number format is biased towards those types found in the United
+# States and may need to be adjusted for international support.
+class PhoneNumber < ActiveRecord::Base
+  # The valid lengths allowed per country code for area code + subscriber number
+  VALID_LENGTHS = {
+    1 =>  10,     7 => 10,      20 => 9,       27 => 9,      30 => 10,      31 => 9,
+    32 => 8..9,   33 => 9..10,  34 => 9,       36 => 8..9,   39 => 9,       40 => 9,
+    41 => 9..10,  43 => 7..13,  44 => 10..11,  45 => 8,      46 => 9,       47 => 8,     
+    48 => 9,      49 => 7..11,  51 => 8..9,    52 => 8..10,  53 => 8,       54 => 8..9, 
+    55 => 10,     56 => 8..9,   57 => 9..10,   58 => 10,     60 => 9..10,   61 => 9,
+    62 => 8..11,  63 => 8..10,  64 => 8..9,    65 => 8..9,   66 => 9..10,   81 => 9..10,
+    82 => 8..9,   84 => 7..10,  86 => 7..11,   90 => 10,     91 => 10,      92 => 9..10,
+    93 => 8..9,   94 => 10,     95 => 7..8,    98 => 10,     212 => 8,      213 => 8,
+    216 => 8,     218 => 8..9,  220 => 7,      221 => 7,     222 => 7,      223 => 8,
+    224 => 8,     225 => 8,     226 => 8,      227 => 8,     228 => 7,      229 => 8,
+    230 => 7,     231 => 6..8,  232 => 8,      233 => 5..8,  234 => 7..8,   235 => 7,
+    236 => 8,     237 => 8,     238 => 7,      239 => 6..7,  240 => 6,      241 => 6..8,
+    242 => 7,     243 => 8,     244 => 9,      245 => 7,     246 => 4..7,   247 => 4,
+    248 => 6,     249 => 9,     250 => 5..8,   251 => 9,     252 => 7..8,   253 => 6,
+    254 => 9,     255 => 9,     256 => 9,      257 => 8,     258 => 8..9,   260 => 9,
+    261 => 9,     262 => 10,    263 => 8..11,  264 => 6..7,  265 => 8,      266 => 8,
+    267 => 7,     268 => 7,     269 => 7,      290 => 4,     291 => 7,      297 => 7,
+    298 => 6,     299 => 6,     350 => 8,      351 => 9,     352 => 9,      353 => 9,
+    354 => 7..9,  355 => 7..9,  356 => 8,      357 => 8,     358 => 9,      359 => 8..10,
+    370 => 8,     371 => 8,     372 => 7..8,   373 => 8,     374 => 8,      375 => 9,
+    376 => 6..9,  377 => 8..9,  378 => 9..12,  380 => 8..9,  381 => 9,      382 => 8,
+    385 => 8,     386 => 8,     387 => 8,      388 => 8..10, 389 => 7..8,   420 => 9,
+    421 => 9,     423 => 7,     500 => 5,      501 => 7,     502 => 8,      503 => 8,
+    504 => 7..8,  505 => 8,     506 => 8,      507 => 7,     508 => 6,      509 => 8,
+    590 => 10,    591 => 8,     592 => 6..7,   593 => 8..9,  594 => 10,     595 => 9,
+    596 => 10,    597 => 6,     598 => 7..8,   599 => 7,     670 => 7,      672 => 6,
+    673 => 7,     674 => 7,     675 => 7,      676 => 5..7,  677 => 5,      678 => 5..7,
+    679 => 7,     680 => 7,     681 => 6,      682 => 5,     683 => 4,      685 => 6..7,
+    686 => 5,     687 => 6,     688 => 5,      689 => 6,     690 => 4,      691 => 7,
+    692 => 7,     800 => 8..12, 808 => 8,      850 => 8..9,  852 => 8,      853 => 8,
+    855 => 8,     856 => 8,     870 => 9,      871 => 9,     872 => 9,      873 => 9,
+    874 => 9,     878 => 9,     880 => 10,     881 => 6,     882 => 6,      883 => 6,
+    886 => 7..8,  960 => 7,     961 => 8,      962 => 8..9,  963 => 7..8,   964 => 8..10,
+    965 => 7,     966 => 8..9,  967 => 7..9,   968 => 8,     970 => 8,      971 => 7..9,
+    972 => 7..9,  973 => 8,     974 => 7,      975 => 7..8,  976 => 7..10,  977 => 7..8,
+    979 => 9,     991 => 9,     992 => 9,      993 => 8,     994 => 8..9,   995 => 9,
+    996 => 9,     998 => 9
+  }.stringify_keys
+  
+  # The list of country calling codes as defined by ITU-T recommendation E.164
+  COUNTRY_CODES = VALID_LENGTHS.keys
+  
+  # Whether to always use the default country code configured for this model
+  # when parsing the raw content of a phone number
+  cattr_accessor :use_default_country_code_on_parse
+  @@use_default_country_code_on_parse = false
+  
+  belongs_to :phoneable, :polymorphic => true
+  
+  validates_presence_of :phoneable_id, :phoneable_type, :country_code, :number
+  validates_numericality_of :number
+  validates_numericality_of :extension, :allow_nil => true
+  validates_length_of :extension, :maximum => 10, :allow_nil => true
+  validates_inclusion_of :country_code, :in => COUNTRY_CODES
+  validates_each :number do |phone_number, attr, value|
+    country_code = phone_number.country_code
+    
+    if country_code && length = VALID_LENGTHS[country_code]
+      if length.is_a?(Range)
+        if value.nil? || value.size < length.begin
+          phone_number.errors.add(attr, :too_short, :count => length.begin)
+        elsif value.size > length.end
+          phone_number.errors.add(attr, :too_long, :count => length.end)
+        end
+      elsif value.nil? || value.size != length
+        phone_number.errors.add(attr, :wrong_length, :count => length) 
+      end
+    end
+  end
+  
+  # The raw, unparsed content containing the phone number.  This can be parsed
+  # in various formats, such as:
+  # * 599 600 11 22
+  # * + 386 1 5853 449
+  # * +48 (22) 641 0001
+  # * 36 1 267-4636
+  # * +39-02-4823001
+  # * 231 331 996 x4621
+  # * 358 2 141 540 65 ext. 1423
+  attr_accessor :content
+  before_validation_on_create :parse_content, :if => :content
+  
+  private
+    # Parses the raw content of a phone number, extracting the following
+    # attributes:
+    # * country_code
+    # * number
+    # * extension
+    def parse_content
+      content = self.content.strip
+      
+      # Check for extension
+      if match = content.match(/\s*(?:(?:ext|ex|xt|x)[\s.:]*(\d+))$/i)
+        self.extension = match[1]
+        content.gsub!(match.to_s, '')
+      end
+ 
+      # Remove non-digits and leading 0
+      content.gsub!(/\D/, '')
+      content.gsub!(/^0+/, '')
+      
+      if use_default_country_code_on_parse
+        # Scrub pre-determined country code
+        content.gsub!(/^#{country_code}/, '')
+      else
+        # Try to figure out the country code.  It is not possible for one
+        # country code's number to overlap another.
+        (1..3).each do |length|
+          code = content[0, length]
+          if VALID_LENGTHS[code] # Fast lookup
+            self.country_code = code
+            content.gsub!(/^#{code}/, '')
+            break
+          end
+        end
+      end
+      
+      self.number = content
+    end
+end

data/db/migrate/001_create_phone_numbers.rb

@@ -0,0 +1,15 @@
+class CreatePhoneNumbers < ActiveRecord::Migration
+  def self.up
+    create_table :phone_numbers do |t|
+      t.references :phoneable, :polymorphic => true, :null => false
+      t.string :country_code, :null => false, :limit => 3, :default => 1 # Default is the United States
+      t.string :number, :null => false, :limit => 12
+      t.string :extension, :limit => 10
+      t.timestamps
+    end
+  end
+  
+  def self.down
+    drop_table :phone_numbers
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'has_phone_numbers'

data/lib/has_phone_numbers.rb

@@ -0,0 +1,14 @@
+# Adds a generic implementation for dealing with phone numbers
+module HasPhoneNumbers
+  module MacroMethods
+    # Creates the following association:
+    # * +phone_number+ - All phone numbers associated with the current record.
+    def has_phone_numbers
+      has_many :phone_numbers, :as => :phoneable
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  extend HasPhoneNumbers::MacroMethods
+end

data/test/app_root/app/models/person.rb

@@ -0,0 +1,3 @@
+class Person < ActiveRecord::Base
+  has_phone_numbers
+end

data/test/app_root/db/migrate/001_create_people.rb

@@ -0,0 +1,11 @@
+class CreatePeople < ActiveRecord::Migration
+  def self.up
+    create_table :people do |t|
+      t.string :name
+    end
+  end
+  
+  def self.down
+    drop_table :people
+  end
+end

data/test/app_root/db/migrate/002_migrate_has_phone_numbers_to_version_1.rb

@@ -0,0 +1,13 @@
+class MigrateHasPhoneNumbersToVersion1 < ActiveRecord::Migration
+  def self.up
+    ActiveRecord::Migrator.new(:up, "#{Rails.root}/../../db/migrate", 0).migrations.each do |migration|
+      migration.migrate(:up)
+    end
+  end
+  
+  def self.down
+    ActiveRecord::Migrator.new(:up, "#{Rails.root}/../../db/migrate", 0).migrations.each do |migration|
+      migration.migrate(:down)
+    end
+  end
+end

data/test/factory.rb

@@ -0,0 +1,49 @@
+module Factory
+  # Build actions for the model
+  def self.build(model, &block)
+    name = model.to_s.underscore
+    
+    define_method("#{name}_attributes", block)
+    define_method("valid_#{name}_attributes") {|*args| valid_attributes_for(model, *args)}
+    define_method("new_#{name}")              {|*args| new_record(model, *args)}
+    define_method("create_#{name}")           {|*args| create_record(model, *args)}
+  end
+  
+  # Get valid attributes for the model
+  def valid_attributes_for(model, attributes = {})
+    name = model.to_s.underscore
+    send("#{name}_attributes", attributes)
+    attributes.stringify_keys!
+    attributes
+  end
+  
+  # Build an unsaved record
+  def new_record(model, *args)
+    attributes = valid_attributes_for(model, *args)
+    record = model.new(attributes)
+    attributes.each {|attr, value| record.send("#{attr}=", value) if model.accessible_attributes && !model.accessible_attributes.include?(attr) || model.protected_attributes && model.protected_attributes.include?(attr)}
+    record
+  end
+  
+  # Build and save/reload a record
+  def create_record(model, *args)
+    record = new_record(model, *args)
+    record.save!
+    record.reload
+    record
+  end
+  
+  build Person do |attributes|
+    attributes.reverse_merge!(
+      :name => 'John Doe'
+    )
+  end
+  
+  build PhoneNumber do |attributes|
+    attributes[:phoneable] = create_person unless attributes.include?(:phoneable)
+    attributes.reverse_merge!(
+      :country_code => '1',
+      :number => '1234567890'
+    )
+  end
+end

data/test/functional/has_phone_numbers_test.rb

@@ -0,0 +1,22 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class PersonByDefaultTest < Test::Unit::TestCase
+  def setup
+    @person = create_person
+  end
+  
+  def test_should_not_have_any_phone_numbers
+    assert @person.phone_numbers.empty?
+  end
+end
+
+class PersonWithPhoneNumbersTest < Test::Unit::TestCase
+  def setup
+    @person = create_person
+    @phone_number = create_phone_number(:phoneable => @person)
+  end
+  
+  def test_should_have_phone_numbers
+    assert_equal [@phone_number], @person.phone_numbers
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+# Load the plugin testing framework
+$:.unshift("#{File.dirname(__FILE__)}/../../plugin_test_helper/lib")
+require 'rubygems'
+require 'plugin_test_helper'
+
+# Run the migrations
+ActiveRecord::Migrator.migrate("#{Rails.root}/db/migrate")
+
+# Mixin the factory helper
+require File.expand_path("#{File.dirname(__FILE__)}/factory")
+Test::Unit::TestCase.class_eval do
+  include Factory
+end

data/test/unit/phone_number_test.rb

@@ -0,0 +1,319 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class PhoneNumberByDefaultTest < Test::Unit::TestCase
+  def setup
+    @phone_number = PhoneNumber.new
+  end
+  
+  def test_should_not_have_a_phoneable_id
+    assert_nil @phone_number.phoneable_id
+  end
+  
+  def test_should_not_have_a_phoneable_type
+    assert @phone_number.phoneable_type.blank?
+  end
+  
+  def test_should_a_united_states_country_code
+    assert_equal '1', @phone_number.country_code
+  end
+  
+  def test_should_not_have_a_number
+    assert @phone_number.number.blank?
+  end
+  
+  def test_should_not_have_an_extension
+    assert @phone_number.extension.blank?
+  end
+end
+
+class PhoneNumberTest < Test::Unit::TestCase
+  def test_should_be_valid_with_a_set_of_valid_attributes
+    phone_number = new_phone_number
+    assert phone_number.valid?
+  end
+  
+  def test_should_require_a_phoneable_id
+    phone_number = new_phone_number(:phoneable => nil, :phoneable_id => nil)
+    assert !phone_number.valid?
+    assert phone_number.errors.invalid?(:phoneable_id)
+  end
+  
+  def test_should_require_a_phoneable_type
+    phone_number = new_phone_number(:phoneable => nil, :phoneable_type => nil)
+    assert !phone_number.valid?
+    assert phone_number.errors.invalid?(:phoneable_type)
+  end
+  
+  def test_should_require_a_country_code
+    phone_number = new_phone_number(:country_code => nil)
+    assert !phone_number.valid?
+    assert phone_number.errors.invalid?(:country_code)
+  end
+  
+  def test_should_require_a_known_country_code
+    phone_number = new_phone_number(:country_code => '2')
+    assert !phone_number.valid?
+    assert phone_number.errors.invalid?(:country_code)
+    
+    phone_number.country_code = '1'
+    assert phone_number.valid?
+  end
+  
+  def test_should_require_a_number
+    phone_number = new_phone_number(:number => nil)
+    assert !phone_number.valid?
+    assert phone_number.errors.invalid?(:number)
+  end
+  
+  def test_should_require_number_be_a_number
+    phone_number = new_phone_number(:number => 'a' * 10)
+    assert !phone_number.valid?
+    assert phone_number.errors.invalid?(:number)
+  end
+  
+  def test_should_require_number_be_exact_for_country_code_without_range
+    phone_number = new_phone_number(:country_code => '1', :number => '1' * 9)
+    assert !phone_number.valid?
+    assert_equal 'is the wrong length (should be 10 characters)', phone_number.errors.on(:number)
+    
+    phone_number.number += '1'
+    assert phone_number.valid?
+    
+    phone_number.number += '1'
+    assert !phone_number.valid?
+    assert_equal 'is the wrong length (should be 10 characters)', phone_number.errors.on(:number)
+  end
+  
+  def test_should_require_number_be_within_range_for_country_code_with_range
+    phone_number = new_phone_number(:country_code => '32', :number => '1' * 7)
+    assert !phone_number.valid?
+    assert_equal 'is too short (minimum is 8 characters)', phone_number.errors.on(:number)
+    
+    phone_number.number += '1'
+    assert phone_number.valid?
+    
+    phone_number.number += '1'
+    assert phone_number.valid?
+    
+    phone_number.number += '1'
+    assert !phone_number.valid?
+    assert_equal 'is too long (maximum is 9 characters)', phone_number.errors.on(:number)
+  end
+  
+  def test_should_not_require_an_extension
+    phone_number = new_phone_number(:extension => nil)
+    assert phone_number.valid?
+  end
+  
+  def test_should_require_extension_be_at_most_10_digits
+    phone_number = new_phone_number(:extension => '1' * 9)
+    assert phone_number.valid?
+    
+    phone_number.extension += '1'
+    assert phone_number.valid?
+    
+    phone_number.extension += '1'
+    assert !phone_number.valid?
+    assert phone_number.errors.invalid?(:extension)
+  end
+  
+  def test_should_protect_attributes_from_mass_assignment
+    phone_number = PhoneNumber.new(
+      :id => 1,
+      :phoneable_id => 1,
+      :phoneable_type => 'User',
+      :country_code => '123',
+      :number => '8675309',
+      :extension => '999'
+    )
+    
+    assert_nil phone_number.id
+    assert_equal 1, phone_number.phoneable_id
+    assert_equal 'User', phone_number.phoneable_type
+    assert_equal '123', phone_number.country_code
+    assert_equal '8675309', phone_number.number
+    assert_equal '999', phone_number.extension
+  end
+end
+
+class PhoneNumberAfterBeingCreatedTest < Test::Unit::TestCase
+  def setup
+    @person = create_person
+    @phone_number = create_phone_number(:phoneable => @person, :country_code => '1', :number => '1234567890')
+  end
+  
+  def test_should_record_when_it_was_created
+    assert_not_nil @phone_number.created_at
+  end
+  
+  def test_should_record_when_it_was_updated
+    assert_not_nil @phone_number.updated_at
+  end
+  
+  def test_should_have_a_phoneable_association
+    assert_equal @person, @phone_number.phoneable
+  end
+end
+
+class PhoneNumberParserTest < Test::Unit::TestCase
+  def setup
+    @person = create_person
+    @phone_number = new_phone_number(:phoneable => @person, :country_code => nil, :number => nil, :extension => nil)
+  end
+  
+  def test_should_parse_country_code_with_1_digit
+    @phone_number.content = '11234567890'
+    
+    assert @phone_number.valid?
+    assert_equal '1', @phone_number.country_code
+    assert_equal '1234567890', @phone_number.number
+    assert_nil @phone_number.extension
+  end
+  
+  def test_should_parse_country_code_with_2_digits
+    @phone_number.content = '20123456789'
+    
+    assert @phone_number.valid?
+    assert_equal '20', @phone_number.country_code
+    assert_equal '123456789', @phone_number.number
+    assert_nil @phone_number.extension
+  end
+  
+  def test_should_parse_country_code_with_3_digits
+    @phone_number.content = '21212345678'
+    
+    assert @phone_number.valid?
+    assert_equal '212', @phone_number.country_code
+    assert_equal '12345678', @phone_number.number
+    assert_nil @phone_number.extension
+  end
+  
+  def test_should_parse_number_with_spaces
+    @phone_number.content = '1 123 456 7890'
+    
+    assert @phone_number.valid?
+    assert_equal '1', @phone_number.country_code
+    assert_equal '1234567890', @phone_number.number
+    assert_nil @phone_number.extension
+  end
+  
+  def test_should_parse_number_with_dashes
+    @phone_number.content = '1-123-456-7890'
+    
+    assert @phone_number.valid?
+    assert_equal '1', @phone_number.country_code
+    assert_equal '1234567890', @phone_number.number
+    assert_nil @phone_number.extension
+  end
+  
+  def test_should_parse_number_with_parentheses
+    @phone_number.content = '1- (123) 456-7890'
+    
+    assert @phone_number.valid?
+    assert_equal '1', @phone_number.country_code
+    assert_equal '1234567890', @phone_number.number
+    assert_nil @phone_number.extension
+  end
+  
+  def test_should_parse_number_with_leading_zero
+    @phone_number.content = '011234567890'
+    
+    assert @phone_number.valid?
+    assert_equal '1', @phone_number.country_code
+    assert_equal '1234567890', @phone_number.number
+    assert_nil @phone_number.extension
+  end
+  
+  def test_should_parse_number_with_multiple_leading_zeroes
+    @phone_number.content = '0011234567890'
+    
+    assert @phone_number.valid?
+    assert_equal '1', @phone_number.country_code
+    assert_equal '1234567890', @phone_number.number
+    assert_nil @phone_number.extension
+  end
+  
+  def test_should_parse_extension_with_leading_ext
+    @phone_number.content = '11234567890 ext. 123'
+    
+    assert @phone_number.valid?
+    assert_equal '1', @phone_number.country_code
+    assert_equal '1234567890', @phone_number.number
+    assert_equal '123', @phone_number.extension
+  end
+  
+  def test_should_parse_extension_with_leading_ex
+    @phone_number.content = '11234567890 ex:123'
+    
+    assert @phone_number.valid?
+    assert_equal '1', @phone_number.country_code
+    assert_equal '1234567890', @phone_number.number
+    assert_equal '123', @phone_number.extension
+  end
+  
+  def test_should_parse_extension_with_leading_xt
+    @phone_number.content = '11234567890 xt: 123'
+    
+    assert @phone_number.valid?
+    assert_equal '1', @phone_number.country_code
+    assert_equal '1234567890', @phone_number.number
+    assert_equal '123', @phone_number.extension
+  end
+  
+  def test_should_parse_extension_with_leading_x
+    @phone_number.content = '11234567890 x.  123'
+    
+    assert @phone_number.valid?
+    assert_equal '1', @phone_number.country_code
+    assert_equal '1234567890', @phone_number.number
+    assert_equal '123', @phone_number.extension
+  end
+  
+  def test_should_parse_extension_with_mixed_case
+    @phone_number.content = '11234567890 xT 123'
+    
+    assert @phone_number.valid?
+    assert_equal '1', @phone_number.country_code
+    assert_equal '1234567890', @phone_number.number
+    assert_equal '123', @phone_number.extension
+  end
+  
+  def test_should_not_be_valid_if_parse_fails
+    @phone_number.content = '1123456789'
+    
+    assert !@phone_number.valid?
+    assert_equal '1', @phone_number.country_code
+    assert_equal '123456789', @phone_number.number
+    assert_nil @phone_number.extension
+  end
+end
+
+class PhoneNumberParserWithDefaultCountryCodeTest < Test::Unit::TestCase
+  def setup
+    PhoneNumber.use_default_country_code_on_parse = true
+    
+    @person = create_person
+    @phone_number = new_phone_number(:phoneable => @person, :content => '7234567890 ex. 12')
+    @valid = @phone_number.valid?
+  end
+  
+  def test_should_be_valid
+    assert @valid
+  end
+  
+  def test_should_use_default_country_code
+    assert_equal '1', @phone_number.country_code
+  end
+  
+  def test_should_parse_number
+    assert_equal '7234567890', @phone_number.number
+  end
+  
+  def test_should_parse_extension
+    assert_equal '12', @phone_number.extension
+  end
+  
+  def teardown
+    PhoneNumber.use_default_country_code_on_parse = false
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: pluginaweek-has_phone_numbers
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Aaron Pfeifer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-08 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Demonstrates a reference implementation for handling phone numbers in ActiveRecord
+email: aaron@pluginaweek.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/models
+- app/models/phone_number.rb
+- db/migrate
+- db/migrate/001_create_phone_numbers.rb
+- lib/has_phone_numbers.rb
+- test/unit
+- test/unit/phone_number_test.rb
+- test/factory.rb
+- test/app_root
+- test/app_root/app
+- test/app_root/app/models
+- test/app_root/app/models/person.rb
+- test/app_root/db
+- test/app_root/db/migrate
+- test/app_root/db/migrate/002_migrate_has_phone_numbers_to_version_1.rb
+- test/app_root/db/migrate/001_create_people.rb
+- test/test_helper.rb
+- test/functional
+- test/functional/has_phone_numbers_test.rb
+- CHANGELOG.rdoc
+- init.rb
+- LICENSE
+- Rakefile
+- README.rdoc
+has_rdoc: true
+homepage: http://www.pluginaweek.org
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: pluginaweek
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Demonstrates a reference implementation for handling phone numbers in ActiveRecord
+test_files: 
+- test/unit/phone_number_test.rb
+- test/functional/has_phone_numbers_test.rb