rojo-rbx/rojo
1
0
Fork 1
mirror of https://github.com/rojo-rbx/rojo.git synced 2026-04-21 05:06:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Flatten snapshot middleware to be much simpler (#324)

Browse Source 
* First take at flattening middleware for simpler code and better perf

* Undo debug prints

* Fix using wrong path in snapshot_from_vfs

* Disable some broken tests

* Re-enable (mistakenly?) disabled CSV test

* Fix some tests

* Update project file tests

* Fix benchmark
This commit is contained in:
Lucien Greathouse
2020-06-17 13:47:09 -07:00
committed by GitHub
parent bdd1afea57
commit 486b067567
18 changed files with 489 additions and 713 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
src/snapshot_middleware/lua.rs
View File

@@ -7,50 +7,12 @@ use rbx_dom_weak::RbxValue;
use crate::snapshot::{InstanceContext, InstanceMetadata, InstanceSnapshot};
use super::{
dir::SnapshotDir,
meta_file::AdjacentMetadata,
middleware::{SnapshotInstanceResult, SnapshotMiddleware},
dir::snapshot_dir, meta_file::AdjacentMetadata, middleware::SnapshotInstanceResult,
util::match_trailing,
};
pub struct SnapshotLua;
impl SnapshotMiddleware for SnapshotLua {
fn from_vfs(context: &InstanceContext, vfs: &Vfs, path: &Path) -> SnapshotInstanceResult {
let file_name = path.file_name().unwrap().to_string_lossy();
// These paths alter their parent instance, so we don't need to turn
// them into a script instance here.
match &*file_name {
"init.lua" | "init.server.lua" | "init.client.lua" => return Ok(None),
_ => {}
}
let meta = vfs.metadata(path)?;
if meta.is_file() {
snapshot_lua_file(context, vfs, path)
} else {
// At this point, our entry is definitely a directory!
if let Some(snapshot) = snapshot_init(context, vfs, path, "init.lua")? {
// An `init.lua` file turns its parent into a ModuleScript
Ok(Some(snapshot))
} else if let Some(snapshot) = snapshot_init(context, vfs, path, "init.server.lua")? {
// An `init.server.lua` file turns its parent into a Script
Ok(Some(snapshot))
} else if let Some(snapshot) = snapshot_init(context, vfs, path, "init.client.lua")? {
// An `init.client.lua` file turns its parent into a LocalScript
Ok(Some(snapshot))
} else {
Ok(None)
}
}
}
}
/// Core routine for turning Lua files into snapshots.
fn snapshot_lua_file(context: &InstanceContext, vfs: &Vfs, path: &Path) -> SnapshotInstanceResult {
pub fn snapshot_lua(context: &InstanceContext, vfs: &Vfs, path: &Path) -> SnapshotInstanceResult {
let file_name = path.file_name().unwrap().to_string_lossy();
let (class_name, instance_name) = if let Some(name) = match_trailing(&file_name, ".server.lua")
@@ -100,35 +62,29 @@ fn snapshot_lua_file(context: &InstanceContext, vfs: &Vfs, path: &Path) -> Snaps
///
/// Scripts named `init.lua`, `init.server.lua`, or `init.client.lua` usurp
/// their parents, which acts similarly to `__init__.py` from the Python world.
fn snapshot_init(
pub fn snapshot_lua_init(
context: &InstanceContext,
vfs: &Vfs,
folder_path: &Path,
init_name: &str,
init_path: &Path,
) -> SnapshotInstanceResult {
let init_path = folder_path.join(init_name);
let folder_path = init_path.parent().unwrap();
let dir_snapshot = snapshot_dir(context, vfs, folder_path)?.unwrap();
if vfs.metadata(&init_path).with_not_found()?.is_some() {
if let Some(dir_snapshot) = SnapshotDir::from_vfs(context, vfs, folder_path)? {
if let Some(mut init_snapshot) = snapshot_lua_file(context, vfs, &init_path)? {
if dir_snapshot.class_name != "Folder" {
panic!(
"init.lua, init.server.lua, and init.client.lua can \
only be used if the instance produced by the parent \
directory would be a Folder."
);
}
init_snapshot.name = dir_snapshot.name;
init_snapshot.children = dir_snapshot.children;
init_snapshot.metadata = dir_snapshot.metadata;
return Ok(Some(init_snapshot));
}
}
if dir_snapshot.class_name != "Folder" {
panic!(
"init.lua, init.server.lua, and init.client.lua can \
only be used if the instance produced by the parent \
directory would be a Folder."
);
}
Ok(None)
let mut init_snapshot = snapshot_lua(context, vfs, init_path)?.unwrap();
init_snapshot.name = dir_snapshot.name;
init_snapshot.children = dir_snapshot.children;
init_snapshot.metadata = dir_snapshot.metadata;
Ok(Some(init_snapshot))
}
#[cfg(test)]
@@ -146,7 +102,7 @@ mod test {
let mut vfs = Vfs::new(imfs);
let instance_snapshot =
SnapshotLua::from_vfs(&InstanceContext::default(), &mut vfs, Path::new("/foo.lua"))
snapshot_lua(&InstanceContext::default(), &mut vfs, Path::new("/foo.lua"))
.unwrap()
.unwrap();
@@ -161,7 +117,7 @@ mod test {
let mut vfs = Vfs::new(imfs);
let instance_snapshot = SnapshotLua::from_vfs(
let instance_snapshot = snapshot_lua(
&InstanceContext::default(),
&mut vfs,
Path::new("/foo.server.lua"),
@@ -180,7 +136,7 @@ mod test {
let mut vfs = Vfs::new(imfs);
let instance_snapshot = SnapshotLua::from_vfs(
let instance_snapshot = snapshot_lua(
&InstanceContext::default(),
&mut vfs,
Path::new("/foo.client.lua"),
@@ -191,6 +147,7 @@ mod test {
insta::assert_yaml_snapshot!(instance_snapshot);
}
#[ignore = "init.lua functionality has moved to the root snapshot function"]
#[test]
fn init_module_from_vfs() {
let mut imfs = InMemoryFs::new();
@@ -205,7 +162,7 @@ mod test {
let mut vfs = Vfs::new(imfs);
let instance_snapshot =
SnapshotLua::from_vfs(&InstanceContext::default(), &mut vfs, Path::new("/root"))
snapshot_lua(&InstanceContext::default(), &mut vfs, Path::new("/root"))
.unwrap()
.unwrap();
@@ -232,7 +189,7 @@ mod test {
let mut vfs = Vfs::new(imfs);
let instance_snapshot =
SnapshotLua::from_vfs(&InstanceContext::default(), &mut vfs, Path::new("/foo.lua"))
snapshot_lua(&InstanceContext::default(), &mut vfs, Path::new("/foo.lua"))
.unwrap()
.unwrap();
@@ -258,7 +215,7 @@ mod test {
let mut vfs = Vfs::new(imfs);
let instance_snapshot = SnapshotLua::from_vfs(
let instance_snapshot = snapshot_lua(
&InstanceContext::default(),
&mut vfs,
Path::new("/foo.server.lua"),
@@ -290,7 +247,7 @@ mod test {
let mut vfs = Vfs::new(imfs);
let instance_snapshot = SnapshotLua::from_vfs(
let instance_snapshot = snapshot_lua(
&InstanceContext::default(),
&mut vfs,
Path::new("/bar.server.lua"),