Switch from Maven to a Gradle build.

Author: carlosame

.gitignore

@@ -7,7 +7,6 @@
 /javadoc.xml
 *.class
 /*.jardesc
-*.jar
 *.war
 *.ear
 /local.properties
@@ -17,5 +16,9 @@
 *.iml
 *.iws
 
-# Maven
+# Gradle
+**/.gradle
 /build/
+/buildSrc/build/
+
+/CHANGES.txt

README.md

@@ -1,6 +1,83 @@
 # css4j - agent module
 
-This provides user agent-related functionality to CSS4J. Licence is BSD 3-clause, but includes a file with another licence (see `LICENSES.txt`).
+This provides user agent-related functionality to CSS4J.
 
-Refer to the `css4j` or `css4j-dist` repositores for build instructions.
+[License](LICENSE.txt) is BSD 3-clause, but includes a file with another license
+(see [`LICENSES.txt`](LICENSES.txt)).
 
+<br/>
+
+## Java™ Runtime Environment requirements
+All the classes in the binary package have been compiled with a [Java compiler](https://adoptium.net/)
+set to 1.7 compiler compliance level, except the `module-info.java` file.
+
+Building this module requires JDK 11 or higher.
+
+<br/>
+
+## Build from source
+To build css4j-agent from the code that is currently at the Git repository, Java 11 or later is needed.
+You can run a variety of Gradle tasks with the Gradle wrapper (on Windows shells you can omit the `./`):
+
+- `./gradlew build` (normal build)
+- `./gradlew build publishToMavenLocal` (to install in local Maven repository)
+- `./gradlew lineEndingConversion` (to convert line endings of top-level text files to CRLF)
+- `./gradlew publish` (to deploy to a Maven repository, as described in the `publishing.repositories.maven` block of
+[build.gradle](https://github.com/css4j/css4j-agent/blob/1-stable/build.gradle))
+
+<br/>
+
+## Usage from a Gradle project
+If your Gradle project depends on css4j-agent, you can use this project's own Maven repository in a `repositories` section of
+your build file:
+```groovy
+repositories {
+    maven {
+        url "https://css4j.github.io/maven/"
+        mavenContent {
+            releasesOnly()
+        }
+        content {
+            includeGroup 'io.sf.carte'
+            includeGroup 'io.sf.jclf'
+        }
+    }
+}
+```
+please use this repository **only** for the artifact groups listed in the `includeGroup` statements.
+
+Then, in your `build.gradle` file:
+```groovy
+dependencies {
+    api "io.sf.carte:css4j-agent:${css4jAgentVersion}"
+}
+```
+where `css4jAgentVersion` would be defined in a `gradle.properties` file.
+
+<br/>
+
+## Software dependencies
+
+In case that you do not use a Gradle or Maven build (which would manage the
+dependencies according to the relevant `.module` or `.pom` files), the required
+and optional library packages are the following:
+
+### Compile-time dependencies
+
+- The [css4j](https://github.com/css4j/css4j/releases) library (and its transitive
+  dependencies); version 1.3.1 or higher (but below 2.x) is recommended.
+
+- The [validator.nu html5 parser](https://about.validator.nu/htmlparser/).
+
+- [SLF4J](http://www.slf4j.org/), which is a logging package.
+
+### Test dependencies
+
+- A recent version of [JUnit 4](https://junit.org/junit4/).
+
+- The [validator.nu html5 parser](https://about.validator.nu/htmlparser/).
+
+<br/>
+
+## Website
+For more information please visit https://css4j.github.io/

build.gradle

@@ -0,0 +1,237 @@
+plugins {
+	id 'java-library'
+	id 'maven-publish'
+	id 'de.jjohannes.extra-java-module-info' version '0.11'
+}
+
+group = 'io.sf.carte'
+version = '1.3.0'
+
+description = 'css4j-agent'
+
+dependencies {
+	api('io.sf.carte:css4j') {
+		version {
+			strictly '[1.3.0,2.0['
+			prefer '1.3.1'
+		}
+	}
+	api 'nu.validator:htmlparser:1.4.16'
+	/*
+	 * The next dependency is not required for compiling, but it was optional
+	 * in the core module and is mandatory for user agents. So it is set as a
+	 * mandatory dependency here.
+	 */
+	api('org.slf4j:slf4j-api') {
+		version {
+			require '[1.7.28,)'
+			prefer '1.7.35'
+		}
+	}
+	testImplementation(group: 'io.sf.carte', name: 'css4j', classifier: 'tests') {
+		version {
+			strictly '[1.3.0,2.0['
+			prefer '1.3.1'
+		}
+	}
+	testImplementation 'junit:junit:4.13.2'
+}
+
+extraJavaModuleInfo {
+	failOnMissingModuleInfo.set(false)
+	automaticModule('htmlparser-1.4.16.jar', 'htmlparser')
+	automaticModule('sac-1.3.jar', 'sac')
+}
+
+java {
+	sourceCompatibility = JavaVersion.VERSION_1_7
+	targetCompatibility = JavaVersion.VERSION_1_7
+	withJavadocJar()
+	withSourcesJar()
+}
+
+repositories {
+	maven {
+		url = uri('https://repo.maven.apache.org/maven2/')
+	}
+	maven {
+		url "https://css4j.github.io/maven/"
+		mavenContent {
+			releasesOnly()
+		}
+		content {
+			includeGroup 'io.sf.carte'
+			includeGroup 'io.sf.jclf'
+		}
+	}
+}
+
+sourceSets {
+	main {
+		java {
+			srcDirs = ['src']
+			includes += ["**/*.java"]
+		}
+		resources {
+			srcDirs = ['src']
+			excludes += ["**/*.java"]
+		}
+	}
+	test {
+		java {
+			srcDirs = ['junit']
+			includes += ["**/*.java"]
+		}
+		resources {
+			srcDirs = ['junit']
+			excludes += ["**/*.java"]
+		}
+	}
+}
+
+tasks.compileJava {
+	excludes += ['module-info.java']
+	modularity.inferModulePath = false
+}
+
+tasks.register('compileModuleInfo', JavaCompile) {
+	description = 'Compile module-info to Java 11 bytecode'
+	dependsOn tasks.compileJava
+	sourceCompatibility = JavaVersion.VERSION_11
+	targetCompatibility = JavaVersion.VERSION_11
+	source = sourceSets.main.java
+	classpath = sourceSets.main.compileClasspath
+	destinationDirectory = sourceSets.main.java.destinationDirectory
+	modularity.inferModulePath = true
+	includes = ['module-info.java']
+}
+
+classes.dependsOn compileModuleInfo
+
+// Check bytecode version, in case some other task screws it
+tasks.register('checkLegacyJava') {
+	description = 'Check that classes are Java 7 bytecode (except module-info)'
+	def classdir = sourceSets.main.output.classesDirs.files.stream().findAny().get()
+	def classfiles = fileTree(classdir).matching({it.exclude('module-info.class')}).files
+	doFirst() {
+		if (!classfiles.isEmpty()) {
+			def classfile = classfiles.stream().findAny().get()
+			if (classfile != null) {
+				def classbytes = classfile.bytes
+				def bcversion = classbytes[6] * 128 + classbytes[7]
+				if (bcversion != 51) {
+					throw new GradleException("Bytecode on " + classfile +
+							" is not valid Java 7. Version should be 51, instead is " + bcversion)
+				}
+			}
+		}
+	}
+}
+
+classes.finalizedBy checkLegacyJava
+
+tasks.register('lineEndingConversion', CRLFConvert) {
+	file "$rootDir/LICENSE.txt"
+	file "$rootDir/LICENSES.txt"
+	file "$rootDir/CHANGES.txt"
+	file "$rootDir/RELEASE_NOTES.md"
+}
+
+tasks.register('cleanBuildSrc') {
+	description = 'Clean the buildSrc directory'
+	doLast {
+		delete("$rootDir/buildSrc/build")
+	}
+}
+
+tasks.named('clean') {
+	finalizedBy('cleanBuildSrc')
+}
+
+tasks.withType(JavaCompile) {
+	options.encoding = 'UTF-8'
+}
+
+tasks.withType(Javadoc) {
+	options.addStringOption('Xdoclint:none', '-quiet')
+	options.addStringOption('encoding', 'UTF-8')
+	options.addStringOption('charset', 'UTF-8')
+	options.links 'https://docs.oracle.com/en/java/javase/11/docs/api/'
+}
+
+tasks.withType(AbstractArchiveTask).configureEach {
+	// Reproducible build
+	preserveFileTimestamps = false
+	reproducibleFileOrder = true
+	// Copy license file
+	dependsOn lineEndingConversion
+	from ('LICENSE.txt') {
+		into 'META-INF'
+	}
+	from ('LICENSES.txt') {
+		into 'META-INF'
+	}
+}
+
+tasks.withType(PublishToMavenRepository) { task ->
+	doFirst {
+		if (repository == publishing.repositories.getByName('mavenRepo')) {
+			logger.lifecycle "Deploying artifacts to \"${it.repository.url}\""
+		}
+	}
+}
+
+publishing {
+	publications {
+		maven(MavenPublication) {
+			description = 'css4j agent module'
+			from(components.java)
+			pom {
+				description = 'css4j agent module'
+				url = "https://github.com/css4j/css4j-agent/"
+				licenses {
+					license {
+						name = "BSD 3-clause license"
+						url = "https://css4j.github.io/LICENSE.txt"
+					}
+				}
+			}
+		}
+	}
+	repositories {
+		maven {
+			name = 'mavenRepo'
+			/*
+			 * The following section applies to the 'publish' task:
+			 *
+			 * If you plan to deploy to a repository, please configure the
+			 * 'mavenReleaseRepoUrl' and/or 'mavenSnapshotRepoUrl' properties
+			 * (for example in GRADLE_USER_HOME/gradle.properties).
+			 *
+			 * Otherwise, Gradle shall create a 'build/repository' subdirectory
+			 * at ${rootDir} and deploy there.
+			 *
+			 * Properties 'mavenRepoUsername' and 'mavenRepoPassword' can also
+			 * be set (generally from command line).
+			 */
+			def releasesUrl
+			def snapshotsUrl
+			if (project.hasProperty('mavenReleaseRepoUrl') && project.mavenReleaseRepoUrl) {
+				releasesUrl = mavenReleaseRepoUrl
+			} else {
+				releasesUrl = "${buildDir}/repository/releases"
+			}
+			if (project.hasProperty('mavenSnapshotRepoUrl') && project.mavenSnapshotRepoUrl) {
+				snapshotsUrl = mavenSnapshotRepoUrl
+			} else {
+				snapshotsUrl = "${buildDir}/repository/snapshots"
+			}
+			url = version.endsWith('-SNAPSHOT') ? snapshotsUrl : releasesUrl
+			if (project.hasProperty('mavenRepoUsername') &&
+					project.hasProperty('mavenRepoPassword')) {
+				credentials.username = mavenRepoUsername
+				credentials.password = mavenRepoPassword
+			}
+		}
+	}
+}

buildSrc/src/main/groovy/CRLFConvert.groovy

@@ -0,0 +1,43 @@
+import org.gradle.api.DefaultTask
+import org.gradle.api.tasks.TaskAction
+
+/**
+ * Converts line endings to CRLF (Windows)
+ * <p>
+ * Usage:
+ * </p>
+ * <code>
+ * tasks.register('lineEndingConversion', CRLFConvert) {
+ * 	file "path/to/file1.txt"
+ * 	file "path/to/fileN.txt"
+ * }
+ * </code>
+ */
+class CRLFConvert extends DefaultTask {
+
+	private static final String CRLF = "\r\n"
+	private static final String LF = "\n"
+
+	private files = []
+
+	@TaskAction
+	def action() {
+		files.each { path ->
+			File file = new File(path)
+			if (file.exists()) {
+				String content = file.text
+				String newContent = content.replaceAll(/\r\n/, LF)
+				newContent = newContent.replaceAll(/\n|\r/, CRLF)
+				if (content != newContent) {
+					file.write(newContent)
+				}
+			} else {
+				logger.warn('File ' + path + ' does not exist.')
+			}
+		}
+	}
+
+	def file(String path) {
+		this.files << path
+	}
+}

gradle/wrapper/gradle-wrapper.jar

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists