ion-schema 0.15.0

use crate::isl::isl_constraint::{IslConstraint, IslConstraintValue};
use crate::isl::isl_import::IslImportType;
use crate::isl::IslVersion;
use crate::result::{invalid_schema_error, invalid_schema_error_raw, IonSchemaResult};
use ion_rs::{Element, IonResult, StructWriter, ValueWriter, WriteAsIon};

/// Provides public facing APIs for constructing ISL types programmatically for ISL 1.0
pub mod v_1_0 {
    use crate::isl::isl_constraint::{IslConstraint, IslConstraintValue};
    use crate::isl::isl_type::IslType;
    use crate::isl::IslVersion;
    use crate::result::IonSchemaResult;
    use ion_rs::Element;

    /// Creates a named [IslType] using the [IslConstraint] defined within it
    pub fn named_type<A: Into<String>, B: Into<Vec<IslConstraint>>>(
        name: A,
        constraints: B,
    ) -> IslType {
        let constraints = constraints.into();
        IslType::new(Some(name.into()), constraints, None)
    }

    /// Creates an anonymous [IslType] using the [IslConstraint] defined within it
    pub fn anonymous_type<A: Into<Vec<IslConstraint>>>(constraints: A) -> IslType {
        let constraints = constraints.into();
        let isl_constraints: Vec<IslConstraintValue> = constraints
            .iter()
            .map(|c| c.constraint_value.to_owned())
            .collect();
        IslType::new(None, constraints, None)
    }

    /// Creates an [IslType] using the bytes that represent an ISL type definition.
    /// Returns an error if the given bytes representation is syntactically incorrect as per [Ion Schema specification's grammar].
    ///
    /// _Note: This method allows loading both named and anonymous type definition._
    ///
    /// [Ion Schema specification's grammar]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#grammar
    pub fn load_isl_type(bytes: &[u8]) -> IonSchemaResult<IslType> {
        IslType::from_owned_element(IslVersion::V1_0, &Element::read_one(bytes)?, &mut vec![])
    }
}

/// Provides public facing APIs for constructing ISL types programmatically for ISL 2.0
pub mod v_2_0 {
    use crate::isl::isl_constraint::IslConstraint;
    use crate::isl::isl_type::{v_1_0, IslType};
    use crate::isl::IslVersion;
    use crate::result::IonSchemaResult;
    use ion_rs::Element;

    /// Creates a named [IslType] using the [IslConstraint] defined within it
    pub fn named_type<A: Into<String>, B: Into<Vec<IslConstraint>>>(
        name: A,
        constraints: B,
    ) -> IslType {
        v_1_0::named_type(name, constraints)
    }

    /// Creates an anonymous [IslType] using the [IslConstraint] defined within it
    pub fn anonymous_type<A: Into<Vec<IslConstraint>>>(constraints: A) -> IslType {
        v_1_0::anonymous_type(constraints)
    }

    /// Loads an [IslType] using the bytes that represent an ISL type definition.
    /// Returns an error if the given bytes representation is syntactically incorrect as per [Ion Schema specification's grammar].
    ///
    /// _Note: This method allows loading both named and anonymous definition._
    ///
    /// [Ion Schema specification's grammar]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#grammar
    pub fn load_isl_type(bytes: &[u8]) -> IonSchemaResult<IslType> {
        IslType::from_owned_element(IslVersion::V2_0, &Element::read_one(bytes)?, &mut vec![])
    }
}

/// Represents both named and anonymous [IslType]s and can be converted to a resolved type definition
/// Named ISL type grammar: `type:: { name: <NAME>, <CONSTRAINT>...}`
/// Anonymous ISL type grammar: `{ <CONSTRAINT>... }`
#[derive(Debug, Clone)]
pub struct IslType {
    name: Option<String>,
    constraints: Vec<IslConstraint>,
    // Represents the ISL type struct in string format for anonymous type definition
    // For named type definition & programmatically created type definition, this will be `None`
    pub(crate) isl_type_struct: Option<Element>,
}

impl IslType {
    pub(crate) fn new(
        name: Option<String>,
        constraints: Vec<IslConstraint>,
        isl_type_struct: Option<Element>,
    ) -> Self {
        Self {
            name,
            constraints,
            isl_type_struct,
        }
    }

    pub fn name(&self) -> Option<&str> {
        self.name.as_deref()
    }

    pub fn constraints(&self) -> &[IslConstraint] {
        &self.constraints
    }

