phone_number_validator 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b738d275e832cd19f6c417322269515b14b7e9ec786c05b59b86507f409640d0
-  data.tar.gz: 46e37e8449934765e5ba28dfcc115b21b9d1c5b79d7a22dc3c12b684fc03d0f7
+  metadata.gz: a245dadacf3c7b6a0f70d0fb94e3f55c04ce1f0e1bb24a7efd14c9f311610367
+  data.tar.gz: 5b0b597c2ecc2c97ee4a0a9e623c8adfcfe811ce6b1f12b32fee74b6a5a93d63
 SHA512:
-  metadata.gz: 4feb0d85c93e2ef0e910143ad541da07281341636fda1802c7f983c35ad4cb944ed81fe227389ea866c3325e0d031971a2f947f1319c0bebdf92b36b8583a1ca
-  data.tar.gz: 1324734c3632fb52f4844bab466bada595565a112568d7135c8abc7437533800586d33fcb07090123ef9e939280a36599120a797aab31648cee92421c36cafb0
+  metadata.gz: 26d36e027e39d44870136436d73928a2bb861abb89aff986da427ae64d279be71d41b5aaf44429ab25266c6e24477130cb8ffdc42746e21417cb7f08d9ace0b5
+  data.tar.gz: 8c061cced1b200fe335d4aac1cda1a0f71c0ed2efdf8d8a2581be5536c8b17dd49226c80634dcc7c44707d0f5d010cbc7c0f6af98e35df4bc0a6fb9495783bc0

data/README.rdoc

@@ -10,7 +10,7 @@ It uses a complex regular expression to validate any United States phone number.
 
 This gem uses the following regular expression:
 
