Permalink
Browse files

updated and added meta files

  • Loading branch information...
1 parent 49908b0 commit 8db813d1a0cfb731f07ea0de2b9102244a390090 @xdg xdg committed Jan 31, 2013
Showing with 193 additions and 1 deletion.
  1. +80 −0 META.json
  2. +112 −0 README.pod
  3. +1 −1 dist.ini
View
@@ -0,0 +1,80 @@
+{
+ "abstract" : "Portable filename comparison",
+ "author" : [
+ "David A. Golden <dagolden@cpan.org>"
+ ],
+ "dynamic_config" : 0,
+ "generated_by" : "Dist::Zilla version 4.300029, CPAN::Meta::Converter version 2.120921",
+ "license" : [
+ "apache_2_0"
+ ],
+ "meta-spec" : {
+ "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
+ "version" : "2"
+ },
+ "name" : "Test-Filename",
+ "no_index" : {
+ "directory" : [
+ "t",
+ "xt",
+ "examples",
+ "corpus"
+ ],
+ "package" : [
+ "DB"
+ ]
+ },
+ "prereqs" : {
+ "configure" : {
+ "requires" : {
+ "ExtUtils::MakeMaker" : "6.30"
+ }
+ },
+ "develop" : {
+ "requires" : {
+ "Pod::Coverage::TrustPod" : "0",
+ "Test::CPAN::Meta" : "0",
+ "Test::Pod" : "1.41",
+ "Test::Pod::Coverage" : "1.08"
+ }
+ },
+ "runtime" : {
+ "requires" : {
+ "Path::Tiny" : "0",
+ "Test::Builder::Module" : "0",
+ "perl" : "5.006",
+ "strict" : "0",
+ "warnings" : "0"
+ }
+ },
+ "test" : {
+ "requires" : {
+ "File::Find" : "0",
+ "File::Spec::Functions" : "0",
+ "File::Temp" : "0",
+ "Test::More" : "0",
+ "Test::Tester" : "0"
+ }
+ }
+ },
+ "provides" : {
+ "Test::Filename" : {
+ "file" : "lib/Test/Filename.pm",
+ "version" : "0.001"
+ }
+ },
+ "release_status" : "stable",
+ "resources" : {
+ "bugtracker" : {
+ "web" : "https://github.com/dagolden/test-filename/issues"
+ },
+ "homepage" : "https://metacpan.org/release/Test-Filename",
+ "repository" : {
+ "type" : "git",
+ "url" : "git://github.com/dagolden/test-filename.git",
+ "web" : "https://github.com/dagolden/test-filename"
+ }
+ },
+ "version" : "0.001"
+}
+
View
@@ -0,0 +1,112 @@
+=pod
+
+=head1 NAME
+
+Test::Filename - Portable filename comparison
+
+=head1 VERSION
+
+version 0.001
+
+=head1 SYNOPSIS
+
+ use Test::Filename tests => 2;
+
+ filename_is ( "some\path", "some/path", "should pass" );
+ filename_isnt( "some\path", "some/path", "should fail" );
+
+=head1 DESCRIPTION
+
+Many cross-platform test failures -- particularly on Win32 -- are due to
+hard-coded file paths being used in comparison tests.
+
+ my $file = get_file(); # returns "foo\bar.t";
+ is( $file, "foo/bar.t" ); # fails on Win32
+
+This simple module provides some handy functions to convert all those
+path separators automatically so filename tests will just DWIM.
+
+The alternative is to write your own utility subroutine and use it everywhere
+or just keep on littering your test code with calls to File::Spec -- yuck!
+
+ is( $file, File::Spec->canonpath("some/path"), "should pass" );
+
+Since this module is so simple, you might not think it worth including as a
+dependency. After all, it's not I<that> hard to always remember to use
+L<File::Spec>, L<Path::Tiny> or some other file utility, right? But odds are
+that, at some point, you'll be so busy writing tests that you'll forget and
+hard-code a path in your haste to show what a clever programmer you are.
+
+So just use this module and stop worrying about it. You'll be happier
+and so will anyone trying to install your modules on Win32.
+
+=head1 USAGE
+
+Just like Test::More, you have the option of providing a test plan
+as arguments when you use this module. The following functions are
+imported by default.
+
+=head2 filename_is
+=head2 filename_isnt
+
+ filename_is ( $got, $expected, $label );
+ filename_isnt( $got, $expected, $label );
+
+These functions work just like C<is()> and C<isnt()> from Test::More, but
+the first two argument will be cleaned up and normalized to Unix-style
+paths using L<Path::Tiny>. This means that C<.\foo.txt> will get normalized
+to C<foo.txt> and so on.
+
+=head1 SEE ALSO
+
+=over 4
+
+=item *
+
+L<perlport>
+
+=item *
+
+L<File::Spec>
+
+=item *
+
+L<Path::Tiny>
+
+=item *
+
+L<Test::More>
+
+=back
+
+=for :stopwords cpan testmatrix url annocpan anno bugtracker rt cpants kwalitee diff irc mailto metadata placeholders metacpan
+
+=head1 SUPPORT
+
+=head2 Bugs / Feature Requests
+
+Please report any bugs or feature requests through the issue tracker
+at L<https://github.com/dagolden/test-filename/issues>.
+You will be notified automatically of any progress on your issue.
+
+=head2 Source Code
+
+This is open source software. The code repository is available for
+public review and contribution under the terms of the license.
+
+L<https://github.com/dagolden/test-filename>
+
+ git clone git://github.com/dagolden/test-filename.git
+
+=head1 AUTHOR
+
+David A. Golden <dagolden@cpan.org>
+
+=head1 COPYRIGHT AND LICENSE
+
+This software is Copyright (c) 2007 by David A. Golden.
+
+This is free software, licensed under:
+
+ The Apache License, Version 2.0, January 2004
+
View
@@ -8,4 +8,4 @@ copyright_year = 2007
:version = 0.036
AutoMetaResources.bugtracker.rt = 0
AutoMetaResources.bugtracker.github = user:dagolden
-
+stopwords = DWIM

0 comments on commit 8db813d

Please sign in to comment.