File Coverage

blib/lib/Test/Auto.pm

Criterion	Covered	Total	%
statement	33	94	35.1
branch	4	10	40.0
condition			n/a
subroutine	9	33	27.2
pod	8	17	47.0
total	54	154	35.0

package Test::Auto;

use 5.018;

use strict;
use warnings;

use base 'Venus::Test';

use Test::More;

# VERSION

our $VERSION = '0.13';

# AUTHORITY

our $AUTHORITY = 'cpan:AWNCORP';

# IMPORT

sub import {
  my ($self, @args) = @_;

  my $from = caller;

  no strict 'refs';

  if (!*{"${from}::test"}{"CODE"}) {
    *{"${from}::test"} = \&testauto;
  }

  if (!*{"${from}::testauto"}{"CODE"}) {
    *{"${from}::testauto"} = \&testauto;
  }

  return $self;
}

# BUILDERS

sub build_self {
  my ($self, $data) = @_;

  $self->Venus::Data::build_self($data);

  for my $item (grep !$self->count({name => $_}), qw(
    name abstract synopsis description
  ))
  {
    $self->throw->error({message => "Failed to find =$item"});
  }

  return $self;
};

# FUNCTIONS (< 0.13 API)

sub testauto {
  __PACKAGE__->new($_[0]);
}

# METHODS (< 0.13 API)

sub standard {
  my ($self) = @_;

  # approximating the v1 API subtests
  $self->package;
  $self->document;
  $self->libraries if $self->count({name => 'libraries'});
  $self->inherits if $self->count({name => 'inherits'});
  $self->attributes;
  $self->methods;
  $self->routines;
  $self->functions;
  $self->types;

  return $self;
}

sub package {
  my ($self) = @_;

  # approximating the v1 API subtests
  $self->for('name');

  return $self;
}

sub plugin {
  my ($self, $name) = @_;

  subtest "testing plugin ($name)", sub {
    plan skip_all => "plugins are no longer supported";
  };

  return $self;
}

sub libraries {
  my ($self) = @_;

  # approximating the v1 API subtests
  $self->for('libraries');

  return $self;
}

sub inherits {
  my ($self) = @_;

  # approximating the v1 API subtests
  $self->for('inherits');

  return $self;
}

sub document {
  my ($self) = @_;

  # approximating the v1 API subtests
  subtest "testing document", sub {
    ok $self->data($_), "pod $_" for qw(
      name
      abstract
      synopsis
      abstract
      description
    );
  };

  return $self;
}

sub attributes {
  my ($self) = @_;

  subtest "testing attributes", sub {
    plan skip_all => "< 0.12-style attributes testing is no longer supported";
  };

  return $self;
}

sub methods {
  my ($self) = @_;

  subtest "testing methods", sub {
    plan skip_all => "< 0.12-style methods testing is no longer supported";
  };

  return $self;
}

sub routines {
  my ($self) = @_;

  subtest "testing routines", sub {
    plan skip_all => "< 0.12-style routines testing is no longer supported";
  };

  return $self;
}

sub functions {
  my ($self) = @_;

  subtest "testing functions", sub {
    plan skip_all => "< 0.12-style functions testing is no longer supported";
  };

  return $self;
}

sub types {
  my ($self) = @_;

  subtest "testing types", sub {
    plan skip_all => "< 0.12-style types testing is no longer supported";
  };

  return $self;
}

sub synopsis {
  my ($self, @args) = @_;

  $self->for('synopsis', @args);

  return $self;
}

sub scenario {

  my ($self) = @_;

  subtest "testing scenario", sub {
    plan skip_all => "< 0.12-style scenario testing is no longer supported";
  };

  return $self;
}

sub example {
  my ($self, $id, $name, $type, $code) = @_;

  $self->for('example', ($id < 0 ? -$id : $id), $name, (sub{ $code->(@_); 1 }));

  return $self;
}

sub tests {
  # See "plugin", e.g. $self->plugin($name)->tests;
}

1;


=head1 NAME

Test::Auto - Test Automation

=cut

=head1 ABSTRACT

Test Automation for Perl 5

=cut

=head1 VERSION

0.13

=cut

