Breaking: Remove file labels (#170)

This is the next step to removing the path() method of the temporary
file (#165): if there is no path,
there is definitely no labels in file path

Author: bugdea1er

README.md

@@ -75,7 +75,7 @@ The location of temporary files generated by this library is determined by the `
 ...
 {
     // Create a unique temporary file
-    auto tmpfile = tmp::file("org.example.product", std::ios::binary);
+    auto tmpfile = tmp::file(std::ios::binary);
 
     // Write its contents and metadata
     tmpfile << contents << metadata;

include/tmp/file

@@ -37,7 +37,7 @@ namespace tmp {
 ///   #include <tmp/file>
 ///
 ///   auto func(std::string_view content) {
-///     auto tmpfile = tmp::file("org.example.product", std::ios::out);
+///     auto tmpfile = tmp::file(std::ios::bin);
 ///     tmpfile << content << std::flush;
 ///
 ///     // the temporary file is deleted recursively when the
@@ -48,23 +48,17 @@ class TMP_EXPORT file : public entry, public std::iostream {
 public:
   /// Creates a unique temporary file and opens it for reading and writing
   /// @note std::ios::in | std::ios::out are always added to the `mode`
-  /// @param label     A label to attach to the temporary file path
-  /// @param mode      Specifies stream open mode
+  /// @param mode Specifies stream open mode
   /// @throws std::filesystem::filesystem_error if cannot create a file
-  /// @throws std::invalid_argument             if the label is ill-formatted
-  explicit file(std::string_view label = "",
-                std::ios::openmode mode = std::ios::in | std::ios::out);
+  explicit file(std::ios::openmode mode = std::ios::in | std::ios::out);
 
   /// Creates a unique temporary copy from the given path
   /// @note std::ios::in | std::ios::out are always added to the `mode`
-  /// @param path      A path to make a temporary copy from
-  /// @param label     A label to attach to the temporary file path
-  /// @param mode      Specifies stream open mode
+  /// @param path A path to make a temporary copy from
+  /// @param mode Specifies stream open mode
   /// @returns The new temporary file
   /// @throws std::filesystem::filesystem_error if given path is not a file
-  /// @throws std::invalid_argument             if the label is ill-formatted
   static file copy(const std::filesystem::path& path,
-                   std::string_view label = "",
                    std::ios::openmode mode = std::ios::in | std::ios::out);
 
 #if __cpp_lib_fstream_native_handle >= 202306L

src/create.cpp

@@ -129,12 +129,9 @@ void close(filebuf::native_handle_type handle) noexcept {
 }
 }    // namespace
 
-std::pair<fs::path, filebuf> create_file(std::string_view label,
-                                         std::ios::openmode mode) {
-  validate_label(label);    // throws std::invalid_argument with a proper text
-
+std::pair<fs::path, filebuf> create_file(std::ios::openmode mode) {
   std::error_code ec;
-  auto file = create_file(label, mode, ec);
+  std::pair<fs::path, filebuf> file = create_file(mode, ec);
 
   if (ec) {
     throw fs::filesystem_error("Cannot create a temporary file", ec);
@@ -143,18 +140,12 @@ std::pair<fs::path, filebuf> create_file(std::string_view label,
   return file;
 }
 
-std::pair<fs::path, filebuf> create_file(std::string_view label,
-                                         std::ios::openmode mode,
+std::pair<fs::path, filebuf> create_file(std::ios::openmode mode,
                                          std::error_code& ec) {
-  if (!is_label_valid(label)) {
-    ec = std::make_error_code(std::errc::invalid_argument);
-    return {};
-  }
-
 #ifdef _WIN32
-  fs::path::string_type path = make_path(label);
+  fs::path::string_type path = make_path("");
 #else
-  fs::path::string_type path = make_pattern(label);
+  fs::path::string_type path = make_pattern("");
 #endif
   create_parent(path, ec);
   if (ec) {

src/create.hpp

@@ -12,24 +12,19 @@
 namespace tmp {
 namespace fs = std::filesystem;
 
-/// Creates a temporary file with the given label in the system's
-/// temporary directory, and opens it for reading and writing
-/// @param[in] label     A label to attach to the temporary file path
-/// @param[in] mode      Specifies stream open mode
+/// Creates a temporary file in the system's temporary directory,
+/// and opens it for reading and writing
+/// @param[in] mode Specifies stream open mode
 /// @returns A path to the created temporary file and a handle to it
 /// @throws fs::filesystem_error  if cannot create a temporary file
-/// @throws std::invalid_argument if the label is ill-formatted
-std::pair<fs::path, filebuf> create_file(std::string_view label,
-                                         std::ios::openmode mode);
-
-/// Creates a temporary file with the given label in the system's
-/// temporary directory, and opens it for reading and writing
-/// @param[in]  label     A label to attach to the temporary file path
-/// @param[in] mode      Specifies stream open mode
-/// @param[out] ec        Parameter for error reporting
+std::pair<fs::path, filebuf> create_file(std::ios::openmode mode);
+
+/// Creates a temporary file  in the system's temporary directory,
+/// and opens it for reading and writing
+/// @param[in]  mode Specifies stream open mode
+/// @param[out] ec   Parameter for error reporting
 /// @returns A path to the created temporary file and a handle to it
-std::pair<fs::path, filebuf> create_file(std::string_view label,
-                                         std::ios::openmode mode,
+std::pair<fs::path, filebuf> create_file(std::ios::openmode mode,
                                          std::error_code& ec);
 
 /// Creates a temporary directory with the given label in the system's

src/file.cpp

@@ -19,11 +19,11 @@ file::file(std::pair<fs::path, filebuf> handle) noexcept
       std::iostream(std::addressof(sb)),
       sb(std::move(handle.second)) {}
 
-file::file(std::string_view label, openmode mode)
-    : file(create_file(label, mode)) {}
+file::file(std::ios::openmode mode)
+    : file(create_file(mode)) {}
 
-file file::copy(const fs::path& path, std::string_view label, openmode mode) {
-  file tmpfile = file(label, mode);
+file file::copy(const fs::path& path, std::ios::openmode mode) {
+  file tmpfile = file(mode);
 
   std::error_code ec;
   fs::copy_file(path, tmpfile, fs::copy_options::overwrite_existing, ec);

tests/file.cpp

@@ -52,14 +52,14 @@ TEST(file, type_traits) {
   static_assert(std::is_same_v<file::off_type, traits::off_type>);
 }
 
-/// Tests file creation with label
-TEST(file, create_with_label) {
-  file tmpfile = file(LABEL);
+/// Tests file creation
+TEST(file, create) {
+  file tmpfile = file();
   fs::path parent = tmpfile.path().parent_path();
 
   EXPECT_TRUE(fs::exists(tmpfile));
   EXPECT_TRUE(fs::is_regular_file(tmpfile));
-  EXPECT_TRUE(fs::equivalent(parent, fs::temp_directory_path() / LABEL));
+  EXPECT_TRUE(fs::equivalent(parent, fs::temp_directory_path()));
   EXPECT_TRUE(is_open(tmpfile));
 
 #if __cpp_lib_fstream_native_handle >= 202306L
@@ -76,49 +76,23 @@ TEST(file, create_with_label) {
 #endif
 }
 
-/// Tests file creation without label
-TEST(file, create_without_label) {
-  file tmpfile = file();
-  fs::path parent = tmpfile.path().parent_path();
-
-  EXPECT_TRUE(fs::exists(tmpfile));
-  EXPECT_TRUE(fs::is_regular_file(tmpfile));
-  EXPECT_TRUE(fs::equivalent(parent, fs::temp_directory_path()));
-  EXPECT_TRUE(is_open(tmpfile));
-}
-
-/// Tests multiple file creation with the same label
+/// Tests multiple file creation
 TEST(file, create_multiple) {
-  file fst = file(LABEL);
-  file snd = file(LABEL);
+  file fst = file();
+  file snd = file();
 
   EXPECT_FALSE(fs::equivalent(fst, snd));
 }
 
-/// Tests error handling with invalid labels
-TEST(file, create_invalid_label) {
-  EXPECT_THROW(file("multi/segment"), std::invalid_argument);
-  EXPECT_THROW(file("/root"), std::invalid_argument);
-  EXPECT_THROW(file(".."), std::invalid_argument);
-  EXPECT_THROW(file("."), std::invalid_argument);
-
-  fs::path root = fs::temp_directory_path().root_name();
-  if (!root.empty()) {
-    EXPECT_THROW(file(root.string() + "relative"), std::invalid_argument);
-    EXPECT_THROW(file(root.string() + "/root"), std::invalid_argument);
-  }
-}
-
 /// Tests error handling with invalid open mode
 TEST(file, create_invalid_openmode) {
   // C++ standard forbids opening a filebuf with `trunc | app`
-  std::ios::openmode openmode = std::ios::trunc | std::ios::app;
-  EXPECT_THROW(file("", openmode), fs::filesystem_error);
+  EXPECT_THROW(file(std::ios::trunc | std::ios::app), fs::filesystem_error);
 }
 
 /// Tests that file adds std::ios::in and std::ios::out flags
 TEST(file, ios_flags) {
-  file tmpfile = file("", std::ios::binary);
+  file tmpfile = file(std::ios::binary);
   tmpfile << "Hello, world!" << std::flush;
 
   std::ifstream stream = std::ifstream(tmpfile.path());