Include the file name in file read/parse failures (#260)

cashapp · Nov 14, 2023 · d8ff7b6 · d8ff7b6
1 parent 7fba1e4
commit d8ff7b6
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 20 deletions.
diff --git a/plugin/src/main/java/app/cash/paraphrase/plugin/GenerateFormattedResources.kt b/plugin/src/main/java/app/cash/paraphrase/plugin/GenerateFormattedResources.kt
@@ -16,6 +16,8 @@
 package app.cash.paraphrase.plugin
 
 import app.cash.paraphrase.plugin.model.ResourceFolder
+import java.io.File
+import java.io.InputStream
 import javax.inject.Inject
 import org.gradle.api.DefaultTask
 import org.gradle.api.file.ConfigurableFileCollection
@@ -71,7 +73,8 @@ internal abstract class GenerateFormattedResources @Inject constructor() : Defau
     //   values-es -> [TokenizedResource(name=hello, ..)]
     val resourcesByConfiguration = filesByConfiguration
       .mapValues { (_, files) ->
-        files.flatMap(::parseResources).map(::tokenizeResource)
+        files.flatMap { it.checkedRead(::parseResources) }
+          .map(::tokenizeResource)
       }
 
     // Split the folder map into individual maps keyed on resource name.
@@ -98,7 +101,7 @@ internal abstract class GenerateFormattedResources @Inject constructor() : Defau
     //  https://developer.android.com/studio/projects/android-library#PrivateResources suggests this
     //  is the case. Check AGP source.
     val publicResources = (filesByConfiguration[ResourceFolder.Default] ?: emptyList())
-      .flatMap(::parsePublicResources)
+      .flatMap { it.checkedRead(::parsePublicResources) }
       .toSet()
 
     // Merge each resource's configuration map into final, canonical versions.
@@ -115,4 +118,12 @@ internal abstract class GenerateFormattedResources @Inject constructor() : Defau
 
     // TODO Fail on errors which make it this far.
   }
+
+  private fun <T> File.checkedRead(parser: (InputStream) -> T): T {
+    return try {
+      inputStream().buffered().run(parser)
+    } catch (e: Exception) {
+      throw IllegalArgumentException("Unable to parse $this", e)
+    }
+  }
 }
diff --git a/plugin/src/main/java/app/cash/paraphrase/plugin/PublicResourceParser.kt b/plugin/src/main/java/app/cash/paraphrase/plugin/PublicResourceParser.kt
@@ -17,19 +17,10 @@ package app.cash.paraphrase.plugin
 
 import app.cash.paraphrase.plugin.model.PublicResource
 import app.cash.paraphrase.plugin.model.ResourceName
-import java.io.File
 import java.io.InputStream
 import javax.xml.parsers.DocumentBuilderFactory
 import org.w3c.dom.Node
 
-/**
- * Parses and returns all of the Android <string> resources declared in the given file.
- *
- * Ignores all other resources, including <plurals> and <string-array>.
- */
-internal fun parsePublicResources(file: File): List<PublicResource> =
-  file.inputStream().use(::parsePublicResources)
-
 /**
  * Parses and returns all of the Android <public> resources declared in the given stream, regardless
  * of type.

diff --git a/plugin/src/main/java/app/cash/paraphrase/plugin/ResourceParser.kt b/plugin/src/main/java/app/cash/paraphrase/plugin/ResourceParser.kt
@@ -17,19 +17,10 @@ package app.cash.paraphrase.plugin
 
 import app.cash.paraphrase.plugin.model.ResourceName
 import app.cash.paraphrase.plugin.model.StringResource
-import java.io.File
 import java.io.InputStream
 import javax.xml.parsers.DocumentBuilderFactory
 import org.w3c.dom.Node
 
-/**
- * Parses and returns all of the Android <string> resources declared in the given file.
- *
- * Ignores all other resources, including <plurals> and <string-array>.
- */
-internal fun parseResources(file: File): List<StringResource> =
-  file.inputStream().use(::parseResources)
-
 /**
  * Parses and returns all of the Android <string> resources declared in the given stream.
  *