schematools 0.22.5

Tools for codegen, preprocessing and validation of json-schema and openapi spec
Documentation
use std::borrow::Cow;
use std::collections::HashMap;

use serde::Serialize;
use serde_json::Value;

use crate::codegen::jsonschema::types::WrapperStrategy;
use crate::codegen::jsonschema::{
    types::{FlatModel, Model, ModelType},
    ModelContainer,
};
use crate::error::Error;
use crate::scope::SchemaScope;

const DISCRIMINATOR_META: &str = "_discriminator";

// extractor has access to original and processed oneOf
// it also may need to create new models if it affects oneOf options
pub trait Extractor {
    /// Performs extraction on oneOf specific value
    fn extract(
        &mut self,
        original: &Value,
        model: Model,
        container: &mut ModelContainer,
        scope: &mut SchemaScope,
    ) -> Result<FlatModel, Error>;

    /// Receives created flat model as extractor processing result
    fn postprocess(&self, list: Vec<FlatModel>) -> Vec<FlatModel> {
        list
    }

    /// Receives contains of oneOf array and return list of array
    /// may be used to change oneOf list
    fn preprocess<'a>(&mut self, one_of: Cow<'a, [Value]>) -> Cow<'a, [Value]> {
        one_of
    }

    fn strategy(&self) -> WrapperStrategy;
}

#[derive(Serialize)]
pub struct DiscriminatorMeta {
    pub property: String,
    pub properties: Option<usize>,

    // Inner model value
    pub value: DiscriminatorValue,
}

#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub enum DiscriminatorValue {
    Model(DiscriminatorValueModel),
    Simple(FlatModel),
}

#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct DiscriminatorValueModel {
    name: String,
    kind: String,
}

impl DiscriminatorValueModel {
    pub fn flat(f: &FlatModel) -> DiscriminatorValue {
        if f.type_ == "array" {
            // probably here logic should be reverted, and only if object it
            // should inner name
            DiscriminatorValue::Simple(f.clone())
        } else {
            f.model
                .as_ref()
                .and_then(|inner| {
                    inner.name.clone().map(|name| {
                        DiscriminatorValue::Model(Self {
                            name,
                            kind: inner.type_.clone(),
                        })
                    })
                })
                .unwrap_or(DiscriminatorValue::Simple(f.clone()))
        }
    }
}

pub struct Simple {
    properties: Vec<SimpleProperty>,
}

#[derive(Debug)]
#[allow(dead_code)]
pub enum SimpleProperty {
    Internal(String),
    External(String),
    Unknown,
}

impl Extractor for Simple {
    fn extract(
        &mut self,
        _: &Value,
        m: Model,
        container: &mut ModelContainer,
        scope: &mut SchemaScope,
    ) -> Result<FlatModel, Error> {
        m.flatten(container, scope).map(|mut f| {
            if let Some(meta) = self.autodetect(&m) {
                f.attributes.x.insert(
                    DISCRIMINATOR_META.to_owned(),
                    serde_json::to_value(meta).unwrap(),
                );
            }

            f
        })
    }

    fn strategy(&self) -> WrapperStrategy {
        match self.properties.len() {
            i if i
                == self
                    .properties
                    .iter()
                    .filter(|p| matches!(p, SimpleProperty::External(_)))
                    .count() =>
            {
                WrapperStrategy::Externally
            }
            i if i
                == self
                    .properties
                    .iter()
                    .filter(|p| matches!(p, SimpleProperty::Internal(_)))
                    .count() =>
            {
                self.properties
                    .first()
                    .and_then(|d| match d {
                        SimpleProperty::Internal(property) => {
                            Some(WrapperStrategy::Internally(property.clone()))
                        }
                        _ => None,
                    })
                    .unwrap_or(WrapperStrategy::BruteForce)
            }
            _ => WrapperStrategy::BruteForce,
        }
    }
}

impl Simple {
    pub fn new() -> Self {
        Self { properties: vec![] }
    }

