NAME

Venus::Test - Test Class

ABSTRACT

Test Class for Perl 5

SYNOPSIS

  package main;
  use Venus::Test;
  my $test = Venus::Test->new('t/Venus_Test.t');
  # $test->for('name');
  # $test->for('tagline');
  # $test->for('abstract');
  # $test->for('synopsis');
  # $test->done;

DESCRIPTION

This package aims to provide a standard for documenting Venus derived software projects, a framework writing tests, test automation, and documentation generation. This package will automatically exports "true", "false", and "test" keyword functions.

SPECIFICATION

This section describes the specification format used by Venus::Test to generate documentation and automate testing for Perl packages. The specification uses specially formatted POD blocks that serve as both human-readable documentation and executable test cases.

Note: When code blocks are evaluated, "redefined" warnings are automatically disabled.

  # [required]
  =name
  =abstract
  =tagline
  =synopsis
  =description
  # [optional]
  =encoding
  =includes
  =libraries
  =inherits
  =integrates
  # [optional; repeatable]
  =attribute $name
  =signature $name
  =metadata $name
  =example-$number $name
  =raise $name $error ($id optional)
  =function $name
  =signature $name
  =metadata $name
  =example-$number $name
  =raise $name $error ($id optional)
  =message $name
  =signature $name
  =metadata $name
  =example-$number $name
  =method $name
  =signature $name
  =metadata $name
  =example-$number $name
  =raise $name $error ($id optional)
  =routine $name
  =signature $name
  =metadata $name
  =example-$number $name
  =raise $name $error ($id optional)
  =feature $name
  =metadata $name
  =example-$number $name
  =error $name
  =example-$number $name
  =operator $name
  =example-$number $name
  # [optional]
  =layout
  =partials
  =authors
  =license
  =project
  =version

REQUIRED BLOCKS

These blocks must be present in every specification document.

  =name
  Example
  =cut
  $test->for('name');

  =abstract
  Example Test Documentation
  =cut
  $test->for('abstract');

  =tagline
  Example Class
  =cut
  $test->for('tagline');

  =synopsis
    use Example;
    my $example = Example->new;
    # bless(..., "Example")
  =cut
  $test->for('synopsis', sub {
    my ($tryable) = @_;
    $tryable->result;
  });

  =description
  This package provides an example class.
  =cut
  $test->for('description');

PACKAGE BLOCKS

These optional blocks define the package's relationships and dependencies.

  =includes
  function: eg
  method: prepare
  method: execute
  =cut
  $test->for('includes');

  =libraries
  Venus::Check
  =cut
  $test->for('libraries');

  =inherits
  Venus::Core::Class
  =cut
  $test->for('inherits');

  =integrates
  Venus::Role::Catchable
  Venus::Role::Throwable
  =cut
  $test->for('integrates');

API BLOCKS

These blocks document the package's interface: attributes, methods, functions, messages, and routines. Each API block follows a common pattern requiring a description block, a signature block, and at least one example block.

  =$type $name               # Description of the $type
  =signature $name           # Type signature
  =metadata $name            # Optional metadata (since, deprecated, etc.)
  =example-1 $name           # First example (required)
  =example-2 $name           # Additional examples (optional)
  =raise $name $error        # Document exceptions (optional)
  =raise $name $error $id    # Exception with named error (optional)
  ...

  =attribute name
  The name attribute is read-write, optional, and holds a string.
  =signature name
    name(string $value) (string)
  =metadata name
  since: 1.0.0
  =example-1 name
    # given: synopsis
    my $name = $example->name;
    # "..."
  =cut
  $test->for('attribute', 'name');
  $test->for('example', 1, 'name', sub {
    my ($tryable) = @_;
    $tryable->result;
  });

  =method prepare
  The prepare method prepares for execution.
  =signature prepare
    prepare() (boolean)
  =example-1 prepare
    # given: synopsis
    my $prepare = $example->prepare;
    # "..."
  =cut
  $test->for('method', 'prepare');
  $test->for('example', 1, 'prepare', sub {
    my ($tryable) = @_;
    $tryable->result;
  });

  =function eg
  The eg function returns a new instance of Example.
  =signature eg
    eg() (Example)
  =example-1 eg
    # given: synopsis
    my $example = eg();
    # "..."
  =cut
  $test->for('function', 'eg');
  $test->for('example', 1, 'eg', sub {
    my ($tryable) = @_;
    $tryable->result;
  });

  =routine process
  The process routine processes and returns data.
  =signature process
    process(any @args) (any)
  =example-1 process
    # given: synopsis
    my $result = $example->process;
    # "..."
  =cut
  $test->for('routine', 'process');
  $test->for('example', 1, 'process', sub {
    my ($tryable) = @_;
    $tryable->result;
  });

  =message accept
  The accept message represents acceptance.
  =signature accept
    accept(any @args) (string)
  =example-1 accept
    # given: synopsis
    my $accept = $example->accept;
    # "..."
  =cut
  $test->for('message', 'accept');
  $test->for('example', 1, 'accept', sub {
    my ($tryable) = @_;
    $tryable->result;
  });

SUPPORTING BLOCKS

These blocks provide additional context for API documentation.

  =signature prepare
    prepare() (boolean)
  =cut
  $test->for('signature', 'prepare');

  =example-1 name
    # given: synopsis
    my $name = $example->name;
    # "..."
  =cut
  $test->for('example', 1, 'name', sub {
    my ($tryable) = @_;
    $tryable->result;
  });

  =metadata prepare
  {since => "1.2.3"}
  =cut
  $test->for('metadata', 'prepare');

  =metadata prepare
  introduced: 1.2.3
  deprecated: 2.0.0
  =cut

  =raise execute Venus::Error
    # given: synopsis
    $example->operation; # throw exception
    # Error
  =cut
  $test->for('raise', 'execute', 'Venus::Error', sub {
    my ($tryable) = @_;
    my $error = $tryable->error->result;
    $test->is_error($error);
  });

  =raise execute Venus::Error on.unknown
    # given: synopsis
    $example->operation; # throw exception
    # Error (on.unknown)
  =cut
  $test->for('raise', 'execute', 'Venus::Error', 'on.unknown', sub {
    my ($tryable) = @_;
    my $error = $tryable->error->result;
    $test->is_error($error);
    $test->is($error->name, 'on.unknown');
  });

FEATURE BLOCKS

These blocks document special capabilities, errors, and operator overloads.

  =feature noop
  This package provides no particularly useful features.
  =example-1 noop
    # given: synopsis
    my $feature = $example->feature;
    # "..."
  =cut
  $test->for('feature');
  $test->for('example', 1, 'noop', sub {
    my ($tryable) = @_;
    $tryable->result;
  });

  =error error_on_unknown
  This package may raise an error_on_unknown error.
  =example-1 error_on_unknown
    # given: synopsis
    my $error = $example->catch('error', {
      with => 'error_on_unknown',
    });
    # "..."
  =cut
  $test->for('error', 'error_on_unknown');
  $test->for('example', 1, 'error_on_unknown', sub {
    my ($tryable) = @_;
    $tryable->result;
  });

  =operator ("")
  This package overloads the C<""> operator.
  =example-1 ("")
    # given: synopsis
    my $string = "$example";
    # "..."
  =cut
  $test->for('operator', '("")');
  $test->for('example', 1, '("")', sub {
    my ($tryable) = @_;
    $tryable->result;
  });

CONTROL BLOCKS

