Class: Phone

Inherits:
Object
  • Object
show all
Defined in:
lib/phone.rb

Constant Summary collapse

NUMBER = 
'([^0][0-9]{1,7})$'
DEFAULT_AREA_CODE =

USA

'[2-9][0-8][0-9]'
@@n1_length =

default length of first number part

3
@@named_formats = 
{
  :default => "+%c%a%n",
  :europe => '+%c (0) %a %f %l',
  :us => "(%a) %f-%l"
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*hash_or_args) ⇒ Phone

Returns a new instance of Phone.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/phone.rb', line 35

def initialize(*hash_or_args)    
  if hash_or_args.first.is_a?(Hash)
    hash_or_args = hash_or_args.first
    keys = {:number => :number, :area_code => :area_code, :country_code => :country_code}
  else
    keys = {:number => 0, :area_code => 1, :country_code => 2}
  end
  
  self.number = hash_or_args[ keys[:number] ]
  self.area_code = hash_or_args[ keys[:area_code] ] || self.default_area_code
  self.country_code = hash_or_args[ keys[:country_code] ] || self.default_country_code      

  raise "Must enter number" if self.number.blank?
  raise "Must enter area code or set default area code" if self.area_code.blank?
  raise "Must enter country code or set default country code" if self.country_code.blank?    
end

Instance Attribute Details

#area_code ⇒ Object

Returns the value of attribute area_code.



18
19
20
 
# File 'lib/phone.rb', line 18

def area_code
  @area_code
end

#country_code ⇒ Object

Returns the value of attribute country_code.



18
19
20
 
# File 'lib/phone.rb', line 18

def country_code
  @country_code
end

#number ⇒ Object

Returns the value of attribute number.



18
19
20
 
# File 'lib/phone.rb', line 18

def number
  @number
end

Class Method Details

.detect_country(string) ⇒ Object

detect country from the string entered



113
114
115
116
117
118
119
120
121
122
 
# File 'lib/phone.rb', line 113

def self.detect_country(string)
  detected_country = nil
  # find if the number has a country code
  PhoneCountry.all.each_pair do |country_code, country|
    if string =~ country.country_code_regexp
      detected_country = country
    end
  end
  detected_country    
end

.detect_format(string_with_number, country) ⇒ Object

detect format (from FORMATS) of input string



135
136
137
138
139
140
141
142
143
 
# File 'lib/phone.rb', line 135

def self.detect_format(string_with_number, country)
  arr = []
  formats(country).each_pair do |format, regexp|
    arr << format if string_with_number =~ regexp
  end
  
  raise "Detected more than 1 format for #{string_with_number}" if arr.size > 1
  arr.first
end

.formats(country) ⇒ Object 



124
125
126
127
128
129
130
131
132
 
# File 'lib/phone.rb', line 124

def self.formats(country)
  area_code_regexp = country.area_code || DEFAULT_AREA_CODE
  {
    # 047451588, 013668734
    :short => Regexp.new('^0(' + area_code_regexp + ')' + NUMBER),
    # 451588
    :really_short => Regexp.new('^' + NUMBER)
  }    
end

.normalize(string_with_number) ⇒ Object

fix string so it’s easier to parse, remove extra characters etc.



146
147
148
 
# File 'lib/phone.rb', line 146

def self.normalize(string_with_number)
  string_with_number.gsub("(0)", "").gsub(/[^0-9+]/, '').gsub(/^00/, '+')
end

.parse(string, options = {}) ⇒ Object

create a new phone number by parsing a string the format of the string is detect automatically (from FORMATS)



54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/phone.rb', line 54

def self.parse(string, options={})       
  if string.present?    
    PhoneCountry.load
    string = normalize(string)
    
    options[:country_code] ||= self.default_country_code
    options[:area_code] ||= self.default_area_code         
    
    parts = split_to_parts(string, options)      
    
    pn = Phone.new(parts) if parts
  end
end

.split_to_parts(string, options = {}) ⇒ Object

split string into hash with keys :country_code, :area_code and :number



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/phone.rb', line 78

def self.split_to_parts(string, options = {})
  country = detect_country(string)
  
  if country
    options[:country_code] = country.country_code      
    string = string.gsub(country.country_code_regexp, '0')
  else
    if options[:country_code]
      country = PhoneCountry.find_by_country_code options[:country_code]
    end
  end
  
  if country.nil?
    if options[:country_code].nil?
      raise "Must enter country code or set default country code"
    else
      raise "Could not find country with country code #{options[:country_code]}"
    end
  end
          
  format = detect_format(string, country)
  
  return nil if format.nil?    

  parts = string.match formats(country)[format]

  case format  
    when :short
      {:number => parts[2], :area_code => parts[1], :country_code => options[:country_code]}            
    when :really_short
      {:number => parts[1], :area_code => options[:area_code], :country_code => options[:country_code]}                      
  end    
end

.valid?(string) ⇒ Boolean

is this string a valid phone number?

Returns:

  • (Boolean) 


69
70
71
72
73
74
75
 
# File 'lib/phone.rb', line 69

def self.valid?(string)
  begin
    parse(string).present?
  rescue RuntimeError # if we encountered exceptions (missing country code, missing area code etc)
    return false
  end
end

Instance Method Details

#area_code_long ⇒ Object

format area_code with trailing zero (e.g. 91 as 091)



151
152
153
 
# File 'lib/phone.rb', line 151

def area_code_long
  "0" + area_code if area_code
end

#format(fmt) ⇒ Object

Formats the phone number.

if the method argument is a String, it is used as a format string, with the following fields being interpolated:

  • %c - country_code (385)

  • %a - area_code (91)

  • %A - area_code with leading zero (091)

  • %n - number (5125486)

  • %n1 - first @@n1_length characters of number (configured through Phone.n1_length), default is 3 (512)

  • %n2 - last characters of number (5486)

if the method argument is a Symbol, it is used as a lookup key for a format String in Phone.named_formats

pn.format(:europe)



179
180
181
182
183
184
185
186
 
# File 'lib/phone.rb', line 179

def format(fmt)    
  if fmt.is_a?(Symbol)
    raise "The format #{fmt} doesn't exist'" unless named_formats.has_key?(fmt)
    format_number named_formats[fmt]
  else
    format_number(fmt)
  end
end

#has_default_area_code? ⇒ Boolean

does this number belong to the default area code?

Returns:

  • (Boolean) 


199
200
201
 
# File 'lib/phone.rb', line 199

def has_default_area_code?
  area_code == self.class.default_area_code
end

#has_default_country_code? ⇒ Boolean

does this number belong to the default country code?

Returns:

  • (Boolean) 


194
195
196
 
# File 'lib/phone.rb', line 194

def has_default_country_code?
  country_code == self.class.default_country_code
end

#number1 ⇒ Object

first n characters of :number



156
157
158
 
# File 'lib/phone.rb', line 156

def number1
  number[0...self.class.n1_length]
end

#number2 ⇒ Object

everything left from number after the first n characters (see number1)



161
162
163
164
 
# File 'lib/phone.rb', line 161

def number2
  n2_length = number.size - self.class.n1_length
  number[-n2_length, n2_length]
end

#to_s ⇒ Object

the default format is “+%c%a%n”



189
190
191
 
# File 'lib/phone.rb', line 189

def to_s
  format(:default)
end