phone_number_validator 0.6.5 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5aff944676fcfac78440b5a7739e515fe02d8f09a160b4b7a4a3747a75dd275f
-  data.tar.gz: cf8cbdddab0f632f8fcc17ab3f26b6c427c9217fccf3bf6428e103c9c7c3348d
+  metadata.gz: 629926c89e8e22e60c406b97b4a1c8c01fa99c6b6e66e84a72bcf5ed9817cd74
+  data.tar.gz: 6740844c607bdf45687fdf259ad235beb7776bb2ef57d80ba5ec8463a9a34deb
 SHA512:
-  metadata.gz: '028a5322e5f11c2daa2583fed126d7a69ebfe7b7583ca2ca696d49274b479e6f0c23df2b269aa8d2b65b96edba0b329702ae35199c0a277eb91f1bf7f37f9126'
-  data.tar.gz: 68874558b8e0fdc28c0cea0a565e89928ce07ebe336bbbd66b0758945982779c9bc5b72a9a180185f77651ba0340411354c491f7a3769fae63dd4e4e76546e2f
+  metadata.gz: bf9b19201974683ecb0148ba70b22b3fa750ffa9899aa0adaab065d7069b28d059e01ad78ea210fcd611e3afd2646fb0244f240abb65f751f02746c1de3b113e
+  data.tar.gz: b7d0e471c33386d44c68c769c0fe95aa782bb45d9afb5a959d69fe5330611a75565551bf23e332724fe940093f8375ba1cb819e447c976dcd4e75f564fc550c7

data/README.rdoc

@@ -55,3 +55,4 @@ This gem uses the following regular expression:
 ==== Output
 
   => true
+  # output can be true (boolean, valid phone number), false (boolean, invalid phone number), or nil (symbol, no phone number entered)

data/doc/PhoneNumberValidator.html

@@ -123,42 +123,15 @@ functionality</p>
           
           <p>Validates any United States phone number!</p>
 
-<h3 id="method-c-validate-label-Arguments-3A">Arguments:<span><a href="#method-c-validate-label-Arguments-3A">&para;</a> <a href="#top">&uarr;</a></span></h3>
+<p><strong>Arguments:</strong></p>
 
 <pre>phone_number: (String)</pre>
