phony_rails 0.1.6 → 0.1.7

data/.gitignore

@@ -0,0 +1,2 @@
+/.rvmrc
+/.idea/

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--drb
+--format documentation

data/Gemfile

@@ -2,5 +2,23 @@ source :rubygems
 gemspec # Specify your gem's dependencies in phony_number.gemspec
 
 # For testing
-gem 'rspec'
 gem 'sqlite3'
+
+gem 'rspec',          '~> 2.11.0'
+gem 'guard',          '~> 1.2.0'
+gem 'guard-bundler',  '~> 1.0.0'
+gem 'guard-rspec',    '~> 1.2.0'
+
+case RbConfig::CONFIG['host_os']
+  when /darwin/i
+    gem 'growl'
+    gem 'rb-fsevent'
+  when /linux/i
+    gem 'libnotify'
+    gem 'rb-inotify'
+  when /mswin|windows/i
+    gem 'rb-fchange'
+    gem 'rb-notifu'
+    gem 'win32console'
+end
+

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    phony_rails (0.1.5)
+    phony_rails (0.1.6)
       activerecord (~> 3.0)
       countries (~> 0.8.2)
-      phony (~> 1.7.4)
+      phony (~> 1.7.7)
 
 GEM
   remote: http://rubygems.org/
@@ -27,24 +27,49 @@ GEM
       currencies (>= 0.2.0)
     currencies (0.4.0)
     diff-lcs (1.1.3)
+    ffi (1.1.0)
+    growl (1.0.3)
+    guard (1.2.3)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-bundler (1.0.0)
+      bundler (~> 1.0)
+      guard (~> 1.1)
+    guard-rspec (1.2.0)
+      guard (>= 1.1)
     i18n (0.6.0)
+    listen (0.4.7)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
     multi_json (1.3.6)
-    phony (1.7.4)
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.1)
-    rspec-expectations (2.10.0)
+    phony (1.7.7)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.1)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
+    rspec-mocks (2.11.1)
     sqlite3 (1.3.6)
+    thor (0.15.4)
     tzinfo (0.3.33)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  growl
+  guard (~> 1.2.0)
+  guard-bundler (~> 1.0.0)
+  guard-rspec (~> 1.2.0)
   phony_rails!
-  rspec
+  rb-fsevent
+  rspec (~> 2.11.0)
   sqlite3

data/Guardfile

@@ -0,0 +1,12 @@
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -21,6 +21,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Normalization / ActiveRecord Extension
+
 In your model add:
 
     class SomeModel < ActiveRecord::Base
@@ -39,14 +41,39 @@ The `:default_country_code` options is used to specify a country_code when norma
 
 PhonyRails will also check your model for a country_code method to use when normalizing the number. So `'070-12341234'` with `country_code` 'NL' will get normalized to `'317012341234'`.
 
-Use the Phony.plausible method to validate an attribute:
+### Validation
+
+In your model use the Phony.plausible method to validate an attribute:
 
     validates :phone_number, :phony_plausible => true
 
+or the helper method:
+
+    validates_plausible_phone :phone_number
+
+this method use other validators under the hood to provide:
+* presence validation using `ActiveModel::Validations::PresenceValidator`
+* format validation using `ActiveModel::Validations::FormatValidator`
+
+so we can use:
+
+    validates_plausible_phone :phone_number, :presence => true
+    validates_plausible_phone :phone_number, :with => /^\+\d+/
+    validates_plausible_phone :phone_number, :without => /^\+\d+/
+    validates_plausible_phone :phone_number, :presence => true, :with => /^\+\d+/
+
+### Display / Views
+
 In your views use:
 
     <%= "some number string variable".phony_formatted(:format => :international, :spaces => '-') %>
 
+### Find by normalized number
+
+Say you want to find a record by a phone number. Best is to normalize user input and compare to an attribute stored in the db.
+
+    Home.find_by_normalized_phone_number(PhonyRails.normalize_number(params[:phone_number]))
+
 ## Changelog
 
 0.1.6
@@ -77,6 +104,12 @@ In your views use:
 0.0.6
 * Fixed problem with '070-4157134' being parsed as US number
 
+## TODO
+
+* Make this work: Home.find_by_normalized_phone_number(Home.normalize_number(params[:phone_number]))
+  So we use Home.normalize_number instead of PhonyRails.normalize_number. This way we can use the same default_country_code.
+* Make country_code method configurable.
+
 ## Contributing
 
 1. Fork it

data/lib/phony_rails/version.rb

@@ -1,3 +1,3 @@
 module PhonyRails
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/lib/validators/phony_validator.rb

@@ -16,7 +16,12 @@ module ActiveModel
     module HelperMethods
 
       def validates_plausible_phone(*attr_names)
