tests and documentation

mojolicious · Jan 7, 2017 · f3d9f5d · f3d9f5d
1 parent 2808cf5
commit f3d9f5d
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 16 deletions.
diff --git a/lib/Mojo/File.pm b/lib/Mojo/File.pm
@@ -128,7 +128,7 @@ sub to_string {"${$_[0]}"}
 
 =head1 NAME
 
-Mojo::File - File paths
+Mojo::File - File system paths
 
 =head1 SYNOPSIS
 
@@ -146,11 +146,12 @@ Mojo::File - File paths
 
 =head1 DESCRIPTION
 
-L<Mojo::File> is a scalar-based container for file system paths.
+L<Mojo::File> is a scalar-based container for file system paths that provides a
+friendly API for dealing with different operating systems.
 
   # Access scalar directly to manipulate path
-  my $path = Mojo::File->new('/home/sri/');
-  $$path .= '.vimrc';
+  my $path = Mojo::File->new('/home/sri/test');
+  $$path .= '.txt';
 
 =head1 FUNCTIONS
 
@@ -171,7 +172,8 @@ working directory.
   my $path = tempdir;
   my $path = tempdir('tempXXXXX');
 
-Construct a new scalar-based L<Mojo::File> object with L<File::Temp>.
+Construct a new scalar-based L<Mojo::File> object for a temporary directory with
+L<File::Temp>.
 
   # Longer version
   my $path = Mojo::File->new(File::Temp->newdir('tempXXXXX'));
@@ -185,7 +187,7 @@ L<Mojo::File> implements the following methods.
   my $name = $path->basename;
   my $name = $path->basename('.txt');
 
-Return the last level of the path with L<File::Basename> as a string.
+Return the last level of the path with L<File::Basename>.
 
   # ".vimrc" (on UNIX)
   Mojo::File->new('/home/sri/.vimrc')->basename;
@@ -197,7 +199,7 @@ Return the last level of the path with L<File::Basename> as a string.
 
   my $child = $path->child('.vimrc');
 
-Return a new L<Mojo::File> object relative to the original.
+Return a new L<Mojo::File> object relative to the path.
 
   # "/home/sri/.vimrc" (on UNIX)
   Mojo::File->new('/home')->child('sri', '.vimrc');
@@ -216,7 +218,7 @@ L<Mojo::File> object.
 
   my $bool = $path->is_abs;
 
-Check if path is absolute.
+Check if the path is absolute.
 
   # True (on UNIX)
   Mojo::File->new('/home/sri/.vimrc')->is_abs;
@@ -229,8 +231,8 @@ Check if path is absolute.
   my $collection = $path->list;
   my $collection = $path->list({hidden => 1});
 
-List all files in a directory and return a L<Mojo::Collection> object containing
-the results as L<Mojo::File> objects.
+List all files in the directory and return a L<Mojo::Collection> object
+containing the results as L<Mojo::File> objects.
 
   # List files
   say for Mojo::File->new('/home/sri/myapp')->list->each;
@@ -258,7 +260,7 @@ Include hidden files.
   my $collection = $path->list_tree;
   my $collection = $path->list_tree({hidden => 1});
 
-List all files recursively in a directory and return a L<Mojo::Collection>
+List all files recursively in the directory and return a L<Mojo::Collection>
 object containing the results as L<Mojo::File> objects.
 
   # List all templates
@@ -280,13 +282,13 @@ Include hidden files and directories.
 
   $path = $path->make_path;
 
-Create the given directories if they don't exist already with L<File::Path>.
+Create the directories if they don't already exist with L<File::Path>.
 
 =head2 move_to
 
   $path = $path->move_to('/home/sri/.vimrc.backup');
 
-Move file with L<File::Copy>.
+Move the file.
 
 =head2 new
 
@@ -301,13 +303,13 @@ directory.
 
   my $bytes = $path->slurp;
 
-Read all data at once from file.
+Read all data at once from the file.
 
 =head2 spurt
 
   $path = $path->spurt($bytes);
 
-Write all data at once to file.
+Write all data at once to the file.
 
 =head2 tap
 
@@ -344,7 +346,7 @@ L<Mojo::File> object.
 
   my $str = $path->to_string;
 
-Turn path into a string.
+Stringify the path.
 
 =head1 OPERATORS
 

diff --git a/lib/Mojolicious/Guides.pod b/lib/Mojolicious/Guides.pod
@@ -461,6 +461,8 @@ This is the class hierarchy of the L<Mojolicious> distribution.
 
 =item * L<Mojo::DOM>
 
+=item * L<Mojo::File>
+
 =item * L<Mojo::JSON>
 
 =item * L<Mojo::Loader>

diff --git a/t/mojo/file.t b/t/mojo/file.t
@@ -52,6 +52,9 @@ my $path = "$dir";
 ok -d $path, 'directory exists';
 undef $dir;
 ok !-d $path, 'directory does not exist anymore';
+$dir = tempdir 'mytestXXXXX';
+ok -d $dir, 'directory exists';
+like $dir->basename, qr/mytest.{5}$/, 'right format';
 
 # Make path
 $dir = tempdir;