=head1 SYNOPSIS

  package main;

  use Test::Auto;
  use Test::More;

  my $test = Test::Auto->new(
    't/Test_Auto.t'
  );

  # =synopsis
  #
  # use Path::Find 'path';
  #
  # my $path = path; # get path using cwd
  #
  # =cut

  # $test->for('synopsis', sub {
  #   my ($tryable) = @_;
  #   ok my $result = $tryable->result;
  #
  #   # more test for the synopsis ...
  #
  #   $result
  # });

  # ...

  # $test->render('lib/Path/Find.pod');

  # done_testing

=cut

=head1 DESCRIPTION

This package aims to provide, a standard for documenting Perl 5 software
projects, a framework writing tests, test automation, and documentation
generation.

=head1 AUTOMATION

  # ...

  $test->for('name');

This framework provides a set of automated subtests based on the package
specification, but not everything can be automated so it also provides you with
powerful hooks into the framework for manual testing.

  # ...

  $test->for('synopsis', sub {
    my ($tryable) = @_;

    ok my $result = $tryable->result, 'result ok';

    # must return truthy to cont
    $result;
  });

The code examples documented can be automatically evaluated (evaled) and
returned using a callback you provide for further testing. Because the code
examples are returned as L objects this makes capturing and testing
exceptions simple, for example:

  # ...

  $test->for('synopsis', sub {
    my ($tryable) = @_;

    # catch exception thrown by the synopsis
    $tryable->catch('Path::Find::Error', sub {
      return $_[0];
    });

    # test the exception
    ok my $result = $tryable->result, 'result ok';
    ok $result->isa('Path::Find::Error'), 'exception caught';

    # must return truthy to cont
    $result;
  });

Additionally, another manual testing hook (with some automation) is the
C method. This hook evaluates (evals) a given example and returns the
result as a L object. The first argument is the example ID (or
  number), for example:

  # ...

  $test->for('example', 1, 'children', sub {
    my ($tryable) = @_;

    ok my $result = $tryable->result, 'result ok';

    # must return truthy to cont
    $result;
  });

Finally, the lesser-used but useful manual testing hook is the C
method. This hook evaluates (evals) a documented feature and returns the result
as a L object, for example:

  # ...

  $test->for('feature', 'export-path-make', sub {
    my ($tryable) = @_;

    ok my $result = $tryable->result, 'result ok';

    # must return truthy to cont
    $result;
  });

The test automation and documentation generation enabled through this framework
makes it easy to maintain source/test/documentation parity. This also increases
reusability and reduces the need for complicated state and test setup.

=head1 SPECIFICATION

  # Since 0.13

  # [required]

  =name
  =abstract
  =tagline
  =includes
  =synopsis
  =description

  # [optional]

  =libraries
  =inherits
  =integrates

  # [repeatable; optional]

  =feature $name
  =example $name

  # [repeatable; optional]

  =attribute $name
  =signature $name
  =example-$number $name # [repeatable]

  # [repeatable; optional]

  =method $name
  =signature $name
  =example-$number $name # [repeatable]

  # [repeatable; optional]

  =function $name
  =signature $name
  =example-$number $name # [repeatable]

  # [repeatable; optional]

  =routine $name
  =signature $name
  =example-$number $name # [repeatable]

The specification is designed to accommodate typical package declarations. It
is used by the parser to provide the content used in test automation and
document generation. B When code blocks are evaluated I<"redefined">
warnings are now automatically disabled.

=head2 name

  =name

  Path::Find

  =cut

The C block should contain the package name. This is tested for
loadability.

=head2 tagline

  =tagline

  Path Finder

  =cut

The C block should contain a tagline for the package. This is optional
but if present is concatenated with the C during POD generation.

=head2 abstract

  =abstract

  Find Paths using Heuristics

  =cut

The C block should contain a subtitle describing the package. This is
tested for existence.

=head2 includes

  =includes

  function: path
  method: children
  method: siblings
  method: new

  =cut

The C block should contain a list of C, C, and/or
C names in the format of C<$type: $name>. Empty lines are ignored.
This is tested for existence. Each function, method, and/or routine is tested
to be documented properly, i.e. has the requisite counterparts (e.g. signature
and at least one example block). Also, the package must recognize that each
exists.

