Merge

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [iluwatar]

.gitignore

@@ -16,5 +16,4 @@ datanucleus.log
 /bin/
 /bin/
 *.log
-data-mapper/src/main/resources/log4j.xml
 event-sourcing/Journal.json

.travis.yml

@@ -1,30 +1,29 @@
 language: java
+dist: bionic
 jdk:
-- oraclejdk8
+- openjdk11
+sudo: required
 
 env:
   global:
-  - GH_REF: github.com/iluwatar/java-design-patterns.git
-  - secure: LxTDuNS/rBWIvKkaEqr79ImZAe48mCdoYCF41coxNXgNoippo4GIBArknqtv+XvdkiuRZ1yGyj6pn8GU33c/yn+krddTUkVCwTbVatbalW5jhQjDbHYym/JcxaK9ZS/3JTeGcWrBgiPqHEEDhCf26vPZsXoMSeVCEORVKTp1BSg=
-  - secure: "eoWlW9GyTJY04P8K3pxayXwU9/hmptQg/LfirispQkV9YvmziCfSzXnatnBhNfud98sCzY8BScXnb+OWLTnjLKpId4rtEqb0aJ40Jc32cUKzgzFAUn7cNcDAbUIfyPAGVqyQqfj/11wYSADwWMMOPlW97ExUtoyiH2WenXuRHso="
-
-before_install:
-- export DISPLAY=:99.0
-- sh -e /etc/init.d/xvfb start
-
-# default install command is just "mvn install -DskipTests=true -Dmaven.javadoc.skip=true -B -V"
-install:
-- mvn install -DskipTests=true -Dmaven.javadoc.skip=true -B -V -e
+  - secure: "DCpazS3nkLnter3sguXEAS2fC/1ZWNfM+XLyif9MfNFxlZdpni2vCD/jA0Rdpga8puQWHNVLyAec+RPFH/2qSmJ1c1UTV5MaLv8tPqwUX0VFA+1I6XoSv6oX4ldHTBWHEWqQHkRFOLoil0h0edc0tTOWQwXF8U+DLAB+HkRb4gw="
 
-after_success:
-- mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent package sonar:sonar -Dsonar.host.url=https://sonarcloud.io -Dsonar.login=$SONAR_TOKEN
-- bash update-ghpages.sh
+services:
+- xvfb
 
-# use latest java version available instead of travis default
 addons:
-  apt:
-    packages:
-      - oracle-java8-installer
+  sonarcloud:
+    organization: "iluwatar"
+    token:
+      secure: "FpHwMYPMkdWU6CeIB7+O3qIeIM4vJMp47UjkKK53f0w0s6tPZofZZkab+gcL2TqKSil7sFVB/AQXU1cUubflRszwcLbNsc8H2yFehD79o0o0Mqd1Dd5ip/q0KQbHkkln+InFlVLfvrLB4Xd4mlQVxbGhqpULBhXjKzFzQlRFcuU="
+script:
+  # Because of Travis security restrictions, SonarCloud analysis cannot be run on pull requests originated from forks
+  # See https://docs.travis-ci.com/user/pull-requests/#pull-requests-and-security-restrictions
+  - 'if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then mvn clean verify; fi'
+  - 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then mvn clean verify sonar:sonar -Dsonar.projectKey=iluwatar_java-design-patterns -Dsonar.host.url=https://sonarcloud.io; fi'
+
+after_success:
+- bash update-website.sh
 
 notifications:
   email:
@@ -35,5 +34,3 @@ notifications:
     on_success: change  # options: [always|never|change] default: always
     on_failure: always  # options: [always|never|change] default: always
     on_start: never     # options: [always|never|change] default: always
-
-sudo: required

README.md

