Merge branch 'lightbend:main' into formatting-optins

Author: kastoestoramadus

.github/workflows/ci.yml

@@ -2,6 +2,8 @@ name: CI
 on:
   pull_request:
   push:
+permissions:
+  contents: read
 jobs:
   test:
     runs-on: ubuntu-latest
@@ -14,12 +16,14 @@ jobs:
           - java: 11
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup JDK
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v4
         with:
           distribution: temurin
           java-version: ${{ matrix.java }}
+      - name: Setup sbt launcher
+        uses: sbt/setup-sbt@v1
       - name: Build and test
         shell: bash
         run: sbt -v test doc

.github/workflows/release.yml

@@ -0,0 +1,39 @@
+name: Release
+on:
+  push:
+    tags: ["v*"]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    if: github.repository == 'lightbend/config'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup JDK
+        uses: actions/setup-java@v2
+        with:
+          distribution: temurin
+          java-version: 11
+      - name: Setup SBT
+        run: |
+          # Make sure ca-certificates and gnupg are installed (often required for adding new repos)
+          sudo apt-get update
+          sudo apt-get install -y ca-certificates gnupg
+          
+          # Add the sbt repositories to apt sources
+          echo "deb https://repo.scala-sbt.org/scalasbt/debian all main" | sudo tee /etc/apt/sources.list.d/sbt.list
+          echo "deb https://repo.scala-sbt.org/scalasbt/debian /" | sudo tee /etc/apt/sources.list.d/sbt_old.list
+      
+          # Import the Scala SBT public key
+          curl -sL "https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x2EE0EA64E40A89B84B2DF73499E82A75642AC823" \
+            | sudo apt-key add -
+      
+          # Now update and install
+          sudo apt-get update
+          sudo apt-get install -y sbt
+      - env:
+          PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}
+          PGP_SECRET: ${{ secrets.PGP_SECRET }}
+          SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
+          SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
+        run: sbt ci-release

NEWS.md

