Fix Lua snapshot code to work with children.

It's also way easier to read now
This commit is contained in:
Lucien Greathouse
2019-08-29 17:13:36 -07:00
parent 0f530b7e80
commit 2fb2342fd4
5 changed files with 111 additions and 56 deletions

View File

@@ -0,0 +1 @@
-- init.lua

View File

@@ -0,0 +1 @@
-- other.lua

View File

@@ -24,6 +24,7 @@ gen_build_tests! {
csv_in_folder, csv_in_folder,
deep_nesting, deep_nesting,
gitkeep, gitkeep,
init_with_children,
json_model_in_folder, json_model_in_folder,
json_model_legacy_name, json_model_legacy_name,
module_in_folder, module_in_folder,

View File

@@ -0,0 +1,20 @@
---
created: "2019-08-30T00:12:56.686707700Z"
creator: insta@0.10.1
source: rojo-test/src/build_test.rs
expression: contents
---
<roblox version="4">
<Item class="ModuleScript" referent="0">
<Properties>
<string name="Name">init_with_children</string>
<string name="Source">-- init.lua</string>
</Properties>
<Item class="ModuleScript" referent="1">
<Properties>
<string name="Name">other</string>
<string name="Source">-- other.lua</string>
</Properties>
</Item>
</Item>
</roblox>

View File

@@ -8,7 +8,10 @@ use crate::{
snapshot::InstanceSnapshot, snapshot::InstanceSnapshot,
}; };
use super::middleware::{SnapshotFileResult, SnapshotInstanceResult, SnapshotMiddleware}; use super::{
dir::SnapshotDir,
middleware::{SnapshotFileResult, SnapshotInstanceResult, SnapshotMiddleware},
};
pub struct SnapshotLua; pub struct SnapshotLua;
@@ -19,37 +22,52 @@ impl SnapshotMiddleware for SnapshotLua {
) -> SnapshotInstanceResult<'static> { ) -> SnapshotInstanceResult<'static> {
let file_name = entry.path().file_name().unwrap().to_string_lossy(); let file_name = entry.path().file_name().unwrap().to_string_lossy();
if entry.is_directory() { // These paths alter their parent instance, so we don't need to turn
let module_init_path = entry.path().join("init.lua"); // them into a script instance here.
if let Some(init_entry) = imfs.get(module_init_path).with_not_found()? { match &*file_name {
if let Some(mut snapshot) = SnapshotLua::from_imfs(imfs, &init_entry)? { "init.lua" | "init.server.lua" | "init.client.lua" => return Ok(None),
snapshot.name = Cow::Owned(file_name.into_owned()); _ => {}
return Ok(Some(snapshot));
}
} }
let server_init_path = entry.path().join("init.server.lua"); if entry.is_file() {
if let Some(init_entry) = imfs.get(server_init_path).with_not_found()? { snapshot_lua_file(imfs, entry)
if let Some(mut snapshot) = SnapshotLua::from_imfs(imfs, &init_entry)? { } else {
snapshot.name = Cow::Owned(file_name.into_owned()); if let Some(snapshot) = snapshot_init(imfs, entry, "init.lua")? {
// An `init.lua` file turns its parent into a ModuleScript
return Ok(Some(snapshot)); Ok(Some(snapshot))
} } else if let Some(snapshot) = snapshot_init(imfs, entry, "init.server.lua")? {
} // An `init.server.lua` file turns its parent into a Script
Ok(Some(snapshot))
let client_init_path = entry.path().join("init.client.lua"); } else if let Some(snapshot) = snapshot_init(imfs, entry, "init.client.lua")? {
if let Some(init_entry) = imfs.get(client_init_path).with_not_found()? { // An `init.client.lua` file turns its parent into a LocalScript
if let Some(mut snapshot) = SnapshotLua::from_imfs(imfs, &init_entry)? { Ok(Some(snapshot))
snapshot.name = Cow::Owned(file_name.into_owned()); } else {
Ok(None)
return Ok(Some(snapshot));
} }
} }
} }
let (class_name, instance_name) = fn from_instance(tree: &RbxTree, id: RbxId) -> SnapshotFileResult {
if let Some(name) = match_trailing(&file_name, ".server.lua") { let instance = tree.get_instance(id).unwrap();
match instance.class_name.as_str() {
"ModuleScript" | "LocalScript" | "Script" => {
unimplemented!("Snapshotting Script instances")
}
_ => None,
}
}
}
/// Core routine for turning Lua files into snapshots.
fn snapshot_lua_file<F: ImfsFetcher>(
imfs: &mut Imfs<F>,
entry: &ImfsEntry,
) -> SnapshotInstanceResult<'static> {
let file_name = entry.path().file_name().unwrap().to_string_lossy();
let (class_name, instance_name) = if let Some(name) = match_trailing(&file_name, ".server.lua")
{
("Script", name) ("Script", name)
} else if let Some(name) = match_trailing(&file_name, ".client.lua") { } else if let Some(name) = match_trailing(&file_name, ".client.lua") {
("LocalScript", name) ("LocalScript", name)
@@ -79,18 +97,32 @@ impl SnapshotMiddleware for SnapshotLua {
})) }))
} }
fn from_instance(tree: &RbxTree, id: RbxId) -> SnapshotFileResult { /// Attempts to snapshot an 'init' Lua script contained inside of a folder with
let instance = tree.get_instance(id).unwrap(); /// the given name.
///
/// 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<F: ImfsFetcher>(
imfs: &mut Imfs<F>,
folder_entry: &ImfsEntry,
init_name: &str,
) -> SnapshotInstanceResult<'static> {
let init_path = folder_entry.path().join(init_name);
match instance.class_name.as_str() { if let Some(init_entry) = imfs.get(init_path).with_not_found()? {
"ModuleScript" | "LocalScript" | "Script" => { if let Some(mut dir_snapshot) = SnapshotDir::from_imfs(imfs, folder_entry)? {
unimplemented!("Snapshotting Script instances") if let Some(mut init_snapshot) = snapshot_lua_file(imfs, &init_entry)? {
} init_snapshot.name = dir_snapshot.name;
_ => None, init_snapshot.children = dir_snapshot.children;
return Ok(Some(init_snapshot));
} }
} }
} }
Ok(None)
}
fn match_trailing<'a>(input: &'a str, trailer: &str) -> Option<&'a str> { fn match_trailing<'a>(input: &'a str, trailer: &str) -> Option<&'a str> {
if input.ends_with(trailer) { if input.ends_with(trailer) {
let end = input.len().saturating_sub(trailer.len()); let end = input.len().saturating_sub(trailer.len());