=head2 synopsis

  =synopsis

  use Path::Find 'path';

  my $path = path; # get path using cwd

  =cut

The C block should contain the normative usage of the package. This
is tested for existence. This block should be written in a way that allows it
to be evaled successfully and should return a value.

=head2 description

  =description

  interdum posuere lorem ipsum dolor sit amet consectetur adipiscing elit duis
  tristique sollicitudin nibh sit amet

  =cut

The C block should contain a thorough explanation of the purpose
of the package. This is tested for existence.

=head2 libraries

  =libraries

  Types::Standard
  Types::TypeTiny

  =cut

The C block should contain a list of packages, each of which is
itself a L. These packages are tested for loadability, and to
ensure they are type library classes.

=head2 inherits

  =inherits

  Path::Tiny

  =cut

The C block should contain a list of parent packages. These packages
are tested for loadability.

=head2 integrates

  =integrates

  Path::Find::Upable
  Path::Find::Downable

  =cut

The C block should contain a list of packages that are involved in
the behavior of the main package. These packages are not automatically tested.

=head2 features

  =feature export-path-make

  quisque egestas diam in arcu cursus euismod quis viverra nibh

  =example export-path-make

  # given: synopsis

  package main;

  use Path::Find 'path_make';

  path_make 'relpath/to/file';

  =cut


There are situation where a package can be configured in different ways,
especially where it exists without functions, methods or routines for the
purpose of configuring the environment. The feature directive can be used to
automate testing and documenting package usages and configurations. Describing
a feature requires two blocks, i.e. C and C. The
C block should contain a description of the feature and its purpose.
The C block must exist when documenting a feature and should contain
valid Perl code and return a value. The block may contain a "magic" comment in
the form of C or C which if present will
include the given code example(s) with the evaluation of the current block.
Each feature is tested and must be recognized to exist by the main package.

=head2 attributes

  =attribute cwd

  quis viverra nibh cras pulvinar mattis nunc sed blandit libero volutpat

  =signature cwd

  cwd(Str $path) : (Object)

  =example-1 cwd

  # given: synopsis

  my $cwd = $path->cwd;

  =example-2 cwd

  # given: synopsis

  my $cwd = $path->cwd('/path/to/file');

  =cut

Describing an attribute requires at least three blocks, i.e. C
$name>, C, and C. The C block
should contain a description of the attribute and its purpose. The C
block should contain a routine signature in the form of C<$signature :
$return_type>, where C<$signature> is a valid typed signature and
C<$return_type> is any valid L expression. The C
block is a repeatable block, and at least one block must exist when documenting
an attribute. The C block should contain valid Perl code and
return a value. The block may contain a "magic" comment in the form of C
synopsis> or C which if present will include the
given code example(s) with the evaluation of the current block. Each attribute
is tested and must be recognized to exist by the main package.

=head2 methods

  =method children

  quis viverra nibh cras pulvinar mattis nunc sed blandit libero volutpat

  =signature children

  children() : [Object]

  =example-1 children

  # given: synopsis

  my $children = $path->children;

  =example-2 children

  # given: synopsis

  my $filtered = $path->children(qr/lib/);

  =cut

Describing a method requires at least three blocks, i.e. C,
C, and C. The C block should contain
a description of the method and its purpose. The C block should
contain a method signature in the form of C<$signature : $return_type>, where
C<$signature> is a valid typed signature and C<$return_type> is any valid
L expression. The C block is a repeatable block,
and at least one block must exist when documenting a method. The
C block should contain valid Perl code and return a value. The
block may contain a "magic" comment in the form of C or
C which if present will include the given code
example(s) with the evaluation of the current block. Each method is tested and
must be recognized to exist by the main package.

=head2 functions

  =function path

  lectus quam id leo in vitae turpis massa sed elementum tempus egestas

  =signature children

  path() : Object

  =example-1 path

  package Test::Path::Find;

  use Path::Find;

  my $path = path;

  =cut