-        validates_with PhonyPlausibleValidator, _merge_attributes(attr_names)
+        # merged attributes are modified somewhere, so we are cloning them for each validator
+        merged_attributes = _merge_attributes(attr_names)
+
+        validates_with PresenceValidator, merged_attributes.clone if merged_attributes[:presence]
+        validates_with FormatValidator, merged_attributes.clone if (merged_attributes[:with] or merged_attributes[:without])
+        validates_with PhonyPlausibleValidator, merged_attributes.clone
       end
 
     end

data/phony_rails.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = PhonyRails::VERSION
 
-  gem.add_dependency "phony", "~> 1.7.4"
+  gem.add_dependency "phony", "~> 1.7.7"
   gem.add_dependency "countries", "~> 0.8.2"
   gem.add_dependency "activerecord", "~> 3.0"
 end

data/spec/lib/validators/phony_validator_spec.rb

@@ -0,0 +1,245 @@
+require 'spec_helper'
+
+#-----------------------------------------------------------------------------------------------------------------------
+# Model
+#-----------------------------------------------------------------------------------------------------------------------
+
+#--------------------
+ActiveRecord::Schema.define do
+  create_table :simple_homes do |table|
+    table.column :phone_number, :string
+  end
+
+  create_table :helpful_homes do |table|
+    table.column :phone_number, :string
+  end
+
+  create_table :required_helpful_homes do |table|
+    table.column :phone_number, :string
+  end
+
+  create_table :optional_helpful_homes do |table|
+    table.column :phone_number, :string
+  end
+
+  create_table :formatted_helpful_homes do |table|
+    table.column :phone_number, :string
+  end
+
+  create_table :not_formatted_helpful_homes do |table|
+    table.column :phone_number, :string
+  end
+
+  create_table :big_helpful_homes do |table|
+    table.column :phone_number, :string
+  end
+end
+
+#--------------------
+class SimpleHome < ActiveRecord::Base
+  attr_accessor :phone_number
+  validates :phone_number, :phony_plausible => true
+end
+
+#--------------------
+class HelpfulHome < ActiveRecord::Base
+  attr_accessor :phone_number
+  validates_plausible_phone :phone_number
+end
+
+#--------------------
+class RequiredHelpfulHome < ActiveRecord::Base
+  attr_accessor :phone_number
+  validates_plausible_phone :phone_number, :presence => true
+end
+
+#--------------------
+class OptionalHelpfulHome < ActiveRecord::Base
+  attr_accessor :phone_number
+  validates_plausible_phone :phone_number, :presence => false
+end
+
+#--------------------
+class FormattedHelpfulHome < ActiveRecord::Base
+  attr_accessor :phone_number
+  validates_plausible_phone :phone_number, :with => /^\+\d+/
+end
+
+#--------------------
+class NotFormattedHelpfulHome < ActiveRecord::Base
+  attr_accessor :phone_number
+  validates_plausible_phone :phone_number, :without => /^\+\d+/
+end
+
+#--------------------
+class BigHelpfulHome < ActiveRecord::Base
+  attr_accessor :phone_number
+  validates_plausible_phone :phone_number, :presence => true, :with => /^\+\d+/
+end
+
+#-----------------------------------------------------------------------------------------------------------------------
+# Tests
+#-----------------------------------------------------------------------------------------------------------------------
+
+VALID_NUMBER = '123456789'
+INVALID_NUMBER = '123456789 123456789 123456789 123456789'
+
+#-----------------------------------------------------------------------------------------------------------------------
+describe PhonyPlausibleValidator do
+
+  #--------------------
+  describe '#validates' do
+
+    before(:each) do
+      @home = SimpleHome.new
+    end
+
+    it "should validate an empty number" do
+      @home.should be_valid
+    end
+
+    it "should validate a valid number" do
+      @home.phone_number = VALID_NUMBER
+      @home.should be_valid
+    end
+
+    it "should invalidate an invalid number" do
+      @home.phone_number = INVALID_NUMBER
+      @home.should_not be_valid
+      @home.errors.messages.should include(:phone_number => ["is an invalid number"])
+    end
+
+  end
+end
+
+#-----------------------------------------------------------------------------------------------------------------------
+describe ActiveModel::Validations::HelperMethods do
+
+  #--------------------
+  describe '#validates_plausible_phone' do
+
+    #--------------------
+    context 'when a number is optional' do
+
+      before(:each) do
+        @home = HelpfulHome.new
+      end
+
+      it "should validate an empty number" do
+        @home.should be_valid
+      end
+
+      it "should validate a valid number" do
+        @home.phone_number = VALID_NUMBER
+        @home.should be_valid
+      end
+
+      it "should invalidate an invalid number" do
+        @home.phone_number = INVALID_NUMBER
+        @home.should_not be_valid
+        @home.errors.messages.should include(:phone_number => ["is an invalid number"])
+      end
+
+    end
+
+    #--------------------
+    context 'when a number is required (:presence = true)' do
+
+      before(:each) do
+        @home = RequiredHelpfulHome.new
+      end
+
+      it "should invalidate an empty number" do
+        @home.should_not be_valid
+        @home.errors.messages.should include(:phone_number => ["can't be blank"])
+      end
+
+      it "should validate a valid number" do
+        @home.phone_number = VALID_NUMBER
+        @home.should be_valid
+      end
+
+      it "should invalidate an invalid number" do
+        @home.phone_number = INVALID_NUMBER
+        @home.should_not be_valid
+        @home.errors.messages.should include(:phone_number => ["is an invalid number"])
+      end
+
+    end
+
+    #--------------------
+    context 'when a number is not required (!presence = false)' do
+
+      before(:each) do
+        @home = OptionalHelpfulHome.new
+      end
+
+      it "should validate an empty number" do
+        @home.should be_valid
+      end
+
+      it "should validate a valid number" do
+        @home.phone_number = VALID_NUMBER
+        @home.should be_valid
+      end
+
+      it "should invalidate an invalid number" do
+        @home.phone_number = INVALID_NUMBER
+        @home.should_not be_valid
+        @home.errors.messages.should include(:phone_number => ["is an invalid number"])
+      end
+
+    end
+
+    #--------------------
+    context 'when a number must be formatted (:with)' do
+
+      before(:each) do
+        @home = FormattedHelpfulHome.new
+      end
+
+      it "should invalidate an empty number" do
+        @home.should_not be_valid
+        @home.errors.messages.should include(:phone_number => ["is invalid"])
+      end
+
+      it "should validate a well formatted valid number" do
+        @home.phone_number = "+33 #{VALID_NUMBER}"
+        @home.should be_valid
+      end
+
+      it "should invalidate a bad formatted valid number" do
+        @home.phone_number = VALID_NUMBER
+        @home.should_not be_valid
+        @home.errors.messages.should include(:phone_number => ["is invalid"])
+      end
+
+    end
+
+    #--------------------
+    context 'when a number must not be formatted (:without)' do
+
+      before(:each) do
+        @home = NotFormattedHelpfulHome.new
+      end
+
+      it "should validate an empty number" do
+        @home.should be_valid
+      end
+
+      it "should validate a well formatted valid number" do
+        @home.phone_number = VALID_NUMBER
+        @home.should be_valid
+      end
+
+      it "should invalidate a bad formatted valid number" do
+        @home.phone_number =  "+33 #{VALID_NUMBER}"
+        @home.should_not be_valid
+        @home.errors.messages.should include(:phone_number => ["is invalid"])
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phony_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-02 00:00:00.000000000 Z
+date: 2012-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phony
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.4
+        version: 1.7.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.4
+        version: 1.7.7
 - !ruby/object:Gem::Dependency
   name: countries
   requirement: !ruby/object:Gem::Requirement
