vandrijevik-has_phone_number 1.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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.markdown

@@ -0,0 +1,53 @@
+HasPhoneNumber
+==============
+
+HasPhoneNumber makes phone number validations in ActiveRecord easy. Make sure your model
+has a string attribute to store your phone number, pass it to `has_phone_number`, and
+you're done!
+
+    class Person < ActiveRecord::Base
+      has_phone_number :cell_phone
+    end
+
+This will ensure that the phone number in `cell_phone` is of a valid phone number
+format, and invalidate Person if the phone number is invalid. It will also play
+nice with `form_for`, so you can display the errors to your users.
+
+Using Formats
+-------------
+
+By default, `has_phone_number` will validate against a US phone number format. For this,
+all you need to do is:
+
+    class Person < ActiveRecord::Base
+      has_phone_number :cell_phone
+    end
+
+If, however you want to validate against a different phone number format, you can:
+
+    class Office < ActiveRecord::Base
+      has_phone_number :main, :format => :us
+      has_phone_number :abroad, :format => :france
+    end
+
+This will validate the `main` attribute against a US number format (included),
+and `abroad` against a France number format (if you've specified it).
+
+Specifying Formats
+------------------
+
+Format names and specifications are stored in the HasPhoneNumber::PhoneNumber.formats hash.
+The key is a symbol (that can be used with the :format option to `has_phone_number`),
+and the value is a regex that the attribute is matched against.
+
+In a Rails project, you can specify additional formats a number of ways, but the cleanest is
+to put your number formats in an intializer. For example, `config/initializers/phone_number_formats.rb`:
+
+    my_formats = {:my_number_format => /\d{10}/,
+                  :no_area_code => /\d{3}-\d{4}/}
+    
+    HasPhoneNumber::PhoneNumber.formats.update(my_formats)
+
+Hope you like it!
+
+Copyright (c) 2009 [Vladimir Andrijevik], released under the MIT license

data/Rakefile

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

data/lib/has_phone_number.rb

@@ -0,0 +1,55 @@
+module HasPhoneNumber
+  autoload :PhoneNumber, 'has_phone_number/phone_number'
+
+  module ClassMethods
+    def has_phone_number(*attr_names)
+      setup_number_formats_mapping
+      
+      phone_number_format = attr_names.extract_options![:format]
+      record_number_format(attr_names, phone_number_format)
+      
+      setup_aggregations(attr_names)
+      validates_as_phone_number attr_names.map {|attribute_name| "#{attribute_name}_as_phone_number".to_sym}
+    end
+  
+  private
+    def setup_number_formats_mapping
+      unless respond_to?(:number_formats) && respond_to?(:number_formats=)
+        class_inheritable_hash :number_formats
+        self.number_formats = {}
+        self.number_formats.default = :us
+      end
+    end
+    
+    def record_number_format(attr_names, format)
+      if format.present?
+        attr_names.each { |attribute_name| self.number_formats[attribute_name.to_sym] = format }
+      end
+    end
+    
+    def setup_aggregations(attr_names)
+      attr_names.each do |attribute_name|
+        composed_of "#{attribute_name}_as_phone_number".intern,
+                    :class_name => "HasPhoneNumber::PhoneNumber",
+                    :mapping => [attribute_name, "number"],
+                    :allow_nil => true,
+                    :constructor => Proc.new { |phone_number| HasPhoneNumber::PhoneNumber.new(phone_number, number_formats[attribute_name.to_sym]) }
+      end
+    end
+    
+    def validates_as_phone_number(*attr_names)
+      configuration = { :on => :save }
+      configuration.update(attr_names.extract_options!)
+      
+      validates_each(attr_names, configuration) do |record, attr_name, value|
+        unless value.nil? || value.valid?
+          original_attr_name = attr_name.to_s.gsub(/_as_phone_number$/, "").to_sym
+          record.errors.add(original_attr_name, :invalid, :default => configuration[:message], :value => value)
+        end
+      end
+    end
+  end # ClassMethods
+  
+end # HasPhoneNumber
+
+ActiveRecord::Base.class_eval { extend HasPhoneNumber::ClassMethods } if defined?(ActiveRecord::Base)

data/lib/has_phone_number/phone_number.rb

@@ -0,0 +1,23 @@
+module HasPhoneNumber
+  autoload :Validateable, File.join(File.dirname(__FILE__), "validateable")
+
+  class PhoneNumber
+    include Validateable
+
+    class_inheritable_hash :formats
+    self.formats = {:us => /^(\(\d{3}\) |\d{3}[- ])\d{3}[- ]?\d{4}$/}
+    
+    attr_reader :number, :number_format
+    validates_each(:number) do |record, attr_name, value|
+      unless record.formats[record.number_format].match(value)
+        record.errors.add(attr_name, :invalid, :value => value)
+      end
+    end
+    
+    def initialize(number, number_format)
+      @number = number
+      @number_format = number_format
+      @errors = ActiveRecord::Errors.new(self)
+    end
+  end
+end

data/lib/has_phone_number/validateable.rb

@@ -0,0 +1,31 @@
+require 'active_record'
+require 'active_record/base'
+
+module Validateable
+  def self.included(base)
+    base.class_eval do
+      extend ClassMethods
+      include InstanceMethods
+      include ActiveRecord::Validations
+    end
+  end
+  
+  module ClassMethods
+    def self_and_descendants_from_active_record; [self]; end
+    def human_name; name.humanize; end
+    
+    def human_attribute_name(attribute)
+      attribute.to_s.titleize
+    end
+  end # ClassMethods
+  
+  module InstanceMethods
+    [:save, :save!, :update_attribute, :new_record?].each do |method_name|
+      define_method(method_name) {}
+    end
+    
+    def method_missing(symbol, *params)
+      symbol.to_s =~ /(.*)_before_type_cast$/ ? send($1) : super
+    end
+  end # InstanceMethods
+end # Validateable

data/test/config/boot.rb

@@ -0,0 +1,110 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.3.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/test/config/database.yml

@@ -0,0 +1,5 @@
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000

data/test/config/environment.rb

@@ -0,0 +1,14 @@
+ENV['RAILS_ENV'] ||= 'test'
+ 
+# Specifies gem version of Rails to use when vendor/rails is not present
+RAILS_GEM_VERSION = '2.3.2' unless defined? RAILS_GEM_VERSION
+ 
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+ 
+Rails::Initializer.run do |config|
+  config.frameworks -= [ :active_resource, :action_mailer, :action_controller, :action_view ]
+ 
+  config.gem 'sqlite3-ruby', :lib => 'sqlite3'
+  config.gem 'thoughtbot-shoulda', :lib => 'shoulda/rails', :source => 'http://gems.github.com'
+end

data/test/config/environments/test.rb

@@ -0,0 +1,28 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+config.action_view.cache_template_loading            = true
+
+# Disable request forgery protection in test environment
+config.action_controller.allow_forgery_protection    = false
+
+# Tell Action Mailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test
+
+# Use SQL instead of Active Record's schema dumper when creating the test database.
+# This is necessary if your schema can't be completely dumped by the schema dumper,
+# like if you have constraints or database-specific column types
+# config.active_record.schema_format = :sql

data/test/config/routes.rb

@@ -0,0 +1,43 @@
+ActionController::Routing::Routes.draw do |map|
+  # The priority is based upon order of creation: first created -> highest priority.
+
+  # Sample of regular route:
+  #   map.connect 'products/:id', :controller => 'catalog', :action => 'view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   map.purchase 'products/:id/purchase', :controller => 'catalog', :action => 'purchase'
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   map.resources :products
+
+  # Sample resource route with options:
+  #   map.resources :products, :member => { :short => :get, :toggle => :post }, :collection => { :sold => :get }
+
+  # Sample resource route with sub-resources:
+  #   map.resources :products, :has_many => [ :comments, :sales ], :has_one => :seller
+  
+  # Sample resource route with more complex sub-resources
+  #   map.resources :products do |products|
+  #     products.resources :comments
+  #     products.resources :sales, :collection => { :recent => :get }
+  #   end
+
+  # Sample resource route within a namespace:
+  #   map.namespace :admin do |admin|
+  #     # Directs /admin/products/* to Admin::ProductsController (app/controllers/admin/products_controller.rb)
+  #     admin.resources :products
+  #   end
+
+  # You can have the root of your site routed with map.root -- just remember to delete public/index.html.
+  # map.root :controller => "welcome"
+
+  # See how all your routes lay out with "rake routes"
+
+  # Install the default routes as the lowest priority.
+  # Note: These default routes make all actions in every controller accessible via GET requests. You should
+  # consider removing the them or commenting them out if you're using named routes and resources.
+  map.connect ':controller/:action/:id'
+  map.connect ':controller/:action/:id.:format'
+end

data/test/has_phone_number_test.rb

@@ -0,0 +1,92 @@
+require 'test_helper'
+
+class Office < ActiveRecord::Base
+  has_phone_number :main
+  has_phone_number :abroad, :format => :uk
+  has_phone_number :chicago, :boston
+  has_phone_number :paris, :lyon, :format => :france
+end
+
+class HasPhoneNumberTest < ActiveSupport::TestCase
+  context "An object with phone numbers" do
+    setup { @office = Office.new }
+    
+    should "respond to main_as_phone_number" do
+      assert_respond_to @office, :main_as_phone_number
+    end # respond to main_as_phone_number
+    
+    should "have a number_formats registry" do
+      assert_respond_to Office, :number_formats
+    end # have a number_formats registry
+    
+    should "allow specifying a format for the phone number" do
+      assert_equal :uk, Office.number_formats[:abroad]
+    end # allow specifying a format for the phone number
+    
+    should "default the phone number format to :us" do
+      assert_equal :us, Office.number_formats[:main]
+    end # default the phone number format to :us
+    
+    should "allow specifying more than one phone number attribute in a single call" do
+      assert_respond_to @office, :chicago_as_phone_number
+      assert_respond_to @office, :boston_as_phone_number
+    end # allow specifying more than one phone number attribute in a single call
+    
+    should "register the correct format for all phone numbers specified in a single call" do
+      assert_equal :france, Office.number_formats[:paris]
+      assert_equal :france, Office.number_formats[:lyon]
+    end # apply the correct format to all phone numbers specified in a single call
+    
+    should "validate all phone numbers specified in a single call" do
+      @office.lyon = "123"
+      @office.lyon_as_phone_number.expects(:valid?)
+      
+      @office.valid?
+    end # validate all phone numbers specified in a single call
+    
+    context "whose value object is invalid" do
+      setup do
+        @office.main_as_phone_number = stub(:number => "123", :valid? => false)
+      end
+      
+      should("not be valid") { deny @office.valid? }
+      
+      should "add an error to the attribute" do
+        @office.valid?
+        
+        assert_nil @office.errors.on(:main_as_phone_number)
+        assert_not_nil @office.errors.on(:main)
+      end # add an error to the attribute
+    end
+    
+    context "with a nil phone number attribute" do
+      should("have a nil corresponding value object") { assert_nil @office.main_as_phone_number }
+    end # with a nil phone number attribute
+    
+    context "with a set phone attribute" do
+      setup { @office.main = "1" }
+      
+      should "have a set value object" do
+        assert_kind_of HasPhoneNumber::PhoneNumber, @office.main_as_phone_number
+      end
+      
+      should "set the number of the value object to the value of the phone attribute" do
+        assert_equal @office.main, @office.main_as_phone_number.number
+      end # set the number of the value object to the value of the phone attribute
+      
+      should "set the value object to the appropriate number format" do
+        assert_equal :us, @office.main_as_phone_number.number_format
+      end # set the value object to the appropriate number format
+    end # with a set phone attribute
+    
+    context "with a set value object" do
+      setup do
+        @office.main_as_phone_number = stub(:number => "123")
+      end
+      
+      should "have an attribute value that matches the number of the value object" do
+        assert_equal @office.main_as_phone_number.number, @office.main
+      end # have an attribute value that matches the number of the value object
+    end # with a set value object
+  end # An object with phone numbers
+end

data/test/phone_number_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+require 'has_phone_number/phone_number'
+
+class PhoneNumberTest < ActiveSupport::TestCase
+  context "A Phone Number" do
+    setup do
+      @phone_number = HasPhoneNumber::PhoneNumber.new("123", :test)
+    end
+    
+    context "whose number matches its format" do
+      setup do
+        HasPhoneNumber::PhoneNumber.formats[:test].expects(:match).returns(stub("match_stub"))
+      end
+      
+      should("be valid") { assert @phone_number.valid? }
+    end # whose number matches its format
+    
+    context "whose number does not match its format" do
+      setup do
+        HasPhoneNumber::PhoneNumber.formats[:test].expects(:match).returns(nil)
+      end
+
+      should("not be valid") { deny @phone_number.valid? }
+    end # whose number does not match its format
+  end # A Phone Number
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+require 'active_record'
+require 'test/unit'
+require 'shoulda'
+
+require 'config/environment'
+require 'db/schema'
+require File.join(File.dirname(__FILE__), "..", "init.rb")
+
+class ActiveSupport::TestCase
+  def deny(expression)
+    assert !expression
+  end
+end

data/test/us_test.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+require 'has_phone_number/phone_number'
+
+class UsTest < ActiveSupport::TestCase
+  context "An US Phone Number" do
+    setup do
+      @format = HasPhoneNumber::PhoneNumber.formats[:us]
+    end
+    
+    context "with less than 10 digits" do
+      setup { @phone_number = "(312) 456-789" }
+      should("not match") { deny @format.match @phone_number }
+    end # with less than 10 digits
+    
+    context "with more than 10 digits" do
+      setup { @phone_number = "312-456-78901" }
+      should("not match") { deny @format.match @phone_number }
+    end # with more than 10 digits
+    
+    context "with 10 digits" do
+      context "and characters other than (), - and space" do
+        setup { @phone_number = "a312b456c7890" }
+        
+        should("not match") { deny @format.match @phone_number }
+      end # and characters other than (), - and space
+      
+      context "that are grouped and separated by hyphens" do
+        setup { @phone_number = "312-456-7890" }
+        
+        should("match") { assert @format.match @phone_number }
+      end # that are grouped and separated by hyphens
+      
+      context "that are grouped and separated by spaces" do
+        setup { @phone_number = "312 456 7890" }
+        
+        should("match") { assert @format.match @phone_number }
+      end # that are grouped and separated by spaces
+      
+      context "where the area code is in parentheses" do
+        context "followed by a hyphen, and the exchange is followed by a space" do
+          setup { @phone_number = "(312)-456 7890" }
+        
+          should("not match") { deny @format.match @phone_number }
+        end # followed by a hyphen, and then space-separated
+        
+        context "followed by a space, and the exchange is followed by a space" do
+          setup { @phone_number = "(312) 456 7890" }
+        
+          should("match") { assert @format.match @phone_number }
+        end # followed by a space, and the exchange is followed by a space
+        
+        context "followed by a space, and the exchange is followed by a hyphen" do
+          setup { @phone_number = "(312) 456-7890" }
+        
+          should("match") { assert @format.match @phone_number }
+        end # followed by a space, and the exchange is followed by a hyphen
+      end # where the area code is in parentheses
+    end # with 10 digits
+  end # A Phone Number
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: vandrijevik-has_phone_number
+version: !ruby/object:Gem::Version 
+  version: "1.1"
+platform: ruby
+authors: 
+- Vladimir Andrijevik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-21 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: HasPhoneNumber makes validations for US phone numbers in ActiveRecord models easy.
+email: vladimir@andrijevik.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/has_phone_number/phone_number.rb
+- lib/has_phone_number/validateable.rb
+- lib/has_phone_number.rb
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+has_rdoc: false
+homepage: http://github.com/vandrijevik/has_phone_number/
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: a phone number validator for ActiveRecord
+test_files: 
+- test/config/boot.rb
+- test/config/database.yml
+- test/config/environment.rb
+- test/config/environments/test.rb
+- test/config/routes.rb
+- test/has_phone_number_test.rb
+- test/phone_number_test.rb
+- test/test_helper.rb
+- test/us_test.rb