refactor: remove pattern interface

It's not needed. Make it a record and validate the state properly. Add more validations for Ingredient.
refinedmods · Dec 31, 2024 · e7b6412 · e7b6412
1 parent 6db0078
commit e7b6412
Show file tree

Hide file tree

Showing 37 changed files with 755 additions and 836 deletions.
diff --git a/...rafting-api/src/main/java/com/refinedmods/refinedstorage/api/autocrafting/Ingredient.java b/...rafting-api/src/main/java/com/refinedmods/refinedstorage/api/autocrafting/Ingredient.java
@@ -1,21 +1,19 @@
 package com.refinedmods.refinedstorage.api.autocrafting;
 
+import com.refinedmods.refinedstorage.api.core.CoreValidations;
 import com.refinedmods.refinedstorage.api.resource.ResourceKey;
 
-import java.util.Collections;
 import java.util.List;
 
 public class Ingredient {
     private final long amount;
     private final List<ResourceKey> inputs;
 
     public Ingredient(final long amount, final List<? extends ResourceKey> inputs) {
+        CoreValidations.validateLargerThanZero(amount, "Amount must be larger than zero");
+        CoreValidations.validateNotEmpty(inputs, "Inputs cannot be empty");
         this.amount = amount;
-        this.inputs = Collections.unmodifiableList(inputs);
-    }
-
-    public boolean isEmpty() {
-        return inputs.isEmpty();
+        this.inputs = List.copyOf(inputs);
     }
 
     public int size() {
@@ -30,6 +28,10 @@ public ResourceKey get(final int index) {
         return inputs.get(index);
     }
 
+    public List<ResourceKey> getAll() {
+        return inputs;
+    }
+
     @Override
     public String toString() {
         return "Ingredient{"

diff --git a/...tocrafting-api/src/main/java/com/refinedmods/refinedstorage/api/autocrafting/Pattern.java b/...tocrafting-api/src/main/java/com/refinedmods/refinedstorage/api/autocrafting/Pattern.java
@@ -1,20 +1,18 @@
 package com.refinedmods.refinedstorage.api.autocrafting;
 
+import com.refinedmods.refinedstorage.api.core.CoreValidations;
 import com.refinedmods.refinedstorage.api.resource.ResourceAmount;
-import com.refinedmods.refinedstorage.api.resource.ResourceKey;
 
 import java.util.List;
-import java.util.Set;
 
 import org.apiguardian.api.API;
 
 @API(status = API.Status.STABLE, since = "2.0.0-milestone.4.6")
-public interface Pattern {
-    Set<ResourceKey> getInputResources();
-
-    Set<ResourceKey> getOutputResources();
-
-    List<Ingredient> getIngredients();
-
-    List<ResourceAmount> getOutputs();
+public record Pattern(List<Ingredient> ingredients, List<ResourceAmount> outputs) {
+    public Pattern(final List<Ingredient> ingredients, final List<ResourceAmount> outputs) {
+        CoreValidations.validateNotEmpty(ingredients, "Ingredients cannot be empty");
+        CoreValidations.validateNotEmpty(outputs, "Outputs cannot be empty");
+        this.ingredients = List.copyOf(ingredients);
+        this.outputs = List.copyOf(outputs);
+    }
 }
diff --git a/...rage/api/autocrafting/PatternBuilder.java → ...rage/api/autocrafting/PatternBuilder.java b/...rage/api/autocrafting/PatternBuilder.java → ...rage/api/autocrafting/PatternBuilder.java
@@ -37,7 +37,7 @@ public PatternBuilder output(final ResourceKey output, final long amount) {
     }
 
     public Pattern build() {
-        return new PatternImpl(ingredients, outputs.toArray(new ResourceAmount[0]));
+        return new Pattern(ingredients, outputs);
     }
 
     public class IngredientBuilder {

diff --git a/.../src/main/java/com/refinedmods/refinedstorage/api/autocrafting/PatternRepositoryImpl.java b/.../src/main/java/com/refinedmods/refinedstorage/api/autocrafting/PatternRepositoryImpl.java
@@ -1,5 +1,6 @@
 package com.refinedmods.refinedstorage.api.autocrafting;
 
+import com.refinedmods.refinedstorage.api.resource.ResourceAmount;
 import com.refinedmods.refinedstorage.api.resource.ResourceKey;
 
 import java.util.Collections;
@@ -13,25 +14,26 @@
 
 public class PatternRepositoryImpl implements PatternRepository {
     private final Set<Pattern> patterns = new HashSet<>();
-    private final Map<ResourceKey, PriorityQueue<PatternHolder>> patternsByOutput = new HashMap<>();
     private final Set<Pattern> patternsView = Collections.unmodifiableSet(patterns);
+    private final Map<ResourceKey, PriorityQueue<PatternHolder>> patternsByOutput = new HashMap<>();
     private final Set<ResourceKey> outputs = new HashSet<>();
+    private final Set<ResourceKey> outputsView = Collections.unmodifiableSet(outputs);
 
     @Override
     public void add(final Pattern pattern, final int priority) {
         patterns.add(pattern);
-        outputs.addAll(pattern.getOutputResources());
-        for (final ResourceKey output : pattern.getOutputResources()) {
-            patternsByOutput.computeIfAbsent(output, k -> new PriorityQueue<>(
+        pattern.outputs().forEach(output -> outputs.add(output.resource()));
+        for (final ResourceAmount output : pattern.outputs()) {
+            patternsByOutput.computeIfAbsent(output.resource(), k -> new PriorityQueue<>(
                 Comparator.comparingInt(PatternHolder::priority).reversed()
             )).add(new PatternHolder(pattern, priority));
         }
     }
 
     @Override
     public void update(final Pattern pattern, final int priority) {
-        for (final ResourceKey output : pattern.getOutputResources()) {
-            final PriorityQueue<PatternHolder> holders = patternsByOutput.get(output);
+        for (final ResourceAmount output : pattern.outputs()) {
+            final PriorityQueue<PatternHolder> holders = patternsByOutput.get(output.resource());
             if (holders == null) {
                 continue;
             }
@@ -43,19 +45,20 @@ public void update(final Pattern pattern, final int priority) {
     @Override
     public void remove(final Pattern pattern) {
         patterns.remove(pattern);
-        for (final ResourceKey output : pattern.getOutputResources()) {
-            final PriorityQueue<PatternHolder> holders = patternsByOutput.get(output);
+        for (final ResourceAmount output : pattern.outputs()) {
+            final PriorityQueue<PatternHolder> holders = patternsByOutput.get(output.resource());
             if (holders == null) {
                 continue;
             }
             holders.removeIf(holder -> holder.pattern.equals(pattern));
             if (holders.isEmpty()) {
-                patternsByOutput.remove(output);
+                patternsByOutput.remove(output.resource());
             }
             final boolean noOtherPatternHasThisOutput = patterns.stream()
-                .noneMatch(otherPattern -> otherPattern.getOutputResources().contains(output));
+                .noneMatch(otherPattern -> otherPattern.outputs().stream()
+                    .anyMatch(o -> o.resource().equals(output.resource())));
             if (noOtherPatternHasThisOutput) {
-                outputs.remove(output);
+                outputs.remove(output.resource());
             }
         }
     }
@@ -71,7 +74,7 @@ public List<Pattern> getByOutput(final ResourceKey output) {
 
     @Override
     public Set<ResourceKey> getOutputs() {
-        return outputs;
+        return outputsView;
     }
 
     @Override

diff --git a/...api/src/main/java/com/refinedmods/refinedstorage/api/autocrafting/calculation/Amount.java b/...api/src/main/java/com/refinedmods/refinedstorage/api/autocrafting/calculation/Amount.java
@@ -10,7 +10,7 @@ public long getTotal() {
     }
 
     static Amount of(final Pattern pattern, final ResourceKey resource, final long requestedAmount) {
-        final long amountPerIteration = pattern.getOutputs()
+        final long amountPerIteration = pattern.outputs()
             .stream()
             .filter(output -> output.resource().equals(resource))
             .mapToLong(ResourceAmount::amount)

diff --git a/.../main/java/com/refinedmods/refinedstorage/api/autocrafting/calculation/CraftingState.java b/.../main/java/com/refinedmods/refinedstorage/api/autocrafting/calculation/CraftingState.java
@@ -28,9 +28,7 @@ void extractFromStorage(final ResourceKey resource, final long amount) {
     }
 
     void addOutputsToInternalStorage(final Pattern pattern, final Amount amount) {
-        pattern.getOutputs().forEach(
-            output -> addOutputToInternalStorage(amount, output)
-        );
+        pattern.outputs().forEach(output -> addOutputToInternalStorage(amount, output));
     }
 
     private void addOutputToInternalStorage(final Amount amount, final ResourceAmount output) {

diff --git a/...c/main/java/com/refinedmods/refinedstorage/api/autocrafting/calculation/CraftingTree.java b/...c/main/java/com/refinedmods/refinedstorage/api/autocrafting/calculation/CraftingTree.java
@@ -58,10 +58,7 @@ CalculationResult calculate() {
             throw new PatternCycleDetectedException(pattern);
         }
         CalculationResult result = CalculationResult.SUCCESS;
-        for (final Ingredient ingredient : pattern.getIngredients()) {
-            if (ingredient.isEmpty()) {
-                continue;
-            }
+        for (final Ingredient ingredient : pattern.ingredients()) {
             final IngredientState ingredientState = new IngredientState(ingredient, craftingState);
             final CalculationResult ingredientResult = calculateIngredient(ingredientState);
             if (ingredientResult == CalculationResult.MISSING_RESOURCES) {

diff --git a/...src/main/java/com/refinedmods/refinedstorage/api/autocrafting/preview/PreviewBuilder.java b/...src/main/java/com/refinedmods/refinedstorage/api/autocrafting/preview/PreviewBuilder.java
@@ -29,7 +29,7 @@ private MutablePreviewItem get(final ResourceKey resource) {
     }
 
     public PreviewBuilder withPatternWithCycle(final Pattern pattern) {
-        this.outputsOfPatternWithCycle = pattern.getOutputs();
+        this.outputsOfPatternWithCycle = pattern.outputs();
         return this;
     }
 

diff --git a/...efinedmods/refinedstorage/api/autocrafting/preview/PreviewCraftingCalculatorListener.java b/...efinedmods/refinedstorage/api/autocrafting/preview/PreviewCraftingCalculatorListener.java
@@ -33,7 +33,7 @@ public static Preview calculatePreview(final CraftingCalculator calculator,
         try {
             calculator.calculate(resource, amount, listener);
         } catch (final PatternCycleDetectedException e) {
-            return new Preview(PreviewType.CYCLE_DETECTED, Collections.emptyList(), e.getPattern().getOutputs());
+            return new Preview(PreviewType.CYCLE_DETECTED, Collections.emptyList(), e.getPattern().outputs());
         } catch (final NumberOverflowDuringCalculationException e) {
             return new Preview(PreviewType.OVERFLOW, Collections.emptyList(), Collections.emptyList());
         }

diff --git a/...ing-api/src/test/java/com/refinedmods/refinedstorage/api/autocrafting/IngredientTest.java b/...ing-api/src/test/java/com/refinedmods/refinedstorage/api/autocrafting/IngredientTest.java
@@ -0,0 +1,79 @@
+package com.refinedmods.refinedstorage.api.autocrafting;
+
+import com.refinedmods.refinedstorage.api.resource.ResourceKey;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.assertj.core.api.ThrowableAssert;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+
+import static com.refinedmods.refinedstorage.api.autocrafting.ResourceFixtures.A;
+import static com.refinedmods.refinedstorage.api.autocrafting.ResourceFixtures.B;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+
+class IngredientTest {
+    @Test
+    void testIngredient() {
+        // Act
+        final Ingredient sut = new Ingredient(1, List.of(A, B));
+
+        // Assert
+        assertThat(sut.size()).isEqualTo(2);
+        assertThat(sut.getAmount()).isEqualTo(1);
+        assertThat(sut.get(0)).isEqualTo(A);
+        assertThat(sut.get(1)).isEqualTo(B);
+        assertThat(sut.getAll()).containsExactly(A, B);
+    }
+
+    @Test
+    void shouldCopyIngredients() {
+        // Arrange
+        final List<ResourceKey> outputs = new ArrayList<>();
+        outputs.add(A);
+
+        // Act
+        final Ingredient sut = new Ingredient(1, outputs);
+        outputs.add(B);
+
+        // Assert
+        assertThat(sut.size()).isEqualTo(1);
+        assertThat(sut.get(0)).isEqualTo(A);
+        assertThat(sut.getAll()).containsExactly(A);
+    }
+
+    @Test
+    void shouldNotBeAbleToModifyIngredients() {
+        // Arrange
+        final Ingredient sut = new Ingredient(1, List.of(A));
+        final List<ResourceKey> items = sut.getAll();
+
+        // Act
+        final ThrowableAssert.ThrowingCallable action = () -> items.add(B);
+
+        // Assert
+        assertThatThrownBy(action).isInstanceOf(UnsupportedOperationException.class);
+    }
+
+    @ParameterizedTest
+    @ValueSource(longs = {0, -1})
+    void shouldNotCreateIngredientWithInvalidAmount(final long amount) {
+        // Arrange
+        final ThrowableAssert.ThrowingCallable action = () -> new Ingredient(amount, List.of(A, B));
+
+        // Assert
+        assertThatThrownBy(action).isInstanceOf(IllegalArgumentException.class);
+    }
+
+    @Test
+    void shouldNotCreateIngredientWithEmptyInputs() {
+        // Act
+        final ThrowableAssert.ThrowingCallable action = () -> new Ingredient(1, List.of());
+
+        // Assert
+        assertThatThrownBy(action).isInstanceOf(IllegalArgumentException.class);
+    }
+}
diff --git a/...afting-api/src/test/java/com/refinedmods/refinedstorage/api/autocrafting/PatternImpl.java b/...afting-api/src/test/java/com/refinedmods/refinedstorage/api/autocrafting/PatternImpl.java