Merge plugin back into main repository (#49)

server/src/plugins/default_plugin.rs

@@ -0,0 +1,67 @@
+use std::collections::HashMap;
+
+use core::Route;
+use plugin::{Plugin, PluginChain, TransformFileResult, RbxChangeResult, FileChangeResult};
+use rbx::{RbxInstance, RbxValue};
+use vfs::VfsItem;
+
+/// A plugin with simple transforms:
+/// * Directories become Folder instances
+/// * Files become StringValue objects with 'Value' as their contents
+pub struct DefaultPlugin;
+
+impl DefaultPlugin {
+    pub fn new() -> DefaultPlugin {
+        DefaultPlugin
+    }
+}
+
+impl Plugin for DefaultPlugin {
+    fn transform_file(&self, plugins: &PluginChain, vfs_item: &VfsItem) -> TransformFileResult {
+        match vfs_item {
+            &VfsItem::File { ref contents, .. } => {
+                let mut properties = HashMap::new();
+
+                properties.insert("Value".to_string(), RbxValue::String {
+                    value: contents.clone(),
+                });
+
+                TransformFileResult::Value(Some(RbxInstance {
+                    name: vfs_item.name().clone(),
+                    class_name: "StringValue".to_string(),
+                    children: Vec::new(),
+                    properties,
+                    route: Some(vfs_item.route().to_vec()),
+                }))
+            },
+            &VfsItem::Dir { ref children, .. } => {
+                let mut rbx_children = Vec::new();
+
+                for (_, child_item) in children {
+                    match plugins.transform_file(child_item) {
+                        Some(rbx_item) => {
+                            rbx_children.push(rbx_item);
+                        },
+                        _ => {},
+                    }
+                }
+
+                TransformFileResult::Value(Some(RbxInstance {
+                    name: vfs_item.name().clone(),
+                    class_name: "*".to_string(),
+                    children: rbx_children,
+                    properties: HashMap::new(),
+                    route: Some(vfs_item.route().to_vec()),
+                }))
+            },
+        }
+    }
+
+    fn handle_file_change(&self, route: &Route) -> FileChangeResult {
+        FileChangeResult::MarkChanged(Some(vec![route.clone()]))
+    }
+
+    fn handle_rbx_change(&self, _route: &Route, _rbx_item: &RbxInstance) -> RbxChangeResult {
+        RbxChangeResult::Pass
+    }
+}

server/src/plugins/json_model_plugin.rs

@@ -0,0 +1,55 @@
+use regex::Regex;
+use serde_json;
+
+use core::Route;
+use plugin::{Plugin, PluginChain, TransformFileResult, RbxChangeResult, FileChangeResult};
+use rbx::RbxInstance;
+use vfs::VfsItem;
+
+lazy_static! {
+    static ref JSON_MODEL_PATTERN: Regex = Regex::new(r"^(.*?)\.model\.json$").unwrap();
+}
+
+pub struct JsonModelPlugin;
+
+impl JsonModelPlugin {
+    pub fn new() -> JsonModelPlugin {
+        JsonModelPlugin
+    }
+}
+
+impl Plugin for JsonModelPlugin {
+    fn transform_file(&self, _plugins: &PluginChain, vfs_item: &VfsItem) -> TransformFileResult {
+        match vfs_item {
+            &VfsItem::File { ref contents, .. } => {
+                let rbx_name = match JSON_MODEL_PATTERN.captures(vfs_item.name()) {
+                    Some(captures) => captures.get(1).unwrap().as_str().to_string(),
+                    None => return TransformFileResult::Pass,
+                };
+
+                let mut rbx_item: RbxInstance = match serde_json::from_str(contents) {
+                    Ok(v) => v,
+                    Err(e) => {
+                        eprintln!("Unable to parse JSON Model File named {}: {}", vfs_item.name(), e);
+
+                        return TransformFileResult::Pass; // This should be an error in the future!
+                    },
+                };
+
+                rbx_item.route = Some(vfs_item.route().to_vec());
+                rbx_item.name = rbx_name;
+
+                TransformFileResult::Value(Some(rbx_item))
+            },
+            &VfsItem::Dir { .. } => TransformFileResult::Pass,
+        }
+    }
+
+    fn handle_file_change(&self, _route: &Route) -> FileChangeResult {
+        FileChangeResult::Pass
+    }
+
+    fn handle_rbx_change(&self, _route: &Route, _rbx_item: &RbxInstance) -> RbxChangeResult {
+        RbxChangeResult::Pass
+    }
+}

server/src/plugins/mod.rs

@@ -0,0 +1,7 @@
+mod default_plugin;
+mod script_plugin;
+mod json_model_plugin;
+
+pub use self::default_plugin::*;
+pub use self::script_plugin::*;
+pub use self::json_model_plugin::*;

server/src/plugins/script_plugin.rs

@@ -0,0 +1,124 @@
+use std::collections::HashMap;
+
+use regex::Regex;
+
+use core::Route;
+use plugin::{Plugin, PluginChain, TransformFileResult, RbxChangeResult, FileChangeResult};
+use rbx::{RbxInstance, RbxValue};
+use vfs::VfsItem;
+
+lazy_static! {
+    static ref SERVER_PATTERN: Regex = Regex::new(r"^(.*?)\.server\.lua$").unwrap();
+    static ref CLIENT_PATTERN: Regex = Regex::new(r"^(.*?)\.client\.lua$").unwrap();
+    static ref MODULE_PATTERN: Regex = Regex::new(r"^(.*?)\.lua$").unwrap();
+}
+
+static SERVER_INIT: &'static str = "init.server.lua";
+static CLIENT_INIT: &'static str = "init.client.lua";
+static MODULE_INIT: &'static str = "init.lua";
+
+pub struct ScriptPlugin;
+
+impl ScriptPlugin {
+    pub fn new() -> ScriptPlugin {
+        ScriptPlugin
+    }
+}
+
+impl Plugin for ScriptPlugin {
+    fn transform_file(&self, plugins: &PluginChain, vfs_item: &VfsItem) -> TransformFileResult {
+        match vfs_item {
+            &VfsItem::File { ref contents, .. } => {
+                let name = vfs_item.name();
+
+                let (class_name, rbx_name) = {
+                    if let Some(captures) = SERVER_PATTERN.captures(name) {
+                        ("Script".to_string(), captures.get(1).unwrap().as_str().to_string())
+                    } else if let Some(captures) = CLIENT_PATTERN.captures(name) {
+                        ("LocalScript".to_string(), captures.get(1).unwrap().as_str().to_string())
+                    } else if let Some(captures) = MODULE_PATTERN.captures(name) {
+                        ("ModuleScript".to_string(), captures.get(1).unwrap().as_str().to_string())
+                    } else {
+                        return TransformFileResult::Pass;
+                    }
+                };
+
+                let mut properties = HashMap::new();
+
+                properties.insert("Source".to_string(), RbxValue::String {
+                    value: contents.clone(),
+                });
+
+                TransformFileResult::Value(Some(RbxInstance {
+                    name: rbx_name,
+                    class_name: class_name,
+                    children: Vec::new(),
+                    properties,
+                    route: Some(vfs_item.route().to_vec()),
+                }))
+            },
+            &VfsItem::Dir { ref children, .. } => {
+                let init_item = {
+                    let maybe_item = children.get(SERVER_INIT)
+                        .or(children.get(CLIENT_INIT))
+                        .or(children.get(MODULE_INIT));
+
+                    match maybe_item {
+                        Some(v) => v,
+                        None => return TransformFileResult::Pass,
+                    }
+                };
+
+                let mut rbx_item = match self.transform_file(plugins, init_item) {
+                    TransformFileResult::Value(Some(item)) => item,
+                    _ => {
+                        eprintln!("Inconsistency detected in ScriptPlugin!");
+                        return TransformFileResult::Pass;
+                    },
+                };
+
+                rbx_item.name.clear();
+                rbx_item.name.push_str(vfs_item.name());
+
+                for (child_name, child_item) in children {
+                    if child_name == init_item.name() {
+                        continue;
+                    }
+
+                    match plugins.transform_file(child_item) {
+                        Some(child_rbx_item) => {
+                            rbx_item.children.push(child_rbx_item);
+                        },
+                        _ => {},
+                    }
+                }
+
+                TransformFileResult::Value(Some(rbx_item))
+            },
+        }
+    }
+
+    fn handle_file_change(&self, route: &Route) -> FileChangeResult {
+        let leaf = match route.last() {
+            Some(v) => v,
+            None => return FileChangeResult::Pass,
+        };
+
+        let is_init = leaf == SERVER_INIT
+            || leaf == CLIENT_INIT
+            || leaf == MODULE_INIT;
+
+        if is_init {
+            let mut changed = route.clone();
+            changed.pop();
+
+            FileChangeResult::MarkChanged(Some(vec![changed]))
+        } else {
+            FileChangeResult::Pass
+        }
+    }
+
+    fn handle_rbx_change(&self, _route: &Route, _rbx_item: &RbxInstance) -> RbxChangeResult {
+        RbxChangeResult::Pass
+    }
+}