NAME

Data::Compare::Plugins::Set::Object - plugin for Data::Compare to handle Set::Object objects

VERSION

This document describes Data::Compare::Plugins::Set::Object version 1.0

SYNOPSIS

    use Set::Object 'set';
    use Data::Compare;

    my $foo = {
        list => [ qw(one two three) ],
        set  => set( [1], [2], [3] ),
    };
    my $bar = {
        list => [ qw(one two three) ],
        set  => set( [1], [2], [3] ),
    };

    say 'Sets in $foo and $bar are ',
        $foo->{set} == $bar->{set} ? '' : 'NOT ', 'identical.';
    say 'Data within $foo and $bar are ',
        Compare($foo, $bar) ? '' : 'NOT ', 'equal.';

DESCRIPTION

Enables Data::Compare to Do The Right Thing for Set::Object objects. Set::Object already has an equals() method, but it only returns true if objects within two sets are exactly equal (i.e. have the same references, referring to the same object instance). When using Data::Compare in conjuction with this plugin, objects in sets are considered the same if their contents are the same. This extends down to sets that contain arrays, hashes, or other objects supported by Data::Compare plugins.

SUBROUTINES/METHODS

As a plugin to Data::Compare, the interface is the same as Data::Compare itself: pass the reference to two data structures to the Compare function, which for historical reasons is exported by default.

Set::Object also can export certain functions, and overloads comparison operators pertaining to sets. Consult the Set::Object documentation for more information.

DIAGNOSTICS

See the documentation for Data::Compare.

CONFIGURATION AND ENVIRONMENT

Data::Compare::Plugins::Set::Object requires no configuration files or environment variables.

DEPENDENCIES

Data::Compare >= 0.06 (must be installed separately)

Set::Object (must be installed separately)

English (part of the standard Perl 5 distribution)

List::Util (part of the standard Perl 5 distribution)

version >= 0.77 (part of the standard Perl 5.10.1 distribution)

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests via GitHub at http://github.com/mjg/Data-Compare-Plugins-Set-Object/issues. Please report any bugs or feature requests to bug-data-compare-plugins-set-object@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

Mark Gardner <mjgardner@cpan.org>

LICENSE AND COPYRIGHT

Copyright (c) 2009, Mark Gardner <mjgardner@cpan.org>. All rights reserved.

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

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.