Update tests

This commit is contained in:
Andras Schmelczer 2024-11-17 16:29:03 +00:00
commit aeb51c03f9
No known key found for this signature in database
GPG key ID: FC8F2C3D3D1A718C
7 changed files with 35 additions and 110 deletions

View file

@ -5,23 +5,25 @@ use std::fmt::Display;
use crate::errors::SyncLibError; use crate::errors::SyncLibError;
/// Represents a change that can be applied to a text document. /// Represents a change that can be applied to a text document.
/// Operation is tied to a ropey::Rope and is mainly expected to be
/// created by OperationSequence.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)] #[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum Operation { pub enum Operation {
Insert { Insert {
index: i64, index: usize,
text: String, text: String,
}, },
Delete { Delete {
index: i64, index: usize,
deleted_character_count: i64, deleted_character_count: usize,
}, },
} }
impl Operation { impl Operation {
pub fn create_insert(index: i64, text: &str) -> Result<Option<Self>, SyncLibError> { /// Creates an insert operation with the given index and text.
Self::validate_index(index)?; /// If the text is empty (meaning that the operation would be a no-op), returns None.
pub fn create_insert(index: usize, text: &str) -> Result<Option<Self>, SyncLibError> {
if text.is_empty() { if text.is_empty() {
return Ok(None); return Ok(None);
} }
@ -32,29 +34,25 @@ impl Operation {
})) }))
} }
pub fn create_delete(index: i64, length: i64) -> Result<Option<Self>, SyncLibError> { /// Creates a delete operation with the given index and number of to-be-deleted characters.
Self::validate_index(index)?; /// If the operation would delete 0 (meaning that the operation would be a no-op), returns None.
pub fn create_delete(
if length < 0 { index: usize,
return Err(SyncLibError::NegativeOperationIndexError(format!( deleted_character_count: usize,
"Length {} is negative", ) -> Result<Option<Self>, SyncLibError> {
length if deleted_character_count == 0 {
)));
}
if length == 0 {
return Ok(None); return Ok(None);
} }
Ok(Some(Operation::Delete { Ok(Some(Operation::Delete {
index, index,
deleted_character_count: length, deleted_character_count,
})) }))
} }
/// Tries to apply the operation to the given text, returning the modified text. /// Tries to apply the operation to the given ropey::Rope text, returning the modified text.
pub fn apply<'a>(&self, rope_text: &'a mut Rope) -> Result<&'a mut Rope, SyncLibError> { pub fn apply<'a>(&self, rope_text: &'a mut Rope) -> Result<&'a mut Rope, SyncLibError> {
let index: usize = self.start_index() as usize; let index: usize = self.start_index();
match self { match self {
Operation::Insert { text, .. } => rope_text.try_insert(index, text).map_err(|err| { Operation::Insert { text, .. } => rope_text.try_insert(index, text).map_err(|err| {
SyncLibError::OperationApplicationError(format!("Failed to insert text: {}", err)) SyncLibError::OperationApplicationError(format!("Failed to insert text: {}", err))
@ -63,7 +61,7 @@ impl Operation {
deleted_character_count, deleted_character_count,
.. ..
} => rope_text } => rope_text
.try_remove(index..index + *deleted_character_count as usize) .try_remove(index..index + { *deleted_character_count })
.map_err(|err| { .map_err(|err| {
SyncLibError::OperationApplicationError(format!( SyncLibError::OperationApplicationError(format!(
"Failed to remove text: {}", "Failed to remove text: {}",
@ -76,30 +74,23 @@ impl Operation {
} }
/// Returns the index of the first character that the operation affects. /// Returns the index of the first character that the operation affects.
pub fn start_index(&self) -> i64 { pub fn start_index(&self) -> usize {
match self { match self {
Operation::Insert { index, .. } => *index, Operation::Insert { index, .. } => *index,
Operation::Delete { index, .. } => *index, Operation::Delete { index, .. } => *index,
} }
} }
/// Returns the index based on which concurrent operations must be ordered.
pub fn comparison_index(&self) -> i64 {
match self {
Operation::Insert { .. } => self.start_index(),
Operation::Delete { .. } => self.end_index(),
}
}
/// Returns the index of the last character that the operation affects. /// Returns the index of the last character that the operation affects.
pub fn end_index(&self) -> i64 { pub fn end_index(&self) -> usize {
// len() must be greater than 0 because operations must be non-empty
self.start_index() + self.len() - 1 self.start_index() + self.len() - 1
} }
/// Returns the number of affected characters. /// Returns the number of affected characters. It is always greater than 0 because empty operations cannot be created.
pub fn len(&self) -> i64 { pub fn len(&self) -> usize {
match self { match self {
Operation::Insert { text, .. } => text.chars().count() as i64, Operation::Insert { text, .. } => text.chars().count(),
Operation::Delete { Operation::Delete {
deleted_character_count, deleted_character_count,
.. ..
@ -107,20 +98,13 @@ impl Operation {
} }
} }
/// Returns true if applying operation wouldn't change the text.
pub fn is_empty(&self) -> bool {
self.len() == 0
}
/// Returns the range of indices of characters that the operation affects, inclusive. /// Returns the range of indices of characters that the operation affects, inclusive.
pub fn range(&self) -> std::ops::RangeInclusive<i64> { pub fn range(&self) -> std::ops::RangeInclusive<usize> {
self.start_index()..=self.end_index() self.start_index()..=self.end_index()
} }
/// Clones the operation while updating the index. /// Clones the operation while updating the index.
pub fn with_index(&self, index: i64) -> Result<Self, SyncLibError> { pub fn with_index(&self, index: usize) -> Result<Self, SyncLibError> {
Self::validate_index(index)?;
Ok(match self { Ok(match self {
Operation::Insert { text, .. } => Operation::Insert { Operation::Insert { text, .. } => Operation::Insert {
index, index,
@ -139,18 +123,14 @@ impl Operation {
/// Clones the operation while shifting the index by the given offset. /// Clones the operation while shifting the index by the given offset.
/// The offset can be negative but the resulting index must be non-negative. /// The offset can be negative but the resulting index must be non-negative.
pub fn with_shifted_index(&self, offset: i64) -> Result<Self, SyncLibError> { pub fn with_shifted_index(&self, offset: i64) -> Result<Self, SyncLibError> {
self.with_index(self.start_index() + offset) let index = self.start_index() as i64 + offset;
}
fn validate_index(index: i64) -> Result<(), SyncLibError> { self.with_index(index.try_into().map_err(|_| {
if index < 0 { SyncLibError::NegativeOperationIndexError(format!(
return Err(SyncLibError::NegativeOperationIndexError(format!( "Index {} is negative but operations must have a non-negative index",
"Index {} is negative",
index index
))); ))
} })?)
Ok(())
} }
} }
@ -180,14 +160,7 @@ mod tests {
use pretty_assertions::assert_eq; use pretty_assertions::assert_eq;
#[test] #[test]
fn test_creation_errors() { fn test_shifting_error() {
insta::assert_debug_snapshot!(Operation::create_insert(-1, "hi"));
insta::assert_debug_snapshot!(Operation::create_delete(0, -1));
insta::assert_debug_snapshot!(Operation::create_delete(-1, -1));
insta::assert_debug_snapshot!(Operation::create_insert(0, "hi")
.unwrap()
.unwrap()
.with_index(-1));
insta::assert_debug_snapshot!(Operation::create_insert(1, "hi") insta::assert_debug_snapshot!(Operation::create_insert(1, "hi")
.unwrap() .unwrap()
.unwrap() .unwrap()

View file

@ -1,10 +0,0 @@
---
source: sync_lib/src/operations/operation.rs
expression: "Operation::create_delete(0, -1)"
snapshot_kind: text
---
Err(
NegativeOperationIndexError(
"Length -1 is negative",
),
)

View file

@ -1,10 +0,0 @@
---
source: sync_lib/src/operations/operation.rs
expression: "Operation::create_delete(-1, -1)"
snapshot_kind: text
---
Err(
NegativeOperationIndexError(
"Index -1 is negative",
),
)

View file

@ -1,10 +0,0 @@
---
source: sync_lib/src/operations/operation.rs
expression: "Operation::create_insert(0, \"hi\").unwrap().unwrap().with_index(-1)"
snapshot_kind: text
---
Err(
NegativeOperationIndexError(
"Index -1 is negative",
),
)

View file

@ -1,10 +0,0 @@
---
source: sync_lib/src/operations/operation.rs
expression: "Operation::create_insert(-1, \"hi\")"
snapshot_kind: text
---
Err(
NegativeOperationIndexError(
"Index -1 is negative",
),
)

View file

@ -5,6 +5,6 @@ snapshot_kind: text
--- ---
Err( Err(
NegativeOperationIndexError( NegativeOperationIndexError(
"Index -1 is negative", "Index -1 is negative but operations must have a non-negative index",
), ),
) )

View file

@ -1,8 +0,0 @@
---
source: sync_lib/src/operations/operation_sequence.rs
expression: operations
snapshot_kind: text
---
OperationSequence {
operations: [],
}