mary

<!DOCTYPE html> <html> <head> <title>mary.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> mary.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> <a href="https://github.com/alexeypetrushin/mary">Dr. Mary</a> - JavaScript (CoffeeScript) BDD in Object-Oriented way. <pre><code>'Mary'.should match: /ry/ 'Mary'.should be: 'Mary' 'Mary'.should contain: 'ry' 'Mary'.should beEqualTo: 'Mary' 10.should beGreaterThan: 9 fun = -> throw 'some bug' (-> fun()).should throw: 'some bug' _(null).should be: null </code></pre> Every matcher also available in form of method. <pre><code>'Mary'.should().match /ry/ 'Mary'.should().be 'Mary' 'Mary'.should().contain 'ry' 'Mary'.should().beEqualTo 'Mary' 10.should().beGreaterThan 9 fun = -> throw 'some bug' (-> fun()).should().throw 'some bug' _(null).should().be null </code></pre> Mocks and stubs. <pre><code>class Bob hi: -> 'hi' bob = new Bob() bob.spyOn 'hi', andReturn: 'Hello' bob.hi().should be: 'Hello' bob.hi.should().haveBeenCalled() </code></pre> <h3>Control flow helpers.</h3> <code>it.async</code> and <code>it.next</code> helpers allows You to write asynchronous specs. <code>it.async</code> will pause specs execution and will wait untill <code>it.next</code> will be called. <pre><code>it.async "should save object to collection", -> db.collection 'units', (err, collection) -> obj = name: 'Probe', status: 'alive' collection.create obj, (err, result) -> _(err).should be: null it.next() </code></pre> <code>it.sync</code> helper designed to be used with fiber-aware code and wraps the spec inside of <a href="https://github.com/laverdet/node-fibers">Fiber</a>, the previous sample will looks like this. <pre><code>it.async "should save object to collection", -> collection = db.collection 'units' obj = name: 'Probe', status: 'alive' collection.create obj </code></pre> In short, <code>it.sync</code> helps to write asynchrnous code as if it's synchronous. If You need more samples please take a look at <a href="http://alexeypetrushin.github.com/mongo-model">Mongo Model</a> all its specs are writeen using <code>it.sync</code>. <h3>Installation</h3> Node.JS <code>npm install mary</code> Broser <code>add jasmine.js and mary.js to the page</code> You can also use Dr. Marys's own spec as a sample, run it with <code>cake spec</code> and see the result. Dr. Mary is a thin wrapper around the <a href="http://pivotal.github.com/jasmine">Jasmine</a> and <a href="https://github.com/mhevery/jasmine-node">jasmine-node</a> libraries. The project is <a href="https://github.com/alexeypetrushin/mary">hosted on GitHub</a>, You can report bugs and discuss features on the <a href="https://github.com/alexeypetrushin/mary/issues">issues page</a>. Copyright (c) Alexey Petrushin <a href="http://petrush.in">http://petrush.in</a>, released under the MIT license. </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> <h3>Source Code</h3> </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> Checking for presence of Jasmine. </td> <td class="code"> <div class="highlight"><pre>throw new Error("no jasmine (mary requires jasmine BDD framework)!") unless jasmine?</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> Adding some useful matchers to Jasmine. </td> <td class="code"> <div class="highlight"><pre>jasmine.Matchers.prototype.toInclude = (expected) -> if @actual.indexOf @actual.indexOf(expected) >= 0 else expected of @actual jasmine.Matchers.prototype.toInclude = jasmine.Matchers.matcherFn_( 'toInclude', jasmine.Matchers.prototype.toInclude )</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> Mary. </td> <td class="code"> <div class="highlight"><pre>Mary = {}</pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> Matcher. </td> <td class="code"> <div class="highlight"><pre>class Mary.Matcher constructor: (@obj) -> @expect = expect obj</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> Expectations with expected value. </td> <td class="code"> <div class="highlight"><pre> include : (o) -> @expect.toInclude o beEqualTo : (o) -> @expect.toEqual o be : (o) -> @expect.toEqual o match : (o) -> @expect.toMatch o contain : (o) -> @expect.toContain o beLessThan : (o) -> @expect.toBeLessThan o beGreaterThan : (o) -> @expect.toBeGreaterThan o throw : (o) -> @expect.toThrow o raise : (o) -> @expect.toThrow o</pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> Expectations without expected value. </td> <td class="code"> <div class="highlight"><pre> beNull : () -> @expect.toBeNull() beTrue : () -> @expect.toBeTruthy() beFalse : () -> @expect.toBeFalsy() beDefined : () -> @expect.toBeDefined() beUndefined : () -> @expect.toBeUndefined()</pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">¶</a> </div> Stubs and mocks. </td> <td class="code"> <div class="highlight"><pre> haveBeenCalled : () -> @expect.toHaveBeenCalled() haveBeenCalledWith : (args...) -> @expect.toHaveBeenCalledWith.apply(@expect, args)</pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">¶</a> </div> Apply matchers defined as hash, i.e. <code>be: null</code>. </td> <td class="code"> <div class="highlight"><pre> applyHashMatchers: (args) -> if args then for matcher, value of args @[matcher](value) @</pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">¶</a> </div> Negative matcher. </td> <td class="code"> <div class="highlight"><pre>class Mary.NegativeMatcher extends Mary.Matcher constructor: (@obj) -> @expect = expect(obj).not</pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">¶</a> </div> <code>should</code> and <code>shouldNot</code> methods. </td> <td class="code"> <div class="highlight"><pre>getValue = (obj) -> if obj.hasOwnProperty('_wrapped') obj._wrapped else obj.valueOf() methods = should: (args) -> new Mary.Matcher(getValue(@)).applyHashMatchers(args) shouldNot: (args) -> new Mary.NegativeMatcher(getValue(@)).applyHashMatchers(args) spyOn: (method, options) -> spy = spyOn(getValue(@), method) if options then for method, arg of options spy[method](arg) spy</pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">¶</a> </div> Extending native types with <code>should</code> methods. </td> <td class="code"> <div class="highlight"><pre>types = [ Object.prototype String.prototype Number.prototype Array.prototype Boolean.prototype Date.prototype Function.prototype RegExp.prototype ] for type in types for name, method of methods Object.defineProperty type, name, enumerable: false writable: true configurable: true value: method</pre></div> </td> </tr> <tr id="section-14"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-14">¶</a> </div> It's impossible to extend <code>null</code> and <code>undefined</code>, so we use a wrapper, i.e. <code>_(null).shouldBe().undefined()</code>. Sometimes such wrapper may be already defined (by underscore.js for example), if it's not we defining it. </td> <td class="code"> <div class="highlight"><pre>wrapper = (obj) -> wrapper = new Object() wrapper._wrapped = obj wrapper</pre></div> </td> </tr> <tr id="section-15"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-15">¶</a> </div> Flow. Sample: it.async "should provide handy shortcuts to databases", -> $db.collection 'test', (err, collection) -> collection.name.should be: 'test' it.next() </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> Block and waits untill <code>it.next()</code> is called. </td> <td class="code"> <div class="highlight"><pre>it.async = (desc, func) -> it desc, -> it.finished = false func() waitsFor (-> it.finished), desc, 1000</pre></div> </td> </tr> <tr id="section-17"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-17">¶</a> </div> Resumes execution of <code>it.async</code>. </td> <td class="code"> <div class="highlight"><pre>it.next = (e) -> it.lastError = e it.finished = true</pre></div> </td> </tr> <tr id="section-18"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-18">¶</a> </div> Wraps spec into Fiber. </td> <td class="code"> <div class="highlight"><pre>it.sync = (desc, callback) -> try require 'fibers' catch e console.log """ WARN: You are trying to use synchronous mode. Synchronous mode is optional and requires additional `fibers` library. It seems that there's no such library in Your system. Please install it with `npm install fibers`.""" throw e it.async desc, -> Fiber(-> callback() it.next() ).run()</pre></div> </td> </tr> <tr id="section-19"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-19">¶</a> </div> Setting up globals. </td> <td class="code"> <div class="highlight"><pre>if module? and module.exports? exports.Mary = Mary exports._ = wrapper if window? window.Mary = Mary window._ ||= wrapper </pre></div> </td> </tr> </tbody> </table> </div> </body> </html>