-
-<h3 id="method-c-validate-label-Example+1-3A">Example 1:<span><a href="#method-c-validate-label-Example+1-3A">&para;</a> <a href="#top">&uarr;</a></span></h3>
-
-<pre class="ruby"><span class="ruby-constant">PhoneNumberValidator</span>.<span class="ruby-identifier">validate</span>(<span class="ruby-string">&#39;+1 (949) 355-6244 ext. 198842&#39;</span>)
-</pre>
-
-<h4 id="method-c-validate-label-Output-3A">Output:<span><a href="#method-c-validate-label-Output-3A">&para;</a> <a href="#top">&uarr;</a></span></h4>
-
-<pre>=&gt; true</pre>
-
-<h3 id="method-c-validate-label-Example+2-3A">Example 2:<span><a href="#method-c-validate-label-Example+2-3A">&para;</a> <a href="#top">&uarr;</a></span></h3>
-
-<pre class="ruby"><span class="ruby-constant">PhoneNumberValidator</span>.<span class="ruby-identifier">validate</span>(<span class="ruby-string">&#39;94643823637337&#39;</span>)
-</pre>
-
-<h4 id="method-c-validate-label-Output-3A">Output:<span><a href="#method-c-validate-label-Output-3A">&para;</a> <a href="#top">&uarr;</a></span></h4>
-
-<pre>=&gt; false</pre>
-
-<h3 id="method-c-validate-label-Example+3-3A">Example 3:<span><a href="#method-c-validate-label-Example+3-3A">&para;</a> <a href="#top">&uarr;</a></span></h3>
-
-<pre class="ruby"><span class="ruby-constant">PhoneNumberValidator</span>.<span class="ruby-identifier">validate</span>(<span class="ruby-string">&#39;&#39;</span>)
-</pre>
-
-<h4 id="method-c-validate-label-Output-3A">Output:<span><a href="#method-c-validate-label-Output-3A">&para;</a> <a href="#top">&uarr;</a></span></h4>
-
-<pre>=&gt; nil</pre>
           
           
 
           
           <div class="method-source-code" id="validate-source">
-            <pre><span class="ruby-comment"># File lib/phone_number_validator.rb, line 29</span>
+            <pre><span class="ruby-comment"># File lib/phone_number_validator.rb, line 11</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">validate</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</span>

data/doc/README_rdoc.html

@@ -148,7 +148,8 @@ number.</p>
 
 <h4 id="label-Output">Output<span><a href="#label-Output">&para;</a> <a href="#top">&uarr;</a></span></h4>
 
-<pre>=&gt; true</pre>
+<pre>=&gt; true
+# output can be true (boolean, valid phone number), false (boolean, invalid phone number), or nil (symbol, no phone number entered)</pre>
 </main>
 
 

data/doc/created.rid

@@ -1,6 +1,6 @@
-Sat, 24 Nov 2018 18:03:06 -0800
-README.rdoc	Sat, 24 Nov 2018 09:40:41 -0800
-lib/phone_number_validator.rb	Sat, 24 Nov 2018 09:44:29 -0800
+Sat, 24 Nov 2018 18:13:33 -0800
+README.rdoc	Sat, 24 Nov 2018 18:13:24 -0800
+lib/phone_number_validator.rb	Sat, 24 Nov 2018 18:11:57 -0800
 lib/phone_number_validator/validator.rb	Sat, 24 Nov 2018 09:42:07 -0800
 test/test_phone_number_validator.rb	Sat, 24 Nov 2018 09:34:43 -0800
 bin/pnv	Sat, 24 Nov 2018 18:03:00 -0800

data/doc/index.html

@@ -142,7 +142,8 @@ number.</p>
 
 <h4 id="label-Output">Output<span><a href="#label-Output">&para;</a> <a href="#top">&uarr;</a></span></h4>
 
-<pre>=&gt; true</pre>
+<pre>=&gt; true
+# output can be true (boolean, valid phone number), false (boolean, invalid phone number), or nil (symbol, no phone number entered)</pre>
 </main>
 
 

data/doc/js/search_index.js

@@ -1 +1 @@
-var search_data = {"index":{"searchIndex":["phonenumbervalidator","validator","phonenumbervalidatortest","new()","test_invalid_phone_number()","test_no_phone_number()","test_valid_phone_number()","validate()","validate()","readme"],"longSearchIndex":["phonenumbervalidator","phonenumbervalidator::validator","phonenumbervalidatortest","phonenumbervalidator::validator::new()","phonenumbervalidatortest#test_invalid_phone_number()","phonenumbervalidatortest#test_no_phone_number()","phonenumbervalidatortest#test_valid_phone_number()","phonenumbervalidator::validate()","phonenumbervalidator::validator#validate()",""],"info":[["PhoneNumberValidator","","PhoneNumberValidator.html","","<p>This class is the master/parent class to all of the validation\nfunctionality\n"],["PhoneNumberValidator::Validator","","PhoneNumberValidator/Validator.html","","<p>This class does all of the matching and checking work for the validation of\nthe phone number.\n"],["PhoneNumberValidatorTest","","PhoneNumberValidatorTest.html","","<p>This class respresents the testing-unit for this gem app\n<p><strong>Inherits from:</strong>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Test</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">Unit</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">TestCase</span>\n</pre>\n"],["new","PhoneNumberValidator::Validator","PhoneNumberValidator/Validator.html#method-c-new","(phone_number = '+1 (949) 355-6244 ext. 198842')","<p>initializes the <strong>@phone_number</strong> instance variable\n"],["test_invalid_phone_number","PhoneNumberValidatorTest","PhoneNumberValidatorTest.html#method-i-test_invalid_phone_number","()","<p>This test inputs an invalid phone number and expects the output to be\n<strong>false</strong>\n"],["test_no_phone_number","PhoneNumberValidatorTest","PhoneNumberValidatorTest.html#method-i-test_no_phone_number","()","<p>This test inputs no phone number and expectst the output to be\n<strong>:nil</strong>\n"],["test_valid_phone_number","PhoneNumberValidatorTest","PhoneNumberValidatorTest.html#method-i-test_valid_phone_number","()","<p>This test inputs a valid phone number and expects the output to be\n<strong>true</strong>\n"],["validate","PhoneNumberValidator","PhoneNumberValidator.html#method-c-validate","(phone_number)","<p>Validates any United States phone number!\n<p>Arguments:\n\n<pre>phone_number: (String)</pre>\n"],["validate","PhoneNumberValidator::Validator","PhoneNumberValidator/Validator.html#method-i-validate","()","<p>Checks to see if the phone number the user entered is valid by testing\nregex the pattern with the phone …\n"],["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_no_phone_number()","test_valid_phone_number()","validate()","validate()","readme"],"longSearchIndex":["phonenumbervalidator","phonenumbervalidator::validator","phonenumbervalidatortest","phonenumbervalidator::validator::new()","phonenumbervalidatortest#test_invalid_phone_number()","phonenumbervalidatortest#test_no_phone_number()","phonenumbervalidatortest#test_valid_phone_number()","phonenumbervalidator::validate()","phonenumbervalidator::validator#validate()",""],"info":[["PhoneNumberValidator","","PhoneNumberValidator.html","","<p>This class is the master/parent class to all of the validation\nfunctionality\n"],["PhoneNumberValidator::Validator","","PhoneNumberValidator/Validator.html","","<p>This class does all of the matching and checking work for the validation of\nthe phone number.\n"],["PhoneNumberValidatorTest","","PhoneNumberValidatorTest.html","","<p>This class respresents the testing-unit for this gem app\n<p><strong>Inherits from:</strong>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Test</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">Unit</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">TestCase</span>\n</pre>\n"],["new","PhoneNumberValidator::Validator","PhoneNumberValidator/Validator.html#method-c-new","(phone_number = '+1 (949) 355-6244 ext. 198842')","<p>initializes the <strong>@phone_number</strong> instance variable\n"],["test_invalid_phone_number","PhoneNumberValidatorTest","PhoneNumberValidatorTest.html#method-i-test_invalid_phone_number","()","<p>This test inputs an invalid phone number and expects the output to be\n<strong>false</strong>\n"],["test_no_phone_number","PhoneNumberValidatorTest","PhoneNumberValidatorTest.html#method-i-test_no_phone_number","()","<p>This test inputs no phone number and expectst the output to be\n<strong>:nil</strong>\n"],["test_valid_phone_number","PhoneNumberValidatorTest","PhoneNumberValidatorTest.html#method-i-test_valid_phone_number","()","<p>This test inputs a valid phone number and expects the output to be\n<strong>true</strong>\n"],["validate","PhoneNumberValidator","PhoneNumberValidator.html#method-c-validate","(phone_number)","<p>Validates any United States phone number!\n<p><strong>Arguments:</strong>\n\n<pre>phone_number: (String)</pre>\n"],["validate","PhoneNumberValidator::Validator","PhoneNumberValidator/Validator.html#method-i-validate","()","<p>Checks to see if the phone number the user entered is valid by testing\nregex the pattern with the phone …\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/lib/phone_number_validator.rb

@@ -6,26 +6,8 @@ class PhoneNumberValidator
     ##
     # Validates any United States phone number!
     #
-    # === Arguments:
+    # <b>Arguments:</b>
     #   phone_number: (String)
-    #
-    # === Example 1:
-    #   PhoneNumberValidator.validate('+1 (949) 355-6244 ext. 198842')
-    #
-    # ==== Output:
-    #   => true
-    #
-    # === Example 2:
-    #   PhoneNumberValidator.validate('94643823637337')
-    #
-    # ==== Output:
-    #   => false
-    #
-    # === Example 3:
-    #   PhoneNumberValidator.validate('')
-    #
-    # ==== Output:
-    #   => nil
     def validate(phone_number)
       validator = Validator.new(phone_number)
       validator.validate

data/phone_number_validator.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name                      = 'phone_number_validator'
-  spec.version                   = '0.6.5'
+  spec.version                   = '0.6.6'
   spec.date                      = Time.now.strftime("%Y-%m-%d")
   spec.summary                   = 'Validate any US phone number!'
   spec.description               = <<-EOF

metadata

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