Rename Luau's TextRequirer to FsRequirer

Author: khvzak

src/lib.rs

@@ -147,7 +147,7 @@ pub use crate::debug::HookTriggers;
 pub use crate::{
     buffer::Buffer,
     chunk::{CompileConstant, Compiler},
-    luau::{HeapDump, NavigateError, Require, TextRequirer},
+    luau::{FsRequirer, HeapDump, NavigateError, Require},
     vector::Vector,
 };
 

src/luau/mod.rs

@@ -10,7 +10,7 @@ use crate::traits::{FromLuaMulti, IntoLua};
 use crate::types::MaybeSend;
 
 pub use heap_dump::HeapDump;
-pub use require::{NavigateError, Require, TextRequirer};
+pub use require::{FsRequirer, NavigateError, Require};
 
 // Since Luau has some missing standard functions, we re-implement them here
 
@@ -86,7 +86,7 @@ impl Lua {
         }
 
         // Enable default `require` implementation
-        let require = self.create_require_function(require::TextRequirer::new())?;
+        let require = self.create_require_function(FsRequirer::new())?;
         self.globals().raw_set("require", require)?;
 
         Ok(())

src/luau/require.rs

@@ -12,8 +12,7 @@ use crate::state::{Lua, callback_error_ext};
 use crate::table::Table;
 use crate::types::MaybeSend;
 
-// TODO: Rename to FsRequirer
-pub use fs::TextRequirer;
+pub use fs::FsRequirer;
 
 /// An error that can occur during navigation in the Luau `require-by-string` system.
 #[derive(Debug, Clone)]

src/luau/require/fs.rs

@@ -12,7 +12,7 @@ use super::{NavigateError, Require};
 
 /// The standard implementation of Luau `require-by-string` navigation.
 #[derive(Default, Debug)]
-pub struct TextRequirer {
+pub struct FsRequirer {
     /// An absolute path to the current Luau module (not mapped to a physical file)
     abs_path: PathBuf,
     /// A relative path to the current Luau module (not mapped to a physical file)
@@ -22,7 +22,7 @@ pub struct TextRequirer {
     resolved_path: Option<PathBuf>,
 }
 
-impl TextRequirer {
+impl FsRequirer {
     /// The prefix used for chunk names in the require system.
     /// Only chunk names starting with this prefix are allowed to be used in `require`.
     const CHUNK_PREFIX: &str = "@";
@@ -36,7 +36,7 @@ impl TextRequirer {
     /// The filename for the Luau configuration file.
     const LUAU_CONFIG_FILENAME: &str = ".config.luau";
 
-    /// Creates a new `TextRequirer` instance.
+    /// Creates a new `FsRequirer` instance.
     pub fn new() -> Self {
         Self::default()
     }
@@ -114,7 +114,7 @@ impl TextRequirer {
     }
 }
 
-impl Require for TextRequirer {
+impl Require for FsRequirer {
     fn is_require_allowed(&self, chunk_name: &str) -> bool {
         chunk_name.starts_with(Self::CHUNK_PREFIX)
     }
@@ -231,7 +231,7 @@ impl Require for TextRequirer {
 mod tests {
     use std::path::Path;
 
-    use super::TextRequirer;
+    use super::FsRequirer;
 
     #[test]
     fn test_path_normalize() {
@@ -267,7 +267,7 @@ mod tests {
             // '..' disappears if path is absolute and component is non-erasable
             ("/../", "/"),
         ] {
-            let path = TextRequirer::normalize_path(input.as_ref());
+            let path = FsRequirer::normalize_path(input.as_ref());
             assert_eq!(
                 &path,
                 expected.as_ref() as &Path,

src/prelude.rs

@@ -25,8 +25,8 @@ pub use crate::HookTriggers as LuaHookTriggers;
 #[cfg(feature = "luau")]
 #[doc(no_inline)]
 pub use crate::{
-    CompileConstant as LuaCompileConstant, Compiler as LuaCompiler, NavigateError as LuaNavigateError,
-    Require as LuaRequire, TextRequirer as LuaTextRequirer, Vector as LuaVector,
+    CompileConstant as LuaCompileConstant, Compiler as LuaCompiler, FsRequirer as LuaFsRequirer,
+    NavigateError as LuaNavigateError, Require as LuaRequire, Vector as LuaVector,
 };
 
 #[cfg(feature = "async")]

tests/luau/require.rs

@@ -1,7 +1,7 @@
 use std::io::Result as IoResult;
 use std::result::Result as StdResult;
 
-use mlua::{Error, FromLua, IntoLua, Lua, MultiValue, NavigateError, Require, Result, TextRequirer, Value};
+use mlua::{Error, FromLua, FsRequirer, IntoLua, Lua, MultiValue, NavigateError, Require, Result, Value};
 
 fn run_require(lua: &Lua, path: impl IntoLua) -> Result<Value> {
     lua.load(r#"return require(...)"#).call(path)
@@ -65,7 +65,7 @@ fn test_require_errors() {
     assert!((res.unwrap_err().to_string()).contains("@ is not a valid alias"));
 
     // Test throwing mlua::Error
-    struct MyRequire(TextRequirer);
+    struct MyRequire(FsRequirer);
 
     impl Require for MyRequire {
         fn is_require_allowed(&self, chunk_name: &str) -> bool {
@@ -109,9 +109,7 @@ fn test_require_errors() {
         }
     }
 
-    let require = lua
-        .create_require_function(MyRequire(TextRequirer::new()))
-        .unwrap();
+    let require = lua.create_require_function(MyRequire(FsRequirer::new())).unwrap();
     lua.globals().set("require", require).unwrap();
     let res = lua.load(r#"return require('./a/relative/path')"#).exec();
     assert!((res.unwrap_err().to_string()).contains("test error"));