@@ -1,3 +1,9 @@
+# 1.4.4: July 3, 2025
+
+- build: bump actions to get sbt ([#818](https://github.com/lightbend/config/pull/818)) thanks to [@johanandren]((https://github.com/johanandren))
+- build: second try for sbt back in CI job ([#820](https://github.com/lightbend/config/pull/820)) thanks to [@johanandren]((https://github.com/johanandren))
+- fix: Incorrect abs of hashes in BadMap ([#817](https://github.com/lightbend/config/pull/817)) thanks to [@johanandren]((https://github.com/johanandren))
+
 # 1.4.3: October 17, 2023
 
 - Optionally hide rendered environment variables ([#798](/../../pull/798))

README.md

@@ -101,12 +101,12 @@ You can find published releases on Maven Central.
     <dependency>
         <groupId>com.typesafe</groupId>
         <artifactId>config</artifactId>
-        <version>1.4.3</version>
+        <version>1.4.4</version>
     </dependency>
 
 sbt dependency:
 
-    libraryDependencies += "com.typesafe" % "config" % "1.4.3"
+    libraryDependencies += "com.typesafe" % "config" % "1.4.4"
 
 Link for direct download if you don't use a dependency manager:
 
@@ -921,7 +921,8 @@ format.
 
 #### Rust port
 
-  * https://github.com/mockersf/hocon.rs
+  * https://github.com/mockersf/hocon.rs (unmaintained)
+  * https://github.com/mikai233/hocon-rs
 
 #### Go port
 
@@ -936,7 +937,7 @@ format.
 
 #### Online playground
 
-   * https://hocon-playground.avelier.dev/
+   * https://hocon-playground.tehbrian.dev
 
 # Maintenance notes
 

build.sbt

@@ -1,9 +1,3 @@
-// to release, bump major/minor/micro as appropriate,
-// update NEWS, update version in README.md, tag, then
-// publishSigned.
-// Release tags should follow: http://semver.org/
-import scalariform.formatter.preferences._
-
 ThisBuild / git.baseVersion         := "1.4.0"
 ThisBuild / organization            := "com.typesafe"
 ThisBuild / Compile / scalacOptions := List("-unchecked", "-deprecation", "-feature")
@@ -25,11 +19,6 @@ ThisBuild / description             := "configuration library for JVM languages
 ThisBuild / licenses                := List("Apache-2.0" -> url("https://www.apache.org/licenses/LICENSE-2.0"))
 ThisBuild / homepage                := Option(url("https://github.com/lightbend/config"))
 ThisBuild / pomIncludeRepository    := { _ => false }
-ThisBuild / publishTo               := {
-  val nexus = "https://oss.sonatype.org/"
-  if ((ThisBuild / isSnapshot).value) Option("Sonatype OSS Snapshots" at nexus + "content/repositories/snapshots")
-  else Option("Sonatype OSS Staging" at nexus + "service/local/staging/deploy/maven2")
-}
 ThisBuild / publishMavenStyle       := true
 
 lazy val root = (project in file("."))
@@ -40,49 +29,39 @@ lazy val root = (project in file("."))
     simpleLibJava, simpleAppJava, complexAppJava
   )
   .settings(commonSettings)
-  .settings(nocomma {
-    name                                   := "config-root"
-    git.baseVersion                        := (ThisBuild / git.baseVersion).value
-    doc / aggregate                        := false
-    doc                                    := (configLib / Compile / doc).value
-    packageDoc / aggregate                 := false
+  .settings(
+    name                                   := "config-root",
+    git.baseVersion                        := (ThisBuild / git.baseVersion).value,
+    doc / aggregate                        := false,
+    doc                                    := (configLib / Compile / doc).value,
+    packageDoc / aggregate                 := false,
     packageDoc                             := (configLib / Compile / packageDoc).value
-    checkstyle / aggregate                 := false
-    checkstyle                             := (configLib / Compile / checkstyle).value
-    useGpg                                 := true
-    PgpKeys.publishSigned / aggregate      := false
-    PgpKeys.publishSigned                  := (PgpKeys.publishSigned in configLib).value
-    PgpKeys.publishLocalSigned / aggregate := false
-    PgpKeys.publishLocalSigned             := (PgpKeys.publishLocalSigned in configLib).value
-  })
+  )
 
 lazy val configLib =  Project("config", file("config"))
   .enablePlugins(SbtOsgi)
   .dependsOn(testLib % "test->test")
   .settings(osgiSettings)
-  .settings(nocomma {
-    autoScalaLibrary                       := false
-    crossPaths                             := false
-    libraryDependencies                    += "net.liftweb" %% "lift-json" % "3.3.0" % Test
-    libraryDependencies                    += "com.novocode" % "junit-interface" % "0.11" % Test
+  .settings(
+    autoScalaLibrary                       := false,
+    crossPaths                             := false,
+    libraryDependencies                    += "net.liftweb" %% "lift-json" % "3.3.0" % Test,
+    libraryDependencies                    += "com.novocode" % "junit-interface" % "0.11" % Test,
 
     Compile / compile / javacOptions       ++= Seq("-source", "1.8", "-target", "1.8",
-                                                   "-g", "-Xlint:unchecked")
+                                                   "-g", "-Xlint:unchecked"),
 
     Compile / doc / javacOptions           ++= Seq("-group", s"Public API (version ${version.value})", "com.typesafe.config:com.typesafe.config.parser",
-                                                   "-group", "Internal Implementation - Not ABI Stable", "com.typesafe.config.impl")
-    javadocSourceBaseUrl := {
-      for (gitHead <- com.typesafe.sbt.SbtGit.GitKeys.gitHeadCommit.value)
-        yield s"https://github.com/lightbend/config/blob/$gitHead/config/src/main/java"
-    }
+                                                   "-group", "Internal Implementation - Not ABI Stable", "com.typesafe.config.impl"),
+    javadocSourceBaseUrl := Some("https://github.com/lightbend/config/tree/main/config/src/main/java"),
     // because we test some global state such as singleton caches,
     // we have to run tests in serial.
-    Test / parallelExecution               := false
+    Test / parallelExecution               := false,
 
-    test / fork                            := true
-    Test / fork                            := true
-    run / fork                             := true
-    Test/ run / fork                       := true
+    test / fork                            := true,
+    Test / fork                            := true,
+    run / fork                             := true,
+    Test/ run / fork                       := true,
 
     //env vars for tests
     Test / envVars                         ++= Map("testList.0" -> "0",
@@ -99,63 +78,15 @@ lazy val configLib =  Project("config", file("config"))
       "SECRET_A" -> "A", // ConfigTest.renderShowEnvVariableValues
       "SECRET_B" -> "B", // ConfigTest.renderShowEnvVariableValues
       "SECRET_C" -> "C" // ConfigTest.renderShowEnvVariableValues
-    )
+    ),
 
-    OsgiKeys.exportPackage                 := Seq("com.typesafe.config", "com.typesafe.config.impl")
-    publish                                := sys.error("use publishSigned instead of plain publish")
-    publishLocal                           := sys.error("use publishLocalSigned instead of plain publishLocal")
+    OsgiKeys.exportPackage                 := Seq("com.typesafe.config", "com.typesafe.config.impl"),
     Compile / packageBin / packageOptions  +=
       Package.ManifestAttributes("Automatic-Module-Name" -> "typesafe.config" )
-    scalariformPreferences                 := scalariformPreferences.value
-      .setPreference(IndentSpaces, 4)
-      .setPreference(FirstArgumentOnNewline, Preserve)
-
-    checkstyleConfigLocation               := CheckstyleConfigLocation.File((baseDirectory.value / "checkstyle-config.xml").toString)
-
-    Compile / checkstyle := {
-      val log = streams.value.log
-      (Compile / checkstyle).value
-      val resultFile = (Compile / checkstyleOutputFile).value
-      val results = scala.xml.XML.loadFile(resultFile)
-      val errorFiles = results \\ "checkstyle" \\ "file"
-
-      def errorFromXml(node: scala.xml.NodeSeq): (String, String, String) = {
-        val line: String = (node \ "@line" text)
-        val msg: String = (node \ "@message" text)
-        val source: String = (node \ "@source" text)
-        (line, msg, source)
-      }
-      def errorsFromXml(fileNode: scala.xml.NodeSeq): Seq[(String, String, String, String)] = {
-        val name: String = (fileNode \ "@name" text)
-        val errors = (fileNode \\ "error") map { e => errorFromXml(e) }
-        errors map { case (line, error, source) => (name, line, error, source) }
-      }
-
-      val errors = errorFiles flatMap { f => errorsFromXml(f) }
-
-      if (errors.nonEmpty) {
-        for (e <- errors) {
-          log.error(s"${e._1}:${e._2}: ${e._3} (from ${e._4})")
-        }
-        throw new RuntimeException(s"Checkstyle failed with ${errors.size} errors")
-      }
-      log.info("No errors from checkstyle")
-    }
-
-    // add checkstyle as a dependency of doc
-    Compile / doc                          := ((Compile / doc).dependsOn(Compile / checkstyle)).value
-
-    findbugsReportType                     := Some(FindbugsReport.Html)
-    findbugsReportPath                     := Some(crossTarget.value / "findbugs.html")
-    findbugsEffort                         := FindbugsEffort.Maximum
-    findbugsMaxMemory                      := 2000
-  })
+  )
 
 lazy val commonSettings: Seq[Setting[_]] = Def.settings(
   unpublished,
-  scalariformPreferences := scalariformPreferences.value
-    .setPreference(IndentSpaces, 4)
-    .setPreference(FirstArgumentOnNewline, Preserve),
   Compile / compile / javacOptions ++= Seq("-source", "1.8", "-target", "1.8"),
 )
 

config/src/main/java/com/typesafe/config/Config.java

@@ -669,8 +669,7 @@ public interface Config extends ConfigMergeable {
      * Gets a value as a size in bytes (parses special strings like "128M"). If
      * the value is already a number, then it's left alone; if it's a string,
      * it's parsed understanding unit suffixes such as "128K", as documented in
-     * the <a
-     * href="https://github.com/lightbend/config/blob/main/HOCON.md">the
+     * <a href="https://github.com/lightbend/config/blob/main/HOCON.md">the
      * spec</a>.
      *
      * @param path
@@ -689,8 +688,7 @@ public interface Config extends ConfigMergeable {
      * Gets a value as an amount of memory (parses special strings like "128M"). If
      * the value is already a number, then it's left alone; if it's a string,
      * it's parsed understanding unit suffixes such as "128K", as documented in
-     * the <a
-     * href="https://github.com/lightbend/config/blob/main/HOCON.md">the
+     * <a href="https://github.com/lightbend/config/blob/main/HOCON.md">the
      * spec</a>.
      *
      * @since 1.3.0
@@ -710,9 +708,8 @@ public interface Config extends ConfigMergeable {
     /**
      * Get value as a duration in milliseconds. If the value is already a
      * number, then it's left alone; if it's a string, it's parsed understanding
-     * units suffixes like "10m" or "5ns" as documented in the <a
-     * href="https://github.com/lightbend/config/blob/main/HOCON.md">the
-     * spec</a>.
+     * units suffixes like "10m" or "5ns" as documented in
+     * <a href="https://github.com/lightbend/config/blob/main/HOCON.md">the spec</a>.
      *
      * @deprecated  As of release 1.1, replaced by {@link #getDuration(String, TimeUnit)}
      *
@@ -753,9 +750,8 @@ public interface Config extends ConfigMergeable {
      * {@link java.util.concurrent.TimeUnit TimeUnit}. If the value is already a
      * number, then it's taken as milliseconds and then converted to the
      * requested TimeUnit; if it's a string, it's parsed understanding units
-     * suffixes like "10m" or "5ns" as documented in the <a
-     * href="https://github.com/lightbend/config/blob/main/HOCON.md">the
-     * spec</a>.
+     * suffixes like "10m" or "5ns" as documented in
+     * <a href="https://github.com/lightbend/config/blob/main/HOCON.md">the spec</a>.
      * 
      * @since 1.2.0
      * 
@@ -777,9 +773,9 @@ public interface Config extends ConfigMergeable {
      * Gets a value as a java.time.Duration. If the value is
      * already a number, then it's taken as milliseconds; if it's
      * a string, it's parsed understanding units suffixes like
-     * "10m" or "5ns" as documented in the <a
-     * href="https://github.com/lightbend/config/blob/main/HOCON.md">the
-     * spec</a>. This method never returns null.
+     * "10m" or "5ns" as documented in
+     * <a href="https://github.com/lightbend/config/blob/main/HOCON.md">the spec</a>.
+     * This method never returns null.
      *
      * @since 1.3.0
      *
@@ -799,9 +795,9 @@ public interface Config extends ConfigMergeable {
      * Gets a value as a java.time.Period. If the value is
      * already a number, then it's taken as days; if it's
      * a string, it's parsed understanding units suffixes like
-     * "10d" or "5w" as documented in the <a
-     * href="https://github.com/lightbend/config/blob/main/HOCON.md">the
-     * spec</a>. This method never returns null.
+     * "10d" or "5w" as documented in
+     * <a href="https://github.com/lightbend/config/blob/main/HOCON.md">the spec</a>.
+     * This method never returns null.
      *
      * @since 1.3.0
      *
@@ -819,7 +815,7 @@ public interface Config extends ConfigMergeable {
 
     /**
      * Gets a value as a java.time.temporal.TemporalAmount.
-     * This method will first try get get the value as a java.time.Duration, and if unsuccessful,
+     * This method will first try to get the value as a java.time.Duration, and if unsuccessful,
      * then as a java.time.Period.
      * This means that values like "5m" will be parsed as 5 minutes rather than 5 months
      * @param path path expression

config/src/main/java/com/typesafe/config/ConfigFactory.java

@@ -618,9 +618,10 @@ public static Config systemProperties() {
      * <p>
      * Environment variables are mangled in the following way after stripping the prefix "CONFIG_FORCE_":
      * <table border="1">
+     *   <caption>environment variables</caption>
      * <tr>
-     *     <th bgcolor="silver">Env Var</th>
-     *     <th bgcolor="silver">Config</th>
+     *     <th>Env Var</th>
+     *     <th>Config</th>
      * </tr>
      * <tr>
      *     <td>_&nbsp;&nbsp;&nbsp;[1 underscore]</td>

config/src/main/java/com/typesafe/config/impl/BadMap.java

@@ -68,13 +68,13 @@ BadMap<K,V> copyingPut(K k, V v) {
     }
 
     private static <K,V> void store(Entry[] entries, int hash, K k, V v) {
-        int i = hash % entries.length;
+        int i = Math.abs(hash % entries.length);
         Entry old = entries[i];  // old may be null
         entries[i] = new Entry(hash, k, v, old);
     }
 
     private static void store(Entry[] entries, Entry e) {
-        int i = e.hash % entries.length;
+        int i = Math.abs(e.hash % entries.length);
         Entry old = entries[i]; // old may be null
         if (old == null && e.next == null) {
             // share the entry since it has no "next"
@@ -100,8 +100,8 @@ V get(K k) {
         if (entries.length == 0) {
             return null;
         } else {
-            int hash = Math.abs(k.hashCode());
-            int i = hash % entries.length;
+            int hash = k.hashCode();
+            int i = Math.abs(hash % entries.length);
             Entry e = entries[i];
             if (e == null)
                 return null;

config/src/main/java/com/typesafe/config/impl/package.html

@@ -6,7 +6,7 @@
 -->
 
 </head>
-<body bgcolor="white">
+<body>
 
 <p>
 Internal implementation details that can change ABI at any time.