Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Error on leading zeros when decoding indices #66

Merged
merged 4 commits into from
Aug 6, 2024
Merged

Error on leading zeros when decoding indices #66

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0df82a6
leading zeros error
asmello Aug 5, 2024
172b521
update changelog and bump version
asmello Aug 5, 2024
020ead3
coverage :shrug:
asmello Aug 5, 2024
14d9f17
changelog detail
asmello Aug 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions src/assign.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
//! in the case of arrays, or a scalar value (including `null`) based upon a
//! best-guess effort on the meaning of each [`Token`](crate::Token):
//! - If the [`Token`](crate::Token) is equal to `"0"` or `"-"`, the token will
//! be considered an index of an array.
//! be considered an index of an array.
//! - All tokens not equal to `"0"` or `"-"` will be considered keys of an
//! object.
//!
Expand Down Expand Up @@ -63,7 +63,7 @@ use core::fmt::{self, Debug};
/// effort on the meaning of each [`Token`](crate::Token):
///
/// - If the [`Token`](crate::Token) is equal to `"0"` or `"-"`, the token will
/// be considered an index of an array.
/// be considered an index of an array.
/// - All tokens not equal to `"0"` or `"-"` will be considered keys of an
/// object.
///
Expand Down Expand Up @@ -753,9 +753,17 @@ mod tests {
assign: json!("foo"),
expected: Err(AssignError::FailedToParseIndex {
offset: 0,
source: ParseIndexError {
source: usize::from_str("foo").unwrap_err(),
},
source: ParseIndexError::InvalidInteger(usize::from_str("foo").unwrap_err()),
}),
expected_data: json!([]),
},
Test {
ptr: "/002",
data: json!([]),
assign: json!("foo"),
expected: Err(AssignError::FailedToParseIndex {
offset: 0,
source: ParseIndexError::LeadingZeros,
}),
expected_data: json!([]),
},
Expand Down Expand Up @@ -907,9 +915,7 @@ mod tests {
assign: "foo".into(),
expected: Err(AssignError::FailedToParseIndex {
offset: 0,
source: ParseIndexError {
source: usize::from_str("foo").unwrap_err(),
},
source: ParseIndexError::InvalidInteger(usize::from_str("foo").unwrap_err()),
}),
expected_data: Value::Array(vec![]),
},
Expand Down
51 changes: 35 additions & 16 deletions src/index.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,10 +118,10 @@ impl Index {

/// Resolves the index for a given array length.
///
/// No bound checking will take place. If you wish to ensure the index can
/// be used to access an existing element in the array, use [`Self::for_len`]
/// - or use [`Self::for_len_incl`] if you wish to accept [`Self::Next`] as
/// valid as well.
/// No bound checking will take place. If you wish to ensure the
/// index can be used to access an existing element in the array, use
/// [`Self::for_len`] - or use [`Self::for_len_incl`] if you wish to accept
/// [`Self::Next`] as valid as well.
///
/// # Examples
///
Expand Down Expand Up @@ -163,6 +163,8 @@ impl FromStr for Index {
fn from_str(s: &str) -> Result<Self, Self::Err> {
if s == "-" {
Ok(Index::Next)
} else if s.starts_with('0') && s != "0" {
Err(ParseIndexError::LeadingZeros)
} else {
Ok(s.parse::<usize>().map(Index::Num)?)
}
Expand Down Expand Up @@ -260,27 +262,40 @@ impl std::error::Error for OutOfBoundsError {}

/// Indicates that the `Token` could not be parsed as valid RFC 6901 index.
#[derive(Debug, PartialEq, Eq)]
pub struct ParseIndexError {
/// The source `ParseIntError`
pub source: ParseIntError,
pub enum ParseIndexError {
/// The Token does not represent a valid integer.
InvalidInteger(ParseIntError),
/// The Token contains leading zeros.
LeadingZeros,
chanced marked this conversation as resolved.
Show resolved Hide resolved
}

impl From<ParseIntError> for ParseIndexError {
fn from(source: ParseIntError) -> Self {
Self { source }
Self::InvalidInteger(source)
}
}

impl fmt::Display for ParseIndexError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "failed to parse token as an integer")
match self {
ParseIndexError::InvalidInteger(source) => {
write!(f, "failed to parse token as an integer: {source}")
}
ParseIndexError::LeadingZeros => write!(
f,
"token contained leading zeros, which are disallowed by RFC 6901"
),
}
}
}

#[cfg(feature = "std")]
impl std::error::Error for ParseIndexError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
Some(&self.source)
match self {
ParseIndexError::InvalidInteger(source) => Some(source),
ParseIndexError::LeadingZeros => None,
}
}
}

