Extract bundling logic into its own module

.github/workflows/website-build.yml

@@ -26,6 +26,7 @@ jobs:
           -DBLAZE_DOCUMENTATION:BOOL=OFF
           -DBLAZE_EDITOR:BOOL=OFF
           -DBLAZE_FOUNDATION:BOOL=OFF
+          -DBLAZE_BUNDLE:BOOL=OFF
           -DBLAZE_TESTS:BOOL=OFF
           -DBLAZE_DOCS:BOOL=ON
       - run: cmake --build ./build --config Release --target doxygen

.github/workflows/website-deploy.yml

@@ -37,6 +37,7 @@ jobs:
           -DBLAZE_DOCUMENTATION:BOOL=OFF
           -DBLAZE_EDITOR:BOOL=OFF
           -DBLAZE_FOUNDATION:BOOL=OFF
+          -DBLAZE_BUNDLE:BOOL=OFF
           -DBLAZE_TESTS:BOOL=OFF
           -DBLAZE_DOCS:BOOL=ON
       - run: cmake --build ./build --config Release --target doxygen

CMakeLists.txt

@@ -15,6 +15,7 @@ option(BLAZE_CODEGEN "Build the Blaze codegen library" ON)
 option(BLAZE_DOCUMENTATION "Build the Blaze documentation generator library" ON)
 option(BLAZE_EDITOR "Build the Blaze editor schema compatibility library" ON)
 option(BLAZE_FOUNDATION "Build the Blaze foundation JSON Schema library" ON)
+option(BLAZE_BUNDLE "Build the Blaze bundle library" ON)
 option(BLAZE_TESTS "Build the Blaze tests" OFF)
 option(BLAZE_BENCHMARK "Build the Blaze benchmarks" OFF)
 option(BLAZE_CONTRIB "Build the Blaze contrib programs" OFF)
@@ -51,6 +52,10 @@ if(BLAZE_FOUNDATION)
   add_subdirectory(src/foundation)
 endif()
 
+if(BLAZE_BUNDLE)
+  add_subdirectory(src/bundle)
+endif()
+
 if(BLAZE_COMPILER)
   add_subdirectory(src/compiler)
 endif()
@@ -137,6 +142,10 @@ if(BLAZE_TESTS)
     add_subdirectory(test/foundation)
   endif()
 
+  if(BLAZE_BUNDLE)
+    add_subdirectory(test/bundle)
+  endif()
+
   if(BLAZE_COMPILER)
     add_subdirectory(test/compiler)
   endif()

benchmark/CMakeLists.txt

@@ -1,6 +1,6 @@
 set(BENCHMARK_SOURCES)
 
-if(BLAZE_FOUNDATION)
+if(BLAZE_FOUNDATION AND BLAZE_BUNDLE)
   list(APPEND BENCHMARK_SOURCES foundation.cc)
 endif()
 
@@ -53,6 +53,10 @@ if(BENCHMARK_SOURCES)
     target_link_libraries(sourcemeta_blaze_benchmark
       PRIVATE sourcemeta::blaze::foundation)
   endif()
