Merge remote-tracking branch 'origin/master'

Author: Ciobanu, Andrei-Nicolin (UK - EDC)

README.md

@@ -40,25 +40,38 @@ DZone Article(s):
 
 ### 1. Mocking Real-World Objects
 
-The library supports several ways of filling/mocking the "model layer" of your application with relevant data.
+The library supports several ways of filling/mocking the "model layer" of your application with relevant data. (*Note*: In the following examples `User` is a *custom* bean class from the "model layer").
 
 a) Using some "lambda magic" and referencing the setter methods:
 
 ```java
 MockNeat m = MockNeat.threadLocal();
 
-User user1 = m.filler(() -> new User())
+User user1 = m.filler(() -> new User()) // Object is created throught the supplier
               .setter(User::setUserName,m.users())
               .setter(User::setFirstName, m.names().first())
               .setter(User::setLastName, m.names().last())
               .setter(User::setCreated, m.localDates().thisYear().toUtilDate())
               .setter(User::setModified, m.localDates().thisMonth().toUtilDate())
-              .val();
+              .val(); // When val() is called all the setters are applied in order over the object created with the supplier
 
 // Output:
 // User{userName='toomjefferey', firstName='Lia', lastName='Noyd', created=Tue May 08 00:00:00 EEST 2018, modified=Fri Mar 23 00:00:00 EET 2018}
 ```
 
+Creating a `List<User>` is easy. We just collect the results using the `list()` method. Actually we can collect the results in a different structures and collections. Check the `MockUnit<T>` [interface documentation](https://github.com/nomemory/mockneat/wiki/MockUnit) for all the options:
+
+```java
+List<User> users = m.filler(() -> new User())
+                    .setter(User::setUserName,m.users())
+                    .setter(User::setFirstName, m.names().first())
+                    .setter(User::setLastName, m.names().last())
+                    .setter(User::setCreated, m.localDates().thisYear().toUtilDate())
+                    .setter(User::setModified, m.localDates().thisMonth().toUtilDate())
+                    .list(() -> new ArrayList<>(), 10) // Collecting all the results ina  List of 10 elements.
+                    .val();
+```
+
 b) Using reflection at setter level:
 
 ```java
@@ -68,13 +81,12 @@ User user2 = m.reflect(User.class)
               .field("lastName", m.names().last())
               .field("created", m.localDates().thisYear().toUtilDate())
               .field("modified", m.localDates().thisMonth().toUtilDate())
-              .val();
+              .val(); // Nohting happens until you call val()
 // Output:
 // User{userName='serelovella', firstName='Hassan', lastName='Reich', created=Sat Sep 15 00:00:00 EEST 2018, modified=Tue Mar 20 00:00:00 EET 2018}
+```
 
-```                      
-
-c) Using reflection at constructor level:
+c) Using reflection at constructor level. The invocation assumes a constructor having the exact set of arguments exists:
 
 ```java
 User user3 = m.constructor(User.class)
@@ -85,7 +97,7 @@ User user3 = m.constructor(User.class)
                         m.localDates().thisYear().toUtilDate(),
                         m.localDates().thisMonth().toUtilDate()
                       )
-              .val();
+              .val(); // Nothing happens until you call val()
 //Output:
 // User{userName='meetswipple', firstName='Florine', lastName='Buchmiller', created=Tue May 15 00:00:00 EEST 2018, modified=Wed Mar 14 00:00:00 EET 2018}
 ```
@@ -169,6 +181,25 @@ From under the couch and put her finger on her forehead. Her words seemed to reg
 
 ### 5. Fill-up complex structures
 
+Generate a "matrix" (`Integer[][]`) of "0" and "1":
+
+```java
+// Generating a matrix of random integers with 5 rows and 5 columns
+Integer[][] a = m.from(new Integer[]{0, 1})
+                 .array(() -> new Integer[5]) // Cols
+                 .array(() -> new Integer[5][]) // Rows
+                 .val();
+                 
+// Possible Output:
+// 1 1 1 0 1
+// 1 1 0 1 0
+// 1 1 1 0 0
+// 0 1 1 0 1
+// 0 1 1 1 1 
+```                     
+
+Filling-up a complex structure:
+
 ```java
 MockNeat mock = MockNeat.threadLocal();
 
@@ -188,3 +219,27 @@ Possible Output (figure that!):
 ```
 {3D2Ly=[{[1188658698, -57519401, -1864634426]=[2052830538, 366685266], [-133985978, -2085629065, 1907531435]=[1485192096, 605946545]}, {[450717932, -1027874751, -549281331]=[900908182, -1603177013], [742214495, -1457376922, 1024095212]=[86581883, 271158555]}], tTobl=[{[-1886416467, 548674791, -593491043]=[-1631835207, 127044558], [2070408663, 1969285421, 1886566844]=[2029888013, 1401655408]}, {[-2086648400, -305706082, -707025980]=[178357740, 1657815118], [235507533, 63522348, 1439128176]=[-1800049424, -1714421491]}], qIQLs=[{[1106366866, 663699257, 368333112]=[-1857289744, 600277178], [1526858982, -1690364246, 28655773]=[358915749, -1177167700]}, {[2006554761, -1416799941, -1912526788]=[-1768470769, 1934286466], [-1679536093, -1582849360, 35999417]=[1795480034, -705569340]}], w3LIX=[{[1859659934, 1564658075, -1996131138]=[-791077342, 1086818886], [1843489282, 423382881, 1587909770]=[-1350074159, -304332972]}, {[921761090, -376877683, 34301027]=[1680999098, 1039071483], [1696152588, 387405184, 363183726]=[1040085467, 1395835033]}]}
 ```
+
+### 6. Generating data that always match a certain (simple) regex:
+
+Generating a [`LOLs`](https://en.wikipedia.org/wiki/LOL) with varying levels of intensity:
+
+```java
+mock.regex("LO{1,15}L!").consume(10, (i, s) -> System.out.println(s));
+```
+
+Possible output:
+
+```
+LOOL!
+LOOOL!
+LOL!
+LOOL!
+LOL!
+LOL!
+LOOOOL!
+LOOOOOOOOOOL!
+LOL!
+LOOL!
+```
+