.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Test::BDD::Cucumber::Manual::Steps 3pm"
.TH Test::BDD::Cucumber::Manual::Steps 3pm "2014-10-09" "perl v5.20.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Test::BDD::Cucumber::Manual::Steps \- How to write Step Definitions
.SH "VERSION"
.IX Header "VERSION"
version 0.31
.SH "INTRODUCTION"
.IX Header "INTRODUCTION"
The 'code' part of a Cucumber test-suite are the Step Definition files which
match steps, and execute code based on them. This document aims to give you a
quick overview of those.
.SH "STARTING OFF"
.IX Header "STARTING OFF"
Most of your step files will want to start something like:
.PP
.Vb 1
\& #!perl
\&
\& use strict;
\& use warnings;
\&
\& use Test::More;
\& use Test::BDD::Cucumber::StepFile;
.Ve
.PP
The fake shebang line gives some hints to syntax highlighters, and
\&\f(CW\*(C`use strict;\*(C'\fR and \f(CW\*(C`use warnings;\*(C'\fR are hopefully fairly standard at this point.
.PP
Most of \fImy\fR Step Definition files make use of Test::More, but you can use
any Test::Builder based testing module. Your step will pass its pass or fail
status back to its harness via Test::Builder \- \fBeach step is run as if it
were its own tiny test file\fR, with its own localized Test::Builder object.
.PP
Test::BDD::Cucumber::StepFile gives us the functions \f(CW\*(C`Given()\*(C'\fR, \f(CW\*(C`When()\*(C'\fR,
\&\f(CW\*(C`Then()\*(C'\fR and \f(CW\*(C`Step()\*(C'\fR. These pass the step definitions to the class loading
the step definitions, and specify which Step Verb should be used \- \f(CW\*(C`Step()\*(C'\fR
matches any.
.SH "STEP DEFINITIONS"
.IX Header "STEP DEFINITIONS"
.Vb 3
\& Given qr/I have (\ed+)/, sub {
\&    S\->{\*(Aqcount\*(Aq} += $1;
\& }
\&
\& When "The count is an integer", sub {
\&    S\->{\*(Aqcount\*(Aq} =
\&        int( S\->{\*(Aqcount\*(Aq} );
\& }
\&
\& Then qr/The count should be (\ed+)/, sub {
\&    is( S\->{\*(Aqcount\*(Aq}, C\->matches\->[0], "Count matches" );
\& }
.Ve
.PP
Each of the exported verb functions accept a regular expression (or a string
that's used as one), and a coderef. The coderef is passed a single argument,
the Test::BDD::Cucumber::StepContext object. Before the subref is executed,
localized definitions of \f(CW\*(C`S\*(C'\fR and \f(CW\*(C`C\*(C'\fR are set, such that the lines below are
equivalent:
.PP
.Vb 3
\&  # Access the first match
\&  sub { my $context = shift; print $context\->matches\->[0] }
\&  sub { C\->matches\->[0] }
\&
\&  # Set a value in the scenario\-level stash
\&  sub { my $context = shift; my $stash = $context\->stash; $stash\->{\*(Aqcount\*(Aq} = 1 }
\&  sub { S\->{\*(Aqcount\*(Aq} = 1 }
.Ve
.PP
We will evaluate the regex immediately before we execute the coderef, so you
can use \f(CW$1\fR, \f(CW$2\fR, \f(CW$etc\fR, although these are also available via the StepContext.
.SH "NEXT STEPS"
.IX Header "NEXT STEPS"
How step files are loaded is discussed in
Test::BDD::Cucumber::Manual::Architecture, but isn't of much interest. Of
far more interest should be seeing what you have available in
Test::BDD::Cucumber::StepContext...
.SH "AUTHOR"
.IX Header "AUTHOR"
Peter Sergeant \f(CW\*(C`pete@clueball.com\*(C'\fR
.SH "LICENSE"
.IX Header "LICENSE"
Copyright 2011\-2014, Peter Sergeant; Licensed under the same terms as Perl