has_phone_numbers 0.0.1

data/CHANGELOG

@@ -0,0 +1,7 @@
+*SVN*
+
+*0.0.1* (August 21st, 2007)
+
+* Added documentation
+
+* Removed dependency on has_association_helper

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2007 Aaron Pfeifer & Neil Abraham
+
+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

@@ -0,0 +1,55 @@
+= has_phone_numbers
+
+has_phone_numbers adds a base skeleton for handling phone numbers.
+
+== Resources
+
+API
+
+* http://api.pluginaweek.org/has_phone_numbers
+
+Wiki
+
+* http://wiki.pluginaweek.org/Has_phone_numbers
+
+Announcement
+
+* http://www.pluginaweek.org/
+
+Source
+
+* http://svn.pluginaweek.org/trunk/plugins/active_record/has/has_phone_numbers
+
+Development
+
+* http://dev.pluginaweek.org/browser/trunk/plugins/active_record/has/has_phone_numbers
+
+== Description
+
+A phone number is a simple model whose data and functionality should be
+standardized across multiple applications.  Phone numbers are minimialistic in
+terms of the type of data required and follows the standard U.S. format.
+Support for international formats may be added in the future.
+
+=== Running migrations
+
+To migrate the tables required for has_phone_numbers, you can either run the
+migration from the command line like so:
+
+  rake db:migrate:plugins PLUGIN=has_phone_numbers
+
+or (more ideally) generate a migration file that will integrate into your main
+application's migration path:
+
+  ruby script/generate plugin_migration MigrateHasPhoneNumbersToVersion1
+
+== Testing
+
+The following plugins/gems must be installed before any tests can be run:
+* plugin_dependencies - http://wiki.pluginaweekk.org/Plugin_dependencies
+* loaded_plugins - http://wiki.pluginaweek.org/Loaded_plugins
+* appable_plugins - http://wiki.pluginaweek.org/Appable_plugins
+
+== Dependencies
+
+This plugin does not depend on the presence of any other plugin.

data/Rakefile

@@ -0,0 +1,79 @@
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/contrib/sshpublisher'
+
+PKG_NAME           = 'has_phone_numbers'
+PKG_VERSION        = '0.0.1'
+PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
+RUBY_FORGE_PROJECT = 'pluginaweek'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the has_phone_numbers plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the has_phone_numbers plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HasPhoneNumbers'
+  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         = 'Adds a base skeleton for handling phone numbers.'
+  
+  s.files           = FileList['{app,db,lib,test}/**/*'].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, Neil Abraham'
+  s.email           = 'info@pluginaweek.org'
+  s.homepage        = 'http://www.pluginaweek.org'
+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('pluginaweek@pluginaweek.org', '/home/pluginaweek/gems.pluginaweek.org/gems', 'pkg', "#{PKG_FILE_NAME}.gem").upload
+end
+
+desc 'Publish the API documentation'
+task :pdoc => [:rdoc] do
+  Rake::SshDirPublisher.new('pluginaweek@pluginaweek.org', "/home/pluginaweek/api.pluginaweek.org/#{PKG_NAME}", 'rdoc').upload
+end
+
+desc 'Publish the API docs and gem'
+task :publish => [:pdoc, :release]
+
+desc 'Publish the release files to RubyForge.'
+task :release => [:gem, :package] do
+  require 'rubyforge'
+  
+  ruby_forge = RubyForge.new
+  ruby_forge.login
+  
+  %w( gem tgz zip ).each do |ext|
+    file = "pkg/#{PKG_FILE_NAME}.#{ext}"
+    puts "Releasing #{File.basename(file)}..."
+    
+    ruby_forge.add_release(RUBY_FORGE_PROJECT, PKG_NAME, PKG_VERSION, file)
+  end
+end

data/app/models/phone_number.rb

@@ -0,0 +1,29 @@
+# Represents a phone number
+class PhoneNumber < ActiveRecord::Base
+  belongs_to  :phoneable,
+                :polymorphic => true
+  
+  validates_presence_of     :phoneable_id,
+                            :phoneable_type,
+                            :country_code,
+                            :number
+  
+  with_options(:allow_nil => true) do |klass|
+    klass.validates_numericality_of :country_code,
+                                    :number,
+                                    :extension
+    klass.validates_length_of       :country_code,
+                                      :in => 1..3
+    klass.validates_length_of       :number,
+                                      :is => 10
+    klass.validates_length_of       :extension,
+                                      :maximum => 10
+  end
+  
+  def to_s #:nodoc
+    human_number = "#{country_code}- #{number}"
+    human_number << " ext. #{extension}" if extension
+    
+    human_number
+  end
+end

data/db/migrate/001_create_phone_numbers.rb

