Rename metadata-qa-marc to qa-catalogue pkiraly#272

.gitignore

@@ -25,6 +25,7 @@ hs_err_pid*
 target/*
 .idea/*
 metadata-qa-marc.iml
+qa-catalogue.iml
 temp
 scala/project
 scala/target

CONTRIBUTING.md

@@ -1,2 +1,2 @@
 The contributing guide is available in the wiki of QA catalogue project:
-https://github.com/pkiraly/metadata-qa-marc/wiki/Contribution-guide
+https://github.com/pkiraly/qa-catalogue/wiki/Contribution-guide

Dockerfile

@@ -4,7 +4,7 @@ LABEL maintainer="Péter Király <[email protected]>, Ákos Takács <rimelek@rimel
 
 LABEL description="QA catalogue - a metadata quality assessment tool for MARC based library catalogues."
 
-ARG QA_CATALOGUE_VERSION=0.7.0-rc1
+ARG QA_CATALOGUE_VERSION=0.7.0-rc2
 ARG QA_CATALOGUE_WEB_VERSION=0.7.0-rc1
 ARG DEBIAN_FRONTEND=noninteractive
 ARG SMARTY_VERSION=3.1.44
@@ -43,17 +43,17 @@ RUN apt-get update \
       less \
  && rm -rf /var/lib/apt/lists/*
 
-# install metadata-qa-marc
-COPY target/metadata-qa-marc-${QA_CATALOGUE_VERSION}-release.zip /opt
+# install qa-catalogue
+COPY target/qa-catalogue-${QA_CATALOGUE_VERSION}-release.zip /opt
 
 RUN cd /opt \
- && unzip metadata-qa-marc-${QA_CATALOGUE_VERSION}-release.zip \
- && rm metadata-qa-marc-${QA_CATALOGUE_VERSION}-release.zip \
- && mv metadata-qa-marc-${QA_CATALOGUE_VERSION} metadata-qa-marc \
- && mv /opt/metadata-qa-marc/setdir.sh.template /opt/metadata-qa-marc/setdir.sh \
- && mkdir -p /opt/metadata-qa-marc/marc \
- && sed -i.bak 's,BASE_INPUT_DIR=./input,BASE_INPUT_DIR=/opt/metadata-qa-marc/marc,' /opt/metadata-qa-marc/setdir.sh \
- && sed -i.bak 's,BASE_OUTPUT_DIR=./output,BASE_OUTPUT_DIR=/opt/metadata-qa-marc/marc/_output,' /opt/metadata-qa-marc/setdir.sh \
+ && unzip qa-catalogue-${QA_CATALOGUE_VERSION}-release.zip \
+ && rm qa-catalogue-${QA_CATALOGUE_VERSION}-release.zip \
+ && mv qa-catalogue-${QA_CATALOGUE_VERSION} qa-catalogue \
+ && mv /opt/qa-catalogue/setdir.sh.template /opt/qa-catalogue/setdir.sh \
+ && mkdir -p /opt/qa-catalogue/marc \
+ && sed -i.bak 's,BASE_INPUT_DIR=./input,BASE_INPUT_DIR=/opt/qa-catalogue/marc,' /opt/qa-catalogue/setdir.sh \
+ && sed -i.bak 's,BASE_OUTPUT_DIR=./output,BASE_OUTPUT_DIR=/opt/qa-catalogue/marc/_output,' /opt/qa-catalogue/setdir.sh \
  # install web application
  && apt-get update \
  && apt-get install -y --no-install-recommends \
@@ -65,57 +65,63 @@ RUN cd /opt \
       composer \
  && rm -rf /var/lib/apt/lists/* \
  && cd /var/www/html/ \
-# && curl -s -L https://github.com/pkiraly/metadata-qa-marc-web/archive/refs/heads/main.zip --output master.zip \
-# && curl -s -L https://github.com/pkiraly/metadata-qa-marc-web/archive/${QA_CATALOGUE_VERSION}.zip --output master.zip \
- && curl -s -L https://github.com/pkiraly/metadata-qa-marc-web/archive/refs/tags/v${QA_CATALOGUE_WEB_VERSION}.zip --output master.zip \
+# && curl -s -L https://github.com/pkiraly/qa-catalogue-web/archive/refs/heads/main.zip --output master.zip \
+# && curl -s -L https://github.com/pkiraly/qa-catalogue-web/archive/${QA_CATALOGUE_VERSION}.zip --output master.zip \
+ && curl -s -L https://github.com/pkiraly/qa-catalogue-web/archive/refs/tags/v${QA_CATALOGUE_WEB_VERSION}.zip --output master.zip \
  && ls -la \
  && unzip -q master.zip \
  && rm master.zip \
-# && mv metadata-qa-marc-web-0.4 metadata-qa \
- && mv metadata-qa-marc-web-${QA_CATALOGUE_WEB_VERSION} metadata-qa \
- && cd metadata-qa \
+# && mv qa-catalogue-web-0.4 qa-catalogue \
+ && mv qa-catalogue-web-${QA_CATALOGUE_WEB_VERSION} qa-catalogue \
+ && cd qa-catalogue \
  && composer install \
- && echo dir=/opt/metadata-qa-marc/marc/_output > /var/www/html/metadata-qa/configuration.cnf \
- # && cp /var/www/html/metadata-qa/configuration.js.template /var/www/html/metadata-qa/configuration.js \
- && touch /var/www/html/metadata-qa/selected-facets.js \
- && mkdir /var/www/html/metadata-qa/cache \
- && chown www-data:www-data -R /var/www/html/metadata-qa/cache \
- && chmod g+w -R /var/www/html/metadata-qa/cache \
+ && echo dir=/opt/qa-catalogue/marc/_output > /var/www/html/qa-catalogue/configuration.cnf \
+ # && cp /var/www/html/qa-catalogue/configuration.js.template /var/www/html/qa-catalogue/configuration.js \
+ && touch /var/www/html/qa-catalogue/selected-facets.js \
+ && mkdir /var/www/html/qa-catalogue/cache \
+ && chown www-data:www-data -R /var/www/html/qa-catalogue/cache \
+ && chmod g+w -R /var/www/html/qa-catalogue/cache \
  && touch cache/selected-facets.js \
  && mkdir _smarty \
  && chgrp www-data -R _smarty \
  && chmod g+w -R _smarty \
- && mkdir /var/www/html/metadata-qa/libs \
- && mkdir /var/www/html/metadata-qa/images \
-# && cd /var/www/html/metadata-qa/libs/ \
+ && mkdir /var/www/html/qa-catalogue/libs \
+ && mkdir /var/www/html/qa-catalogue/images \
+# && cd /var/www/html/qa-catalogue/libs/ \
 # && curl -s -L https://github.com/smarty-php/smarty/archive/v${SMARTY_VERSION}.zip --output v$SMARTY_VERSION.zip \
 # && unzip -q v${SMARTY_VERSION}.zip \
 # && rm v${SMARTY_VERSION}.zip \
-# && mkdir -p /var/www/html/metadata-qa/libs/_smarty/templates_c \
-# && chmod a+w -R /var/www/html/metadata-qa/libs/_smarty/templates_c/ \
- && sed -i.bak 's,</VirtualHost>,        RedirectMatch ^/$ /metadata-qa/\n        <Directory /var/www/html/metadata-qa>\n                Options Indexes FollowSymLinks MultiViews\n                AllowOverride All\n                Order allow\,deny\n                allow from all\n                DirectoryIndex index.php index.html\n        </Directory>\n</VirtualHost>,' /etc/apache2/sites-available/000-default.conf \
- && echo "\nWEB_DIR=/var/www/html/metadata-qa/\n" >> /opt/metadata-qa-marc/common-variables
+# && mkdir -p /var/www/html/qa-catalogue/libs/_smarty/templates_c \
+# && chmod a+w -R /var/www/html/qa-catalogue/libs/_smarty/templates_c/ \
+ && sed -i.bak 's,</VirtualHost>,        RedirectMatch ^/$ /qa-catalogue/\n        <Directory /var/www/html/qa-catalogue>\n                Options Indexes FollowSymLinks MultiViews\n                AllowOverride All\n                Order allow\,deny\n                allow from all\n                DirectoryIndex index.php index.html\n        </Directory>\n</VirtualHost>,' /etc/apache2/sites-available/000-default.conf \
+ && echo "\nWEB_DIR=/var/www/html/qa-catalogue/\n" >> /opt/qa-catalogue/common-variables
 
 # install Solr
-RUN apt-get update \
+RUN echo "install lsof" \
+ && apt-get update \
  && apt-get install -y --no-install-recommends \
       lsof \
  && apt-get --assume-yes autoremove \
  && rm -rf /var/lib/apt/lists/* \
+ && echo "install solr" \
  && cd /opt \
- && curl -s -L http://archive.apache.org/dist/lucene/solr/${SOLR_VERSION}/solr-${SOLR_VERSION}.zip --output solr-${SOLR_VERSION}.zip \
+ && echo "download solr-${SOLR_VERSION}" \
+ && curl -L http://archive.apache.org/dist/lucene/solr/${SOLR_VERSION}/solr-${SOLR_VERSION}.zip --output solr-${SOLR_VERSION}.zip \
+ && echo "unzip solr" \
  && unzip -q solr-${SOLR_VERSION}.zip \
  && rm solr-${SOLR_VERSION}.zip \
+ && echo "linking solr" \
  && ln -s solr-${SOLR_VERSION} solr
 
-# init process configuration
-RUN apt-get update \
+# init process supervisor
+RUN echo "install supervisor" \
+ && apt-get update \
  && apt-get install -y --no-install-recommends supervisor \
  && mkdir -p /var/log/supervisor \
  && rm -rf /var/lib/apt/lists/*
 
 COPY docker/supervisord.conf /etc/
 
-WORKDIR /opt/metadata-qa-marc
+WORKDIR /opt/qa-catalogue
 
 CMD ["/usr/bin/supervisord", "-c", "/etc/supervisord.conf"]

INSTALL.md

@@ -45,8 +45,8 @@ ln -s solr-${SOLR_VERSION} solr
 ## Download and Configure QA catalogue
 
 ```bash
-export VERSION=0.5.0
-wget https://github.com/pkiraly/metadata-qa-marc/releases/download/v${VERSION}/metadata-qa-marc-${VERSION}-release.zip
+export VERSION=0.6.0
+wget https://github.com/pkiraly/qa-catalogue/releases/download/v${VERSION}/metadata-qa-marc-${VERSION}-release.zip
 unzip metadata-qa-marc-$VERSION-release.zip
 cd metadata-qa-marc-$VERSION
 cp setdir.sh.template setdir.sh

common-variables

@@ -1,3 +1,3 @@
-VERSION=0.7.0-rc1
-JAR=target/metadata-qa-marc-${VERSION}-jar-with-dependencies.jar
+VERSION=0.7.0-rc2
+JAR=target/qa-catalogue-${VERSION}-jar-with-dependencies.jar
 DIR=.

pom.xml

@@ -3,12 +3,12 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>de.gwdg.metadataqa</groupId>
-	<artifactId>metadata-qa-marc</artifactId>
+	<artifactId>qa-catalogue</artifactId>
 	<packaging>jar</packaging>
-	<version>0.7.0-rc1</version>
-	<name>Quality assessment for MARC</name>
+	<version>0.7.0-rc2</version>
+	<name>Quality assessment for bibliogaphic records</name>
 	<description>
-		A metadata quality assessment framework for MARC21 records.
+		A metadata quality assessment framework for bibliogaphic (MARC21 and PICA) records.
 		It checks some metrics of metadata records, such as completeness,
 		uniqueness, problem catalog.
 	</description>
@@ -37,9 +37,9 @@
 	</licenses>
 
 	<scm>
-		<connection>scm:git:[email protected]:pkiraly/metadata-qa-marc.git</connection>
-		<developerConnection>scm:git:[email protected]:pkiraly/metadata-qa-marc.git</developerConnection>
-		<url>http://github.com/pkiraly/metadata-qa-marc</url>
+		<connection>scm:git:[email protected]:pkiraly/qa-catalogue.git</connection>
+		<developerConnection>scm:git:[email protected]:pkiraly/qa-catalogue.git</developerConnection>
+		<url>http://github.com/pkiraly/qa-catalogue</url>
 	</scm>
 
 	<distributionManagement>
@@ -308,7 +308,7 @@
 				</configuration>
 			</plugin>
 			<!-- Autogenerated code coverage reports published at
-			     https://coveralls.io/github/pkiraly/metadata-qa-marc -->
+			     https://coveralls.io/github/pkiraly/qa-catalogue -->
 			<plugin>
 				<groupId>org.eluder.coveralls</groupId>
 				<artifactId>coveralls-maven-plugin</artifactId>
@@ -366,14 +366,14 @@
 				<directory>src/main/resources</directory>
 				<filtering>true</filtering>
 				<includes>
-					<include>**/metadata-qa-marc.version.prop</include>
+					<include>**/qa-catalogue.version.prop</include>
 				</includes>
 			</resource>
 			<resource>
 				<directory>src/main/resources</directory>
 				<filtering>false</filtering>
 				<excludes>
