Merge pull request #185 from japgolly/topic/filter_by_key_and_source

Add ability to filter report tables by key & source

Author: japgolly

CHANGELOG.md

@@ -1,3 +1,12 @@
+### 3.3.0
+
+* When calling `report.map{Used,Unused}`:
+  * Added `filterKeysAndSource(f: (String, SourceName) => Boolean)`
+  * Added `filterKeysAndSourceNot(f: (String, SourceName) => Boolean)`
+  * Added `sources: SourceName*` to `filterKeys` to only filter keys for a given set of sources
+  * Added `sources: SourceName*` to `filterKeysNot` to only filter-not keys for a given set of sources
+  * Added `withoutKeys(keys: Set[String], sources: SourceName*)` to remove keys for a given set of sources, or all if none specified
+
 ### 3.2.0
 
 * [#133](https://github.com/japgolly/clear-config/issues/133) Add `ConfigDef.logbackXmlOnClasspath` (available on JVM only) that scans logback xml files for environment variables so that they can appear in a config report.

README.md

@@ -116,8 +116,9 @@ val (dbCfg, report) =
 
 println(report
 
-  // Remove env & system columns from the unused section of the report
-  .mapUnused(_.withoutSources(ConfigSourceName.environment, ConfigSourceName.system))
+  // Only show unused env vars and properties that start with POSTGRES
+  // (All unused keys in database.props will remain unfiltered in the report)
+  .mapUnused(_.filterKeys(_.startsWith("POSTGRES"), ConfigSourceName.environment, ConfigSourceName.system))
 
   // Show the full report
   .full

core/shared/src/main/scala/japgolly/clearconfig/internals/Report.scala

@@ -45,16 +45,28 @@ object Report {
   trait HasTable[A <: HasTable[A]] {
     def map(f: Table => Table): A
 
-    final def filterKeys(f: String => Boolean): A =
-      map(_.modByKey(_.iterator.filter(kv => f(kv._1.value)).toMap))
+    final def filterKeysAndSource(f: (String, SourceName) => Boolean): A =
+      map(_.modByKey(_.iterator.map { case (k, m) => (k, m.filter { case (s, _) => f(k.value, s) }) }.toMap))
 
-    final def filterKeysNot(f: String => Boolean): A =
-      filterKeys(!f(_))
+    final def filterKeysAndSourceNot(f: (String, SourceName) => Boolean): A =
+      filterKeysAndSource(!f(_, _))
 
-    final def withoutKeys(keys: String*): A = {
-      val keySet = keys.toSet
-      filterKeys(!keySet.contains(_))
-    }
+    final def filterKeys(f: String => Boolean, sources: SourceName*): A =
+      if (sources.isEmpty)
+        map(_.modByKey(_.iterator.filter(kv => f(kv._1.value)).toMap))
+      else {
+        val sourceSet = sources.toSet
+        filterKeysAndSource((k, s) => if (sourceSet.contains(s)) f(k) else true).withoutEmptyKeyRows
+      }
+
+    final def filterKeysNot(f: String => Boolean, sources: SourceName*): A =
+      filterKeys(!f(_), sources: _*)
+
+    final def withoutKeys(keys: String*): A =
+      withoutKeys(keys.toSet)
+
+    final def withoutKeys(keys: Set[String], sources: SourceName*): A =
+      filterKeys(!keys.contains(_), sources: _*)
 
     final def filterSources(f: SourceName => Boolean): A =
       map(_.modBySource(_.iterator.filter(kv => f(kv._1)).toMap))

core/shared/src/test/scala/japgolly/clearconfig/external/ConfigReportTest.scala

@@ -364,6 +364,63 @@ object ConfigReportTest extends TestSuite {
            !Unused keys (0):
            !No data to report.
          """.stripMargin('!').trim)
+
+       "filterKeysAndSourceNot" - {
+        val r2 = r.mapUnused(_.filterKeysAndSourceNot(_.startsWith("s") && _ == s1.name))
+        assertMultiline(r2.unused,
+          s"""
+             !Unused keys (3):
+             !+-----+----+----+
+             !| Key | S1 | S2 |
+             !+-----+----+----+
+             !| a   | a1 |    |
+             !| b   |    | b2 |
+             !| s   |    | s2 |
+             !+-----+----+----+
+           """.stripMargin('!').trim)
+       }
+
+       "filterKeysNotWithSources" - {
+        val r2 = r.mapUnused(_.filterKeysNot(_.startsWith("s"), s1.name))
+        assertMultiline(r2.unused,
+          s"""
+             !Unused keys (3):
+             !+-----+----+----+
+             !| Key | S1 | S2 |
+             !+-----+----+----+
+             !| a   | a1 |    |
+             !| b   |    | b2 |
+             !| s   |    | s2 |
+             !+-----+----+----+
+           """.stripMargin('!').trim)
+       }
+
+       "filterKeysWithSources1" - {
+        val r2 = r.mapUnused(_.filterKeys(_.startsWith("s"), s1.name))
+        assertMultiline(r2.unused,
+          s"""
+             !Unused keys (2):
+             !+-----+----+----+
+             !| Key | S1 | S2 |
+             !+-----+----+----+
+             !| b   |    | b2 |
+             !| s   | s1 | s2 |
+             !+-----+----+----+
+           """.stripMargin('!').trim)
+       }
+
+       "filterKeysWithSources2" - {
+        val r2 = r.mapUnused(_.filterKeys(_.startsWith("s"), s1.name, s2.name))
+        assertMultiline(r2.unused,
+          s"""
+             !Unused keys (1):
+             !+-----+----+----+
+             !| Key | S1 | S2 |
+             !+-----+----+----+
+             !| s   | s1 | s2 |
+             !+-----+----+----+
+           """.stripMargin('!').trim)
+       }
     }
 
     "colour" - {