README

Part of Barn.

Generates Scenario Runner Port stub classes from a captured Barnspec area of business — one Arrange and Assert per Subject → Fact, one Act per Action, one Authenticate per Role — ready for you to fill in with real application logic. It can also check the generated files for drift.

It ships as a library plus the port-generator command.

Requirements

PHP 8.5+
rmb32/barnspec, Barncept and Barnscaff
A project with captured Barnspec data (.barnspec/) — see Barnspec CLI

Installation

composer require --dev rmb32/port-generator

Configuration

Create barnspec.json at your project root (next to .barnspec/):

{
    "portStubs": {
        "directory": "tests/Barnspec/Port",
        "namespace": "App\\Tests\\Barnspec\\Port"
    }
}

Inside a barn

In a barn (a project whose root holds .barn/barn.json), the config is .barn/barnspec.json and the stories are in .barn/barnspec/. Commands work from any folder inside the barn, and a relative portStubs.directory is taken from the barn's root, not from where you run them.

Usage

vendor/bin/port-generator generate <area-of-business-slug>
vendor/bin/port-generator check <area-of-business-slug>

generate writes stubs and never overwrites an existing file, so re-running after capturing new vocabulary is safe. Each area of business gets its own folder and namespace beneath portStubs — e.g. tests/Barnspec/Port/RoomManagement/Fact/Room/IsOnOfferArrange.php — so a Fact named the same in two areas is two Ports.
check reports Missing, Unexpected, Misplaced and TypeMismatch files in the output directory — useful after renaming or deleting a Fact, Action or Role. Until its Phase is released, a Subject, Fact or Action can be reworded or deleted; generate then writes the stub under its new name, and check lists the old file as Unexpected for you to move your code from and delete.
Vocabulary that only replaced Scenarios use — every Scenario using it was amended or retired by an elaboration in a released Phase — has nothing left to prove: generate no longer writes its stubs, and check reports any still on disk as Retired, safe to delete. Vocabulary no Scenario uses yet is still generated.

Generated stubs throw a TODO until you fill them in. Once you have, run your scenarios with Scenario Bridge.

Ports are built with new by default. To give them constructor dependencies — your application's handlers, say — name a Scenario Runner PortFactory that hands them out of your container:

{
    "portStubs": {
        "directory": "tests/Barnspec/Port",
        "namespace": "App\\Tests\\Barnspec\\Port",
        "factory": "App\\Tests\\Barnspec\\ContainerPorts"
    }
}

rmb32 / port-generator

Package info

Security

Statistics

README

Requirements

Installation

Configuration

Inside a barn

Usage

Related packages

More docs

License