Test::Object(3)

NAME
Test::Object - Thoroughly testing objects via registered handlers

SYNOPSIS
  ###################################################################
  # In your test module, register test handlers again class names   #
  ###################################################################

  package My::ModuleTester;

  use Test::More;
  use Test::Object;

  # Foo::Bar is a subclass of Foo
  Test::Object->register(
        class => 'Foo',
        tests => 5,
        code  => \&foo_ok,
        );
  Test::Object->register(
        class => 'Foo::Bar',
        # No fixed number of tests
        code  => \&foobar_ok,
        );

  sub foo_ok {
        my $object = shift;
        ok( $object->foo, '->foo returns true' );
  }

  sub foobar_ok {
        my $object = shift;
        is( $object->foo, 'bar', '->foo returns "bar"' );
  }

  1;

  ###################################################################
  # In test script, test object against all registered classes      #
  ###################################################################

  #!/usr/bin/perl -w

  use Test::More 'no_plan';
  use Test::Object;
  use My::ModuleTester;

  my $object = Foo::Bar->new;
  isa_ok( $object, 'Foo::Bar' );
  object_ok( $object );

DESCRIPTION
In situations where you have deep trees of classes, there is a common situation in which you test a module 4 or 5 subclasses down, which should follow the correct behaviour of not just the subclass, but of all the parent classes.

This should be done to ensure that the implementation of a subclass has not somehow "broken" the object's behaviour in a more general sense.

"Test::Object" is a testing package designed to allow you to easily test what you believe is a valid object against the expected behaviour of all of the classes in its inheritance tree in one single call.

To do this, you "register" tests (in the form of CODE or function references) with "Test::Object", with each test associated with a particular class.

When you call "object_ok" in your test script, "Test::Object" will check the object against all registered tests. For each class that your object responds to "$object->isa($class)" for, the appropriate testing function will be called.

Doing it this way allows adapter objects and other things that respond to "isa" differently that the default to still be tested against the classes that it is advertising itself as correctly.

This also means that more than one test might be "counted" for each call to "object_ok". You should account for this correctly in your expected test count.

SUPPORT
Bugs should be submitted via the CPAN bug tracker, located at

<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Object>

For other issues, contact the author.

AUTHOR
Adam Kennedy <cpan@ali.as>

SEE ALSO
<http://ali.as/>, Test::More, Test::Builder::Tester, Test::Class

COPYRIGHT
Copyright 2005, 2006 Adam Kennedy. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.