+  if(BLAZE_BUNDLE)
+    target_link_libraries(sourcemeta_blaze_benchmark
+      PRIVATE sourcemeta::blaze::bundle)
+  endif()
 
   add_custom_target(benchmark_all
     COMMAND sourcemeta_blaze_benchmark

benchmark/foundation.cc

@@ -4,7 +4,9 @@
 #include <filesystem> // std::filesystem
 #include <vector>     // std::vector
 
+#include <sourcemeta/blaze/bundle.h>
 #include <sourcemeta/blaze/foundation.h>
+
 #include <sourcemeta/core/json.h>
 #include <sourcemeta/core/uri.h>
 

config.cmake.in

@@ -14,6 +14,7 @@ if(NOT BLAZE_COMPONENTS)
   list(APPEND BLAZE_COMPONENTS codegen)
   list(APPEND BLAZE_COMPONENTS documentation)
   list(APPEND BLAZE_COMPONENTS editor)
+  list(APPEND BLAZE_COMPONENTS bundle)
 endif()
 
 include(CMakeFindDependencyMacro)
@@ -24,13 +25,15 @@ foreach(component ${BLAZE_COMPONENTS})
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_foundation.cmake")
   elseif(component STREQUAL "compiler")
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_foundation.cmake")
+    include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_bundle.cmake")
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_evaluator.cmake")
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_compiler.cmake")
   elseif(component STREQUAL "evaluator")
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_foundation.cmake")
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_evaluator.cmake")
   elseif(component STREQUAL "test")
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_foundation.cmake")
+    include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_bundle.cmake")
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_evaluator.cmake")
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_compiler.cmake")
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_test.cmake")
@@ -40,6 +43,7 @@ foreach(component ${BLAZE_COMPONENTS})
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_output.cmake")
   elseif(component STREQUAL "configuration")
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_foundation.cmake")
+    include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_bundle.cmake")
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_configuration.cmake")
   elseif(component STREQUAL "alterschema")
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_foundation.cmake")
@@ -49,6 +53,7 @@ foreach(component ${BLAZE_COMPONENTS})
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_alterschema.cmake")
   elseif(component STREQUAL "codegen")
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_foundation.cmake")
+    include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_bundle.cmake")
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_evaluator.cmake")
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_compiler.cmake")
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_output.cmake")
@@ -60,6 +65,9 @@ foreach(component ${BLAZE_COMPONENTS})
   elseif(component STREQUAL "editor")
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_foundation.cmake")
     include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_editor.cmake")
+  elseif(component STREQUAL "bundle")
+    include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_foundation.cmake")
+    include("${CMAKE_CURRENT_LIST_DIR}/sourcemeta_blaze_bundle.cmake")
   else()
     message(FATAL_ERROR "Unknown Blaze component: ${component}")
   endif()

doxygen/index.markdown

@@ -74,6 +74,7 @@ CMake
 | `BLAZE_DOCUMENTATION`       | Boolean | `ON`    | Build the Blaze documentation library   |
 | `BLAZE_EDITOR`              | Boolean | `ON`    | Build the Blaze editor library          |
 | `BLAZE_FOUNDATION`          | Boolean | `ON`    | Build the Blaze foundation library      |
+| `BLAZE_BUNDLE`              | Boolean | `ON`    | Build the Blaze bundle library          |
 | `BLAZE_TESTS`               | Boolean | `OFF`   | Build the Blaze tests                   |
 | `BLAZE_BENCHMARK`           | Boolean | `OFF`   | Build the Blaze benchmarks              |
 | `BLAZE_CONTRIB`             | Boolean | `OFF`   | Build the Blaze contrib programs        |

src/bundle/CMakeLists.txt

@@ -0,0 +1,16 @@
+sourcemeta_library(NAMESPACE sourcemeta PROJECT blaze NAME bundle
+  FOLDER "Blaze/Bundle"
+  SOURCES bundle.cc helpers.h)
+
+if(BLAZE_INSTALL)
+  sourcemeta_library_install(NAMESPACE sourcemeta PROJECT blaze NAME bundle)
+endif()
+
+target_link_libraries(sourcemeta_blaze_bundle PUBLIC
+  sourcemeta::core::json)
+target_link_libraries(sourcemeta_blaze_bundle PUBLIC
+  sourcemeta::core::jsonpointer)
+target_link_libraries(sourcemeta_blaze_bundle PUBLIC
+  sourcemeta::blaze::foundation)
+target_link_libraries(sourcemeta_blaze_bundle PRIVATE
+  sourcemeta::core::uri)

src/foundation/bundle.cc → src/bundle/bundle.cc

@@ -1,3 +1,5 @@
+#include <sourcemeta/blaze/bundle.h>
+
 #include <sourcemeta/blaze/foundation.h>
 
 #include "helpers.h"

src/bundle/helpers.h

@@ -0,0 +1,89 @@
+#ifndef SOURCEMETA_BLAZE_BUNDLE_HELPERS_H
+#define SOURCEMETA_BLAZE_BUNDLE_HELPERS_H
+
+#include <sourcemeta/blaze/foundation.h>
+
+#include <cassert>     // assert
+#include <string_view> // std::string_view
+
+namespace sourcemeta::blaze {
+
+inline auto id_keyword(const SchemaBaseDialect base_dialect)
+    -> std::string_view {
+  switch (base_dialect) {
+    case SchemaBaseDialect::JSON_Schema_2020_12:
+    case SchemaBaseDialect::JSON_Schema_2020_12_Hyper:
+    case SchemaBaseDialect::JSON_Schema_2019_09:
+    case SchemaBaseDialect::JSON_Schema_2019_09_Hyper:
+    case SchemaBaseDialect::JSON_Schema_Draft_7:
+    case SchemaBaseDialect::JSON_Schema_Draft_7_Hyper:
+    case SchemaBaseDialect::JSON_Schema_Draft_6:
+    case SchemaBaseDialect::JSON_Schema_Draft_6_Hyper:
+      return "$id";
+    case SchemaBaseDialect::JSON_Schema_Draft_4:
+    case SchemaBaseDialect::JSON_Schema_Draft_4_Hyper:
+    case SchemaBaseDialect::JSON_Schema_Draft_3:
+    case SchemaBaseDialect::JSON_Schema_Draft_3_Hyper:
+    case SchemaBaseDialect::JSON_Schema_Draft_2_Hyper:
+    case SchemaBaseDialect::JSON_Schema_Draft_1_Hyper:
+    case SchemaBaseDialect::JSON_Schema_Draft_0_Hyper:
+      return "id";
+  }
+
+  assert(false);
+  return "$id";
+}
+
+inline auto definitions_keyword(const SchemaBaseDialect base_dialect)
+    -> std::string_view {
+  switch (base_dialect) {
+    case SchemaBaseDialect::JSON_Schema_2020_12:
+    case SchemaBaseDialect::JSON_Schema_2020_12_Hyper:
+    case SchemaBaseDialect::JSON_Schema_2019_09:
+    case SchemaBaseDialect::JSON_Schema_2019_09_Hyper:
+      return "$defs";
+    case SchemaBaseDialect::JSON_Schema_Draft_7:
+    case SchemaBaseDialect::JSON_Schema_Draft_7_Hyper:
+    case SchemaBaseDialect::JSON_Schema_Draft_6:
+    case SchemaBaseDialect::JSON_Schema_Draft_6_Hyper:
+    case SchemaBaseDialect::JSON_Schema_Draft_4:
+    case SchemaBaseDialect::JSON_Schema_Draft_4_Hyper:
+    case SchemaBaseDialect::JSON_Schema_Draft_3:
+    case SchemaBaseDialect::JSON_Schema_Draft_3_Hyper:
+      return "definitions";
+    case SchemaBaseDialect::JSON_Schema_Draft_2_Hyper:
+    case SchemaBaseDialect::JSON_Schema_Draft_1_Hyper:
+    case SchemaBaseDialect::JSON_Schema_Draft_0_Hyper:
+      return "";
+  }
+
+  assert(false);
+  return "$defs";
+}
+
+// In older drafts, the presence of `$ref` would override any sibling keywords
+// See
+// https://json-schema.org/draft-07/draft-handrews-json-schema-01#rfc.section.8.3
+inline auto
+ref_overrides_adjacent_keywords(const SchemaBaseDialect base_dialect) -> bool {
+  switch (base_dialect) {
+    case SchemaBaseDialect::JSON_Schema_Draft_7:
+    case SchemaBaseDialect::JSON_Schema_Draft_7_Hyper:
+    case SchemaBaseDialect::JSON_Schema_Draft_6:
+    case SchemaBaseDialect::JSON_Schema_Draft_6_Hyper:
+    case SchemaBaseDialect::JSON_Schema_Draft_4:
+    case SchemaBaseDialect::JSON_Schema_Draft_4_Hyper:
+    case SchemaBaseDialect::JSON_Schema_Draft_3:
+    case SchemaBaseDialect::JSON_Schema_Draft_3_Hyper:
+    case SchemaBaseDialect::JSON_Schema_Draft_2_Hyper:
+    case SchemaBaseDialect::JSON_Schema_Draft_1_Hyper:
+    case SchemaBaseDialect::JSON_Schema_Draft_0_Hyper:
+      return true;
+    default:
+      return false;
+  }
+}
+
+} // namespace sourcemeta::blaze
+
+#endif

src/foundation/include/sourcemeta/blaze/foundation_bundle.h → src/bundle/include/sourcemeta/blaze/bundle.h

@@ -1,24 +1,31 @@
-#ifndef SOURCEMETA_BLAZE_FOUNDATION_BUNDLE_H
-#define SOURCEMETA_BLAZE_FOUNDATION_BUNDLE_H
+#ifndef SOURCEMETA_BLAZE_BUNDLE_H_
+#define SOURCEMETA_BLAZE_BUNDLE_H_
 
-#ifndef SOURCEMETA_BLAZE_FOUNDATION_EXPORT
-#include <sourcemeta/blaze/foundation_export.h>
+/// @defgroup bundle Bundle
+/// @brief Bundle JSON Schemas by inlining their external references.
+///
+/// This functionality is included as follows:
+///
+/// ```cpp
+/// #include <sourcemeta/blaze/bundle.h>
+/// ```
+
+#ifndef SOURCEMETA_BLAZE_BUNDLE_EXPORT
+#include <sourcemeta/blaze/bundle_export.h>
 #endif
 
 #include <sourcemeta/core/json.h>
 #include <sourcemeta/core/jsonpointer.h>
 
-// NOLINTBEGIN(misc-include-cleaner)
-#include <sourcemeta/blaze/foundation_frame.h>
-#include <sourcemeta/blaze/foundation_types.h>
-// NOLINTEND(misc-include-cleaner)
+#include <sourcemeta/blaze/foundation.h>
 
 #include <functional>  // std::function
+#include <optional>    // std::optional, std::nullopt
 #include <string_view> // std::string_view
 
 namespace sourcemeta::blaze {
 
-/// @ingroup foundation
+/// @ingroup bundle
 /// A callback to get dependency information
 /// - Origin URI (empty if none)
 /// - Pointer (reference keyword from the origin)
@@ -28,13 +35,14 @@ using DependencyCallback =
     std::function<void(std::string_view, const sourcemeta::core::WeakPointer &,
                        std::string_view, const sourcemeta::core::JSON &)>;
 
-/// @ingroup foundation
+/// @ingroup bundle
 ///
 /// This function recursively traverses and reports the external references in a
 /// schema. For example:
 ///
 /// ```cpp
 /// #include <sourcemeta/core/json.h>
+/// #include <sourcemeta/blaze/bundle.h>
 /// #include <sourcemeta/blaze/foundation.h>
 ///
 /// // A custom resolver that knows about an additional schema
@@ -66,7 +74,7 @@ using DependencyCallback =
 ///     // Do something with the information
 ///   });
 /// ```
-SOURCEMETA_BLAZE_FOUNDATION_EXPORT
+SOURCEMETA_BLAZE_BUNDLE_EXPORT
 auto dependencies(const sourcemeta::core::JSON &schema,
                   const SchemaWalker &walker, const SchemaResolver &resolver,
                   const DependencyCallback &callback,
@@ -75,14 +83,15 @@ auto dependencies(const sourcemeta::core::JSON &schema,
                   const SchemaFrame::Paths &paths = {
                       sourcemeta::core::empty_weak_pointer}) -> void;
 
-/// @ingroup foundation
+/// @ingroup bundle
 ///
 /// This function bundles a JSON Schema (starting from Draft 4) by embedding
 /// every remote reference into the top level schema resource, handling circular
 /// dependencies and more. This overload mutates the input schema.  For example:
 ///
 /// ```cpp
 /// #include <sourcemeta/core/json.h>
+/// #include <sourcemeta/blaze/bundle.h>
 /// #include <sourcemeta/blaze/foundation.h>
 /// #include <cassert>
 ///
@@ -124,7 +133,7 @@ auto dependencies(const sourcemeta::core::JSON &schema,
 ///
 /// assert(document == expected);
 /// ```
-SOURCEMETA_BLAZE_FOUNDATION_EXPORT
+SOURCEMETA_BLAZE_BUNDLE_EXPORT
 auto bundle(sourcemeta::core::JSON &schema, const SchemaWalker &walker,
             const SchemaResolver &resolver,
             std::string_view default_dialect = "",
@@ -134,7 +143,7 @@ auto bundle(sourcemeta::core::JSON &schema, const SchemaWalker &walker,
             const SchemaFrame::Paths &paths = {
                 sourcemeta::core::empty_weak_pointer}) -> void;
 
-/// @ingroup foundation
+/// @ingroup bundle
 ///
 /// This function bundles a JSON Schema (starting from Draft 4) by embedding
 /// every remote reference into the top level schema resource, handling circular
@@ -143,6 +152,7 @@ auto bundle(sourcemeta::core::JSON &schema, const SchemaWalker &walker,
 ///
 /// ```cpp
 /// #include <sourcemeta/core/json.h>
+/// #include <sourcemeta/blaze/bundle.h>
 /// #include <sourcemeta/blaze/foundation.h>
 /// #include <cassert>
 ///
@@ -185,7 +195,7 @@ auto bundle(sourcemeta::core::JSON &schema, const SchemaWalker &walker,
 ///
 /// assert(result == expected);
 /// ```
-SOURCEMETA_BLAZE_FOUNDATION_EXPORT
+SOURCEMETA_BLAZE_BUNDLE_EXPORT
 auto bundle(
     const sourcemeta::core::JSON &schema, const SchemaWalker &walker,
     const SchemaResolver &resolver, std::string_view default_dialect = "",

src/codegen/CMakeLists.txt

@@ -16,5 +16,7 @@ target_link_libraries(sourcemeta_blaze_codegen PUBLIC
   sourcemeta::core::json)
 target_link_libraries(sourcemeta_blaze_codegen PUBLIC
   sourcemeta::blaze::foundation)
+target_link_libraries(sourcemeta_blaze_codegen PRIVATE
+  sourcemeta::blaze::bundle)
 target_link_libraries(sourcemeta_blaze_codegen PRIVATE
   sourcemeta::blaze::alterschema)

src/codegen/codegen.cc

@@ -1,4 +1,5 @@
 #include <sourcemeta/blaze/alterschema.h>
+#include <sourcemeta/blaze/bundle.h>
 #include <sourcemeta/blaze/codegen.h>
 
 #include <algorithm>     // std::ranges::sort

src/compiler/CMakeLists.txt

@@ -26,5 +26,7 @@ target_link_libraries(sourcemeta_blaze_compiler PRIVATE
   sourcemeta::core::uri)
 target_link_libraries(sourcemeta_blaze_compiler PUBLIC
   sourcemeta::blaze::foundation)
+target_link_libraries(sourcemeta_blaze_compiler PRIVATE
+  sourcemeta::blaze::bundle)
 target_link_libraries(sourcemeta_blaze_compiler PUBLIC
   sourcemeta::blaze::evaluator)

src/compiler/compile.cc

@@ -1,6 +1,6 @@
+#include <sourcemeta/blaze/bundle.h>
 #include <sourcemeta/blaze/compiler.h>
 #include <sourcemeta/blaze/evaluator.h>
-
 #include <sourcemeta/blaze/foundation.h>
 
 #include <algorithm> // std::move, std::sort, std::unique

src/configuration/CMakeLists.txt

@@ -11,3 +11,4 @@ target_link_libraries(sourcemeta_blaze_configuration PRIVATE sourcemeta::core::u
 target_link_libraries(sourcemeta_blaze_configuration PRIVATE sourcemeta::core::io)
 target_link_libraries(sourcemeta_blaze_configuration PRIVATE sourcemeta::core::crypto)
 target_link_libraries(sourcemeta_blaze_configuration PRIVATE sourcemeta::blaze::foundation)
+target_link_libraries(sourcemeta_blaze_configuration PRIVATE sourcemeta::blaze::bundle)