-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
66 lines (60 loc) · 21.8 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
<!DOCTYPE html> <html> <head> <title>RandomData.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> RandomData.coffee </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> <h1>Description</h1>
<p>RandomData is a node.js module that generates random test data for
your application. It is a partial port of the ruby
<a href="http://random-data.rubyforge.org/">random-data</a> gem. It is written
in coffescript but can be used from JavaScript as well (since
coffescript generates Javascript).</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> <h1>Installation</h1>
<pre><code>npm install random-data
</code></pre> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> <h1>Example</h1>
<pre><code>random = require 'random-data'
randomUser =
login: random.string 10
password: random.string 10
first_name: random.firstName()
middle_initial: random.middleInitial()
last_name: random.lastName()
address_line_1: random.addressLine1()
address_line_2: random.addressLine2()
city: random.city()
state: random.usStateName()
zip: random.usZipLong()
home_phone: random.usPhone()
cell_phone: random.usPhone()
console.log randomUser
</code></pre> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> <p>Output:</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> <pre><code>{ login: 'Dq,,9Qaskg',
password: ',7,3vHqF,,',
first_name: 'Michael',
middle_initial: 'X',
last_name: 'Taylor',
address_line_1: '1978 Larch Pkwy',
address_line_2: 'Bldg 982',
city: 'Bela',
state: 'Illinois',
zip: '12345-1234',
home_phone: '209-611-9742',
cell_phone: '714-181-10467' }
</code></pre> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> <h1>Source Code</h1> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> <h3>Housekeeping</h3> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> <p>Object that will hold our exports.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random = </span><span class="p">{}</span></pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">¶</a> </div> <p>Import data (list of names, cities, etc).</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">data = </span><span class="nx">require</span> <span class="s1">'./Data'</span></pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">¶</a> </div> <h3>Functions</h3> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">¶</a> </div> <h4>General random generators</h4> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">¶</a> </div> <p>Generates a random number between 0...n, exclusive. For example
<code>random.number(3)</code> will return <code>0</code>, <code>1</code> or <code>2</code>.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.number = </span><span class="nf">(n) -></span> <span class="nb">Math</span><span class="p">.</span><span class="nx">floor</span><span class="p">(</span><span class="nb">Math</span><span class="p">.</span><span class="nx">random</span><span class="p">()</span> <span class="o">*</span> <span class="nx">n</span><span class="p">)</span></pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">¶</a> </div> <p>Picks a random element from an array.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.element = </span><span class="nf">(array) -></span>
<span class="nx">array</span><span class="p">[</span><span class="nx">random</span><span class="p">.</span><span class="nx">number</span> <span class="nx">array</span><span class="p">.</span><span class="nx">length</span><span class="p">]</span></pre></div> </td> </tr> <tr id="section-14"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-14">¶</a> </div> <p>Randomly returns <code>true</code> or <code>false</code>.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.trueOrFalse = </span><span class="o">-></span>
<span class="nx">random</span><span class="p">.</span><span class="nx">number</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span> <span class="o">is</span> <span class="mi">1</span> <span class="o">?</span> <span class="kc">true</span> <span class="o">:</span> <span class="kc">false</span></pre></div> </td> </tr> <tr id="section-15"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-15">¶</a> </div> <h4>Strings</h4> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-16"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-16">¶</a> </div> <p>Generates a random alphanumeric string of given length. Default length is 16.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.string = </span><span class="nf">(length = 16) -></span>
<span class="p">(</span><span class="nx">data</span><span class="p">.</span><span class="nx">all_chars</span><span class="p">[</span><span class="nx">random</span><span class="p">.</span><span class="nx">number</span> <span class="nx">data</span><span class="p">.</span><span class="nx">all_chars</span><span class="p">.</span><span class="nx">length</span><span class="p">]</span> <span class="k">for</span> <span class="nx">i</span> <span class="k">in</span> <span class="p">[</span><span class="mi">0</span><span class="p">...</span><span class="nx">length</span><span class="p">]).</span><span class="nx">join</span><span class="p">(</span><span class="s1">''</span><span class="p">)</span></pre></div> </td> </tr> <tr id="section-17"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-17">¶</a> </div> <p>Generates a random string of digits of given length.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.stringOfNumbers = </span><span class="nf">(n) -></span>
<span class="p">(</span><span class="nx">i</span> <span class="k">for</span> <span class="nx">i</span> <span class="k">in</span> <span class="p">[</span><span class="mi">1</span><span class="p">..</span><span class="nx">n</span><span class="p">]).</span><span class="nx">join</span><span class="p">(</span><span class="s2">""</span><span class="p">)</span> <span class="c1"># TODO: use util.format in node.js 0.5.x</span></pre></div> </td> </tr> <tr id="section-18"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-18">¶</a> </div> <h4>Names</h4> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-19"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-19">¶</a> </div> <p>Picks a random female first name.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.femaleFirstName = </span><span class="o">-></span>
<span class="nx">random</span><span class="p">.</span><span class="nx">element</span> <span class="nx">data</span><span class="p">.</span><span class="nx">female_first_names</span></pre></div> </td> </tr> <tr id="section-20"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-20">¶</a> </div> <p>Picks a random male first name.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.maleFirstName = </span><span class="o">-></span>
<span class="nx">random</span><span class="p">.</span><span class="nx">element</span> <span class="nx">data</span><span class="p">.</span><span class="nx">male_first_names</span></pre></div> </td> </tr> <tr id="section-21"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-21">¶</a> </div> <p>Picks random first name (male or female).</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.firstName = </span><span class="o">-></span>
<span class="nx">random</span><span class="p">.</span><span class="nx">element</span> <span class="nx">data</span><span class="p">.</span><span class="nx">all_names</span></pre></div> </td> </tr> <tr id="section-22"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-22">¶</a> </div> <p>Picks random last name.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.lastName = </span><span class="o">-></span>
<span class="nx">random</span><span class="p">.</span><span class="nx">element</span> <span class="nx">data</span><span class="p">.</span><span class="nx">last_names</span></pre></div> </td> </tr> <tr id="section-23"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-23">¶</a> </div> <p>Returns a random letter between 'A'..'Z'.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.middleInitial = </span><span class="o">-></span>
<span class="nx">random</span><span class="p">.</span><span class="nx">element</span> <span class="nx">data</span><span class="p">.</span><span class="nx">upper_alphas</span></pre></div> </td> </tr> <tr id="section-24"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-24">¶</a> </div> <h4>Locations</h4> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-25"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-25">¶</a> </div> <p>Generates random first address line.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.addressLine1 = </span><span class="o">-></span>
<span class="s2">"#{random.number(4000) + 1} #{random.element data.street_names} #{random.element data.street_types}"</span></pre></div> </td> </tr> <tr id="section-26"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-26">¶</a> </div> <p>Generates random second address line.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.addressLine2 = </span><span class="o">-></span>
<span class="s2">"#{random.element data.line_2_types} #{random.number(999) + 1}"</span></pre></div> </td> </tr> <tr id="section-27"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-27">¶</a> </div> <p>Picks a random city, for example <code>'St. Louis'</code>.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.city = </span><span class="o">-></span>
<span class="nx">random</span><span class="p">.</span><span class="nx">element</span> <span class="nx">data</span><span class="p">.</span><span class="nx">cities</span></pre></div> </td> </tr> <tr id="section-28"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-28">¶</a> </div> <p>Picks a random 2 character US state abbreviation, for example <code>'MO'</code>.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.usStateAbbreviation = </span><span class="o">-></span>
<span class="nx">random</span><span class="p">.</span><span class="nx">element</span> <span class="nx">data</span><span class="p">.</span><span class="nx">state_abbrevs</span></pre></div> </td> </tr> <tr id="section-29"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-29">¶</a> </div> <p>Picks a random US state full name, for example <code>'Missouri'</code>.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.usStateName = </span><span class="o">-></span>
<span class="nx">random</span><span class="p">.</span><span class="nx">element</span> <span class="nx">data</span><span class="p">.</span><span class="nx">state_names</span></pre></div> </td> </tr> <tr id="section-30"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-30">¶</a> </div> <p>Generates a random 5 digit US zip code. Note: the zip code may not
be an actual US zip code, but the format will be valid.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.usZipShort = </span><span class="o">-></span>
<span class="nx">random</span><span class="p">.</span><span class="nx">stringOfNumbers</span> <span class="mi">5</span></pre></div> </td> </tr> <tr id="section-31"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-31">¶</a> </div> <p>Generates a random 9 digit US zip code in the zip+4 format. For
example, <code>'12345-0123'</code>. Note: the zip code may not be an actual US
zip code, but the format will be valid.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.usZipLong = </span><span class="o">-></span>
<span class="s2">"#{random.stringOfNumbers 5}-#{random.stringOfNumbers 4}"</span></pre></div> </td> </tr> <tr id="section-32"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-32">¶</a> </div> <p>Picks a random country name.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.country = </span><span class="o">-></span>
<span class="nx">random</span><span class="p">.</span><span class="nx">element</span> <span class="nx">data</span><span class="p">.</span><span class="nx">countries</span></pre></div> </td> </tr> <tr id="section-33"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-33">¶</a> </div> <h4>Phone Numbers</h4> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-34"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-34">¶</a> </div> <p>Generates a random US phone number. For example <code>'628-611-6473'</code>.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.usPhone = </span><span class="o">-></span>
<span class="s2">"#{random.number(900) + 100}-#{random.number(900)+100}-#{random.number(10000)+1000}"</span></pre></div> </td> </tr> <tr id="section-35"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-35">¶</a> </div> <p>Generates a random international phone number, for example <code>'011-54-16-10169'</code>.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">random.internationalPhone = </span><span class="o">-></span>
<span class="s2">"011-#{random.number(100) + 1}-#{random.number(100)+10}-#{random.number(10000)+1000}"</span></pre></div> </td> </tr> <tr id="section-36"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-36">¶</a> </div> <h3>Exports</h3> </td> <td class="code"> <div class="highlight"><pre><span class="nv">module.exports = </span><span class="nx">random</span>
</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>