Update documentation and version

[gruntmaster-daemon.git] / lib / Gruntmaster / Daemon / Runner / File.pm

diff --git a/lib/Gruntmaster/Daemon/Runner/File.pm b/lib/Gruntmaster/Daemon/Runner/File.pm
index 50f51868e2e199cd6a6045e00a5051fe4ae00d2f..00d38fd010564fc116d75865b1bf9a2728ac5215 100644 (file)
--- a/lib/Gruntmaster/Daemon/Runner/File.pm
+++ b/lib/Gruntmaster/Daemon/Runner/File.pm
@@ -8,6 +8,8 @@ use Gruntmaster::Daemon::Constants qw/WA/;
 use File::Slurp qw/slurp/;
 use Log::Log4perl qw/get_logger/;
 
+our $VERSION = "5999-TRIAL";
+
 ##################################################
 
 sub run{
@@ -28,4 +30,36 @@ sub run{
   $meta->{tests}[$test - 1] // 0
 }
 
-1
+1;
+__END__
+
+=encoding utf-8
+
+=head1 NAME
+
+Gruntmaster::Daemon::Runner::File - Compare output with static text files
+
+=head1 SYNOPSIS
+
+  use Gruntmaster::Daemon::Runner::File;
+  Gruntmaster::Daemon::Runner::File->run(5, $meta);
+
+=head1 DESCRIPTION
+
+Gruntmaster::Daemon::Runner::File is a runner which compares the program output for test C<$test> with C<< $meta->{tests}[$test - 1]>>. Before comparing, leading and trailing whitespace is removed, and sequences of whitespace are converted to a single space.
+
+=head1 AUTHOR
+
+Marius Gavrilescu E<lt>marius@ieval.roE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2014 by Marius Gavrilescu
+
+This library is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+
+=cut