File perl-Test-Spelling.spec of Package perl-Test-Spelling

# spec file for package perl-Test-Spelling
# Copyright (c) 2015 SUSE LINUX GmbH, Nuernberg, Germany.
# All modifications and additions to the file contributed by third parties
# remain the property of their copyright owners, unless otherwise agreed
# upon. The license for this file, and modifications and additions to the
# file, is the same license as for the pristine package itself (unless the
# license for the pristine package is not an Open Source License, in which
# case the license is the MIT License). An "Open Source License" is a
# license that conforms to the Open Source Definition (Version 1.9)
# published by the Open Source Initiative.

# Please submit bugfixes or comments via

Name:           perl-Test-Spelling
Version:        0.20
Release:        0
%define cpan_name Test-Spelling
Summary:        check for spelling errors in POD files
License:        Artistic-1.0 or GPL-1.0+
Group:          Development/Libraries/Perl
BuildArch:      noarch
BuildRoot:      %{_tmppath}/%{name}-%{version}-build
BuildRequires:  perl
BuildRequires:  perl-macros
BuildRequires:  perl(IPC::Run3) >= 0.044
BuildRequires:  perl(Pod::Spell) >= 1.01
BuildRequires:  perl(Test::More) >= 0.88
BuildRequires:  perl(Test::Tester)
Requires:       perl(IPC::Run3) >= 0.044
Requires:       perl(Pod::Spell) >= 1.01

'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_.

    use Test::Spelling;
    pod_file_spelling_ok('lib/Foo/', 'POD file spelling OK');

Note that it is a bad idea to run spelling tests during an ordinary CPAN
distribution install, or in a package that will run in an uncontrolled
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. :-)

You can add your own stop words, which are words that should be ignored by
the spell check, like so:

    add_stopwords(qw(asdf thiswordiscorrect));

Adding stop words in this fashion affects all files checked for the
remainder of the test script. See the Pod::Spell manpage (which this module
is built upon) for a variety of ways to add per-file stop words to each .pm

If you have a lot of stop words, it's useful to put them in your test
file's 'DATA' section like so:

    use Test::Spelling;


To maintain backwards compatibility, comment markers and some whitespace
are ignored. In the near future, the preprocessing we do on the arguments
to the add_stopwords manpage will be changed and documented properly.

%setup -q -n %{cpan_name}-%{version}

%{__perl} Makefile.PL INSTALLDIRS=vendor
%{__make} %{?_smp_mflags}

%{__make} test


%files -f %{name}.files
%doc Changes README

openSUSE Build Service is sponsored by