Support XSD includes

fixes #51

Author: svacas

src/main/java/org/raml/model/MimeType.java

@@ -23,6 +23,7 @@
 import org.raml.parser.annotation.Key;
 import org.raml.parser.annotation.Mapping;
 import org.raml.parser.annotation.Scalar;
+import org.raml.parser.builder.SchemaTupleBuilder;
 
 public class MimeType implements Serializable
 {
@@ -32,9 +33,11 @@ public class MimeType implements Serializable
     @Key
     private String type;
 
-    @Scalar(rule = org.raml.parser.rule.SchemaRule.class)
+    @Scalar(rule = org.raml.parser.rule.SchemaRule.class, builder = SchemaTupleBuilder.class)
     private String schema;
 
+    private Object compiledSchema;
+
     @Scalar
     private String example;
 
@@ -70,6 +73,16 @@ public void setSchema(String schema)
         this.schema = schema;
     }
 
+    public Object getCompiledSchema()
+    {
+        return compiledSchema;
+    }
+
+    public void setCompiledSchema(Object compiledSchema)
+    {
+        this.compiledSchema = compiledSchema;
+    }
+
     public String getExample()
     {
         return example;

src/main/java/org/raml/model/Raml.java

@@ -56,6 +56,8 @@ public class Raml implements Serializable
     @Sequence(rule = org.raml.parser.rule.GlobalSchemasRule.class)
     private List<Map<String, String>> schemas = new ArrayList<Map<String, String>>();
 
+    private Map<String, Object> compiledSchemas;
+
     @Sequence
     private List<Map<String, Template>> resourceTypes = new ArrayList<Map<String, Template>>();
 
@@ -236,6 +238,16 @@ public Map<String, String> getConsolidatedSchemas()
         return consolidated;
     }
 