-					<exclude>**/metadata-qa-marc.version.prop</exclude>
+					<exclude>**/qa-catalogue.version.prop</exclude>
 				</excludes>
 			</resource>
 		</resources>

scripts/tt-histogram/tt-histogram-from-no-ids.R

@@ -25,7 +25,7 @@ if (!file.exists(csv)) {
   stop(paste("input file", csv, "does not exist!"))
 }
 print(csv)
-df <- read_csv(csv, col_types = cols(.default = col_integer(), id = col_character()), progress = TRUE, trim_ws = FALSE, show_col_types = FALSE)
+df <- read_csv(csv, col_types = cols(.default = col_integer(), id = col_character()), progress = TRUE, trim_ws = FALSE)
 print("read")
 names <- names(df)
 

scripts/tt-histogram/tt-histogram.R

@@ -24,7 +24,7 @@ csv <- sprintf("%s/%s.csv", output_dir, prefix)
 if (!file.exists(csv)) {
   stop(paste("input file", csv, "does not exist!"))
 }
-df <- read_csv(csv, col_types = cols(.default = col_integer(), id = col_character()), progress = TRUE, trim_ws = FALSE, show_col_types = FALSE)
+df <- read_csv(csv, col_types = cols(.default = col_integer(), id = col_character()), progress = TRUE, trim_ws = FALSE)
 df <- df %>% 
   select(-id)
 names <- names(df)

src/main/java/de/gwdg/metadataqa/marc/cli/Completeness.java

@@ -445,7 +445,7 @@ private char getSeparator(ValidationErrorFormat format) {
   @Override
   public void printHelp(Options options) {
     HelpFormatter formatter = new HelpFormatter();
-    String message = String.format("java -cp metadata-qa-marc.jar %s [options] [file]", this.getClass().getCanonicalName());
+    String message = String.format("java -cp qa-catalogue.jar %s [options] [file]", this.getClass().getCanonicalName());
     formatter.printHelp(message, options);
   }
 

src/main/java/de/gwdg/metadataqa/marc/cli/DataElements.java

@@ -136,7 +136,7 @@ private char getSeparator(ValidationErrorFormat format) {
   @Override
   public void printHelp(Options options) {
     HelpFormatter formatter = new HelpFormatter();
-    String message = String.format("java -cp metadata-qa-marc.jar %s [options] [file]", this.getClass().getCanonicalName());
+    String message = String.format("java -cp qa-catalogue.jar %s [options] [file]", this.getClass().getCanonicalName());
     formatter.printHelp(message, options);
   }
 

src/main/java/de/gwdg/metadataqa/marc/cli/Formatter.java

@@ -25,7 +25,7 @@
 
 /**
  * usage:
- * java -cp target/metadata-qa-marc-0.1-SNAPSHOT-jar-with-dependencies.jar de.gwdg.metadataqa.marc.cli.Validator [MARC21 file]
+ * java -cp target/qa-catalogue-0.1-SNAPSHOT-jar-with-dependencies.jar de.gwdg.metadataqa.marc.cli.Validator [MARC21 file]
  *
  * @author Péter Király <peter.kiraly at gwdg.de>
  */
@@ -61,7 +61,7 @@ public static void main(String[] args) throws ParseException {
   @Override
   public void printHelp(Options options) {
     HelpFormatter formatter = new HelpFormatter();
-    String message = String.format("java -cp metadata-qa-marc.jar %s [options] [file]", this.getClass().getCanonicalName());
+    String message = String.format("java -cp qa-catalogue.jar %s [options] [file]", this.getClass().getCanonicalName());
     formatter.printHelp(message, options);
   }
 

src/main/java/de/gwdg/metadataqa/marc/cli/MarcToSolr.java

@@ -31,7 +31,7 @@
 
 /**
  * usage:
- * java -cp target/metadata-qa-marc-0.1-SNAPSHOT-jar-with-dependencies.jar de.gwdg.metadataqa.marc.cli.SolrKeyGenerator http://localhost:8983/solr/tardit 0001.0000000.formatted.json
+ * java -cp target/qa-catalogue-0.1-SNAPSHOT-jar-with-dependencies.jar de.gwdg.metadataqa.marc.cli.SolrKeyGenerator http://localhost:8983/solr/tardit 0001.0000000.formatted.json
  *
  * @author Péter Király <peter.kiraly at gwdg.de>
  */
@@ -164,7 +164,7 @@ public void afterIteration(int numberOfprocessedRecords) {
   @Override
   public void printHelp(Options options) {
     HelpFormatter formatter = new HelpFormatter();
-    String message = String.format("java -cp metadata-qa-marc.jar %s [options] [file]", this.getClass().getCanonicalName());
+    String message = String.format("java -cp qa-catalogue.jar %s [options] [file]", this.getClass().getCanonicalName());
     formatter.printHelp(message, options);
   }
 

src/main/java/de/gwdg/metadataqa/marc/cli/SerialScore.java

@@ -32,7 +32,7 @@
 
 /**
  * usage:
- * java -cp target/metadata-qa-marc-0.1-SNAPSHOT-jar-with-dependencies.jar \
+ * java -cp target/qa-catalogue-0.1-SNAPSHOT-jar-with-dependencies.jar \
  * de.gwdg.metadataqa.marc.cli.SerialScore [MARC21 file]
  *
  * @author Péter Király <peter.kiraly at gwdg.de>
@@ -158,7 +158,7 @@ public boolean readyToProcess() {
   public void printHelp(Options options) {
     HelpFormatter formatter = new HelpFormatter();
     String message = String.format(
-      "java -cp metadata-qa-marc.jar %s [options] [file]",
+      "java -cp qa-catalogue.jar %s [options] [file]",
       this.getClass().getCanonicalName()
     );
     formatter.printHelp(message, options);

src/main/java/de/gwdg/metadataqa/marc/cli/ShelfReadyCompleteness.java

@@ -35,7 +35,7 @@
 
 /**
  * usage:
- * java -cp target/metadata-qa-marc-0.1-SNAPSHOT-jar-with-dependencies.jar \
+ * java -cp target/qa-catalogue-0.1-SNAPSHOT-jar-with-dependencies.jar \
  * de.gwdg.metadataqa.marc.cli.ShelfReadyCompleteness [MARC21 file]
  *
  * @author Péter Király <peter.kiraly at gwdg.de>
@@ -151,7 +151,7 @@ public boolean readyToProcess() {
   public void printHelp(Options options) {
     HelpFormatter formatter = new HelpFormatter();
     String message = String.format(
-      "java -cp metadata-qa-marc.jar %s [options] [file]",
+      "java -cp qa-catalogue.jar %s [options] [file]",
       this.getClass().getCanonicalName()
     );
     formatter.printHelp(message, options);

src/main/java/de/gwdg/metadataqa/marc/cli/ThompsonTraillCompleteness.java

@@ -32,7 +32,7 @@
 
 /**
  * usage:
- * java -cp target/metadata-qa-marc-0.1-SNAPSHOT-jar-with-dependencies.jar \
+ * java -cp target/qa-catalogue-0.1-SNAPSHOT-jar-with-dependencies.jar \
  * de.gwdg.metadataqa.marc.cli.ThompsonTraillCompleteness [MARC21 file]
  *
  * @author Péter Király <peter.kiraly at gwdg.de>
@@ -136,7 +136,7 @@ public boolean readyToProcess() {
   public void printHelp(Options options) {
     HelpFormatter formatter = new HelpFormatter();
     String message = String.format(
-      "java -cp metadata-qa-marc.jar %s [options] [file]",
+      "java -cp qa-catalogue.jar %s [options] [file]",
       this.getClass().getCanonicalName()
     );
     formatter.printHelp(message, options);

src/main/java/de/gwdg/metadataqa/marc/cli/ValidatorCli.java

@@ -34,7 +34,7 @@
 
 /**
  * usage:
- * java -cp target/metadata-qa-marc-0.1-SNAPSHOT-jar-with-dependencies.jar de.gwdg.metadataqa.marc.cli.Validator [MARC21 file]
+ * java -cp target/qa-catalogue-0.1-SNAPSHOT-jar-with-dependencies.jar de.gwdg.metadataqa.marc.cli.Validator [MARC21 file]
  *
  * @author Péter Király <peter.kiraly at gwdg.de>
  */
@@ -109,7 +109,7 @@ public static void main(String[] args) {
 
   public void printHelp(Options opions) {
     HelpFormatter formatter = new HelpFormatter();
-    String message = String.format("java -cp metadata-qa-marc.jar %s [options] [file]",
+    String message = String.format("java -cp qa-catalogue.jar %s [options] [file]",
       this.getClass().getCanonicalName());
     formatter.printHelp(message, options);
   }

src/main/java/de/gwdg/metadataqa/marc/cli/Version.java

@@ -33,7 +33,7 @@ private static void initialize() {
   }
 
   public static String readVersionFromPropertyFile() {
-    String path = "/metadata-qa-marc.version.prop";
+    String path = "/qa-catalogue.version.prop";
     InputStream stream = de.gwdg.metadataqa.marc.cli.Version.class.getResourceAsStream(path);
     if (stream == null) {
       return "UNKNOWN";

src/main/java/de/gwdg/metadataqa/marc/cli/utils/MarcJsonToSolr.java

@@ -17,7 +17,7 @@
 
 /**
  * usage:
- * java -cp target/metadata-qa-marc-0.1-SNAPSHOT-jar-with-dependencies.jar de.gwdg.metadataqa.marc.cli.SolrKeyGenerator http://localhost:8983/solr/tardit 0001.0000000.formatted.json
+ * java -cp target/qa-catalogue-0.1-SNAPSHOT-jar-with-dependencies.jar de.gwdg.metadataqa.marc.cli.SolrKeyGenerator http://localhost:8983/solr/tardit 0001.0000000.formatted.json
  *
  * @author Péter Király <peter.kiraly at gwdg.de>
  */

src/main/java/de/gwdg/metadataqa/marc/cli/utils/RecordIterator.java

@@ -33,7 +33,7 @@
 
 /**
  * usage:
- * java -cp target/metadata-qa-marc-0.1-SNAPSHOT-jar-with-dependencies.jar de.gwdg.metadataqa.marc.cli.Validator [MARC21 file]
+ * java -cp target/qa-catalogue-0.1-SNAPSHOT-jar-with-dependencies.jar de.gwdg.metadataqa.marc.cli.Validator [MARC21 file]
  * @author Péter Király <peter.kiraly at gwdg.de>
  */
 public class RecordIterator {
@@ -254,7 +254,7 @@ private static boolean isUnderOffset(int offset, int i) {
 
   private static void printHelp(Options opions) {
     HelpFormatter formatter = new HelpFormatter();
-    formatter.printHelp("java -cp metadata-qa-marc.jar de.gwdg.metadataqa.marc.cli.Validator [options] [file]",
+    formatter.printHelp("java -cp qa-catalogue.jar de.gwdg.metadataqa.marc.cli.Validator [options] [file]",
       opions);
   }