Refactored file.rs to separate concerns

Author: RPG-Alex

src/ast.rs

@@ -10,35 +10,35 @@ use sqlparser::{
     parser::{Parser, ParserError},
 };
 
-use crate::files::{SqlFile, SqlFileSet};
+use crate::source::SqlSource;
 
 /// A single SQL file plus all [`Statement`].
 #[derive(Debug)]
 pub struct ParsedSqlFile {
-    file: SqlFile,
+    file: SqlSource,
     statements: Vec<Statement>,
 }
 
 impl ParsedSqlFile {
-    /// Parses a [`SqlFile`] into `sqlparser` [`Statement`] nodes.
+    /// Parses a [`SqlSource`] into `sqlparser` [`Statement`] nodes.
     ///
     /// This is the AST layer used by the `comments` module to attach leading
     /// comment spans to statements/columns.
     ///
     /// # Parameters
-    /// - `file`: the [`SqlFile`] to parse
+    /// - `file`: the [`SqlSource`] to parse
     ///
     /// # Errors
     /// - Returns [`ParserError`] if parsing fails
-    pub fn parse(file: SqlFile) -> Result<Self, ParserError> {
+    pub fn parse(file: SqlSource) -> Result<Self, ParserError> {
         let dialect = GenericDialect {};
         let statements = Parser::parse_sql(&dialect, file.content())?;
         Ok(Self { file, statements })
     }
 
-    /// Getter method for returning the [`SqlFile`]
+    /// Getter method for returning the [`SqlSource`]
     #[must_use]
-    pub const fn file(&self) -> &SqlFile {
+    pub const fn file(&self) -> &SqlSource {
         &self.file
     }
 
@@ -74,14 +74,14 @@ pub struct ParsedSqlFileSet {
 }
 
 impl ParsedSqlFileSet {
-    /// Method that parses all members in a [`SqlFileSet`]
+    /// Method that parses a set of all members in a [`SqlSource`]
     ///
     /// # Parameters
-    /// - `set` the set of [`SqlFileSet`]
+    /// - `set` the set of [`SqlSource`]
     ///
     /// # Errors
     /// - [`ParserError`] is returned for any errors parsing
-    pub fn parse_all(set: SqlFileSet) -> Result<Self, ParserError> {
+    pub fn parse_all(set: Vec<SqlSource>) -> Result<Self, ParserError> {
         let files = set.into_iter().map(ParsedSqlFile::parse).collect::<Result<Vec<_>, _>>()?;
 
         Ok(Self { files })
@@ -99,7 +99,7 @@ mod tests {
     use std::{env, fs};
 
     use super::*;
-    use crate::files::{SqlFile, SqlFileSet};
+    use crate::source::SqlSource;
 
     #[test]
     fn parsed_sql_file_parses_single_statement() -> Result<(), Box<dyn std::error::Error>> {
@@ -109,7 +109,7 @@ mod tests {
         let file_path = base.join("one.sql");
         let sql = "CREATE TABLE users (id INTEGER PRIMARY KEY);";
         fs::write(&file_path, sql)?;
-        let sql_file = SqlFile::new(&file_path)?;
+        let sql_file = SqlSource::from_path(&file_path)?;
         let parsed = ParsedSqlFile::parse(sql_file)?;
         assert_eq!(parsed.path(), Some(file_path.as_path()));
         assert_eq!(parsed.content(), sql);
@@ -131,7 +131,7 @@ mod tests {
         let sql2 = "CREATE TABLE posts (id INTEGER PRIMARY KEY);";
         fs::write(&file1, sql1)?;
         fs::write(&file2, sql2)?;
-        let set = SqlFileSet::new(&base, &[])?;
+        let set = SqlSource::sql_sources(&base, &[])?;
         let parsed_set = ParsedSqlFileSet::parse_all(set)?;
         let existing_files = parsed_set.files();
         assert_eq!(existing_files.len(), 2);

src/comments.rs

@@ -490,7 +490,7 @@ mod tests {
 
     #[test]
     fn parse_comments() -> Result<(), Box<dyn std::error::Error>> {
-        use crate::{ast::ParsedSqlFileSet, comments::Comments, files::SqlFileSet};
+        use crate::{ast::ParsedSqlFileSet, comments::Comments, source::SqlSource};
         let base = env::temp_dir().join("all_sql_files");
         let _ = fs::remove_dir_all(&base);
         fs::create_dir_all(&base)?;
@@ -506,7 +506,7 @@ mod tests {
         let file4 = base.join("without_comments.sql");
         fs::File::create(&file4)?;
         fs::write(&file4, no_comments_sql())?;
-        let set = SqlFileSet::new(&base, &[])?;
+        let set = SqlSource::sql_sources(&base, &[])?;
         let parsed_set = ParsedSqlFileSet::parse_all(set)?;
 
         for file in parsed_set.files() {
@@ -726,14 +726,14 @@ CREATE TABLE posts (
 
     #[test]
     fn single_line_comment_spans_are_correct() -> Result<(), Box<dyn std::error::Error>> {
-        use crate::{ast::ParsedSqlFileSet, files::SqlFileSet};
+        use crate::{ast::ParsedSqlFileSet, source::SqlSource};
         let base = env::temp_dir().join("single_line_spans");
         let _ = fs::remove_dir_all(&base);
         fs::create_dir_all(&base)?;
         let file = base.join("single.sql");
         fs::File::create(&file)?;
         fs::write(&file, single_line_comments_sql())?;
-        let set = SqlFileSet::new(&base, &[])?;
+        let set = SqlSource::sql_sources(&base, &[])?;
         let parsed_set = ParsedSqlFileSet::parse_all(set)?;
         let file = parsed_set
             .files()
@@ -764,14 +764,14 @@ CREATE TABLE posts (
 
     #[test]
     fn multiline_comment_spans_are_correct() -> Result<(), Box<dyn std::error::Error>> {
-        use crate::{ast::ParsedSqlFileSet, files::SqlFileSet};
+        use crate::{ast::ParsedSqlFileSet, source::SqlSource};
         let base = env::temp_dir().join("multi_line_spans");
         let _ = fs::remove_dir_all(&base);
         fs::create_dir_all(&base)?;
         let file = base.join("multi.sql");
         fs::File::create(&file)?;
         fs::write(&file, multiline_comments_sql())?;
-        let set = SqlFileSet::new(&base, &[])?;
+        let set = SqlSource::sql_sources(&base, &[])?;
         let parsed_set = ParsedSqlFileSet::parse_all(set)?;
         let file = parsed_set
             .files()

src/docs.rs

@@ -472,7 +472,7 @@ CREATE TABLE posts (
 
     #[test]
     fn generate_docs_files() -> Result<(), Box<dyn std::error::Error>> {
-        use crate::{ast::ParsedSqlFileSet, comments::Comments, files::SqlFileSet};
+        use crate::{ast::ParsedSqlFileSet, comments::Comments, source::SqlSource};
         let base = env::temp_dir().join("all_sql_files2");
         let _ = fs::remove_dir_all(&base);
         fs::create_dir_all(&base)?;
@@ -488,7 +488,7 @@ CREATE TABLE posts (
         let file4 = base.join("without_comments.sql");
         fs::File::create(&file4)?;
         fs::write(&file4, no_comments_sql())?;
-        let set = SqlFileSet::new(&base, &[])?;
+        let set = SqlSource::sql_sources(&base, &[])?;
         let parsed_set = ParsedSqlFileSet::parse_all(set)?;
         let expected_values = expect_values();