@@ -0,0 +1,18 @@
+class CreatePhoneNumbers < ActiveRecord::Migration
+  def self.up
+    create_table :phone_numbers do |t|
+      t.column :phoneable_id, :integer, :null => false, :references => nil
+      t.column :phoneable_type, :string, :null => false
+      # Default is the United States
+      t.column :country_code, :string, :null => false, :limit => 3, :default => 1
+      t.column :number, :string, :null => false, :limit => 12
+      t.column :extension, :string, :limit => 10
+      t.column :created_at, :timestamp, :null => false            
+      t.column :updated_at, :datetime, :null => false
+    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,69 @@
+module PluginAWeek #:nodoc:
+  module Has #:nodoc:
+    # Adds base models, with minimal attribute definitions, for interacting with
+    # phone numbers.
+    module PhoneNumbers
+      def self.included(base) #:nodoc:
+        base.extend(MacroMethods)
+      end
+      
+      module MacroMethods
+        # Creates a new association for having a single phone number.  This
+        # takes the same parameters as ActiveRecord::Associations::ClassMethods#has_one.
+        # By default, the following associations are the same:
+        # 
+        #   class Person < ActiveRecord::Base
+        #     has_phone_number
+        #   end
+        # 
+        # and
+        # 
+        #   class Person < ActiveRecord::Base
+        #     has_one :phone_number,
+        #               :class_name => 'PhoneNumber',
+        #               :as => :phoneable,
+        #               :dependent => :destroy
+        #   end
+        def has_phone_number(*args, &extension)
+          create_phone_number_association(:one, :phone_number, *args, &extension)
+        end
+        
+        # Creates a new association for having a multiple phone numbers.  This
+        # takes the same parameters as ActiveRecord::Associations::ClassMethods#has_many.
+        # By default, the following associations are the same:
+        # 
+        #   class Person < ActiveRecord::Base
+        #     has_phone_numbers
+        #   end
+        # 
+        # and
+        # 
+        #   class Person < ActiveRecord::Base
+        #     has_many  :phone_numbers,
+        #                 :class_name => 'PhoneNumber',
+        #                 :as => :phoneable,
+        #                 :dependent => :destroy
+        #   end
+        def has_phone_numbers(*args, &extension)
+          create_phone_number_association(:many, :phone_numbers, *args, &extension)
+        end
+        
+        private
+        def create_phone_number_association(cardinality, association_id, *args, &extension)
+          options = extract_options_from_args!(args)
+          options.symbolize_keys!.reverse_merge!(
+            :class_name => 'PhoneNumber',
+            :as => :phoneable,
+            :dependent => :destroy
+          )
+          
+          send("has_#{cardinality}", args.first || association_id, options, &extension)
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  include PluginAWeek::Has::PhoneNumbers
+end

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

@@ -0,0 +1,7 @@
+class Person < ActiveRecord::Base
+  has_phone_number  :cell_phone,
+                      :conditions => ['phone_numbers.kind = ?', 'cell']
+  has_phone_number  :work_phone,
+                      :conditions => ['phone_numbers.kind = ?', 'work']
+  has_phone_numbers :phone_numbers
+end

data/test/app_root/config/environment.rb

@@ -0,0 +1,30 @@
+require 'config/boot'
+
+$:.unshift("#{RAILS_ROOT}/../../../../../rails/plugin_dependencies/lib")
+begin
+  require 'plugin_dependencies'
+rescue
+end
+
+Rails::Initializer.run do |config|
+  config.log_level = :debug
+  config.cache_classes = false
+  config.whiny_nils = true
+  config.breakpoint_server = true
+  config.load_paths << "#{RAILS_ROOT}/../../lib"
+  
+  config.plugin_paths.concat([
+    "#{RAILS_ROOT}/../../..",
+    "#{RAILS_ROOT}/../../../../migrations",
+    "#{RAILS_ROOT}/../../../../../rails",
+    "#{RAILS_ROOT}/../../../../../test"
+  ])
+  config.plugins = [
+    File.basename(File.expand_path("#{RAILS_ROOT}/../..")),
+    'appable_plugins',
+    'plugin_migrations',
+    'dry_validity_assertions'
+  ]
+end
+
+Dependencies.log_activity = true

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.column :name, :string
+    end
+  end
+  
+  def self.down
+    drop_table :people
+  end
+end

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

@@ -0,0 +1,9 @@
+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

data/test/app_root/test/fixtures/people.yml

@@ -0,0 +1,3 @@
+john_doe:
+  id: 1
+  name: John Doe

data/test/app_root/test/fixtures/phone_numbers.yml

@@ -0,0 +1,20 @@
+cell:
+  id: 1
+  phoneable_id: 1
+  phoneable_type: Person
+  country_code: 1
+  number: 1234567890
+  created_at: <%= Time.now.to_s(:db) %>
+  updated_at: <%= Time.now.to_s(:db) %>
+  kind: cell
+  
+work:
+  id: 2
+  phoneable_id: 1
+  phoneable_type: Person
+  country_code: 1
+  number: 1234567891
+  extension: 123
+  created_at: <%= Time.now.to_s(:db) %>
+  updated_at: <%= Time.now.to_s(:db) %>
+  kind: work

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+# Load the plugin testing framework
+$:.unshift("#{File.dirname(__FILE__)}/../../../../test/plugin_test_helper/lib")
+require 'rubygems'
+require 'plugin_test_helper'
+
+PluginAWeek::PluginMigrations.migrate('has_phone_numbers')
+
+# Run the migrations
+ActiveRecord::Migrator.migrate("#{RAILS_ROOT}/db/migrate")

