has_phone_numbers 0.2.0 → 0.2.1

data/CHANGELOG.rdoc

@@ -1,5 +1,10 @@
 == master
 
+== 0.2.1 / 2010-03-07
+
+* Add a generator for db migration
+* Release gems via rake-gemcutter instead of rubyforge
+
 == 0.2.0 / 2009-04-19
 
 * Add the ability to parse raw values [Matt Lightner]

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2009 Aaron Pfeifer
+Copyright (c) 2006-2010 Aaron Pfeifer
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -23,23 +23,46 @@ Source
 == 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.
+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, should be
+Note that this is a reference implementation and, most likely, will be
 modified for your own usage.
 
+=== Installation
+
++has_phone_numbers+ requires an additional database table to work.  You can
+generate a migration for this tables like so:
+
+  script/generate has_phone_numbers
+
+Then simply migrate your database:
+
+  rake db:migrate
+
 === Example
 
-  phone_number = Phone_number.new(
-    :country_code => '1',
-    :number => '1234567890',
-    :extension => '123'
-  )
-  phone_number.display_value # => 1- 1234567890 ext. 123
+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
 

data/Rakefile

@@ -1,15 +1,17 @@
+require 'rubygems'
+require 'rake'
 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.version           = '0.2.1'
   s.platform          = Gem::Platform::RUBY
-  s.summary           = 'Demonstrates a reference implementation for handling phone numbers.'
+  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.files             = FileList['{app,generators,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']
@@ -52,20 +54,27 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   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
+  require 'rake/contrib/sshpublisher'
   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
+  require 'rake/contrib/sshpublisher'
   Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{spec.name}", 'rdoc').upload
 end
 
@@ -74,15 +83,8 @@ 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
+  require 'rake/gemcutter'
   
-  %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
+  Rake::Gemcutter::Tasks.new(spec)
+  Rake::Task['gem:push'].invoke
 end

data/app/models/phone_number.rb

@@ -81,12 +81,12 @@ class PhoneNumber < ActiveRecord::Base
   
   # The raw, unparsed content containing the phone number.  This can be parsed
   # in various formats, such as:
-  # * 600 600 11 22
+  # * 599 600 11 22
   # * + 386 1 5853 449
-  # * +48 (22) 64 0001
+  # * +48 (22) 641 0001
   # * 36 1 267-4636
-  # * +39-02-48230001
-  # * 202 331 996 x4621
+  # * +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

data/generators/has_phone_numbers/USAGE

@@ -0,0 +1,5 @@
+Usage:
+
+  script/generate has_phone_numbers
+
+This will create migrations that will add the proper tables to store phone numbers.

data/generators/has_phone_numbers/has_phone_numbers_generator.rb

@@ -0,0 +1,7 @@
+class HasPhoneNumbersGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.migration_template '001_create_phone_numbers.rb', 'db/migrate', :migration_file_name => 'create_phone_numbers'
+    end
+  end
+end

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

@@ -1,12 +1,12 @@
 class MigrateHasPhoneNumbersToVersion1 < ActiveRecord::Migration
   def self.up
-    ActiveRecord::Migrator.new(:up, "#{Rails.root}/../../db/migrate", 0).migrations.each do |migration|
+    ActiveRecord::Migrator.new(:up, "#{Rails.root}/../../generators/has_phone_numbers/templates", 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|
+    ActiveRecord::Migrator.new(:down, "#{Rails.root}/../../generators/has_phone_numbers/templates", 0).migrations.each do |migration|
       migration.migrate(:down)
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: has_phone_numbers
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Aaron Pfeifer
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-19 00:00:00 -04:00
+date: 2010-03-07 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
-description: 
+description: Demonstrates a reference implementation for handling phone numbers in ActiveRecord
 email: aaron@pluginaweek.org
 executables: []
 
@@ -22,25 +22,18 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- app/models
 - app/models/phone_number.rb
-- db/migrate
-- db/migrate/001_create_phone_numbers.rb
+- generators/has_phone_numbers/USAGE
+- generators/has_phone_numbers/has_phone_numbers_generator.rb
+- generators/has_phone_numbers/templates/001_create_phone_numbers.rb
 - lib/has_phone_numbers.rb
-- test/factory.rb
-- test/test_helper.rb
-- test/functional
-- test/functional/has_phone_numbers_test.rb
-- test/unit
 - test/unit/phone_number_test.rb
-- test/app_root
-- 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/app_root/app
-- test/app_root/app/models
+- test/app_root/db/migrate/002_migrate_has_phone_numbers_to_version_1.rb
 - test/app_root/app/models/person.rb
+- test/test_helper.rb
+- test/factory.rb
+- test/functional/has_phone_numbers_test.rb
 - CHANGELOG.rdoc
 - init.rb
 - LICENSE
@@ -48,6 +41,8 @@ files:
 - README.rdoc
 has_rdoc: true
 homepage: http://www.pluginaweek.org
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -68,10 +63,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: pluginaweek
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
-summary: Demonstrates a reference implementation for handling phone numbers.
+specification_version: 3
+summary: Demonstrates a reference implementation for handling phone numbers in ActiveRecord
 test_files: 
-- test/functional/has_phone_numbers_test.rb
 - test/unit/phone_number_test.rb
+- test/functional/has_phone_numbers_test.rb