+    public Map<String, Object> getCompiledSchemas()
+    {
+        return compiledSchemas;
+    }
+
+    public void setCompiledSchemas(Map<String, Object> compiledSchemas)
+    {
+        this.compiledSchemas = compiledSchemas;
+    }
+
     public Resource getResource(String path)
     {
         for (Resource resource : resources.values())

src/main/java/org/raml/parser/ResolveResourceException.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2013 (c) MuleSoft, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
+ */
+package org.raml.parser;
+
+import java.io.IOException;
+
+public class ResolveResourceException extends RuntimeException
+{
+
+    public ResolveResourceException(IOException e)
+    {
+        super(e);
+    }
+
+}

src/main/java/org/raml/parser/XsdResourceResolver.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2013 (c) MuleSoft, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
+ */
+package org.raml.parser;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+
+import org.apache.commons.io.IOUtils;
+import org.raml.parser.loader.ResourceLoader;
+import org.raml.parser.rule.LSInputImpl;
+import org.raml.parser.tagresolver.ContextPath;
+import org.raml.parser.utils.StreamUtils;
+import org.w3c.dom.ls.LSInput;
+import org.w3c.dom.ls.LSResourceResolver;
+
+public class XsdResourceResolver implements LSResourceResolver
+{
+
+    private final ContextPath contextPath;
+    private final ResourceLoader resourceLoader;
+
+    public XsdResourceResolver(ContextPath contextPath, ResourceLoader resourceLoader)
+    {
+        this.contextPath = contextPath;
+        this.resourceLoader = resourceLoader;
+    }
+
+    @Override
+    public LSInput resolveResource(String type, String namespaceURI, String publicId, String systemId, String baseURI)
+    {
+        String path = contextPath.resolveAbsolutePath(systemId);
+        if (path == null || path.startsWith("http://"))
+        {
+            //delegate resource resolution to xml parser
+            return null;
+        }
+        InputStream inputStream = resourceLoader.fetchResource(path);
+        if (inputStream == null)
+        {
+            //delegate resource resolution to xml parser
+            return null;
+        }
+        byte[] content;
+        try
+        {
+            content = IOUtils.toByteArray(inputStream);
+        }
+        catch (IOException e)
+        {
+            throw new ResolveResourceException(e);
+        }
+        LSInput input = new LSInputImpl(publicId, systemId, baseURI, new ByteArrayInputStream(content), StreamUtils.detectEncoding(content));
+        return input;
+    }
+}

src/main/java/org/raml/parser/builder/SchemaTupleBuilder.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright 2013 (c) MuleSoft, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
+ */
+package org.raml.parser.builder;
+
+import javax.xml.validation.Schema;
+
+import org.raml.parser.utils.NodeUtils;
+import org.raml.parser.utils.ReflectionUtils;
+import org.raml.parser.visitor.SchemaCompiler;
+import org.yaml.snakeyaml.nodes.ScalarNode;
+
+public class SchemaTupleBuilder extends ScalarTupleBuilder
+{
+
+    private static final String SCHEMA_FIELD_NAME = "schema";
+    private static final String PARSED_SCHEMA_FIELD_NAME = "compiledSchema";
+
+    public SchemaTupleBuilder()
+    {
+        super(SCHEMA_FIELD_NAME, String.class);
+    }
+
+    @Override
+    public Object buildValue(Object parent, ScalarNode node)
+    {
+        Object result = super.buildValue(parent, node);
+        Object schema = compileSchema(node);
+        ReflectionUtils.setProperty(parent, PARSED_SCHEMA_FIELD_NAME, schema);
+        return result;
+    }
+
+    private Object compileSchema(ScalarNode node)
+    {
+        String value = node.getValue();
+
+        if (value == null || NodeUtils.isNonStringTag(node.getTag()))
+        {
+            return null;
+        }
+
+        Schema schema = null;
+        String mimeType = getParent() instanceof PojoTupleBuilder ? ((PojoTupleBuilder) getParent()).getFieldName() : null;
+        if (mimeType != null && mimeType.contains("xml"))
+        {
+            schema = SchemaCompiler.getInstance().compile(value);
+        }
+        return schema;
+    }
+
+}

src/main/java/org/raml/parser/loader/ResourceLoaderAware.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2013 (c) MuleSoft, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
+ */
+package org.raml.parser.loader;
+
+public interface ResourceLoaderAware
+{
+
+    void setResourceLoader(ResourceLoader resourceLoader);
+
+}

src/main/java/org/raml/parser/rule/LSInputImpl.java

@@ -0,0 +1,142 @@
+/*
+ * Copyright 2013 (c) MuleSoft, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
+ */
+package org.raml.parser.rule;
+
+import java.io.ByteArrayInputStream;
+import java.io.InputStream;
+import java.io.Reader;
+
+import org.w3c.dom.ls.LSInput;
+
+public class LSInputImpl implements LSInput
+{
+
+    protected Reader characterStream;
+    protected InputStream byteStream;
+    protected String stringData;
+
+    protected String systemId;
+    protected String publicId;
+    protected String baseUri;
+
+    protected String encoding;
+    protected boolean certifiedText;
+
+    public LSInputImpl(String publicId, String systemId, String baseURI, ByteArrayInputStream content, String encoding)
+    {
+        this.publicId = publicId;
+        this.systemId = systemId;
+        this.baseUri = baseURI;
+        this.byteStream = content;
+        this.encoding = encoding;
+    }
+
+    @Override
+    public Reader getCharacterStream()
+    {
+        return characterStream;
+    }
+
+    @Override
+    public void setCharacterStream(Reader characterStream)
+    {
+        this.characterStream = characterStream;
+    }
+
+    @Override
+    public InputStream getByteStream()
+    {
+        return byteStream;
+    }
+
+    @Override
+    public void setByteStream(InputStream byteStream)
+    {
+        this.byteStream = byteStream;
+    }
+
+    @Override
+    public String getStringData()
+    {
+        return stringData;
+    }
+
+    @Override
+    public void setStringData(String stringData)
+    {
+        this.stringData = stringData;
+    }
+
+    @Override
+    public String getSystemId()
+    {
+        return systemId;
+    }
+
+    @Override
+    public void setSystemId(String systemId)
+    {
+        this.systemId = systemId;
+    }
+
+    @Override
+    public String getPublicId()
+    {
+        return publicId;
+    }
+
+    @Override
+    public void setPublicId(String publicId)
+    {
+        this.publicId = publicId;
+    }
+
+    @Override
+    public String getBaseURI()
+    {
+        return baseUri;
+    }
+
+    @Override
+    public void setBaseURI(String baseURI)
+    {
+        this.baseUri = baseURI;
+    }
+
+    @Override
+    public String getEncoding()
+    {
+        return encoding;
+    }
+
+    @Override
+    public void setEncoding(String encoding)
+    {
+        this.encoding = encoding;
+    }
+
+    @Override
+    public boolean getCertifiedText()
+    {
+        return certifiedText;
+    }
+
+    @Override
+    public void setCertifiedText(boolean certifiedText)
+    {
+        this.certifiedText = certifiedText;
+    }
+}