test coverage added for file.rs; next docs.rs

Author: RPG-Alex

README.md

@@ -13,7 +13,7 @@ It then attaches comments to the SQL structures they describe.
 ## Example 
 
 With a directory structured like this:
-```
+```bash
 sql_dir/
 └── users.sql
 ```
@@ -30,7 +30,7 @@ CREATE TABLE users (
 );
 ```
 A rudimentary implementation can be generated with:
-```rust
+```rust,no_run
 use sql_docs::generate_docs_from_dir_no_deny;
 use std::path::Path;
 

src/docs.rs

@@ -378,4 +378,5 @@ mod tests {
             }
         }
     }
+
 }

src/files.rs

@@ -28,6 +28,7 @@ impl DenyList {
 }
 
 /// A collection of discovered `.sql` files under a given directory.
+#[derive(Debug)]
 pub struct SqlFilesList {
     sql_files: Vec<PathBuf>,
 }
@@ -281,4 +282,28 @@ mod tests {
         assert_eq!(found, expected);
         let _ = fs::remove_dir_all(&base);
     }
+
+    #[test]
+    fn test_file_fails() {
+        let invalid_dir = "INVALID";
+        let failed_list = SqlFilesList::new(invalid_dir, None);
+        assert!(failed_list.is_err());
+
+        let base = env::temp_dir().join("test_files_fails_dir");
+        let _ = fs::remove_dir_all(&base);
+        fs::create_dir_all(&base).unwrap();
+        let bad_file = base.join("one.sql");
+        fs::File::create(&bad_file).unwrap();
+        let failed_read = SqlFilesList::new(&bad_file, None);
+        assert!(failed_read.is_err());
+        let missed_file = base.join("missing.sql");
+        let missing_file = SqlFile::new(&missed_file);
+        assert!(missing_file.is_err());
+        let _ = fs::remove_dir_all(&base);
+
+        let bad_file_list = SqlFileSet::new(Path::new(invalid_dir), None);
+        assert!(bad_file_list.is_err())
+
+    }
 }
+

src/lib.rs

@@ -87,9 +87,9 @@ impl From<ParserError> for DocError {
 ///   sql parsing)
 ///
 /// # Example
-/// ```no_run
+/// ```rust, no_run
 /// use sql_docs::generate_docs_from_dir;
-/// let docs = generate_docs_from_dir("sql_dir", &["skip_this.sql"])?;
+/// let docs = generate_docs_from_dir("sql_dir", &["skip_this.sql"]);
 /// ```
 pub fn generate_docs_from_dir<P: AsRef<Path>, S: AsRef<str>>(
     dir: P,
@@ -126,9 +126,9 @@ pub fn generate_docs_from_dir<P: AsRef<Path>, S: AsRef<str>>(
 ///   sql parsing)
 ///
 /// # Example
-/// ```no_run
-/// use sql_docs::generate_docs_from_dir;
-/// let docs = generate_docs_from_dir_no_deny("sql_dir")?;
+/// ```rust,no_run
+/// use sql_docs::generate_docs_from_dir_no_deny;
+/// let docs = generate_docs_from_dir_no_deny("sql_dir");
 /// ```
 pub fn generate_docs_from_dir_no_deny<P: AsRef<Path>>(
     dir: P,