Describing a function requires at least three blocks, i.e. C,
C, and C. The C block should
contain a description of the function and its purpose. The C block
should contain a function signature in the form of C<$signature :
$return_type>, where C<$signature> is a valid typed signature and
C<$return_type> is any valid L expression. The C
block is a repeatable block, and at least one block must exist when documenting
a function. The C block should contain valid Perl code and
return a value. The block may contain a "magic" comment in the form of C
synopsis> or C which if present will include the
given code example(s) with the evaluation of the current block. Each function
is tested and must be recognized to exist by the main package.

=head2 routines

  =routine algorithms

  sed sed risus pretium quam vulputate dignissim suspendisse in est ante

  =signature algorithms

  algorithms() : Object

  =example-1 algorithms

  # given: synopsis

  $path->algorithms

  =example-2 algorithms

  package Test::Path::Find;

  use Path::Find;

  Path::Find->algorithms;

  =cut

Typically, a Perl subroutine is declared as a function or a method. Rarely, but
sometimes necessary, you will need to describe a subroutine where the invocant
is either a class or class instance. Describing a routine requires at least
three blocks, i.e. C, C, and C
$name>. The C block should contain a description of the routine and
its purpose. The C block should contain a routine signature in the
form of C<$signature : $return_type>, where C<$signature> is a valid typed
signature and C<$return_type> is any valid L expression. The
C block is a repeatable block, and at least one block must
exist when documenting a routine. The C block should contain
valid Perl code and return a value. The block may contain a "magic" comment in
the form of C or C which if
present will include the given code example(s) with the evaluation of the
current block. Each routine is tested and must be recognized to exist by the
main package.

=cut

=head1 INHERITS

This package inherits behaviors from:

L

=cut

=head1 FUNCTIONS

This package provides the following functions:

=cut

=head2 test

  test(Str $file) (Auto)

The test function takes a file path and returns a L object for use
in test automation and documentation rendering. This function is exported
automatically unless a routine of the same name already exists in the calling
package.

I>

=over 4

=item test example 1

  # given: synopsis

  $test = test('t/Test_Auto.t');

  # =synopsis
  #
  # use Path::Find 'path';
  #
  # my $path = path; # get path using cwd
  #
  # =cut

  # $test->for('synopsis', sub {
  #   my ($tryable) = @_;
  #   ok my $result = $tryable->result;
  #
  #   # more test for the synopsis ...
  #
  #   $result
  # });

  # ...

  # $test->render('lib/Path/Find.pod');

  # done_testing

=back

=cut

=head1 METHODS

This package provides the following methods:

=cut

=head2 data

  data(Str $name, Any @args) (Str)

The data method attempts to find and return the POD content based on the name
provided. If the content cannot be found an exception is raised.

I>

=over 4

=item data example 1

  # given: synopsis

  my $data = $test->data('name');

  # Test::Auto

=back

=over 4

=item data example 2

  # given: synopsis

  my $data = $test->data('unknown');

  # Exception! isa (Test::Auto::Error)

=back

=cut

=head2 for

  for(Str $name | CodeRef $code, Any @args) (Any)

The for method attempts to find the POD content based on the name provided and
executes the corresponding predefined test, optionally accepting a callback
which, if provided, will be passes a L object containing the
POD-driven test. The callback, if provided, must always return a true value.
B All automated tests disable the I<"redefine"> class of warnings to
prevent warnings when redeclaring packages in examples.

I>

=over 4

=item for example 1

  # given: synopsis

  my $data = $test->for('name');

  # Test::Auto

=back

=over 4

=item for example 2

  # given: synopsis

  my $data = $test->for('synosis');

  # bless({value => 't/Test_Auto.t'}, 'Test::Auto')

=back

=over 4

=item for example 3

  # given: synopsis

  my $data = $test->for('example', 1, 'data', sub {
    my ($tryable) = @_;
    my $result = $tryable->result;
    ok length($result) > 1;

    $result
  });

  # Test::Auto

=back

=cut

=head2 render

  render(Str $file) (Path)

The render method renders and writes a valid POD document, and returns a
L object representation the POD file specified.

I>

=over 4

=item render example 1

  # given: synopsis

  my $path = $test->render('t/Path_Find.pod');

  # bless({value => 't/Path_Find.pod', 'Venus::Path'})

=back

=cut

=head1 AUTHORS

Awncorp, C

=cut