HBX-3022: Create 5 Minute Tutorial for Gradle"

This reverts commit ad87091.

Signed-off-by: Koen Aers <[email protected]>

Author: koentsje

gradle/docs/5-minute-tutorial.md

@@ -23,29 +23,61 @@ Hence we will provide a quick tutorial that gives you the first taste of it.
 Before tackling this tutorial, make sure you have the [Gradle](https://gradle.org) build tool 
 [installed](https://gradle.org/install/) and available on your machine.
 
-## Create a Simple Initial Gradle Java Project
+## Create a Gradle Java Project
 
-Let’s assume in this case that we start off with a very simple Gradle Java application
-that we create from a command-line window with the instructions below. 
+Let’s assume in this case that we start off with a very simple default Gradle Java application
+that we create from a command-line window with the instruction below. 
 
 ```shell
-mkdir 5-minute-tutorial
-cd 5-minute-tutorial
-echo "" > settings.gradle
+gradle init --type java-application --dsl groovy
 ```
 
-The last line above created an empty `settings.gradle` file. To use Gradle, we also need
-a `build.gradle` file.
+Gradle will ask you some details about your application. The conversation is shown below
+for completenes but of course you can make your own choices.
 
-## Create the  `build.gradle` file
+```shell
+Enter target Java version (min: 7, default: 21): 
 
-Add a `build.gradle` file to the `5-minute-tutorial` folder.
+Project name (default: 5-minute-tutorial): 
 
-```shell
-echo "" > build.gradle
+Select application structure:
+  1: Single application project
+  2: Application and library project
+Enter selection (default: Single application project) [1..2] 1
+
+Select test framework:
+  1: JUnit 4
+  2: TestNG
+  3: Spock
+  4: JUnit Jupiter
+Enter selection (default: JUnit Jupiter) [1..4] 4
+
+Generate build using new APIs and behavior (some features may change in the next minor release)? (default: no) [yes, no] 
+
+
+> Task :init
+Learn more about Gradle by exploring our Samples at https://docs.gradle.org/8.13/samples/sample_building_java_applications.html
+
+BUILD SUCCESSFUL in 19s
+1 actionable task: 1 executed
 ```
 
-Now edit the created emtpy file and add the following contents:
+Now you should see two folders along with a number of Gradle specific files that have 
+been created. It is beyond the scope of this short tutorial to explain all these artefacts.
+However, we will focus on the `build.gradle` file in the `app` folder.
+
+## Modify the generated `app\build.gradle` file
+
+We have to specify the use of the Gradle plugin in the `plugin` section of the `build.gradle` file.
+So we add `id('org.hibernate.tool.hibernate-tools-gradle') version '7.0.3.Final'` to that section.
+
+Also we need to depend on the java library containing the [H2 database]() drivers.
+This is done in the `dependencies` section of the `gradle.build` file, 
+to which we add `implementation('com.h2database:h2:2.3.232')`.
+To be able to look up this dependency, we add `mavenCentral()` to the `repositories` section 
+of the `gradle.build` file.
+
+The complete `gradle.build` file can look like the below.
 
 ```groovy
 plugins {
@@ -72,15 +104,7 @@ For the purpose of this tutorial introduction, let's assume that you have a data
 [H2 Sakila database](https://github.com/hibernate/sakila-h2) reacheable at the following JDBC URL:
 `jdbc:h2:tcp://localhost/./sakila`.
 
-With this set up, we create a `hibernate.properties` file in the `src/main/resources` folder
-as this is the default location where the Hibernate Gradle plugin will look for this file.
-
-```shell
-mkdir -p src/main/resources
-echo "" > src/main/resources/hibernate.properties
-```
-
-Now edit the `hibernate.properties` file so that it contains the properties as specified below.
+With this set up, the `hibernate.properties` file should contain the properties as specified below.
 
 ```properties
 hibernate.connection.driver_class=org.h2.Driver
@@ -90,25 +114,6 @@ hibernate.default_catalog=SAKILA
 hibernate.default_schema=PUBLIC
 ```
 
-Now we are ready to generate the entities.
-
-## Run the Reverse Engineering
-
-With all the previous elements in place, generating the Java classes from the Sakila database
-becomes as simple as issuing `gradle generateJava` in your command line window.
-
-```shell
-> Task :generateJava
-Starting Task 'generateJava'
-Creating Java exporter
-Loading the properties file : /Users/koen/temp/5-minute-tutorial/src/main/resources/hibernate.properties
-Properties file is loaded
-Starting Java export to directory: /Users/koen/temp/5-minute-tutorial/generated-sources...
-...
-Java export finished
-Ending Task 'generateJava'
-```
-
+For the file to be found by the plugin, add it as a resource to the project in the 
+`app/src/main/resources` subfolder.
 
-Congratulations! You have succesfully created Java classes for the Sakila database... Now it's
-probably time to dive somewhat deeper in the available functionality.

gradle/docs/examples/5-minute-tutorial/.gitattributes

@@ -0,0 +1,12 @@
+#
+# https://help.github.com/articles/dealing-with-line-endings/
+#
+# Linux start script should use lf
+/gradlew        text eol=lf
+
+# These are Windows script files and should use crlf
+*.bat           text eol=crlf
+
+# Binary files should be left untouched
+*.jar           binary
+

gradle/docs/examples/5-minute-tutorial/.gitignore

@@ -1 +1,5 @@
-generated-sources
+# Ignore Gradle project-specific cache directory
+.gradle
+
+# Ignore Gradle build output directory
+build

gradle/docs/examples/5-minute-tutorial/build.gradle renamed to gradle/docs/examples/5-minute-tutorial/app/build.gradle

@@ -0,0 +1,14 @@
+/*
+ * This source file was generated by the Gradle 'init' task
+ */
+package org.example;
+
+public class App {
+    public String getGreeting() {
+        return "Hello World!";
+    }
+
+    public static void main(String[] args) {
+        System.out.println(new App().getGreeting());
+    }
+}

gradle/docs/examples/5-minute-tutorial/app/src/main/java/org/example/App.java

@@ -0,0 +1,5 @@
+# This file was generated by the Gradle 'init' task.
+# https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_configuration_properties
+
+org.gradle.configuration-cache=true
+

gradle/docs/examples/5-minute-tutorial/src/main/resources/hibernate.properties renamed to gradle/docs/examples/5-minute-tutorial/app/src/main/resources/hibernate.properties

@@ -0,0 +1,10 @@
+# This file was generated by the Gradle 'init' task.
+# https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format
+
+[versions]
+guava = "33.3.1-jre"
+junit-jupiter = "5.11.3"
+
+[libraries]
+guava = { module = "com.google.guava:guava", version.ref = "guava" }
+junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit-jupiter" }