These blocks control how documentation is rendered.

  =encoding
  utf8
  =cut
  $test->for('encoding');

  =layout
  encoding
  name
  synopsis
  description
  attributes: attribute
  authors
  license
  =cut
  $test->for('layout');

  =partials
  t/path/to/other.t: present: authors
  t/path/to/other.t: present: license
  =cut
  $test->for('partials');

PROJECT BLOCKS

These blocks provide metadata about the project.

  =authors
  Awncorp, C<awncorp@cpan.org>
  =cut
  $test->for('authors');

  =license
  No license granted.
  =cut
  $test->for('license');

  =project
  https://github.com/awncorp/example
  =cut
  $test->for('project');

  =version
  1.2.3
  =cut
  $test->for('version');

TESTING

This framework provides automated subtests based on the package specification, but also provides hooks for manual testing when automation is not sufficient.

  $test->for('name');
  $test->for('abstract');
  $test->for('description');

  $test->for('synopsis', sub {
    my ($tryable) = @_;
    my $result = $tryable->result;
    # must return truthy to continue
    $result;
  });

  $test->for('synopsis', sub {
    my ($tryable) = @_;
    # catch exception thrown by the synopsis
    $tryable->catch('Path::Find::Error', sub {
      return $_[0];
    });
    # test the exception
    my $result = $tryable->result;
    ok $result->isa('Path::Find::Error'), 'exception caught';
    # must return truthy to continue
    $result;
  });

  $test->for('example', 1, 'children', sub {
    my ($tryable) = @_;
    my $result = $tryable->result;
    # must return truthy to continue
    $result;
  });

  $test->for('feature', 'export-path-make', sub {
    my ($tryable) = @_;
    ok my $result = $tryable->result, 'result ok';
    # must return truthy to continue
    $result;
  });

ATTRIBUTES

This package has the following attributes:

  file(string $data) (string)

INHERITS

This package inherits behaviors from:

Venus::Kind

INTEGRATES

This package integrates behaviors from:

Venus::Role::Buildable

Venus::Role::Encaseable

FUNCTIONS

This package provides the following functions:

  test(string $file) (Venus::Test)

METHODS

This package provides the following methods:

  auto(string $name, any @args) (any)

  diag(string @messages) (any)

  done() (any)

  eval(string $perl) (any)

  explain(any @args) (any)

  fail(any $data, string $description) (any)

  for(any @args) (Venus::Test)

  gate(string $note, coderef $code) (Venus::Test)

  handler(any @args) (any)

  in(arrayref | hashref | consumes[Venus::Role::Mappable] $collection, any $value) (boolean)

  is(any $data1, any $data2, string $description) (any)

  is_arrayref(any $data, string @args) (boolean)

  is_blessed(any $data, string @args) (boolean)

  is_boolean(any $data, string @args) (boolean)

  is_coderef(any $data, string @args) (boolean)

  is_dirhandle(any $data, string @args) (boolean)

  is_enum(any $data, arrayref | hashref $data, string @args) (boolean)

  is_error(any $data, string @args) (boolean)

  is_false(any $data, string @args) (boolean)

  is_fault(any $data, string @args) (boolean)

  is_filehandle(any $data, string @args) (boolean)

  is_float(any $data, string @args) (boolean)

  is_glob(any $data, string @args) (boolean)

  is_hashref(any $data, string @args) (boolean)

  is_number(any $data, string @args) (boolean)

  is_object(any $data, string @args) (boolean)

  is_package(any $data, string @args) (boolean)

  is_reference(any $data, string @args) (boolean)

  is_regexp(any $data, string @args) (boolean)

  is_scalarref(any $data, string @args) (boolean)

  is_string(any $data, string @args) (boolean)

  is_true(any $data, string @args) (boolean)

  is_undef(any $data, string @args) (boolean)

  is_value(any $data, string @args) (boolean)

  is_yesno(any $data, string @args) (boolean)

  isnt(any $data1, any $data2, string $description) (any)

  isnt_arrayref(any $data, string @args) (boolean)

  isnt_blessed(any $data, string @args) (boolean)

  isnt_boolean(any $data, string @args) (boolean)

  isnt_coderef(any $data, string @args) (boolean)

  isnt_dirhandle(any $data, string @args) (boolean)

  isnt_enum(any $data, arrayref | hashref $data, string @args) (boolean)

  isnt_error(any $data, string @args) (boolean)

  isnt_false(any $data, string @args) (boolean)

  isnt_fault(any $data, string @args) (boolean)

  isnt_filehandle(any $data, string @args) (boolean)

  isnt_float(any $data, string @args) (boolean)

  isnt_glob(any $data, string @args) (boolean)

  isnt_hashref(any $data, string @args) (boolean)

  isnt_number(any $data, string @args) (boolean)

  isnt_object(any $data, string @args) (boolean)

  isnt_package(any $data, string @args) (boolean)

  isnt_reference(any $data, string @args) (boolean)

  isnt_regexp(any $data, string @args) (boolean)

  isnt_scalarref(any $data, string @args) (boolean)

  isnt_string(any $data, string @args) (boolean)

  isnt_true(any $data, string @args) (boolean)

  isnt_undef(any $data, string @args) (boolean)

  isnt_value(any $data, string @args) (boolean)

  isnt_yesno(any $data, string @args) (boolean)

  lfile() (Venus::Path)

  like(string $data, string | Venus::Regexp $match, string $description) (any)

  mktemp_dir() (Venus::Path)

  mktemp_file() (Venus::Path)

  new(any @args) (Venus::Test)

  note(string @messages) (any)

  only_if(string | coderef $code) (Venus::Test)

  os() (Venus::Os)

  os_is_bsd() (boolean)

  os_is_cyg() (boolean)

  os_is_dos() (boolean)

  os_is_lin() (boolean)

  os_is_mac() (boolean)

  os_is_non() (boolean)

  os_is_sun() (boolean)

  os_is_vms() (boolean)

  os_is_win() (boolean)

  os_isnt_bsd() (boolean)

  os_isnt_cyg() (boolean)

  os_isnt_dos() (boolean)

  os_isnt_lin() (boolean)

  os_isnt_mac() (boolean)

  os_isnt_non() (boolean)

  os_isnt_sun() (boolean)

  os_isnt_vms() (boolean)

  os_isnt_win() (boolean)

  pass(any $data, string $description) (any)

  patch(string $name, coderef $code) (coderef)

  path(string $path) (Venus::Path)

  pfile() (Venus::Path)

  render(string $file) (Venus::Path)

  same(any $data1, any $data2, string $description) (any)

  skip(string $reason) (any)

  skip_if(string | coderef $code) (Venus::Test)

  space(string $package) (Venus::Space)

  subtest(string $name, coderef $code) (any)

  text() (Venus::Text::Pod)

  tfile() (Venus::Path)

  type(any $data, string $expression, string @args) (boolean)

  unlike(string $data, regexp $regex, string $description) (any)

  unpatch(string @names) (Venus::Space)

FEATURES

This package provides the following features:

collect

  collect(string $name, any @args) (any)
    

The collect method dispatches to the "collect_data_for_${name}" method indictated by the first argument and returns the result. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # given: synopsis
  package main;
  my ($collect) = $test->collect('name');
  # "Venus::Test"
    

example 2

  # given: synopsis
  package main;
  my $collect = $test->collect('name');
  # ["Venus::Test"]
    

collect_data_for_abstract

  collect_data_for_abstract() (arrayref)
    

