refactor: rename SassImporter, SassLogger to BoxedImporter, BoxedLogger, etc. (#14)

Author: ahabhgk

.github/workflows/publish.yml

@@ -18,9 +18,8 @@ jobs:
           node-version: 16
       - name: setup sass-embedded
         run: |
-          cd scripts
           npm install
-          node setup.mjs
+          npm run setup
       - uses: actions-rs/toolchain@v1
         with:
           toolchain: 'stable'

Cargo.toml

@@ -1,11 +1,12 @@
 [package]
 name = "sass-embedded"
-version = "0.3.0"
+version = "0.4.0"
 authors = ["ahabhgk <[email protected]>"]
 edition = "2021"
 resolver = "2"
 license = "MIT"
 description = "A Rust library that will communicate with Embedded Dart Sass using the Embedded Sass protocol"
+keywords = ["sass", "dart-sass", "sass-embedded", "scss"]
 repository = "https://github.com/ahabhgk/sass-embedded-host-rust"
 documentation = "https://docs.rs/sass-embedded-host-rust"
 readme = "README.md"
@@ -40,3 +41,6 @@ prost-build = "0.11"
 [[bench]]
 name = "bootstrap"
 harness = false
+
+[package.metadata.docs.rs]
+all-features = true

README.md

@@ -10,33 +10,10 @@ let res = sass.compile_string("a {b: c}", StringOptions::default()).unwrap();
 println!("{:?}", res);
 ```
 
-For more details, checkout the [docs.rs](https://docs.rs/sass-embedded)
-
-## Benchmark
-
-[Compile bootstrap with `sass-embedded-host-rust`, `sass-embedded-host-node`, and `dart-sass`](https://github.com/ahabhgk/sass-embedded-host-rust/tree/main/benches/bootstrap)
-
-```bash
-$ cargo bench bootstrap
-Benchmarking bootstrap/Host Rust: Warming up for 3.0000 s
-Warning: Unable to complete 10 samples in 5.0s. You may wish to increase target time to 5.6s.
-bootstrap/Host Rust     time:   [502.81 ms 507.54 ms 512.59 ms]                              
-                        change: [-14.057% -9.4932% -5.7950%] (p = 0.00 < 0.05)
-                        Performance has improved.
-Benchmarking bootstrap/Host Node: Warming up for 3.0000 s
-Warning: Unable to complete 10 samples in 5.0s. You may wish to increase target time to 14.7s.
-bootstrap/Host Node     time:   [1.1295 s 1.2127 s 1.3098 s]                                 
-                        change: [+1.1844% +9.3527% +18.371%] (p = 0.05 > 0.05)
-                        No change in performance detected.
-Benchmarking bootstrap/Dart Sass: Warming up for 3.0000 s
-Warning: Unable to complete 10 samples in 5.0s. You may wish to increase target time to 24.8s.
-bootstrap/Dart Sass     time:   [2.4472 s 2.4728 s 2.4986 s]                                 
-                        change: [-1.1681% +1.3988% +3.8141%] (p = 0.31 > 0.05)
-                        No change in performance detected.
-```
+For more details, checkout [docs.rs](https://docs.rs/sass-embedded) and [examples](https://github.com/ahabhgk/sass-embedded-host-rust/tree/main/examples).
 
 ## Contributing
 
 1. Install the [Protocol Buffer Compiler](https://grpc.io/docs/protoc-installation/).
-2. Run `cd scripts && npm install && node setup.mjs`.
+2. Run `npm install && npm run setup`.
 3. Find issues and welcome PRs.

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "sass-embedded-host-rust-scripts",
+  "name": "sass-embedded-host-rust",
   "version": "0.0.0",
   "scripts": {
     "setup": "node ./scripts/setup.mjs"

src/api.rs

@@ -34,7 +34,7 @@ pub struct Options {
   pub load_paths: Vec<PathBuf>,
   /// More information:
   ///  - [Sass documentation](https://sass-lang.com/documentation/js-api/interfaces/Options#logger)
-  pub logger: Option<SassLogger>,
+  pub logger: Option<BoxedLogger>,
   /// More information:
   ///  - [Sass documentation](https://sass-lang.com/documentation/js-api/interfaces/Options#quietDeps)
   pub quiet_deps: bool,
@@ -103,9 +103,9 @@ impl OptionsBuilder {
   }
 
   /// Sets the [Options]'s [load_paths] field.
-  pub fn load_paths(mut self, arg: &[impl AsRef<Path>]) -> Self {
+  pub fn load_paths<P: AsRef<Path>>(mut self, arg: impl AsRef<[P]>) -> Self {
     self.options.load_paths =
-      arg.iter().map(|p| p.as_ref().to_owned()).collect();
+      arg.as_ref().iter().map(|p| p.as_ref().to_owned()).collect();
     self
   }
 
@@ -282,9 +282,9 @@ impl StringOptionsBuilder {
   }
 
   /// Sets the [StringOptions]'s [load_paths] field.
-  pub fn load_paths(mut self, arg: &[impl AsRef<Path>]) -> Self {
+  pub fn load_paths<P: AsRef<Path>>(mut self, arg: impl AsRef<[P]>) -> Self {
     self.options.load_paths =
-      arg.iter().map(|p| p.as_ref().to_owned()).collect();
+      arg.as_ref().iter().map(|p| p.as_ref().to_owned()).collect();
     self
   }
 
@@ -371,7 +371,7 @@ impl StringOptionsBuilder {
 }
 
 /// A type alias for [Box<dyn Logger>].
-pub type SassLogger = Box<dyn Logger>;
+pub type BoxedLogger = Box<dyn Logger>;
 
 /// More information
 ///  - [Sass documentation](https://sass-lang.com/documentation/js-api/interfaces/Logger)
@@ -413,15 +413,21 @@ pub struct LoggerDebugOptions {
   pub(crate) formatted: String,
 }
 
-/// Enum wrapper for [Box<dyn Importer>] and [Box<dyn FileImporter>].
+/// Enum wrapper for [BoxedImporter] and [BoxedFileImporter].
 #[derive(Debug)]
 pub enum SassImporter {
-  /// A [Box<dyn Importer>].
-  Importer(Box<dyn Importer>),
-  /// A [Box<dyn FileImporter>].
-  FileImporter(Box<dyn FileImporter>),
+  /// A [BoxedImporter].
+  Importer(BoxedImporter),
+  /// A [BoxedFileImporter].
+  FileImporter(BoxedFileImporter),
 }
 
+/// A type alias for [Box<dyn Importer>].
+pub type BoxedImporter = Box<dyn Importer>;
+
+/// A type alias for [Box<dyn FileImporter>].
+pub type BoxedFileImporter = Box<dyn FileImporter>;
+
 /// More information
 ///  - [Sass documentation](https://sass-lang.com/documentation/js-api/interfaces/Importer)
 pub trait Importer: Debug + Send + Sync {

src/host/logger_registry.rs

@@ -1,15 +1,15 @@
 use crate::{
   protocol::{outbound_message::LogEvent, LogEventType},
-  LoggerDebugOptions, LoggerWarnOptions, SassLogger,
+  BoxedLogger, LoggerDebugOptions, LoggerWarnOptions,
 };
 
 #[derive(Debug, Default)]
 pub struct LoggerRegistry {
-  logger: Option<SassLogger>,
+  logger: Option<BoxedLogger>,
 }
 
 impl LoggerRegistry {
-  pub fn register(&mut self, logger: SassLogger) {
+  pub fn register(&mut self, logger: BoxedLogger) {
     self.logger = Some(logger);
   }
 

src/legacy/api.rs

@@ -10,10 +10,10 @@ use crate::{
   legacy::url_to_file_path_cross_platform, CompileResult, Options,
   StringOptions, Syntax, Url,
 };
-pub use crate::{Logger, OutputStyle, SassLogger};
+pub use crate::{BoxedLogger, Logger, OutputStyle};
 
 use super::{
-  LegacyImporter, SassLegacyImporter, END_OF_LOAD_PROTOCOL,
+  BoxedLegacyImporter, LegacyImporter, END_OF_LOAD_PROTOCOL,
   LEGACY_IMPORTER_PROTOCOL,
 };
 
@@ -268,14 +268,14 @@ impl LegacyOptionsBuilder {
   /// Sets the [LegacyOptions]'s [sass_importers] field with [SassLegacyImporter]s.
   pub fn sass_importers(
     mut self,
-    arg: impl IntoIterator<Item = impl Into<SassLegacyImporter>>,
+    arg: impl IntoIterator<Item = impl Into<BoxedLegacyImporter>>,
   ) -> Self {
     self.options.importers = Some(arg.into_iter().map(|i| i.into()).collect());
     self
   }
 
   /// Adds a [SassLegacyImporter] to the [LegacyOptions]'s [sass_importers] field.
-  pub fn sass_importer(mut self, arg: impl Into<SassLegacyImporter>) -> Self {
+  pub fn sass_importer(mut self, arg: impl Into<BoxedLegacyImporter>) -> Self {
     self.options.importers =
       Some(if let Some(mut importers) = self.options.importers {
         importers.push(arg.into());
@@ -369,7 +369,7 @@ pub struct LegacyOptions {
   pub source_map_contents: bool,
   /// More information:
   ///  - [Sass documentation](https://sass-lang.com/documentation/js-api/interfaces/LegacySharedOptions#importer)
-  pub importers: Option<Vec<SassLegacyImporter>>,
+  pub importers: Option<Vec<BoxedLegacyImporter>>,
   /// More information:
   ///  - [Sass documentation](https://sass-lang.com/documentation/js-api/interfaces/LegacySharedOptions#charset)
   pub charset: bool,
@@ -381,7 +381,7 @@ pub struct LegacyOptions {
   pub verbose: bool,
   /// More information:
   ///  - [Sass documentation](https://sass-lang.com/documentation/js-api/interfaces/LegacySharedOptions#logger)
-  pub logger: Option<SassLogger>,
+  pub logger: Option<BoxedLogger>,
   /// More information:
   ///  - [Sass documentation](https://sass-lang.com/documentation/js-api/interfaces/LegacyFileOptions#file)
   pub file: Option<PathBuf>,

src/legacy/importer.rs

@@ -34,9 +34,9 @@ pub trait LegacyImporter: Debug + Sync + Send {
 }
 
 /// A type alias for [Box<dyn LegacyImporter>].
-pub type SassLegacyImporter = Box<dyn LegacyImporter>;
+pub type BoxedLegacyImporter = Box<dyn LegacyImporter>;
 
-impl<I: 'static + LegacyImporter> From<I> for SassLegacyImporter {
+impl<I: 'static + LegacyImporter> From<I> for BoxedLegacyImporter {
   fn from(importer: I) -> Self {
     Box::new(importer)
   }
@@ -47,15 +47,15 @@ pub(crate) struct LegacyImporterWrapper {
   prev_stack: Mutex<Vec<PreviousUrl>>,
   last_contents: Mutex<Option<String>>,
   expecting_relative_load: Mutex<bool>,
-  callbacks: Vec<SassLegacyImporter>,
+  callbacks: Vec<BoxedLegacyImporter>,
   this: LegacyPluginThis,
   load_paths: Vec<PathBuf>,
 }
 
 impl LegacyImporterWrapper {
   pub fn new(
     this: LegacyPluginThis,
-    callbacks: Vec<SassLegacyImporter>,
+    callbacks: Vec<BoxedLegacyImporter>,
     load_paths: Vec<PathBuf>,
     initial_prev: &str,
   ) -> Arc<Self> {

src/lib.rs

@@ -31,9 +31,10 @@ mod varint;
 pub mod legacy;
 
 pub use api::{
-  CompileResult, FileImporter, Importer, ImporterOptions, ImporterResult,
-  Logger, LoggerDebugOptions, LoggerWarnOptions, Options, OptionsBuilder,
-  SassImporter, SassLogger, StringOptions, StringOptionsBuilder,
+  BoxedFileImporter, BoxedImporter, BoxedLogger, CompileResult, FileImporter,
+  Importer, ImporterOptions, ImporterResult, Logger, LoggerDebugOptions,
+  LoggerWarnOptions, Options, OptionsBuilder, SassImporter, StringOptions,
+  StringOptionsBuilder,
 };
 pub use embedded::{Embedded, Embedded as Sass};
 pub use error::{Exception, Result};