Expand Down Expand Up @@ -389,18 +404,22 @@ mod tests {

#[test]
fn parse_index_error_display() {
let err = ParseIndexError {
source: "not a number".parse::<usize>().unwrap_err(),
};
assert_eq!(err.to_string(), "failed to parse token as an integer");
let err = ParseIndexError::InvalidInteger("not a number".parse::<usize>().unwrap_err());
assert_eq!(
err.to_string(),
"failed to parse token as an integer: invalid digit found in string"
);
assert_eq!(
ParseIndexError::LeadingZeros.to_string(),
"token contained leading zeros, which are disallowed by RFC 6901"
);
}

#[test]
#[cfg(feature = "std")]
fn parse_index_error_source() {
use std::error::Error;
let source = "not a number".parse::<usize>().unwrap_err();
let err = ParseIndexError { source };
let err = ParseIndexError::InvalidInteger("not a number".parse::<usize>().unwrap_err());
assert_eq!(
err.source().unwrap().to_string(),
"not a number".parse::<usize>().unwrap_err().to_string()
Expand Down
4 changes: 2 additions & 2 deletions src/pointer.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1959,8 +1959,8 @@ mod tests {
let base = PointerBuf::parse(base).expect(&format!("failed to parse ${base}"));
let mut a = base.clone();
let mut b = base.clone();
a.append(&PointerBuf::parse(a_suffix).unwrap());
b.append(&PointerBuf::parse(b_suffix).unwrap());
a.append(PointerBuf::parse(a_suffix).unwrap());
b.append(PointerBuf::parse(b_suffix).unwrap());
let intersection = a.intersection(&b);
assert_eq!(intersection, base);
}
Expand Down
28 changes: 7 additions & 21 deletions src/resolve.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -428,9 +428,7 @@ mod tests {
use std::error::Error;
let err = ResolveError::FailedToParseIndex {
offset: 0,
source: ParseIndexError {
source: "invalid".parse::<usize>().unwrap_err(),
},
source: ParseIndexError::InvalidInteger("invalid".parse::<usize>().unwrap_err()),
};
assert!(err.source().is_some());

Expand All @@ -454,9 +452,7 @@ mod tests {
fn resolve_error_display() {
let err = ResolveError::FailedToParseIndex {
offset: 0,
source: ParseIndexError {
source: "invalid".parse::<usize>().unwrap_err(),
},
source: ParseIndexError::InvalidInteger("invalid".parse::<usize>().unwrap_err()),
};
assert_eq!(format!("{err}"), "failed to parse index at offset 0");

Expand Down Expand Up @@ -484,9 +480,7 @@ mod tests {
fn resolve_error_offset() {
let err = ResolveError::FailedToParseIndex {
offset: 0,
source: ParseIndexError {
source: "invalid".parse::<usize>().unwrap_err(),
},
source: ParseIndexError::InvalidInteger("invalid".parse::<usize>().unwrap_err()),
};
assert_eq!(err.offset(), 0);

Expand All @@ -510,9 +504,7 @@ mod tests {
fn resolve_error_is_unreachable() {
let err = ResolveError::FailedToParseIndex {
offset: 0,
source: ParseIndexError {
source: "invalid".parse::<usize>().unwrap_err(),
},
source: ParseIndexError::InvalidInteger("invalid".parse::<usize>().unwrap_err()),
};
assert!(!err.is_unreachable());

Expand All @@ -536,9 +528,7 @@ mod tests {
fn resolve_error_is_not_found() {
let err = ResolveError::FailedToParseIndex {
offset: 0,
source: ParseIndexError {
source: "invalid".parse::<usize>().unwrap_err(),
},
source: ParseIndexError::InvalidInteger("invalid".parse::<usize>().unwrap_err()),
};
assert!(!err.is_not_found());

Expand All @@ -562,9 +552,7 @@ mod tests {
fn resolve_error_is_out_of_bounds() {
let err = ResolveError::FailedToParseIndex {
offset: 0,
source: ParseIndexError {
source: "invalid".parse::<usize>().unwrap_err(),
},
source: ParseIndexError::InvalidInteger("invalid".parse::<usize>().unwrap_err()),
};
assert!(!err.is_out_of_bounds());

Expand All @@ -588,9 +576,7 @@ mod tests {
fn resolve_error_is_failed_to_parse_index() {
let err = ResolveError::FailedToParseIndex {
offset: 0,
source: ParseIndexError {
source: "invalid".parse::<usize>().unwrap_err(),
},
source: ParseIndexError::InvalidInteger("invalid".parse::<usize>().unwrap_err()),
};
assert!(err.is_failed_to_parse_index());

Expand Down
8 changes: 2 additions & 6 deletions src/token.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,9 +398,7 @@ mod tests {
fn assign_error_display() {
let err = AssignError::FailedToParseIndex {
offset: 3,
source: ParseIndexError {
source: "a".parse::<usize>().unwrap_err(),
},
source: ParseIndexError::InvalidInteger("a".parse::<usize>().unwrap_err()),
};
assert_eq!(
err.to_string(),
Expand All @@ -427,9 +425,7 @@ mod tests {
use std::error::Error;
let err = AssignError::FailedToParseIndex {
offset: 3,
source: ParseIndexError {
source: "a".parse::<usize>().unwrap_err(),
},
source: ParseIndexError::InvalidInteger("a".parse::<usize>().unwrap_err()),
};
assert!(err.source().is_some());
assert!(err.source().unwrap().is::<ParseIndexError>());
Expand Down
Loading