remove trait objects

Author: Heliozoa

tmc-langs-framework/src/io/submission_processing.rs

@@ -21,8 +21,8 @@ lazy_static! {
 
 /// Moves some of the contents of source to target based on the given policy.
 /// For example, a file source/foo.java would be moved to target/foo.java.
-pub fn move_files(
-    student_file_policy: Box<dyn StudentFilePolicy>,
+pub fn move_files<P: StudentFilePolicy>(
+    student_file_policy: P,
     source: &Path,
     target: &Path,
 ) -> Result<()> {
@@ -244,9 +244,7 @@ mod test {
         std::fs::create_dir_all(file_path.parent().unwrap()).unwrap();
         let _file = std::fs::File::create(&file_path).unwrap();
         move_files(
-            Box::new(EverythingIsStudentFilePolicy::new(
-                source.path().to_path_buf(),
-            )),
+            EverythingIsStudentFilePolicy::new(source.path().to_path_buf()),
             source.path(),
             target.path(),
         )
@@ -275,12 +273,7 @@ mod test {
         let file_path = source.path().join(mock_file);
         std::fs::create_dir_all(file_path.parent().unwrap()).unwrap();
         let _file = std::fs::File::create(&file_path).unwrap();
-        move_files(
-            Box::new(NothingIsStudentFilePolicy {}),
-            source.path(),
-            target.path(),
-        )
-        .unwrap();
+        move_files(NothingIsStudentFilePolicy {}, source.path(), target.path()).unwrap();
 
         let mut paths = HashSet::new();
         for entry in WalkDir::new(target.path()) {

tmc-langs-framework/src/io/zip.rs

@@ -48,7 +48,7 @@ pub fn zip(policy: Box<dyn StudentFilePolicy>, root_directory: &Path) -> Result<
 }
 
 /// Finds a project directory in the given zip and unzips it.
-pub fn unzip(policy: Box<dyn StudentFilePolicy>, zip: &Path, target: &Path) -> Result<()> {
+pub fn unzip<P: StudentFilePolicy>(policy: P, zip: &Path, target: &Path) -> Result<()> {
     log::debug!("Unzipping {} to {}", zip.display(), target.display());
 
     let file = File::open(zip).map_err(|e| Error::OpenFile(zip.to_path_buf(), e))?;
@@ -246,7 +246,7 @@ mod test {
         init();
 
         assert!(unzip(
-            Box::new(EverythingIsStudentFilePolicy::new(PathBuf::new())),
+            EverythingIsStudentFilePolicy::new(PathBuf::new()),
             Path::new("nonexistent"),
             Path::new(""),
         )
@@ -259,9 +259,7 @@ mod test {
 
         let temp = tempdir().unwrap();
         unzip(
-            Box::new(EverythingIsStudentFilePolicy::new(
-                temp.path().to_path_buf(),
-            )),
+            EverythingIsStudentFilePolicy::new(temp.path().to_path_buf()),
             Path::new("tests/data/zip/module-trivial.zip"),
             temp.path(),
         )
@@ -278,9 +276,7 @@ mod test {
 
         let temp = tempdir().unwrap();
         unzip(
-            Box::new(EverythingIsStudentFilePolicy::new(
-                temp.path().to_path_buf(),
-            )),
+            EverythingIsStudentFilePolicy::new(temp.path().to_path_buf()),
             Path::new("tests/data/zip/course-module-trivial.zip"),
             temp.path(),
         )
@@ -297,9 +293,7 @@ mod test {
 
         let temp = tempdir().unwrap();
         unzip(
-            Box::new(EverythingIsStudentFilePolicy::new(
-                temp.path().to_path_buf(),
-            )),
+            EverythingIsStudentFilePolicy::new(temp.path().to_path_buf()),
             Path::new("tests/data/zip/no-src-entry.zip"),
             temp.path(),
         )

tmc-langs-framework/src/plugin.rs

@@ -26,8 +26,10 @@ use walkdir::WalkDir;
 /// Implementations must be thread-safe and preferably fully stateless. Users of
 /// this interface are free to cache results if needed.
 pub trait LanguagePlugin {
+    type StudentFilePolicy: StudentFilePolicy + 'static;
+
     /// Returns the name of the plug-in.
-    fn get_plugin_name(&self) -> &str;
+    fn get_plugin_name() -> &'static str;
 
     /// Returns a list of all directories inside that contain an exercise in this
     /// language.
@@ -43,7 +45,7 @@ pub trait LanguagePlugin {
                 .filter_entry(|e| e.path().is_dir())
                 .filter_map(|e| e.ok())
             {
-                if self.is_exercise_type_correct(entry.path()) {
+                if Self::is_exercise_type_correct(entry.path()) {
                     debug!("found exercise {}", entry.path().display());
                     exercises.push(entry.into_path());
                 }
@@ -63,8 +65,7 @@ pub trait LanguagePlugin {
 
     /// Runs the tests for the exercise.
     fn run_tests(&self, path: &Path) -> Result<RunResult> {
-        let timeout = self
-            .get_student_file_policy(path)
+        let timeout = Self::get_student_file_policy(path)
             .get_tmc_project_yml()
             .ok()
             .and_then(|t| t.tests_timeout_ms.map(Duration::from_millis));
@@ -82,7 +83,7 @@ pub trait LanguagePlugin {
     /// easily replace the tests.
     fn prepare_submission(
         &self,
-        policy: Box<dyn StudentFilePolicy>,
+        policy: Self::StudentFilePolicy,
         submission_path: &Path,
         dest_path: &Path,
     ) -> Result<()> {
@@ -124,24 +125,24 @@ pub trait LanguagePlugin {
 
     /// Compress a given project so that it can be sent to the TestMyCode server.
     fn compress_project(&self, path: &Path) -> Result<Vec<u8>> {
-        let policy = self.get_student_file_policy(path);
-        Ok(zip::zip(policy, path)?)
+        let policy = Self::get_student_file_policy(path);
+        Ok(zip::zip(Box::new(policy), path)?)
     }
 
-    fn get_student_file_policy(&self, project_path: &Path) -> Box<dyn StudentFilePolicy>;
+    fn get_student_file_policy(project_path: &Path) -> Self::StudentFilePolicy;
 
     /// Extract a given archive file containing a compressed project to a target location.
     ///
     /// This will overwrite any existing files as long as they are not specified as student files
     /// by the language dependent student file policy.
     fn extract_project(&self, compressed_project: &Path, target_location: &Path) -> Result<()> {
-        let policy = self.get_student_file_policy(target_location);
+        let policy = Self::get_student_file_policy(target_location);
         zip::unzip(policy, compressed_project, target_location)?;
         Ok(())
     }
 
     /// Tells if there's a valid exercise in this path.
-    fn is_exercise_type_correct(&self, path: &Path) -> bool;
+    fn is_exercise_type_correct(path: &Path) -> bool;
 
     /// Copy shared stuff to stub or solution used for example for copying tmc-junit-runner.
     #[allow(unused_variables)]
@@ -206,11 +207,13 @@ mod test {
     }
 
     impl LanguagePlugin for MockPlugin {
-        fn get_student_file_policy(&self, _project_path: &Path) -> Box<dyn StudentFilePolicy> {
+        type StudentFilePolicy = MockPolicy;
+
+        fn get_student_file_policy(project_path: &Path) -> Self::StudentFilePolicy {
             unimplemented!()
         }
 
-        fn get_plugin_name(&self) -> &'static str {
+        fn get_plugin_name() -> &'static str {
             unimplemented!()
         }
 
@@ -226,7 +229,7 @@ mod test {
             unimplemented!()
         }
 
-        fn is_exercise_type_correct(&self, path: &Path) -> bool {
+        fn is_exercise_type_correct(path: &Path) -> bool {
             !path.to_str().unwrap().contains("ignored")
         }
 

tmc-langs-java/src/ant.rs

@@ -71,7 +71,9 @@ impl AntPlugin {
 }
 
 impl LanguagePlugin for AntPlugin {
-    fn get_plugin_name(&self) -> &str {
+    type StudentFilePolicy = AntStudentFilePolicy;
+
+    fn get_plugin_name() -> &'static str {
         "apache-ant"
     }
 
@@ -80,7 +82,7 @@ impl LanguagePlugin for AntPlugin {
     }
 
     fn scan_exercise(&self, path: &Path, exercise_name: String) -> Result<ExerciseDesc, Error> {
-        if !self.is_exercise_type_correct(path) {
+        if !Self::is_exercise_type_correct(path) {
             return JavaError::InvalidExercise.into();
         }
 
@@ -96,13 +98,13 @@ impl LanguagePlugin for AntPlugin {
         Ok(self.run_java_tests(project_root_path)?)
     }
 
-    fn is_exercise_type_correct(&self, path: &Path) -> bool {
+    fn is_exercise_type_correct(path: &Path) -> bool {
         path.join(BUILD_FILE_NAME).exists()
             || path.join("test").exists() && path.join("src").exists()
     }
 
-    fn get_student_file_policy(&self, project_path: &Path) -> Box<dyn StudentFilePolicy> {
-        Box::new(AntStudentFilePolicy::new(project_path.to_path_buf()))
+    fn get_student_file_policy(project_path: &Path) -> Self::StudentFilePolicy {
+        AntStudentFilePolicy::new(project_path.to_path_buf())
     }
 
     fn maybe_copy_shared_stuff(&self, dest_path: &Path) -> Result<(), Error> {

tmc-langs-java/src/maven.rs

@@ -73,7 +73,9 @@ impl MavenPlugin {
 }
 
 impl LanguagePlugin for MavenPlugin {
-    fn get_plugin_name(&self) -> &str {
+    type StudentFilePolicy = MavenStudentFilePolicy;
+
+    fn get_plugin_name() -> &'static str {
         "apache-maven"
     }
 
@@ -82,7 +84,7 @@ impl LanguagePlugin for MavenPlugin {
     }
 
     fn scan_exercise(&self, path: &Path, exercise_name: String) -> Result<ExerciseDesc, Error> {
-        if !self.is_exercise_type_correct(path) {
+        if !Self::is_exercise_type_correct(path) {
             return JavaError::InvalidExercise.into();
         }
 
@@ -98,12 +100,12 @@ impl LanguagePlugin for MavenPlugin {
         Ok(self.run_java_tests(project_root_path)?)
     }
 
-    fn is_exercise_type_correct(&self, path: &Path) -> bool {
+    fn is_exercise_type_correct(path: &Path) -> bool {
         path.join("pom.xml").exists()
     }
 
-    fn get_student_file_policy(&self, project_path: &Path) -> Box<dyn StudentFilePolicy> {
-        Box::new(MavenStudentFilePolicy::new(project_path.to_path_buf()))
+    fn get_student_file_policy(project_path: &Path) -> Self::StudentFilePolicy {
+        MavenStudentFilePolicy::new(project_path.to_path_buf())
     }
 
     fn clean(&self, path: &Path) -> Result<(), Error> {

tmc-langs-java/src/plugin.rs

@@ -151,7 +151,7 @@ pub(crate) trait JavaPlugin: LanguagePlugin {
         exercise_name: String,
         compile_result: CompileResult,
     ) -> Result<ExerciseDesc, JavaError> {
-        if !self.is_exercise_type_correct(path) || !compile_result.status_code.success() {
+        if !Self::is_exercise_type_correct(path) || !compile_result.status_code.success() {
             return Err(JavaError::InvalidExercise);
         }
 

tmc-langs-make/src/plugin.rs

@@ -117,12 +117,14 @@ impl MakePlugin {
 }
 
 impl LanguagePlugin for MakePlugin {
-    fn get_plugin_name(&self) -> &str {
+    type StudentFilePolicy = MakeStudentFilePolicy;
+
+    fn get_plugin_name() -> &'static str {
         "make"
     }
 
     fn scan_exercise(&self, path: &Path, exercise_name: String) -> Result<ExerciseDesc, Error> {
-        if !self.is_exercise_type_correct(path) {
+        if !Self::is_exercise_type_correct(path) {
             return MakeError::NoExerciseFound.into();
         }
 
@@ -247,11 +249,11 @@ impl LanguagePlugin for MakePlugin {
         Ok(run_result)
     }
 
-    fn get_student_file_policy(&self, project_path: &Path) -> Box<dyn StudentFilePolicy> {
-        Box::new(MakeStudentFilePolicy::new(project_path.to_path_buf()))
+    fn get_student_file_policy(project_path: &Path) -> Self::StudentFilePolicy {
+        MakeStudentFilePolicy::new(project_path.to_path_buf())
     }
 
-    fn is_exercise_type_correct(&self, path: &Path) -> bool {
+    fn is_exercise_type_correct(path: &Path) -> bool {
         path.join("Makefile").is_file()
     }
 

tmc-langs-notests/src/lib.rs

@@ -18,7 +18,7 @@ impl NoTestsPlugin {
     }
 
     fn get_points(&self, path: &Path) -> Vec<String> {
-        self.get_student_file_policy(path)
+        Self::get_student_file_policy(path)
             .get_tmc_project_yml()
             .ok()
             .and_then(|c| c.no_tests.map(|n| n.points))
@@ -27,7 +27,9 @@ impl NoTestsPlugin {
 }
 
 impl LanguagePlugin for NoTestsPlugin {
-    fn get_plugin_name(&self) -> &str {
+    type StudentFilePolicy = EverythingIsStudentFilePolicy;
+
+    fn get_plugin_name() -> &'static str {
         "No-Tests"
     }
 
@@ -60,14 +62,12 @@ impl LanguagePlugin for NoTestsPlugin {
         })
     }
 
-    fn get_student_file_policy(&self, project_path: &Path) -> Box<dyn StudentFilePolicy> {
-        Box::new(EverythingIsStudentFilePolicy::new(
-            project_path.to_path_buf(),
-        ))
+    fn get_student_file_policy(project_path: &Path) -> Self::StudentFilePolicy {
+        EverythingIsStudentFilePolicy::new(project_path.to_path_buf())
     }
 
-    fn is_exercise_type_correct(&self, path: &Path) -> bool {
-        self.get_student_file_policy(path)
+    fn is_exercise_type_correct(path: &Path) -> bool {
+        Self::get_student_file_policy(path)
             .get_tmc_project_yml()
             .map(|c| c.no_tests.is_some())
             .unwrap_or(false)
@@ -92,7 +92,7 @@ mod test {
 
         let plugin = NoTestsPlugin {};
         let path = Path::new("tests/data/notests");
-        assert!(plugin.is_exercise_type_correct(path));
+        assert!(NoTestsPlugin::is_exercise_type_correct(path));
         let desc = plugin
             .scan_exercise(path, "No Tests Exercise".to_string())
             .unwrap();
@@ -108,7 +108,7 @@ mod test {
 
         let plugin = NoTestsPlugin {};
         let path = Path::new("tests/data/notests-points");
-        assert!(plugin.is_exercise_type_correct(path));
+        assert!(NoTestsPlugin::is_exercise_type_correct(path));
         let desc = plugin
             .scan_exercise(path, "No Tests Exercise".to_string())
             .unwrap();

tmc-langs-python3/src/plugin.rs

@@ -27,12 +27,14 @@ impl Python3Plugin {
 }
 
 impl LanguagePlugin for Python3Plugin {
-    fn get_plugin_name(&self) -> &'static str {
+    type StudentFilePolicy = Python3StudentFilePolicy;
+
+    fn get_plugin_name() -> &'static str {
         "python3"
     }
 
-    fn get_student_file_policy(&self, project_path: &Path) -> Box<dyn StudentFilePolicy> {
-        Box::new(Python3StudentFilePolicy::new(project_path.to_owned()))
+    fn get_student_file_policy(project_path: &Path) -> Self::StudentFilePolicy {
+        Python3StudentFilePolicy::new(project_path.to_owned())
     }
 
     fn scan_exercise(&self, path: &Path, exercise_name: String) -> Result<ExerciseDesc, Error> {
@@ -60,7 +62,7 @@ impl LanguagePlugin for Python3Plugin {
         Ok(parse_test_result(path)?)
     }
 
-    fn is_exercise_type_correct(&self, path: &Path) -> bool {
+    fn is_exercise_type_correct(path: &Path) -> bool {
         let mut setup = path.to_owned();
         setup.push("setup.py");
 
@@ -292,10 +294,10 @@ mod test {
         init();
         let plugin = Python3Plugin::new();
 
-        let correct = plugin.is_exercise_type_correct(Path::new("tests/data"));
+        let correct = Python3Plugin::is_exercise_type_correct(Path::new("tests/data"));
         assert!(correct);
 
-        let correct = plugin.is_exercise_type_correct(Path::new("./"));
+        let correct = Python3Plugin::is_exercise_type_correct(Path::new("./"));
         assert!(!correct);
     }