validates_and_formats_phones 0.0.7 → 0.0.8

data/.gitignore

@@ -0,0 +1,4 @@
+*.swp
+*.log
+*.db
+*.swo

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Rakefile

@@ -1,45 +1,2 @@
-require 'rubygems'
-require 'rake'
-require 'rake/gempackagetask'
-require 'spec/rake/spectask'
-require 'metric_fu'
-
-desc 'Default: run specs.'
-task :default => :spec
-
-desc 'Run the specs'
-Spec::Rake::SpecTask.new(:spec) do |t|
-  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
-  t.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-PKG_FILES = FileList[
-  '[a-zA-Z]*',
-  'generators/**/*',
-  'lib/**/*',
-  'rails/**/*',
-  'tasks/**/*',
-  'test/**/*'
-]
-
-spec = Gem::Specification.new do |s|
-  s.name = "validates_and_formats_phones"
-  s.version = "0.0.7"
-
-  s.author = "Bernie Telles"
-  s.email = "btelles@gmail.com"
-  s.homepage = "http://github.com/btelles/validates_and_formats_phones"
-  s.platform = Gem::Platform::RUBY
-  s.summary = "Allows you to easily format and validate phone numbers in any format you desire (sensible defaults provided)."
-  s.files = PKG_FILES.to_a
-  s.require_path = "lib"
-
-  s.has_rdoc = false
-  s.extra_rdoc_files = ["README"]
-end
-
-desc 'Turn this plugin into a gem.'
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.gem_spec = spec
-end
-
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/validates_and_formats_phones.rb

@@ -1,3 +1,4 @@
 require 'active_record'
 require 'validates_and_formats_phones/phone_formatter'
 require 'validates_and_formats_phones/validates_and_formats_phones'
+require 'validates_and_formats_phones/railtie'

data/lib/validates_and_formats_phones/railtie.rb

@@ -0,0 +1,17 @@
+module ValidatesAndFormatsPhones
+  if defined? Rails::Railtie
+    class Railtie < Rails::Railtie
+      initializer "validates_and_formats_phones.extend_activerecord_base" do |app|
+        ActiveSupport.on_load(:active_record) do
+          ValidatesAndFormatsPhones::Railtie.insert
+        end
+      end
+    end
+  end
+
+  class Railtie
+    def self.insert
+      ActiveRecord::Base.send(:include, ValidatesAndFormatsPhones)
+    end
+  end
+end

data/lib/validates_and_formats_phones/validates_and_formats_phones.rb

@@ -1,56 +1,54 @@
-  module ValidatesAndFormatsPhones
-    DEFAULT_FORMAT = "(###) ###-####"
-    def self.included(base)
-      base.send :extend, ClassMethods
-      base.send :include, InstanceMethods
-    end
+module ValidatesAndFormatsPhones
+  DEFAULT_FORMAT = "(###) ###-####"
+  def self.included(base)
+    base.send :extend, ClassMethods
+    base.send :include, InstanceMethods
+  end
 
-    def self.extract_formats_and_fields(formats_and_fields)
-      options = {:on => :save, :allow_nil => false}
-      options.merge!(formats_and_fields.extract_options!)
-      formats = []
-      fields = []
-      formats_and_fields.each do |option|
-        option.to_s =~ /#/ ?
-          formats << option :
-          fields << option.to_sym
-      end
-      formats << DEFAULT_FORMAT if formats.empty?
-      fields  << :phone if fields.empty?
-      [formats, fields, options]
+  def self.extract_formats_and_fields(formats_and_fields)
+    options = {:on => :save, :allow_nil => false}
+    options.merge!(formats_and_fields.extract_options!)
+    formats = []
+    fields = []
+    formats_and_fields.each do |option|
+      option.to_s =~ /#/ ?
+        formats << option :
+        fields << option.to_sym
     end
+    formats << DEFAULT_FORMAT if formats.empty?
+    fields  << :phone if fields.empty?
+    [formats, fields, options]
+  end
 
-    module ClassMethods
+  module ClassMethods
 
-      def validates_and_formats_phones(*args)
-        formats, fields, options = ValidatesAndFormatsPhones.extract_formats_and_fields(args)
+    def validates_and_formats_phones(*args)
+      formats, fields, options = ValidatesAndFormatsPhones.extract_formats_and_fields(args)
 
-        size_options = formats.collect {|format| format.count '#'}
+      size_options = formats.collect {|format| format.count '#'}
 
