boco-mdd-jasmine-coffee

Jasmine + CoffeeScript generator for boco-markdown-driven.

Installation
Using the CLI
Using the API

Installation

Install both this library and boco-markdown-driven via npm:

$ npm install boco-mdd-jasmine-coffee boco-markdown-driven

Using the CLI

Create a configuration file called markdown-driven.json:

// file: "markdown-driven.json"
{
  "generator": "boco-mdd-jasmine-coffee",
  "parserOptions": {
    "nativeLanguages": ["coffee", "coffeescript"],
    "assertionCodePattern": /\bexpect\b/
  },
  "converterOptions": {
    "readDir": "docs",
    "writeDir": "spec",
    "writeExt": ".spec.coffee"
  }
}

Run the CLI:

$ boco-markdown-driven -c markdown-driven.json "docs/**/*.coffee.md"

See the CLI documentation on boco-markdown-driven for more information.

Using the API

note: you can view the example markdown and coffeescript files at the end of this section

JasmineCoffee = require 'boco-mdd-jasmine-coffee'
MarkdownDriven = require 'boco-markdown-driven'

generator = new JasmineCoffee.Generator
compiler = new MarkdownDriven.Compiler generator: generator

The compiler will now generate jasmine specs for your markdown:

markdown = $files['example.coffee.md']
expected = $files['example.spec.coffee']

compiled = compiler.compile $files['example.coffee.md']
expect(compiled).toEqual expected

<!-- file: "example.coffee.md" -->
# Mather

Mather is a library for doing Math.

    Mather = require "mather"
    mather = new Mather

The following is made available to the `$files` variable:

    # file: "foo.coffee"
    # and this is the content

## Adding numbers

It adds two numbers:

    mather.add 2, 2, (error, result) ->
      throw error if error?
      expect(result).toEqual 4
      ok()

It adds more than two numbers:

    mather.add 3, 4, 5, (error, result) ->
      throw error if error?
      expect(result).toEqual 12
      ok()

# file: "example.spec.coffee"
$files = {}

describe "Mather", ->
  [Mather, mather] = []

  beforeEach ->
    $files["foo.coffee"] = "# and this is the content\n"

    Mather = require "mather"
    mather = new Mather

  afterEach ->
    delete $files["foo.coffee"]

  describe "Adding numbers", ->

    it "It adds two numbers:", (ok) ->
      mather.add 2, 2, (error, result) ->
        throw error if error?
        expect(result).toEqual 4
        ok()

    it "It adds more than two numbers:", (ok) ->
      mather.add 3, 4, 5, (error, result) ->
        throw error if error?
        expect(result).toEqual 12
        ok()

The MIT License (MIT)

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.

bocodigitalmedia / boco-mdd-jasmine-coffee Goto Github PK