RAT-377: Create a STANDARD process filter like the ARCHIVE process switch in RAT-372 #249
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Claudenw
force-pushed
the
create_standard_process
branch
from
6487234
to
406d822
Compare
ottlinger
reviewed
May 11, 2024
| * Specify the processing of STANDARD files. | ||
| */ | ||
| static final Option STANDARD = Option.builder().longOpt("standard").hasArg().argName("ProcessingType") | ||
| .desc(format("Specifies the level of detail in STANDARD file reporting.. (default is %s)", |
There was a problem hiding this comment.
Double dot in this sentence - pls update the site template as well to keep it in sync with your changes.
ottlinger
reviewed
May 11, 2024
ottlinger
reviewed
May 11, 2024
ottlinger
reviewed
May 11, 2024
| @@ -74,25 +78,48 @@ public DefaultAnalyser(ReportConfiguration config, final Collection<ILicense> li | |||
| this.configuration = config; | |||
| } | |||
|
|
|||
| /** | |||
| * Generates a predicateo to filter out licnses that should not be reported. | |||
There was a problem hiding this comment.
LHF: typo predicateo / licnes
ottlinger
reviewed
May 11, 2024
apache-rat/src/site/apt/index.apt.vm
Outdated
| @@ -106,6 +104,7 @@ usage: java -jar apache-rat/target/apache-rat-${project.version}.jar | |||
| external xsl file may be specified or one of the internal named sheets: plain-rat (default), | |||
| missing-headers, or unapproved-licenses | |||
| --scan-hidden-directories Scan hidden directories | |||
| --standard <ProcessingType> Specifies the level of detail in STANDARD file reporting.. (default is ABSENCE) | |||
There was a problem hiding this comment.
LHF: typo - double dot. Should the dot be at the end of the sentence.
ottlinger
reviewed
May 11, 2024
src/changes/changes.xml
Outdated
| @@ -72,6 +72,15 @@ https://maven.apache.org/plugins/maven-changes-plugin/xsd/changes-1.0.0.xsd | |||
| </release> | |||
| --> | |||
| <release version="0.17-SNAPSHOT" date="xxxx-yy-zz" description="Current SNAPSHOT - release to be done"> | |||
| <action issue="RAT-377" type="add" dev="claudenw"> | |||
| Added ability to specify the leverl of reporting on STANDARD files within a project. This necessitated an addition | |||
There was a problem hiding this comment.
LHF: typo leverl ;) Sounds Austrian to my ear.
ottlinger
approved these changes
May 11, 2024
Claudenw
force-pushed
the
create_standard_process
branch
from
406d822
to
7777690
Compare
|
I had to rework some code to bring the errors down below the minimum. The net result is a much larger change. You may want to review the last commit. Please reapprove when you are satisfied. |
ottlinger
reviewed
May 14, 2024
| lastMatch = null; | ||
| if (!checked) { | ||
| checked = true; | ||
| if (line.contains("SPDX-License-Identifier")) { |
There was a problem hiding this comment.
Should we extract this as a constant as it is used in line 62 as well, when defining the pattern?
ottlinger
reviewed
May 14, 2024
| @@ -75,7 +77,8 @@ public LicenseSetFactory(SortedSet<ILicense> licenses, Collection<String> approv | |||
| * @return An empty sorted set of ILicense objects. | |||
| */ | |||
| public static SortedSet<ILicense> emptyLicenseSet() { | |||
| return new TreeSet<>(ILicense.getComparator()); | |||
| //return new TreeSet<>((a,b) -> a.getLicenseFamily().compareTo(b.getLicenseFamily())); | |||
ottlinger
reviewed
May 14, 2024
| public static ILicense search(String licenseId, SortedSet<ILicense> licenses) { | ||
| ILicenseFamily searchFamily = ILicenseFamily.builder().setLicenseFamilyCategory(licenseId) | ||
| public static Optional<ILicense> search(String familyId, String licenseId, SortedSet<ILicense> licenses) { | ||
| // return licenses.stream().filter( l -> l.getId().equals(licenseId)).findFirst(); |
ottlinger
reviewed
May 14, 2024
| @@ -212,13 +221,14 @@ public IHeaderMatcher getMatcher() { | |||
|
|
|||
| /** | |||
| * Search a SortedSet of licenses for the matching license. | |||
| * License must mach both family code, and license id. | |||
ottlinger
reviewed
May 14, 2024
| assertTrue(target.matches(AbstractMatcherTest.makeHeaders("SPDX-License-Identifier: hello", null))); | ||
| target.reset(); | ||
| StringBuilder sb = new StringBuilder() | ||
| .append("SPDX-License-Identifier: world").append(System.lineSeparator()) |
There was a problem hiding this comment.
constant from above could be used in these tests as well.
ottlinger
reviewed
May 14, 2024
ottlinger
approved these changes
May 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes RAT-377
This change is dependent upon RAT-372 and should not be considered for merged until after that change has been accepted.
The solution for process archive files (RAT-372) introduces a command line switch to change from just reporting the presence of archive files to reporting what licenses they contain or reporting licenses contains as well as missing licenses.
This request is for a similar change in STANDARD reporting.
The use case is for non-ASF projects that don't require a license header in every file but do require licensing to be declared within the project.
Using
--standard PRESENCEwould cause Rat to list all the declared licenses in the scan, without the overhead noise of 'missing license headers'