You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@creadur.apache.org by rd...@apache.org on 2009/05/22 22:23:36 UTC

svn commit: r777693 - in /incubator/rat/main/trunk/apache-rat-core/src: main/java/org/apache/rat/report/analyser/ main/java/org/apache/rat/report/xml/ test/java/org/apache/rat/report/analyser/ test/java/org/apache/rat/report/xml/

Author: rdonkin
Date: Fri May 22 20:23:36 2009
New Revision: 777693

URL: http://svn.apache.org/viewvc?rev=777693&view=rev
Log:
RAT-53 No longer any need to pass reporter through. https://issues.apache.org/jira/browse/RAT-53

Modified:
    incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/DefaultAnalyserFactory.java
    incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/DocumentHeaderAnalyser.java
    incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/HeaderCheckWorker.java
    incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/xml/XmlReportFactory.java
    incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/report/analyser/AnalyserFactoryTest.java
    incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/report/analyser/HeaderCheckWorkerTest.java
    incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/report/xml/XmlReportTest.java

Modified: incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/DefaultAnalyserFactory.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/DefaultAnalyserFactory.java?rev=777693&r1=777692&r2=777693&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/DefaultAnalyserFactory.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/DefaultAnalyserFactory.java Fri May 22 20:23:36 2009
@@ -20,7 +20,6 @@
 
 import org.apache.rat.analysis.IHeaderMatcher;
 import org.apache.rat.api.Document;
-import org.apache.rat.api.Reporter;
 import org.apache.rat.api.MetaData;
 import org.apache.rat.document.IDocumentAnalyser;
 import org.apache.rat.document.RatDocumentAnalysisException;
@@ -34,20 +33,17 @@
  */
 public class DefaultAnalyserFactory {
   
-    public static final IDocumentAnalyser createDefaultAnalyser(final Reporter reporter, 
-            final IHeaderMatcher matcher) {
+    public static final IDocumentAnalyser createDefaultAnalyser(final IHeaderMatcher matcher) {
         
-        return new DefaultAnalyser(reporter, matcher);
+        return new DefaultAnalyser(matcher);
     }
     
     private final static class DefaultAnalyser implements IDocumentAnalyser {
 
-        private final Reporter reporter;
         private final IHeaderMatcher matcher;
         
-        public DefaultAnalyser(final Reporter reporter, final IHeaderMatcher matcher) {
+        public DefaultAnalyser(final IHeaderMatcher matcher) {
             super();
-            this.reporter = reporter;
             this.matcher = matcher;
         }
 
@@ -61,7 +57,7 @@
                 documentCategory = MetaData.RAT_DOCUMENT_CATEGORY_DATUM_BINARY;
             } else {
                 documentCategory = MetaData.RAT_DOCUMENT_CATEGORY_DATUM_STANDARD;
-                final DocumentHeaderAnalyser headerAnalyser = new DocumentHeaderAnalyser(matcher, reporter);
+                final DocumentHeaderAnalyser headerAnalyser = new DocumentHeaderAnalyser(matcher);
                 headerAnalyser.analyse(subject);
             }
             subject.getMetaData().set(documentCategory);

Modified: incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/DocumentHeaderAnalyser.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/DocumentHeaderAnalyser.java?rev=777693&r1=777692&r2=777693&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/DocumentHeaderAnalyser.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/DocumentHeaderAnalyser.java Fri May 22 20:23:36 2009
@@ -24,20 +24,16 @@
 import org.apache.rat.analysis.IHeaderMatcher;
 import org.apache.rat.analysis.RatHeaderAnalysisException;
 import org.apache.rat.api.Document;
-import org.apache.rat.api.Reporter;
 import org.apache.rat.document.IDocumentAnalyser;
 import org.apache.rat.document.RatDocumentAnalysisException;
 
 public class DocumentHeaderAnalyser implements IDocumentAnalyser {
 
     private final IHeaderMatcher matcher;
-    // TODO: coupling to unknown license should be replaced
-    private final Reporter reporter;
     
-    public DocumentHeaderAnalyser(final IHeaderMatcher matcher, final Reporter reporter) {
+    public DocumentHeaderAnalyser(final IHeaderMatcher matcher) {
         super();
         this.matcher = matcher;
-        this.reporter = reporter;
     }
 
     public void analyse(Document document) throws RatDocumentAnalysisException {
@@ -45,7 +41,7 @@
         try {
             reader = document.reader();
             // TODO: worker function should be moved into this class
-            HeaderCheckWorker worker = new HeaderCheckWorker(reader, matcher, reporter, document);
+            HeaderCheckWorker worker = new HeaderCheckWorker(reader, matcher, document);
             worker.read();
         } catch (IOException e) {
             throw new RatDocumentAnalysisException("Cannot read header", e);

Modified: incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/HeaderCheckWorker.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/HeaderCheckWorker.java?rev=777693&r1=777692&r2=777693&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/HeaderCheckWorker.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/analyser/HeaderCheckWorker.java Fri May 22 20:23:36 2009
@@ -25,7 +25,6 @@
 import org.apache.rat.analysis.IHeaderMatcher;
 import org.apache.rat.analysis.RatHeaderAnalysisException;
 import org.apache.rat.api.Document;
-import org.apache.rat.api.Reporter;
 import org.apache.rat.api.MetaData;
 
 /**
@@ -39,7 +38,6 @@
 	private final int numberOfRetainedHeaderLines;
 	private final BufferedReader reader;
 	private final IHeaderMatcher matcher;
-	private final Reporter reporter;
     private final Document subject;
     
 	private boolean match = false;
@@ -48,32 +46,31 @@
 	private boolean finished = false;
 
 	public HeaderCheckWorker(Reader reader, int numberOfRetainedHeaderLine, 
-            final IHeaderMatcher matcher, final Reporter reporter, final Document name) {
-		this(new BufferedReader(reader), numberOfRetainedHeaderLine, matcher, reporter, name);
+            final IHeaderMatcher matcher, final Document name) {
+		this(new BufferedReader(reader), numberOfRetainedHeaderLine, matcher, name);
 	}
 	
 	
 	/**
 	 * Convenience constructor wraps given <code>Reader</code> 
 	 * in a <code>BufferedReader</code>.
-	 * @param name the name of the checked content, possibly null
 	 * @param reader a <code>Reader</code> for the content, not null
+	 * @param name the name of the checked content, possibly null
 	 */
-	public HeaderCheckWorker(Reader reader, final IHeaderMatcher matcher, final Reporter reporter, final Document name) {
-		this(new BufferedReader(reader), matcher, reporter, name);
+	public HeaderCheckWorker(Reader reader, final IHeaderMatcher matcher, final Document name) {
+		this(new BufferedReader(reader), matcher, name);
 	}
 	
 	public HeaderCheckWorker(BufferedReader reader, final IHeaderMatcher matcher,
-            final Reporter reporter, final Document name) {
-		this(reader, DEFAULT_NUMBER_OF_RETAINED_HEADER_LINES, matcher, reporter, name);
+            final Document name) {
+		this(reader, DEFAULT_NUMBER_OF_RETAINED_HEADER_LINES, matcher, name);
 	}
 	
 	public HeaderCheckWorker(BufferedReader reader, int numberOfRetainedHeaderLine, final IHeaderMatcher matcher,
-            final Reporter reporter, final Document name) {
+            final Document name) {
 		this.reader = reader;
 		this.numberOfRetainedHeaderLines = numberOfRetainedHeaderLine;
 		this.matcher = matcher;
-        this.reporter = reporter;
         this.subject = name;
 	}
 

Modified: incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/xml/XmlReportFactory.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/xml/XmlReportFactory.java?rev=777693&r1=777692&r2=777693&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/xml/XmlReportFactory.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/xml/XmlReportFactory.java Fri May 22 20:23:36 2009
@@ -57,7 +57,7 @@
         final DefaultPolicy policy = new DefaultPolicy(approvedLicenses);
         
         final IDocumentAnalyser analyser = 
-            DefaultAnalyserFactory.createDefaultAnalyser(reporter, matcher);
+            DefaultAnalyserFactory.createDefaultAnalyser(matcher);
         final IDocumentAnalyser[] analysers = {analyser, policy};
         DocumentAnalyserMultiplexer analysisMultiplexer = new DocumentAnalyserMultiplexer(analysers);
         

Modified: incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/report/analyser/AnalyserFactoryTest.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/report/analyser/AnalyserFactoryTest.java?rev=777693&r1=777692&r2=777693&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/report/analyser/AnalyserFactoryTest.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/report/analyser/AnalyserFactoryTest.java Fri May 22 20:23:36 2009
@@ -60,7 +60,7 @@
 
     public void testStandardTypeAnalyser() throws Exception {
         MonolithicFileDocument document = new MonolithicFileDocument(new File("src/test/resources/elements/Text.txt"));
-        IDocumentAnalyser analyser = DefaultAnalyserFactory.createDefaultAnalyser(reporter, matcherStub);
+        IDocumentAnalyser analyser = DefaultAnalyserFactory.createDefaultAnalyser(matcherStub);
         analyser.analyse(document);
         reporter.report(document);
         assertEquals("Open standard element", "<resource name='src/test/resources/elements/Text.txt'><header-sample>/*\n" +
@@ -88,7 +88,7 @@
 
     public void testNoteTypeAnalyser() throws Exception {
         MonolithicFileDocument document = new MonolithicFileDocument(new File("src/test/elements/LICENSE"));
-        IDocumentAnalyser analyser = DefaultAnalyserFactory.createDefaultAnalyser(reporter, matcherStub);
+        IDocumentAnalyser analyser = DefaultAnalyserFactory.createDefaultAnalyser(matcherStub);
         analyser.analyse(document);
         reporter.report(document);
         assertEquals("Open note element", "<resource name='src/test/elements/LICENSE'><type name='notice'/>", out.toString());
@@ -96,7 +96,7 @@
 
     public void testBinaryTypeAnalyser() throws Exception {
         MonolithicFileDocument document = new MonolithicFileDocument(new File("src/test/elements/Image.png"));
-        IDocumentAnalyser analyser = DefaultAnalyserFactory.createDefaultAnalyser(reporter, matcherStub);
+        IDocumentAnalyser analyser = DefaultAnalyserFactory.createDefaultAnalyser(matcherStub);
         analyser.analyse(document);
         reporter.report(document);
         assertEquals("Open binary element", "<resource name='src/test/elements/Image.png'><type name='binary'/>", out.toString());
@@ -104,7 +104,7 @@
 
     public void testArchiveTypeAnalyser() throws Exception {
         MonolithicFileDocument document = new MonolithicFileDocument(new File("src/test/elements/Dummy.jar"));
-        IDocumentAnalyser analyser = DefaultAnalyserFactory.createDefaultAnalyser(reporter, matcherStub);
+        IDocumentAnalyser analyser = DefaultAnalyserFactory.createDefaultAnalyser(matcherStub);
         analyser.analyse(document);
         reporter.report(document);
         assertEquals("Open archive element", "<resource name='src/test/elements/Dummy.jar'><type name='archive'/>", out.toString());

Modified: incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/report/analyser/HeaderCheckWorkerTest.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/report/analyser/HeaderCheckWorkerTest.java?rev=777693&r1=777692&r2=777693&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/report/analyser/HeaderCheckWorkerTest.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/report/analyser/HeaderCheckWorkerTest.java Fri May 22 20:23:36 2009
@@ -42,7 +42,7 @@
 	
 	public void testIsFinished() throws Exception {
         final Document subject = new MockLocation("subject");
-		HeaderCheckWorker worker = new HeaderCheckWorker(new StringReader(""), new ApacheSoftwareLicense20(), reporter, subject);
+		HeaderCheckWorker worker = new HeaderCheckWorker(new StringReader(""), new ApacheSoftwareLicense20(), subject);
 		assertFalse(worker.isFinished());
 		worker.read();
 		assertTrue(worker.isFinished());

Modified: incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/report/xml/XmlReportTest.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/report/xml/XmlReportTest.java?rev=777693&r1=777692&r2=777693&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/report/xml/XmlReportTest.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/test/java/org/apache/rat/report/xml/XmlReportTest.java Fri May 22 20:23:36 2009
@@ -57,7 +57,7 @@
             public void reset() {
             }            
         };
-        IDocumentAnalyser analyser = DefaultAnalyserFactory.createDefaultAnalyser(reporter, matcher);
+        IDocumentAnalyser analyser = DefaultAnalyserFactory.createDefaultAnalyser(matcher);
         report = new XmlReport(writer, analyser, reporter);
     }