Skip to content

Commit

Permalink
More documentation
Browse files Browse the repository at this point in the history 
Signed-off-by: Francis Galiegue <[email protected]>
  • Loading branch information
@fge
fge committed May 25, 2014
1 parent 1852f51 commit cad70e5
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 45 deletions.
120 changes: 76 additions & 44 deletions src/main/java/com/github/fge/jsonschema/processors/validation/InstanceValidator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,15 @@
import com.github.fge.jsonschema.core.tree.JsonTree;
import com.github.fge.jsonschema.core.tree.SchemaTree;
import com.github.fge.jsonschema.keyword.validator.KeywordValidator;
import com.github.fge.jsonschema.main.JsonSchema;
import com.github.fge.jsonschema.main.JsonValidator;
import com.github.fge.jsonschema.processors.data.FullData;
import com.github.fge.jsonschema.processors.data.SchemaContext;
import com.github.fge.jsonschema.processors.data.ValidatorList;
import com.github.fge.msgsimple.bundle.MessageBundle;
import com.github.fge.uritemplate.URITemplate;
import com.github.fge.uritemplate.URITemplateException;
import com.github.fge.uritemplate.URITemplateParseException;
import com.github.fge.uritemplate.vars.VariableMap;
import com.google.common.base.Equivalence;
import com.google.common.collect.Lists;
Expand All @@ -50,7 +53,16 @@
import java.util.Set;

/**
* Main validation processor
* Processor for validating one schema/instance pair
*
* <p>One such processor is created for each schema/instance validation.</p>
*
* <p>Internally, all validation operations provided by the API (whether that
* be a {@link JsonSchema}, via {@link JsonValidator} or using {@link
* ValidationProcessor} directly) will eventually instantiate one of these. More
* precisely, this is instantiated by {@link
* ValidationProcessor#process(ProcessingReport, FullData)}.</p>
*
*/
@NotThreadSafe
@ParametersAreNonnullByDefault
Expand All @@ -71,7 +83,7 @@ public final class InstanceValidator
* Whatever the data, validation will end up validating, for a same pointer
* into the instance, the following pointers into the schema:
*
* "" -> "/oneOf/0" -> "/oneOf/1" -> "" <-- LOOP
* "" -> "/oneOf/0" -> "/oneOf/1" -> "/oneOf/0" <-- LOOP
*
* This is not a JSON Reference loop here, but truly a validation loop.
*
Expand All @@ -84,6 +96,13 @@ public final class InstanceValidator
private final Set<Equivalence.Wrapper<FullData>> visited
= Sets.newLinkedHashSet();

/**
* Constructor -- do not use directly!
*
* @param syntaxMessages the syntax message bundle
* @param validationMessages the validation message bundle
* @param keywordBuilder the keyword builder
*/
public InstanceValidator(final MessageBundle syntaxMessages,
final MessageBundle validationMessages,
final Processor<SchemaContext, ValidatorList> keywordBuilder)
Expand All @@ -98,22 +117,12 @@ public FullData process(final ProcessingReport report,
final FullData input)
throws ProcessingException
{
if (!visited.add(FULL_DATA_EQUIVALENCE.wrap(input))) {
final String errmsg
= validationMessages.getMessage("err.common.validationLoop");
final ArrayNode node = JacksonUtils.nodeFactory().arrayNode();
for (final Equivalence.Wrapper<FullData> e: visited)
//noinspection ConstantConditions
node.add(toJson(e.get()));
final ProcessingMessage message = input.newMessage()
.put("domain", "validation")
.setMessage(errmsg)
.putArgument("alreadyVisited", toJson(input))
.putArgument("instancePointer",
input.getInstance().getPointer().toString())
.put("validationPath", node);
throw new ProcessingException(message);
}
/*
* We don't want the same validation context to appear twice, see above
*/
if (!visited.add(FULL_DATA_EQUIVALENCE.wrap(input)))
throw new ProcessingException(validationLoopMessage(input));


/*
* Build a validation context, attach a report to it
Expand Down Expand Up @@ -169,25 +178,10 @@ public FullData process(final ProcessingReport report,
return input;
}

private ProcessingMessage collectSyntaxErrors(final ProcessingReport report)
@Override
public String toString()
{
/*
* OK, that's for issue #99 but that's ugly nevertheless.
*
* We want syntax error messages to appear in the exception text.
*/
final String msg = syntaxMessages.getMessage("core.invalidSchema");
final ArrayNode arrayNode = JacksonUtils.nodeFactory().arrayNode();
JsonNode node;
for (final ProcessingMessage message: report) {
node = message.asJson();
if ("syntax".equals(node.path("domain").asText()))
arrayNode.add(node);
}
final StringBuilder sb = new StringBuilder(msg);
sb.append("\nSyntax errors:\n");
sb.append(JacksonUtils.prettyPrint(arrayNode));
return new ProcessingMessage().setMessage(sb.toString());
return "instance validator";
}

