remove last instance of Filter.encode()

implement $mod's codec
MorphiaOrg · Oct 15, 2023 · 2dfa71b · 2dfa71b
1 parent 168ea9a
commit 2dfa71b
Show file tree

Hide file tree

Showing 18 changed files with 143 additions and 96 deletions.
diff --git a/core/src/main/java/dev/morphia/aggregation/codecs/stages/GraphLookupCodec.java b/core/src/main/java/dev/morphia/aggregation/codecs/stages/GraphLookupCodec.java
@@ -5,6 +5,7 @@
 import dev.morphia.query.filters.Filter;
 
 import org.bson.BsonWriter;
+import org.bson.codecs.Codec;
 import org.bson.codecs.EncoderContext;
 import org.bson.codecs.configuration.CodecRegistry;
 
@@ -22,6 +23,7 @@ public Class<GraphLookup> getEncoderClass() {
         return GraphLookup.class;
     }
 
+    @SuppressWarnings({ "unchecked", "rawtypes" })
     @Override
     protected void encodeStage(BsonWriter writer, GraphLookup value, EncoderContext encoderContext) {
         document(writer, () -> {
@@ -41,7 +43,8 @@ protected void encodeStage(BsonWriter writer, GraphLookup value, EncoderContext
             if (restriction != null) {
                 document(writer, "restrictSearchWithMatch", () -> {
                     for (Filter filter : restriction) {
-                        filter.encode(getDatastore(), writer, encoderContext);
+                        Codec codec = getCodecRegistry().get(filter.getClass());
+                        codec.encode(writer, filter, encoderContext);
                     }
                 });
             }

diff --git a/core/src/main/java/dev/morphia/mapping/codec/CodecHelper.java b/core/src/main/java/dev/morphia/mapping/codec/CodecHelper.java
@@ -7,6 +7,7 @@
 import com.mongodb.lang.NonNull;
 import com.mongodb.lang.Nullable;
 
+import dev.morphia.MorphiaDatastore;
 import dev.morphia.aggregation.expressions.impls.Expression;
 import dev.morphia.aggregation.expressions.impls.SingleValuedExpression;
 import dev.morphia.annotations.internal.MorphiaInternal;
@@ -138,4 +139,35 @@ public static void value(CodecRegistry codecRegistry, BsonWriter writer, String
             encoderContext.encodeWithChildContext(codec, writer, value);
         }
     }
+
+    /**
+     * @hidden
+     * @morphia.internal
+     */
+    @MorphiaInternal
+    public static void namedValue(BsonWriter writer, MorphiaDatastore datastore, @Nullable String name, @Nullable Object value,
+            EncoderContext encoderContext) {
+        writer.writeName(name);
+        if (value != null) {
+            Codec codec = datastore.getCodecRegistry().get(value.getClass());
+            encoderContext.encodeWithChildContext(codec, writer, value);
+        } else {
+            writer.writeNull();
+        }
+    }
+
+    /**
+     * @hidden
+     * @morphia.internal
+     */
+    @MorphiaInternal
+    public static void unnamedValue(BsonWriter writer, MorphiaDatastore datastore, @Nullable Object value,
+            EncoderContext encoderContext) {
+        if (value != null) {
+            Codec codec = datastore.getCodecRegistry().get(value.getClass());
+            encoderContext.encodeWithChildContext(codec, writer, value);
+        } else {
+            writer.writeNull();
+        }
+    }
 }
diff --git a/core/src/main/java/dev/morphia/mapping/codec/ModFilterCodec.java b/core/src/main/java/dev/morphia/mapping/codec/ModFilterCodec.java
@@ -0,0 +1,33 @@
+package dev.morphia.mapping.codec;
+
+import dev.morphia.MorphiaDatastore;
+import dev.morphia.mapping.codec.filters.BaseFilterCodec;
+import dev.morphia.query.filters.ModFilter;
+
+import org.bson.BsonWriter;
+import org.bson.codecs.EncoderContext;
+
+import static dev.morphia.mapping.codec.CodecHelper.array;
+import static dev.morphia.mapping.codec.CodecHelper.document;
+import static dev.morphia.mapping.codec.CodecHelper.unnamedValue;
+
+public class ModFilterCodec extends BaseFilterCodec<ModFilter> {
+    public ModFilterCodec(MorphiaDatastore datastore) {
+        super(datastore);
+    }
+
+    @Override
+    public void encode(BsonWriter writer, ModFilter filter, EncoderContext context) {
+        document(writer, filter.path(datastore.getMapper()), () -> {
+            array(writer, filter.getName(), () -> {
+                unnamedValue(writer, datastore, filter.divisor(), context);
+                unnamedValue(writer, datastore, filter.remainder(), context);
+            });
+        });
+    }
+
+    @Override
+    public Class<ModFilter> getEncoderClass() {
+        return ModFilter.class;
+    }
+}
diff --git a/core/src/main/java/dev/morphia/mapping/codec/MorphiaFilterCodecProvider.java b/core/src/main/java/dev/morphia/mapping/codec/MorphiaFilterCodecProvider.java
@@ -43,6 +43,7 @@ public MorphiaFilterCodecProvider(MorphiaDatastore datastore) {
         addCodec(new GeoIntersectsFilterCodec(datastore));
         addCodec(new JsonSchemaFilterCodec(datastore));
         addCodec(new LogicalFilterCodec(datastore));
+        addCodec(new ModFilterCodec(datastore));
         addCodec(new NearFilterCodec(datastore));
         addCodec(new PolygonFilterCodec(datastore));
         addCodec(new RegexFilterCodec(datastore));

diff --git a/core/src/main/java/dev/morphia/mapping/codec/filters/BaseFilterCodec.java b/core/src/main/java/dev/morphia/mapping/codec/filters/BaseFilterCodec.java
@@ -1,17 +1,12 @@
 package dev.morphia.mapping.codec.filters;
 
-import com.mongodb.lang.Nullable;
-
 import dev.morphia.MorphiaDatastore;
-import dev.morphia.annotations.internal.MorphiaInternal;
 import dev.morphia.query.filters.Filter;
 import dev.morphia.sofia.Sofia;
 
 import org.bson.BsonReader;
-import org.bson.BsonWriter;
 import org.bson.codecs.Codec;
 import org.bson.codecs.DecoderContext;
-import org.bson.codecs.EncoderContext;
 
 public abstract class BaseFilterCodec<T extends Filter> implements Codec<T> {
     protected MorphiaDatastore datastore;
@@ -25,34 +20,4 @@ public final T decode(BsonReader reader, DecoderContext decoderContext) {
         throw new UnsupportedOperationException(Sofia.encodingOnly());
     }
 
-    /**
-     * @hidden
-     * @morphia.internal
-     */
-    @MorphiaInternal
-    protected void writeNamedValue(@Nullable String name, @Nullable Object value, MorphiaDatastore datastore, BsonWriter writer,
-            EncoderContext encoderContext) {
-        writer.writeName(name);
-        if (value != null) {
-            Codec codec = datastore.getCodecRegistry().get(value.getClass());
-            encoderContext.encodeWithChildContext(codec, writer, value);
-        } else {
-            writer.writeNull();
-        }
-    }
-
-    /**
-     * @hidden
-     * @morphia.internal
-     */
-    @MorphiaInternal
-    protected void writeUnnamedValue(@Nullable Object value, MorphiaDatastore datastore, BsonWriter writer, EncoderContext encoderContext) {
-        if (value != null) {
-            Codec codec = datastore.getCodecRegistry().get(value.getClass());
-            encoderContext.encodeWithChildContext(codec, writer, value);
-        } else {
-            writer.writeNull();
-        }
-    }
-
 }
diff --git a/core/src/main/java/dev/morphia/mapping/codec/filters/EqFilterCodec.java b/core/src/main/java/dev/morphia/mapping/codec/filters/EqFilterCodec.java
@@ -1,6 +1,7 @@
 package dev.morphia.mapping.codec.filters;
 
 import dev.morphia.MorphiaDatastore;
+import dev.morphia.mapping.codec.CodecHelper;
 import dev.morphia.query.filters.EqFilter;
 
 import org.bson.BsonWriter;
@@ -19,11 +20,11 @@ public void encode(BsonWriter writer, EqFilter filter, EncoderContext encoderCon
             document(writer, filter.path(datastore.getMapper()), () -> {
                 document(writer, "$not", () -> {
                     writer.writeName(filter.getName());
-                    writeUnnamedValue(filter.getValue(datastore), datastore, writer, encoderContext);
+                    CodecHelper.unnamedValue(writer, datastore, filter.getValue(datastore), encoderContext);
                 });
             });
         } else {
-            writeNamedValue(filter.path(datastore.getMapper()), filter.getValue(datastore), datastore, writer, encoderContext);
+            CodecHelper.namedValue(writer, datastore, filter.path(datastore.getMapper()), filter.getValue(datastore), encoderContext);
         }
 
     }

diff --git a/core/src/main/java/dev/morphia/mapping/codec/filters/FilterCodec.java b/core/src/main/java/dev/morphia/mapping/codec/filters/FilterCodec.java
@@ -1,6 +1,7 @@
 package dev.morphia.mapping.codec.filters;
 
 import dev.morphia.MorphiaDatastore;
+import dev.morphia.mapping.codec.CodecHelper;
 import dev.morphia.query.filters.Filter;
 
 import org.bson.BsonWriter;
@@ -18,10 +19,10 @@ public void encode(BsonWriter writer, Filter filter, EncoderContext encoderConte
         document(writer, filter.path(datastore.getMapper()), () -> {
             if (filter.isNot()) {
                 document(writer, "$not", () -> {
-                    writeNamedValue(filter.getName(), filter.getValue(datastore), datastore, writer, encoderContext);
+                    CodecHelper.namedValue(writer, datastore, filter.getName(), filter.getValue(datastore), encoderContext);
                 });
             } else {
-                writeNamedValue(filter.getName(), filter.getValue(datastore), datastore, writer, encoderContext);
+                CodecHelper.namedValue(writer, datastore, filter.getName(), filter.getValue(datastore), encoderContext);
             }
         });
     }

diff --git a/core/src/main/java/dev/morphia/mapping/codec/filters/NearFilterCodec.java b/core/src/main/java/dev/morphia/mapping/codec/filters/NearFilterCodec.java
@@ -1,6 +1,7 @@
 package dev.morphia.mapping.codec.filters;
 
 import dev.morphia.MorphiaDatastore;
+import dev.morphia.mapping.codec.CodecHelper;
 import dev.morphia.query.filters.NearFilter;
 
 import org.bson.BsonWriter;
@@ -31,7 +32,7 @@ public void encode(BsonWriter writer, NearFilter near, EncoderContext encoderCon
     private void encodeFilter(BsonWriter writer, NearFilter near, EncoderContext context) {
         document(writer, near.getName(), () -> {
             writer.writeName("$geometry");
-            writeUnnamedValue(near.getValue(datastore), datastore, writer, context);
+            CodecHelper.unnamedValue(writer, datastore, near.getValue(datastore), context);
             value(writer, "$maxDistance", near.maxDistance());
             value(writer, "$minDistance", near.minDistance());
             value(datastore.getCodecRegistry(), writer, "crs", near.crs(), context);

diff --git a/core/src/main/java/dev/morphia/mapping/codec/filters/SampleRateFilterCodec.java b/core/src/main/java/dev/morphia/mapping/codec/filters/SampleRateFilterCodec.java
@@ -2,6 +2,7 @@
 
 import dev.morphia.MorphiaDatastore;
 import dev.morphia.aggregation.expressions.SampleRateFilter;
+import dev.morphia.mapping.codec.CodecHelper;
 
 import org.bson.BsonWriter;
 import org.bson.codecs.EncoderContext;
@@ -13,7 +14,7 @@ public SampleRateFilterCodec(MorphiaDatastore datastore) {
 
     @Override
     public void encode(BsonWriter writer, SampleRateFilter filter, EncoderContext encoderContext) {
-        writeNamedValue(filter.getName(), filter.getValue(), datastore, writer, encoderContext);
+        CodecHelper.namedValue(writer, datastore, filter.getName(), filter.getValue(), encoderContext);
     }
 
     @Override

diff --git a/core/src/main/java/dev/morphia/query/filters/Filter.java b/core/src/main/java/dev/morphia/query/filters/Filter.java
@@ -63,18 +63,6 @@ public boolean isNot() {
         return not;
     }
 
-    /**
-     * @param datastore the datastore
-     * @param writer    the writer
-     * @param context   the context
-     * @hidden
-     * @morphia.internal
-     */
-    @Deprecated
-    public void encode(MorphiaDatastore datastore, BsonWriter writer, EncoderContext context) {
-        throw new UnsupportedOperationException();
-    }
-
     /**
      * Sets the query entity type on the filter
      *

diff --git a/core/src/main/java/dev/morphia/query/filters/GeoWithinFilter.java b/core/src/main/java/dev/morphia/query/filters/GeoWithinFilter.java
@@ -4,13 +4,8 @@
 import com.mongodb.client.model.geojson.MultiPolygon;
 import com.mongodb.client.model.geojson.Polygon;
 
-import dev.morphia.MorphiaDatastore;
 import dev.morphia.annotations.internal.MorphiaInternal;
 
-import org.bson.BsonWriter;
-import org.bson.codecs.Codec;
-import org.bson.codecs.EncoderContext;
-
 /**
  * Defines a $geoWithin filter.
  *
@@ -49,19 +44,4 @@ public GeoWithinFilter crs(CoordinateReferenceSystem crs) {
         return this;
     }
 
-    @Override
-    public final void encode(MorphiaDatastore datastore, BsonWriter writer, EncoderContext context) {
-        writer.writeStartDocument(path(datastore.getMapper()));
-        writer.writeStartDocument(getName());
-        writer.writeName("$geometry");
-
-        Object shape = getValue();
-        if (shape != null) {
-            Codec codec = datastore.getCodecRegistry().get(shape.getClass());
-            codec.encode(writer, shape, context);
-        }
-
-        writer.writeEndDocument();
-        writer.writeEndDocument();
-    }
 }
diff --git a/core/src/main/java/dev/morphia/query/filters/ModFilter.java b/core/src/main/java/dev/morphia/query/filters/ModFilter.java
@@ -1,11 +1,13 @@
 package dev.morphia.query.filters;
 
-import dev.morphia.MorphiaDatastore;
+import dev.morphia.annotations.internal.MorphiaInternal;
 
-import org.bson.BsonWriter;
-import org.bson.codecs.EncoderContext;
-
-class ModFilter extends Filter {
+/**
+ * @hidden
+ * @morphia.internal
+ */
+@MorphiaInternal
+public class ModFilter extends Filter {
     private final long divisor;
 
     private final long remainder;
@@ -16,14 +18,23 @@ public ModFilter(String field, long divisor, long remainder) {
         this.remainder = remainder;
     }
 
-    @Override
-    public void encode(MorphiaDatastore datastore, BsonWriter writer, EncoderContext context) {
-        writer.writeStartDocument(path(datastore.getMapper()));
-        writer.writeName(getName());
-        writer.writeStartArray();
-        writeValue(divisor, datastore, writer, context);
-        writeValue(remainder, datastore, writer, context);
-        writer.writeEndArray();
-        writer.writeEndDocument();
+    /**
+     * @hidden
+     * @morphia.internal
+     * @return the divisor
+     */
+    @MorphiaInternal
+    public long divisor() {
+        return divisor;
+    }
+
+    /**
+     * @hidden
+     * @morphia.internal
+     * @return the remainder
+     */
+    @MorphiaInternal
+    public long remainder() {
+        return remainder;
     }
 }
diff --git a/core/src/test/java/dev/morphia/test/TemplatedTestBase.java b/core/src/test/java/dev/morphia/test/TemplatedTestBase.java
@@ -51,7 +51,7 @@ public TemplatedTestBase(MorphiaConfig config) {
     }
 
     public final String prefix() {
-        String root = getClass().getSimpleName().substring(4);
+        String root = getClass().getSimpleName().replace("Test", "");
         return toLowerCase(root.charAt(0)) + root.substring(1);
     }