The collect_data_for_abstract method uses "data" to fetch data for the "abstract" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =abstract
  #
  # Example Test Documentation
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_abstract = $test->collect_data_for_abstract;
  # ["Example Test Documentation"]
    

example 2

  # =abstract
  #
  # Example Test Documentation
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_abstract) = $test->collect_data_for_abstract;
  # "Example Test Documentation"
    

collect_data_for_attribute

  collect_data_for_attribute(string $name) (arrayref)
    

The collect_data_for_attribute method uses "data" to fetch data for the "attribute $name" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =attribute name
  #
  # The name attribute is read-write, optional, and holds a string.
  #
  # =cut
  #
  # =example-1 name
  #
  #   # given: synopsis
  #
  #   my $name = $example->name;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_attribute = $test->collect_data_for_attribute('name');
  # ["The name attribute is read-write, optional, and holds a string."]
    

example 2

  # =attribute name
  #
  # The name attribute is read-write, optional, and holds a string.
  #
  # =cut
  #
  # =example-1 name
  #
  #   # given: synopsis
  #
  #   my $name = $example->name;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_attribute) = $test->collect_data_for_attribute('name');
  # "The name attribute is read-write, optional, and holds a string."
    

collect_data_for_authors

  collect_data_for_authors() (arrayref)
    

The collect_data_for_authors method uses "data" to fetch data for the "authors" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =authors
  #
  # Awncorp, C<awncorp@cpan.org>
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_authors = $test->collect_data_for_authors;
  # ["Awncorp, C<awncorp@cpan.org>"]
    

example 2

  # =authors
  #
  # Awncorp, C<awncorp@cpan.org>
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_authors) = $test->collect_data_for_authors;
  # "Awncorp, C<awncorp@cpan.org>"
    

collect_data_for_description

  collect_data_for_description() (arrayref)
    

The collect_data_for_description method uses "data" to fetch data for the "description" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =description
  #
  # This package provides an example class.
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_description = $test->collect_data_for_description;
  # ["This package provides an example class."]
    

example 2

  # =description
  #
  # This package provides an example class.
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_description) = $test->collect_data_for_description;
  # "This package provides an example class."
    

collect_data_for_encoding

  collect_data_for_encoding() (arrayref)
    

The collect_data_for_encoding method uses "data" to fetch data for the "encoding" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =encoding
  #
  # utf8
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_encoding = $test->collect_data_for_encoding;
  # ["UTF8"]
    

example 2

  # =encoding
  #
  # utf8
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_encoding) = $test->collect_data_for_encoding;
  # "UTF8"
    

collect_data_for_error

  collect_data_for_error(string $name) (arrayref)
    

The collect_data_for_error method uses "data" to fetch data for the error $name section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =error error_on_unknown
  #
  # This package may raise an error_on_unknown error.
  #
  # =cut
  #
  # =example-1 error_on_unknown
  #
  #   # given: synopsis
  #
  #   my $error = $example->catch('error', {
  #     with => 'error_on_unknown',
  #   });
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_error = $test->collect_data_for_error('error_on_unknown');
  # ["This package may raise an error_on_unknown error."]
    

example 2

  # =error error_on_unknown
  #
  # This package may raise an error_on_unknown error.
  #
  # =cut
  #
  # =example-1 error_on_unknown
  #
  #   # given: synopsis
  #
  #   my $error = $example->catch('error', {
  #     with => 'error_on_unknown',
  #   });
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_error) = $test->collect_data_for_error('error_on_unknown');
  # "This package may raise an error_on_unknown error."
    

collect_data_for_example

  collect_data_for_example(number $numberm string $name) (arrayref)
    

The collect_data_for_example method uses "data" to fetch data for the "example-$number $name" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =attribute name
  #
  # The name attribute is read-write, optional, and holds a string.
  #
  # =cut
  #
  # =example-1 name
  #
  #   # given: synopsis
  #
  #   my $name = $example->name;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_example = $test->collect_data_for_example(1, 'name');
  # ['  # given: synopsis', '  my $name = $example->name;', '  # "..."']
    

example 2

  # =attribute name
  #
  # The name attribute is read-write, optional, and holds a string.
  #
  # =cut
  #
  # =example-1 name
  #
  #   # given: synopsis
  #
  #   my $name = $example->name;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my @collect_data_for_example = $test->collect_data_for_example(1, 'name');
  # ('  # given: synopsis', '  my $name = $example->name;', '  # "..."')
    

collect_data_for_feature

  collect_data_for_feature(string $name) (arrayref)
    

The collect_data_for_feature method uses "data" to fetch data for the "feature $name" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =feature noop
  #
  # This package is no particularly useful features.
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_feature = $test->collect_data_for_feature('noop');
  # ["This package is no particularly useful features."]
    

example 2

  # =feature noop
  #
  # This package is no particularly useful features.
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_feature) = $test->collect_data_for_feature('noop');
  # "This package is no particularly useful features."
    

collect_data_for_function

  collect_data_for_function(string $name) (arrayref)
    

The collect_data_for_function method uses "data" to fetch data for the "function $name" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =function eg
  #
  # The eg function returns a new instance of Example.
  #
  # =cut
  #
  # =example-1 name
  #
  #   # given: synopsis
  #
  #   my $example = eg();
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_function = $test->collect_data_for_function('eg');
  # ["The eg function returns a new instance of Example."]
    

example 2

  # =function eg
  #
  # The eg function returns a new instance of Example.
  #
  # =cut
  #
  # =example-1 name
  #
  #   # given: synopsis
  #
  #   my $example = eg();
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_function) = $test->collect_data_for_function('eg');
  # "The eg function returns a new instance of Example."
    

collect_data_for_includes

  collect_data_for_includes() (arrayref)
    

The collect_data_for_includes method uses "data" to fetch data for the "includes" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =includes
  #
  # function: eg
  #
  # method: prepare
  # method: execute
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_includes = $test->collect_data_for_includes;
  # ["function: eg", "method: prepare", "method: execute"]
    

example 2

  # =includes
  #
  # function: eg
  #
  # method: prepare
  # method: execute
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my @collect_data_for_includes = $test->collect_data_for_includes;
  # ("function: eg", "method: prepare", "method: execute")
    

collect_data_for_inherits

  collect_data_for_inherits() (arrayref)
    

The collect_data_for_inherits method uses "data" to fetch data for the "inherits" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =inherits
  #
  # Venus::Core::Class
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_inherits = $test->collect_data_for_inherits;
  # ["Venus::Core::Class"]
    

example 2

  # =inherits
  #
  # Venus::Core::Class
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_inherits) = $test->collect_data_for_inherits;
  # "Venus::Core::Class"
    

collect_data_for_integrates

  collect_data_for_integrates() (arrayref)
    

The collect_data_for_integrates method uses "data" to fetch data for the "integrates" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =integrates
  #
  # Venus::Role::Catchable
  # Venus::Role::Throwable
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_integrates = $test->collect_data_for_integrates;
  # ["Venus::Role::Catchable\nVenus::Role::Throwable"]
    

example 2

  # =integrates
  #
  # Venus::Role::Catchable
  # Venus::Role::Throwable
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_integrates) = $test->collect_data_for_integrates;
  # "Venus::Role::Catchable\nVenus::Role::Throwable"
    

collect_data_for_layout

  collect_data_for_layout() (arrayref)
    

