phony_rails 0.3.2 → 0.4.0

data/Gemfile.lock

@@ -2,7 +2,7 @@ PATH
   remote: .
   specs:
     phony_rails (0.3.2)
-      activerecord (>= 3.0)
+      activesupport (>= 3.0)
       countries (>= 0.8.2)
       phony (>= 1.7.7)
 
@@ -41,7 +41,14 @@ GEM
       rb-fchange (~> 0.0.5)
       rb-fsevent (~> 0.9.1)
       rb-inotify (~> 0.8.8)
+    mongoid (3.1.4)
+      activemodel (~> 3.2)
+      moped (~> 1.4)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.22)
+    moped (1.5.0)
     multi_json (1.7.2)
+    origin (1.1.0)
     phony (1.9.0)
     rake (10.0.3)
     rb-fchange (0.0.5)
@@ -65,11 +72,13 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord (>= 3.0)
   countries
   growl
   guard (~> 1.2.0)
   guard-bundler (~> 1.0.0)
   guard-rspec (~> 1.2.0)
+  mongoid (>= 3.0)
   phony_rails!
   rake
   rb-fsevent

data/README.md

@@ -21,9 +21,9 @@ Or install it yourself as:
 
 ## Usage
 
-### Normalization / ActiveRecord Extension
+### Normalization / Model Usage
 
-In your model add:
+For **ActiveRecord**, in your model add:
 
     class SomeModel < ActiveRecord::Base
 
@@ -37,6 +37,15 @@ In your model add:
       phony_normalized_method :fax_number
     end
 
+For **Mongoid**, in keeping with Mongoid plug-in conventions you must include the `Mongoid::Phony` module:
+
+    class SomeModel
+      include Mongoid::Document
+      include Mongoid::Phony
+
+      # methods are same as ActiveRecord usage
+    end
+
 The `:default_country_code` options is used to specify a country_code when normalizing.
 
 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'`.
@@ -101,6 +110,9 @@ Say you want to find a record by a phone number. Best is to normalize user input
 
 ## Changelog
 
+0.4.0
+* Better Mongoid support by @johnnyshields
+
 0.3.0
 * Now ability to force change a country_code.
   See: https://github.com/joost/phony_rails/pull/23#issuecomment-17480463

data/lib/phony_rails.rb

@@ -37,14 +37,9 @@ module PhonyRails
   end
 
   module Extension
+    extend ActiveSupport::Concern
 
-    def self.extended(base)
-      base.send :include, InstanceMethods
-      base.extend ClassMethods
-    end
-
-    module InstanceMethods
-
+    included do
       private
 
       # This methods sets the attribute to the normalized version.
@@ -58,7 +53,6 @@ module PhonyRails
           write_attribute(attribute_name, PhonyRails.normalize_number(read_attribute(attribute), options))
         end
       end
-
     end
 
     module ClassMethods
@@ -97,20 +91,19 @@ module PhonyRails
           end
         end
       end
-
     end
-
   end
-
 end
 
 # check whether it is ActiveRecord or Mongoid being used
-ActiveRecord::Base.send :extend, PhonyRails::Extension if defined?(ActiveRecord)
-Mongoid::Document.module_eval do
-  def self.included(base)
-    base.extend PhonyRails::Extension
+ActiveRecord::Base.send :include, PhonyRails::Extension if defined?(ActiveRecord)
+
+if defined?(Mongoid)
+  module Mongoid::Phony
+    extend ActiveSupport::Concern
+    include PhonyRails::Extension
   end
-end if defined?(Mongoid)
+end
 
 Dir["#{File.dirname(__FILE__)}/phony_rails/locales/*.yml"].each do |file|
   I18n.load_path << file

data/lib/phony_rails/locales/en.yml

@@ -1,6 +1,9 @@
-
 en:
   activerecord:
     errors:
       messages:
         improbable_phone: "is an invalid number"
+  activemodel:
+    errors:
+      messages:
+        improbable_phone: "is an invalid number"

data/lib/phony_rails/version.rb

@@ -1,3 +1,3 @@
 module PhonyRails
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/phony_rails.gemspec

@@ -17,5 +17,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "phony", ">= 1.7.7"
   gem.add_dependency "countries", ">= 0.8.2"
-  gem.add_dependency "activerecord", ">= 3.0"
+  gem.add_dependency "activesupport", ">= 3.0"
+  gem.add_development_dependency "activerecord", ">= 3.0"
+  gem.add_development_dependency "mongoid", ">= 3.0"
 end

data/spec/lib/phony_rails_spec.rb

