Updated tests for cfg flags. and added CI for flagging

Author: RPG-Alex

.github/workflows/rust.yml

@@ -43,6 +43,21 @@ jobs:
     - name: Run tests (release)
       run: cargo test --release --verbose
 
+  no_std:
+    name: no_std
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Check no_std build
+        run: cargo check --no-default-features
+
+      - name: Test no_std build
+        run: cargo test --no-default-features
+
   fmt:
     name: Rustfmt
     runs-on: ubuntu-latest

README.md

@@ -33,14 +33,61 @@ CREATE TABLE users (
 );
 ```
 A rudimentary implementation can be generated with:
+```rust,no_run
+# #[cfg(not(feature = "std"))]
+# fn main() {}
+# #[cfg(feature = "std")]
+fn main() -> Result<(), sql_docs::error::DocError> {
+    use sql_docs::{GenericDialect, SqlDoc};
+    use std::{env, fs};
+
+    let base = env::temp_dir().join("tmp_sql_docs_example");
+    let _ = fs::remove_dir_all(&base);
+    fs::create_dir_all(&base)?;
+    let example = base.join("example.sql");
+
+    fs::write(
+        &example,
+        r#"-- Table storing user accounts
+-- Contains all user values
+/* Rows generated at registration */
+CREATE TABLE users (
+    /* Primary key for each user */
+    id INTEGER PRIMARY KEY,
+    -- The user's login name
+    username VARCHAR(255) NOT NULL,
+    /* User's email address */
+    email VARCHAR(255) UNIQUE NOT NULL
+);"#,
+    )?;
+
+    let docs = SqlDoc::from_path(&example)
+        .collect_all_leading()
+        .flatten_multiline_with(". ")
+        .build::<GenericDialect>()?;
+
+    let users = docs.table("users", None)?;
+    assert_eq!(users.name(), "users");
+    assert_eq!(
+        users.doc(),
+        Some("Table storing user accounts. Contains all user values. Rows generated at registration")
+    );
+    assert_eq!(users.path(), Some(example.as_path()));
+
+    let _ = fs::remove_dir_all(&base);
+    Ok(())
+}
+```
+
+Or with no `std` and from a `String`:
 ```rust
