Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ license = "MIT"
description = "macros for querying semi-structured data with the JavaScript-like syntax"
readme = "README.md"
repository = "https://github.com/jiftechnify/valq"
categories = ["rust-patterns"]
keywords = ["macro", "query", "extract", "json", "serde"]

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
Expand Down
2 changes: 2 additions & 0 deletions src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,5 @@ impl std::error::Error for Error {
}
}
}

pub type Result<T> = std::result::Result<T, Error>;
4 changes: 3 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@
//! [`query_value_result!`]: crate::query_value_result

mod error;
pub use error::Error;
pub use error::{Error, Result};

mod util;

#[doc(hidden)]
pub use paste::paste as __paste;
Expand Down
87 changes: 87 additions & 0 deletions src/util.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
/// Transposes an arbitrary length of tuple of `Option`s/`Result`s into an `Option`/`Result` of a tuple.
///
/// Syntax:
///
/// - `Option`-variant: `transpose_tuple!(Option; e1, e2, ..., eN)` ... transposes a tuple of `Option`s.
/// - You can omit `Option;` part, like: `transpose_tuple!(e1, e2, ..., eN)`.
/// - `Result`-variant: `transpose_tuple!(Result; e1, e2, ..., eN)`... transposes a tuple of [`valq::Result`]s.
///
/// Note: `Result`-variant is meant to be used with [`valq::Result`] (return type of `query_value_result!` macro).
/// It doesn't support other error types for now.
///
/// [`valq::Result`]: crate::Result
///
/// ## Examples
///
/// ```
/// // Options
/// use serde_json::json;
/// use valq::{query_value, transpose_tuple};
///
/// let valq = json!({
/// "name": "valq",
/// "keywords": ["macro", "query", "serde"],
/// "author": {
/// "name": "jiftechnify",
/// "age": 31
/// }
/// });
///
/// let picks = transpose_tuple!(
/// query_value!(valq.name -> str),
/// query_value!(valq.keywords[1] -> str),
/// query_value!(valq.author.age -> u64),
/// );
/// assert_eq!(picks, Some(("valq", "query", 31u64)));
///
/// let wrong_picks = transpose_tuple!(
/// query_value!(valq.name -> str),
/// query_value!(valq.keywords[10] -> str), // out of bounds
/// );
/// assert_eq!(wrong_picks, None);
/// ```
///
/// ```
/// // Results
/// # use serde_json::json;
/// use valq::{query_value_result, transpose_tuple};
/// # let valq = json!({
/// # "name": "valq",
/// # "keywords": ["macro", "query", "serde"],
/// # "author": {
/// # "name": "jiftechnify",
/// # "age": 31
/// # }
/// # });
///
/// let picks = transpose_tuple!(
/// Result; // don't forget this!
/// query_value_result!(valq.name -> str),
/// query_value_result!(valq.keywords[1] -> str),
/// query_value_result!(valq.author.age -> u64),
/// );
/// assert!(matches!(picks, Ok(("valq", "query", 31u64))));
///
/// let wrong_picks = transpose_tuple!(
/// Result;
/// query_value_result!(valq.name -> str),
/// query_value_result!(valq.secrets), // non-existent path
/// );
/// assert!(matches!(wrong_picks, Err(valq::Error::ValueNotFoundAtPath(_))));
/// ```
#[macro_export]
macro_rules! transpose_tuple {
(Option; $first:expr, $($rest:expr),+ $(,)?) => {
(|| {
Some(( $first?, $($rest?),+ ))
})()
};
(Result; $first:expr, $($rest:expr),+ $(,)?) => {
(|| {
Ok(( $first?, $($rest?),+ )) as $crate::Result<_>
})()
};
($first:expr, $($rest:expr),+ $(,)?) => {
transpose_tuple!(Option; $first, $($rest),+)
};
}
217 changes: 217 additions & 0 deletions tests/transpose_tuple.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,217 @@
use serde_json::json;
use valq::{query_value, query_value_result, transpose_tuple, Error};

#[test]
fn test_option_variant_all_some() {
let data = json!({
"name": "valq",
"version": "0.2.0",
"stars": 100
});

let result = transpose_tuple!(
query_value!(data.name -> str),
query_value!(data.version -> str),
query_value!(data.stars -> u64),
);

assert_eq!(result, Some(("valq", "0.2.0", 100u64)));
}