    pub fn open_content(&self) -> Vec<(String, Element)> {
        let mut open_content = vec![];
        for constraint in &self.constraints {
            if let IslConstraintValue::Unknown(constraint_name, element) =
                &constraint.constraint_value
            {
                open_content.push((constraint_name.to_owned(), element.to_owned()))
            }
        }
        open_content
    }

    pub(crate) fn is_open_content_allowed(&self) -> bool {
        let mut open_content = true;
        if self.constraints.contains(&IslConstraint::new(
            IslVersion::V1_0,
            IslConstraintValue::ContentClosed,
        )) {
            open_content = false;
        }
        open_content
    }

    /// Parse constraints inside an [Element] to an [IslType]
    pub(crate) fn from_owned_element(
        isl_version: IslVersion,
        ion: &Element,
        inline_imported_types: &mut Vec<IslImportType>, // stores the inline_imports that are discovered while loading this ISL type
    ) -> IonSchemaResult<Self> {
        let mut constraints = vec![];
        let contains_annotations = ion.annotations().contains("type");

        let ion_struct = try_to!(ion.as_struct());

        // parses the name of the type specified by schema
        if ion_struct.get_all("name").count() > 1 {
            return Err(invalid_schema_error_raw(
                "type definition must only contain a single field that represents name of the type",
            ));
        }
        let type_name: Option<String> = match ion_struct.get("name") {
            Some(name_element) => match name_element.as_symbol() {
                Some(name_symbol) => match name_symbol.text() {
                    None => {
                        return Err(invalid_schema_error_raw(
                            "type names must be a symbol with defined text",
                        ))
                    }
                    Some(name) => {
                        if !name_element.annotations().is_empty() {
                            return Err(invalid_schema_error_raw(
                                "type names must be a non null and unannotated symbol with defined text",
                            ));
                        }
                        Some(name.to_owned())
                    }
                },
                None => {
                    return Err(invalid_schema_error_raw(
                        "type names must be a symbol with defined text",
                    ))
                }
            },
            None => None, // If there is no name field then it is an anonymous type
        };

        if !contains_annotations && type_name.is_some() {
            // For named types if it does not have the `type::` annotation return an error
            return Err(invalid_schema_error_raw(
                "Top level types must have `type::` annotation in their definition",
            ));
        }

        // set the isl type name for any error that is returned while parsing its constraints
        let isl_type_name = match type_name.to_owned() {
            Some(name) => name,
            None => format!("{ion_struct:?}"),
        };

        // parses all the constraints inside a Type
        for (field_name, value) in ion_struct.iter() {
            let constraint_name = match field_name.text() {
                Some("name") => continue, // if the field_name is "name" then it's the type name not a constraint
                Some("occurs") => continue, // if the field_name is "occurs" then skip it as it is handled elsewhere
                Some(name) => name,
                None => {
                    return Err(invalid_schema_error_raw(
                        "A type name symbol token does not have any text",
                    ))
                }
            };

            let constraint = IslConstraint::new(
                isl_version,
                IslConstraintValue::from_ion_element(
                    isl_version,
                    constraint_name,
                    value,
                    &isl_type_name,
                    inline_imported_types,
                )?,
            );
            constraints.push(constraint);
        }
        Ok(IslType::new(type_name, constraints, Some(ion.to_owned())))
    }
}

impl WriteAsIon for IslType {
    fn write_as_ion<V: ValueWriter>(&self, writer: V) -> IonResult<()> {
        let mut struct_writer = writer.with_annotations(["type"])?.struct_writer()?;

        if let Some(name) = self.name.as_ref() {
            struct_writer
                .field_writer("name")
                .write_symbol(name.as_str())?;
        }

        for constraint in self.constraints() {
            let constraint_name = constraint.constraint().field_name();
            struct_writer
                .field_writer(constraint_name)
                .write(constraint.constraint())?;
        }
        struct_writer.close()
    }
}

// OwnedStruct doesn't preserve field order hence the PartialEq won't work properly for unordered constraints
// Related issue: https://github.com/amazon-ion/ion-rust/issues/200
impl PartialEq for IslType {
    fn eq(&self, other: &Self) -> bool {
        self.constraints.len() == other.constraints.len()
            && self.name == other.name
            && self.constraints.iter().all(|constraint| {
                other
                    .constraints
                    .iter()
                    .any(|other_constraint| constraint == other_constraint)
            })
    }
}