The collect_data_for_layout method uses "data" to fetch data for the "layout" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =layout
  #
  # encoding
  # name
  # synopsis
  # description
  # attributes: attribute
  # authors
  # license
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_layout = $test->collect_data_for_layout;
  # ["encoding\nname\nsynopsis\ndescription\nattributes: attribute\nauthors\nlicense"]
    

example 2

  # =layout
  #
  # encoding
  # name
  # synopsis
  # description
  # attributes: attribute
  # authors
  # license
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_layout) = $test->collect_data_for_layout;
  # "encoding\nname\nsynopsis\ndescription\nattributes: attribute\nauthors\nlicense"
    

collect_data_for_libraries

  collect_data_for_libraries() (arrayref)
    

The collect_data_for_libraries method uses "data" to fetch data for the "libraries" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =libraries
  #
  # Venus::Check
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_libraries = $test->collect_data_for_libraries;
  # ["Venus::Check"]
    

example 2

  # =libraries
  #
  # Venus::Check
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_libraries) = $test->collect_data_for_libraries;
  # "Venus::Check"
    

collect_data_for_license

  collect_data_for_license() (arrayref)
    

The collect_data_for_license method uses "data" to fetch data for the "license" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =license
  #
  # No license granted.
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_license = $test->collect_data_for_license;
  # ["No license granted."]
    

example 2

  # =license
  #
  # No license granted.
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_license) = $test->collect_data_for_license;
  # "No license granted."
    

collect_data_for_message

  collect_data_for_message(string $name) (arrayref)
    

The collect_data_for_message method uses "data" to fetch data for the "message $name" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =message accept
  #
  # The accept message represents acceptance.
  #
  # =cut
  #
  # =example-1 accept
  #
  #   # given: synopsis
  #
  #   my $accept = $example->accept;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_message = $test->collect_data_for_message('accept');
  # ["The accept message represents acceptance."]
    

example 2

  # =message accept
  #
  # The accept message represents acceptance.
  #
  # =cut
  #
  # =example-1 accept
  #
  #   # given: synopsis
  #
  #   my $accept = $example->accept;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_message) = $test->collect_data_for_message('accept');
  # "The accept message represents acceptance."
    

collect_data_for_metadata

  collect_data_for_metadata(string $name) (arrayref)
    

The collect_data_for_metadata method uses "data" to fetch data for the "metadata $name" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =method prepare
  #
  # The prepare method prepares for execution.
  #
  # =cut
  #
  # =metadata prepare
  #
  # {since => 1.2.3}
  #
  # =cut
  #
  # =example-1 prepare
  #
  #   # given: synopsis
  #
  #   my $prepare = $example->prepare;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_metadata = $test->collect_data_for_metadata('prepare');
  # ["{since => 1.2.3}"]
    

example 2

  # =method prepare
  #
  # The prepare method prepares for execution.
  #
  # =cut
  #
  # =metadata prepare
  #
  # {since => 1.2.3}
  #
  # =cut
  #
  # =example-1 prepare
  #
  #   # given: synopsis
  #
  #   my $prepare = $example->prepare;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_metadata) = $test->collect_data_for_metadata('prepare');
  # "{since => 1.2.3}"
    

collect_data_for_method

  collect_data_for_method(string $name) (arrayref)
    

The collect_data_for_method method uses "data" to fetch data for the "method $name" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =method execute
  #
  # The execute method executes the logic.
  #
  # =cut
  #
  # =metadata execute
  #
  # {since => 1.2.3}
  #
  # =cut
  #
  # =example-1 execute
  #
  #   # given: synopsis
  #
  #   my $execute = $example->execute;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_method = $test->collect_data_for_method('execute');
  # ["The execute method executes the logic."]
    

example 2

  # =method execute
  #
  # The execute method executes the logic.
  #
  # =cut
  #
  # =metadata execute
  #
  # {since => 1.2.3}
  #
  # =cut
  #
  # =example-1 execute
  #
  #   # given: synopsis
  #
  #   my $execute = $example->execute;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_method) = $test->collect_data_for_method('execute');
  # "The execute method executes the logic."
    

collect_data_for_name

  collect_data_for_name() (arrayref)
    

The collect_data_for_name method uses "data" to fetch data for the "name" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =name
  # Example
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_name = $test->collect_data_for_name;
  # ["Example"]
    

example 2

  # =name
  # Example
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_name) = $test->collect_data_for_name;
  # "Example"
    

collect_data_for_operator

  collect_data_for_operator(string $name) (arrayref)
    

The collect_data_for_operator method uses "data" to fetch data for the "operator $name" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =operator ("")
  #
  # This package overloads the C<""> operator.
  #
  # =cut
  #
  # =example-1 ("")
  #
  #   # given: synopsis
  #
  #   my $string = "$example";
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_operator = $test->collect_data_for_operator('("")');
  # ['This package overloads the C<""> operator.']
    

example 2

  # =operator ("")
  #
  # This package overloads the C<""> operator.
  #
  # =cut
  #
  # =example-1 ("")
  #
  #   # given: synopsis
  #
  #   my $string = "$example";
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_operator) = $test->collect_data_for_operator('("")');
  # 'This package overloads the C<""> operator.'
    

collect_data_for_partials

  collect_data_for_partials() (arrayref)
    

The collect_data_for_partials method uses "data" to fetch data for the "partials" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =partials
  #
  # t/path/to/other.t: present: authors
  # t/path/to/other.t: present: license
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_partials = $test->collect_data_for_partials;
  # ["t/path/to/other.t: present: authors\nt/path/to/other.t: present: license"]
    

example 2

  # =partials
  #
  # t/path/to/other.t: present: authors
  # t/path/to/other.t: present: license
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_partials) = $test->collect_data_for_partials;
  # "t/path/to/other.t: present: authors\nt/path/to/other.t: present: license"
    

collect_data_for_project

  collect_data_for_project() (arrayref)
    

The collect_data_for_project method uses "data" to fetch data for the "project" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =project
  #
  # https://github.com/awncorp/example
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_project = $test->collect_data_for_project;
  # ["https://github.com/awncorp/example"]
    

example 2

  # =project
  #
  # https://github.com/awncorp/example
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_project) = $test->collect_data_for_project;
  # "https://github.com/awncorp/example"
    

collect_data_for_signature

  collect_data_for_signature(string $name) (arrayref)
    

The collect_data_for_signature method uses "data" to fetch data for the "signature $name" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =method execute
  #
  # The execute method executes the logic.
  #
  # =cut
  #
  # =signature execute
  #
  #   execute() (boolean)
  #
  # =cut
  #
  # =metadata execute
  #
  # {since => 1.2.3}
  #
  # =cut
  #
  # =example-1 execute
  #
  #   # given: synopsis
  #
  #   my $execute = $example->execute;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_signature = $test->collect_data_for_signature('execute');
  # ["  execute() (boolean)"]
    

example 2

  # =method execute
  #
  # The execute method executes the logic.
  #
  # =cut
  #
  # =signature execute
  #
  #   execute() (boolean)
  #
  # =cut
  #
  # =metadata execute
  #
  # {since => 1.2.3}
  #
  # =cut
  #
  # =example-1 execute
  #
  #   # given: synopsis
  #
  #   my $execute = $example->execute;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_signature) = $test->collect_data_for_signature('execute');
  # "  execute() (boolean)"
    

collect_data_for_synopsis

  collect_data_for_synopsis() (arrayref)
    

The collect_data_for_synopsis method uses "data" to fetch data for the "synopsis" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =synopsis
  #
  #   use Example;
  #
  #   my $example = Example->new;
  #
  #   # bless(..., "Example")
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_synopsis = $test->collect_data_for_synopsis;
  # ['  use Example;', '  my $example = Example->new;', '  # bless(..., "Example")']
    

