happy_phone_number 0.0.2 → 0.0.3

data/README.markdown

@@ -37,6 +37,11 @@ Or in uppercase if you prefer:
     <%= @contact.happy_phone(:FR) %>
     #=> "01 23 45 67 89"
 
+Or maybe with a string:
+
+    <%= @contact.happy_phone('fr') %>
+    #=> "01 23 45 67 89"
+
 If you want an international format:
 
     <%= @contact.happy_inter_phone(:fr) %>
@@ -75,19 +80,16 @@ Now, imagine you live in Belgium, where phone numbers could have 2 formats:
 And if *Happy Phone Number* don't know your country, you could use a
 **mask formatting**:
 
-    <%= @contact.happy_phone("#### ###-###") %>
+    <%= @contact.happy_mask_phone("#### ###-###") %>
     #=> "0123 456-789"
 
-### Caveats
-
-*Mask formatting* doesn't work for international phone number format.
 
 Install
 -------------------------
 
 Add this line in your Gemfile:
 
-    gem 'happy_phone_number', :git => 'git://github.com/lkdjiin/happy_phone_number.git'
+    gem 'happy_phone_number'
 
 
 Usage

data/lib/happy_phone_number.rb

@@ -18,13 +18,16 @@ require 'happy_phone_number/base_format'
 #   <%= @contact.happy_phone(:fr) %>
 #   # => "01 23 45 67 89"
 #
+#   <%= @contact.happy_phone('fr') %>
+#   # => "01 23 45 67 89"
+#
 #   <%= @contact.happy_inter_phone(:fr) %>
 #   # => "+33 1 23 45 67 89"
 #
 #   <%= @contact.happy_phone(:be) %>
 #   # => "03 111 22 33"
 #
-#   <%= @contact.happy_phone("#### ###-###") %>
+#   <%= @contact.happy_mask_phone("#### ###-###") %>
 #   # => "0123 456-789"
 module HappyPhoneNumber
   extend ActiveSupport::Concern
@@ -39,23 +42,29 @@ module HappyPhoneNumber
 
   # Public: Format a phone number from a model.
   #
-  # args[0] - Either a Symbol country or a String formatting mask.
-  #           A country symbol must be in ISO 3166-1-alpha-2 format,
+  # args[0] - Either a Symbol|String country or a String formatting mask.
+  #           A country must be in ISO 3166-1-alpha-2 format,
   #           both lower and upper case are valids.
   # block   - Not used.
   #
   # Signature
   #
-  #   happy_<field>(country_or_mask, separator)
-  #   happy_inter_<field>(country_or_mask, separator)
+  #   happy_<field>(country, separator)
+  #   happy_inter_<field>(country, separator)
+  #   happy_mask_<field>(mask)
   #
-  # field - A field name of the model that holds a phone number as a
-  #         string.
+  # field     - A field name of the model that holds a phone number as a
+  #             string.
+  # country   - Symbol or String in ISO 3166-1-alpha-2 format.
+  # separator - A String used to separate groups of number.
+  # mask      - A String formatting mask.
   #
   # Returns the String formatted phone number.
   def method_missing(meth, *args, &block)
     if meth.to_s =~ /^happy_inter_(.+)$/
       happy_format(:international, $1, *args)
+    elsif meth.to_s =~ /^happy_mask_(.+)$/
+      happy_format(:mask, $1, *args)
     elsif meth.to_s =~ /^happy_(.+)$/
       happy_format(:national, $1, *args)
     else
@@ -76,7 +85,7 @@ module HappyPhoneNumber
 
   # Launch the formatting process.
   #
-  # type - Either :national or :international.
+  # type - Either :national, :international or :mask.
   # meth - The String field from the model.
   # args - Argument(s) passed to the formatting method, like a country,
   #        a mask string, the separator.

data/lib/happy_phone_number/formatter.rb

@@ -8,9 +8,9 @@ module HappyPhoneNumber
     # Internal: Initialize the formatter facade.
     #
     # phone           - A String phone number to format.
-    # type            - Either :national or :international.
-    # country_or_mask - If it's a country, must be a two-letters Symbol.
-    #                   If it's a String, it is considered as a mask.
+    # type            - :national | :international | :mask.
+    # country_or_mask - The country as Symbol or String in
+    #                   ISO 3166-1-alpha-2, or a String mask.
     # separator       - Optional, a String to separate groups of digits
     #                   the final result.
     def initialize phone, type, country_or_mask, separator
@@ -24,7 +24,7 @@ module HappyPhoneNumber
     #
     # Returns the String formatted phone number.
     def format
-      if @country_or_mask.class == String
+      if @type == :mask
         use_mask
       else
         use_formatter

data/lib/happy_phone_number/version.rb

@@ -1,3 +1,3 @@
 module HappyPhoneNumber
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: happy_phone_number
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   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-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails