text resource from classpath

[Vampire]

I didn't find a way to do it, besides having a separate non-transitive configuration with one dependency and then use resources.text.fromArchiveEntry(configurations.myConfiguration, 'my-file.txt').

It would be nice if you could do something like resources.text.fromClasspath('my-file.txt') or resources.text.fromUri('classpath:my-file.txt') or similar.

[big-guy]

Are you trying to get it from the classpath of the plugin on the buildscript?

Have you tried something like:

def resourceUri = YourPluginClass.class.classLoader.getResource("path/to/resource")
def resource = resources.text.fromUri(resourceUri)

[Vampire]

Ah, hm, somehow didn't think about fromUri, thanks.
After adding spotbugs to the classpath, I can successfully find the file on the classpath, unfortunately I cannot use it, as there seems to be an encoding problem.
This again is about the SpotBugs HTML stylesheets.
Well, like always with encoding problems it can be hairy.
The question probably only or at least firstly is, whether it is like expected or should work differently.
The fancy.xsl file is UTF-8 with BOM encoded.

Here some findings as run on Windows,
BOM means it prints the BOM as if it was read with ISO-8859-1 as the famous three characters sequence
? means it prints a literal question mark character
OK means it prints the line starting with <?xml like needed

configurations { spotbugsStylesheets { transitive false } }
dependencies { spotbugsStylesheets 'com.github.spotbugs:spotbugs:3.1.11' }

/* BOM */ /* ?  */ println resources.text.fromArchiveEntry(configurations.spotbugsStylesheets, 'fancy.xsl').asReader().readLine()
/* ?   */ /* ?  */ println resources.text.fromArchiveEntry(configurations.spotbugsStylesheets, 'fancy.xsl', 'UTF-8').asReader().readLine()
/* ?   */ /* ?  */ println resources.text.fromUri(getClass().classLoader.getResource('fancy.xsl')).asReader().readLine()
/* OK  */ /* OK */ println resources.text.fromArchiveEntry(configurations.spotbugsStylesheets, 'fancy.xsl').asFile().readLines().first()
/* ?   */ /* OK */ println resources.text.fromArchiveEntry(configurations.spotbugsStylesheets, 'fancy.xsl', 'UTF-8').asFile().readLines().first()
/* ?   */ /* OK */ println resources.text.fromUri(getClass().classLoader.getResource('fancy.xsl')).asFile().readLines().first()
/* BOM */ /* OK */ println resources.text.fromArchiveEntry(configurations.spotbugsStylesheets, 'fancy.xsl').asFile('UTF-8').readLines().first()
/* OK  */ /* OK */ println resources.text.fromArchiveEntry(configurations.spotbugsStylesheets, 'fancy.xsl', 'UTF-8').asFile('UTF-8').readLines().first()
/* OK  */ /* OK */ println resources.text.fromUri(getClass().classLoader.getResource('fancy.xsl')).asFile('UTF-8').readLines().first()
/* ?   */ /* ?  */ println resources.text.fromArchiveEntry(configurations.spotbugsStylesheets, 'fancy.xsl').asFile().readLines('UTF-8').first()
/* ?   */ /* ?  */ println resources.text.fromArchiveEntry(configurations.spotbugsStylesheets, 'fancy.xsl', 'UTF-8').asFile().readLines('UTF-8').first()
/* ?   */ /* ?  */ println resources.text.fromUri(getClass().classLoader.getResource('fancy.xsl')).asFile().readLines('UTF-8').first()
/* BOM */ /* ?  */ println resources.text.fromArchiveEntry(configurations.spotbugsStylesheets, 'fancy.xsl').asFile('UTF-8').readLines('UTF-8').first()
/* ?   */ /* ?  */ println resources.text.fromArchiveEntry(configurations.spotbugsStylesheets, 'fancy.xsl', 'UTF-8').asFile('UTF-8').readLines('UTF-8').first()
/* ?   */ /* ?  */ println resources.text.fromUri(getClass().classLoader.getResource('fancy.xsl')).asFile('UTF-8').readLines('UTF-8').first()

The main point here is, if not specifying any encodings, it just works with fromArchiveEntry, but with fromUri I have to specify UTF-8 on the asFile call to make it work properly.
Also, why is there no variant of fromUri that accepts an encoding like there is for fromArchiveEntry and fromFile?

[Vampire]

Actually I also wonder that there is no variant of org.gradle.api.resources.TextResource#asReader that accepts an encoding like for org.gradle.api.resources.TextResource#asFile.
And I also added a second comment column above with the results when setting -Dfile.encoding=UTF-8

[Vampire]

The encoding problem also is especially problematic if you do not use it yourself but give it to some task.
For example if you have

tasks.withType(SpotBugsTask) {
    reports {
        xml.enabled false
        html {
            enabled true
            stylesheet resources.text.fromUri(getClass().classLoader.getResource('fancy.xsl'))
        }
    }
}

the transformation will not work due to the encoding problem.
You would have to do it like

tasks.withType(SpotBugsTask) {
    reports {
        xml.enabled false
        html {
            enabled true
            stylesheet resources.text.fromFile(resources.text.fromUri(getClass().classLoader.getResource('fancy.xsl')).asFile('UTF-8'))
        }
    }
}

to make it work.

[grv87]

I've also hit encoding problem in TextResource and code quality plugins.
I think that TextResource should preserve encoding on creation and use it in asFile().
Otherwise, all config files not in system default encoding become corrupted.
This is especially a problem with XMLs since they declare encoding explicitly.

Should I open another issue specifically about encoding?

[stale]

This issue has been automatically marked as stale because it has not had recent activity. Given the limited bandwidth of the team, it will be automatically closed if no further activity occurs. If you're interested in how we try to keep the backlog in a healthy state, please read our blog post on how we refine our backlog. If you feel this is something you could contribute, please have a look at our Contributor Guide. Thank you for your contribution.

[Vampire]

still an issue with version 6.5.1

[stale]

This issue has been automatically marked as stale because it has not had recent activity. Given the limited bandwidth of the team, it will be automatically closed if no further activity occurs. If you're interested in how we try to keep the backlog in a healthy state, please read our blog post on how we refine our backlog. If you feel this is something you could contribute, please have a look at our Contributor Guide. Thank you for your contribution.