2017 © Pedro Peláez
 

library speculator

A tool for displaying software specifications with their unit test status.

image

gcdtech/speculator

A tool for displaying software specifications with their unit test status.

  • Thursday, July 19, 2018
  • by acuthbert
  • Repository
  • 0 Watchers
  • 0 Stars
  • 3,326 Installations
  • 3 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 5 Versions
  • 15 % Grown

The README.md

README

Speculator is a small self contained web server present software specifications and the status of unit tests covering those specifications., (*1)

Install

Use composer require gcdtech/speculator, (*2)

Usage

Note these examples assume your bin-dir composer property is set to "bin/". If yours differs be sure to change the path to speculator., (*3)

Invoke speculator using the terminal:, (*4)

``` bash bin/speculator [pathtospecs] [pathtotests] [bootstrap-php-file], (*5)


Or create a speculator.json file in the same folder e.g.

``` javascript
{
  "specs-dir": "specs",
  "tests-dir": "tests/unit",
  "bootstrap": "tests/_bootstrap.php"
}

And this invoke in a simpler way:, (*6)

``` bash bin/speculator, (*7)


## Specification Documents

Specification documents are simply markdown files that live in a folder normally called `specs`.

`index.md` should exist as an root entry page.

Create links between your pages in the normal markdown way.

Inject a unit test assessment using the following syntax:

(@Path/To/Unit/Test::testMethodName) ```, (*8)

If this exists inside a bullet item then the bullet style will change to a tick or an x depending on the test success. Otherwise a tick or x will be dropped in place of the test marker., (*9)

Extended markdown syntax

This project uses the erusev/parsedown-extra parser for markdown which provides a range of additional markdown goodies., (*10)

The Versions

19/07 2018

dev-master

9999999-dev https://bitbucket.org/gcdtech/speculator

A tool for displaying software specifications with their unit test status.

  Sources   Download

proprietary

The Requires

 

The Development Requires

by Andrew Cuthbert

19/07 2018

1.0.3

1.0.3.0 https://bitbucket.org/gcdtech/speculator

A tool for displaying software specifications with their unit test status.

  Sources   Download

proprietary

The Requires

 

The Development Requires

by Andrew Cuthbert

01/06 2017

1.0.2

1.0.2.0 https://bitbucket.org/gcdtech/speculator

A tool for displaying software specifications with their unit test status.

  Sources   Download

proprietary

The Requires

 

by Andrew Cuthbert

15/02 2017

1.0.1

1.0.1.0

A tool for displaying software specifications with their unit test status.

  Sources   Download

proprietary

The Requires

 

by Andrew Cuthbert

09/02 2017

1.0.0

1.0.0.0

A tool for displaying software specifications with their unit test status.

  Sources   Download

proprietary

The Requires

 

by Andrew Cuthbert