    fn autodetect(&mut self, model: &Model) -> Option<DiscriminatorMeta> {
        let property = if let ModelType::ObjectType(object) = model.inner() {
            if object.properties.len() == 1 {
                object.properties.first().map(|f| {
                    self.properties
                        .push(SimpleProperty::External(f.name.clone().unwrap()));

                    DiscriminatorMeta {
                        property: f.name.clone().unwrap(),
                        value: DiscriminatorValueModel::flat(f),
                        properties: Some(object.properties.len()),
                    }
                })
            } else {
                object
                    .properties
                    .iter()
                    .find(|f| f.type_ == "const")
                    .map(|f| {
                        self.properties
                            .push(SimpleProperty::Internal(f.name.clone().unwrap()));

                        DiscriminatorMeta {
                            property: f.name.clone().unwrap(),
                            value: DiscriminatorValueModel::flat(f),
                            properties: Some(object.properties.len() - 1),
                        }
                    })
            }
        } else {
            None
        };

        if property.is_none() {
            self.properties.push(SimpleProperty::Unknown);
        }

        property
    }
}

#[derive(Debug)]
pub struct Discriminator {
    property: String,
    mapping: HashMap<String, Vec<String>>,
}

impl Discriminator {
    pub fn new(data: &Value) -> Option<Self> {
        let property = data["propertyName"].as_str()?;

        let mut mapping = HashMap::<String, Vec<String>>::new();

        data["mapping"]
            .as_object()?
            .into_iter()
            .filter_map(|(key, value)| {
                value
                    .as_str()
                    .map(|reference| (key.clone(), reference.to_string()))
            })
            .for_each(|(key, value)| {
                mapping
                    .entry(value)
                    .and_modify(|l| l.push(key.clone()))
                    .or_insert(vec![key]);
            });

        Some(Self {
            property: property.to_string(),
            mapping,
        })
    }
}

impl Extractor for Discriminator {
    fn extract(
        &mut self,
        original: &Value,
        mut m: Model,
        container: &mut ModelContainer,
        scope: &mut SchemaScope,
    ) -> Result<FlatModel, Error> {
        // use refs to find correct mapping
        if let Some(value) = original["$ref"]
            .as_str()
            .and_then(|reference| self.mapping.get_mut(reference))
        {
            if let Some(value) = value.pop() {
                let properties = match m.mut_inner() {
                    ModelType::ObjectType(object_type) => {
                        // remove excess discrimnator field from variant
                        // fixme: it probably should convert property to const type instead
                        object_type.properties = object_type
                            .properties
                            .clone()
                            .into_iter()
                            .filter(|a| {
                                a.name
                                    .as_ref()
                                    .map(|name| name != &self.property)
                                    .unwrap_or_default()
                            })
                            .collect::<Vec<_>>();

                        Some(object_type.properties.len())
                    }
                    _ => None,
                };

                m.flatten(container, scope).map(|mut f| {
                    f.attributes.x.insert(
                        DISCRIMINATOR_META.to_owned(),
                        serde_json::to_value(DiscriminatorMeta {
                            property: self.property.clone(),
                            value: DiscriminatorValue::Model(DiscriminatorValueModel {
                                name: value,
                                kind: "string".to_string(),
                            }),
                            properties,
                        })
                        .unwrap(),
                    );
                    f
                })
            } else {
                unreachable!()
            }
        } else {
            m.flatten(container, scope)
        }
    }

    fn strategy(&self) -> WrapperStrategy {
        WrapperStrategy::Internally(self.property.clone())
    }

    fn preprocess<'a>(&mut self, one_of: Cow<'a, [Value]>) -> Cow<'a, [Value]> {
        let mut list: Vec<Value> = Vec::new();

        let references = one_of.iter().filter_map(|original| {
            original["$ref"].as_str().and_then(|reference| {
                self.mapping
                    .get(reference)
                    .map(|mappings| (mappings.len(), original))
            })
        });

        for (qty, value) in references {
            for _ in 0..qty {
                list.push(value.clone());
            }
        }

        Cow::Owned(list)
    }
}