private void processArray(final ProcessingReport report,
Expand All @@ -200,7 +194,8 @@ private void processArray(final ProcessingReport report,
final JsonNode schema = tree.getNode();
final JsonNode node = instance.getNode();

final JsonNode digest = ArraySchemaDigester.getInstance().digest(schema);
final JsonNode digest = ArraySchemaDigester.getInstance()
.digest(schema);
final ArraySchemaSelector selector = new ArraySchemaSelector(digest);

final int size = node.size();
Expand Down Expand Up @@ -248,21 +243,58 @@ private void processObject(final ProcessingReport report,
}
}

@Override
public String toString()
private ProcessingMessage validationLoopMessage(final FullData input)
{
return "instance validator";
final String errmsg
= validationMessages.getMessage("err.common.validationLoop");
final ArrayNode node = JacksonUtils.nodeFactory().arrayNode();
for (final Equivalence.Wrapper<FullData> e: visited)
//noinspection ConstantConditions
node.add(toJson(e.get()));
return input.newMessage()
.put("domain", "validation")
.setMessage(errmsg)
.putArgument("alreadyVisited", toJson(input))
.putArgument("instancePointer",
input.getInstance().getPointer().toString())
.put("validationPath", node);
}

private ProcessingMessage collectSyntaxErrors(final ProcessingReport report)
{
/*
* OK, that's for issue #99 but that's ugly nevertheless.
*
* We want syntax error messages to appear in the exception text.
*/
final String msg = syntaxMessages.getMessage("core.invalidSchema");
final ArrayNode arrayNode = JacksonUtils.nodeFactory().arrayNode();
JsonNode node;
for (final ProcessingMessage message: report) {
node = message.asJson();
if ("syntax".equals(node.path("domain").asText()))
arrayNode.add(node);
}
final StringBuilder sb = new StringBuilder(msg);
sb.append("\nSyntax errors:\n");
sb.append(JacksonUtils.prettyPrint(arrayNode));
return new ProcessingMessage().setMessage(sb.toString());
}

private static String toJson(final FullData data)
{
final SchemaTree tree = data.getSchema();
final URI baseUri = tree.getLoadingRef().getLocator();
final VariableMap vars = VariableMap.newBuilder().addScalarValue("ptr",
tree.getPointer()).freeze();
// TODO: there should be an easier way to do that...
final URITemplate template;
try {
template = new URITemplate(baseUri + "{+ptr}");
} catch (URITemplateParseException e) {
throw new IllegalStateException("wtf??", e);
}
try {
// TODO: there should be an easier way to do that...
final URITemplate template = new URITemplate(baseUri + "{+ptr}");
final VariableMap vars = VariableMap.newBuilder().addScalarValue(
"ptr", tree.getPointer()).freeze();
return template.toString(vars);
} catch (URITemplateException e) {
throw new IllegalStateException("wtf??", e);
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/github/fge/jsonschema/processors/validation/ObjectSchemaDigester.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
import java.util.Set;

/**
* JSON Schema digester for an {@link ObjectSchemaDigester}
* JSON Schema digester for an {@link ObjectSchemaSelector}
*/
public final class ObjectSchemaDigester
extends AbstractDigester
Expand Down

0 comments on commit cad70e5

Please sign in to comment.