@@ -123,143 +123,156 @@ describe PhonyRails do
     end
   end
 
-  describe 'defining ActiveRecord#phony_normalized_method' do
-    it "should add a normalized_phone_attribute method" do
-      Home.new.should respond_to(:normalized_phone_attribute)
-    end
+  shared_examples_for 'model with PhonyRails' do
+    describe 'defining model#phony_normalized_method' do
+      it "should add a normalized_phone_attribute method" do
+        model_klass.new.should respond_to(:normalized_phone_attribute)
+      end
 
-    it "should add a normalized_phone_method method" do
-      Home.new.should respond_to(:normalized_phone_method)
-    end
+      it "should add a normalized_phone_method method" do
+        model_klass.new.should respond_to(:normalized_phone_method)
+      end
 
-    it "should raise error on existing methods" do
-      lambda {
-        Home.phony_normalized_method(:phone_method)
-      }.should raise_error(StandardError)
-    end
+      it "should raise error on existing methods" do
+        lambda {
+          model_klass.phony_normalized_method(:phone_method)
+        }.should raise_error(StandardError)
+      end
 
-    it "should raise error on not existing attribute" do
-      Home.phony_normalized_method(:phone_non_existing_method)
-      lambda {
-        Home.new.normalized_phone_non_existing_method
-      }.should raise_error(ArgumentError)
+      it "should raise error on not existing attribute" do
+        model_klass.phony_normalized_method(:phone_non_existing_method)
+        lambda {
+          model_klass.new.normalized_phone_non_existing_method
+        }.should raise_error(ArgumentError)
+      end
     end
-  end
 
-  describe 'defining ActiveRecord#phony_normalize' do
-    it "should not accept :as option with multiple attribute names" do
-      lambda {
-        Home.phony_normalize(:phone_number, :phone1_method, :as => 'non_existing_attribute')
-      }.should raise_error(ArgumentError)
-    end
+    describe 'defining model#phony_normalize' do
+      it "should not accept :as option with multiple attribute names" do
+        lambda {
+          model_klass.phony_normalize(:phone_number, :phone1_method, :as => 'non_existing_attribute')
+        }.should raise_error(ArgumentError)
+      end
 
-    it "should not accept :as option with unexisting attribute name" do
-      lambda {
-        Home.phony_normalize(:non_existing_attribute, :as => 'non_existing_attribute')
-      }.should raise_error(ArgumentError)
-    end
+      it "should not accept :as option with unexisting attribute name" do
+        lambda {
+          model_klass.phony_normalize(:non_existing_attribute, :as => 'non_existing_attribute')
+        }.should raise_error(ArgumentError)
+      end
 
-    it "should not accept :as option with single non existing attribute name" do
-      lambda {
-        Home.phony_normalize(:phone_number, :as => 'something_else')
-      }.should raise_error(ArgumentError)
-    end
+      it "should not accept :as option with single non existing attribute name" do
+        lambda {
+          model_klass.phony_normalize(:phone_number, :as => 'something_else')
+        }.should raise_error(ArgumentError)
+      end
 
-    it "should accept :as option with single existing attribute name" do
-      lambda {
-        Home.phony_normalize(:phone_number, :as => 'phone_number_as_normalized')
-      }.should_not raise_error(ArgumentError)
-    end
+      it "should accept :as option with single existing attribute name" do
+        lambda {
+          model_klass.phony_normalize(:phone_number, :as => 'phone_number_as_normalized')
+        }.should_not raise_error(ArgumentError)
+      end
 
-    it "should accept a non existing attribute name" do
-      lambda {
-        Dummy.phony_normalize(:non_existing_attribute)
-      }.should_not raise_error
+      it "should accept a non existing attribute name" do
+        lambda {
+          dummy_klass.phony_normalize(:non_existing_attribute)
+        }.should_not raise_error
+      end
     end
-  end
 
-  describe 'using ActiveRecord#phony_normalized_method' do
-  # Following examples have complete number (with country code!)
-    it "should return a normalized version of an attribute" do
-      home = Home.new(:phone_attribute => "+31-(0)10-1234123")
-      home.normalized_phone_attribute.should eql('31101234123')
-    end
+    describe 'using model#phony_normalized_method' do
+    # Following examples have complete number (with country code!)
+      it "should return a normalized version of an attribute" do
+        model = model_klass.new(:phone_attribute => "+31-(0)10-1234123")
+        model.normalized_phone_attribute.should eql('31101234123')
+      end
 