-#![cfg(not(feature = "std"))]
-use sql_docs::{GenericDialect,SqlDoc,error::DocError};
+# #[cfg(feature = "std")]
+# fn main() {}
+# #[cfg(not(feature = "std"))]
+fn main() -> Result<(), sql_docs::error::DocError> {
+    use sql_docs::{GenericDialect, SqlDoc};
 
-fn main() -> Result<(), DocError> {
-    // Temporary directory and file created for demonstration purposes
-    let example = 
-        r#"-- Table storing user accounts
+    let example = r#"-- Table storing user accounts
 -- Contains all user values
 /* Rows generated at registration */
 CREATE TABLE users (
@@ -52,26 +99,20 @@ CREATE TABLE users (
     email VARCHAR(255) UNIQUE NOT NULL
 );"#;
 
-    // Extract documentation from a single file
-    let docs = SqlDoc::builder_from_str(&example)
-        // Capture all valid comment lines preceding the statements directly
+    let docs = SqlDoc::builder_from_str(example)
         .collect_all_leading()
-        // Replace `\n` with a `str`
         .flatten_multiline_with(". ")
-        // Finally build the `SqlDoc`
         .build::<GenericDialect>()?;
-    // Or extract recursively from a directory
-    // let docs = SqlDoc::from_dir(&base).build()?;
 
-    // Retrieve a specific table
     let users = docs.table("users", None)?;
-
-    // Table name
     assert_eq!(users.name(), "users");
-    // Optional table-level documentation
-    assert_eq!(users.doc(), Some("Table storing user accounts. Contains all user values. Rows generated at registration"));
+    assert_eq!(
+        users.doc(),
+        Some("Table storing user accounts. Contains all user values. Rows generated at registration")
+    );
+
     Ok(())
- }
+}
 ```
 ## Primary Interface (Main API)
 

src/comments.rs

@@ -588,7 +588,7 @@ mod tests {
         let _ = std::fs::remove_dir_all(&base);
         Ok(())
     }
-
+    #[cfg(feature = "std")]
     fn assert_parsed_comments_eq(parsed: &Comments, expected: &[&str]) {
         let comments = parsed.comments();
         assert_eq!(
@@ -603,7 +603,7 @@ mod tests {
             assert_eq!(expected[i], comment.text(), "comment at index {i} did not match");
         }
     }
-
+    #[cfg(feature = "std")]
     fn single_line_comments_sql() -> &'static str {
         "-- Users table stores user account information
 CREATE TABLE users (
@@ -631,7 +631,7 @@ CREATE TABLE posts (
     published_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
 );"
     }
-
+    #[cfg(feature = "std")]
     fn multiline_comments_sql() -> &'static str {
         r"/* Users table stores user account information 
 multiline */
@@ -670,7 +670,7 @@ CREATE TABLE posts (
     published_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
 );"
     }
-
+    #[cfg(feature = "std")]
     fn no_comments_sql() -> &'static str {
         "CREATE TABLE users (
     id INTEGER PRIMARY KEY,
@@ -687,7 +687,7 @@ CREATE TABLE posts (
     published_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
 );"
     }
-
+    #[cfg(feature = "std")]
     fn mixed_comments_sql() -> &'static str {
         "-- interstitial Comment above statements (should be ignored)
 
@@ -719,7 +719,7 @@ CREATE TABLE posts (
 );
 "
     }
-
+    #[cfg(feature = "std")]
     fn expected_single_line_comments() -> &'static [&'static str] {
         &[
             "Users table stores user account information",
@@ -735,7 +735,7 @@ CREATE TABLE posts (
             "When the post was created",
         ]
     }
-
+    #[cfg(feature = "std")]
     fn expected_multiline_comments() -> &'static [&'static str] {
         &[
             "Users table stores user account information\nmultiline",
@@ -751,7 +751,7 @@ CREATE TABLE posts (
             "When the post was created\nmultiline",
         ]
     }
-
+    #[cfg(feature = "std")]
     fn expected_mixed_comments() -> &'static [&'static str] {
         &[
             "interstitial Comment above statements (should be ignored)",

src/docs.rs

@@ -358,10 +358,10 @@ mod tests {
     use alloc::{
         borrow::ToOwned,
         boxed::Box,
-        string::{String, ToString},
+        string::String,
         vec,
-        vec::Vec,
     };
+    #[cfg(feature = "std")]
     use core::fmt;
 
     use sqlparser::{
@@ -391,6 +391,7 @@ mod tests {
         assert_eq!(sql_doc_val_column.name(), "id");
     }
 
+        #[cfg(feature = "std")]
     fn single_line_comments_sql() -> &'static str {
         "-- Users table stores user account information
 CREATE TABLE users (
@@ -419,6 +420,7 @@ CREATE TABLE posts (
 );"
     }
 
+        #[cfg(feature = "std")]
     fn multiline_comments_sql() -> &'static str {
         r"/* Users table stores user account information 
 multiline */
@@ -458,6 +460,7 @@ CREATE TABLE posts (
 );"
     }
 
+    #[cfg(feature = "std")]
     fn no_comments_sql() -> &'static str {
         "CREATE TABLE users (
     id INTEGER PRIMARY KEY,
@@ -474,7 +477,7 @@ CREATE TABLE posts (
     published_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
 );"
     }
-
+    #[cfg(feature = "std")]
     fn mixed_comments_sql() -> &'static str {
         "-- interstitial Comment above statements (should be ignored)
 
@@ -800,18 +803,20 @@ CREATE TABLE posts (
         Ok(())
     }
 
+    #[cfg(feature = "std")]
     struct FailOnNthWrite {
         fail_at: usize,
         writes: usize,
         sink: String,
     }
-
+    #[cfg(feature = "std")]
     impl FailOnNthWrite {
+
         fn new(fail_at: usize) -> Self {
             Self { fail_at, writes: 0, sink: String::new() }
         }
     }
-
+    #[cfg(feature = "std")]
     impl fmt::Write for FailOnNthWrite {
         fn write_str(&mut self, s: &str) -> fmt::Result {
             self.writes += 1;
@@ -823,11 +828,13 @@ CREATE TABLE posts (
         }
     }
 
+    #[cfg(feature = "std")]
     fn run_fail_at<T: fmt::Display>(v: &T, fail_at: usize) -> Result<(), fmt::Error> {
         let mut w = FailOnNthWrite::new(fail_at);
         fmt::write(&mut w, format_args!("{v}"))
     }
 
+    #[cfg(feature = "std")]
     fn count_writes<T: fmt::Display>(v: &T) -> usize {
         let mut w = FailOnNthWrite { fail_at: usize::MAX, writes: 0, sink: String::new() };
         let _ = fmt::write(&mut w, format_args!("{v}"));

src/error.rs

@@ -136,7 +136,9 @@ mod tests {
     #[cfg(not(feature = "std"))]
     use alloc::{string::ToString, vec};
 
-    use crate::{docs::TableDoc, error::DocError};
+    #[cfg(feature = "std")]
+    use crate::TableDoc;
+    use crate::error::DocError;
 
     #[cfg(feature = "std")]
     #[test]

src/sql_doc.rs

@@ -521,16 +521,15 @@ fn generate_docs_from_strs_with_paths<D: Dialect + Default>(
 
 #[cfg(test)]
 mod tests {
-    use alloc::{borrow::ToOwned, boxed::Box, vec, vec::Vec};
+    use alloc::{boxed::Box, vec};
 
     use sqlparser::dialect::{GenericDialect, PostgreSqlDialect};
 
+    #[cfg(feature = "std")]
+    use crate::{LeadingCommentCapture, MultiFlatten, SqlDocBuilder, docs::{ColumnDoc, TableDoc}};
     use crate::{
         SqlDoc,
-        comments::LeadingCommentCapture,
-        docs::{ColumnDoc, TableDoc},
         error::DocError,
-        sql_doc::{MultiFlatten, SqlDocBuilder},
     };
 
     #[cfg(feature = "std")]
@@ -642,6 +641,7 @@ mod tests {
         assert!(matches!(duplicate_tables_err, Err(DocError::DuplicateTablesFound { .. })));
     }
 
+    #[cfg(feature = "std")]
     fn sort_tables(tables: &mut [TableDoc]) {
         tables.sort_by(|a, b| {
             let a_key = (a.schema().unwrap_or(""), a.name());
@@ -759,6 +759,8 @@ mod tests {
     #[test]
     fn test_sql_builder_deny_from_path() {
         use std::{path::PathBuf, vec};
+
+        use crate::{LeadingCommentCapture, MultiFlatten, SqlDocBuilder};
         let actual_builder = SqlDoc::from_path("path").deny("path1").deny("path2");
         let expected_builder = SqlDocBuilder {
             source: crate::sql_doc::SqlFileDocSource::File(PathBuf::from("path")),