example 2

  # =synopsis
  #
  #   use Example;
  #
  #   my $example = Example->new;
  #
  #   # bless(..., "Example")
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my @collect_data_for_synopsis = $test->collect_data_for_synopsis;
  # ('  use Example;', '  my $example = Example->new;', '  # bless(..., "Example")')
    

collect_data_for_tagline

  collect_data_for_tagline() (arrayref)
    

The collect_data_for_tagline method uses "data" to fetch data for the "tagline" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =tagline
  #
  # Example Class
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_tagline = $test->collect_data_for_tagline;
  # ["Example Class"]
    

example 2

  # =tagline
  #
  # Example Class
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_tagline) = $test->collect_data_for_tagline;
  # "Example Class"
    

collect_data_for_version

  collect_data_for_version() (arrayref)
    

The collect_data_for_version method uses "data" to fetch data for the "version" section and returns the data. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # =version
  #
  # 1.2.3
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $collect_data_for_version = $test->collect_data_for_version;
  # ["1.2.3"]
    

example 2

  # =version
  #
  # 1.2.3
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my ($collect_data_for_version) = $test->collect_data_for_version;
  # "1.2.3"
    

data

  data() (Venus::Text::Pod)
    

The data method returns a Venus::Text::Pod object using "file" for parsing the test specification.

Introduced 3.55, Deprecated 4.15

example 1

  # given: synopsis
  package main;
  my $data = $test->data;
  # bless(..., "Venus::Text::Pod")
    

execute

  execute(string $name, any @args) (boolean)
    

The execute method dispatches to the "execute_data_for_${name}" method indictated by the first argument and returns the result. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # given: synopsis
  package main;
  my $execute = $test->execute('name');
  # true
    

example 2

  # given: synopsis
  package main;
  my $execute = $test->execute('name', sub {
    my ($data) = @_;
    my $result = $data->[0] eq 'Venus::Test' ? true : false;
    $self->pass($result, 'name set as Venus::Test');
    return $result;
  });
  # true
    

execute_test_for_abstract

  execute_test_for_abstract() (arrayref)
    

The execute_test_for_abstract method tests a documentation block for the "abstract" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =abstract
  #
  # Example Test Documentation
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_abstract = $test->execute_test_for_abstract;
  # true
    

execute_test_for_attribute

  execute_test_for_attribute(string $name) (arrayref)
    

The execute_test_for_attribute method tests a documentation block for the "attribute $name" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =attribute name
  #
  # The name attribute is read-write, optional, and holds a string.
  #
  # =cut
  #
  # =example-1 name
  #
  #   # given: synopsis
  #
  #   my $name = $example->name;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_attribute = $test->execute_test_for_attribute('name');
  # true
    

execute_test_for_authors

  execute_test_for_authors() (arrayref)
    

The execute_test_for_authors method tests a documentation block for the "authors" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =authors
  #
  # Awncorp, C<awncorp@cpan.org>
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_authors = $test->execute_test_for_authors;
  # true
    

execute_test_for_description

  execute_test_for_description() (arrayref)
    

The execute_test_for_description method tests a documentation block for the "description" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =description
  #
  # This package provides an example class.
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_description = $test->execute_test_for_description;
  # true
    

execute_test_for_encoding

  execute_test_for_encoding() (arrayref)
    

The execute_test_for_encoding method tests a documentation block for the "encoding" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =encoding
  #
  # utf8
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_encoding = $test->execute_test_for_encoding;
  # true
    

execute_test_for_error

  execute_test_for_error(string $name) (arrayref)
    

The execute_test_for_error method tests a documentation block for the "error $name" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =error error_on_unknown
  #
  # This package may raise an error_on_unknown error.
  #
  # =cut
  #
  # =example-1 error_on_unknown
  #
  #   # given: synopsis
  #
  #   my $error = $example->catch('error', {
  #     with => 'error_on_unknown',
  #   });
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_error = $test->execute_test_for_error('error_on_unknown');
  # true
    

execute_test_for_example

  execute_test_for_example(number $numberm string $name) (arrayref)
    

The execute_test_for_example method tests a documentation block for the "example-$number $name" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =attribute name
  #
  # The name attribute is read-write, optional, and holds a string.
  #
  # =cut
  #
  # =example-1 name
  #
  #   # given: synopsis
  #
  #   my $name = $example->name;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_example = $test->execute_test_for_example(1, 'name');
  # true
    

execute_test_for_feature

  execute_test_for_feature(string $name) (arrayref)
    

The execute_test_for_feature method tests a documentation block for the "feature $name" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =feature noop
  #
  # This package is no particularly useful features.
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_feature = $test->execute_test_for_feature('noop');
  # true
    

execute_test_for_function

  execute_test_for_function(string $name) (arrayref)
    

The execute_test_for_function method tests a documentation block for the "function $name" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =function eg
  #
  # The eg function returns a new instance of Example.
  #
  # =cut
  #
  # =example-1 name
  #
  #   # given: synopsis
  #
  #   my $example = eg();
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_function = $test->execute_test_for_function('eg');
  # true
    

execute_test_for_includes

  execute_test_for_includes() (arrayref)
    

The execute_test_for_includes method tests a documentation block for the "includes" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =includes
  #
  # function: eg
  #
  # method: prepare
  # method: execute
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_includes = $test->execute_test_for_includes;
  # true
    

execute_test_for_inherits

  execute_test_for_inherits() (arrayref)
    

The execute_test_for_inherits method tests a documentation block for the "inherits" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =inherits
  #
  # Venus::Core::Class
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_inherits = $test->execute_test_for_inherits;
  # true
    

execute_test_for_integrates

  execute_test_for_integrates() (arrayref)
    

The execute_test_for_integrates method tests a documentation block for the "integrates" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =integrates
  #
  # Venus::Role::Catchable
  # Venus::Role::Throwable
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_integrates = $test->execute_test_for_integrates;
  # true
    

execute_test_for_layout

  execute_test_for_layout() (arrayref)
    

The execute_test_for_layout method tests a documentation block for the "layout" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =layout
  #
  # encoding
  # name
  # synopsis
  # description
  # attributes: attribute
  # authors
  # license
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_layout = $test->execute_test_for_layout;
  # true
    

execute_test_for_libraries

  execute_test_for_libraries() (arrayref)
    

The execute_test_for_libraries method tests a documentation block for the "libraries" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =libraries
  #
  # Venus::Check
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_libraries = $test->execute_test_for_libraries;
  # true
    

execute_test_for_license

  execute_test_for_license() (arrayref)
    

The execute_test_for_license method tests a documentation block for the "license" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =license
  #
  # No license granted.
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_license = $test->execute_test_for_license;
  # true
    

execute_test_for_message

  execute_test_for_message(string $name) (arrayref)
    

The execute_test_for_message method tests a documentation block for the "message $name" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =message accept
  #
  # The accept message represents acceptance.
  #
  # =cut
  #
  # =example-1 accept
  #
  #   # given: synopsis
  #
  #   my $accept = $example->accept;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_message = $test->execute_test_for_message('accept');
  # true
    

execute_test_for_metadata

  execute_test_for_metadata(string $name) (arrayref)
    

