Merge remote-tracking branch 'origin/master'

Author: isidore

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: maven
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

README.md

@@ -9,6 +9,8 @@
   * [Documentation](#documentation)
   * [Getting started](#getting-started)
   * [How to get it](#how-to-get-it)
+    * [Maven](#maven)
+    * [Gradle](#gradle)
   * [Podcasts](#podcasts)
   * [Examples](#examples)
   * [Approved File Artifacts](#approved-file-artifacts)
@@ -44,22 +46,34 @@ Approval Tests can be used for verifying objects that require more than a simple
 
 ## Getting started
 
-The best way to get started is download and open the [Starter Project](https://github.com/approvals/approvaltests.java.starterproject).  
-It is a maven project and can be imported into any editor.
+The best way to get started is download and open one of 
+* [Maven Starter Project](https://github.com/approvals/approvaltests.java.starterproject)
+* [Gradle Starter Project](https://github.com/approvals/approvaltests.java.starterproject.gradle)  
+It is a standard project and can be imported into any editor or IDE.
 
 
 ## How to get it
-It's on Maven Central, search for 'approvaltests'. If you're using Maven,
-add this to your pom file:
+It's on Maven Central, search for 'approvaltests'.
+
+### Maven 
+If you're using Maven, add this to your pom file:
 
 ``` xml
 <dependency>
     <groupId>com.approvaltests</groupId>
     <artifactId>approvaltests</artifactId>
-    <version>11.2.2</version>
+    <version>11.2.3</version>
 </dependency>
 ```
 
+### Gradle
+
+```gradle
+dependencies {
+    testImplementation("com.approvaltests:approvaltests:11.2.3")
+}
+```
+
 or [download the jars from maven central repository](https://repo1.maven.org/maven2/com/approvaltests/approvaltests/)
 
 [Video Tutorials](https://www.youtube.com/playlist?list=PLFBA98F47156EFAA9&feature=view_all)

approvaltests-util/src/main/java/com/spun/util/ArrayUtils.java

@@ -10,8 +10,10 @@
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.List;
+import java.util.Map;
 import java.util.Vector;
 
+import org.lambda.functions.Function0;
 import org.lambda.functions.Function1;
 import org.lambda.query.Queryable;
 
@@ -276,6 +278,18 @@ public static <T> T[] toArray(List<T> list, Class<T> type)
   {
     return Queryable.as(list, type).asArray();
   }
+  public static <KEY, VALUES, SPECIFIC_VALUE extends VALUES> SPECIFIC_VALUE getOrElse(Map<KEY, VALUES> fields,
+      KEY key, Function0<SPECIFIC_VALUE> defaultIfNotFound)
+  {
+    if (fields.containsKey(key))
+    {
+      return (SPECIFIC_VALUE) fields.get(key);
+    }
+    else
+    {
+      return defaultIfNotFound.call();
+    }
+  }
   public static class IterableWrapper<T> implements Iterable<T>
   {
     private final Iterator<T> iterator;

approvaltests/src/main/java/org/approvaltests/core/Options.java

@@ -1,109 +1,96 @@
 package org.approvaltests.core;
 
-import java.util.Optional;
+import java.util.HashMap;
+import java.util.Map;
 
 import org.approvaltests.Approvals;
 import org.approvaltests.ReporterFactory;
 import org.approvaltests.namer.ApprovalNamer;
 import org.approvaltests.namer.NamerWrapper;
 import org.approvaltests.scrubbers.NoOpScrubber;
 
+import com.spun.util.ArrayUtils;
+
 public class Options
 {
-  private Scrubber                          scrubber    = NoOpScrubber.INSTANCE;
-  private Optional<ApprovalFailureReporter> reporter    = Optional.empty();
-  private FileOptions                       fileOptions = new FileOptions();
+  private enum Fields {
+                       SCRUBBER, REPORTER, FILE_OPTIONS_FILE_EXTENSION, FILE_OPTIONS_NAMER;
+  }
+  private final Map<Fields, Object> fields = new HashMap<>();
   public Options()
   {
   }
   public Options(Scrubber scrubber)
   {
-    this.scrubber = scrubber;
+    fields.put(Fields.SCRUBBER, scrubber);
   }
   public Options(ApprovalFailureReporter reporter)
   {
-    this.reporter = Optional.ofNullable(reporter);
-  }
-  private Options(Scrubber scrubber, Optional<ApprovalFailureReporter> reporter, FileOptions fileOptions)
-  {
-    this.scrubber = scrubber;
-    this.reporter = reporter;
-    this.fileOptions = fileOptions;
+    fields.put(Fields.REPORTER, reporter);
   }
-  public Options(Options parent, FileOptions fileOptions)
+  private Options(Map<Fields, Object> fields, Fields key, Object value)
   {
-    this(parent.scrubber, parent.reporter, fileOptions);
+    this.fields.putAll(fields);
+    this.fields.put(key, value);
   }
   public ApprovalFailureReporter getReporter()
   {
-    return this.reporter.orElseGet(ReporterFactory::get);
+    return ArrayUtils.getOrElse(fields, Fields.REPORTER, ReporterFactory::get);
   }
   public Options withReporter(ApprovalFailureReporter reporter)
   {
-    return new Options(this.scrubber, Optional.ofNullable(reporter), fileOptions);
+    return new Options(fields, Fields.REPORTER, reporter);
   }
   public Options withScrubber(Scrubber scrubber)
   {
-    return new Options(scrubber, this.reporter, fileOptions);
+    return new Options(fields, Fields.SCRUBBER, scrubber);
   }
   public String scrub(String input)
   {
-    return scrubber.scrub(input);
+    return getScrubber().scrub(input);
+  }
+  private Scrubber getScrubber()
+  {
+    return ArrayUtils.getOrElse(fields, Fields.SCRUBBER, () -> NoOpScrubber.INSTANCE);
   }
   public FileOptions forFile()
   {
-    fileOptions.setParent(this);
-    return fileOptions;
+    return new FileOptions(this.fields);
   }
   public static class FileOptions
   {
-    private String         fileExtension = ".txt";
-    protected NamerWrapper approvalNamer = null;
-    protected Options      parent;
-    public FileOptions()
-    {
-    }
-    public FileOptions(String fileExtension)
-    {
-      this.fileExtension = fileExtension;
-    }
-    public FileOptions(NamerWrapper approvalNamer, String fileExtension)
-    {
-      this.approvalNamer = approvalNamer;
-      this.fileExtension = fileExtension;
-    }
-    public void setParent(Options parent)
+    private final Map<Fields, Object> fields;
+    public FileOptions(Map<Fields, Object> fields)
     {
-      this.parent = parent;
+      this.fields = fields;
     }
     public Options withExtension(String fileExtensionWithDot)
     {
       if (!fileExtensionWithDot.startsWith("."))
       {
         fileExtensionWithDot = "." + fileExtensionWithDot;
       }
-      FileOptions f = new FileOptions(this.approvalNamer, fileExtensionWithDot);
-      return new Options(parent, f);
+      return new Options(fields, Fields.FILE_OPTIONS_FILE_EXTENSION, fileExtensionWithDot);
     }
     public ApprovalNamer getNamer()
     {
-      return approvalNamer == null ? Approvals.createApprovalNamer() : approvalNamer;
+      return ArrayUtils.getOrElse(fields, Fields.FILE_OPTIONS_NAMER, Approvals::createApprovalNamer);
     }
     public String getFileExtension()
     {
-      return fileExtension;
+      return ArrayUtils.getOrElse(fields, Fields.FILE_OPTIONS_FILE_EXTENSION, () -> ".txt");
     }
     public Options withBaseName(String fileBaseName)
     {
       NamerWrapper approvalNamer = new NamerWrapper(() -> fileBaseName, getNamer());
-      FileOptions f = new FileOptions(approvalNamer, this.fileExtension);
-      return new Options(parent, f);
+      return new Options(fields, Fields.FILE_OPTIONS_NAMER, approvalNamer);
     }
     public Options withName(String fileBaseName, String extension)
     {
       NamerWrapper approvalNamer = new NamerWrapper(() -> fileBaseName, getNamer());
-      FileOptions f = new FileOptions(approvalNamer, extension);
-      return new Options(parent, f);
+      HashMap<Fields, Object> newFields = new HashMap<>(fields);
+      newFields.put(Fields.FILE_OPTIONS_FILE_EXTENSION, extension);
+      return new Options(newFields, Fields.FILE_OPTIONS_NAMER, approvalNamer);
     }
   }
 }

build/UpdateVersion.java

@@ -8,6 +8,8 @@ public static void main(String[] args) throws IOException {
     final String version = args[0];
     replaceTextInFile("README.md", "<version>\\d+.\\d+.\\d+</version>",
         "<version>" + version + "</version>");
+    replaceTextInFile("README.md", "com.approvaltests:approvaltests:\\d+.\\d+.\\d+",
+    "com.approvaltests:approvaltests:" + version);
   }
 
   private static void replaceTextInFile(String fileName, String regex, String replacement)