@@ -7,7 +7,7 @@
 [![Build status](https://travis-ci.org/iluwatar/java-design-patterns.svg?branch=master)](https://travis-ci.org/iluwatar/java-design-patterns)
 [![License MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/iluwatar/java-design-patterns/master/LICENSE.md)
 [![Join the chat at https://gitter.im/iluwatar/java-design-patterns](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/iluwatar/java-design-patterns?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=com.iluwatar%3Ajava-design-patterns&metric=alert_status)](https://sonarcloud.io/dashboard/index/com.iluwatar%3Ajava-design-patterns)
+[![Sonarcloud Status](https://sonarcloud.io/api/project_badges/measure?project=iluwatar_java-design-patterns&metric=alert_status)](https://sonarcloud.io/dashboard?id=iluwatar_java-design-patterns) 
 
 # Introduction
 
@@ -17,14 +17,21 @@ solve common problems when designing an application or system.
 Design patterns can speed up the development process by providing tested, proven
 development paradigms.
 
-Reusing design patterns help prevent subtle issues which cause major
+Reusing design patterns help prevent subtle issues that cause major
 problems, and it also improves code readability for coders and architects who
 are familiar with the patterns.
 
 # Getting started
 
+This site showcases Java Design Patterns. The solutions have been developed by
+experienced programmers and architects from the open source community. The 
+patterns can be browsed by their high level descriptions or by looking at their
+source code. The source code examples are well commented and can be thought as
+programming tutorials how to implement a specific pattern. We use the most
+popular battle-proven open source Java technologies.
+
 Before you dive into the material, you should be familiar with various
-Programming/Software Design Principles.
+software design principles.
 
 All designs should be as simple as possible. You should start with KISS, YAGNI,
 and Do The Simplest Thing That Could Possibly Work principles. Complexity and
@@ -35,12 +42,17 @@ Once you are familiar with these concepts you can start drilling down into
 patterns by any of the following approaches
 
  - Using difficulty tags, `Difficulty-Beginner`, `Difficulty-Intermediate` & `Difficulty-Expert`.
- - Using pattern categories, `Creational`, `Behavioral` and others.
+ - Using pattern categories, `Creational`, `Behavioral`, and others.
  - Search for a specific pattern. Can't find one? Please report a new pattern [here](https://github.com/iluwatar/java-design-patterns/issues).
 
+Hopefully you find the object oriented solutions presented on this site useful
+in your architectures and have as much fun learning them as we had developing them.
+
 # How to contribute
 
-If you are willing to contribute to the project you will find the relevant information in our [developer wiki](https://github.com/iluwatar/java-design-patterns/wiki). We will help you and answer your questions in the [Gitter chatroom](https://gitter.im/iluwatar/java-design-patterns).
+If you are willing to contribute to the project you will find the relevant information in 
+our [developer wiki](https://github.com/iluwatar/java-design-patterns/wiki). We will help 
+you and answer your questions in the [Gitter chatroom](https://gitter.im/iluwatar/java-design-patterns).
 
 # License
 

abstract-document/README.md

@@ -5,13 +5,13 @@ folder: abstract-document
 permalink: /patterns/abstract-document/
 categories: Structural
 tags: 
- - Java
- - Difficulty-Intermediate
+ - Extensibility
 ---
 
 ## Intent
 Achieve flexibility of untyped languages and keep the type-safety 
 
+## Class diagram
 ![alt text](./etc/abstract-document.png "Abstract Document Traits and Domain")
 
 
@@ -26,4 +26,4 @@ Use the Abstract Document Pattern when
 ## Credits
 
 * [Wikipedia: Abstract Document Pattern](https://en.wikipedia.org/wiki/Abstract_Document_Pattern)
-* [Martin Fowler: Dealing with properties](http://martinfowler.com/apsupp/properties.pdf)
+* [Martin Fowler: Dealing with properties](http://martinfowler.com/apsupp/properties.pdf)

abstract-document/etc/abstract-document.urm.puml

@@ -0,0 +1,65 @@
+@startuml
+package com.iluwatar.abstractdocument.domain.enums {
+  enum Property {
+    + MODEL {static}
+    + PARTS {static}
+    + PRICE {static}
+    + TYPE {static}
+    + valueOf(name : String) : Property {static}
+    + values() : Property[] {static}
+  }
+}
+package com.iluwatar.abstractdocument.domain {
+  class Car {
+    + Car(properties : Map<String, Object>)
+  }
+  interface HasModel {
+    + getModel() : Optional<String>
+  }
+  interface HasParts {
+    + getParts() : Stream<Part>
+  }
+  interface HasPrice {
+    + getPrice() : Optional<Number>
+  }
+  interface HasType {
+    + getType() : Optional<String>
+  }
+  class Part {
+    + Part(properties : Map<String, Object>)
+  }
+}
+package com.iluwatar.abstractdocument {
+  abstract class AbstractDocument {
+    - properties : Map<String, Object>
+    # AbstractDocument(properties : Map<String, Object>)
+    + children(key : String, constructor : Function<Map<String, Object>, T>) : Stream<T>
+    + get(key : String) : Object
+    + put(key : String, value : Object)
+    + toString() : String
+  }
+  class App {
+    - LOGGER : Logger {static}
+    + App()
+    + main(args : String[]) {static}
+  }
+  interface Document {
+    + children(String, Function<Map<String, Object>, T>) : Stream<T> {abstract}
+    + get(String) : Object {abstract}
+    + put(String, Object) {abstract}
+  }
+}
+AbstractDocument ..|> Document 
+Car ..|> HasModel 
+Car ..|> HasPrice 
+Car ..|> HasParts 
+Car --|> AbstractDocument 
+HasModel --|> Document 
+HasParts --|> Document 
+HasPrice --|> Document 
+HasType --|> Document 
+Part ..|> HasType 
+Part ..|> HasModel 
+Part ..|> HasPrice 
+Part --|> AbstractDocument 
+@enduml

abstract-document/pom.xml

@@ -1,47 +1,55 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!--
-
-    The MIT License
-    Copyright (c) 2014-2016 Ilkka Seppälä
-
-    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.
-
--->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-    <modelVersion>4.0.0</modelVersion>
-    <parent>
-        <artifactId>java-design-patterns</artifactId>
-        <groupId>com.iluwatar</groupId>
-        <version>1.21.0-SNAPSHOT</version>
-    </parent>
-    <artifactId>abstract-document</artifactId>
-    <dependencies>
-        <dependency>
-            <groupId>org.junit.jupiter</groupId>
-            <artifactId>junit-jupiter-api</artifactId>
-            <scope>test</scope>
-        </dependency>
-        <dependency>
-            <groupId>org.junit.jupiter</groupId>
-            <artifactId>junit-jupiter-engine</artifactId>
-            <scope>test</scope>
-        </dependency>
-    </dependencies>
-</project>
+<!-- The MIT License Copyright © 2014-2019 Ilkka Seppälä 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. -->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<parent>
+		<artifactId>java-design-patterns</artifactId>
+		<groupId>com.iluwatar</groupId>
+		<version>1.23.0-SNAPSHOT</version>
+	</parent>
+	<artifactId>abstract-document</artifactId>
+	<dependencies>
+		<dependency>
+			<groupId>org.junit.jupiter</groupId>
+			<artifactId>junit-jupiter-engine</artifactId>
+			<scope>test</scope>
+		</dependency>
+	</dependencies>
+	<build>
+		<plugins>
+			<!-- Maven assembly plugin is invoked with default setting which we have 
+				in parent pom and specifying the class having main method -->
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-assembly-plugin</artifactId>
+				<executions>
+					<execution>
+						<configuration>
+							<archive>
+								<manifest>
+									<mainClass>com.iluwatar.abstractdocument.App</mainClass>
+								</manifest>
+							</archive>
+						</configuration>
+					</execution>
+				</executions>
+			</plugin>
+		</plugins>
+	</build>
+</project>

abstract-document/src/main/java/com/iluwatar/abstractdocument/AbstractDocument.java

@@ -1,17 +1,17 @@
-/**
+/*
  * The MIT License
- * Copyright (c) 2014-2016 Ilkka Seppälä
- * <p>
+ * Copyright © 2014-2019 Ilkka Seppälä
+ *
  * 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:
- * <p>
+ *
  * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
- * <p>
+ *
  * 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
@@ -20,17 +20,18 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  * THE SOFTWARE.
  */
+
 package com.iluwatar.abstractdocument;
 
+import java.util.Collection;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
-import java.util.Optional;
 import java.util.function.Function;
 import java.util.stream.Stream;
 
 /**
- * Abstract implementation of Document interface
+ * Abstract implementation of Document interface.
  */
 public abstract class AbstractDocument implements Document {
 
@@ -54,17 +55,21 @@ public Object get(String key) {
 
   @Override
   public <T> Stream<T> children(String key, Function<Map<String, Object>, T> constructor) {
-    Optional<List<Map<String, Object>>> any = Stream.of(get(key)).filter(el -> el != null)
-        .map(el -> (List<Map<String, Object>>) el).findAny();
-    return any.isPresent() ? any.get().stream().map(constructor) : Stream.empty();
+    return Stream.ofNullable(get(key))
+        .filter(Objects::nonNull)
+        .map(el -> (List<Map<String, Object>>) el)
+        .findAny()
+        .stream()
+        .flatMap(Collection::stream)
+        .map(constructor);
   }
 
   @Override
   public String toString() {
-    StringBuilder builder = new StringBuilder();
+    var builder = new StringBuilder();
     builder.append(getClass().getName()).append("[");
-    properties.entrySet()
-        .forEach(e -> builder.append("[").append(e.getKey()).append(" : ").append(e.getValue()).append("]"));
+    properties.forEach((key, value) -> builder.append("[").append(key).append(" : ").append(value)
+        .append("]"));
     builder.append("]");
     return builder.toString();
   }