has_phone_numbers 0.0.4 → 0.0.5

data/CHANGELOG.rdoc

@@ -0,0 +1,23 @@
+== master
+
+== 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/{README → README.rdoc}

@@ -4,21 +4,21 @@
 
 == Resources
 
-Wiki
-
-* http://wiki.pluginaweek.org/Has_phone_numbers
-
 API
 
 * http://api.pluginaweek.org/has_phone_numbers
 
+Bugs
+
+* http://pluginaweek.lighthouseapp.com/projects/13275-has_phone_numbers
+
 Development
 
-* http://dev.pluginaweek.org/browser/trunk/has_phone_numbers
+* http://github.com/pluginaweek/has_phone_numbers
 
 Source
 
-* http://svn.pluginaweek.org/trunk/has_phone_numbers
+* git://github.com/pluginaweek/has_phone_numbers.git
 
 == Description
 
@@ -39,12 +39,12 @@ modified for your own usage.
     :number => '1234567890',
     :extension => '123'
   )
-  phone_number.to_s # => 1- 1234567890 ext. 123
+  phone_number.display_value # => 1- 1234567890 ext. 123
 
 == Testing
 
 Before you can run any tests, the following gem must be installed:
-* plugin_test_helper[http://wiki.pluginaweek.org/Plugin_test_helper]
+* plugin_test_helper[http://github.com/pluginaweek/plugin_test_helper]
 
 To run against a specific version of Rails:
 
@@ -53,4 +53,4 @@ To run against a specific version of Rails:
 == Dependencies
 
 * Rails 2.1 or later
-* plugins_plus[http://wiki.pluginaweek.org/Plugins_plus]
+* plugins_plus[http://github.com/pluginaweek/plugins_plugins] (optional if app files are copied to your project tree)

data/Rakefile

@@ -3,46 +3,54 @@ require 'rake/rdoctask'
 require 'rake/gempackagetask'
 require 'rake/contrib/sshpublisher'
 
-PKG_NAME           = 'has_phone_numbers'
-PKG_VERSION        = '0.0.4'
-PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
-RUBY_FORGE_PROJECT = 'pluginaweek'
-
-desc 'Default: run unit tests.'
+spec = Gem::Specification.new do |s|
+  s.name              = 'has_phone_numbers'
+  s.version           = '0.0.5'
+  s.platform          = Gem::Platform::RUBY
+  s.summary           = 'Demonstrates a reference implementation for handling phone numbers.'
+  
+  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 has_phone_numbers plugin.'
+desc "Test the #{spec.name} plugin."
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
+  t.test_files = spec.test_files
   t.verbose = true
 end
 
-desc 'Generate documentation for the has_phone_numbers plugin.'
+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    = 'HasPhoneNumbers'
+  rdoc.title    = spec.name
   rdoc.template = '../rdoc_template.rb'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-spec = Gem::Specification.new do |s|
-  s.name            = PKG_NAME
-  s.version         = PKG_VERSION
-  s.platform        = Gem::Platform::RUBY
-  s.summary         = 'Demonstrates a reference implementation for handling phone numbers.'
-  
-  s.files           = FileList['{app,db,lib,test}/**/*'].to_a - FileList['test/app_root/log/*'].to_a + %w(CHANGELOG init.rb MIT-LICENSE Rakefile README)
-  s.require_path    = 'lib'
-  s.autorequire     = 'has_phone_numbers'
-  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'
+  rdoc.rdoc_files.include('README.rdoc', 'CHANGELOG.rdoc', 'LICENSE', 'lib/**/*.rb', 'app/**/*.rb')
 end
   
 Rake::GemPackageTask.new(spec) do |p|
@@ -51,14 +59,14 @@ Rake::GemPackageTask.new(spec) do |p|
   p.need_zip = true
 end
 
-desc 'Publish the beta gem'
+desc 'Publish the beta gem.'
 task :pgem => [:package] do
-  Rake::SshFilePublisher.new('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/gems', 'pkg', "#{PKG_FILE_NAME}.gem").upload
+  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'
+desc 'Publish the API documentation.'
 task :pdoc => [:rdoc] do
-  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{PKG_NAME}", 'rdoc').upload
+  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{spec.name}", 'rdoc').upload
 end
 
 desc 'Publish the API docs and gem'
@@ -71,10 +79,10 @@ task :release => [:gem, :package] do
   ruby_forge = RubyForge.new.configure
   ruby_forge.login
   
-  %w( gem tgz zip ).each do |ext|
-    file = "pkg/#{PKG_FILE_NAME}.#{ext}"
+  %w(gem tgz zip).each do |ext|
+    file = "pkg/#{spec.name}-#{spec.version}.#{ext}"
     puts "Releasing #{File.basename(file)}..."
     
-    ruby_forge.add_release(RUBY_FORGE_PROJECT, PKG_NAME, PKG_VERSION, file)
+    ruby_forge.add_release(spec.rubyforge_project, spec.name, spec.version, file)
   end
 end

data/app/models/phone_number.rb

@@ -1,4 +1,10 @@
-# Represents a phone number (most likely in the United States)
+# 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
   belongs_to  :phoneable,
                 :polymorphic => true
@@ -19,10 +25,18 @@ class PhoneNumber < ActiveRecord::Base
                               :maximum => 10,
                               :allow_nil => true
   
-  def to_s #:nodoc
+  # Generates a human-readable version of the phone number, based on all of the
+  # various parts of the number.
+  # 
+  # For example,
+  # 
+  #   phone = PhoneNumber.new(:country_code => '1', :number => '123-456-7890')
+  #   phone.display_value     # => "1- 123-456-7890"
+  #   phone.extension = "123"
+  #   phone.display_value     # => "1- 123-456-7890 ext. 123"
+  def display_value
     human_number = "#{country_code}- #{number}"
     human_number << " ext. #{extension}" if extension
-    
     human_number
   end
 end

data/lib/has_phone_numbers.rb

@@ -1,12 +1,6 @@
 module PluginAWeek #:nodoc:
   # Adds a generic implementation for dealing with phone numbers
   module HasPhoneNumbers
-    def self.included(base) #:nodoc:
-      base.class_eval do
-        extend PluginAWeek::HasPhoneNumbers::MacroMethods
-      end
-    end
-    
     module MacroMethods
       # Creates the following association:
       # * +phone_number+ - All phone numbers associated with the current record.
@@ -19,5 +13,5 @@ module PluginAWeek #:nodoc:
 end
 
 ActiveRecord::Base.class_eval do
-  include PluginAWeek::HasPhoneNumbers
+  extend PluginAWeek::HasPhoneNumbers::MacroMethods
 end

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

@@ -1,9 +1,3 @@
 class Person < ActiveRecord::Base
-  has_one   :cell_phone,
-              :class_name => 'PhoneNumber',
-              :conditions => {:kind => 'cell'}
-  has_one   :work_phone,
-              :class_name => 'PhoneNumber',
-              :conditions => {:kind => 'work'}
-  has_many  :phone_numbers
+  has_phone_numbers
 end

data/test/factory.rb

@@ -1,26 +1,36 @@
 module Factory
-  # Build actions for the class
-  def self.build(klass, &block)
-    name = klass.to_s.underscore
-    define_method("#{name}_attributes", block)
+  # Build actions for the model
+  def self.build(model, &block)
+    name = model.to_s.underscore
     
-    module_eval <<-end_eval
-      def valid_#{name}_attributes(attributes = {})
-        #{name}_attributes(attributes)
-        attributes
-      end
-      
-      def new_#{name}(attributes = {})
-        #{klass}.new(valid_#{name}_attributes(attributes))
-      end
-      
-      def create_#{name}(*args)
-        record = new_#{name}(*args)
-        record.save!
-        record.reload
-        record
-      end
-    end_eval
+    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|

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

@@ -8,6 +8,6 @@ ActiveRecord::Migrator.migrate("#{Rails.root}/db/migrate")
 
 # Mixin the factory helper
 require File.expand_path("#{File.dirname(__FILE__)}/factory")
-class Test::Unit::TestCase #:nodoc:
+Test::Unit::TestCase.class_eval do
   include Factory
 end

data/test/unit/phone_number_test.rb

@@ -113,6 +113,24 @@ class PhoneNumberTest < Test::Unit::TestCase
     assert !phone_number.valid?
     assert_equal 1, Array(phone_number.errors.on(:extension)).size
   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
@@ -133,8 +151,8 @@ class PhoneNumberAfterBeingCreatedTest < Test::Unit::TestCase
     assert_equal @person, @phone_number.phoneable
   end
   
-  def test_should_generate_stringified_version_of_phone_number
-    assert_equal '1- 1234567890', @phone_number.to_s
+  def test_should_have_a_display_value
+    assert_equal '1- 1234567890', @phone_number.display_value
   end
 end
 
@@ -143,7 +161,7 @@ class PhoneNumberWithExtensionTest < Test::Unit::TestCase
     @phone_number = create_phone_number(:country_code => '1', :number => '1234567890', :extension => '123')
   end
   
-  def test_should_generate_stringified_version_of_phone_number
-    assert_equal '1- 1234567890 ext. 123', @phone_number.to_s
+  def test_should_have_a_display_value
+    assert_equal '1- 1234567890 ext. 123', @phone_number.display_value
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: has_phone_numbers
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Aaron Pfeifer
-autorequire: has_phone_numbers
+autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-06-22 00:00:00 -04:00
+date: 2008-10-26 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -37,17 +37,17 @@ files:
 - test/app_root/db/migrate
 - test/app_root/db/migrate/001_create_people.rb
 - test/app_root/db/migrate/002_migrate_has_phone_numbers_to_version_1.rb
-- test/app_root/db/migrate/003_add_phone_number_kinds.rb
-- test/app_root/log
+- test/functional
+- test/functional/has_phone_numbers_test.rb
 - test/test_helper.rb
 - test/factory.rb
 - test/unit
 - test/unit/phone_number_test.rb
-- CHANGELOG
+- CHANGELOG.rdoc
 - init.rb
-- MIT-LICENSE
+- LICENSE
 - Rakefile
-- README
+- README.rdoc
 has_rdoc: true
 homepage: http://www.pluginaweek.org
 post_install_message: 
@@ -69,10 +69,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.1.1
+rubyforge_project: pluginaweek
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Demonstrates a reference implementation for handling phone numbers.
 test_files: 
+- test/functional/has_phone_numbers_test.rb
 - test/unit/phone_number_test.rb

data/CHANGELOG

@@ -1,19 +0,0 @@
-*SVN*
-
-*0.0.4* (June 22nd, 2008)
-
-* Remove log files from gems
-
-*0.0.3* (May 5th, 2008)
-
-* Updated documentation
-
-*0.0.2* (September 26th, 2007)
-
-* Move test fixtures out of the test application root directory
-
-*0.0.1* (August 21st, 2007)
-
-* Added documentation
-
-* Removed dependency on has_association_helper

data/test/app_root/db/migrate/003_add_phone_number_kinds.rb

@@ -1,9 +0,0 @@
-class AddPhoneNumberKinds < ActiveRecord::Migration
-  def self.up
-    add_column :phone_numbers, :kind, :string
-  end
-  
-  def self.down
-    remove_column :phone_numbers, :kind, :string
-  end
-end