The execute_test_for_metadata method tests a documentation block for the "metadata $name" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =method prepare
  #
  # The prepare method prepares for execution.
  #
  # =cut
  #
  # =metadata prepare
  #
  # {since => 1.2.3}
  #
  # =cut
  #
  # =example-1 prepare
  #
  #   # given: synopsis
  #
  #   my $prepare = $example->prepare;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_metadata = $test->execute_test_for_metadata('prepare');
  # true
    

execute_test_for_method

  execute_test_for_method(string $name) (arrayref)
    

The execute_test_for_method method tests a documentation block for the "method $name" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =method execute
  #
  # The execute method executes the logic.
  #
  # =cut
  #
  # =metadata execute
  #
  # {since => 1.2.3}
  #
  # =cut
  #
  # =example-1 execute
  #
  #   # given: synopsis
  #
  #   my $execute = $example->execute;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_method = $test->execute_test_for_method('execute');
  # true
    

execute_test_for_name

  execute_test_for_name() (arrayref)
    

The execute_test_for_name method tests a documentation block for the "name" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =name
  # Example
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_name = $test->execute_test_for_name;
  # true
    

execute_test_for_operator

  execute_test_for_operator(string $name) (arrayref)
    

The execute_test_for_operator method tests a documentation block for the "operator $name" section and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # =operator ("")
  #
  # This package overloads the C<""> operator.
  #
  # =cut
  #
  # =example-1 ("")
  #
  #   # given: synopsis
  #
  #   my $string = "$example";
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_operator = $test->execute_test_for_operator('("")');
  # true
    

execute_test_for_raise

  execute_test_for_raise(string $name, string $class, string $id) (arrayref)
    

The execute_test_for_raise method tests a documentation block for the "raise $name $error $id" section and returns the result.

Introduced 4.15

example 1

  # =raise execute Venus::Error on.unknown
  #
  #   # given: synopsis
  #
  #   $example->operation; # throw exception
  #
  #   # Error (on.unknown)
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $execute_test_for_raise = $test->execute_test_for_raise('execute', 'Venus::Error', 'on.unknown');
  # true
    

more

  more(any @args) (any)
    

The more method dispatches to the Test::More method specified by the first argument and returns its result.

Introduced 3.55, Deprecated 4.15

example 1

  # given: synopsis
  package main;
  my $more = $test->more('ok', true);
  # true
    

okay

  okay(any $data, string $description) (any)
    

The okay method dispatches to the "ok" in Test::More operation and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # given: synopsis
  package main;
  my $okay = $test->okay(1, 'example-1 okay passed');
  # true
    

example 2

  # given: synopsis
  package main;
  my $okay = $test->okay(!0, 'example-1 okay passed');
  # true
    

okay_can

  okay_can(string $name, string @args) (any)
    

The okay_can method dispatches to the "can_ok" in Test::More operation and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # given: synopsis
  package main;
  my $okay_can = $test->okay_can('Venus::Test', 'diag');
  # true
    

okay_isa

  okay_isa(string $name, string $base) (any)
    

The okay_isa method dispatches to the "isa_ok" in Test::More operation and returns the result.

Introduced 3.55, Deprecated 4.15

example 1

  # given: synopsis
  package main;
  my $okay_isa = $test->okay_isa('Venus::Test', 'Venus::Kind');
  # true
    

perform

  perform(string $name, any @args) (boolean)
    

The perform method dispatches to the "perform_data_for_${name}" method indictated by the first argument and returns the result. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # given: synopsis
  package main;
  my $data = $test->collect('name');
  my $perform = $test->perform('name', $data);
  # true
    

perform_test_for_abstract

  perform_test_for_abstract(arrayref $data) (boolean)
    

