Adding tests to verify examples from the Wiki

CONTRIBUTING.md

@@ -25,6 +25,13 @@ The command typically used to build the project is:
 ./gradlew clean spotlessApply build
 ```
 
+It doesn't hurt to go extra mile and ensure that your code is properly covered with tests by running mutation tests
+using:
+
+```shell
+./gradlew clean spotlessApply build pitest
+```
+
 > It is highly recommended to run this command before submitting a Pull Request to comply with code formatting rules.
 
 * [Official Gradle documentation](https://docs.gradle.org)

src/test/java/io/github/suppierk/inject/cookbook/CycleResolutionTest.java

@@ -0,0 +1,79 @@
+/*
+ * MIT License
+ *
+ * Copyright 2024 Roman Khlebnov
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the “Software”), to deal in the Software without
+ * restriction, including without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+ * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package io.github.suppierk.inject.cookbook;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
+
+import io.github.suppierk.inject.Injector;
+import jakarta.inject.Inject;
+import jakarta.inject.Provider;
+import java.util.function.Supplier;
+import org.junit.jupiter.api.Test;
+
+class CycleResolutionTest {
+  static class Hello implements Supplier<String> {
+    private final World world;
+
+    @Inject
+    Hello(World world) {
+      this.world = world;
+    }
+
+    @Override
+    public String get() {
+      return "Hello, ";
+    }
+
+    public String getComplete() {
+      return get() + world.get();
+    }
+  }
+
+  static class World implements Supplier<String> {
+    private final Provider<Hello> helloProvider;
+
+    @Inject
+    public World(Provider<Hello> helloProvider) {
+      this.helloProvider = helloProvider;
+    }
+
+    @Override
+    public String get() {
+      return "World!";
+    }
+
+    public String getComplete() {
+      return helloProvider.get().get() + get();
+    }
+  }
+
+  @Test
+  void example_must_work_as_expected() {
+    final Injector injector = Injector.injector().add(Hello.class).add(World.class).build();
+
+    assertNotEquals(injector.get(Hello.class).get(), injector.get(World.class).get());
+    assertEquals(injector.get(Hello.class).getComplete(), injector.get(World.class).getComplete());
+  }
+}

src/test/java/io/github/suppierk/inject/cookbook/DeclareAndConsumeDependencyTest.java

@@ -0,0 +1,64 @@
+/*
+ * MIT License
+ *
+ * Copyright 2024 Roman Khlebnov
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the “Software”), to deal in the Software without
+ * restriction, including without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+ * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package io.github.suppierk.inject.cookbook;
+
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
+
+import io.github.suppierk.inject.Injector;
+import jakarta.inject.Inject;
+import org.junit.jupiter.api.Test;
+
+class DeclareAndConsumeDependencyTest {
+  static class Value {
+    private final long time;
+
+    Value() {
+      this.time = System.nanoTime();
+    }
+
+    public long time() {
+      return time;
+    }
+  }
+
+  static class Consumer {
+    private final Value value;
+
+    @Inject
+    public Consumer(Value value) {
+      this.value = value;
+    }
+
+    public long get() {
+      return value.time();
+    }
+  }
+
+  @Test
+  void example_must_work_as_expected() {
+    final Injector injector = Injector.injector().add(Value.class).add(Consumer.class).build();
+
+    assertNotEquals(injector.get(Consumer.class).get(), injector.get(Consumer.class).get());
+  }
+}

src/test/java/io/github/suppierk/inject/cookbook/DeclareAndConsumeSingletonDependencyTest.java

@@ -0,0 +1,66 @@
+/*
+ * MIT License
+ *
+ * Copyright 2024 Roman Khlebnov
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the “Software”), to deal in the Software without
+ * restriction, including without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+ * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package io.github.suppierk.inject.cookbook;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import io.github.suppierk.inject.Injector;
+import jakarta.inject.Inject;
+import jakarta.inject.Singleton;
+import org.junit.jupiter.api.Test;
+
+class DeclareAndConsumeSingletonDependencyTest {
+  @Singleton
+  static class Value {
+    private final long time;
+
+    Value() {
+      this.time = System.nanoTime();
+    }
+
+    public long time() {
+      return time;
+    }
+  }
+
+  static class Consumer {
+    private final Value value;
+
+    @Inject
+    public Consumer(Value value) {
+      this.value = value;
+    }
+
+    public long get() {
+      return value.time();
+    }
+  }
+
+  @Test
+  void example_must_work_as_expected() {
+    final Injector injector = Injector.injector().add(Value.class).add(Consumer.class).build();
+
+    assertEquals(injector.get(Consumer.class).get(), injector.get(Consumer.class).get());
+  }
+}

src/test/java/io/github/suppierk/inject/cookbook/DeclareFactoryTest.java

@@ -0,0 +1,61 @@
+/*
+ * MIT License
+ *
+ * Copyright 2024 Roman Khlebnov
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the “Software”), to deal in the Software without
+ * restriction, including without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+ * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package io.github.suppierk.inject.cookbook;
+
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
+
+import io.github.suppierk.inject.Injector;
+import io.github.suppierk.inject.Provides;
+import jakarta.inject.Inject;
+import org.junit.jupiter.api.Test;
+
+class DeclareFactoryTest {
+  static class ValueProvider {
+    @Provides
+    Long time() {
+      return System.nanoTime();
+    }
+  }
+
+  static class Consumer {
+    private final Long value;
+
+    @Inject
+    public Consumer(Long value) {
+      this.value = value;
+    }
+
+    public long get() {
+      return value;
+    }
+  }
+
+  @Test
+  void example_must_work_as_expected() {
+    final Injector injector =
+        Injector.injector().add(ValueProvider.class).add(Consumer.class).build();
+
+    assertNotEquals(injector.get(Consumer.class).get(), injector.get(Consumer.class).get());
+  }
+}

src/test/java/io/github/suppierk/inject/cookbook/DeclareValueTest.java

@@ -0,0 +1,54 @@
+/*
+ * MIT License
+ *
+ * Copyright 2024 Roman Khlebnov
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the “Software”), to deal in the Software without
+ * restriction, including without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+ * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package io.github.suppierk.inject.cookbook;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import io.github.suppierk.inject.Injector;
+import jakarta.inject.Inject;
+import org.junit.jupiter.api.Test;
+
+class DeclareValueTest {
+  static class Consumer {
+    private final Long value;
+
+    @Inject
+    public Consumer(Long value) {
+      this.value = value;
+    }
+
+    public long get() {
+      return value;
+    }
+  }
+
+  @Test
+  void example_must_work_as_expected() {
+    final Long value = 42L;
+
+    final Injector injector = Injector.injector().add(value).add(Consumer.class).build();
+
+    assertEquals(injector.get(Consumer.class).get(), injector.get(Consumer.class).get());
+  }
+}