fluentnode

<!DOCTYPE html> <html> <head> <title>assert_String.litcoffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <ul id="jump_to"> <li> <a class="large" href="javascript:void(0);">Jump To …</a> <a class="small" href="javascript:void(0);">+</a> <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="assert_Array.html"> assert_Array.litcoffee </a> <a class="source" href="assert_Boolean.html"> assert_Boolean.litcoffee </a> <a class="source" href="assert_Function.html"> assert_Function.litcoffee </a> <a class="source" href="assert_Number.html"> assert_Number.litcoffee </a> <a class="source" href="assert_Object.html"> assert_Object.litcoffee </a> <a class="source" href="assert_String.html"> assert_String.litcoffee </a> <a class="source" href="fluentnode.html"> fluentnode.coffee </a> <a class="source" href="index.html"> index.md </a> <a class="source" href="Array.html"> Array.litcoffee </a> <a class="source" href="Boolean.html"> Boolean.litcoffee </a> <a class="source" href="Function.html"> Function.litcoffee </a> <a class="source" href="Number.html"> Number.litcoffee </a> <a class="source" href="Object.html"> Object.litcoffee </a> <a class="source" href="String.html"> String.litcoffee </a> <a class="source" href="console.html"> console.litcoffee </a> <a class="source" href="crypto.html"> crypto.litcoffee </a> <a class="source" href="fs.html"> fs.litcoffee </a> <a class="source" href="http.GET.html"> http.GET.litcoffee </a> <a class="source" href="http.POST.html"> http.POST.litcoffee </a> <a class="source" href="http.Server.html"> http.Server.litcoffee </a> <a class="source" href="http.html"> http.litcoffee </a> <a class="source" href="path.html"> path.litcoffee </a> <a class="source" href="process.html"> process.litcoffee </a> <a class="source" href="encoding.html"> encoding.litcoffee </a> <a class="source" href="globals.html"> globals.litcoffee </a> <a class="source" href="assert_Array.test.html"> assert_Array.test.coffee </a> <a class="source" href="assert_Boolean.test.html"> assert_Boolean.test.coffee </a> <a class="source" href="assert_Function.test.html"> assert_Function.test.coffee </a> <a class="source" href="assert_Number.test.html"> assert_Number.test.coffee </a> <a class="source" href="assert_Object.test.html"> assert_Object.test.coffee </a> <a class="source" href="assert_String.test.html"> assert_String.test.coffee </a> <a class="source" href="fluentnode.test.html"> fluentnode.test.coffee </a> <a class="source" href="Array.test.html"> Array.test.coffee </a> <a class="source" href="Boolean.test.html"> Boolean.test.coffee </a> <a class="source" href="Function.test.html"> Function.test.coffee </a> <a class="source" href="Number.test.html"> Number.test.coffee </a> <a class="source" href="Object.test.html"> Object.test.coffee </a> <a class="source" href="String.test.html"> String.test.coffee </a> <a class="source" href="console.test.html"> console.test.coffee </a> <a class="source" href="crypto.test.html"> crypto.test.coffee </a> <a class="source" href="fs.test.html"> fs.test.coffee </a> <a class="source" href="http.GET.test.html"> http.GET.test.coffee </a> <a class="source" href="http.POST.test.html"> http.POST.test.coffee </a> <a class="source" href="http.Server.test.html"> http.Server.test.coffee </a> <a class="source" href="http.test.html"> http.test.coffee </a> <a class="source" href="path.test.html"> path.test.coffee </a> <a class="source" href="process.test.html"> process.test.coffee </a> <a class="source" href="encoding.test.html"> encoding.test.coffee </a> <a class="source" href="globals.test.html"> globals.test.coffee </a> </div> </li> </ul> <ul class="sections"> <li id="title"> <div class="annotation"> <h1>assert_String.litcoffee</h1> </div> </li> <li id="section-1"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-1">¶</a> </div> <p>dependencies</p> </div> <div class="content"><div class='highlight'><pre>assert = <span class="hljs-built_in">require</span> <span class="hljs-string">'assert'</span></pre></div></div> </li> <li id="section-2"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-2">¶</a> </div> <p>@.<strong>String::assert_Contains</strong> target</p> </div> <div class="content"><div class='highlight'><pre><span class="hljs-attribute">String</span>::assert_Contains = <span class="hljs-function"><span class="hljs-params">(target, message)</span>-></span> source = @.toString() message = message || <span class="hljs-string">"expected string '<span class="hljs-subst">#{source}</span>' to contain the string/array '<span class="hljs-subst">#{target}</span>'"</span> assert(source.contains(target), message) @</pre></div></div> </li> <li id="section-3"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-3">¶</a> </div> <p>@.<strong>assert_Empty</strong></p> <p>Throws assert exception if @ is not ‘’</p> </div> <div class="content"><div class='highlight'><pre><span class="hljs-attribute">String</span>::assert_Empty = <span class="hljs-function">-></span> <span class="hljs-keyword">throw</span> <span class="hljs-keyword">new</span> Error(<span class="hljs-string">"Expected empty string but it was <span class="hljs-subst">#{@}</span>"</span>) <span class="hljs-keyword">if</span> @.valueOf() <span class="hljs-keyword">isnt</span> <span class="hljs-string">''</span> @</pre></div></div> </li> <li id="section-4"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-4">¶</a> </div> <p>@.<strong>String::assert_File_Contents_Contains</strong> value</p> <p>Asserts that file <code>@</code> contents contains the string <code>value</code></p> <p>twin method: assert_File_Contains</p> </div> <div class="content"><div class='highlight'><pre><span class="hljs-attribute">String</span>::assert_File_Contents_Contains = <span class="hljs-function"><span class="hljs-params">(value)</span>-></span> message = <span class="hljs-string">"expected file '<span class="hljs-subst">#{@}</span>' to contain '<span class="hljs-subst">#{value}</span>'"</span> @.file_Contents().assert_Contains value, message @.valueOf() <span class="hljs-attribute">String</span>::assert_File_Contains = <span class="hljs-attribute">String</span>::assert_File_Contents_Contains</pre></div></div> </li> <li id="section-5"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-5">¶</a> </div> <p>@.<strong>String::assert_File_Contents_Is</strong> value</p> <p>Asserts that file <code>@</code> contents is the string <code>value</code></p> </div> <div class="content"><div class='highlight'><pre><span class="hljs-attribute">String</span>::assert_File_Contents = <span class="hljs-function"><span class="hljs-params">(value)</span>-></span> message = <span class="hljs-string">"expected file '<span class="hljs-subst">#{@}</span>' to be '<span class="hljs-subst">#{value}</span>'"</span> @.file_Contents().assert_Is value, message @.valueOf()</pre></div></div> </li> <li id="section-6"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-6">¶</a> </div> <p>@.<strong>String::assert_File_Deleted</strong> value</p> </div> <div class="content"><div class='highlight'><pre><span class="hljs-attribute">String</span>::assert_File_Deleted = <span class="hljs-function"><span class="hljs-params">()</span>-></span> message = <span class="hljs-string">"expected file '<span class="hljs-subst">#{@}</span>' have been deleted'"</span> @.file_Delete().assert_Is_True message @.valueOf()</pre></div></div> </li> <li id="section-7"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-7">¶</a> </div> <p>@.<strong>String::assert_Not_Contains</strong> target</p> </div> <div class="content"><div class='highlight'><pre><span class="hljs-attribute">String</span>::assert_Not_Contains = <span class="hljs-function"><span class="hljs-params">(target)</span>-></span> source = @.toString() message = <span class="hljs-string">"expected string '<span class="hljs-subst">#{source}</span>' to not contain the string '<span class="hljs-subst">#{target}</span>'"</span> assert(source.indexOf(target) == -<span class="hljs-number">1</span>, message) @</pre></div></div> </li> <li id="section-8"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-8">¶</a> </div> <p>@.<strong>assert_Not_Empty</strong></p> <p>Throws assert exception if @ is not ‘’</p> </div> <div class="content"><div class='highlight'><pre><span class="hljs-attribute">String</span>::assert_Not_Empty = <span class="hljs-function">-></span> <span class="hljs-keyword">throw</span> <span class="hljs-keyword">new</span> Error(<span class="hljs-string">"Expected non empty string but it was ''"</span>) <span class="hljs-keyword">if</span> @.valueOf() <span class="hljs-keyword">is</span> <span class="hljs-string">''</span> @</pre></div></div> </li> <li id="section-9"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-9">¶</a> </div> <p>@.<strong>assert_Is_Equal_To</strong> target</p> </div> <div class="content"><div class='highlight'><pre><span class="hljs-attribute">String</span>::assert_Is_Equal_To = <span class="hljs-function"><span class="hljs-params">(target, message)</span>-></span> source = @.toString() assert.equal(source, target, message) @ <span class="hljs-attribute">String</span>::assert_Is_Not_Equal_To = <span class="hljs-function"><span class="hljs-params">(target, message)</span>-></span> assert.notDeepEqual(@.valueOf(), target.valueOf(), message) @ <span class="hljs-attribute">String</span>::assert_Is_Json = <span class="hljs-function">-></span> contents = @.toString() <span class="hljs-keyword">try</span> json = JSON.parse(contents) <span class="hljs-keyword">return</span> json <span class="hljs-keyword">catch</span> <span class="hljs-keyword">throw</span> <span class="hljs-string">'[assert_Is_JSON] failed to convert string to json'</span> <span class="hljs-attribute">String</span>::assert_Is_String = <span class="hljs-function">=></span> assert.equal(<span class="hljs-keyword">typeof</span>(@), <span class="hljs-string">'object'</span>) <span class="hljs-comment"># not the best test, but if @ is not a string there will be an run-time-error</span></pre></div></div> </li> <li id="section-10"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-10">¶</a> </div> <p>assert.equal(typeof(@), ‘array’, message) # this doesn’t work</p> </div> <div class="content"><div class='highlight'><pre> @ <span class="hljs-comment"># also not working as expected</span> <span class="hljs-attribute">String</span>::assert_Length_Is = <span class="hljs-function"><span class="hljs-params">(size)</span>-></span> message = <span class="hljs-string">"[assert_Length_Is]"</span> assert.equal(@.length, size, message) @ <span class="hljs-attribute">String</span>::assert_Length_Is_Not = <span class="hljs-function"><span class="hljs-params">(size)</span>-></span> message = <span class="hljs-string">"[assert_Length_Is_Not]"</span> assert.notEqual(@.length, size, message) @ <span class="hljs-attribute">String</span>::assert_That_File_Exists = <span class="hljs-function">-></span> file = @.toString() test = file.file_Exists() message = <span class="hljs-string">"[assert_That_File_Exists]: <span class="hljs-subst">#{file}</span>"</span> assert(test, message) file <span class="hljs-attribute">String</span>::assert_That_File_Not_Exists = <span class="hljs-function">-></span> file = @.toString() test = file.file_Not_Exists() message = <span class="hljs-string">"[assert_That_File_Not_Exists]: <span class="hljs-subst">#{file}</span>"</span> assert(test, message) file</pre></div></div> </li> <li id="section-11"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-11">¶</a> </div> <p>@.<strong>assert_That_Folder_Exists</strong></p> <p>Assert that <code>@</code> is a folder and that is exists</p> <p>twin methods: assert_Is_Folder</p> </div> <div class="content"><div class='highlight'><pre><span class="hljs-attribute">String</span>::assert_That_Folder_Exists = <span class="hljs-function">-></span> folder = @.toString() test = message = <span class="hljs-string">"Expected <span class="hljs-subst">#{folder}</span> to exist"</span> folder.folder_Exists().assert_Is_True message folder <span class="hljs-attribute">String</span>::assert_Is_Folder = <span class="hljs-attribute">String</span>::assert_That_Folder_Exists <span class="hljs-attribute">String</span>::assert_That_Folder_Not_Exists = <span class="hljs-function">-></span> folder = @.toString() test = folder.folder_Exists().is_False() message = <span class="hljs-string">"[assert_That_Not_Folder_Exists]: <span class="hljs-subst">#{folder}</span>"</span> assert(test, message) folder <span class="hljs-attribute">String</span>::assert_Is = <span class="hljs-attribute">String</span>::assert_Is_Equal_To <span class="hljs-attribute">String</span>::assert_Is_Not = <span class="hljs-attribute">String</span>::assert_Is_Not_Equal_To <span class="hljs-attribute">String</span>::assert_Equals = <span class="hljs-attribute">String</span>::assert_Is_Equal_To <span class="hljs-attribute">String</span>::assert_File_Exists = <span class="hljs-attribute">String</span>::assert_That_File_Exists <span class="hljs-attribute">String</span>::assert_File_Not_Exists = <span class="hljs-attribute">String</span>::assert_That_File_Not_Exists <span class="hljs-attribute">String</span>::assert_Folder_Exists = <span class="hljs-attribute">String</span>::assert_That_Folder_Exists <span class="hljs-attribute">String</span>::assert_Folder_Not_Exists = <span class="hljs-attribute">String</span>::assert_That_Folder_Not_Exists <span class="hljs-attribute">String</span>::assert_Size_Is = <span class="hljs-attribute">String</span>::assert_Length_Is <span class="hljs-attribute">String</span>::assert_Size_Is_Not = <span class="hljs-attribute">String</span>::assert_Length_Is_Not</pre></div></div> </li> <li id="section-12"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-12">¶</a> </div> <hr> </div> </li> <li id="section-13"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-13">¶</a> </div> <p>back to <a href="index.html">index</a></p> </div> </li> </ul> </div> </body> </html>