J. J. Merelo-Guervós
and 1 contributors

NAME

Test::Text - A module for testing text files for spelling and (maybe) more.

VERSION

This document describes Test::Text version 0.3.0

SYNOPSIS

    use Test::Text;

    my $dir = "path/to/text_dir"; 
    my $data = "path/to/data_dir"; 

    my $tesxt = Test::Text->new($text_dir, $dict_dir); # Defaults to English: en_US and all files

    $tesxt = Test::Text->new($text_dir, $dict_dir, "en_US", $this_file, $that_file); # Tests only those files

    $tesxt = Test::Text->new($text_dir, $dict_dir, "es_ES"); # Uses alternate language

    $testxt->check(); # spell-checks plain or markdown text in that dir or just passed

    $testxt->done_testing(); # all over and out

    #Alternative procedural/single-function interface
    just_check( $dir, $data ); # Includes done_testing

DESCRIPTION

This started as a spell and quality check for my novel, "Manuel the Magnificent Mechanical Man". Eventually, it can be used for checking any kind of markdown-formatted text, be it fiction or non-fiction. The first version included as documentation, the novel itself (check it out at Text::Hoborg::Manuel and also in the test directory the markdown source.

This module is a more general text-tester (that's a tesxter) which can be used on any external set of texts. This all came from the idea that writing is like software development, which I'm using throughout.

You will need to install Hunspell and any dictionary you will be using. By default, Hunspell install quite a few and you can also use the dictionaries from myspell. Problem is Text::Hunspell, which is the module used for spelling, does not work correctly with dictionaries using Latin1 codification, which are the ones supplied by default with Hunspell. For Spanish, for instance, you will have to obtain your own dictionary with UTF8 codification, with the ones supplied with Sublime Text being a very good option. The Spanish files obtained there are included in this module for testing purposes.

INTERFACE

new $text_dir, $data_dir [, $language = 'en_US'] [, @files]

Creates an object with link to text and markdown files identified by extension. There is no default for the dir since it is supposed to be external. If an array of files is given, only those are used and not all the files inside the directory; these files will be prepended the $text_dir to get the whole path.

files

Returns the files it will be checking.

dir

Returns the dir the source files are in. Since this is managed from the object, it is useful for other functions.

check

Check files. This is the only function you will have to call from from your test script.

_strip_urls( text )

Strips URLs in Markdown format

_strip_code( text )

Strips URLs in Markdown format

Strips some code marks in Markdown format

just_check $text_dir, $data_dir [, $language = 'en_US'] [, @files]

Everything you need in a single function. The first directory will include text and auxiliary directory files, the second main dictionary and suffix files. By default all *.md files will be checked. Basically equivalent to the creation of an object followed by $ob-check()>

done_testing

Called after all tests have been performed.

DEPENDENCIES

Test::Text requires Text::Hunspell and the en_US dictionnary for hunspell, which you can install with sudo apt-get install hunspell-en-us, but since I found no way of expressing this dependency within Makefile.PL, I have added it to the data dir, mainly. Latest version requires Test::Builder. It also includes the es dictionnary in the latest version, also included. If you need any other file, check previously that it's in the /usr/share/hunspell dir, but since this module is mainly intended to be used for CI, I had rather include these files in the distro.

If you use any language with heavy dependencies on UTF8 like Spanish, the supplied dictionaries will be no use. Check the UTF dictionaries available from SublimeText; even so, the Spanish affix file yields warnings so you might want to use the version I patched, available at the GitHub repo.

Development and bugs

Development of this module is hosted at GitHub. Use it for forking, bug reports, checking it out, giving stars, whatever. Use also the CPAN interface if you want.

SEE ALSO

Manuel, the Marvelous Mechanical Man, the novel that spawned all this, or the other way around. Check out also Text::Hunspell, an excellent interface to the hunspell spelling program.

AUTHOR

JJ Merelo <jj@merelo.net>

Gabor Szabo <szabgab@cpan.org> has contributed many patches. And encouragement.

Regexes for markdown code taken from node-markdown https://github.com/JJ/node-markdown-spellcheck by Luke Page https://github.com/lukeapage

LICENCE AND COPYRIGHT

Copyright (c) 2014, JJ Merelo <jj@merelo.net>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.