Helper functions. Before or after the spec definition?

[mokagio]

Often we define helper functions, to DRY our specs. Should they go before or after the spec definition?

Please vote with a 👍 on the option that you prefer.

[mokagio]

Before

private func makeFoo() -> Foo {
  return Foo(a: "b", c: "d")
}

final class BarSpec: QuickSpec {
  it("bars") {
    expect(Bar.bar(with: makeFoo()).to(beTrue())
  }
}

[mokagio]

After

final class BarSpec: QuickSpec {
  it("bars") {
    expect(Bar.bar(with: makeFoo()).to(beTrue())
  }
}

private func makeFoo() -> Foo {
  return Foo(a: "b", c: "d")
}

[mokagio]

My vote goes to after.

The reason I like it is because to a reader the most important thing is to read the spec code, and as such it should come earlier. Having all the secondary information, the helper function bodies etc, later on, allows a reader to focus on the core of the logic first, and drill down on the details only if they need.

This is inspired by the teachings of the book Clean Code.

[RodBrown1988]

I vote for after as well, for the same reasons.

The Spec itself is the test, and therefore the appropriate element for focus in the file. Additional helpers are more implementation details, which are often not relevant when you are examining and trying to understand the test.