Merge pull request #346 from korpling/feature/sleep

added sleep module

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - `map` allows to delete annotation via query index
 - `enumerate` via its attribute `by` allows to restart counting when the value of a node specified in the query changes.
+- `sleep` lets annatto sleep
 
 ## [0.20.2] - 2024-12-18
 

src/importer/saltxml.rs

@@ -167,7 +167,7 @@ impl From<&str> for SaltObject {
         } else if let Some(value) = value.strip_prefix("U::") {
             SaltObject::Url(value.to_string())
         } else if let Some(value) = value.strip_prefix("B::") {
-            let value = value.to_ascii_lowercase() == "true";
+            let value = value.eq_ignore_ascii_case("true");
             SaltObject::Boolean(value)
         } else if let Some(value) = value.strip_prefix("N::") {
             let value = value.parse::<i64>().unwrap_or_default();

src/lib.rs

@@ -34,7 +34,7 @@ use importer::{
 };
 use manipulator::{
     check::Check, chunker::Chunk, collapse::Collapse, enumerate::EnumerateMatches,
-    filter::FilterNodes, link::LinkNodes, map::MapAnnos, no_op::NoOp, re::Revise,
+    filter::FilterNodes, link::LinkNodes, map::MapAnnos, no_op::NoOp, re::Revise, sleep::Sleep,
     split::SplitValues, time::Filltime, visualize::Visualize, Manipulator,
 };
 use serde_derive::Deserialize;
@@ -324,7 +324,8 @@ pub enum GraphOp {
     Time(#[serde(default)] Filltime),
     Chunk(#[serde(default)] Chunk),
     Split(#[serde(default)] SplitValues), // default does nothing
-    None(#[serde(default)] NoOp),         // has no attributes
+    Sleep(#[serde(default)] Sleep),
+    None(#[serde(default)] NoOp), // has no attributes
 }
 
 impl Default for GraphOp {
@@ -349,6 +350,7 @@ impl GraphOp {
             GraphOp::Split(m) => m,
             GraphOp::Filter(m) => m,
             GraphOp::Time(m) => m,
+            GraphOp::Sleep(m) => m,
         }
     }
 }
@@ -368,6 +370,7 @@ impl GraphOpDiscriminants {
             GraphOpDiscriminants::Split => SplitValues::DOCS,
             GraphOpDiscriminants::Filter => FilterNodes::DOCS,
             GraphOpDiscriminants::Time => Filltime::DOCS,
+            GraphOpDiscriminants::Sleep => Sleep::DOCS,
         }
     }
 
@@ -397,6 +400,7 @@ impl GraphOpDiscriminants {
                 (FilterNodes::FIELD_NAMES_AS_SLICE, FilterNodes::FIELD_DOCS)
             }
             GraphOpDiscriminants::Time => (Filltime::FIELD_NAMES_AS_SLICE, Filltime::FIELD_DOCS),
+            GraphOpDiscriminants::Sleep => (Sleep::FIELD_NAMES_AS_SLICE, Sleep::FIELD_DOCS),
         };
         for (idx, n) in field_names.iter().enumerate() {
             if idx < field_docs.len() {

src/manipulator/mod.rs

@@ -8,6 +8,7 @@ pub mod link;
 pub mod map;
 pub mod no_op;
 pub mod re;
+pub mod sleep;
 pub mod split;
 pub mod time;
 pub mod visualize;

src/manipulator/sleep.rs

@@ -0,0 +1,39 @@
+use documented::{Documented, DocumentedFields};
+use serde::Deserialize;
+use struct_field_names_as_array::FieldNamesAsSlice;
+
+use super::Manipulator;
+
+/// This operation pauses the conversion process. As a regular user, you usually do not need to use this feature.
+#[derive(Deserialize, Documented, DocumentedFields, FieldNamesAsSlice)]
+#[serde(deny_unknown_fields)]
+pub struct Sleep {
+    /// Time to sleep in seconds.
+    #[serde(default)]
+    seconds: u64,
+}
+
+impl Manipulator for Sleep {
+    fn manipulate_corpus(
+        &self,
+        graph: &mut graphannis::AnnotationGraph,
+        _workflow_directory: &std::path::Path,
+        _step_id: crate::StepID,
+        _tx: Option<crate::workflow::StatusSender>,
+    ) -> Result<(), Box<dyn std::error::Error>> {
+        std::thread::sleep(std::time::Duration::from_secs(self.seconds));
+        graph.ensure_loaded_all()?;
+        Ok(())
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn deserialize() {
+        let toml_str = "seconds = 10";
+        let r: Result<super::Sleep, _> = toml::from_str(toml_str);
+        assert!(r.is_ok());
+        assert_eq!(r.unwrap().seconds, 10);
+    }
+}

tests/snapshots/cli__list_modules.snap

@@ -6,6 +6,8 @@ expression: output
 |------------------|-----------------------------------------------------------------------------------------------------------------------------|
 | Import formats   | conllu, exmaralda, graphml, meta, none, opus, path, ptb, relannis, saltxml, table, textgrid, toolbox, treetagger, xlsx, xml |
 | Export formats   | conllu, exmaralda, graphml, meta, saltxml, sequence, table, textgrid, xlsx                                                  |
-| Graph operations | check, collapse, filter, visualize, enumerate, link, map, revise, time, chunk, split, none                                  |
+| Graph operations | check, collapse, filter, visualize, enumerate, link, map, revise, time, chunk, split, sleep, none                           |
 
 Use `annatto info <name>` to get more information about one of the formats or graph operations.
+
+