Rename spring-boot-3 to spring-boot.

It was a mistake to put the Spring version number in the library name.

Author: prdoyle

README.md

@@ -94,7 +94,7 @@ A read context is intended to be coarse-grained, for example covering an entire
 giving you "snapshot-at-start" semantics and protecting you from race conditions.
 It is an antipattern to use many small read contexts during the course of a single operation.
 
-If you're using Spring Boot 3, you can bring in `bosk-spring-boot-3`
+If you're using Spring Boot 3, you can bring in `bosk-spring-boot`
 and set the `bosk.web.maintenance-path` property to get an immediate HTTP REST API to view and edit your state tree.
 
 To modify state programmatically, use the `BoskDriver` interface:

bosk-spring-boot-3/README.md

@@ -1,35 +1,5 @@
 ## bosk-spring-boot-3
 
-This is the subproject for the published `bosk-spring-boot-3` library for
-Spring Boot support.
+This library is an older name for the `bosk-spring-boot` library.
 
-It offers the features described below.
-
-### Automatic read context
-
-[`ReadContextFilter`](src/main/java/works/bosk/spring/boot/ReadContextFilter.java)
-opens a _read context_ automatically for every `GET`, `HEAD`, and `OPTIONS` request.
-In many cases, this is sufficient that the application need never open its own read contexts,
-except for `POST` operations that are acting like a `GET` with a body,
-or background operations executed on a separate thread.
-
-This feature is enabled by default, and can be disabled by setting `bosk.web.read-context` to `false`.
-(Note, though, that if you have a situation where you need more control over read contexts,
-you can consider using `Bosk.supersedingReadContext()` rather than turning off automatic read contexts globally.)
-
-### Maintenance endpoints
-
-The [`MaintenanceEndpoints`](src/main/java/works/bosk/spring/boot/MaintenanceEndpoints.java) component
-registers HTTP endpoints giving direct `GET`, `PUT`, and `DELETE` access to the bosk state in JSON form.
-The endpoints have a prefix based on the `bosk.web.maintenance-path` setting,
-followed by the path of the node within the bosk state.
-They are intended for troubleshooting, manual operations,
-or integrating with external systems that need full control over the bosk state.
-
-The endpoints also support ETags via `If-Match` and `If-None-Match` headers,
-which exposes a limited ability to do conditional updates.
-Nodes participating in this feature must have a field called `revision` of type `Identifier`.
-Using the `If-` headers on such a node has the following effects:
-
-- `If-None-Match: *`: if the node already exists, no action is taken.
-- `If-Match: {ID}`: if the node does not exist, or its `revision` field has a different value, no action is taken.
+This library is deprecated for removal. Please use `bosk-spring-boot` instead.

bosk-spring-boot-3/build.gradle

