phone_wrangler 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ryan Waldron
+
+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.rdoc

@@ -0,0 +1,18 @@
+= phone_wrangler
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Ryan Waldron. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "phone_wrangler"
+    gem.summary = %Q{Handle phone numbers intelligently}
+    gem.description = %Q{Handle phone numbers intelligently}
+    gem.email = "rew@erebor.com"
+    gem.homepage = "http://github.com/erebor/phone_wrangler"
+    gem.authors = ["Ryan Waldron"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "phone_wrangler #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/phone_wrangler.rb

@@ -0,0 +1,195 @@
+module PhoneWrangler
+
+  class PhoneNumber
+
+    NUMBER_PARTS = [:area_code, :prefix, :number, :extension]
+    attr_accessor :area_code, :prefix, :number, :extension
+
+    unless defined? @@default_area_code
+      @@default_area_code = nil
+    end
+
+    def self.default_area_code
+      @@default_area_code
+    end
+
+    def self.default_area_code=(val)
+      @@default_area_code = val
+    end
+
+    def default_area_code
+      @@default_area_code
+    end
+
+    #-------------------args-----------------------------------------
+    def initialize(args='')
+      @raw = args
+      self.[] args
+    end
+
+    def set(args)
+      self.[] args
+    end
+
+    def [] (args)
+      case args
+      when String
+        parse_from_string(args)
+      when Hash
+        args = { :area_code => PhoneNumber.default_area_code }.merge(args)
+        NUMBER_PARTS.each do |key|
+          send("#{key}=", args[key]) if args[key]
+        end
+      when Array
+        self.pack!(args)
+      else
+        raise ArgumentError.new("Sorry, can't handle arguments of type #{args.class}")
+      end
+    end
+
+    def has_area_code?
+      ! area_code.nil?
+    end
+
+    def == other
+      case other
+      when PhoneNumber
+        self.unpack == other.unpack
+      when String, Hash
+        self.unpack == PhoneNumber.new(other).unpack
+      else
+        false
+      end
+    end
+
+    #------------------------------------------------------------
+    def to_s(format = nil)
+      if format.nil?
+        format = ''
+        format += "(%a) " unless area_code.nil? or area_code.empty?
+        format += "%p-" unless prefix.nil? or area_code.empty?
+        format += "%n" unless number.nil? or area_code.empty?
+        format += " x%e" unless extension.nil? or area_code.empty?
+      end
+      format_number(format)
+    end
+
+    def raw
+      @raw
+    end
+
+    # TODO: Should #digits method include the extension digits at all?  Probably not
+    # with an 'x' anyway.
+    def digits
+      digitstring = ''
+      [:area_code, :prefix, :number].each {|part|
+        digitstring += self.send(part).to_s unless self.send(part).nil?
+      }
+      digitstring += " x#{extension}" unless extension.nil?
+      digitstring
+    end
+
+    # There are lots of regexp-for-phone-number dissussions, but I found this one most useful:
+    #   http://stackoverflow.com/questions/123559/a-comprehensive-regex-for-phone-number-validation
+    # Nice discussion here, and it had this one, which became the germ of mine.  I added optional
+    # parentheses around the area code, the /x and spacing for readability, and changed out \W for
+    # [.\/-] for the delimiters to tighten what I'd accept a little bit.
+    #
+    # The original was (in perl)
+    #   my $us_phone_regex = '1?\s*\W\s*([2-9][0-8][0-9])\W*([2-9][0-9]{2})\W*([0-9]{4})(\se?x?t?(\d*))?';
+
+    def parse_from_string(raw_string)
+      # Optional 1 -./ 256 (opt) 456 -./ 1234 ext(opt) 1234 (opt)
+      phone_regexp = /1? \s* [.\/-]? \s* [\(]?([2-9][0-8][0-9])?[\)]? \s* [.\/-]? \s* ([2-9][0-9]{2}) \s* [.\/-]? \s* ([0-9]{4}) \s* (\s*e?x?t?\s*(\d+))?/x
+      match = phone_regexp.match(raw_string)
+      if ! match.nil?
+        # puts "Setting values #{match.captures.pretty_inspect}"
+        @area_code = match.captures[0]
+        @prefix = match.captures[1]
+        @number = match.captures[2]
+        @extension = match.captures[4]
+      else
+        # puts "No matchy :("
+      end
+
+      if ! default_area_code.nil? and ( @area_code.nil? or @area_code.empty? )
+        @area_code = default_area_code
+      end
+    end
+
+    #------------------------------------------------------------
+    def pack(args)
+
+      phArea    = ''
+      phPrefix  = ''
+      phNumber  = ''
+      phExtension  = ''
+
+      if args.size >= 3
+        phArea    = args[0].to_s
+        phPrefix  = args[1].to_s
+        phNumber  = args[3].to_s
+        if args.size == 4
+          phExtension  = args[4].to_s
+        end
+      end
+
+      return phArea + phPrefix + phNumber + phExtension
+    end
+
+    #------------------------------------------------------------
+    def pack!(args)
+      @phone_number = pack(args)
+    end
+
+    #------------------------------------------------------------
+    def unpack
+      return {
+        :area_code => area_code,
+        :prefix => prefix,
+        :number => number,
+        :extension => extension
+      }
+    end
+
+    # This next part borrowed from http://github.com/erebor/phone/blob/master/lib/phone.rb
+    private
+
+    def format_number(fmt)
+      fmt.
+      #        gsub("%c", country_code || "").
+      gsub("%a", area_code || "").
+      gsub("%p", prefix || "").
+      #        gsub("%A", area_code_long || "").
+      gsub("%n", number || "").
+      #        gsub("%f", number1 || "").
+      #        gsub("%l", number2 || "").
+      gsub("%e", extension || "")
+    end
+
+  end
+
+end
+=begin
+   home = PhoneNumber.new('800/555-2468 x012')
+# or
+   home = PhoneNumber.new
+   home['800/555-2468 x012']
+# or
+#  home = PhoneNumber.new
+({:area_code=>'800', :prefix=>'555', :number=>'2020'})
+
+   puts home.raw
+   puts home.area_code
+   puts home.prefix
+   puts home.number
+   puts home.extension
+   puts home.to_s
+   puts home.to_s("(%a) %p-%n")
+   puts home.pack({:area_code=>'555', :prefix=>'888', :number=>'1212'})
+   p home.unpack
+   puts home.pack!({:area_code=>'555', :prefix=>'888', :number=>'1212'})
+   puts home.formatted
+
+=end
+

data/test/phone_wrangler_test.rb

@@ -0,0 +1,243 @@
+require 'test_helper'
+
+class PhoneWranglerTest < Test::Unit::TestCase
+
+  include PhoneWrangler
+
+  context "Parsing a phone number" do
+
+    should "accept a string" do
+      assert_nothing_raised do
+        pn = PhoneNumber.new("1234")
+      end
+    end
+
+    should "accept a hash" do
+      assert_nothing_raised do
+        pn = PhoneNumber.new(:area_code => '256', :prefix => '555', :number => '1234')
+      end
+    end
+
+    should "raise ArgumentError when passed silly args" do
+      assert_raise(ArgumentError) { PhoneNumber.new(3.77) }
+      assert_raise(ArgumentError) { PhoneNumber.new(false) }
+      assert_raise(ArgumentError) { PhoneNumber.new(/wicky/) }
+    end
+
+    should "return a PhoneNumber object" do
+      pn = PhoneNumber.new("123-456-7685")
+      assert_equal PhoneNumber, pn.class
+    end
+
+    should "correctly parse phone number strings" do
+      pn = PhoneNumber.new("(256) 555-1234")
+      assert_equal '256', pn.area_code
+      assert_equal '555', pn.prefix
+      assert_equal '1234', pn.number
+      assert pn.extension.nil?
+      pn = PhoneNumber.new("1-234-567-8901")
+      assert_equal '234', pn.area_code
+      assert_equal '567', pn.prefix
+      assert_equal '8901', pn.number
+      assert pn.extension.nil?
+      pn = PhoneNumber.new("1-234-567-8901x1234")
+      assert_equal '234', pn.area_code
+      assert_equal '567', pn.prefix
+      assert_equal '8901', pn.number
+      assert_equal '1234', pn.extension
+      pn = PhoneNumber.new("1-234-567-8901 x1234")
+      assert_equal '234', pn.area_code
+      assert_equal '567', pn.prefix
+      assert_equal '8901', pn.number
+      assert_equal '1234', pn.extension
+      pn = PhoneNumber.new("1-234-567-8901 ext 1234")
+      assert_equal '234', pn.area_code
+      assert_equal '567', pn.prefix
+      assert_equal '8901', pn.number
+      assert_equal '1234', pn.extension
+      pn = PhoneNumber.new("1-234-567-8901 ex1234")
+      assert_equal '234', pn.area_code
+      assert_equal '567', pn.prefix
+      assert_equal '8901', pn.number
+      assert_equal '1234', pn.extension
+      pn = PhoneNumber.new("1(234)567-8901x1234")
+      assert_equal '234', pn.area_code
+      assert_equal '567', pn.prefix
+      assert_equal '8901', pn.number
+      assert_equal '1234', pn.extension
+      pn = PhoneNumber.new("(234) 567-8901 x1234")
+      assert_equal '234', pn.area_code
+      assert_equal '567', pn.prefix
+      assert_equal '8901', pn.number
+      assert_equal '1234', pn.extension
+      pn = PhoneNumber.new("1(234) 567.8901 x1234")
+      assert_equal '234', pn.area_code
+      assert_equal '567', pn.prefix
+      assert_equal '8901', pn.number
+      assert_equal '1234', pn.extension
+      pn = PhoneNumber.new("1.234.567.8901 x1234")
+      assert_equal '234', pn.area_code
+      assert_equal '567', pn.prefix
+      assert_equal '8901', pn.number
+      assert_equal '1234', pn.extension
+      pn = PhoneNumber.new("234.567.8901 x1234")
+      assert_equal '234', pn.area_code
+      assert_equal '567', pn.prefix
+      assert_equal '8901', pn.number
+      assert_equal '1234', pn.extension
+      pn = PhoneNumber.new("234/567/8901 xt1234")
+      assert_equal '234', pn.area_code
+      assert_equal '567', pn.prefix
+      assert_equal '8901', pn.number
+      assert_equal '1234', pn.extension
+      pn = PhoneNumber.new("1 234.567/8901 xt1234")
+      assert_equal '234', pn.area_code
+      assert_equal '567', pn.prefix
+      assert_equal '8901', pn.number
+      assert_equal '1234', pn.extension
+      pn = PhoneNumber.new("1-234.567/8901 xt1234")
+      assert_equal '234', pn.area_code
+      assert_equal '567', pn.prefix
+      assert_equal '8901', pn.number
+      assert_equal '1234', pn.extension
+      pn = PhoneNumber.new("1/234.567/8901 xt1234")
+      assert_equal '234', pn.area_code
+      assert_equal '567', pn.prefix
+      assert_equal '8901', pn.number
+      assert_equal '1234', pn.extension
+      pn = PhoneNumber.new("12345678901x1234")
+      assert_equal '234', pn.area_code
+      assert_equal '567', pn.prefix
+      assert_equal '8901', pn.number
+      assert_equal '1234', pn.extension
+    end
+
+    should "correctly parse short phone number strings" do
+      pn = PhoneNumber.new("5678901x1234")
+      assert pn.area_code.nil?
+      assert_equal '567', pn.prefix
+      assert_equal '8901', pn.number
+      assert_equal '1234', pn.extension
+      pn = PhoneNumber.new("567-8901")
+      assert pn.area_code.nil?
+      assert_equal '567', pn.prefix
+      assert_equal '8901', pn.number
+      assert pn.extension.nil?
+      pn_short = PhoneNumber.new("456-7890")
+      pn_parts = PhoneNumber.new(:prefix => '456', :number => '7890')
+      assert_equal pn_parts, pn_short
+    end
+
+    should "allow a default area_code to be set for the class" do
+      PhoneNumber.default_area_code = "256"
+      assert_equal "256", PhoneNumber.default_area_code
+      PhoneNumber.default_area_code = nil  # put it back, it's a class attr
+    end
+  end
+
+  context "With a default_area_code set" do
+    setup do
+      PhoneNumber.default_area_code = "404"
+    end
+
+    teardown do
+      PhoneNumber.default_area_code = nil  # put it back, it's a class attr
+    end
+
+    should "use default area_code if one is not provided (String)" do
+      pn = PhoneNumber.new("456-7890")
+      assert_equal "404", pn.area_code
+    end
+
+    should "use default area_code if one is not provided (Hash)" do
+      pn = PhoneNumber.new(:prefix => '456', :number => "7890")
+      assert_equal "404", pn.area_code
+    end
+
+    should "ignore default_area_code if one is passed in (String)" do
+      pn = PhoneNumber.new("256-456-7890")
+      assert_equal "256", pn.area_code
+    end
+
+    should "ignore default_area_code if one is passed in (Hash)" do
+      pn = PhoneNumber.new(:area_code => '256', :prefix => '456', :number => "7890")
+      assert_equal "256", pn.area_code
+    end
+
+    should "return default area_code if it has one" do
+      assert_equal '404', PhoneNumber.default_area_code
+      PhoneNumber.default_area_code = nil  # put it back, it's a class attr
+      assert_equal nil, PhoneNumber.default_area_code
+    end
+
+    should "use default area_code in comparison is needed on either side" do
+      pn1 = PhoneNumber.new("456-7890")
+      pn2 = PhoneNumber.new("404-456-7890")
+      assert pn1 == pn2
+    end
+  end
+
+  context "Printing a phone number" do
+    setup do
+      @phone_hash = {:area_code => '256', :prefix => '555', :number => '1234'}
+      @pn = PhoneNumber.new(@phone_hash)
+    end
+
+    should "respond to to_s with a String" do
+      assert_equal String, @pn.to_s.class
+    end
+
+    should "format numbers properly with to_s" do
+      assert_equal "(256) 555-1234", @pn.to_s
+    end
+
+    should "correctly interpolate format string" do
+      assert_equal "256 FF 555--1234", @pn.to_s("%a FF %p--%n")
+      assert_equal "256-555-1234", @pn.to_s("%a-%p-%n")
+      assert_equal "256/555-1234", @pn.to_s("%a/%p-%n")
+      assert_equal "(256) 555-1234", @pn.to_s("(%a) %p-%n")
+      assert_equal "256.555.1234", @pn.to_s("%a.%p.%n")
+    end
+
+    should "correctly interpolate format string with missing elements" do
+      @pn = PhoneNumber.new("431-4310")
+      # Make sure to_s doesn't barf based on the requested elements in the format string
+      assert_equal " FF 431--4310", @pn.to_s("%a FF %p--%n")
+    end
+
+
+    should "return raw data" do
+      assert_equal @phone_hash, @pn.raw
+    end
+
+    should "provide a digits-only version" do
+      output = @pn.digits
+      assert /^\d+$/ === output
+      assert_equal @phone_hash[:area_code]+@phone_hash[:prefix]+@phone_hash[:number], output
+    end
+  end
+
+  context "Comparing phone numbers" do
+    setup do
+      @phone_hash = {:area_code => '256', :prefix => '555', :number => '1234'}
+      @pn = PhoneNumber.new(@phone_hash)
+    end
+
+    should "be equal to itself" do
+      assert @pn == @pn
+    end
+
+    should "be equal to an identical PhoneNumber" do
+      @pn_new = PhoneNumber.new(@phone_hash)
+      assert @pn == @pn_new
+    end
+
+    should "should return true when == to an equivalent String" do
+      assert @pn == "256-555-1234"
+    end
+
+    should "should return true when == to an equivalent Hash" do
+      assert @pn == {:area_code => '256', :prefix => '555', :number => '1234'}
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'phone_wrangler'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: phone_wrangler
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Ryan Waldron
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-13 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Handle phone numbers intelligently
+email: rew@erebor.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/phone_wrangler.rb
+- test/phone_wrangler_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/erebor/phone_wrangler
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Handle phone numbers intelligently
+test_files: 
+- test/phone_wrangler_test.rb
+- test/test_helper.rb