data/test/unit/has_phone_numbers_test.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class HasPhoneNumbersTest < Test::Unit::TestCase
+  fixtures :phone_numbers, :people
+  
+  def test_should_create_one_association
+    assert_equal phone_numbers(:cell), people(:john_doe).cell_phone
+    assert_equal phone_numbers(:work), people(:john_doe).work_phone
+  end
+  
+  def test_should_create_many_association
+    assert_equal 2, people(:john_doe).phone_numbers.size
+    assert_equal [], [phone_numbers(:cell), phone_numbers(:work)] - people(:john_doe).phone_numbers
+  end
+end

data/test/unit/phone_number_test.rb

@@ -0,0 +1,63 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class PhoneNumberTest < Test::Unit::TestCase
+  fixtures :phone_numbers
+  
+  def test_should_be_valid
+    assert_valid phone_numbers(:cell)
+  end
+  
+  def test_should_require_phoneable_id
+    assert_invalid phone_numbers(:cell), 'phoneable_id', nil
+  end
+  
+  def test_should_require_phoneable_type
+    assert_invalid phone_numbers(:cell), 'phoneable_type', nil
+  end
+  
+  def test_should_require_country_code
+    assert_invalid phone_numbers(:cell), 'country_code', nil
+  end
+  
+  def test_should_require_number
+    assert_invalid phone_numbers(:cell), 'number', nil
+  end
+  
+  def test_should_require_country_code_be_a_number
+    assert_invalid phone_numbers(:cell), 'country_code', 'invalid', '123invalid'
+  end
+  
+  def test_should_require_number_be_a_number
+    assert_invalid phone_numbers(:cell), 'number', 'invalid', '123invalid'
+  end
+  
+  def test_should_require_extension_be_a_number
+    assert_invalid phone_numbers(:cell), 'extension', 'invalid', '123invalid'
+  end
+  
+  def test_should_restrict_country_code_length
+    assert_invalid phone_numbers(:cell), 'extension', 'invalid', '123invalid'
+  end
+  
+  def test_should_restrict_number_length
+    assert_invalid phone_numbers(:cell), 'number', '123', '12345678901'
+    assert_valid phone_numbers(:cell), 'number', '1234567890'
+  end
+  
+  def test_should_restrict_extension_length
+    assert_invalid phone_numbers(:cell), 'extension', '12345678901'
+    assert_valid phone_numbers(:cell), 'extension', '1', '123', '1234567890'
+  end
+  
+  def test_should_allow_phoneable_to_be_of_any_type
+    assert_valid phone_numbers(:cell), 'phoneable_type', 'House', 'Person'
+  end
+  
+  def test_should_generate_stringified_version_of_phone_number
+    assert_equal '1- 1234567890', phone_numbers(:cell).to_s
+  end
+  
+  def test_should_generate_stringified_version_of_phone_number_with_extension
+    assert_equal '1- 1234567891 ext. 123', phone_numbers(:work).to_s
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: has_phone_numbers
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2007-08-21 00:00:00 -04:00
+summary: Adds a base skeleton for handling phone numbers.
+require_paths: 
+- lib
+email: info@pluginaweek.org
+homepage: http://www.pluginaweek.org
+rubyforge_project: 
+description: 
+autorequire: has_phone_numbers
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Aaron Pfeifer, Neil Abraham
+files: 
+- app/models
+- app/models/phone_number.rb
+- db/migrate
+- db/migrate/001_create_phone_numbers.rb
+- lib/has_phone_numbers.rb
+- test/test_helper.rb
+- test/app_root
+- test/unit
+- test/app_root/test
+- test/app_root/config
+- test/app_root/app
+- test/app_root/db
+- test/app_root/test/fixtures
+- test/app_root/test/fixtures/phone_numbers.yml
+- test/app_root/test/fixtures/people.yml
+- test/app_root/config/environment.rb
+- test/app_root/app/models
+- test/app_root/app/models/person.rb
+- test/app_root/db/migrate
+- test/app_root/db/migrate/001_create_people.rb
+- test/app_root/db/migrate/002_add_phone_number_kinds.rb
+- test/unit/phone_number_test.rb
+- test/unit/has_phone_numbers_test.rb
+- CHANGELOG
+- init.rb
+- MIT-LICENSE
+- Rakefile
+- README
+test_files: 
+- test/unit/phone_number_test.rb
+- test/unit/has_phone_numbers_test.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+