The perform_data_for_abstract method performs an overridable test for the "abstract" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_abstract {
    my ($self, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=abstract content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_abstract;
  my $perform_test_for_abstract = $test->perform_test_for_abstract(
    $data,
  );
  # true
    

perform_test_for_attribute

  perform_test_for_attribute(string $name, arrayref $data) (boolean)
    

The perform_data_for_attribute method performs an overridable test for the "attribute $name" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_attribute {
    my ($self, $name, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=attribute $name content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_attribute('name');
  my $perform_test_for_attribute = $test->perform_test_for_attribute(
    'name', $data,
  );
  # true
    

perform_test_for_authors

  perform_test_for_authors(arrayref $data) (boolean)
    

The perform_data_for_authors method performs an overridable test for the "authors" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_authors {
    my ($self, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=authors content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_authors;
  my $perform_test_for_authors = $test->perform_test_for_authors(
    $data,
  );
  # true
    

perform_test_for_description

  perform_test_for_description(arrayref $data) (boolean)
    

The perform_data_for_description method performs an overridable test for the "description" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_description {
    my ($self, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=description content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_description;
  my $perform_test_for_description = $test->perform_test_for_description(
    $data,
  );
  # true
    

perform_test_for_encoding

  perform_test_for_encoding(arrayref $data) (boolean)
    

The perform_data_for_encoding method performs an overridable test for the "encoding" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_encoding {
    my ($self, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=encoding content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_encoding;
  my $perform_test_for_encoding = $test->perform_test_for_encoding(
    $data,
  );
  # true
    

perform_test_for_error

  perform_test_for_error(arrayref $data) (boolean)
    

The perform_data_for_error method performs an overridable test for the "error $name" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_error {
    my ($self, $name, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=error $name content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_error('error_on_unknown');
  my $perform_test_for_error = $test->perform_test_for_error(
    'error_on_unknown', $data,
  );
  # true
    

perform_test_for_example

  perform_test_for_example(arrayref $data) (boolean)
    

The perform_data_for_example method performs an overridable test for the "example-$number $name" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_example {
    my ($self, $number, $name, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=example-$number $name content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_example(1, 'execute');
  my $perform_test_for_example = $test->perform_test_for_example(
    1, 'execute', $data,
  );
  # true
    

perform_test_for_feature

  perform_test_for_feature(arrayref $data) (boolean)
    

The perform_data_for_feature method performs an overridable test for the "feature $name" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_feature {
    my ($self, $name, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=feature $name content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_feature('noop');
  my $perform_test_for_feature = $test->perform_test_for_feature(
    'noop', $data,
  );
  # true
    

perform_test_for_function

  perform_test_for_function(arrayref $data) (boolean)
    

The perform_data_for_function method performs an overridable test for the "function $name" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_function {
    my ($self, $name, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=function $name content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_function('eg');
  my $perform_test_for_function = $test->perform_test_for_function(
    'eg', $data,
  );
  # true
    

perform_test_for_includes

  perform_test_for_includes(arrayref $data) (boolean)
    

The perform_data_for_includes method performs an overridable test for the "includes" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_includes {
    my ($self, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=includes content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_includes;
  my $perform_test_for_includes = $test->perform_test_for_includes(
    $data,
  );
  # true
    

perform_test_for_inherits

  perform_test_for_inherits(arrayref $data) (boolean)
    

The perform_data_for_inherits method performs an overridable test for the "inherits" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_inherits {
    my ($self, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=inherits content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_inherits;
  my $perform_test_for_inherits = $test->perform_test_for_inherits(
    $data,
  );
  # true
    

perform_test_for_integrates

  perform_test_for_integrates(arrayref $data) (boolean)
    

The perform_data_for_integrates method performs an overridable test for the "integrates" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_integrates {
    my ($self, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=integrates content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_integrates;
  my $perform_test_for_integrates = $test->perform_test_for_integrates(
    $data,
  );
  # true
    

perform_test_for_layout

  perform_test_for_layout(arrayref $data) (boolean)
    

The perform_data_for_layout method performs an overridable test for the "layout" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_layout {
    my ($self, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=layout content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_layout;
  my $perform_test_for_layout = $test->perform_test_for_layout(
    $data,
  );
  # true
    

perform_test_for_libraries

  perform_test_for_libraries(arrayref $data) (boolean)
    

The perform_data_for_libraries method performs an overridable test for the "libraries" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_libraries {
    my ($self, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=libraries content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_libraries;
  my $perform_test_for_libraries = $test->perform_test_for_libraries(
    $data,
  );
  # true
    

perform_test_for_license

  perform_test_for_license(arrayref $data) (boolean)
    

The perform_data_for_license method performs an overridable test for the "license" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_license {
    my ($self, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=license content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_license;
  my $perform_test_for_license = $test->perform_test_for_license(
    $data,
  );
  # true
    

perform_test_for_message

  perform_test_for_message(arrayref $data) (boolean)
    

The perform_data_for_message method performs an overridable test for the "message $name" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_message {
    my ($self, $name, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=message $name content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_message('accept');
  my $perform_test_for_message = $test->perform_test_for_message(
    'accept', $data,
  );
  # true
    

perform_test_for_metadata

  perform_test_for_metadata(arrayref $data) (boolean)
    

The perform_data_for_metadata method performs an overridable test for the "metadata $name" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_metadata {
    my ($self, $name, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=metadata $name content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_metadata('execute');
  my $perform_test_for_metadata = $test->perform_test_for_metadata(
    'execute', $data,
  );
  # true
    

perform_test_for_method

  perform_test_for_method(arrayref $data) (boolean)
    

The perform_data_for_method method performs an overridable test for the "method $name" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_method {
    my ($self, $name, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=method $name content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_method('execute');
  my $perform_test_for_method = $test->perform_test_for_method(
    'execute', $data,
  );
  # true
    

perform_test_for_name

  perform_test_for_name(arrayref $data) (boolean)
    

The perform_data_for_name method performs an overridable test for the "name" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_name {
    my ($self, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=name content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_name;
  my $perform_test_for_name = $test->perform_test_for_name(
    $data,
  );
  # true
    

perform_test_for_operator

  perform_test_for_operator(arrayref $data) (boolean)
    

The perform_data_for_operator method performs an overridable test for the "operator $name" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_operator {
    my ($self, $name, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=operator $name content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_operator('("")');
  my $perform_test_for_operator = $test->perform_test_for_operator(
    '("")', $data,
  );
  # true
    

perform_test_for_partials

  perform_test_for_partials(arrayref $data) (boolean)
    

The perform_data_for_partials method performs an overridable test for the "partials" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_partials {
    my ($self, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=partials content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_partials;
  my $perform_test_for_partials = $test->perform_test_for_partials(
    $data,
  );
  # true
    

perform_test_for_project

  perform_test_for_project(arrayref $data) (boolean)
    

The perform_data_for_project method performs an overridable test for the "project" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_project {
    my ($self, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=project content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_project;
  my $perform_test_for_project = $test->perform_test_for_project(
    $data,
  );
  # true
    

perform_test_for_signature

  perform_test_for_signature(arrayref $data) (boolean)
    

The perform_data_for_signature method performs an overridable test for the "signature $name" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_signature {
    my ($self, $name, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=signature $name content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_signature('execute');
  my $perform_test_for_signature = $test->perform_test_for_signature(
    'execute', $data,
  );
  # true
    

perform_test_for_synopsis

  perform_test_for_synopsis(arrayref $data) (boolean)
    

The perform_data_for_synopsis method performs an overridable test for the "synopsis" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_synopsis {
    my ($self, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=synopsis content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_synopsis;
  my $perform_test_for_synopsis = $test->perform_test_for_synopsis(
    $data,
  );
  # true
    

perform_test_for_tagline

  perform_test_for_tagline(arrayref $data) (boolean)
    

The perform_data_for_tagline method performs an overridable test for the "tagline" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_tagline {
    my ($self, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=tagline content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_tagline;
  my $perform_test_for_tagline = $test->perform_test_for_tagline(
    $data,
  );
  # true
    

perform_test_for_version

  perform_test_for_version(arrayref $data) (boolean)
    

The perform_data_for_version method performs an overridable test for the "version" section and returns truthy or falsy.

Introduced 3.55, Deprecated 4.15

example 1

  package Example::Test;
  use Venus::Class 'base';
  base 'Venus::Test';
  sub perform_test_for_version {
    my ($self, $data) = @_;
    my $result = length(join "\n", @{$data}) ? true : false;
    $self->pass($result, "=version content");
    return $result;
  }
  package main;
  my $test = Example::Test->new('t/path/pod/example');
  my $data = $test->collect_data_for_version;
  my $perform_test_for_version = $test->perform_test_for_version(
    $data,
  );
  # true
    

present

  present(string $name, any @args) (string)
    

The present method dispatches to the "present_data_for_${name}" method indictated by the first argument and returns the result. Returns an arrayref in scalar context, and a list in list context.

Introduced 3.55, Deprecated 4.15

example 1

  # given: synopsis
  package main;
  my $present = $test->present('name');
  # =head1 NAME
  #
  # Venus::Test - Test Class
  #
  # =cut
    

present_data_for_abstract

  present_data_for_abstract() (arrayref)
    

The present_data_for_abstract method builds a documentation block for the "abstract" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =abstract
  #
  # Example Test Documentation
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_abstract = $test->present_data_for_abstract;
  # =head1 ABSTRACT
  #
  # Example Test Documentation
  #
  # =cut
    

present_data_for_attribute

  present_data_for_attribute(string $name) (arrayref)
    

The present_data_for_attribute method builds a documentation block for the "attribute $name" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =attribute name
  #
  # The name attribute is read-write, optional, and holds a string.
  #
  # =cut
  #
  # =example-1 name
  #
  #   # given: synopsis
  #
  #   my $name = $example->name;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_attribute = $test->present_data_for_attribute('name');
  # =head2 name
  #
  # The name attribute is read-write, optional, and holds a string.
  #
  # =over 4
  #
  # =item name example 1
  #
  #   # given: synopsis
  #
  #   my $name = $example->name;
  #
  #   # "..."
  #
  # =back
  #
  # =cut
    

present_data_for_authors

  present_data_for_authors() (arrayref)
    

The present_data_for_authors method builds a documentation block for the "authors" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =authors
  #
  # Awncorp, C<awncorp@cpan.org>
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_authors = $test->present_data_for_authors;
  # =head1 AUTHORS
  #
  # Awncorp, C<awncorp@cpan.org>
  #
  # =cut
    

present_data_for_description

  present_data_for_description() (arrayref)
    

The present_data_for_description method builds a documentation block for the "description" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =description
  #
  # This package provides an example class.
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_description = $test->present_data_for_description;
  # =head1 DESCRIPTION
  #
  # This package provides an example class.
  #
  # =cut
    

present_data_for_encoding

  present_data_for_encoding() (arrayref)
    

The present_data_for_encoding method builds a documentation block for the "encoding" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =encoding
  #
  # utf8
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_encoding = $test->present_data_for_encoding;
  # =encoding UTF8
  #
  # =cut
    

present_data_for_error

  present_data_for_error(string $name) (arrayref)
    

The present_data_for_error method builds a documentation block for the "error $name" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =error error_on_unknown
  #
  # This package may raise an error_on_unknown error.
  #
  # =cut
  #
  # =example-1 error_on_unknown
  #
  #   # given: synopsis
  #
  #   my $error = $example->catch('error', {
  #     with => 'error_on_unknown',
  #   });
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_error = $test->present_data_for_error('error_on_unknown');
  # =over 4
  #
  # =item error: C<error_on_unknown>
  #
  # This package may raise an error_on_unknown error.
  #
  # B<example 1>
  #
  #   # given: synopsis
  #
  #   my $error = $example->catch('error', {
  #     with => 'error_on_unknown',
  #   });
  #
  #   # "..."
  #
  # =back
    

present_data_for_example

  present_data_for_example(number $numberm string $name) (arrayref)
    

The present_data_for_example method builds a documentation block for the "example-$number $name" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =attribute name
  #
  # The name attribute is read-write, optional, and holds a string.
  #
  # =cut
  #
  # =example-1 name
  #
  #   # given: synopsis
  #
  #   my $name = $example->name;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_example = $test->present_data_for_example(1, 'name');
  # =over 4
  #
  # =item name example 1
  #
  #   # given: synopsis
  #
  #   my $name = $example->name;
  #
  #   # "..."
  #
  # =back
    

present_data_for_feature

  present_data_for_feature(string $name) (arrayref)
    

The present_data_for_feature method builds a documentation block for the "feature $name" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =feature noop
  #
  # This package is no particularly useful features.
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_feature = $test->present_data_for_feature('noop');
  # =over 4
  #
  # =item noop
  #
  # This package is no particularly useful features.
  #
  # =back
    

present_data_for_function

  present_data_for_function(string $name) (arrayref)
    

The present_data_for_function method builds a documentation block for the "function $name" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =function eg
  #
  # The eg function returns a new instance of Example.
  #
  # =cut
  #
  # =example-1 name
  #
  #   # given: synopsis
  #
  #   my $example = eg();
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_function = $test->present_data_for_function('eg');
  # =head2 eg
  #
  # The eg function returns a new instance of Example.
  #
  # =cut
    

present_data_for_includes

  present_data_for_includes() (arrayref)
    

The present_data_for_includes method builds a documentation block for the "includes" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =includes
  #
  # function: eg
  #
  # method: prepare
  # method: execute
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_includes = $test->present_data_for_includes;
  # undef
    

present_data_for_inherits

  present_data_for_inherits() (arrayref)
    

The present_data_for_inherits method builds a documentation block for the "inherits" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =inherits
  #
  # Venus::Core::Class
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_inherits = $test->present_data_for_inherits;
  # =head1 INHERITS
  #
  # This package inherits behaviors from:
  #
  # L<Venus::Core::Class>
  #
  # =cut
    

present_data_for_integrates

  present_data_for_integrates() (arrayref)
    

The present_data_for_integrates method builds a documentation block for the "integrates" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =integrates
  #
  # Venus::Role::Catchable
  # Venus::Role::Throwable
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_integrates = $test->present_data_for_integrates;
  # =head1 INTEGRATES
  #
  # This package integrates behaviors from:
  #
  # L<Venus::Role::Catchable>
  #
  # L<Venus::Role::Throwable>
  #
  # =cut
    

present_data_for_layout

  present_data_for_layout() (arrayref)
    

The present_data_for_layout method builds a documentation block for the "layout" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =layout
  #
  # encoding
  # name
  # synopsis
  # description
  # attributes: attribute
  # authors
  # license
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_layout = $test->present_data_for_layout;
  # undef
    

present_data_for_libraries

  present_data_for_libraries() (arrayref)
    

The present_data_for_libraries method builds a documentation block for the "libraries" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =libraries
  #
  # Venus::Check
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_libraries = $test->present_data_for_libraries;
  # =head1 LIBRARIES
  #
  # This package uses type constraints from:
  #
  # L<Venus::Check>
  #
  # =cut
    

present_data_for_license

  present_data_for_license() (arrayref)
    

The present_data_for_license method builds a documentation block for the "license" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =license
  #
  # No license granted.
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_license = $test->present_data_for_license;
  # =head1 LICENSE
  #
  # No license granted.
  #
  # =cut
    

present_data_for_message

  present_data_for_message(string $name) (arrayref)
    

The present_data_for_message method builds a documentation block for the "message $name" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =message accept
  #
  # The accept message represents acceptance.
  #
  # =cut
  #
  # =example-1 accept
  #
  #   # given: synopsis
  #
  #   my $accept = $example->accept;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_message = $test->present_data_for_message('accept');
  # =over 4
  #
  # =item accept
  #
  # The accept message represents acceptance.
  #
  # B<example 1>
  #
  #   # given: synopsis
  #
  #   my $accept = $example->accept;
  #
  #   # "..."
  #
  # =back
    

present_data_for_metadata

  present_data_for_metadata(string $name) (arrayref)
    

The present_data_for_metadata method builds a documentation block for the "metadata $name" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =method prepare
  #
  # The prepare method prepares for execution.
  #
  # =cut
  #
  # =metadata prepare
  #
  # {since => 1.2.3}
  #
  # =cut
  #
  # =example-1 prepare
  #
  #   # given: synopsis
  #
  #   my $prepare = $example->prepare;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_metadata = $test->present_data_for_metadata('prepare');
  # undef
    

present_data_for_method

  present_data_for_method(string $name) (arrayref)
    

The present_data_for_method method builds a documentation block for the "method $name" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =method execute
  #
  # The execute method executes the logic.
  #
  # =cut
  #
  # =metadata execute
  #
  # {since => 1.2.3}
  #
  # =cut
  #
  # =example-1 execute
  #
  #   # given: synopsis
  #
  #   my $execute = $example->execute;
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_method = $test->present_data_for_method('execute');
  # =head2 execute
  #
  #   execute() (boolean)
  #
  # The execute method executes the logic.
  #
  # I<Since C<1.2.3>>
  #
  # =over 4
  #
  # =item execute example 1
  #
  #   # given: synopsis
  #
  #   my $execute = $example->execute;
  #
  #   # "..."
  #
  # =back
  #
  # =cut
    

present_data_for_name

  present_data_for_name() (arrayref)
    

The present_data_for_name method builds a documentation block for the "name" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =name
  # Example
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_name = $test->present_data_for_name;
  # =head1 NAME
  #
  # Example - Example Class
  #
  # =cut
    

present_data_for_operator

  present_data_for_operator(string $name) (arrayref)
    

The present_data_for_operator method builds a documentation block for the "operator $name" section and returns it as a string.

Introduced 3.55, Deprecated 4.15

example 1

  # =operator ("")
  #
  # This package overloads the C<""> operator.
  #
  # =cut
  #
  # =example-1 ("")
  #
  #   # given: synopsis
  #
  #   my $string = "$example";
  #
  #   # "..."
  #
  # =cut
  package main;
  use Venus::Test 'test';
  my $test = test 't/path/pod/example';
  my $present_data_for_operator = $test->present_data_for_operator('("")');
  # =over 4
  #
  # =item operation: C<("")>
  #
  # This package overloads the C<""> operator.
  #
  # B<example 1>
  #
  #   # given: synopsis
  #
  #   my $string = "$example";
  #
  #   # "..."
  #
  # =back
    

AUTHORS

Awncorp, "awncorp@cpan.org"

LICENSE

Copyright (C) 2022, Awncorp, "awncorp@cpan.org".

This program is free software, you can redistribute it and/or modify it under the terms of the Apache license version 2.0.