-        validates_each(fields, options) do |record, attr, value|
-          unless value.blank? || size_options.include?(value.scan(/\d/).size)
-            if size_options.size > 1
-              last = size_options.pop
-              message = "must have #{size_options.join(', ')} or #{last} digits."
-            else
-              message = "must have #{size_options[0]} digits."
-            end
-            record.errors.add attr, message 
+      validates_each(*args) do |record, attr, value|
+        unless (value.present? && size_options.include?(value.scan(/\d/).size)) || options[:allow_nil]
+          if size_options.size > 1
+            last = size_options.pop
+            message = "must have #{size_options.join(', ')} or #{last} digits."
           else
-            record.format_phone_field(attr, formats)
+            message = "must have #{size_options[0]} digits."
           end
+          record.errors.add attr, message 
+        else
+          record.format_phone_field(attr, formats)
         end
       end
-
     end
 
-    module InstanceMethods
+  end
 
-      def format_phone_field(field_name, formats = [])
-        formats << DEFAULT_FORMAT if formats.empty?
-        self.send("#{field_name}=", self.send(field_name).to_s.to_phone(formats)) unless send(field_name).blank?
-      end
+  module InstanceMethods
+
+    def format_phone_field(field_name, formats = [])
+      formats << DEFAULT_FORMAT if formats.empty?
+      self.send("#{field_name}=", self.send(field_name).to_s.to_phone(formats)) unless send(field_name).blank?
     end
   end
-
-  ActiveRecord::Base.send :include, ValidatesAndFormatsPhones
+end

data/lib/validates_and_formats_phones/version.rb

@@ -0,0 +1,3 @@
+module ValidatesAndFormatsPhones
+  VERSION= '0.0.8'
+end

data/spec/db/database.yml

@@ -0,0 +1,3 @@
+sqlite3:
+  adapter: sqlite3
+  database: vendor/plugins/validates_and_formats_phones/spec/validates_phones_plugin.sqlite3.db

data/spec/db/schema.rb

@@ -0,0 +1,18 @@
+ActiveRecord::Schema.define(:version => 0) do 
+
+  create_table :phones, :force => true do |t|
+    t.string :phone
+  end
+
+  create_table :options_phones, :force => true do |t|
+    t.string :other_phone
+    t.string :fax
+  end
+
+  create_table :if_options, :force => true do |t|
+    t.string :phone_if_true
+    t.string :phone_if_false
+    t.string :phone_unless_true
+    t.string :phone_unless_false
+  end
+end

data/spec/lib/phone_formatter_spec.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "String#to_formatted_number" do
+  it 'should accept no arguments and an invalid phone number and return same string' do
+    'aoeu'.to_phone.should == 'aoeu'
+  end
+  it 'should accept no arguments and a valid phone number and return a U.S. phone string' do
+    '1234567890'.to_phone.should == '(123) 456-7890'
+  end
+  it "should accept a number escaped by '#' and return a formatted string" do
+    'a123b123b12'.to_phone('####-####').should == '1231-2312'
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+begin
+  require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
+  #require 'validates_and_formats_phones'
+rescue LoadError
+  puts "You need to install rspec in your base app"
+  exit
+end
+
+plugin_spec_dir = File.dirname(__FILE__)
+ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
+
+databases = YAML::load(IO.read(plugin_spec_dir + "/db/database.yml"))
+
+ActiveRecord::Base.establish_connection(databases[ENV["DB"] || "sqlite3"])
+load(File.join(plugin_spec_dir, "db", "schema.rb"))
+

data/spec/validates_and_formats_phones_spec.rb

