added Iterable implementation - currently iterates through .env file content only'

Author: Maskim Buryshynets

README.md

@@ -43,7 +43,7 @@ Here you can find the instructions for installing the library using various buil
 2. Add library dependency to you dependencies list
     ```groovy
     dependencies {
-        implementation 'com.github.arhor:java-dotenv-revised:0.1.4'
+        implementation 'com.github.arhor:java-dotenv-revised:0.1.5'
     }
     ```
 
@@ -65,7 +65,7 @@ Here you can find the instructions for installing the library using various buil
     <dependency>
         <groupId>com.github.arhor</groupId>
         <artifactId>java-dotenv-revised</artifactId>
-        <version>0.1.4</version>
+        <version>0.1.5</version>
     </dependency>
     ```
 

build.gradle

@@ -6,7 +6,7 @@ plugins {
 }
 
 group = 'com.github.arhor'
-version = '0.1.4'
+version = '0.1.5'
 
 sourceCompatibility = property('version.java')
 targetCompatibility = property('version.java')

src/main/java/io/github/arhor/dotenv/Dotenv.java

@@ -3,11 +3,13 @@
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
+import java.util.Iterator;
+import java.util.Map;
 
 /**
  * Interface representing loaded .env file.
  */
-public interface Dotenv {
+public interface Dotenv extends Iterable<Map.Entry<String, String>> {
 
     /**
      * Factory method returning {@link DotenvConfigurer} instance.
@@ -46,4 +48,8 @@ static DotenvConfigurer configure() {
      */
     @Nonnull
     String getRequired(@Nonnull String name) throws MissingPropertyException;
+
+    @Nonnull
+    @Override
+    Iterator<Map.Entry<String, String>> iterator();
 }

src/main/java/io/github/arhor/dotenv/DotenvImpl.java

@@ -1,8 +1,11 @@
 package io.github.arhor.dotenv;
 
+import org.jetbrains.annotations.NotNull;
+
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import java.util.HashMap;
+import java.util.Iterator;
 import java.util.LinkedHashSet;
 import java.util.Map;
 import java.util.Objects;
@@ -50,6 +53,12 @@ public String getRequired(@Nonnull final String name) throws MissingPropertyExce
         throw new MissingPropertyException(name);
     }
 
+    @NotNull
+    @Override
+    public Iterator<Map.Entry<String, String>> iterator() {
+        return properties.entrySet().stream().map(this::stringifyEntry).iterator();
+    }
+
     private String getPropertyThenClearSearchHistory(
         final String name,
         final String defaultValue,
@@ -82,7 +91,7 @@ private String getProperty(final String name) {
 
     private String findProperty(final String name) {
         final var property = configurer.isIncludeSystemVariables()
-            ? System.getenv().get(name)
+            ? System.getenv(name)
             : null;
         return ((property == null) || configurer.isReplaceSystemVariables())
             ? properties.getProperty(name)
@@ -132,4 +141,11 @@ private String findRefValue(final String refName) {
     private String currentSearchPath() {
         return String.join(" -> ", currentSearchHistory);
     }
+
+    private Map.Entry<String, String> stringifyEntry(final Map.Entry<Object, Object> it) {
+        final var key = it.getKey().toString();
+        final var value = it.getValue().toString();
+
+        return Map.entry(key, value);
+    }
 }

src/test/kotlin/io/github/arhor/dotenv/DotenvImplTest.kt

@@ -2,6 +2,7 @@ package io.github.arhor.dotenv
 
 import io.kotest.assertions.throwables.shouldThrowAny
 import io.kotest.core.spec.style.DescribeSpec
+import io.kotest.matchers.collections.shouldContainExactly
 import io.kotest.matchers.nulls.shouldBeNull
 import io.kotest.matchers.nulls.shouldNotBeNull
 import io.kotest.matchers.shouldBe
@@ -158,4 +159,18 @@ class DotenvImplTest : DescribeSpec({
                 .shouldHaveMessage("Cannot find property: 'missing_property'")
         }
     }
+
+    describe("Dotenv.iterator()") {
+        it("should return an iterator with only one expected entry") {
+            // given
+            val dotenv = Dotenv.configure().location("./directory").load()
+            val result = ArrayList<Map.Entry<String, String>>()
+
+            // when
+            dotenv.iterator().forEach(result::add)
+
+            // then
+            result.shouldContainExactly(java.util.Map.entry("test_key", "test_val"))
+        }
+    }
 })