uk_phone_numbers 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+
+gemspec
+
+group :development do
+  gem "guard", "~> 0.8.8"
+  if RUBY_PLATFORM.downcase.include?("darwin")
+    gem "guard-rspec", "~> 0.5.4"
+    gem "rb-fsevent", "~> 0.9"
+    gem "growl", "~> 1.0.3"
+  end
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 GoCardless
+
+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,30 @@
+# uk_phone_numbers
+
+A Ruby library for validating and formatting UK phone numbers.
+
+## Installation
+
+```console
+$ gem install uk_phone_numbers
+```
+
+## Usage
+
+### Validating a phone number
+
+```ruby
+require 'uk_phone_numbers'
+
+UKPhoneNumbers.valid? "02087123456"
+# => true
+```
+
+### Formatting a phone number
+
+```ruby
+require 'uk_phone_numbers'
+
+UKPhoneNumbers.format "02087123456"
+# => "020 8712 3456"
+```
+

data/lib/uk_phone_numbers/version.rb

@@ -0,0 +1,3 @@
+module UKPhoneNumbers
+  VERSION = '0.1.0'
+end

data/lib/uk_phone_numbers.rb

@@ -0,0 +1,54 @@
+module UKPhoneNumbers
+  # http://www.area-codes.org.uk/formatting.shtml#programmers
+  PATTERNS = <<-PATTERNS
+    (01###) #####[#]
+    (011#) ### ####
+    (01#1) ### ####
+    (013873) #####
+    (015242) #####
+    (015394) #####
+    (015395) #####
+    (015396) #####
+    (016973) #####
+    (016974) #####
+    (016977) ####[#]
+    (017683) #####
+    (017684) #####
+    (017687) #####
+    (019467) #####
+    (02#) #### ####
+    03## ### ####
+    05### ######
+    0500 ######
+    07### ######
+    08## ### ###[#]
+    09## ### ####
+  PATTERNS
+
+  def self.pattern_to_regexp(pattern)
+    regexp = pattern.dup
+    regexp.gsub!(/[()]/, '')
+    regexp = regexp.split.map { |p| "(#{p})" }.join
+    regexp.gsub!(/\[([^\]]*)\]/, '(?:\1)?')
+    regexp.gsub!(/#/, '\d')
+    Regexp.new("^#{regexp}$")
+  end
+
+  REGEXPS = []
+  # Convert each of the patterns to a regexp
+  PATTERNS.split("\n").map(&:strip).each do |pattern|
+    REGEXPS << pattern_to_regexp(pattern)
+  end
+  # Reverse-sort the regexps by how many digits they contain (their specificity)
+  REGEXPS.sort_by! { |r| -r.source.scan(/\d/).length }
+
+  def self.valid?(number)
+    REGEXPS.select { |r| r.match(number) }.any?
+  end
+
+  def self.format(number, opts = {})
+    match = REGEXPS.map { |r| r.match(number) }.reject(&:nil?).first
+    match ? match[1..-1].join(opts[:separator] || ' ') : false
+  end
+end
+

data/spec/uk_phone_numbers_spec.rb

@@ -0,0 +1,71 @@
+require 'uk_phone_numbers'
+
+describe UKPhoneNumbers do
+  describe "::REGEXPS" do
+    subject { UKPhoneNumbers::REGEXPS }
+    it { should have(UKPhoneNumbers::PATTERNS.split("\n").length).items }
+  end
+
+  describe ".pattern_to_regexp" do
+    def regexp_for(pattern)
+      subject.pattern_to_regexp(pattern).source
+    end
+
+    it "given a String pattern returns a Regexp" do
+      subject.pattern_to_regexp("0#").should be_a Regexp
+    end
+
+    it "strips parens from the pattern" do
+      regexp_for("()").should == "^$"
+    end
+
+    it "parenthesises whitespace-separated sections" do
+      regexp_for("0 12 345").should == "^(0)(12)(345)$"
+    end
+
+    it "replaces # with \\d" do
+      regexp_for("0#").should == "^(0\\d)$"
+    end
+
+    it "replaces bracketed expressions with optional non-capturing groups" do
+      regexp_for("0[12]3[4]5").should == "^(0(?:12)?3(?:4)?5)$"
+    end
+
+    it "handles hashes inside brackets" do
+      regexp_for("0[#]1[#]2").should == "^(0(?:\\d)?1(?:\\d)?2)$"
+    end
+  end
+
+  describe ".valid?" do
+    it "returns true for matching numbers" do
+      subject.valid?('08456123123').should be_true
+    end
+
+    it "returns false for invalid numbers" do
+      subject.valid?('08456123123123').should be_false
+    end
+  end
+
+  describe ".format" do
+    it "returns false for invalid numbers" do
+      subject.format('08456123123123').should be_false
+    end
+
+    it "formats long-prefix numbers correctly" do
+      subject.format('01946700000').should == '019467 00000'
+    end
+
+    it "formats mobile numbers correctly" do
+      subject.format('07900000000').should == '07900 000000'
+    end
+
+    it "formats 08xx numbers correctly" do
+      subject.format('08456123123').should == '0845 612 3123'
+    end
+
+    it "uses a custom separator when provided" do
+      subject.format('08456123123', separator: '-').should == '0845-612-3123'
+    end
+  end
+end
+

data/uk_phone_numbers.gemspec

@@ -0,0 +1,15 @@
+require File.expand_path('../lib/uk_phone_numbers/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = 'uk_phone_numbers'
+  gem.version = UKPhoneNumbers::VERSION.dup
+  gem.authors = ['Harry Marr']
+  gem.email = ['harry@gocardless.com']
+  gem.summary = 'A Ruby library for parsing and formatting UK phone numbers.'
+  gem.homepage = 'https://github.com/gocardless/uk_phone_numbers'
+
+  gem.add_development_dependency 'rspec', '~> 2.6'
+
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- spec/*`.split("\n")
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: uk_phone_numbers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Harry Marr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70215946414560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *70215946414560
+description: 
+email:
+- harry@gocardless.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- lib/uk_phone_numbers.rb
+- lib/uk_phone_numbers/version.rb
+- spec/uk_phone_numbers_spec.rb
+- uk_phone_numbers.gemspec
+homepage: https://github.com/gocardless/uk_phone_numbers
+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: A Ruby library for parsing and formatting UK phone numbers.
+test_files:
+- spec/uk_phone_numbers_spec.rb