Gherkin-Utils - Java - Address issue #1662 - add a Java pretty print gherkin module

.circleci/config.yml

@@ -439,6 +439,23 @@ jobs:
           paths:
             - 'io/cucumber/gherkin'
 
+  gherkin-utils-java:
+    executor: docker-circleci-openjdk
+    steps:
+      - attach_workspace:
+          at: '~/cucumber'
+      - attach_workspace:
+          at: '~/.m2/repository'
+      - run:
+          name: gherkin-utils-java
+          command: |
+            cd gherkin-utils/java
+            make
+      - persist_to_workspace:
+          root: '~/.m2/repository'
+          paths:
+            - 'io/cucumber/gherkin'
+
   json-to-messages-java-testdata:
     executor: docker-circleci-openjdk
     steps:
@@ -734,6 +751,9 @@ workflows:
       - gherkin-java:
           requires:
             - messages-java
+      - gherkin-utils-java:
+          requires:
+            - messages-java
       - json-to-messages-java-testdata:
           requires:
             - prepare-parallel

.templates/java/scripts/check-jar.sh

@@ -8,11 +8,11 @@ set -uf -o pipefail
 check_jar() {
   jar="$1"
   module_name=$(xmlstarlet sel -N pom="http://maven.apache.org/POM/4.0.0"  -t -m "//pom:project.Automatic-Module-Name" -v . pom.xml)
-  module_path=$(echo $module_name | sed "s/\./\\\\\//g")
-  echo "Checking contents of ${jar}"
+  module_path=$(echo $module_name | sed "s/\./\\\\\//g" | sed "s/-/\\\\\//g")
+  echo "Checking contents of ${jar} to see if it matches pattern: ${module_path}"
   unshaded_classes=$(unzip -l ${jar} | grep -e "\.class" | rev | cut -d' ' -f1 | rev | grep -v "^$module_path")
   if [[ "${unshaded_classes}" != "" ]]; then
-    echo "Some classes in ${jar} are not in the io.cucumber package. Rename the classes or change the maven-shade-plugin configuration."
+    echo "Some classes in ${jar} are not in the expected package matching pattern ${module_path}. Rename the classes or change the maven-shade-plugin configuration."
     echo
     echo "${unshaded_classes}"
     exit 1

gherkin-utils/java/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,5 @@
+PLEASE DO NOT CREATE ISSUES IN THIS REPO.
+THIS REPO IS A READ-ONLY MIRROR.
+
+Create your issue in the Cucumber monorepo instead:
+https://github.com/cucumber/cucumber/issues

gherkin-utils/java/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+PLEASE DO NOT CREATE PULL REAUESTS IN THIS REPO.
+THIS REPO IS A READ-ONLY MIRROR.
+
+Create your pull request in the Cucumber monorepo instead:
+https://github.com/cucumber/cucumber/pulls

gherkin-utils/java/.gitignore

@@ -0,0 +1,17 @@
+.idea/
+*.iml
+target/
+release.properties
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+dependency-reduced-pom.xml
+.classpath
+.deps
+.project
+.settings/
+.tested*
+.compared
+.built
+.codegen
+# Approval tests
+acceptance/

gherkin-utils/java/.rsync

@@ -0,0 +1,4 @@
+../LICENSE LICENSE
+../../.templates/github/ .github/
+../../.templates/java/ .
+../testdata/ testdata/

gherkin-utils/java/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+Please read [CONTRIBUTING](https://github.com/cucumber/common/blob/main/CONTRIBUTING.md) first. You should clone
+the [cucumber/cucumber](https://github.com/cucumber/cucumber) repo if you want to contribute.
+
+## Run tests
+
+### Using make
+
+Just run `make` from this directory.
+
+### Using just Maven
+
+Just run `mvn clean test` from this directory.
+
+Keep in mind that this will only run unit tests. The acceptance tests are only run when you build with `make`.

gherkin-utils/java/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Cucumber Ltd, Nicholas DiPiazza
+
+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.

gherkin-utils/java/Makefile

@@ -0,0 +1 @@
+include default.mk

gherkin-utils/java/README.md

@@ -0,0 +1,5 @@
+# Gherkin Utilties for Java
+
+This contains a Java library with some common Utilties
+
+See [GherkinTest](src/test/java/io/cucumber/gherkin/utils/PrettyPrintGherkinDocumentTest.java) for sample usage.

gherkin-utils/java/default.mk

@@ -0,0 +1,77 @@
+# Please update /.templates/java/default.mk and sync:
+#
+#     source scripts/functions.sh && rsync_files
+#
+SHELL := /usr/bin/env bash
+JAVA_SOURCE_FILES = $(shell find . -name "*.java")
+IS_TESTDATA = $(findstring -testdata,${CURDIR})
+
+# https://stackoverflow.com/questions/2483182/recursive-wildcards-in-gnu-make
+rwildcard=$(foreach d,$(wildcard $(1:=/*)),$(call rwildcard,$d,$2) $(filter $(subst *,%,$2),$d))
+
+default: .tested
+.PHONY: default
+
+.codegen:
+	touch $@
+
+.tested: .tested-jar-check
+
+.tested-jar-check: .deps .built
+	./scripts/check-jar.sh $(JAR)
+	touch $@
+
+.built: pom.xml $(JAVA_SOURCE_FILES) .codegen
+	mvn install
+	touch $@
+
+.deps:
+	touch $@
+
+update-dependencies:
+	mvn versions:force-releases
+	mvn versions:use-latest-versions -Dmaven.version.rules=file://$(shell pwd)/maven-versions-rules.xml
+	ruby scripts/set_version_ranges.rb
+.PHONY: update-dependencies
+
+pre-release: update-version update-dependencies clean default
+.PHONY: pre-release
+
+update-version:
+ifdef NEW_VERSION
+	mvn versions:set -DnewVersion=$(NEW_VERSION) -DgenerateBackupPoms=false
+else
+	@echo -e "\033[0;31mNEW_VERSION is not defined. Can't update version :-(\033[0m"
+	exit 1
+endif
+.PHONY: update-version
+
+publish: .deps
+ifeq ($(IS_TESTDATA),-testdata)
+	# no-op
+else
+	mvn deploy -Psign-source-javadoc -DskipTests=true
+endif
+.PHONY: publish
+
+post-release:
+	scripts/post-release.sh
+.PHONY: post-release
+
+clean: clean-java
+.PHONY: clean
+
+clean-java:
+	rm -rf target .deps .tested* .built acceptance .codegen
+	mvn clean
+.PHONY: clean-java
+
+### COMMON stuff for all platforms
+
+BERP_VERSION = 1.3.0
+BERP_GRAMMAR = gherkin.berp
+
+define berp-generate-parser =
+-! dotnet tool list --tool-path /usr/bin | grep "berp\s*$(BERP_VERSION)" && dotnet tool update Berp --version $(BERP_VERSION) --tool-path /usr/bin
+berp -g $(BERP_GRAMMAR) -t $< -o $@ --noBOM
+endef

gherkin-utils/java/maven-versions-rules.xml

@@ -0,0 +1,9 @@
+<ruleset comparisonMethod="maven"
+         xmlns="http://mojo.codehaus.org/versions-maven-plugin/rule/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://mojo.codehaus.org/versions-maven-plugin/rule/2.0.0 http://mojo.codehaus.org/versions-maven-plugin/xsd/rule-2.0.0.xsd">
+  <ignoreVersions>
+    <ignoreVersion type="regex">.*pr.*</ignoreVersion>
+    <ignoreVersion type="regex">.*-rc.*</ignoreVersion>
+    <ignoreVersion type="regex">.*-M\d+</ignoreVersion>
+  </ignoreVersions>
+</ruleset>

gherkin-utils/java/pom.xml

@@ -0,0 +1,56 @@
+<?xml version="1.0"?>
+<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>
+  <groupId>io.cucumber</groupId>
+  <artifactId>gherkin-utils</artifactId>
+  <version>22.0.0</version>
+  <packaging>jar</packaging>
+  <name>Gherkin Utils</name>
+  <description>Gherkin utils for doing things such as walking a Gherkin tree or pretty printing Gherkin files.
+  </description>
+  <url>https://github.com/cucumber/common</url>
+
+  <properties>
+    <project.Automatic-Module-Name>io.cucumber.gherkin-utils</project.Automatic-Module-Name>
+    <maven.compiler.source>8</maven.compiler.source>
+    <maven.compiler.target>8</maven.compiler.target>
+  </properties>
+
+  <scm>
+    <connection>scm:git:git://github.com/cucumber/common.git</connection>
+    <developerConnection>scm:git:[email protected]:cucumber/common.git</developerConnection>
+    <url>git://github.com/cucumber/common.git</url>
+    <tag>HEAD</tag>
+  </scm>
+
+  <dependencies>
+    <dependency>
+      <groupId>io.cucumber</groupId>
+      <artifactId>gherkin</artifactId>
+      <version>21.0.0</version>
+    </dependency>
+
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-engine</artifactId>
+      <version>5.5.2</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <artifactId>maven-jar-plugin</artifactId>
+        <version>3.2.0</version>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <version>2.22.2</version>
+      </plugin>
+    </plugins>
+  </build>
+
+</project>

gherkin-utils/java/scripts/check-jar.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+#
+# Verifies that the jar doesn't have any non-"io.cucumber" classes. This might happen
+# if some dependencies are shaded, but some are forgotten.
+#
+set -uf -o pipefail
+
+check_jar() {
+  jar="$1"
+  module_name=$(xmlstarlet sel -N pom="http://maven.apache.org/POM/4.0.0"  -t -m "//pom:project.Automatic-Module-Name" -v . pom.xml)
+  module_path=$(echo $module_name | sed "s/\./\\\\\//g" | sed "s/-/\\\\\//g")
+  echo "Checking contents of ${jar} to see if it matches pattern: ${module_path}"
+  unshaded_classes=$(unzip -l ${jar} | grep -e "\.class" | rev | cut -d' ' -f1 | rev | grep -v "^$module_path")
+  if [[ "${unshaded_classes}" != "" ]]; then
+    echo "Some classes in ${jar} are not in the expected package matching pattern ${module_path}. Rename the classes or change the maven-shade-plugin configuration."
+    echo
+    echo "${unshaded_classes}"
+    exit 1
+  fi
+}
+
+find . -name "*.jar" | while read jar; do
+  check_jar "${jar}"
+done

gherkin-utils/java/scripts/post-release.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+#
+# Bumps the patch version and appends -SNAPSHOT
+#
+set -uf -o pipefail
+
+# Finding current version in Changelog is way simpler, as there may be multiple <version> nodes in pom.xml
+# Also extracting version with maven itself is a bit tedious
+if [[ $(cat "../CHANGELOG.md") =~ \[([0-9]+).([0-9]+).([0-9]+)\] ]]; then
+  MAJOR="${BASH_REMATCH[1]}"
+  MINOR="${BASH_REMATCH[2]}"
+  PATCH="${BASH_REMATCH[3]}"
+
+  NEW_VERSION="$MAJOR.$MINOR.$(( PATCH + 1))-SNAPSHOT"
+  mvn versions:set -DnewVersion=$NEW_VERSION -DgenerateBackupPoms=false
+  echo "Updated version in pom.xml to $NEW_VERSION"
+else
+  echo "Unable to find current version in CHANGELOG, please update pom.xml manually"
+  echo "Bump the patch version in the `pom.xml` and append `-SNAPSHOT` to it."
+  exit 1
+fi

gherkin-utils/java/scripts/set_version_ranges.rb

@@ -0,0 +1,12 @@
+require 'nokogiri'
+
+pom = File.open("pom.xml") { |f| Nokogiri::XML(f) }
+
+versions = pom.xpath("//xmlns:dependency/xmlns:version[../xmlns:groupId/text() = 'io.cucumber']")
+versions.each do |version|
+  return version unless version.content =~ /^\d+\.\d+\.\d+$/
+  major, minor, patch = version.content.split('.').map {|i| i.to_i}
+  version.content = "[#{major}.#{minor}.#{patch},#{major+1}.0.0)"
+end
+
+File.open("pom.xml", "w:UTF-8") { |f| f.write(pom.to_xml) }