phone_number_validator 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d78eddf37f0f8ba4257338f2bbc4a86a924ae564d9538da5df18ee0173ed9481
+  data.tar.gz: 7ab2282b16c172a569be27923aeadb0d4c0669ac77b2c3c4ecc34cea53adbb81
+SHA512:
+  metadata.gz: 7d58887ce1e729b92ebc21dd395e1a936cde5f01e1cba71d93f8618407d0d0ed94324384ec0915bf3b3cf7afcf43b5a151407b3d40e7064bca0be93e53115b34
+  data.tar.gz: 2e4375ae46f35f0cf2b98afadd6ddca3a1391dbdbeaa28e1b82763bbe90c6bf9572826882881b37326f67de82db7d82be3738e95f99545857fff9b12af7b2da8

data/.gitignore

@@ -0,0 +1,25 @@
+# System File(s)/Folder(s)
+.DS_Store
+Thumbs.db
+_MACOSX
+
+# Editor File(s)/Folder(s)
+*.code-workspace
+*.sublime-project
+*.sublime-workspace
+.vscode
+
+# Generated Files
+*.gem
+*.lock
+RPS-*
+
+# Other
+*.bat
+
+# if gitignore is not working, try this:
+#
+# git rm -r --cached .
+# git add .
+# git commit -m "fixed untracked files"
+# git push

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+platform :ruby do
+	gemspec
+	gem 'rdoc', '~> 6.0', '>= 6.0.4'
+  gem 'rake', '~> 11.2', '>= 11.2.2'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 bag33188
+
+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,94 @@
+= Phone Number Validator
+
+== About
+
+This app is a US phone number-validating RubyGem.
+
+== Installing
+
+  $ gem install phone_number_validator
+
+=== Install Required Gems
+
+  $ bundle install
+
+== Uninstalling
+
+  $ gem uninstall phone_number_validator
+
+== Testing
+
+  $ rake test
+
+== Usage
+
+=== In command line
+
+  $ phone_number_validator '+1 (949) 355-6244 ext. 198842'
+  => '+1 (949) 355-6244 ext. 198842' is a valid phone number.'
+  => true
+
+=== In Ruby code
+
+  require 'phone_number_validator'
+
+  check_phone_number = PhoneNumberValidator.validate_phone_number('+1 (949) 355-6244 ext. 198842')
+
+  print(check_phone_number)
+
+==== Output
+
+  => '+1 (949) 355-6244 ext. 198842' is a valid phone number.'
+  => true
+
+== Download/Install Ruby and RubyGems (on all OS)
+
+=== Windows
+
+==== Ruby
+
+Download and install the RubyInstaller from {RubyInstaller's website}[https://rubyinstaller.org/].
+
+==== RubyGems
+
+Download and extract the zip file from the {RubyGems download page}[https://rubygems.org/pages/download].
+
+Then run the following:
+
+  $ cd <path/to/extracted/zip>
+  $ ruby setup.rb
+
+=== OSX
+
+==== Ruby
+
+Run the following:
+
+  $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+  $ sudo brew install ruby
+
+==== RubyGems
+
+Download and extract the zip file from the {RubyGems download page}[https://rubygems.org/pages/download].
+
+Then run the following:
+
+  $ cd <path/to/extracted/zip>
+  $ ruby setup.rb
+
+=== Linux
+
+==== Ruby
+
+Run the following:
+
+  $ sudo apt install ruby-full
+
+==== RubyGems
+
+Download and extract the zip file from the {RubyGems download page}[https://rubygems.org/pages/download].
+
+Then run the following:
+
+  $ cd <path/to/extracted/zip>
+  $ ruby setup.rb

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.libs << 'test'
+end
+
+desc 'Run tests'
+task :default => :test
+
+require 'rdoc/task'
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.rdoc"
+  rdoc.title = 'Phone Number Validator'
+  rdoc.rdoc_files.include('README.rdoc', 'lib/*.rb', 'lib/**/*.rb', 'test/*.rb', 'bin/*')
+  rdoc.rdoc_dir = 'doc'
+end
+
+# for Windows
+task :deldoc do
+	`RMDIR /S /Q "doc"`
+end
+
+# for Unix
+task :deldocx do
+  `rm -rf doc`
+end

data/bin/phone_number_validator

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+=begin
+|======================|
+| PhoneNumberValidator |
+|----------------------|
+| Made by: bag33188    |
+|======================|
+=end
+
+require 'phone_number_validator'
+
+print(PhoneNumberValidator.validate_phone_number(ARGV[0]))

data/doc/PhoneNumberValidator.html

@@ -0,0 +1,164 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class PhoneNumberValidator - Phone Number Validator</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+</script>
+
+<script src="./js/jquery.js"></script>
+<script src="./js/darkfish.js"></script>
+
+<link href="./css/fonts.css" rel="stylesheet">
+<link href="./css/rdoc.css" rel="stylesheet">
+
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="./index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="./table_of_contents.html#pages">Pages</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    <div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  
+  <p class="link">Object
+  
+</div>
+
+    
+    
+    <!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+  <h3>Methods</h3>
+
+  <ul class="link-list" role="directory">
+    
+    <li ><a href="#method-c-validate_phone_number">::validate_phone_number</a>
+    
+  </ul>
+</div>
+
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="class-PhoneNumberValidator">
+  <h1 id="class-PhoneNumberValidator" class="class">
+    class PhoneNumberValidator
+  </h1>
+
+  <section class="description">
+    
+  </section>
+
+  
+  
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+
+    
+
+    
+     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Class Methods</h3>
+       </header>
+
+    
+      <div id="method-c-validate_phone_number" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">validate_phone_number</span><span
+            class="method-args">(phone_number)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Validate any United States phone mumber!</p>
+
+<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;
+=&gt; true</pre>
+
+<p>Arguments:</p>
+
+<pre>phone_no: (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>
+<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>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+    </section>
+  
+  </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="http://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+

data/doc/PhoneNumberValidator/Validator.html

@@ -0,0 +1,216 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class PhoneNumberValidator::Validator - Phone Number Validator</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../";
+</script>
+
+<script src="../js/jquery.js"></script>
+<script src="../js/darkfish.js"></script>
+
+<link href="../css/fonts.css" rel="stylesheet">
+<link href="../css/rdoc.css" rel="stylesheet">
+
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="../index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="../table_of_contents.html#pages">Pages</a>
+    <a href="../table_of_contents.html#classes">Classes</a>
+    <a href="../table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    <div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  
+  <p class="link">Object
+  
+</div>
+
+    
+    
+    <!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+  <h3>Methods</h3>
+
+  <ul class="link-list" role="directory">
+    
+    <li ><a href="#method-c-new">::new</a>
+    
+    <li ><a href="#method-i-validate_phone_number">#validate_phone_number</a>
+    
+  </ul>
+</div>
+
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="class-PhoneNumberValidator::Validator">
+  <h1 id="class-PhoneNumberValidator::Validator" class="class">
+    class PhoneNumberValidator::Validator
+  </h1>
+
+  <section class="description">
+    
+  </section>
+
+  
+  
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+    <section class="constants-list">
+      <header>
+        <h3>Constants</h3>
+      </header>
+      <dl>
+      
+        <dt id="PHONE_NUMBER_REGEX">PHONE_NUMBER_REGEX
+        
+        <dd>
+        
+      
+      </dl>
+    </section>
+    
+
+    
+
+    
+     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Class Methods</h3>
+       </header>
+
+    
+      <div id="method-c-new" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">new</span><span
+            class="method-args">(phone_number = '+1 (949) 355-6244 ext. 198842')</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+          
+
+          
+          <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>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+    </section>
+  
+     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Instance Methods</h3>
+       </header>
+
+    
+      <div id="method-i-validate_phone_number" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">validate_phone_number</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+          
+
+          
+          <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>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">validate_phone_number</span>
+  <span class="ruby-keyword">if</span> (<span class="ruby-ivar">@phone_number</span>.<span class="ruby-identifier">match</span>(<span class="ruby-constant">PHONE_NUMBER_REGEX</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>
+    <span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span>
+  <span class="ruby-keyword">else</span>
+    <span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;&#39;%s&#39; is not a valid phone number.&quot;</span> <span class="ruby-operator">%</span> <span class="ruby-ivar">@phone_number</span>
+    <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>
+  <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+    </section>
+  
+  </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="http://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+