Skip to content

bump schemars to 1.0 #174

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

bump schemars to 1.0 #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 25 additions & 4 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ num-traits = { version = "0.2.9", default-features = false }
proptest = { version = "1.0.0", optional = true }
rand = { version = "0.8.3", optional = true, default-features = false }
rkyv = { version = "0.7.41", optional = true, default-features = false, features = ["rend"] }
schemars = { version = "0.8.8", optional = true }
schemars = { version = "1.0", optional = true }
serde = { version = "1.0", optional = true, default-features = false }
speedy = { version = "0.8.3", optional = true, default-features = false }

Expand Down
122 changes: 31 additions & 91 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2440,28 +2440,27 @@ mod impl_borsh {
#[cfg(all(feature = "std", feature = "schemars"))]
mod impl_schemars {
extern crate schemars;
use self::schemars::gen::SchemaGenerator;
use self::schemars::schema::{InstanceType, Schema, SchemaObject};
use self::schemars::generate::SchemaGenerator;
use self::schemars::Schema;
use super::{NotNan, OrderedFloat};

macro_rules! primitive_float_impl {
($type:ty, $schema_name:literal) => {
impl schemars::JsonSchema for $type {
fn is_referenceable() -> bool {
false
fn inline_schema() -> bool {
true
}

fn schema_name() -> std::string::String {
std::string::String::from($schema_name)
fn schema_name() -> std::borrow::Cow<'static, str> {
std::borrow::Cow::from($schema_name)
}

fn json_schema(_: &mut SchemaGenerator) -> Schema {
SchemaObject {
instance_type: Some(InstanceType::Number.into()),
format: Some(std::string::String::from($schema_name)),
..Default::default()
}
.into()
schemars::json_schema!({
"type": "number",
"title": $schema_name,
"format": $schema_name,
})
}
}
};
Expand All @@ -2474,93 +2473,34 @@ mod impl_schemars {

#[test]
fn schema_generation_does_not_panic_for_common_floats() {
{
let schema = schemars::gen::SchemaGenerator::default()
.into_root_schema_for::<OrderedFloat<f32>>();
assert_eq!(
schema.schema.instance_type,
Some(schemars::schema::SingleOrVec::Single(std::boxed::Box::new(
schemars::schema::InstanceType::Number
)))
);
assert_eq!(
schema.schema.metadata.unwrap().title.unwrap(),
std::string::String::from("float")
);
}
{
let schema = schemars::gen::SchemaGenerator::default()
.into_root_schema_for::<OrderedFloat<f64>>();
assert_eq!(
schema.schema.instance_type,
Some(schemars::schema::SingleOrVec::Single(std::boxed::Box::new(
schemars::schema::InstanceType::Number
)))
);
assert_eq!(
schema.schema.metadata.unwrap().title.unwrap(),
std::string::String::from("double")
);
}
{
let schema =
schemars::gen::SchemaGenerator::default().into_root_schema_for::<NotNan<f32>>();
assert_eq!(
schema.schema.instance_type,
Some(schemars::schema::SingleOrVec::Single(std::boxed::Box::new(
schemars::schema::InstanceType::Number
)))
);
assert_eq!(
schema.schema.metadata.unwrap().title.unwrap(),
std::string::String::from("float")
);
}
{
let schema =
schemars::gen::SchemaGenerator::default().into_root_schema_for::<NotNan<f64>>();
assert_eq!(
schema.schema.instance_type,
Some(schemars::schema::SingleOrVec::Single(std::boxed::Box::new(
schemars::schema::InstanceType::Number
)))
);
assert_eq!(
schema.schema.metadata.unwrap().title.unwrap(),
std::string::String::from("double")
);
fn test<T: schemars::JsonSchema>(title: &str) {
let schema = schemars::generate::SchemaGenerator::default().into_root_schema_for::<T>();

assert_eq!(schema.get("type").unwrap().as_str().unwrap(), "number");
assert_eq!(schema.get("title").unwrap().as_str().unwrap(), title);
assert_eq!(schema.get("format").unwrap().as_str().unwrap(), title);
}

test::<OrderedFloat<f32>>("float");
test::<NotNan<f32>>("float");
test::<OrderedFloat<f64>>("double");
test::<NotNan<f64>>("double");
}

#[test]
fn ordered_float_schema_match_primitive_schema() {
{
let of_schema = schemars::gen::SchemaGenerator::default()
.into_root_schema_for::<OrderedFloat<f32>>();
let prim_schema =
schemars::gen::SchemaGenerator::default().into_root_schema_for::<f32>();
assert_eq!(of_schema, prim_schema);
}
{
let of_schema = schemars::gen::SchemaGenerator::default()
.into_root_schema_for::<OrderedFloat<f64>>();
let prim_schema =
schemars::gen::SchemaGenerator::default().into_root_schema_for::<f64>();
assert_eq!(of_schema, prim_schema);
}
{
let of_schema =
schemars::gen::SchemaGenerator::default().into_root_schema_for::<NotNan<f32>>();
let prim_schema =
schemars::gen::SchemaGenerator::default().into_root_schema_for::<f32>();
assert_eq!(of_schema, prim_schema);
}
{
fn test<Wrapped: schemars::JsonSchema, Inner: schemars::JsonSchema>() {
let of_schema =
schemars::gen::SchemaGenerator::default().into_root_schema_for::<NotNan<f64>>();
schemars::generate::SchemaGenerator::default().into_root_schema_for::<Wrapped>();
let prim_schema =
schemars::gen::SchemaGenerator::default().into_root_schema_for::<f64>();
schemars::generate::SchemaGenerator::default().into_root_schema_for::<Inner>();
assert_eq!(of_schema, prim_schema);
}

test::<OrderedFloat<f32>, f32>();
test::<NotNan<f32>, f32>();
test::<OrderedFloat<f64>, f64>();
test::<NotNan<f64>, f64>();
}
}

Expand Down
Loading