@@ -67,8 +67,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .rspec
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -78,7 +81,7 @@ files:
 - lib/validators/phony_validator.rb
 - phony_rails.gemspec
 - spec/lib/phony_rails_spec.rb
-- spec/lib/phony_validator_spec.rb
+- spec/lib/validators/phony_validator_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/joost/phony_rails
 licenses: []
@@ -107,6 +110,6 @@ summary: This Gem adds useful methods to your Rails app to validate, display and
   phone numbers.
 test_files:
 - spec/lib/phony_rails_spec.rb
-- spec/lib/phony_validator_spec.rb
+- spec/lib/validators/phony_validator_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/spec/lib/phony_validator_spec.rb

@@ -1,60 +0,0 @@
-require 'spec_helper'
-
-ActiveRecord::Schema.define do
-  create_table :validating_homes do |table|
-    table.column :phone_number, :string
-    table.column :fax_number, :string
-  end
-end
-
-class ValidatingHome < ActiveRecord::Base
-  attr_accessor :phone_method, :fax_number
-  validates :phone_number, :phony_plausible => true
-  validates_plausible_phone :fax_number
-end
-
-
-
-describe PhonyPlausibleValidator do
-
-  describe 'validates' do
-    before(:each) do
-      @home = ValidatingHome.new
-    end
-
-    it "should validate an empty number" do
-      @home.should be_valid
-    end
-
-    it "should validate a valid number" do
-      @home.phone_number = '123456789'
-      @home.should be_valid
-    end
-
-    it "should invalidate an invalid number" do
-      @home.phone_number = '123456789 123456789 123456789 123456789'
-      @home.should_not be_valid
-    end
-  end
-
-  describe 'validates_plausible_phone' do
-    before(:each) do
-      @home = ValidatingHome.new
-    end
-
-    it "should validate an empty number" do
-      @home.should be_valid
-    end
-
-    it "should validate a valid number" do
-      @home.fax_number = '123456789'
-      @home.should be_valid
-    end
-
-    it "should invalidate an invalid number" do
-      @home.fax_number = '123456789 123456789 123456789 123456789'
-      @home.should_not be_valid
-    end
-  end
-
-end