-    it "should return a normalized version of a method" do
-      home = Home.new(:phone_method => "+31-(0)10-1234123")
-      home.normalized_phone_method.should eql('31101234123')
-    end
+      it "should return a normalized version of a method" do
+        model = model_klass.new(:phone_method => "+31-(0)10-1234123")
+        model.normalized_phone_method.should eql('31101234123')
+      end
 
-  # Following examples have incomplete number
-    it "should return nil if no country_code is known" do
-      home = Home.new(:phone_attribute => "(0)10-1234123")
-      home.normalized_phone_attribute.should eql('11234123') # This actually is an incorrect number! (FIXME?)
-    end
+    # Following examples have incomplete number
+      it "should return nil if no country_code is known" do
+        model = model_klass.new(:phone_attribute => "(0)10-1234123")
+        model.normalized_phone_attribute.should eql('11234123') # This actually is an incorrect number! (FIXME?)
+      end
 
-    it "should use country_code option" do
-      home = Home.new(:phone_attribute => "(0)10-1234123")
-      home.normalized_phone_attribute(:country_code => 'NL').should eql('31101234123')
-    end
+      it "should use country_code option" do
+        model = model_klass.new(:phone_attribute => "(0)10-1234123")
+        model.normalized_phone_attribute(:country_code => 'NL').should eql('31101234123')
+      end
 
-    it "should use country_code object method" do
-      home = Home.new(:phone_attribute => "(0)10-1234123", :country_code => 'NL')
-      home.normalized_phone_attribute.should eql('31101234123')
-    end
+      it "should use country_code object method" do
+        model = model_klass.new(:phone_attribute => "(0)10-1234123", :country_code => 'NL')
+        model.normalized_phone_attribute.should eql('31101234123')
+      end
 
-    it "should fallback to default_country_code option" do
-      home = Home.new(:phone1_method => "(030) 8 61 29 06")
-      home.normalized_phone1_method.should eql('49308612906')
-    end
+      it "should fallback to default_country_code option" do
+        model = model_klass.new(:phone1_method => "(030) 8 61 29 06")
+        model.normalized_phone1_method.should eql('49308612906')
+      end
 
-    it "should overwrite default_country_code option with object method" do
-      home = Home.new(:phone1_method => "(030) 8 61 29 06", :country_code => 'NL')
-      home.normalized_phone1_method.should eql('31308612906')
-    end
+      it "should overwrite default_country_code option with object method" do
+        model = model_klass.new(:phone1_method => "(030) 8 61 29 06", :country_code => 'NL')
+        model.normalized_phone1_method.should eql('31308612906')
+      end
 
-    it "should overwrite default_country_code option with option" do
-      home = Home.new(:phone1_method => "(030) 8 61 29 06")
-      home.normalized_phone1_method(:country_code => 'NL').should eql('31308612906')
-    end
+      it "should overwrite default_country_code option with option" do
+        model = model_klass.new(:phone1_method => "(030) 8 61 29 06")
+        model.normalized_phone1_method(:country_code => 'NL').should eql('31308612906')
+      end
 
-    it "should use last passed options" do
-      home = Home.new(:phone1_method => "(030) 8 61 29 06")
-      home.normalized_phone1_method(:country_code => 'NL').should eql('31308612906')
-      home.normalized_phone1_method(:country_code => 'DE').should eql('49308612906')
-      home.normalized_phone1_method(:country_code => nil).should eql('49308612906')
-    end
+      it "should use last passed options" do
+        model = model_klass.new(:phone1_method => "(030) 8 61 29 06")
+        model.normalized_phone1_method(:country_code => 'NL').should eql('31308612906')
+        model.normalized_phone1_method(:country_code => 'DE').should eql('49308612906')
+        model.normalized_phone1_method(:country_code => nil).should eql('49308612906')
+      end
 
-    it "should use last object method" do
-      home = Home.new(:phone1_method => "(030) 8 61 29 06")
-      home.country_code = 'NL'
-      home.normalized_phone1_method.should eql('31308612906')
-      home.country_code = 'DE'
-      home.normalized_phone1_method.should eql('49308612906')
-      home.country_code = nil
-      home.normalized_phone1_method(:country_code => nil).should eql('49308612906')
+      it "should use last object method" do
+        model = model_klass.new(:phone1_method => "(030) 8 61 29 06")
+        model.country_code = 'NL'
+        model.normalized_phone1_method.should eql('31308612906')
+        model.country_code = 'DE'
+        model.normalized_phone1_method.should eql('49308612906')
+        model.country_code = nil
+        model.normalized_phone1_method(:country_code => nil).should eql('49308612906')
+      end
     end
-  end
 
