has_phone_number 1.1.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dallas Reedy
+
+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,42 @@
+== HasPhoneNumber
+
+A fairly simple plugin for dealing with the commonalities of phone number (and fax number) attributes.
+I wanted an easy way to set them (as digit-only strings no matter what other junk got passed in) and to display them as desired using a custom getter (with +number_to_phone+ baked right in).
+
+
+== Example
+
+Setting +has_phone_number+ will give you all the default options and assumes an attribute named <tt>:phone_number</tt>.
+Setting +has_fax_number+ just makes a call to +has_phone_number+ but assumes an attribute named <tt>:fax_number</tt>.
+
+  has_phone_number
+  has_fax_number
+
+You can tell +has_phone_number+ what attribute you want it set on, or pass it as many attributes as you want!
+
+  has_phone_number :home_phone, :cell_phone, :other_phone
+  
+You can also pass some simple options in:
+
+  has_phone_number :validate => false # skip validation!
+  has_phone_number :validate_on => :update, :validate_if => proc{|record| record.something?}
+  has_phone_number :validation_message => "that doesn't even <em>look</em> like a phone number!"
+
+Or, you can use the +validates_as_phone_number+ method to validate specific numbers when and where you want!
+
+  validates_as_phone_number :cell_phone, :if => proc{|record| record.home_phone.blank?}
+
+I even went as far as allowing +method_missing+ to respond to validation methods corresponding to defined phone number attributes:
+
+  validates_other_phone :on => :update, :if => proc{|record| ![record.home_phone, record.cell_phone].any?}
+
+
+== To Do
+
+* Add support for phone extensions
+* Add support for custom validations (like specifying the regular expression to check against)
+* Add support for customizing the output of the getter (setting +number_to_phone+ options)
+
+
+---
+Copyright (c) 2009 Dallas Reedy, released under the MIT license

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the has_phone_number plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the has_phone_number plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HasPhoneNumber'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "has_phone_number"
+    gemspec.summary = (summary = "HasPhoneNumber is a Ruby on Rails gem for setting up phone number attributes.")
+    gemspec.email = "code@dallasreedy.com"
+    gemspec.homepage = "http://github.com/dallas/has_phone_number"
+    gemspec.description = summary
+    gemspec.authors = ["Dallas Reedy"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.1

data/has_phone_number.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{has_phone_number}
+  s.version = "1.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dallas Reedy"]
+  s.date = %q{2009-08-25}
+  s.description = %q{HasPhoneNumber is a Ruby on Rails gem for setting up phone number attributes.}
+  s.email = %q{code@dallasreedy.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "has_phone_number.gemspec",
+     "init.rb",
+     "lib/has_phone_number.rb",
+     "test/attributes_test.rb",
+     "test/schema.rb",
+     "test/test.db",
+     "test/test_helper.rb",
+     "test/validations_test.rb"
+  ]
+  s.homepage = %q{http://github.com/dallas/has_phone_number}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{HasPhoneNumber is a Ruby on Rails gem for setting up phone number attributes.}
+  s.test_files = [
+    "test/attributes_test.rb",
+     "test/schema.rb",
+     "test/test_helper.rb",
+     "test/validations_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

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

data/lib/has_phone_number.rb

@@ -0,0 +1,104 @@
+module Dallas #:nodoc: all
+  module HasPhoneNumber
+    include ActionView::Helpers::NumberHelper
+  
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods      
+      attr_accessor :phone_number_attributes
+      
+      # the main method
+      def has_phone_number(*args)
+        @phone_number_attributes = [] unless @phone_number_attributes.is_a? Array
+        
+        options     = args.extract_options!
+        attributes  = args
+        attributes << :phone_number if attributes.empty?
+        
+        unless options[:validate] === false
+          validates_as_phone_number attributes, options
+        end
+        
+        attributes.each do |attribute|
+          # setter method to filter non-digit characters
+          define_method "#{attribute}=" do |value|
+            write_attribute(attribute, value.to_s.gsub(/\D+/, ''))
+          end
+      
+          # getter method which automatically applies number_to_phone helper
+          define_method "#{attribute}" do |*from_database|
+            return nil if self[attribute].nil?
+            !! from_database.first ? self[attribute] : number_to_phone(self[attribute], :area_code => true)
+          end
+      
+          # override the default #{attribute}_before_type_cast so that it is
+          # formatted using number_to_phone in form fields also
+          define_method "#{attribute}_before_type_cast" do |*from_database|
+            __send__(attribute, !! from_database.first)
+          end
+          
+          @phone_number_attributes << attribute
+        end
+      
+        include Dallas::HasPhoneNumber::InstanceMethods
+      end
+      
+      # define convenience method for setting the common attribute "fax_number"
+      def has_fax_number(*args)
+        options     = args.extract_options!  
+        args << :fax_number if args.empty?
+        has_phone_number(*args << options)
+      end
+    
+      def phone_number_attributes
+        Array(@phone_number_attributes)
+      end
+      
+      # simple length and format validation
+      # using validates_each to bypass ActiveRecord's odd propensity to use record.attribute
+      # rather than record.read_attribute(attribute) or record[attribute]
+      def validates_as_phone_number(*args)
+        options     = clean_has_phone_number_options(args.extract_options!)
+        message     = options.delete(:message)
+        attributes  = args
+      
+        validates_each attributes, options do |record, attr_name, value|
+          record.errors.add attr_name, message || 'should be a 10-digit phone number' unless record[attr_name] =~ /^\d{10}$/
+        end
+      end
+      
+      # alias the method_missing method chain for customized validation methods
+      alias_method :method_missing_without_phone_number_validations, :method_missing
+      
+      def method_missing_with_phone_number_validations(name, *args, &block)
+        return validates_as_phone_number($1, *args) if name.to_s =~ /^validates_(#{phone_number_attributes.join('|')})$/
+        method_missing_without_phone_number_validations(name, *args, &block)
+      end
+      
+      alias_method :method_missing, :method_missing_with_phone_number_validations
+      
+      private
+      
+      # look out for keys set in the original has_(phone|fax)_number like the following:
+      #   :validate_on => :update
+      #   :validates_if => proc{…}
+      #   :validation_message
+      def clean_has_phone_number_options(options = {})
+        options.inject({}) do |opts, (key, value)|
+          opts[key.to_s.sub(/^validat(es?|ion)_/, '').to_sym] = value
+          opts
+        end
+      end
+    end # ClassMethods
+  
+    module InstanceMethods
+      def phone_numbers
+        self.class.phone_number_attributes.map {|a| [a, read_attribute(a)]}
+      end
+    end # InstanceMethods
+  end # HasPhoneNumber
+end # Dallas
+
+ActiveRecord::Base.send(:include, Dallas::HasPhoneNumber)

data/test/attributes_test.rb

@@ -0,0 +1,71 @@
+require 'test_helper'
+
+class AttributesTest < Test::Unit::TestCase
+  context 'Setting has_phone_number or has_fax_number' do
+    setup do
+      @attribute_names = %w(phone_number fax_number telephone facsimile phone_not_validated fax_not_validated phone_with_validation_options phone_validated_elsewhere fax_validated_elsewhere)
+      @user = User.new(:name => 'Dallas Reedy')
+      
+      # generates a phone number in the form: nnn-nnn-nnnn
+      def generate_phone_number
+        "#{(x = ('000'..'999').to_a)[rand(x.length - 1)]}-#{x[rand(x.length - 1)]}-#{(y = ('0000'..'9999').to_a)[rand(y.length - 1)]}"
+      end
+    end
+
+    should 'add attributes names to the phone_number_attributes array' do
+      assert_same_elements @user.class.phone_number_attributes.map {|a| a.to_s}, @attribute_names
+    end
+
+    should 'automatically use :phone_number or :fax_number if no attribute names are given' do
+      %w(phone_number fax_number).each do |name|
+        assert_contains   @user.class.phone_number_attributes, name.to_sym
+        assert_respond_to @user, "#{name}="
+        assert_respond_to @user, name
+        assert_nothing_raised do
+          @user.send(name, true)
+        end
+      end
+    end
+    
+    should 'create a setter method' do
+      @attribute_names.each do |name|
+        assert_respond_to @user, "#{name}="
+      end
+    end
+    
+    should 'create a getter method' do
+      @attribute_names.each do |name|
+        assert_respond_to @user, name
+      end
+    end
+          
+    should 'properly set a phone number using setter method' do
+      @attribute_names.each do |name|
+        assert_send [@user, "#{name}=", number = generate_phone_number]
+        assert_equal number.gsub(/\D+/, ''), @user.send("#{name}", true)
+      end
+    end
+    
+    should 'properly return a phone number using getter method' do
+      # need to run the setters again…
+      @attribute_names.each do |name|
+        assert_send [@user, "#{name}=", generate_phone_number]
+      end
+      
+      @attribute_names.each do |name|
+        assert_match /^\(\d{3}\) \d{3}\-\d{4}$/, @user.send(name)
+      end
+    end
+    
+    should 'return the "database stored" value if argument is passed to getter' do
+      # need to run the setters again…
+      @attribute_names.each do |name|
+        assert_send [@user, "#{name}=", generate_phone_number]
+      end
+      
+      @attribute_names.each do |name|
+        assert_match /^\d{10}$/, @user.send(name, true)
+      end
+    end
+  end
+end

data/test/schema.rb

@@ -0,0 +1,53 @@
+ActiveRecord::Base.establish_connection(
+  :adapter => defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby' ? 'jdbcsqlite3' : 'sqlite3',
+  :database => File.join(File.dirname(__FILE__), 'test.db')
+)
+
+class CreateSchema < ActiveRecord::Migration
+  def self.up
+    create_table :users, :force => true do |t|
+      t.string :name
+      t.string :phone_number, :fax_number
+      t.string :telephone, :facsimile
+      t.string :phone_not_validated, :fax_not_validated
+      t.string :phone_with_validation_options
+      t.string :phone_validated_elsewhere, :fax_validated_elsewhere
+      t.timestamps
+    end
+  end
+end
+
+CreateSchema.suppress_messages do
+  CreateSchema.migrate(:up)
+end
+
+# Define our User model
+class User < ActiveRecord::Base
+  # defaults
+  has_phone_number
+  has_fax_number
+  
+  # custom column names
+  has_phone_number  :telephone
+  has_fax_number    :facsimile
+  
+  # validation turned off
+  has_phone_number  :phone_not_validated, :validate => false
+  has_fax_number    :fax_not_validated,   :validate => false
+  
+  # more validation options
+  has_phone_number  :phone_with_validation_options,
+                      :validate_if        => proc{|user| !user.name.nil?},
+                      :validates_on       => :update,
+                      :validation_message => 'is so not a valid phone number!'
+  
+  # handle validation elsewhere
+  has_phone_number  :phone_validated_elsewhere,  :validate => false
+  has_fax_number    :fax_validated_elsewhere,    :validate => false
+  
+  # default validation method
+  validates_as_phone_number  :phone_validated_elsewhere, :message => "didn't pass validations elsewhere"
+  
+  # auto-defined validation method
+  validates_fax_validated_elsewhere :on => :update, :message => "didn't pass validations from auto-defined validation method"
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+$: << File.dirname(__FILE__)
+
+require 'rubygems'
+require 'test/unit'
+require 'activerecord'
+require 'shoulda'
+require 'action_view'
+require 'has_phone_number'
+require 'schema'
+begin; require 'redgreen'; rescue LoadError; end

data/test/validations_test.rb

@@ -0,0 +1,108 @@
+require 'test_helper'
+
+class ValidationsTest < Test::Unit::TestCase
+  context 'Setting has_phone_number or has_fax_number' do
+    setup do
+      @attribute_names      = %w(phone_number fax_number telephone facsimile phone_not_validated fax_not_validated phone_with_validation_options phone_validated_elsewhere fax_validated_elsewhere)
+      @not_validated        = %w(phone_not_validated fax_not_validated)
+      @validated_on_update  = %w(phone_with_validation_options fax_validated_elsewhere)
+      @auto_validated       = @attribute_names - @not_validated - @validated_on_update
+      
+      @user = User.new(:name => 'Dallas Reedy')
+  
+      # generates a phone number in the form: nnn-nnn-nnnn
+      def generate_phone_number
+        "#{(x = ('000'..'999').to_a)[rand(x.length - 1)]}-#{x[rand(x.length - 1)]}-#{(y = ('0000'..'9999').to_a)[rand(y.length - 1)]}"
+      end
+      
+      def set_fields(fields)
+        fields.each do |name|
+          @user.send("#{name}=", generate_phone_number)
+        end
+      end
+    end
+
+    should 'automatically add a validation unless told not to' do
+      @auto_validated.each do |name|
+        assert_equal  false, @user.valid?
+        assert        @user.errors.invalid?(name.to_s)
+        
+        @user.send("#{name}=", 'gibberish.')
+        assert_equal  false, @user.valid?
+        assert        @user.errors.invalid?(name.to_s)
+        
+        @user.send("#{name}=", generate_phone_number)
+      end
+      assert @user.save
+    end
+
+    should 'not validate if told not to' do
+      set_fields @auto_validated
+      
+      @not_validated.each do |name|
+        assert  @user.valid?
+        assert  @user.errors.empty?
+        
+        @user.send("#{name}=", 'gibberish.')
+        @user.valid?
+        assert  @user.errors.empty?
+      end
+      assert @user.save
+    end
+
+    should 'apply and adhere to validation-specific options set for the default validation' do
+      set_fields @auto_validated + ['fax_validated_elsewhere']
+      
+      # test that validation fails on :update
+      assert @user.save
+      assert_equal false, @user.valid?
+      assert @user.errors.invalid?(:phone_with_validation_options)
+      
+      # test invalid data
+      @user.phone_with_validation_options = 'gibberish.'
+      assert_equal false, @user.valid?
+      assert @user.errors.invalid?(:phone_with_validation_options)
+      
+      # test our custom error message
+      assert_equal 'is so not a valid phone number!', @user.errors.on(:phone_with_validation_options)
+      
+      # test our custom error :if option
+      @user.name = nil
+      assert @user.valid?
+      
+      # test saving valid record
+      @user.name = 'Dallas Reedy'
+      @user.phone_with_validation_options = generate_phone_number
+      assert @user.save
+    end
+
+    should 'respond to validates_as_phone_number and adhere to specified options' do
+      set_fields @auto_validated - ['phone_validated_elsewhere']
+      
+      # test our custom error message
+      assert_equal false, @user.valid?
+      assert @user.errors.invalid?(:phone_validated_elsewhere)
+      assert_equal "didn't pass validations elsewhere", @user.errors.on(:phone_validated_elsewhere)
+      
+      # test saving valid record
+      @user.phone_validated_elsewhere = generate_phone_number
+      assert @user.save
+    end
+
+    should 'respond to validates_#{attribute_name} and adhere to specified options' do
+      set_fields @auto_validated + ['phone_with_validation_options']
+      
+      # test that validation fails on :update
+      assert @user.save
+      assert_equal false, @user.valid?
+      assert @user.errors.invalid?(:fax_validated_elsewhere)
+      
+      # test for our custom error message
+      assert_equal "didn't pass validations from auto-defined validation method", @user.errors.on(:fax_validated_elsewhere)
+      
+      # test saving valid record
+      @user.fax_validated_elsewhere = generate_phone_number
+      assert @user.save
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: has_phone_number
+version: !ruby/object:Gem::Version 
+  version: 1.1.1
+platform: ruby
+authors: 
+- Dallas Reedy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-25 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: HasPhoneNumber is a Ruby on Rails gem for setting up phone number attributes.
+email: code@dallasreedy.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- has_phone_number.gemspec
+- init.rb
+- lib/has_phone_number.rb
+- test/attributes_test.rb
+- test/schema.rb
+- test/test.db
+- test/test_helper.rb
+- test/validations_test.rb
+has_rdoc: true
+homepage: http://github.com/dallas/has_phone_number
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: HasPhoneNumber is a Ruby on Rails gem for setting up phone number attributes.
+test_files: 
+- test/attributes_test.rb
+- test/schema.rb
+- test/test_helper.rb
+- test/validations_test.rb