@@ -1,8 +1,10 @@
 
 plugins {
-	id 'bosk.development'
 	id 'bosk.maven-publish'
-	id 'com.github.spotbugs' version '6.1.2'
+}
+
+dependencies {
+	api project(':bosk-spring-boot')
 }
 
 java {
@@ -19,14 +21,16 @@ compileTestJava {
 	options.release = null
 }
 
-dependencies {
-	api project(":bosk-jackson")
-	implementation 'org.springframework.boot:spring-boot-starter-web:3.4.3'
-	annotationProcessor "org.springframework.boot:spring-boot-configuration-processor:3.4.3"
-	testImplementation project(":bosk-testing")
-	testImplementation project(":lib-testing")
-}
-
 repositories {
 	mavenCentral()
 }
+
+publishing {
+	publications {
+		mavenJava(MavenPublication) {
+			description = '''
+				This library has been renamed. Please use bosk-spring-boot instead.
+			'''.stripIndent().trim()
+		}
+	}
+}

bosk-spring-boot-3/src/main/java/works/bosk/annotations/DeserializationPath.java

@@ -0,0 +1,43 @@
+package works.bosk.annotations;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.PARAMETER;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+/**
+ * On a field of a <code>StateTreeNode</code>, indicates that implicit references
+ * enclosed by that field should be constructed using the supplied path string as a prefix.
+ *
+ * <p>
+ * For example:
+ *
+ * <pre>
+ *     public class MyDTO implements StateTreeNode {
+ *        &#064;DeserializationPath("a/b/c")
+ *        MyObject field;
+ *     }
+ *
+ *     public record MyObject(
+ *         &#064;Self Reference&lt;MyObject> self,
+ *         Optional&lt;MyObject> nested
+ *     ) extends Entity {}
+ * </pre>
+ *
+ * If we deserialize an instance <code>x</code> of <code>MyDTO</code>, then
+ * the reference <code>x.field.self</code> will have a path of <code>"a/b/c"</code>,
+ * and <code>x.field.nested.get().self</code> will have a path of <code>"a/b/c/nested"</code>.
+ *
+ * <p>
+ * If the path contains parameters, their values will be taken from the
+ * binding environment on the
+ * <code>DeserializationScope</code>, which can be set using
+ * <code>StateTreeSerializer.overlayScope</code>.
+ */
+@Retention(RUNTIME)
+@Target({ FIELD, PARAMETER })
+public @interface DeserializationPath {
+	String value();
+}

bosk-spring-boot-3/src/main/java/works/bosk/annotations/Enclosing.java

@@ -0,0 +1,24 @@
+package works.bosk.annotations;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.PARAMETER;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+/**
+ * Marks a <code>Reference</code> parameter in an <code>Entity</code> constructor to indicate that the
+ * reference should point to an enclosing entity of the entity itself, as defined by
+ * <code>Reference.enclosingReference</code>.
+ *
+ * <p>
+ * Enclosing references are not serialized, and are created automatically during deserialization.
+ *
+ * @author Patrick Doyle
+ */
+@Retention(RUNTIME)
+@Target({ FIELD, PARAMETER })
+public @interface Enclosing {
+
+}

bosk-spring-boot-3/src/main/java/works/bosk/annotations/Hook.java

@@ -0,0 +1,20 @@
+package works.bosk.annotations;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+/**
+ * Marks a method to be registered as a hook
+ * for an object passed to <code>Bosk.registerHooks</code>.
+ */
+@Retention(RUNTIME)
+@Target(METHOD)
+public @interface Hook {
+	/**
+	 * The scope of the hook for this method.
+	 */
+	String value();
+}

bosk-spring-boot-3/src/main/java/works/bosk/annotations/Polyfill.java

@@ -0,0 +1,36 @@
+package works.bosk.annotations;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+import java.util.Optional;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+/**
+ * Marks a static final field in a <code>StateTreeNode</code> to indicate that it can be
+ * used as a default value for a given field, for backward compatibility with external
+ * systems that don't yet support the field.
+ *
+ * <p>
+ * This is not meant to be used just to supply default values for optional fields;
+ * that should be achieved by declaring the field {@link Optional}
+ * and calling {@link Optional#orElse} when the field is used.
+ * Rather, this is meant to be used <em>temporarily</em> with newly added fields
+ * to support systems that are not yet aware of those fields.
+ *
+ * <p>
+ * The existence of this annotation anywhere in a bosk state tree could add overhead
+ * to all bosk updates, even for unrelated parts of the state tree, so it's best to
+ * remove this once it's no longer needed.
+ *
+ * @author Patrick Doyle
+ */
+@Retention(RUNTIME)
+@Target({ FIELD })
+public @interface Polyfill {
+	/**
+	 * The names of the fields for which we're supplying a default value.
+	 */
+	String[] value();
+}

bosk-spring-boot-3/src/main/java/works/bosk/annotations/ReferencePath.java

@@ -0,0 +1,17 @@
+package works.bosk.annotations;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+/**
+ * For an interface passed to <code>Bosk.buildReferences</code>,
+ * this supplies the path string to be used to create the reference.
+ */
+@Retention(RUNTIME)
+@Target(METHOD)
+public @interface ReferencePath {
+	String value();
+}

bosk-spring-boot-3/src/main/java/works/bosk/annotations/Self.java

@@ -0,0 +1,23 @@
+package works.bosk.annotations;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.PARAMETER;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+/**
+ * Marks a <code>Reference</code> parameter in an <code>Entity</code> constructor to indicate that the
+ * reference should point to the entity itself.
+ *
+ * <p>
+ * Self-references are not serialized, and are created automatically during deserialization.
+ *
+ * @author Patrick Doyle
+ */
+@Retention(RUNTIME)
+@Target({ FIELD, PARAMETER })
+public @interface Self {
+
+}

bosk-spring-boot-3/src/main/java/works/bosk/annotations/VariantCaseMap.java

@@ -0,0 +1,12 @@
+package works.bosk.annotations;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+@Retention(RUNTIME)
+@Target({ FIELD }) // TODO: Also METHOD
+public @interface VariantCaseMap {
+}