-  describe 'using ActiveRecord#phony_normalize' do
-    it "should set a normalized version of an attribute" do
-      home = Home.new(:phone_number => "+31-(0)10-1234123")
-      home.valid?.should be_true
-      home.phone_number.should eql('31101234123')
-    end
+    describe 'using model#phony_normalize' do
+      it "should set a normalized version of an attribute" do
+        model = model_klass.new(:phone_number => "+31-(0)10-1234123")
+        model.valid?.should be_true
+        model.phone_number.should eql('31101234123')
+      end
 
-    it "should set a normalized version of an attribute using :as option" do
-      Home.phony_normalize :phone_number, :as => :phone_number_as_normalized
-      home = Home.new(:phone_number => "+31-(0)10-1234123")
-      home.valid?.should be_true
-      home.phone_number_as_normalized.should eql('31101234123')
+      it "should set a normalized version of an attribute using :as option" do
+        model_klass.phony_normalize :phone_number, :as => :phone_number_as_normalized
+        model = model_klass.new(:phone_number => "+31-(0)10-1234123")
+        model.valid?.should be_true
+        model.phone_number_as_normalized.should eql('31101234123')
+      end
+
+      it "should raise a RuntimeError at validation if the attribute doesn't exist" do
+        dummy_klass.phony_normalize :non_existing_attribute
+        dummy = dummy_klass.new
+        lambda {
+          dummy.valid?
+        }.should raise_error(RuntimeError)
+      end
     end
+  end
 
-    it "should raise a RuntimeError at validation if the attribute doesn't exist" do
-      Dummy.phony_normalize :non_existing_attribute
+  describe 'ActiveRecord' do
+    let(:model_klass){ ActiveRecordModel }
+    let(:dummy_klass){ ActiveRecordDummy }
+    it_behaves_like 'model with PhonyRails'
+  end
 
-      dummy = Dummy.new
-      lambda {
-        dummy.valid?
-      }.should raise_error(RuntimeError)
-    end
+  describe 'Mongoid' do
+    let(:model_klass){ MongoidModel }
+    let(:dummy_klass){ MongoidDummy }
+    it_behaves_like 'model with PhonyRails'
   end
 end

data/spec/spec_helper.rb

@@ -1,8 +1,8 @@
 require 'rubygems'
 require 'bundler/setup'
 
-
 require 'active_record'
+require 'mongoid'
 require 'phony_rails'
 
 ActiveRecord::Base.establish_connection(
@@ -11,22 +11,41 @@ ActiveRecord::Base.establish_connection(
 )
 
 ActiveRecord::Schema.define do
-create_table :homes do |table|
-  table.column :phone_attribute, :string
-  table.column :phone_number, :string
-  table.column :phone_number_as_normalized, :string
+  create_table :active_record_models do |table|
+    table.column :phone_attribute, :string
+    table.column :phone_number, :string
+    table.column :phone_number_as_normalized, :string
+  end
+end
+
+module SharedModelMethods
+  extend ActiveSupport::Concern
+  included do
+    attr_accessor :phone_method, :phone1_method, :country_code
+    phony_normalized_method :phone_attribute # adds normalized_phone_attribute method
+    phony_normalized_method :phone_method # adds normalized_phone_method method
+    phony_normalized_method :phone1_method, :default_country_code => 'DE' # adds normalized_phone_method method
+    phony_normalize :phone_number # normalized on validation
+  end
 end
+
+class ActiveRecordModel < ActiveRecord::Base
+  include SharedModelMethods
+end
+
+class ActiveRecordDummy < ActiveRecordModel
 end
 
-class Home < ActiveRecord::Base
-  attr_accessor :phone_method, :phone1_method, :country_code
-  phony_normalized_method :phone_attribute # adds normalized_phone_attribute method
-  phony_normalized_method :phone_method # adds normalized_phone_method method
-  phony_normalized_method :phone1_method, :default_country_code => 'DE' # adds normalized_phone_method method
-  phony_normalize :phone_number # normalized on validation
+class MongoidModel
+  include Mongoid::Document
+  include Mongoid::Phony
+  field :phone_attribute, :type => String
+  field :phone_number,    :type => String
+  field :phone_number_as_normalized, :type => String
+  include SharedModelMethods
 end
 
-class Dummy < Home
+class MongoidDummy < MongoidModel
 end
 
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phony_rails
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-08 00:00:00.000000000 Z
+date: 2013-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phony
@@ -44,7 +44,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.8.2
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -59,6 +59,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: This Gem adds useful methods to your Rails app to validate, display and
   save phone numbers.
 email: