Setup mycila plugin, and normalize all license headers; Resolves #4. (#…

…20) Travis-CI had one check fail during GitHub outage, others cleared. Overriding defaults.
archivesunleashed · Jul 31, 2017 · eb0e8a9 · eb0e8a9
1 parent bb2e665
commit eb0e8a9
Show file tree

Hide file tree

Showing 73 changed files with 426 additions and 132 deletions.
diff --git a/LICENSE_HEADER.txt b/LICENSE_HEADER.txt
@@ -0,0 +1,14 @@
+Archives Unleashed Toolkit (AUT):
+An open-source platform for analyzing web archives.
+
+Licensed 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.
diff --git a/pom.xml b/pom.xml
@@ -18,11 +18,14 @@
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+		<project_name>${project.artifactId}</project_name>
+		<project_organization>The Archives Unleashed Project</project_organization>
     <scala.version>2.10.5</scala.version>
     <hadoop.version>2.6.0-cdh5.7.1</hadoop.version>
     <spark.version>1.6.0-cdh5.7.1</spark.version>
     <github.global.server>github</github.global.server>
     <checkstyle.plugin.version>2.15</checkstyle.plugin.version>
+    <license.plugin.version>2.11</license.plugin.version>
   </properties>
 
   <licenses>
@@ -179,6 +182,41 @@
           <check />
         </configuration>
       </plugin>
+      <!-- for mycila -->
+      <plugin>
+        <groupId>com.mycila</groupId>
+        <artifactId>license-maven-plugin</artifactId>
+        <version>${license.plugin.version}</version>
+        <configuration>
+          <header>LICENSE_HEADER.txt</header>
+          <mapping>
+              <java>SLASHSTAR_STYLE</java>
+          </mapping>
+          <includes>
+            <include>**/src/main/java/**</include>
+            <include>**/src/test/java/**</include>
+          </includes>
+          <excludes>
+            <exclude>target/**</exclude>
+            <exclude>**/src/test/resources/**</exclude>
+            <exclude>**/src/main/resources/**</exclude>
+            <exclude>**/*.properties</exclude>
+          </excludes>
+          <properties>
+            <name>${project.artifactId}</name>
+            <holder>${project.organization.name}</holder>
+          </properties>
+          <encoding>UTF-8</encoding>
+          <strictCheck>true</strictCheck>
+        </configuration>
+        <executions>
+          <execution>
+            <goals>
+              <goal>check</goal>
+            </goals>
+          </execution>
+        </executions>
+			</plugin>
     </plugins>
   </build>
 

diff --git a/src/main/java/io/archivesunleashed/data/ArcRecordUtils.java b/src/main/java/io/archivesunleashed/data/ArcRecordUtils.java
@@ -1,5 +1,6 @@
 /*
- * Warcbase: an open-source platform for managing web archives
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package io.archivesunleashed.data;
 
 import java.io.BufferedInputStream;

diff --git a/src/main/java/io/archivesunleashed/data/WarcRecordUtils.java b/src/main/java/io/archivesunleashed/data/WarcRecordUtils.java
@@ -1,5 +1,6 @@
 /*
- * Warcbase: an open-source platform for managing web archives
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/archivesunleashed/data/package-info.java b/src/main/java/io/archivesunleashed/data/package-info.java
@@ -1,5 +1,6 @@
 /*
- * Warcbase: an open-source platform for managing web archives
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/archivesunleashed/io/ArcRecordWritable.java b/src/main/java/io/archivesunleashed/io/ArcRecordWritable.java
@@ -1,5 +1,6 @@
 /*
- * Warcbase: an open-source platform for managing web archives
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package io.archivesunleashed.io;
 
 import io.archivesunleashed.data.ArcRecordUtils;

diff --git a/src/main/java/io/archivesunleashed/io/GenericArchiveRecordWritable.java b/src/main/java/io/archivesunleashed/io/GenericArchiveRecordWritable.java
@@ -1,5 +1,6 @@
 /*
- * Warcbase: an open-source platform for managing web archives
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package io.archivesunleashed.io;
 
 import io.archivesunleashed.data.ArcRecordUtils;

diff --git a/src/main/java/io/archivesunleashed/io/WarcRecordWritable.java b/src/main/java/io/archivesunleashed/io/WarcRecordWritable.java
@@ -1,5 +1,6 @@
 /*
- * Warcbase: an open-source platform for managing web archives
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package io.archivesunleashed.io;
 
 import io.archivesunleashed.data.WarcRecordUtils;

diff --git a/src/main/java/io/archivesunleashed/io/package-info.java b/src/main/java/io/archivesunleashed/io/package-info.java
@@ -1,5 +1,6 @@
 /*
- * Warcbase: an open-source platform for managing web archives
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/archivesunleashed/mapreduce/WacArcInputFormat.java b/src/main/java/io/archivesunleashed/mapreduce/WacArcInputFormat.java
@@ -1,5 +1,6 @@
 /*
- * Warcbase: an open-source platform for managing web archives
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package io.archivesunleashed.mapreduce;
 
 import io.archivesunleashed.io.ArcRecordWritable;

diff --git a/src/main/java/io/archivesunleashed/mapreduce/WacGenericInputFormat.java b/src/main/java/io/archivesunleashed/mapreduce/WacGenericInputFormat.java
@@ -1,5 +1,6 @@
 /*
- * Warcbase: an open-source platform for managing web archives
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package io.archivesunleashed.mapreduce;
 
 import io.archivesunleashed.io.GenericArchiveRecordWritable.ArchiveFormat;

diff --git a/src/main/java/io/archivesunleashed/mapreduce/WacWarcInputFormat.java b/src/main/java/io/archivesunleashed/mapreduce/WacWarcInputFormat.java
@@ -1,5 +1,6 @@
 /*
- * Warcbase: an open-source platform for managing web archives
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package io.archivesunleashed.mapreduce;
 
 import io.archivesunleashed.io.WarcRecordWritable;

diff --git a/src/main/java/io/archivesunleashed/mapreduce/package-info.java b/src/main/java/io/archivesunleashed/mapreduce/package-info.java
@@ -1,5 +1,6 @@
 /*
- * Warcbase: an open-source platform for managing web archives
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/scala/io/archivesunleashed/spark/archive/io/ArcRecord.scala b/src/main/scala/io/archivesunleashed/spark/archive/io/ArcRecord.scala
@@ -1,3 +1,19 @@
+/*
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
+ *
+ * Licensed 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 io.archivesunleashed.spark.archive.io
 
 import org.apache.spark.SerializableWritable

diff --git a/src/main/scala/io/archivesunleashed/spark/archive/io/ArchiveRecord.scala b/src/main/scala/io/archivesunleashed/spark/archive/io/ArchiveRecord.scala
@@ -1,3 +1,19 @@
+/*
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
+ *
+ * Licensed 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 io.archivesunleashed.spark.archive.io
 
 trait ArchiveRecord extends Serializable {

diff --git a/src/main/scala/io/archivesunleashed/spark/archive/io/GenericArchiveRecord.scala b/src/main/scala/io/archivesunleashed/spark/archive/io/GenericArchiveRecord.scala
@@ -1,3 +1,19 @@
+/*
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
+ *
+ * Licensed 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 io.archivesunleashed.spark.archive.io
 
 import java.text.SimpleDateFormat

diff --git a/src/main/scala/io/archivesunleashed/spark/archive/io/WarcRecord.scala b/src/main/scala/io/archivesunleashed/spark/archive/io/WarcRecord.scala
@@ -1,3 +1,19 @@
+/*
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
+ *
+ * Licensed 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 io.archivesunleashed.spark.archive.io
 
 import java.text.SimpleDateFormat

diff --git a/src/main/scala/io/archivesunleashed/spark/matchbox/ComputeImageSize.scala b/src/main/scala/io/archivesunleashed/spark/matchbox/ComputeImageSize.scala
@@ -1,3 +1,19 @@
+/*
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
+ *
+ * Licensed 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 io.archivesunleashed.spark.matchbox
 
 import java.io.ByteArrayInputStream

diff --git a/src/main/scala/io/archivesunleashed/spark/matchbox/ComputeMD5.scala b/src/main/scala/io/archivesunleashed/spark/matchbox/ComputeMD5.scala
@@ -1,3 +1,19 @@
+/*
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
+ *
+ * Licensed 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 io.archivesunleashed.spark.matchbox
 
 import java.security.MessageDigest

diff --git a/src/main/scala/io/archivesunleashed/spark/matchbox/DetectLanguage.scala b/src/main/scala/io/archivesunleashed/spark/matchbox/DetectLanguage.scala
@@ -1,5 +1,6 @@
 /*
- * Warcbase: an open-source platform for managing web archives
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package io.archivesunleashed.spark.matchbox
 
 import org.apache.tika.language.LanguageIdentifier

diff --git a/src/main/scala/io/archivesunleashed/spark/matchbox/DetectMimeTypeTika.scala b/src/main/scala/io/archivesunleashed/spark/matchbox/DetectMimeTypeTika.scala
@@ -1,5 +1,6 @@
 /*
- * Warcbase: an open-source platform for managing web archives
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package io.archivesunleashed.spark.matchbox
 
 import java.io.ByteArrayInputStream

diff --git a/src/main/scala/io/archivesunleashed/spark/matchbox/ExtractAtMentions.scala b/src/main/scala/io/archivesunleashed/spark/matchbox/ExtractAtMentions.scala
@@ -1,5 +1,6 @@
 /*
- * Warcbase: an open-source platform for managing web archives
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package io.archivesunleashed.spark.matchbox
 
 object ExtractAtMentions {

diff --git a/src/main/scala/io/archivesunleashed/spark/matchbox/ExtractBoilerpipeText.scala b/src/main/scala/io/archivesunleashed/spark/matchbox/ExtractBoilerpipeText.scala
@@ -1,5 +1,6 @@
 /*
- * Warcbase: an open-source platform for managing web archives
+ * Archives Unleashed Toolkit (AUT):
+ * An open-source platform for analyzing web archives.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package io.archivesunleashed.spark.matchbox
 
 import java.io.IOException