-  PHONE_NUMBER_REGEX = Regexp.new(/^(?:(?:[2-9]11)|(?:(?:\+?1\s*(?:[.-]\s*)?)?(?:\(\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\s*\)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\s*(?:[.-]\s*)?)?([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\s*(?:[.-]\s*)?([0-9]{4})(?:\s*(?:\x20+|#|x\.?|ext\.?|extension)\s*(\d+))?)$/, Regexp::IGNORECASE)
+  PHONE_NUMBER_REGEX = Regexp.new(/^(?:(?:[2-9]11)|(?:(?:\+?1\s*(?:[.-]\s*)?)?(?:\(\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\s*\)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\s*(?:[.-]\s*)?)?([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\s*(?:[.-]\s*)?([0-9]{4})(?:\s*(?:\x20+|#|x\.?|ext\.?|extension)\s*(\d+))?)$/, Regexp::IGNORECASE) # US Phone Numbers
 
 == Installing
 

data/doc/PhoneNumberValidator/Validator.html

@@ -106,7 +106,19 @@
       
         <dt id="PHONE_NUMBER_REGEX">PHONE_NUMBER_REGEX
         
-        <dd>
+        <dd><h2 id="label-Validates+US+Phone+Numbers">Validates US Phone Numbers<span><a href="#label-Validates+US+Phone+Numbers">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<p>Regular Expression tested using <a
+href="https://regexr.com/">regexr.com</a></p>
+
+<p><strong>Raw Regular Expression:</strong></p>
+
+<pre class="ruby"><span class="ruby-node">/^(?:(?:[2-9]11)|(?:(?:\+?1\s*(?:[.-]\s*)?)?(?:\(\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\s*\)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\s*(?:[.-]\s*)?)?([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\s*(?:[.-]\s*)?([0-9]{4})(?:\s*(?:\x20+|#|x\.?|ext\.?|extension)\s*(\d+))?)$/i</span>
+</pre>
+
+<p><strong>RegEx Flags:</strong></p>
+
+<pre>Regexp::IGNORECASE: (i)</pre>
         
       
       </dl>
@@ -135,16 +147,18 @@
 
         <div class="method-description">
           
-          
+          <h2 id="method-c-new-label-Initialize+Phone+Number">Initialize Phone Number<span><a href="#method-c-new-label-Initialize+Phone+Number">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<p><strong>Method type: constructor</strong></p>
           
           
 
           
           <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/phone_number_validator/validator.rb, line 3</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">phone_number</span> = <span class="ruby-string">&#39;+1 (949) 355-6244 ext. 198842&#39;</span>)
-  <span class="ruby-ivar">@phone_number</span> = <span class="ruby-identifier">phone_number</span>
-<span class="ruby-keyword">end</span></pre>
+            <pre><span class="ruby-comment"># File lib/phone_number_validator/validator.rb, line 19</span>
+    <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">phone_number</span> = <span class="ruby-string">&#39;+1 (949) 355-6244 ext. 198842&#39;</span>)
+<span class="ruby-ivar">@phone_number</span> = <span class="ruby-identifier">phone_number</span>
+    <span class="ruby-keyword">end</span></pre>
           </div>
           
         </div>
@@ -176,13 +190,25 @@
 
         <div class="method-description">
           
-          
+          <h2 id="method-i-validate_phone_number-label-Validation+Method">Validation Method<span><a href="#method-i-validate_phone_number-label-Validation+Method">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<p>Checks to see if the phone number the user entered is valid by testing
+regex the pattern with the phone number</p>
+
+<p>Return Type:</p>
+
+<pre class="ruby"><span class="ruby-identifier">boolean</span>
+</pre>
+
+<p>Parameters:</p>
+
+<pre>@phone_number: (String instance)</pre>
           
           
 
           
           <div class="method-source-code" id="validate_phone_number-source">
-            <pre><span class="ruby-comment"># File lib/phone_number_validator/validator.rb, line 6</span>
+            <pre><span class="ruby-comment"># File lib/phone_number_validator/validator.rb, line 34</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">validate_phone_number</span>
   <span class="ruby-keyword">if</span> (<span class="ruby-constant">PHONE_NUMBER_REGEX</span>.<span class="ruby-identifier">match</span>(<span class="ruby-ivar">@phone_number</span>))
     <span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;&#39;%s&#39; is a valid phone number.&quot;</span> <span class="ruby-operator">%</span> <span class="ruby-ivar">@phone_number</span>

data/doc/PhoneNumberValidator.html

@@ -85,6 +85,8 @@
 
   <section class="description">
     
+<h1 id="class-PhoneNumberValidator-label-Phone+Number+Validator+Parent+Class">Phone Number Validator Parent Class<span><a href="#class-PhoneNumberValidator-label-Phone+Number+Validator+Parent+Class">&para;</a> <a href="#top">&uarr;</a></span></h1>
+
   </section>
 
   
@@ -123,19 +125,23 @@
 
 <p>Example:</p>
 
-<pre>&gt;&gt; PhoneNumberValidator.validate_phone_number(&#39;+1 (949) 355-6244 ext. 198842&#39;)
-=&gt; &#39;+1 (949) 355-6244 ext. 198842&#39; is a valid phone number.&#39;
+<pre class="ruby"><span class="ruby-constant">PhoneNumberValidator</span>.<span class="ruby-identifier">validate_phone_number</span>(<span class="ruby-string">&#39;+1 (949) 355-6244 ext. 198842&#39;</span>)
+</pre>
+
+<p>Output:</p>
+
+<pre>=&gt; &#39;+1 (949) 355-6244 ext. 198842&#39; is a valid phone number.&#39;
 =&gt; true</pre>
 
 <p>Arguments:</p>
 
-<pre>phone_no: (String)</pre>
+<pre>phone_number: (String)</pre>
           
           
 
           
           <div class="method-source-code" id="validate_phone_number-source">
-            <pre><span class="ruby-comment"># File lib/phone_number_validator.rb, line 12</span>
+            <pre><span class="ruby-comment"># File lib/phone_number_validator.rb, line 18</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">validate_phone_number</span>(<span class="ruby-identifier">phone_number</span>)
   <span class="ruby-identifier">validator</span> = <span class="ruby-constant">Validator</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">phone_number</span>)
   <span class="ruby-identifier">validator</span>.<span class="ruby-identifier">validate_phone_number</span>

data/doc/PhoneNumberValidatorTest.html

@@ -87,6 +87,8 @@
 
   <section class="description">
     
+<h1 id="class-PhoneNumberValidatorTest-label-Phone+Number+Validator+Test+Class">Phone Number Validator Test Class<span><a href="#class-PhoneNumberValidatorTest-label-Phone+Number+Validator+Test+Class">&para;</a> <a href="#top">&uarr;</a></span></h1>
+
   </section>
 
   
@@ -121,13 +123,15 @@
 
         <div class="method-description">
           
-          
+          <h2 id="method-i-test_invalid_phone_number-label-Negative+Test">Negative Test<span><a href="#method-i-test_invalid_phone_number-label-Negative+Test">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<p>Inputs an invalid phone number and expects the output to be <em>false</em></p>
           
           
 
           
           <div class="method-source-code" id="test_invalid_phone_number-source">
-            <pre><span class="ruby-comment"># File test/test_phone_number_validator.rb, line 9</span>
+            <pre><span class="ruby-comment"># File test/test_phone_number_validator.rb, line 21</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">test_invalid_phone_number</span>
   <span class="ruby-identifier">assert_equal</span> <span class="ruby-keyword">false</span>,
   <span class="ruby-constant">PhoneNumberValidator</span>.<span class="ruby-identifier">validate_phone_number</span>(<span class="ruby-string">&#39;94643823637337&#39;</span>)
@@ -155,13 +159,15 @@
 
         <div class="method-description">
           
-          
+          <h2 id="method-i-test_valid_phone_number-label-Positive+Test">Positive Test<span><a href="#method-i-test_valid_phone_number-label-Positive+Test">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<p>Inputs a valid phone number and expects the output to be <em>true</em></p>
           
           
 
           
           <div class="method-source-code" id="test_valid_phone_number-source">
-            <pre><span class="ruby-comment"># File test/test_phone_number_validator.rb, line 5</span>
+            <pre><span class="ruby-comment"># File test/test_phone_number_validator.rb, line 12</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">test_valid_phone_number</span>
   <span class="ruby-identifier">assert_equal</span> <span class="ruby-keyword">true</span>,
   <span class="ruby-constant">PhoneNumberValidator</span>.<span class="ruby-identifier">validate_phone_number</span>(<span class="ruby-string">&#39;+1 (949) 355-6244 ext. 198842&#39;</span>)

data/doc/README_rdoc.html

@@ -100,7 +100,7 @@ number.</p>
 
 <p>This gem uses the following regular expression:</p>
 
-<pre class="ruby"><span class="ruby-constant">PHONE_NUMBER_REGEX</span> = <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">/^(?:(?:[2-9]11)|(?:(?:\+?1\s*(?:[.-]\s*)?)?(?:\(\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\s*\)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\s*(?:[.-]\s*)?)?([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\s*(?:[.-]\s*)?([0-9]{4})(?:\s*(?:\x20+|#|x\.?|ext\.?|extension)\s*(\d+))?)$/</span>, <span class="ruby-constant">Regexp</span><span class="ruby-operator">::</span><span class="ruby-constant">IGNORECASE</span>)
+<pre class="ruby"><span class="ruby-constant">PHONE_NUMBER_REGEX</span> = <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">/^(?:(?:[2-9]11)|(?:(?:\+?1\s*(?:[.-]\s*)?)?(?:\(\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\s*\)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\s*(?:[.-]\s*)?)?([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\s*(?:[.-]\s*)?([0-9]{4})(?:\s*(?:\x20+|#|x\.?|ext\.?|extension)\s*(\d+))?)$/</span>, <span class="ruby-constant">Regexp</span><span class="ruby-operator">::</span><span class="ruby-constant">IGNORECASE</span>) <span class="ruby-comment"># US Phone Numbers</span>
 </pre>
 
 <h2 id="label-Installing">Installing<span><a href="#label-Installing">&para;</a> <a href="#top">&uarr;</a></span></h2>

data/doc/created.rid

@@ -1,6 +1,6 @@
-Sun, 04 Nov 2018 16:15:14 -0800
-README.rdoc	Sun, 04 Nov 2018 16:14:44 -0800
-lib/phone_number_validator.rb	Sun, 04 Nov 2018 16:15:03 -0800
-lib/phone_number_validator/validator.rb	Sun, 04 Nov 2018 16:14:50 -0800
-test/test_phone_number_validator.rb	Sun, 04 Nov 2018 11:53:56 -0800
+Sun, 04 Nov 2018 16:47:20 -0800
+README.rdoc	Sun, 04 Nov 2018 16:18:04 -0800
+lib/phone_number_validator.rb	Sun, 04 Nov 2018 16:46:30 -0800
+lib/phone_number_validator/validator.rb	Sun, 04 Nov 2018 16:46:13 -0800
+test/test_phone_number_validator.rb	Sun, 04 Nov 2018 16:46:16 -0800
 bin/phone_number_validator	Sun, 04 Nov 2018 14:35:10 -0800

data/doc/index.html

@@ -95,7 +95,7 @@ number.</p>
 
 <p>This gem uses the following regular expression:</p>
 
-<pre class="ruby"><span class="ruby-constant">PHONE_NUMBER_REGEX</span> = <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">/^(?:(?:[2-9]11)|(?:(?:\+?1\s*(?:[.-]\s*)?)?(?:\(\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\s*\)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\s*(?:[.-]\s*)?)?([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\s*(?:[.-]\s*)?([0-9]{4})(?:\s*(?:\x20+|#|x\.?|ext\.?|extension)\s*(\d+))?)$/</span>, <span class="ruby-constant">Regexp</span><span class="ruby-operator">::</span><span class="ruby-constant">IGNORECASE</span>)
+<pre class="ruby"><span class="ruby-constant">PHONE_NUMBER_REGEX</span> = <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">/^(?:(?:[2-9]11)|(?:(?:\+?1\s*(?:[.-]\s*)?)?(?:\(\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\s*\)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\s*(?:[.-]\s*)?)?([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\s*(?:[.-]\s*)?([0-9]{4})(?:\s*(?:\x20+|#|x\.?|ext\.?|extension)\s*(\d+))?)$/</span>, <span class="ruby-constant">Regexp</span><span class="ruby-operator">::</span><span class="ruby-constant">IGNORECASE</span>) <span class="ruby-comment"># US Phone Numbers</span>
 </pre>
 
 <h2 id="label-Installing">Installing<span><a href="#label-Installing">&para;</a> <a href="#top">&uarr;</a></span></h2>

data/doc/js/search_index.js

@@ -1 +1 @@
-var search_data = {"index":{"searchIndex":["phonenumbervalidator","validator","phonenumbervalidatortest","new()","test_invalid_phone_number()","test_valid_phone_number()","validate_phone_number()","validate_phone_number()","readme"],"longSearchIndex":["phonenumbervalidator","phonenumbervalidator::validator","phonenumbervalidatortest","phonenumbervalidator::validator::new()","phonenumbervalidatortest#test_invalid_phone_number()","phonenumbervalidatortest#test_valid_phone_number()","phonenumbervalidator::validate_phone_number()","phonenumbervalidator::validator#validate_phone_number()",""],"info":[["PhoneNumberValidator","","PhoneNumberValidator.html","",""],["PhoneNumberValidator::Validator","","PhoneNumberValidator/Validator.html","",""],["PhoneNumberValidatorTest","","PhoneNumberValidatorTest.html","",""],["new","PhoneNumberValidator::Validator","PhoneNumberValidator/Validator.html#method-c-new","(phone_number = '+1 (949) 355-6244 ext. 198842')",""],["test_invalid_phone_number","PhoneNumberValidatorTest","PhoneNumberValidatorTest.html#method-i-test_invalid_phone_number","()",""],["test_valid_phone_number","PhoneNumberValidatorTest","PhoneNumberValidatorTest.html#method-i-test_valid_phone_number","()",""],["validate_phone_number","PhoneNumberValidator","PhoneNumberValidator.html#method-c-validate_phone_number","(phone_number)","<p>Validate any United States phone number!\n<p>Example:\n\n<pre>&gt;&gt; PhoneNumberValidator.validate_phone_number(&#39;+1 (949) ...</pre>\n"],["validate_phone_number","PhoneNumberValidator::Validator","PhoneNumberValidator/Validator.html#method-i-validate_phone_number","()",""],["README","","README_rdoc.html","","<p>Phone Number Validator\n<p>About\n<p>This app is a US phone number-validating RubyGem.\n"]]}}
+var search_data = {"index":{"searchIndex":["phonenumbervalidator","validator","phonenumbervalidatortest","new()","test_invalid_phone_number()","test_valid_phone_number()","validate_phone_number()","validate_phone_number()","readme"],"longSearchIndex":["phonenumbervalidator","phonenumbervalidator::validator","phonenumbervalidatortest","phonenumbervalidator::validator::new()","phonenumbervalidatortest#test_invalid_phone_number()","phonenumbervalidatortest#test_valid_phone_number()","phonenumbervalidator::validate_phone_number()","phonenumbervalidator::validator#validate_phone_number()",""],"info":[["PhoneNumberValidator","","PhoneNumberValidator.html","","<p>Phone Number Validator Parent Class\n"],["PhoneNumberValidator::Validator","","PhoneNumberValidator/Validator.html","",""],["PhoneNumberValidatorTest","","PhoneNumberValidatorTest.html","","<p>Phone Number Validator Test Class\n"],["new","PhoneNumberValidator::Validator","PhoneNumberValidator/Validator.html#method-c-new","(phone_number = '+1 (949) 355-6244 ext. 198842')","<p>Initialize Phone Number\n<p><strong>Method type: constructor</strong>\n"],["test_invalid_phone_number","PhoneNumberValidatorTest","PhoneNumberValidatorTest.html#method-i-test_invalid_phone_number","()","<p>Negative Test\n<p>Inputs an invalid phone number and expects the output to be <em>false</em>\n"],["test_valid_phone_number","PhoneNumberValidatorTest","PhoneNumberValidatorTest.html#method-i-test_valid_phone_number","()","<p>Positive Test\n<p>Inputs a valid phone number and expects the output to be <em>true</em>\n"],["validate_phone_number","PhoneNumberValidator","PhoneNumberValidator.html#method-c-validate_phone_number","(phone_number)","<p>Validate any United States phone number!\n<p>Example:\n\n<pre>PhoneNumberValidator.validate_phone_number(&#39;+1 (949) ...</pre>\n"],["validate_phone_number","PhoneNumberValidator::Validator","PhoneNumberValidator/Validator.html#method-i-validate_phone_number","()","<p>Validation Method\n<p>Checks to see if the phone number the user entered is valid by testing\nregex the pattern …\n"],["README","","README_rdoc.html","","<p>Phone Number Validator\n<p>About\n<p>This app is a US phone number-validating RubyGem.\n"]]}}

data/doc/table_of_contents.html

@@ -49,12 +49,20 @@
 <ul>
   <li class="class">
     <a href="PhoneNumberValidator.html">PhoneNumberValidator</a>
+
+    <ul>
+      <li><a href="PhoneNumberValidator.html#label-Phone+Number+Validator+Parent+Class">Phone Number Validator Parent Class</a>
+    </ul>
   </li>
   <li class="class">
     <a href="PhoneNumberValidator/Validator.html">PhoneNumberValidator::Validator</a>
   </li>
   <li class="class">
     <a href="PhoneNumberValidatorTest.html">PhoneNumberValidatorTest</a>
+
+    <ul>
+      <li><a href="PhoneNumberValidatorTest.html#label-Phone+Number+Validator+Test+Class">Phone Number Validator Test Class</a>
+    </ul>
   </li>
 </ul>
 

data/lib/phone_number_validator/validator.rb

@@ -1,8 +1,36 @@
 class PhoneNumberValidator::Validator
+	
+	##
+  # == Validates US Phone Numbers
+  #
+  # Regular Expression tested using {regexr.com}[https://regexr.com/]
+  #
+  # <b>Raw Regular Expression:</b>
+  # 	/^(?:(?:[2-9]11)|(?:(?:\+?1\s*(?:[.-]\s*)?)?(?:\(\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\s*\)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\s*(?:[.-]\s*)?)?([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\s*(?:[.-]\s*)?([0-9]{4})(?:\s*(?:\x20+|#|x\.?|ext\.?|extension)\s*(\d+))?)$/i
+	#
+	# <b>RegEx Flags:</b>
+  #   Regexp::IGNORECASE: (i)
   PHONE_NUMBER_REGEX = Regexp.new(/^(?:(?:[2-9]11)|(?:(?:\+?1\s*(?:[.-]\s*)?)?(?:\(\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\s*\)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\s*(?:[.-]\s*)?)?([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\s*(?:[.-]\s*)?([0-9]{4})(?:\s*(?:\x20+|#|x\.?|ext\.?|extension)\s*(\d+))?)$/, Regexp::IGNORECASE)
-  def initialize(phone_number = '+1 (949) 355-6244 ext. 198842')
+
+	##
+	# == Initialize Phone Number
+	#
+	# <b>Method type: constructor</b>
+	def initialize(phone_number = '+1 (949) 355-6244 ext. 198842')
     @phone_number = phone_number
-  end
+	end
+
+	##
+	# == Validation Method
+	#
+	# Checks to see if the phone number the user entered is valid
+	# by testing regex the pattern with the phone number
+	#
+	# Return Type:
+	# 	boolean
+	#
+	# Parameters:
+	# 	@phone_number: (String instance)
   def validate_phone_number
     if (PHONE_NUMBER_REGEX.match(@phone_number))
       puts "'%s' is a valid phone number." % @phone_number

data/lib/phone_number_validator.rb

@@ -1,14 +1,20 @@
+##
+# = Phone Number \Validator Parent Class
 class PhoneNumberValidator
   class << self
+
+    ##
     # Validate any United States phone number!
     #
     # Example:
-    #   >> PhoneNumberValidator.validate_phone_number('+1 (949) 355-6244 ext. 198842')
+    #   PhoneNumberValidator.validate_phone_number('+1 (949) 355-6244 ext. 198842')
+    #
+    # Output:
     #   => '+1 (949) 355-6244 ext. 198842' is a valid phone number.'
     #   => true
     #
     # Arguments:
-    #   phone_no: (String)
+    #   phone_number: (String)
     def validate_phone_number(phone_number)
       validator = Validator.new(phone_number)
       validator.validate_phone_number

data/phone_number_validator.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name                      = 'phone_number_validator'
-  spec.version                   = '0.2.1'
+  spec.version                   = '0.2.2'
   spec.date                      = Time.now.strftime("%Y-%m-%d")
   spec.summary                   = 'Validate any US phone number!'
   spec.description               = 'This gem is a United States phone number validator. This gem uses a complex regular expression that can validate any United States phone number.'

data/test/test_phone_number_validator.rb

@@ -1,11 +1,23 @@
 require 'test/unit'
 require 'phone_number_validator'
 
+##
+# = Phone Number \Validator Test Class
 class PhoneNumberValidatorTest < Test::Unit::TestCase
+  
+  ##
+  # == Positive Test
+  #
+  # Inputs a valid phone number and expects the output to be <em>true</em>
   def test_valid_phone_number
     assert_equal true,
     PhoneNumberValidator.validate_phone_number('+1 (949) 355-6244 ext. 198842')
   end
+
+  ##
+  # == Negative Test
+  #
+  # Inputs an invalid phone number and expects the output to be <em>false</em>
   def test_invalid_phone_number
     assert_equal false,
     PhoneNumberValidator.validate_phone_number('94643823637337')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phone_number_validator
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - bag33188