Test::TrailingSpace(3p)

NAME
Test::TrailingSpace - test for trailing space in source files.

VERSION
version 0.0601

SYNOPSIS
    use Test::TrailingSpace;

    my $finder = Test::TrailingSpace->new(
        {
            root => '.',
            filename_regex => qr/\.(?:t|pm|pl)\z/,
        },
    );

    # TEST
    $finder->no_trailing_space(
        "No trailing space was found."
    );

Or, if you want the test to be optional:

    use Test::More;

    eval "use Test::TrailingSpace";
    if ($@)
    {
        plan skip_all => "Test::TrailingSpace required for trailing space test.";
    }
    else
    {
        plan tests => 1;
    }

    my $finder = Test::TrailingSpace->new(
        {
            root => '.',
            filename_regex => qr/\.(?:t|pm|pl)\z/,
        },
    );

    # TEST
    $finder->no_trailing_space(
        "No trailing space was found."
    );

DESCRIPTION
This module is used to test for lack of trailing space. See the synopsis for more details.

NOTE: there is an older CPAN distribution titled Test::EOL that also supports testing for trailing space / trailing whitespace, although it has some limitations that Test::TrailingSpace does not have, and also only calls it "trailing whitespace", rather than "trailing space". Whenever possible, one should prefer to use it, instead of this module.

METHODS

  new({ root => ".", filename_regex => qr/\. ... \z/,})
Constructs a new object with the root (that defaults to "." and the filename matching regular expression. All the files under root matching the pattern will be searched (excpet for those under version control directories, "blib", "_build", etc.).

The 'abs_path_prune_re' parameter can be used to specify a regular expression to prune the absolute path based on, so as to ignore what is under there.

The 'find_tabs' option, if set to a true value, detects and reports for the presence of hard tabs ('\t'). (Added in version 0.0400)

The 'find_cr' option, if set to a true value, detects and reports for the presence of carriage returns at the end of lines. (DOS-style line endings.) It was added in version 0.0400. So

    my $finder = Test::TrailingSpace->new(
        {
            root => '.',
            filename_regex => qr/\.(?:t|pm|pl)\z/,
            abs_path_prune_re => qr#\Alib/sample-data#,
        }
    );

Will ignore everything under "lib/sample-data" . Note that as of Test::TrailingSpace version 0.0300 it can also be used to skip files with these filenames (e.g: "abs_path_prune_re => qr#\.patch\z#").

  $finder->no_trailing_space($blurb)
Determines if there is no trailing space in the source files. Returns true if no trailing space was found, and false if trailing space was found. It is equivalent to Test::More::ok(), with diagnostics to report if there is trailing space.

AUTHOR
Shlomi Fish, <http://www.shlomifish.org/> .

SEE ALSO

•   Test::EOL

    Test::EOL

•   Test::NoTabs

    Test::NoTabs

COPYRIGHT & LICENSE
Copyright 2012 Shlomi Fish.

This program is distributed under the MIT (X11) License: <http://www.opensource.org/licenses/mit-license.php>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

SUPPORT

  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.

•   MetaCPAN

    A modern, open-source CPAN search engine, useful to view POD in HTML format.

    <https://metacpan.org/release/Test-TrailingSpace>

•   RT: CPAN's Bug Tracker

    The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.

    <https://rt.cpan.org/Public/Dist/Display.html?Name=Test-TrailingSpace>

•   CPANTS

    The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

    <http://cpants.cpanauthors.org/dist/Test-TrailingSpace>

•   CPAN Testers

    The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.

    <http://www.cpantesters.org/distro/T/Test-TrailingSpace>

•   CPAN Testers Matrix

    The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.

    <http://matrix.cpantesters.org/?dist=Test-TrailingSpace>

•   CPAN Testers Dependencies

    The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

    <http://deps.cpantesters.org/?module=Test::TrailingSpace>

  Bugs / Feature Requests
Please report any bugs or feature requests by email to "bug-test-trailingspace at rt.cpan.org", or through the web interface at <https://rt.cpan.org/Public/Bug/Report.html?Queue=Test-TrailingSpace>. 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-trailingspace>

  git clone git://github.com/shlomif/perl-test-trailingspace.git

AUTHOR
Shlomi Fish <shlomif@cpan.org>

BUGS
Please report any bugs or feature requests on the bugtracker website <https://github.com/shlomif/perl-test-trailingspace/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.

COPYRIGHT AND LICENSE
This software is Copyright (c) 2012 by Shlomi Fish.

This is free software, licensed under:

  The MIT (X11) License