class Nokogiri::XML::Schema - nokogiri-1.10.3 Documentation

# class Nokogiri::XML::Schema

Nokogiri::XML::Schema is used for validating XML against a schema (usually from an xsd file).

## Synopsis¶ ↑

Validate an XML document against a Schema. Loop over the errors that are returned and print them out:

    xsd = Nokogiri::XML::Schema(File.read(PO_SCHEMA_FILE))
    doc = Nokogiri::XML(File.read(PO_XML_FILE))

    xsd.validate(doc).each do |error|
      puts error.message
    end

The list of errors are Nokogiri::XML::SyntaxError objects.

### Attributes

errors[RW]

Errors while parsing the schema file

### Public Class Methods

from_document(doc) click to toggle source

Create a new Schema from the Nokogiri::XML::Document `doc`

    static VALUE from_document(VALUE klass, VALUE document)
    {
      xmlDocPtr doc;
      xmlSchemaParserCtxtPtr ctx;
      xmlSchemaPtr schema;
      VALUE errors;
      VALUE rb_schema;

      Data_Get_Struct(document, xmlDoc, doc);

      /* In case someone passes us a node. ugh. */
      doc = doc->doc;

      ctx = xmlSchemaNewDocParserCtxt(doc);

      errors = rb_ary_new();
      xmlSetStructuredErrorFunc((void *)errors, Nokogiri_error_array_pusher);

    #ifdef HAVE_XMLSCHEMASETPARSERSTRUCTUREDERRORS
      xmlSchemaSetParserStructuredErrors(
        ctx,
        Nokogiri_error_array_pusher,
        (void *)errors
      );
    #endif

      schema = xmlSchemaParse(ctx);

      xmlSetStructuredErrorFunc(NULL, NULL);
      xmlSchemaFreeParserCtxt(ctx);

      if(NULL == schema) {
        xmlErrorPtr error = xmlGetLastError();
        if(error)
          Nokogiri_error_raise(NULL, error);
        else
          rb_raise(rb_eRuntimeError, "Could not parse document");

        return Qnil;
      }

      rb_schema = Data_Wrap_Struct(klass, 0, dealloc, schema);
      rb_iv_set(rb_schema, "@errors", errors);

      return rb_schema;

      return Qnil;
    }

new(string_or_io) click to toggle source

Create a new Nokogiri::XML::Schema object using a `string_or_io` object.

    # File lib/nokogiri/xml/schema.rb, line 36
    def self.new string_or_io
      from_document Nokogiri::XML(string_or_io)
    end

read_memory(string) click to toggle source

Create a new Schema from the contents of `string`

    static VALUE read_memory(VALUE klass, VALUE content)
    {
      xmlSchemaPtr schema;
      xmlSchemaParserCtxtPtr ctx = xmlSchemaNewMemParserCtxt(
          (const char *)StringValuePtr(content),
          (int)RSTRING_LEN(content)
      );
      VALUE rb_schema;
      VALUE errors = rb_ary_new();
      xmlSetStructuredErrorFunc((void *)errors, Nokogiri_error_array_pusher);

    #ifdef HAVE_XMLSCHEMASETPARSERSTRUCTUREDERRORS
      xmlSchemaSetParserStructuredErrors(
        ctx,
        Nokogiri_error_array_pusher,
        (void *)errors
      );
    #endif

       schema = xmlSchemaParse(ctx);

      xmlSetStructuredErrorFunc(NULL, NULL);
      xmlSchemaFreeParserCtxt(ctx);

      if(NULL == schema) {
        xmlErrorPtr error = xmlGetLastError();
        if(error)
          Nokogiri_error_raise(NULL, error);
        else
          rb_raise(rb_eRuntimeError, "Could not parse document");

        return Qnil;
      }

      rb_schema = Data_Wrap_Struct(klass, 0, dealloc, schema);
      rb_iv_set(rb_schema, "@errors", errors);

      return rb_schema;
    }

### Public Instance Methods

valid?(thing) click to toggle source

Returns true if `thing` is a valid Nokogiri::XML::Document or file.

    # File lib/nokogiri/xml/schema.rb, line 58
    def valid? thing
      validate(thing).length == 0
    end

validate(thing) click to toggle source

Validate `thing` against this schema. `thing` can be a Nokogiri::XML::Document object, or a filename. An Array of Nokogiri::XML::SyntaxError objects found while validating the `thing` is returned.

    # File lib/nokogiri/xml/schema.rb, line 45
    def validate thing
      if thing.is_a?(Nokogiri::XML::Document)
        validate_document(thing)
      elsif File.file?(thing)
        validate_file(thing)
      else
        raise ArgumentError, "Must provide Nokogiri::Xml::Document or the name of an existing file"
      end
    end

### Private Instance Methods

validate_document(document) click to toggle source

Validate a Nokogiri::XML::Document against this Schema.

    static VALUE validate_document(VALUE self, VALUE document)
    {
      xmlDocPtr doc;
      xmlSchemaPtr schema;
      xmlSchemaValidCtxtPtr valid_ctxt;
      VALUE errors;

      Data_Get_Struct(self, xmlSchema, schema);
      Data_Get_Struct(document, xmlDoc, doc);

      errors = rb_ary_new();

      valid_ctxt = xmlSchemaNewValidCtxt(schema);

      if(NULL == valid_ctxt) {
        /* we have a problem */
        rb_raise(rb_eRuntimeError, "Could not create a validation context");
      }

    #ifdef HAVE_XMLSCHEMASETVALIDSTRUCTUREDERRORS
      xmlSchemaSetValidStructuredErrors(
        valid_ctxt,
        Nokogiri_error_array_pusher,
        (void *)errors
      );
    #endif

      xmlSchemaValidateDoc(valid_ctxt, doc);

      xmlSchemaFreeValidCtxt(valid_ctxt);

      return errors;
    }

validate_file(filename) click to toggle source

Validate a file against this Schema.

    static VALUE validate_file(VALUE self, VALUE rb_filename)
    {
      xmlSchemaPtr schema;
      xmlSchemaValidCtxtPtr valid_ctxt;
      const char *filename ;
      VALUE errors;

      Data_Get_Struct(self, xmlSchema, schema);
      filename = (const char*)StringValueCStr(rb_filename) ;

      errors = rb_ary_new();

      valid_ctxt = xmlSchemaNewValidCtxt(schema);

      if(NULL == valid_ctxt) {
        /* we have a problem */
        rb_raise(rb_eRuntimeError, "Could not create a validation context");
      }

    #ifdef HAVE_XMLSCHEMASETVALIDSTRUCTUREDERRORS
      xmlSchemaSetValidStructuredErrors(
        valid_ctxt,
        Nokogiri_error_array_pusher,
        (void *)errors
      );
    #endif

      xmlSchemaValidateFile(valid_ctxt, filename, 0);

      xmlSchemaFreeValidCtxt(valid_ctxt);

      return errors;
    }