|
| 1 | +#include <sourcemeta/blaze/documentation.h> |
| 2 | + |
| 3 | +#include <sourcemeta/blaze/alterschema.h> |
| 4 | + |
| 5 | +#include <sourcemeta/core/jsonschema.h> |
| 6 | + |
| 7 | +#include <cassert> // assert |
| 8 | +#include <utility> // std::move |
| 9 | + |
| 10 | +namespace sourcemeta::blaze { |
| 11 | + |
| 12 | +namespace { |
| 13 | + |
| 14 | +auto type_expression_of(const sourcemeta::core::JSON &schema) |
| 15 | + -> Documentation::Type::Expression { |
| 16 | + Documentation::Type::Expression expression; |
| 17 | + |
| 18 | + if (!schema.is_object()) { |
| 19 | + return expression; |
| 20 | + } |
| 21 | + |
| 22 | + if (schema.defines("enum") && schema.at("enum").is_array()) { |
| 23 | + Documentation::Type::Expression::Enumeration enumeration; |
| 24 | + for (const auto &value : schema.at("enum").as_array()) { |
| 25 | + enumeration.values.push_back(value); |
| 26 | + } |
| 27 | + expression.value = std::move(enumeration); |
| 28 | + return expression; |
| 29 | + } |
| 30 | + |
| 31 | + if (schema.defines("type") && schema.at("type").is_string()) { |
| 32 | + const auto &type{schema.at("type").to_string()}; |
| 33 | + if (type == "object") { |
| 34 | + expression.value = Documentation::Type::Expression::Object{}; |
| 35 | + } else if (type == "string") { |
| 36 | + expression.value = |
| 37 | + Documentation::Type::Expression::Primitive::String; |
| 38 | + } else if (type == "integer") { |
| 39 | + expression.value = |
| 40 | + Documentation::Type::Expression::Primitive::Integer; |
| 41 | + } else if (type == "number") { |
| 42 | + expression.value = |
| 43 | + Documentation::Type::Expression::Primitive::Number; |
| 44 | + } |
| 45 | + } |
| 46 | + |
| 47 | + return expression; |
| 48 | +} |
| 49 | + |
| 50 | +auto notes_of(const sourcemeta::core::JSON &schema) -> Documentation::Notes { |
| 51 | + Documentation::Notes notes; |
| 52 | + if (!schema.is_object()) { |
| 53 | + return notes; |
| 54 | + } |
| 55 | + if (schema.defines("title") && schema.at("title").is_string()) { |
| 56 | + notes.title = schema.at("title").to_string(); |
| 57 | + } |
| 58 | + if (schema.defines("description") && schema.at("description").is_string()) { |
| 59 | + notes.description = schema.at("description").to_string(); |
| 60 | + } |
| 61 | + if (schema.defines("default")) { |
| 62 | + notes.default_value = schema.at("default"); |
| 63 | + } |
| 64 | + return notes; |
| 65 | +} |
| 66 | + |
| 67 | +auto is_required_property(const sourcemeta::core::JSON &schema, |
| 68 | + const sourcemeta::core::JSON::String &property) |
| 69 | + -> bool { |
| 70 | + if (!schema.is_object() || !schema.defines("required") || |
| 71 | + !schema.at("required").is_array()) { |
| 72 | + return false; |
| 73 | + } |
| 74 | + for (const auto &item : schema.at("required").as_array()) { |
| 75 | + if (item.is_string() && item.to_string() == property) { |
| 76 | + return true; |
| 77 | + } |
| 78 | + } |
| 79 | + return false; |
| 80 | +} |
| 81 | + |
| 82 | +auto walk_schema(const sourcemeta::core::JSON &schema, const bool include_root) |
| 83 | + -> Documentation; |
| 84 | + |
| 85 | +auto walk_properties(const sourcemeta::core::JSON &schema, |
| 86 | + std::vector<Documentation::Row> &rows) -> void { |
| 87 | + if (!schema.is_object() || !schema.defines("properties") || |
| 88 | + !schema.at("properties").is_object()) { |
| 89 | + return; |
| 90 | + } |
| 91 | + |
| 92 | + for (const auto &entry : schema.at("properties").as_object()) { |
| 93 | + Documentation::Row row; |
| 94 | + row.path = "/" + entry.first; |
| 95 | + row.type.expression = type_expression_of(entry.second); |
| 96 | + row.notes = notes_of(entry.second); |
| 97 | + row.required = is_required_property(schema, entry.first); |
| 98 | + rows.push_back(std::move(row)); |
| 99 | + } |
| 100 | +} |
| 101 | + |
| 102 | +auto walk_any_of(const sourcemeta::core::JSON &schema, |
| 103 | + std::vector<Documentation::Section> &children) -> void { |
| 104 | + if (!schema.is_object() || !schema.defines("anyOf") || |
| 105 | + !schema.at("anyOf").is_array()) { |
| 106 | + return; |
| 107 | + } |
| 108 | + |
| 109 | + Documentation::Section section; |
| 110 | + section.label = "Any of"; |
| 111 | + for (const auto &branch : schema.at("anyOf").as_array()) { |
| 112 | + section.children.push_back(walk_schema(branch, false)); |
| 113 | + } |
| 114 | + children.push_back(std::move(section)); |
| 115 | +} |
| 116 | + |
| 117 | +auto walk_schema(const sourcemeta::core::JSON &schema, const bool include_root) |
| 118 | + -> Documentation { |
| 119 | + Documentation documentation; |
| 120 | + |
| 121 | + if (include_root) { |
| 122 | + Documentation::Row root; |
| 123 | + root.path = "(root)"; |
| 124 | + root.type.expression = type_expression_of(schema); |
| 125 | + root.notes = notes_of(schema); |
| 126 | + documentation.rows.push_back(std::move(root)); |
| 127 | + } |
| 128 | + |
| 129 | + walk_properties(schema, documentation.rows); |
| 130 | + walk_any_of(schema, documentation.children); |
| 131 | + |
| 132 | + return documentation; |
| 133 | +} |
| 134 | + |
| 135 | +} // namespace |
| 136 | + |
| 137 | +auto to_documentation(const sourcemeta::core::JSON &schema, |
| 138 | + const sourcemeta::core::SchemaWalker &walker, |
| 139 | + const sourcemeta::core::SchemaResolver &resolver) |
| 140 | + -> Documentation { |
| 141 | + // Canonicalize the schema for easier analysis |
| 142 | + sourcemeta::core::SchemaTransformer canonicalizer; |
| 143 | + sourcemeta::blaze::add(canonicalizer, |
| 144 | + sourcemeta::blaze::AlterSchemaMode::Canonicalizer); |
| 145 | + sourcemeta::core::JSON canonical{schema}; |
| 146 | + [[maybe_unused]] const auto canonicalized{canonicalizer.apply( |
| 147 | + canonical, walker, resolver, |
| 148 | + [](const auto &, const auto, const auto, const auto &, |
| 149 | + [[maybe_unused]] const auto applied) { assert(applied); })}; |
| 150 | + assert(canonicalized.first); |
| 151 | + |
| 152 | + // Frame the canonicalized schema with reference information |
| 153 | + sourcemeta::core::SchemaFrame frame{ |
| 154 | + sourcemeta::core::SchemaFrame::Mode::References}; |
| 155 | + frame.analyse(canonical, walker, resolver); |
| 156 | + |
| 157 | + return walk_schema(canonical, true); |
| 158 | +} |
| 159 | + |
| 160 | +} // namespace sourcemeta::blaze |
0 commit comments