Commits

Shlomi Fish committed 1ba5960

Add an abstract and docs.

Comments (0)

Files changed (1)

Test-TrailingSpace/lib/Test/TrailingSpace.pm

 package Test::TrailingSpace;
 
 1;
+
+__END__
+
+=encoding utf-8
+
+=head1 NAME
+
+Test::TrailingSpace - test for trailing space in source files.
+
+=head1 SYNOPSIS
+
+    use Test::TrailingSpace;
+
+    my $finder = Test::TrailingSpace->new(
+        {
+            root => '.',
+            filename_regex => qr/\.(?:t|pm|pl)\z/,
+        },
+    );
+
+    # TEST
+    $finder->is_without_trailing_space(
+        "No trailing space was found."
+    );
+
+=head1 DESCRIPTION
+
+This module is used to test for lack of trailing space. See the synopsis
+for more details.
+
+=head1 METHODS
+
+=head2 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.).
+
+=head2 $finder->is_without_trailing_space($blurb)
+
+Determines if there is no trailing space in the source files. Returns 1
+if there isn't and 0 if there's not, and is equivalent to the Test::More::ok(),
+with diagnostics if there is trailing space.
+
+=head1 AUTHOR
+
+Shlomi Fish, L<http://www.shlomifish.org/> .
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright 2012 Shlomi Fish.
+
+This program is distributed under the MIT (X11) License:
+L<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.
+
+=cut
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.