@@ -0,0 +1,101 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class Phone < ActiveRecord::Base
+  validates_and_formats_phones 
+end
+class OptionsPhone < ActiveRecord::Base
+  validates_and_formats_phones :other_phone, :fax,
+                               '####-####',
+                               '(###) ###-####'
+end
+class IfOption < ActiveRecord::Base
+  validates_and_formats_phones :phone_if_true, :if => :true_function
+  validates_and_formats_phones :phone_if_false, :if => :false_function
+  validates_and_formats_phones :phone_unless_false, :unless => :false_function
+  validates_and_formats_phones :phone_unless_true, :unless => :true_function
+
+  def true_function
+    true
+  end
+  def false_function
+    false
+  end
+end
+
+describe "ValidatesAndFormatsPhones" do
+
+  valid_phones = ['1234567890', '123-456-7890', '(123) 456-7890', 'o123.456-7890']
+  invalid_phones = ['01234567890', '12-456-7890', '(123) 456-8', 'o1123.456-7890', 'invalid']
+
+  valid_phones.each do |phone|
+    it "allows saving of valid phone #{phone}" do
+      lambda {
+        Phone.create!(:phone => phone)
+      }.should_not raise_error
+
+      Phone.create!(:phone => phone).should be_instance_of(Phone) end
+    it "formats the phone according to a reasonable default option" do
+      new_phone = Phone.create!(:phone => phone)
+      new_phone.phone.should == "(123) 456-7890"
+    end
+  end
+
+  describe "accepts different phone formats" do
+    it "by passing validation" do
+      lambda {
+        OptionsPhone.create!(:other_phone => '12345678')
+      }.should_not raise_error
+    end
+    it "by formatting the string in the new format" do
+        phone = OptionsPhone.create!(:other_phone => '12345678')
+        phone.other_phone.should == "1234-5678"
+    end
+  end
+
+  describe "accepts more phone fields" do
+    it ". They pass validation when the format is correct." do
+      lambda {
+        OptionsPhone.create!(:other_phone => '12345678')
+      }.should_not raise_error
+    end
+    it ". Their format ends up corrrected" do
+      phone = OptionsPhone.create!(:other_phone => '12345678')
+      phone.other_phone.should == "1234-5678"
+    end
+  end
+
+  describe "rejects invalid formats" do
+    invalid_phones.each do |invalid_number|
+      it "when on the default field" do
+         phone = Phone.create(:phone => invalid_number)
+         phone.errors.full_messages[0].should =~ /one must have .*digits\./
+      end
+      it "when on a non-default field" do
+         phone = OptionsPhone.create(:other_phone => invalid_number)
+         phone.errors.full_messages[0].should =~ /one must have.*digits\./
+      end
+
+    end
+  end
+
+  # These just test a few options from the standard validates_each configuration.
+  describe "validates if " do
+    it "'if' option is used and evaluates to true" do
+      IfOption.create(:phone_if_true => 'invalid').valid?.should == false
+      IfOption.create(:phone_if_true => '3333333333').valid?.should == true
+    end
+    it "'unless' option is used and evaluates to true" do
+      IfOption.create(:phone_unless_false => '123-invalid').valid?.should == false
+      IfOption.create(:phone_unless_false => '123-456-7890').valid?.should == true
+    end
+  end
+
+  describe "does not validate if " do
+    it "'if' option is used and evaluates to false" do
+      IfOption.create(:phone_if_false => 'invalid').valid?.should == true
+    end
+    it "'unless' option is used and evaluates to true" do
+      IfOption.create(:phone_unless_true => '123-invalid').valid?.should == true
+    end
+  end
+end

data/validates_and_formats_phones.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "validates_and_formats_phones/version"
+
+Gem::Specification.new do |s|
+  s.name        = "validates_and_formats_phones"
+  s.version     = ValidatesAndFormatsPhones::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Bernardo Telles"]
+  s.email       = ["btelles@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Allows you to easily format and validate phone numbers in any format you desire (sensible defaults provided).}
+  s.description = %q{Allows you to easily format and validate phone numbers in any format you desire (sensible defaults provided).}
+
+  s.rubyforge_project = "validates_and_formats_phones"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'jeweler'
+
+  s.add_dependency 'active_record'
+end

metadata

@@ -1,38 +1,96 @@
 --- !ruby/object:Gem::Specification 
 name: validates_and_formats_phones
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
-- Bernie Telles
+- Bernardo Telles
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-02-08 00:00:00 -05:00
+date: 2011-04-28 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
-description: 
-email: btelles@gmail.com
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: active_record
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Allows you to easily format and validate phone numbers in any format you desire (sensible defaults provided).
+email: 
+- btelles@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README
+extra_rdoc_files: []
+
 files: 
-- README.rdoc
+- .gitignore
+- Gemfile
 - README
-- discover.rb
+- README.rdoc
 - Rakefile
-- lib/validates_and_formats_phones/validates_and_formats_phones.rb
-- lib/validates_and_formats_phones/phone_formatter.rb
+- discover.rb
 - lib/validates_and_formats_phones.rb
-- rails/init.rb
+- lib/validates_and_formats_phones/phone_formatter.rb
+- lib/validates_and_formats_phones/railtie.rb
+- lib/validates_and_formats_phones/validates_and_formats_phones.rb
+- lib/validates_and_formats_phones/version.rb
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/lib/phone_formatter_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/validates_and_formats_phones_spec.rb
 - tasks/validates_and_formats_phones_tasks.rake
+- validates_and_formats_phones.gemspec
 has_rdoc: true
-homepage: http://github.com/btelles/validates_and_formats_phones
+homepage: ""
 licenses: []
 
 post_install_message: 
@@ -41,21 +99,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.5
+rubyforge_project: validates_and_formats_phones
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Allows you to easily format and validate phone numbers in any format you desire (sensible defaults provided).

data/rails/init.rb

@@ -1,2 +0,0 @@
-require 'validates_and_formats_phones/phone_formatter'
-require 'validates_and_formats_phones/validates_and_formats_phones'