Hello community, here is the log from the commit of package perl-Test-Spelling for openSUSE:Factory checked in at 2019-06-01 09:51:51 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Comparing /work/SRC/openSUSE:Factory/perl-Test-Spelling (Old) and /work/SRC/openSUSE:Factory/.perl-Test-Spelling.new.5148 (New) ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "perl-Test-Spelling" Sat Jun 1 09:51:51 2019 rev:15 rq:706229 version:0.25 Changes: -------- --- /work/SRC/openSUSE:Factory/perl-Test-Spelling/perl-Test-Spelling.changes 2019-05-27 08:39:49.219037411 +0200 +++ /work/SRC/openSUSE:Factory/.perl-Test-Spelling.new.5148/perl-Test-Spelling.changes 2019-06-01 09:51:52.623275590 +0200 @@ -1,0 +2,15 @@ +Wed May 29 05:38:26 UTC 2019 - Stephan Kulow <[email protected]> + +- updated to 0.25 + see /usr/share/doc/packages/perl-Test-Spelling/Changes + + 0.25 2019-05-28 + - Re-worded the documentation. + - Ordered documented function in alphabetical order. + - Fixed up the synopsis. + - Put function usage examples directly below the function name; this + makes it easier to get clickable links for functions in metacpan + - Documented get_pod_parser + - Moved hunspell up to the preferred checker + +------------------------------------------------------------------- Old: ---- Test-Spelling-0.24.tar.gz New: ---- Test-Spelling-0.25.tar.gz ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Other differences: ------------------ ++++++ perl-Test-Spelling.spec ++++++ --- /var/tmp/diff_new_pack.LDU8G5/_old 2019-06-01 09:51:53.183275399 +0200 +++ /var/tmp/diff_new_pack.LDU8G5/_new 2019-06-01 09:51:53.187275397 +0200 @@ -17,7 +17,7 @@ Name: perl-Test-Spelling -Version: 0.24 +Version: 0.25 Release: 0 %define cpan_name Test-Spelling Summary: Check for spelling errors in POD files @@ -39,9 +39,10 @@ %{perl_requires} %description -'Test::Spelling' lets you check the spelling of a POD file, and report its -results in standard 'Test::More' fashion. This module requires a spellcheck -program such as _spell_, _aspell_, _ispell_, or _hunspell_. +Test::Spelling lets you check the spelling of a 'POD' file, and report its +results in standard Test::More fashion. This module requires a spellcheck +program such as at http://hunspell.github.io/, _aspell_, _spell_, or, +_ispell_. We suggest using Hunspell. use Test::Spelling; pod_file_spelling_ok('lib/Foo/Bar.pm', 'POD file spelling OK'); @@ -51,10 +52,11 @@ environment. There is no way of predicting whether the word list or spellcheck program used will give the same results. You *can* include the test in your distribution, but be sure to run it only for authors of the -module by guarding it in a 'skip_all unless -d 'inc/.author'' clause, or by -putting the test in your distribution's _xt/_ directory. Anyway, people -installing your module really do not need to run such tests, as it is -unlikely that the documentation will acquire typos while in transit. :-) +module by guarding it in a 'skip_all unless $ENV{AUTHOR_TESTING}' clause, +or by putting the test in your distribution's _xt/author_ directory. +Anyway, people installing your module really do not need to run such tests, +as it is unlikely that the documentation will acquire typos while in +transit. You can add your own stop words, which are words that should be ignored by the spell check, like so: @@ -68,18 +70,24 @@ If you have a lot of stop words, it's useful to put them in your test file's 'DATA' section like so: + use strict; + use warnings; + use Test::More; + use Test::Spelling; + use Pod::Wordlist; + add_stopwords(<DATA>); all_pod_files_spelling_ok(); - __END__ + __DATA__ folksonomy Jifty Zakirov To maintain backwards compatibility, comment markers and some whitespace are ignored. In the near future, the preprocessing we do on the arguments -to add_stopwords will be changed and documented properly. +to Test::Spelling/"add_stopwords" will be changed and documented properly. %prep %setup -q -n %{cpan_name}-%{version} ++++++ Test-Spelling-0.24.tar.gz -> Test-Spelling-0.25.tar.gz ++++++ diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/Test-Spelling-0.24/Changes new/Test-Spelling-0.25/Changes --- old/Test-Spelling-0.24/Changes 2019-05-24 15:43:01.000000000 +0200 +++ new/Test-Spelling-0.25/Changes 2019-05-29 03:11:09.000000000 +0200 @@ -1,5 +1,14 @@ Revision history for Test-Spelling +0.25 2019-05-28 + - Re-worded the documentation. + - Ordered documented function in alphabetical order. + - Fixed up the synopsis. + - Put function usage examples directly below the function name; this + makes it easier to get clickable links for functions in metacpan + - Documented get_pod_parser + - Moved hunspell up to the preferred checker + 0.24 2019-05-24 - Fixup the prereqs some - Revert the unicode support added in the last release as it caused diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/Test-Spelling-0.24/META.json new/Test-Spelling-0.25/META.json --- old/Test-Spelling-0.24/META.json 2019-05-24 15:43:01.000000000 +0200 +++ new/Test-Spelling-0.25/META.json 2019-05-29 03:11:09.000000000 +0200 @@ -1,5 +1,5 @@ { - "abstract" : "check for spelling errors in POD files", + "abstract" : "Check for spelling errors in POD files", "author" : [ "Ivan Tubert-Brohman <[email protected]>" ], @@ -87,7 +87,7 @@ "provides" : { "Test::Spelling" : { "file" : "lib/Test/Spelling.pm", - "version" : "0.24" + "version" : "0.25" } }, "release_status" : "stable", @@ -102,7 +102,7 @@ "web" : "https://github.com/genio/test-spelling"; } }, - "version" : "0.24", + "version" : "0.25", "x_Dist_Zilla" : { "perl" : { "version" : "5.026001" @@ -413,7 +413,7 @@ "branch" : null, "changelog" : "Changes", "signed" : 0, - "tag" : "v0.24", + "tag" : "v0.25", "tag_format" : "v%V", "tag_message" : "v%V" }, @@ -491,7 +491,7 @@ "bin", "lib" ], - "spell_cmd" : "aspell list", + "spell_cmd" : "", "stopwords" : [ "Brohman", "CPAN", diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/Test-Spelling-0.24/META.yml new/Test-Spelling-0.25/META.yml --- old/Test-Spelling-0.24/META.yml 2019-05-24 15:43:01.000000000 +0200 +++ new/Test-Spelling-0.25/META.yml 2019-05-29 03:11:09.000000000 +0200 @@ -1,5 +1,5 @@ --- -abstract: 'check for spelling errors in POD files' +abstract: 'Check for spelling errors in POD files' author: - 'Ivan Tubert-Brohman <[email protected]>' build_requires: @@ -30,7 +30,7 @@ provides: Test::Spelling: file: lib/Test/Spelling.pm - version: '0.24' + version: '0.25' requires: Exporter: '5.57' File::Spec: '0' @@ -46,7 +46,7 @@ bugtracker: https://github.com/genio/test-spelling/issues homepage: https://github.com/genio/test-spelling repository: https://github.com/genio/test-spelling.git -version: '0.24' +version: '0.25' x_Dist_Zilla: perl: version: '5.026001' @@ -286,7 +286,7 @@ branch: ~ changelog: Changes signed: 0 - tag: v0.24 + tag: v0.25 tag_format: v%V tag_message: v%V Dist::Zilla::Role::Git::Repo: @@ -344,7 +344,7 @@ directories: - bin - lib - spell_cmd: 'aspell list' + spell_cmd: '' stopwords: - Brohman - CPAN diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/Test-Spelling-0.24/Makefile.PL new/Test-Spelling-0.25/Makefile.PL --- old/Test-Spelling-0.24/Makefile.PL 2019-05-24 15:43:01.000000000 +0200 +++ new/Test-Spelling-0.25/Makefile.PL 2019-05-29 03:11:09.000000000 +0200 @@ -8,7 +8,7 @@ use ExtUtils::MakeMaker; my %WriteMakefileArgs = ( - "ABSTRACT" => "check for spelling errors in POD files", + "ABSTRACT" => "Check for spelling errors in POD files", "AUTHOR" => "Ivan Tubert-Brohman <itub\@cpan.org>", "BUILD_REQUIRES" => { "ExtUtils::MakeMaker" => 0 @@ -39,7 +39,7 @@ "utf8" => 0, "warnings" => 0 }, - "VERSION" => "0.24", + "VERSION" => "0.25", "test" => { "TESTS" => "t/*.t" } diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/Test-Spelling-0.24/README new/Test-Spelling-0.25/README --- old/Test-Spelling-0.24/README 2019-05-24 15:43:01.000000000 +0200 +++ new/Test-Spelling-0.25/README 2019-05-29 03:11:09.000000000 +0200 @@ -1,20 +1,46 @@ NAME - Test::Spelling - check for spelling errors in POD files + Test::Spelling - Check for spelling errors in POD files SYNOPSIS + Place a file, "pod-spell.t" in your distribution's "xt/author" + directory: + + use strict; + use warnings; + use Test::More; + + use Test::Spelling; + use Pod::Wordlist; + + add_stopwords(<DATA>); + all_pod_files_spelling_ok( qw( bin lib ) ); + + __DATA__ + SomeBizarreWord + YetAnotherBIzarreWord + + Or, you can gate the spelling test with the environment variable + "AUTHOR_TESTING": + + use strict; + use warnings; use Test::More; + BEGIN { plan skip_all => "Spelling tests only for authors" - unless -d 'inc/.author'; + unless $ENV{AUTHOR_TESTING}; } use Test::Spelling; + use Pod::Wordlist; + all_pod_files_spelling_ok(); DESCRIPTION - "Test::Spelling" lets you check the spelling of a POD file, and report - its results in standard "Test::More" fashion. This module requires a - spellcheck program such as spell, aspell, ispell, or hunspell. + Test::Spelling lets you check the spelling of a "POD" file, and report + its results in standard Test::More fashion. This module requires a + spellcheck program such as Hunspell <http://hunspell.github.io/>, + aspell, spell, or, ispell. We suggest using Hunspell. use Test::Spelling; pod_file_spelling_ok('lib/Foo/Bar.pm', 'POD file spelling OK'); @@ -24,10 +50,11 @@ environment. There is no way of predicting whether the word list or spellcheck program used will give the same results. You can include the test in your distribution, but be sure to run it only for authors of the - module by guarding it in a "skip_all unless -d 'inc/.author'" clause, or - by putting the test in your distribution's xt/ directory. Anyway, people - installing your module really do not need to run such tests, as it is - unlikely that the documentation will acquire typos while in transit. :-) + module by guarding it in a "skip_all unless $ENV{AUTHOR_TESTING}" + clause, or by putting the test in your distribution's xt/author + directory. Anyway, people installing your module really do not need to + run such tests, as it is unlikely that the documentation will acquire + typos while in transit. You can add your own stop words, which are words that should be ignored by the spell check, like so: @@ -41,52 +68,42 @@ If you have a lot of stop words, it's useful to put them in your test file's "DATA" section like so: + use strict; + use warnings; + use Test::More; + use Test::Spelling; + use Pod::Wordlist; + add_stopwords(<DATA>); all_pod_files_spelling_ok(); - __END__ + __DATA__ folksonomy Jifty Zakirov To maintain backwards compatibility, comment markers and some whitespace are ignored. In the near future, the preprocessing we do on the - arguments to add_stopwords will be changed and documented properly. + arguments to "add_stopwords" in Test::Spelling will be changed and + documented properly. FUNCTIONS - all_pod_files_spelling_ok( [@files/@directories] ) - Checks all the files for POD spelling. It gathers "all_pod_files" on - each file/directory, and declares a "plan" in Test::More for you (one - test for each file), so you must not call "plan" yourself. - - If @files is empty, the function finds all POD files in the blib - directory if it exists, or the lib directory if it does not. A POD file - is one that ends with .pod, .pl, .plx, or .pm; or any file where the - first line looks like a perl shebang line. - - If there is no working spellchecker (determined by - "has_working_spellchecker"), this test will issue a "skip all" - directive. + Test::Spelling makes the following methods available. - If you're testing a distribution, just create a t/pod-spell.t with the - code in the "SYNOPSIS". + add_stopwords + add_stopwords(@words); + add_stopwords(<DATA>); # pull in stop words from the DATA section + + Add words that should be skipped by the spell checker. Note that + Pod::Spell already skips words believed to be code, such as everything + in verbatim (indented) blocks and code marked up with "...", as well as + some common Perl jargon. + + all_pod_files + all_pod_files(); + all_pod_files(@list_of_directories); - Returns true if every POD file has correct spelling, or false if any of - them fail. This function will show any spelling errors as diagnostics. - - pod_file_spelling_ok( $filename[, $testname ] ) - "pod_file_spelling_ok" will test that the given POD file has no spelling - errors. - - When it fails, "pod_file_spelling_ok" will show any spelling errors as - diagnostics. - - The optional second argument is the name of the test. If it is omitted, - "pod_file_spelling_ok" chooses a default test name "POD spelling for - $filename". - - all_pod_files( [@dirs] ) Returns a list of all the Perl files in each directory and its subdirectories, recursively. If no directories are passed, it defaults to blib if blib exists, or else lib if not. Skips any files in CVS or @@ -105,13 +122,46 @@ The order of the files returned is machine-dependent. If you want them sorted, you'll have to sort them yourself. - add_stopwords(@words) - Add words that should be skipped by the spellcheck. Note that Pod::Spell - already skips words believed to be code, such as everything in verbatim - (indented) blocks and code marked up with "...", as well as some common - Perl jargon. + all_pod_files_spelling_ok + all_pod_files_spelling_ok(@list_of_files); + all_pod_files_spelling_ok(@list_of_directories); + + Checks all the files for "POD" spelling. It gathers "all_pod_files" in + Test::Spelling on each file/directory, and declares a "plan" in + Test::More for you (one test for each file), so you must not call "plan" + yourself. + + If @files is empty, the function finds all "POD" files in the blib + directory if it exists, or the lib directory if it does not. A "POD" + file is one that ends with .pod, .pl, .plx, or .pm; or any file where + the first line looks like a perl shebang line. + + If there is no working spellchecker (determined by + <Test:Spelling/"has_working_spellchecker">), this test will issue a + "skip all" directive. + + If you're testing a distribution, just create an xt/author/pod-spell.t + with the code in the "SYNOPSIS". + + Returns true if every "POD" file has correct spelling, or false if any + of them fail. This function will show any spelling errors as + diagnostics. + + * NOTE: This only tests using bytes. This is not decoded content, etc. + Do not expect this to work with Unicode content, for example. This uses + an open with no layers and no decoding. + + get_pod_parser + # a Pod::Spell -like object + my $object = get_pod_parser(); + + Get the object we're using to parse the "POD". A new Pod::Spell object + should be used for every file. People providing custom parsers will have + to do this themselves. has_working_spellchecker + my $cmd = has_working_spellchecker; + "has_working_spellchecker" will return "undef" if there is no working spellchecker, or a true value (the spellchecker command itself) if there is. The module performs a dry-run to determine whether any of the @@ -122,45 +172,69 @@ A full list of spellcheckers which this method might test can be found in the source of the "spellchecker_candidates" method. - set_spell_cmd($command) - If you want to force this module to use a particular spellchecker, then - you can specify which one with "set_spell_cmd". This is useful to ensure - a more consistent lexicon between developers, or if you have an unusual - environment. Any command that takes text from standard input and prints - a list of misspelled words, one per line, to standard output will do. + pod_file_spelling_ok + pod_file_spelling_ok('/path/to/Foo.pm'); + pod_file_spelling_ok('/path/to/Foo.pm', 'Foo is well spelled!'); - set_pod_file_filter($code) - If your project has POD documents written in languages other than - English, then obviously you don't want to be running a spellchecker on - every Perl file. "set_pod_file_filter" lets you filter out files - returned from "all_pod_files" (and hence, the documents tested by - "all_pod_files_spelling_ok"). + "pod_file_spelling_ok" will test that the given "POD" file has no + spelling errors. + + When it fails, "pod_file_spelling_ok" will show any spelling errors as + diagnostics. + + The optional second argument is the name of the test. If it is omitted, + "pod_file_spelling_ok" chooses a default test name "POD spelling for + $filename". + * NOTE: This only tests using bytes. This is not decoded content, etc. + Do not expect this to work with Unicode content, for example. This uses + an open with no layers and no decoding. + + set_pod_file_filter + # code ref set_pod_file_filter(sub { my $filename = shift; return 0 if $filename =~ /_ja.pod$/; # skip Japanese translations return 1; }); - set_pod_parser($object) + If your project has "POD" documents written in languages other than + English, then obviously you don't want to be running a spellchecker on + every Perl file. "set_pod_file_filter" lets you filter out files + returned from "all_pod_files" (and hence, the documents tested by + "all_pod_files_spelling_ok"). + + set_pod_parser + my $object = Pod::Spell->new(); + set_pod_parser($object); + By default Pod::Spell is used to generate text suitable for spellchecking from the input POD. If you want to use a different parser, perhaps a customized subclass of Pod::Spell, call "set_pod_parser" with an object that is-a Pod::Parser. Be sure to create a fresh parser object for each file (don't use this with "all_pod_files_spelling_ok"). + set_spell_cmd + set_spell_cmd('hunspell -l'); # current preferred + set_spell_cmd('aspell list'); + set_spell_cmd('spell'); + set_spell_cmd('ispell -l'); + + If you want to force this module to use a particular spellchecker, then + you can specify which one with "set_spell_cmd". This is useful to ensure + a more consistent lexicon between developers, or if you have an unusual + environment. Any command that takes text from standard input and prints + a list of misspelled words, one per line, to standard output will do. + SEE ALSO Pod::Spell -ORIGINAL AUTHOR +AUTHOR Ivan Tubert-Brohman "<[email protected]>" Heavily based on Test::Pod by Andy Lester and brian d foy. -MAINTAINER - Shawn M Moore "<[email protected]>" - -COPYRIGHT +COPYRIGHT & LICENSE Copyright 2005, Ivan Tubert-Brohman, All Rights Reserved. You may use, modify, and distribute this package under the same terms as diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/Test-Spelling-0.24/dist.ini new/Test-Spelling-0.25/dist.ini --- old/Test-Spelling-0.24/dist.ini 2019-05-24 15:43:01.000000000 +0200 +++ new/Test-Spelling-0.25/dist.ini 2019-05-29 03:11:09.000000000 +0200 @@ -43,11 +43,11 @@ skiptest = no_symlinks [Test::Version] [Test::Pod::Coverage::Configurable] -trustme = Test::Spelling => qr/^(?:get_pod_parser|invalid_words_in|spellchecker_candidates)$/ +trustme = Test::Spelling => qr/^(?:invalid_words_in|spellchecker_candidates)$/ [Test::PodSpelling] wordlist = Pod::Wordlist -spell_cmd = aspell list +; spell_cmd = hunspell -l stopword = CPAN stopword = github stopword = stopwords diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/Test-Spelling-0.24/lib/Test/Spelling.pm new/Test-Spelling-0.25/lib/Test/Spelling.pm --- old/Test-Spelling-0.24/lib/Test/Spelling.pm 2019-05-24 15:43:01.000000000 +0200 +++ new/Test-Spelling-0.25/lib/Test/Spelling.pm 2019-05-29 03:11:09.000000000 +0200 @@ -11,7 +11,7 @@ use IPC::Run3; use Symbol 'gensym'; -our $VERSION = '0.24'; +our $VERSION = '0.25'; our @EXPORT = qw( pod_file_spelling_ok @@ -36,10 +36,10 @@ return $SPELLCHECKER if $SPELLCHECKER; return ( + 'hunspell -l', # hunspell is now the most common spell checker 'spell', # for back-compat, this is the top candidate ... 'aspell list -l en -p /dev/null', # ... but this should become first soon 'ispell -l', - 'hunspell -l', ); } @@ -262,24 +262,48 @@ =head1 NAME -Test::Spelling - check for spelling errors in POD files +Test::Spelling - Check for spelling errors in POD files =head1 SYNOPSIS +Place a file, C<pod-spell.t> in your distribution's C<xt/author> directory: + + use strict; + use warnings; + use Test::More; + + use Test::Spelling; + use Pod::Wordlist; + + add_stopwords(<DATA>); + all_pod_files_spelling_ok( qw( bin lib ) ); + + __DATA__ + SomeBizarreWord + YetAnotherBIzarreWord + +Or, you can gate the spelling test with the environment variable C<AUTHOR_TESTING>: + + use strict; + use warnings; use Test::More; + BEGIN { plan skip_all => "Spelling tests only for authors" - unless -d 'inc/.author'; + unless $ENV{AUTHOR_TESTING}; } use Test::Spelling; + use Pod::Wordlist; + all_pod_files_spelling_ok(); =head1 DESCRIPTION -C<Test::Spelling> lets you check the spelling of a POD file, and report -its results in standard C<Test::More> fashion. This module requires a -spellcheck program such as F<spell>, F<aspell>, F<ispell>, or F<hunspell>. +L<Test::Spelling> lets you check the spelling of a C<POD> file, and report +its results in standard L<Test::More> fashion. This module requires a +spellcheck program such as L<Hunspell|http://hunspell.github.io/>, +F<aspell>, F<spell>, or, F<ispell>. We suggest using Hunspell. use Test::Spelling; pod_file_spelling_ok('lib/Foo/Bar.pm', 'POD file spelling OK'); @@ -289,10 +313,10 @@ environment. There is no way of predicting whether the word list or spellcheck program used will give the same results. You B<can> include the test in your distribution, but be sure to run it only for authors of the module by guarding -it in a C<skip_all unless -d 'inc/.author'> clause, or by putting the test in -your distribution's F<xt/> directory. Anyway, people installing your module +it in a C<skip_all unless $ENV{AUTHOR_TESTING}> clause, or by putting the test in +your distribution's F<xt/author> directory. Anyway, people installing your module really do not need to run such tests, as it is unlikely that the documentation -will acquire typos while in transit. :-) +will acquire typos while in transit. You can add your own stop words, which are words that should be ignored by the spell check, like so: @@ -306,54 +330,43 @@ If you have a lot of stop words, it's useful to put them in your test file's C<DATA> section like so: + use strict; + use warnings; + use Test::More; + use Test::Spelling; + use Pod::Wordlist; + add_stopwords(<DATA>); all_pod_files_spelling_ok(); - __END__ + __DATA__ folksonomy Jifty Zakirov To maintain backwards compatibility, comment markers and some whitespace are ignored. In the near future, the preprocessing we do on the arguments to -L<add_stopwords> will be changed and documented properly. +L<Test::Spelling/"add_stopwords"> will be changed and documented properly. =head1 FUNCTIONS -=head2 all_pod_files_spelling_ok( [@files/@directories] ) - -Checks all the files for POD spelling. It gathers L</all_pod_files> on each -file/directory, and declares a L<Test::More/plan> for you (one test for each -file), so you must not call C<plan> yourself. +L<Test::Spelling> makes the following methods available. -If C<@files> is empty, the function finds all POD files in the F<blib> -directory if it exists, or the F<lib> directory if it does not. A POD file is -one that ends with F<.pod>, F<.pl>, F<.plx>, or F<.pm>; or any file where the -first line looks like a perl shebang line. +=head2 add_stopwords -If there is no working spellchecker (determined by -L</has_working_spellchecker>), this test will issue a "skip all" directive. - -If you're testing a distribution, just create a F<t/pod-spell.t> with the code -in the L</SYNOPSIS>. + add_stopwords(@words); + add_stopwords(<DATA>); # pull in stop words from the DATA section -Returns true if every POD file has correct spelling, or false if any of them fail. -This function will show any spelling errors as diagnostics. - -=head2 pod_file_spelling_ok( $filename[, $testname ] ) - -C<pod_file_spelling_ok> will test that the given POD file has no spelling -errors. +Add words that should be skipped by the spell checker. Note that L<Pod::Spell> +already skips words believed to be code, such as everything in verbatim +(indented) blocks and code marked up with C<< C<...> >>, as well as some common +Perl jargon. -When it fails, C<pod_file_spelling_ok> will show any spelling errors as -diagnostics. +=head2 all_pod_files -The optional second argument is the name of the test. If it is -omitted, C<pod_file_spelling_ok> chooses a default test name "POD -spelling for C<$filename>". - -=head2 all_pod_files( [@dirs] ) + all_pod_files(); + all_pod_files(@list_of_directories); Returns a list of all the Perl files in each directory and its subdirectories, recursively. If no directories are passed, it defaults to F<blib> if F<blib> @@ -375,15 +388,48 @@ The order of the files returned is machine-dependent. If you want them sorted, you'll have to sort them yourself. -=head2 add_stopwords(@words) +=head2 all_pod_files_spelling_ok -Add words that should be skipped by the spellcheck. Note that L<Pod::Spell> -already skips words believed to be code, such as everything in verbatim -(indented) blocks and code marked up with C<< C<...> >>, as well as some common -Perl jargon. + all_pod_files_spelling_ok(@list_of_files); + all_pod_files_spelling_ok(@list_of_directories); + +Checks all the files for C<POD> spelling. It gathers +L<Test::Spelling/"all_pod_files"> on each file/directory, and +declares a L<Test::More/plan> for you (one test for each file), so you +must not call C<plan> yourself. + +If C<@files> is empty, the function finds all C<POD> files in the F<blib> +directory if it exists, or the F<lib> directory if it does not. A C<POD> file is +one that ends with F<.pod>, F<.pl>, F<.plx>, or F<.pm>; or any file where the +first line looks like a perl shebang line. + +If there is no working spellchecker (determined by +L<Test:Spelling/"has_working_spellchecker">), this test will issue a +C<skip all> directive. + +If you're testing a distribution, just create an F<xt/author/pod-spell.t> with the code +in the L</SYNOPSIS>. + +Returns true if every C<POD> file has correct spelling, or false if any of them fail. +This function will show any spelling errors as diagnostics. + +* B<NOTE:> This only tests using bytes. This is not decoded content, etc. Do +not expect this to work with Unicode content, for example. This uses an open +with no layers and no decoding. + +=head2 get_pod_parser + + # a Pod::Spell -like object + my $object = get_pod_parser(); + +Get the object we're using to parse the C<POD>. A new L<Pod::Spell> object +should be used for every file. People providing custom parsers will have +to do this themselves. =head2 has_working_spellchecker + my $cmd = has_working_spellchecker; + C<has_working_spellchecker> will return C<undef> if there is no working spellchecker, or a true value (the spellchecker command itself) if there is. The module performs a dry-run to determine whether any of the spellcheckers it @@ -394,51 +440,75 @@ A full list of spellcheckers which this method might test can be found in the source of the C<spellchecker_candidates> method. -=head2 set_spell_cmd($command) +=head2 pod_file_spelling_ok -If you want to force this module to use a particular spellchecker, then you can -specify which one with C<set_spell_cmd>. This is useful to ensure a more -consistent lexicon between developers, or if you have an unusual environment. -Any command that takes text from standard input and prints a list of misspelled -words, one per line, to standard output will do. + pod_file_spelling_ok('/path/to/Foo.pm'); + pod_file_spelling_ok('/path/to/Foo.pm', 'Foo is well spelled!'); -=head2 set_pod_file_filter($code) +C<pod_file_spelling_ok> will test that the given C<POD> file has no spelling +errors. -If your project has POD documents written in languages other than English, then -obviously you don't want to be running a spellchecker on every Perl file. -C<set_pod_file_filter> lets you filter out files returned from -L</all_pod_files> (and hence, the documents tested by -L</all_pod_files_spelling_ok>). +When it fails, C<pod_file_spelling_ok> will show any spelling errors as +diagnostics. +The optional second argument is the name of the test. If it is +omitted, C<pod_file_spelling_ok> chooses a default test name +C<< POD spelling for $filename >>. + +* B<NOTE:> This only tests using bytes. This is not decoded content, etc. Do +not expect this to work with Unicode content, for example. This uses an open +with no layers and no decoding. + +=head2 set_pod_file_filter + + # code ref set_pod_file_filter(sub { my $filename = shift; return 0 if $filename =~ /_ja.pod$/; # skip Japanese translations return 1; }); -=head2 set_pod_parser($object) +If your project has C<POD> documents written in languages other than English, then +obviously you don't want to be running a spellchecker on every Perl file. +C<set_pod_file_filter> lets you filter out files returned from +L</all_pod_files> (and hence, the documents tested by +L</all_pod_files_spelling_ok>). + +=head2 set_pod_parser + + my $object = Pod::Spell->new(); + set_pod_parser($object); By default L<Pod::Spell> is used to generate text suitable for spellchecking from the input POD. If you want to use a different parser, perhaps a customized subclass of L<Pod::Spell>, call C<set_pod_parser> with an object that is-a L<Pod::Parser>. Be sure to create a fresh parser object for -each file (don't use this with C<all_pod_files_spelling_ok>). +each file (don't use this with L</all_pod_files_spelling_ok>). + +=head2 set_spell_cmd + + set_spell_cmd('hunspell -l'); # current preferred + set_spell_cmd('aspell list'); + set_spell_cmd('spell'); + set_spell_cmd('ispell -l'); + +If you want to force this module to use a particular spellchecker, then you can +specify which one with C<set_spell_cmd>. This is useful to ensure a more +consistent lexicon between developers, or if you have an unusual environment. +Any command that takes text from standard input and prints a list of misspelled +words, one per line, to standard output will do. =head1 SEE ALSO L<Pod::Spell> -=head1 ORIGINAL AUTHOR +=head1 AUTHOR Ivan Tubert-Brohman C<< <[email protected]> >> Heavily based on L<Test::Pod> by Andy Lester and brian d foy. -=head1 MAINTAINER - -Shawn M Moore C<< <[email protected]> >> - -=head1 COPYRIGHT +=head1 COPYRIGHT & LICENSE Copyright 2005, Ivan Tubert-Brohman, All Rights Reserved. diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/Test-Spelling-0.24/xt/author/pod-coverage.t new/Test-Spelling-0.25/xt/author/pod-coverage.t --- old/Test-Spelling-0.24/xt/author/pod-coverage.t 2019-05-24 15:43:01.000000000 +0200 +++ new/Test-Spelling-0.25/xt/author/pod-coverage.t 2019-05-29 03:11:09.000000000 +0200 @@ -27,7 +27,7 @@ my %trustme = ( 'Test::Spelling' => [ - qr/^(?:get_pod_parser|invalid_words_in|spellchecker_candidates)$/ + qr/^(?:invalid_words_in|spellchecker_candidates)$/ ] ); diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/Test-Spelling-0.24/xt/author/pod-spell.t new/Test-Spelling-0.25/xt/author/pod-spell.t --- old/Test-Spelling-0.24/xt/author/pod-spell.t 2019-05-24 15:43:01.000000000 +0200 +++ new/Test-Spelling-0.25/xt/author/pod-spell.t 2019-05-29 03:11:09.000000000 +0200 @@ -6,7 +6,7 @@ use Test::Spelling 0.12; use Pod::Wordlist; -set_spell_cmd('aspell list'); + add_stopwords(<DATA>); all_pod_files_spelling_ok( qw( bin lib ) ); __DATA__ diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/Test-Spelling-0.24/xt/release/changes_has_content.t new/Test-Spelling-0.25/xt/release/changes_has_content.t --- old/Test-Spelling-0.24/xt/release/changes_has_content.t 2019-05-24 15:43:01.000000000 +0200 +++ new/Test-Spelling-0.25/xt/release/changes_has_content.t 2019-05-29 03:11:09.000000000 +0200 @@ -2,7 +2,7 @@ note 'Checking Changes'; my $changes_file = 'Changes'; -my $newver = '0.24'; +my $newver = '0.25'; my $trial_token = '-TRIAL'; my $encoding = 'UTF-8';
