Re: [PR] RAT-355: Add configuration dump to report [creadur-rat]
Claudenw commented on PR #205: URL: https://github.com/apache/creadur-rat/pull/205#issuecomment-2024506086 Closing in favor of #227 which has a better solution -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@creadur.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
Re: [PR] RAT-355: Add configuration dump to report [creadur-rat]
Claudenw closed pull request #205: RAT-355: Add configuration dump to report URL: https://github.com/apache/creadur-rat/pull/205 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@creadur.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
Re: [PR] RAT-355: Add configuration dump to report [creadur-rat]
Claudenw commented on code in PR #205:
URL: https://github.com/apache/creadur-rat/pull/205#discussion_r1526403205
##
apache-rat-core/src/main/java/org/apache/rat/inspector/AbstractInspector.java:
##
@@ -0,0 +1,120 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one *
+ * or more contributor license agreements. See the NOTICE file *
+ * distributed with this work for additional information*
+ * regarding copyright ownership. The ASF licenses this file *
+ * to you under the Apache License, Version 2.0 (the*
+ * "License"); you may not use this file except in compliance *
+ * with the License. You may obtain a copy of the License at *
+ * *
+ * http://www.apache.org/licenses/LICENSE-2.0 *
+ * *
+ * Unless required by applicable law or agreed to in writing, *
+ * software distributed under the License is distributed on an *
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
+ * KIND, either express or implied. See the License for the*
+ * specific language governing permissions and limitations *
+ * under the License. *
+ */
+package org.apache.rat.inspector;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+import org.apache.rat.license.ILicense;
+
+public abstract class AbstractInspector implements Inspector {
+private final Type type;
+private final String name;
+
+public AbstractInspector(Type type, String name) {
+this.type = type;
+this.name = name;
+}
+
+@Override
+public Type getType() {
+return type;
+}
+
+@Override
+public String getCommonName() {
+return name;
+}
+
+public static Inspector license(ILicense license, Inspector matcher) {
+return new AbstractInspector(Inspector.Type.License, "license") {
Review Comment:
The problem (for reporting) is that the current system allows creation of
new IHeaderMatcher types and adding those matchers to the system. This means
that the output has to be able to handle matchers that we don't know about yet.
I think the way to approach this might be to have each system class that
represents an item in the have a `getDescription()` method that will return a
Description that is basically the same as the Inspector, but is defined within
the class. This will handle the new class problem noted above, as well as
provide a mechanism to construct documentation for all the options and/or
display that information to the user.
I have an example of the Description approach.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscr...@creadur.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
Re: [PR] RAT-355: Add configuration dump to report [creadur-rat]
Claudenw commented on code in PR #205:
URL: https://github.com/apache/creadur-rat/pull/205#discussion_r1526403205
##
apache-rat-core/src/main/java/org/apache/rat/inspector/AbstractInspector.java:
##
@@ -0,0 +1,120 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one *
+ * or more contributor license agreements. See the NOTICE file *
+ * distributed with this work for additional information*
+ * regarding copyright ownership. The ASF licenses this file *
+ * to you under the Apache License, Version 2.0 (the*
+ * "License"); you may not use this file except in compliance *
+ * with the License. You may obtain a copy of the License at *
+ * *
+ * http://www.apache.org/licenses/LICENSE-2.0 *
+ * *
+ * Unless required by applicable law or agreed to in writing, *
+ * software distributed under the License is distributed on an *
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
+ * KIND, either express or implied. See the License for the*
+ * specific language governing permissions and limitations *
+ * under the License. *
+ */
+package org.apache.rat.inspector;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+import org.apache.rat.license.ILicense;
+
+public abstract class AbstractInspector implements Inspector {
+private final Type type;
+private final String name;
+
+public AbstractInspector(Type type, String name) {
+this.type = type;
+this.name = name;
+}
+
+@Override
+public Type getType() {
+return type;
+}
+
+@Override
+public String getCommonName() {
+return name;
+}
+
+public static Inspector license(ILicense license, Inspector matcher) {
+return new AbstractInspector(Inspector.Type.License, "license") {
Review Comment:
The problem (for reporting) is that the current system allows creation of
new IHeaderMatcher types and adding those matchers to the system. This means
that the output has to be able to handle matchers that we don't know about yet.
I think the way to approach this might be to have each system class that
represents an item in the have a `getDescription()` method that will return a
Description that is basically the same as the Inspector, but is defined within
the class. This will handle the new class problem noted above, as well as
provide a mechanism to construct documentation for all the options and/or
display that information to the user.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscr...@creadur.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
Re: [PR] RAT-355: Add configuration dump to report [creadur-rat]
Claudenw commented on code in PR #205:
URL: https://github.com/apache/creadur-rat/pull/205#discussion_r1461171648
##
apache-rat-core/src/main/java/org/apache/rat/inspector/AbstractInspector.java:
##
@@ -0,0 +1,120 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one *
+ * or more contributor license agreements. See the NOTICE file *
+ * distributed with this work for additional information*
+ * regarding copyright ownership. The ASF licenses this file *
+ * to you under the Apache License, Version 2.0 (the*
+ * "License"); you may not use this file except in compliance *
+ * with the License. You may obtain a copy of the License at *
+ * *
+ * http://www.apache.org/licenses/LICENSE-2.0 *
+ * *
+ * Unless required by applicable law or agreed to in writing, *
+ * software distributed under the License is distributed on an *
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
+ * KIND, either express or implied. See the License for the*
+ * specific language governing permissions and limitations *
+ * under the License. *
+ */
+package org.apache.rat.inspector;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+import org.apache.rat.license.ILicense;
+
+public abstract class AbstractInspector implements Inspector {
+private final Type type;
+private final String name;
+
+public AbstractInspector(Type type, String name) {
+this.type = type;
+this.name = name;
+}
+
+@Override
+public Type getType() {
+return type;
+}
+
+@Override
+public String getCommonName() {
+return name;
+}
+
+public static Inspector license(ILicense license, Inspector matcher) {
+return new AbstractInspector(Inspector.Type.License, "license") {
Review Comment:
The parameters for the XML output should all be defined in the documentation
about the XML configuration file. That is partly done. I opened a ticket
about it. I have some questions about how to go about documenting things that
span the various UIs.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscr...@creadur.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
Re: [PR] RAT-355: Add configuration dump to report [creadur-rat]
Claudenw commented on code in PR #205: URL: https://github.com/apache/creadur-rat/pull/205#discussion_r1461170723 ## apache-rat-core/src/main/resources/org/apache/rat/default.xml: ## @@ -158,7 +158,7 @@ may be prepared copied published and distributed + owner="OASIS Open"/> Review Comment: The start date specified is the default if no data is given. So I removed it as generally we want a regular year in there, not the regex pattern. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@creadur.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
Re: [PR] RAT-355: Add configuration dump to report [creadur-rat]
ottlinger commented on code in PR #205: URL: https://github.com/apache/creadur-rat/pull/205#discussion_r1461128420 ## apache-rat-core/src/main/resources/org/apache/rat/default.xml: ## @@ -158,7 +158,7 @@ may be prepared copied published and distributed + owner="OASIS Open"/> Review Comment: What is the semantics of this change? Should there be a test for this OASIS license that needs to be changed here? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@creadur.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
Re: [PR] RAT-355: Add configuration dump to report [creadur-rat]
ottlinger commented on code in PR #205:
URL: https://github.com/apache/creadur-rat/pull/205#discussion_r1461127526
##
apache-rat-core/src/main/java/org/apache/rat/inspector/AbstractInspector.java:
##
@@ -0,0 +1,120 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one *
+ * or more contributor license agreements. See the NOTICE file *
+ * distributed with this work for additional information*
+ * regarding copyright ownership. The ASF licenses this file *
+ * to you under the Apache License, Version 2.0 (the*
+ * "License"); you may not use this file except in compliance *
+ * with the License. You may obtain a copy of the License at *
+ * *
+ * http://www.apache.org/licenses/LICENSE-2.0 *
+ * *
+ * Unless required by applicable law or agreed to in writing, *
+ * software distributed under the License is distributed on an *
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
+ * KIND, either express or implied. See the License for the*
+ * specific language governing permissions and limitations *
+ * under the License. *
+ */
+package org.apache.rat.inspector;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+import org.apache.rat.license.ILicense;
+
+public abstract class AbstractInspector implements Inspector {
+private final Type type;
+private final String name;
+
+public AbstractInspector(Type type, String name) {
+this.type = type;
+this.name = name;
+}
+
+@Override
+public Type getType() {
+return type;
+}
+
+@Override
+public String getCommonName() {
+return name;
+}
+
+public static Inspector license(ILicense license, Inspector matcher) {
+return new AbstractInspector(Inspector.Type.License, "license") {
Review Comment:
Would one want to extract all of these license-config-related constants into
a class where we could easily add documentation about the semantics of each
option/value/parameter?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscr...@creadur.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
