Shlomi Fish

NAME

Test::HTML::Tidy::Recursive - recursively check files in a directory using HTML::Tidy .

VERSION

version 0.4.0

SYNOPSIS

    use Test::HTML::Tidy::Recursive;

    Test::HTML::Tidy::Recursive->new({
        targets => ['./dest-html', './dest-html-production'],
        })->run;

Or with over-riding the defaults:

    use Test::HTML::Tidy::Recursive;

    Test::HTML::Tidy::Recursive->new({
        filename_re => qr/\.x?html?\z/i,
        filename_filter => sub { return shift !~ m#MathJax#; },
        targets => ['./dest-html', './dest-html-production'],
        })->run;

DESCRIPTION

This module acts as test module which runs HTML::Tidy on some directory trees containing HTML/XHTML files and checks that they are all valid.

It was extracted from a bunch of nearly duplicate test scripts in some of my (= Shlomi Fish) web sites, as an attempt to avoid duplicate code and functionality.

VERSION

version 0.4.0

METHODS

calc_tidy

Calculates the HTML::Tidy object - can be overriden.

filename_filter

A parameter with a callback to filter the files. Defaults to accept all files.

filename_re

A regex for which filenames are checked. Defaults to files ending in ".html" or ".xhtml".

run

The method that runs the program.

$obj->check_file({filename => $path_string})

Override this method in subclasses to check a file in a different way.

$obj->check_using_tidy({filename => $path_string})

Actually check a file using tidy. Used by check_file() by default, but can also be called there in subclasses.

$obj->report_error({message => $string});

Reports the error and increment the error count.

$obj->traverse()

The method that gets called by run() to do the actual traversal of the tree without actually checking for no errors. Useful for testing and debugging.

targets

A parameter that accepts an array reference of targets as strings.

SEE ALSO

HTML::Tidy .

AUTHOR

Shlomi Fish <shlomif@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2016 by Shlomi Fish.

This is free software, licensed under:

  The MIT (X11) License

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/shlomif/test-html-tidy-recursive/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SUPPORT

Perldoc

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

  perldoc Test::HTML::Tidy::Recursive

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-test-html-tidy-recursive at rt.cpan.org, or through the web interface at https://rt.cpan.org/Public/Bug/Report.html?Queue=Test-HTML-Tidy-Recursive. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

https://github.com/shlomif/perl-Test-HTML-Tidy-Recursive

  git clone https://github.com/shlomif/perl-Test-HTML-Tidy-Recursive