smoothy 0.10.0

Write smooth assertions in a fluent and human readable way
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

use crate::{implementation, private, Asserter};
use std::{borrow::Borrow, fs::File};

/// Specifies various assertions on file handles. Implemented on [`Asserter`]
///
/// This trait is sealed and cannot be implemented outside Smoothy.
pub trait FileAssertion<FileLike>: private::Sealed
where
    FileLike: Borrow<File>,
{
    /// Asserts that the file handle points to a regular file
    ///
    /// This checks the metadata of the file handle to determine if it represents
    /// a regular file (not a directory or symlink).
    ///
    /// # Examples
    /// ```
    /// # use smoothy::prelude::*;
    /// # use tempfile::NamedTempFile;
    /// # use std::fs::File;
    /// # let temp_file = NamedTempFile::new().unwrap();
    /// # let file = File::open(temp_file.path()).unwrap();
    /// assert_that(file).is_file();
    /// ```
    ///
    /// # Panics
    /// When the file handle does not point to a regular file
    #[track_caller]
    #[allow(clippy::wrong_self_convention)]
    fn is_file(self) -> Asserter<FileLike>;

    /// Asserts that the file handle points to a directory
    ///
    /// This checks the metadata of the file handle to determine if it represents
    /// a directory.
    ///
    /// # Examples
    /// ```
    /// # use smoothy::prelude::*;
    /// # use tempfile::TempDir;
    /// # use std::fs::File;
    /// # let temp_dir = TempDir::new().unwrap();
    /// # let dir = File::open(temp_dir.path()).unwrap();
    /// assert_that(dir).is_directory();
    /// ```
    ///
    /// # Panics
    /// When the file handle does not point to a directory
    #[track_caller]
    #[allow(clippy::wrong_self_convention)]
    fn is_directory(self) -> Asserter<FileLike>;
}

impl<FileLike> FileAssertion<FileLike> for Asserter<FileLike>
where
    FileLike: Borrow<File>,
{
    #[allow(clippy::expect_used)]
    fn is_file(self) -> Self {
        let file: &File = self.value.borrow();
        let metadata = file.metadata().expect("Failed to read file metadata");

        implementation::assert_no_expected(metadata.is_file(), file, "to be a regular file");

        self
    }

    #[allow(clippy::expect_used)]
    fn is_directory(self) -> Self {
        let file: &File = self.value.borrow();
        let metadata = file.metadata().expect("Failed to read file metadata");

        implementation::assert_no_expected(metadata.is_dir(), file, "to be a directory");

        self
    }
}