phony_rails 0.0.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in phony_number.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Joost Hietbrink
+
+MIT License
+
+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.md

@@ -0,0 +1,43 @@
+# PhonyNumber
+
+This Gem adds useful methods to your Rails app to validate, display and save phone numbers.
+It uses the super awesome Phony gem (https://github.com/floere/phony).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'phony_number'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install phony_number
+
+## Usage
+
+In your model add:
+
+    class SomeModel < ActiveRecord::Base
+      phony_normalize :phone_number, :default_country_code => 'US' # Normalizes the attribute itself
+      phony_normalized_method :fax_number # Creates method normalized_fax_number that returns the normalized version of fax_number
+    end
+
+Use the Phony.plausible method to validate an attribute:
+
+    validate :phone_number, :phony_number => true
+
+In your views use:
+
+    <%= "some number string variable".phony_formatted(:format => :international, :spaces => '-') %>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/phony_rails.rb

@@ -0,0 +1,99 @@
+require 'phony'
+require "phony_rails/string_extensions"
+require "phony_rails/version"
+
+module PhonyRails
+
+  # Quick fix to get country_phone_number (phone number) for all relevant countries.
+  # TODO: Replace with some gem or something.
+  COUNTRY_NUMBER = {
+    'NL' => '31',
+    'BE' => '32',
+    'DE' => '49',
+    'GB' => '44',
+    'FR' => '33',
+    'ES' => '34',
+    'IT' => '39',
+    'US' => '1',
+    'AU' => '61',
+    'LU' => '352'
+  }
+
+  # This method requires a country_code attribute (eg. NL) and phone_number to be set.
+  # Options:
+  #   :country_code => The country code we should use.
+  #   :default_country_code => Some fallback code (eg. 'NL') that can be used as default (comes from phony_normalize_numbers method).
+  def self.normalize_number(number, options = {})
+    return if number.blank?
+    number = Phony.normalize(number) # TODO: Catch errors
+    if country_number = COUNTRY_NUMBER[options[:country_code] || options[:default_country_code]]
+      # Add country_number if missing
+      number = "#{country_number}#{number}" if not number =~ /^(00|\+)?#{country_number}/
+    end
+    number = Phony.normalize(number)
+  rescue
+    number # If all goes wrong .. we still return the original input.
+  end
+
+  # This module is added to AR.
+  module ActiveRecordExtension
+
+    def self.extended(base)
+      base.send :include, InstanceMethods
+      base.extend ClassMethods
+    end
+
+    module InstanceMethods
+  
+    private
+
+      # This methods sets the attribute to the normalized version.
+      # It also adds the country_code (number), eg. 31 for NL numbers.
+      def set_phony_normalized_numbers(attributes, options = {})
+        options[:country_code] ||= self.country_code if self.respond_to?(:country_code)
+        attributes.each do |attribute|
+          write_attribute(attribute, PhonyRails.normalize_number(read_attribute(attribute), options))
+        end
+      end
+
+    end
+
+    module ClassMethods
+
+      # Use this method on the class level like:
+      #   phony_normalize :phone_number, :fax_number, :default_country_code => 'NL'
+      #
+      # It checks your model object for a a country_code attribute (eg. 'NL') to do the normalizing so make sure
+      # you've geocoded before calling this method!
+      def phony_normalize(*attributes)
+        options = attributes.last.is_a?(Hash) ? attributes.pop : {} 
+        options.assert_valid_keys :country_code, :default_country_code
+        attributes.each do |attribute|
+          # Add before validation that saves a normalized version of the phone number
+          self.before_validation do 
+            set_phony_normalized_numbers(attributes, options)
+          end
+        end
+      end
+
+      # Usage:
+      #   phony_normalized_method :fax_number, :default_country_code => 'US'
+      # Creates a normalized_fax_number method.
+      def phony_normalized_method(*attributes)
+        options = attributes.last.is_a?(Hash) ? attributes.pop : {} 
+        options.assert_valid_keys :country_code, :default_country_code
+        attributes.each do |attribute|
+          raise ArgumentError, "Attribute #{attribute} was not found on #{self.name} (PhonyRails)" unless self.attribute_method?(attribute)
+          define_method :"normalized_#{attribute}" do
+            options[:country_code] ||= self.country_code if self.respond_to?(:country_code)
+            PhonyRails.normalize_number(self[attribute], options)
+          end
+        end
+      end
+
+    end
+
+  end
+
+end
+ActiveRecord::Base.extend PhonyRails::ActiveRecordExtension

data/lib/phony_rails/string_extensions.rb

@@ -0,0 +1,12 @@
+  class String
+
+    # Add a method to the String class so we can easily format phone numbers.
+    # This enables:
+    #   "31612341234".phony_formatted # => '06 12341234'
+    #   "31612341234".phony_formatted(:spaces => '-') # => '06-12341234'
+    def phony_formatted(options = {})
+      options[:format] ||= :national
+      Phony.formatted(self, options)
+    end
+
+  end

data/lib/phony_rails/version.rb

@@ -0,0 +1,3 @@
+module PhonyRails
+  VERSION = "0.0.4"
+end

data/lib/validators/phony_validator.rb

@@ -0,0 +1,12 @@
+# Uses the Phony.plausible method to validate an attribute.
+# Usage:
+#   validate :phone_number, :phony => true
+class PhonyValidator < ActiveModel::EachValidator
+
+  # Validates a String using Phony.plausible? method.
+  def validate_each(record, attribute, value)
+    return if value.blank?
+    record.errors[attribute] << (options[:message] || "is an invalid number") if not Phony.plausible?(value)
+  end
+
+end

data/phony_rails.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/phony_rails/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Joost Hietbrink"]
+  gem.email         = ["joost@joopp.com"]
+  gem.description   = %q{This Gem adds useful methods to your Rails app to validate, display and save phone numbers.}
+  gem.summary       = %q{This Gem adds useful methods to your Rails app to validate, display and save phone numbers.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "phony_rails"
+  gem.require_paths = ["lib"]
+  gem.version       = PhonyRails::VERSION
+
+  gem.add_dependency "phony", "~> 1.6.7"
+  gem.add_dependency "activerecord", "~> 3.0"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: phony_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Joost Hietbrink
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: phony
+  requirement: &70205545340880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *70205545340880
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70205545340380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70205545340380
+description: This Gem adds useful methods to your Rails app to validate, display and
+  save phone numbers.
+email:
+- joost@joopp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/phony_rails.rb
+- lib/phony_rails/string_extensions.rb
+- lib/phony_rails/version.rb
+- lib/validators/phony_validator.rb
+- phony_rails.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: This Gem adds useful methods to your Rails app to validate, display and save
+  phone numbers.
+test_files: []