File Coverage

blib/lib/Test/Pcuke/Gherkin.pm

Criterion	Covered	Total	%
statement	12	16	75.0
branch			n/a
condition			n/a
subroutine	4	5	80.0
pod	1	1	100.0
total	17	22	77.2

package Test::Pcuke::Gherkin;

use warnings;
use strict;

use Test::Pcuke::Gherkin::Parser;
use Test::Pcuke::Gherkin::Lexer;

=head1 NAME

Test::Pcuke::Gherkin - roll your own cucumber

=head1 VERSION

Version 0.000001

=cut

our $VERSION = '0.000003';


=head1 SYNOPSIS

This module compiles text in Gherkin to the executable AST. If you don't like
L you can roll your own BDD cucumber-like tool!

    use Test::Pcuke::Gherkin;

    my $feature = Test::Pcuke::Gherkin->compile($content, $executor);

    $feature->execute;
    ...


=head1 METHODS

=head2 compile $content, $executor

I<$content> is a text in Gherkin language. It should be decoded string,
not octets, especially if the text is written in language other than english

I<$executor> is (optional) object, that has execute() method.
If I<$executor> is not provided an internal and useless one is used to execute
the steps. See 'ON EXECUTORS' below;

Returns L object (feature object)
=cut

sub compile {
	my ($self, $content, $executor) = @_;

	my $tokens = Test::Pcuke::Gherkin::Lexer->scan( $content );

	my $parser = Test::Pcuke::Gherkin::Parser->new( { executor => $executor } );

	return $parser->parse( $tokens );

}

1; # End of Test::Pcuke::Gherkin
__END__