#[test]
fn test_option_variant_with_none() {
let data = json!({
"name": "valq",
"version": "0.2.0",
});

let result = transpose_tuple!(
query_value!(data.name -> str),
query_value!(data.nonexistent -> str),
query_value!(data.version -> str),
);

assert_eq!(result, None);
}

#[test]
fn test_option_variant_explicit_option_prefix() {
let data = json!({
"a": 1,
"b": 2,
"c": 3
});

let result = transpose_tuple!(
Option;
query_value!(data.a -> u64),
query_value!(data.b -> u64),
query_value!(data.c -> u64),
);

assert_eq!(result, Some((1u64, 2u64, 3u64)));
}

#[test]
fn test_option_variant_many_elements() {
let data = json!({
"v1": 1,
"v2": 2,
"v3": 3,
"v4": 4,
"v5": 5,
"v6": 6
});

let result = transpose_tuple!(
query_value!(data.v1 -> u64),
query_value!(data.v2 -> u64),
query_value!(data.v3 -> u64),
query_value!(data.v4 -> u64),
query_value!(data.v5 -> u64),
query_value!(data.v6 -> u64),
);

assert_eq!(result, Some((1u64, 2u64, 3u64, 4u64, 5u64, 6u64)));
}

#[test]
fn test_option_variant_trailing_comma() {
let data = json!({
"a": "foo",
"b": "bar",
});

let result = transpose_tuple!(query_value!(data.a -> str), query_value!(data.b -> str),);

assert_eq!(result, Some(("foo", "bar")));
}

#[test]
fn test_result_variant_all_ok() {
let data = json!({
"name": "valq",
"keywords": ["macro", "query", "serde"],
"author": {
"name": "jiftechnify",
"age": 31
}
});

let result = transpose_tuple!(
Result;
query_value_result!(data.name -> str),
query_value_result!(data.keywords[1] -> str),
query_value_result!(data.author.age -> u64),
);

assert!(result.is_ok());
assert_eq!(result.unwrap(), ("valq", "query", 31u64));
}

#[test]
fn test_result_variant_with_error() {
let data = json!({
"name": "valq",
"version": "0.2.0"
});

let result = transpose_tuple!(
Result;
query_value_result!(data.name -> str),
query_value_result!(data.nonexistent),
);

assert!(result.is_err());
assert!(matches!(result.unwrap_err(), Error::ValueNotFoundAtPath(_)));
}

#[test]
fn test_result_variant_type_mismatch_error() {
let data = json!({
"value": "not a number",
"other": 123
});

let result = transpose_tuple!(
Result;
query_value_result!(data.value -> u64),
query_value_result!(data.other -> u64),
);

assert!(result.is_err());
}

#[test]
fn test_result_variant_array_out_of_bounds() {
let data = json!({
"items": [1, 2, 3]
});

let result = transpose_tuple!(
Result;
query_value_result!(data.items[0] -> u64),
query_value_result!(data.items[10] -> u64),
);

assert!(result.is_err());
}

#[test]
fn test_result_variant_trailing_comma() {
let data = json!({
"a": 1.5,
"b": 2.5,
});

let result = transpose_tuple!(
Result;
query_value_result!(data.a -> f64),
query_value_result!(data.b -> f64),
);

assert!(result.is_ok());
assert_eq!(result.unwrap(), (1.5f64, 2.5f64));
}

#[test]
fn test_mixed_types() {
let data = json!({
"string": "hello",
"number": 42,
"boolean": true,
"float": 3.14
});

let result = transpose_tuple!(
query_value!(data.string -> str),
query_value!(data.number -> u64),
query_value!(data.boolean -> bool),
query_value!(data.float -> f64),
);

assert_eq!(result, Some(("hello", 42u64, true, 3.14f64)));
}

#[test]
fn test_nested_object_access() {
let data = json!({
"level1": {
"level2": {
"level3": {
"value": "deep",
"number": 99
}
}
}
});

let result = transpose_tuple!(
Result;
query_value_result!(data.level1.level2.level3.value -> str),
query_value_result!(data.level1.level2.level3.number -> u64),
);

assert!(result.is_ok());
assert_eq!(result.unwrap(), ("deep", 99u64));
}