https://github.com/xsawyerx/algorithm-diff-callback

Use callbacks on computed differences
https://github.com/xsawyerx/algorithm-diff-callback

Last synced: 28 days ago
JSON representation

Use callbacks on computed differences

• Host: GitHub
• URL: https://github.com/xsawyerx/algorithm-diff-callback
• Owner: xsawyerx
• Created: 2010-05-04T22:32:36.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2016-10-14T21:51:56.000Z (about 8 years ago)
• Last Synced: 2024-10-13T11:37:13.689Z (about 1 month ago)
• Language: Perl
• Homepage:
• Size: 26.4 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.pod
  • Changelog: Changes

Awesome Lists containing this project

README

        
=pod

=encoding UTF-8

=head1 NAME

Algorithm::Diff::Callback - Use callbacks on computed differences

=head1 VERSION

version 0.111

=head1 SYNOPSIS

Use callbacks in your diff process to get better control over what will happen.

    use Algorithm::Diff::Callback 'diff_arrays';

    diff_arrays(

        \@old_family_members,

        \@new_family_members,

        added   => sub { say 'Happy to hear about ', shift },

        deleted => sub { say 'Sorry to hear about ', shift },

    );

Or using hashes:

    use Algorithm::Diff::Callback 'diff_hashes';

    diff_hashes(

        \%old_details,

        \%new_details,

        added   => sub { say 'Gained ', shift },

        deleted => sub { say 'Lost ',   shift },

        changed => sub {

            my ( $key, $before, $after ) = @_;

            say "$key changed from $before to $after";

        },

    );

=head1 DESCRIPTION

One of the difficulties when using diff modules is that they assume they know

what you want the information for. Some give you formatted output, some give you

just the values that changes (but neglect to mention how each changed) and some

(such as L) give you way too much information that you now have

to skim over and write long complex loops for.

L let's you pick what you're going to diff (Arrays or

Hashes) and set callbacks for the diff process.

=head1 EXPORT

You'll need to declare to explicitly export these functions.

=head2 diff_arrays

=head2 diff_hashes

    use Algorithm::Diff::Callback qw;

=head1 SUBROUTINES/METHODS

=head2 diff_arrays(\@old, \@new, %callbacks)

The first two parameters are array references to compare.

The rest of the parameters are keys for the type of callback you want and the

corresponding callback. You can provide multiple callbacks. Supported keys are:

=over 4

=item * added

    diff_arrays(

        \@old, \@new,

        added => sub {

            my $value = shift;

            say "$value was added to the array";

        }

    );

=item * deleted

    diff_arrays(

        \@old, \@new,

        deleted => sub {

            my $value = shift;

            say "$value was deleted from the array";

        }

    );

=back

=head2 diff_hashes(\%old, \%new, %callbacks)

The first two parameters are hash references to compare.

The rest of the parameters are keys for the type of callback you want and the

corresponding callback. You can provide multiple callbacks. Supported keys are:

=over 4

=item * added

    diff_hashes(

        \%old, \%new,

        added => sub {

            my ( $key, $value ) = @_;

            say "$key ($value) was added to the hash";

        }

    );

=item * deleted

    diff_hashes(

        \%old, \%new,

        deleted => sub {

            my ( $key, $value ) = @_;

            say "$key ($value) was deleted from the hash";

        }

    );

=item * changed

    diff_hashes(

        \%old, \%new,

        changed => sub {

            my ( $key, $before, $after ) = @_;

            say "$key in the hash was changed from $before to $after";

        }

    );

=back

=head1 BUGS

Please report bugs on the Github issues page at

L.

=head1 SUPPORT

This module sports 100% test coverage, but in case you have more issues...

You can find documentation for this module with the perldoc command.

    perldoc Algorithm::Diff::Callback

You can also look for information at:

=over 4

=item * Github issues tracker

L

=item * RT: CPAN's request tracker

L

=item * AnnoCPAN: Annotated CPAN documentation

L

=item * CPAN Ratings

L

=item * Search CPAN

L

=back

=head1 DEPENDENCIES

L

L

L

L

=head1 AUTHOR

Sawyer X 

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Sawyer X.

This is free software; you can redistribute it and/or modify it under

the same terms as the Perl 5 programming language system itself.

=cut