Merge pull request #51 from DILCISBoard/rel/0.2.0

REL: v0.2.0

Author: carlwilson

pandoc/templates/eisvogel.latex

@@ -511,7 +511,7 @@ $endif$
 \usepackage[font={stretch=1.2}, textfont={color=caption-color}, position=top, skip=4mm, labelfont=bf, singlelinecheck=false, justification=$if(caption-justification)$$caption-justification$$else$raggedright$endif$]{caption}
 \setcapindent{0em}
 \captionsetup[longtable]{position=above}
-
+\renewcommand \caption [2][]{}
 %
 % blockquote
 %

pom.xml

@@ -3,7 +3,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>eu.dilcis</groupId>
 	<artifactId>eark-csip-profile-processor</artifactId>
-	<version>0.1.0-SNAPSHOT</version>
+	<version>0.2.0-SNAPSHOT</version>
 	<name>E-ARK CSIP METS Profile processor</name>
 	<description>SAX parser to generate Markdown requirement tables from the E-ARK CSIP METS Profile.</description>
 

res/md/common-intro.md

@@ -8,7 +8,7 @@ A visualisation of the current specification network can be seen here:
 <a name="figi-dip"></a>
 ![OAIS Entities](figs/fig_1_dip.png "Diagram showing E-ARK specification dependency hierarchy")
 
-**Figure I:** Diagram showing E-ARK specification dependency hierarchy. Note that the image only shows a selection of the published CITS and isn't an exhaustive list.
+**Figure 1:** Diagram showing E-ARK specification dependency hierarchy. Note that the image only shows a selection of the published CITS and isn't an exhaustive list.
 
 ### Overview of the E-ARK Specifications
 

src/main/java/eu/dilcis/csip/MetsProfileProcessor.java

@@ -9,6 +9,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
+import java.util.Set;
 import java.util.concurrent.Callable;
 
 import org.xml.sax.SAXException;
@@ -50,6 +51,37 @@ public static void main(final String[] args) {
         System.exit(exitCode);
     }
 
+    private static void serialiseProfile(final Set<Entry<Part, List<Source>>> entries, final boolean isPdf, final Path root)
+            throws IOException {
+        for (final Entry<Part, List<Source>> entry : entries) {
+            try (Writer writer = new FileWriter(root.resolve(entry.getKey().getFileName()).toFile())) {
+                serialisePart(entry.getKey(), entry.getValue(), isPdf, writer);
+            }
+        }
+    }
+
+    private static void serialisePart(final Part part, final List<Source> sources, final boolean isPdf,
+            final Writer writer) throws IOException {
+        boolean isFirst = true;
+        for (final Source section : sources) {
+            if (Part.APPENDICES.equals(part)) {
+                final Map<String, Object> context = new java.util.HashMap<>();
+                context.put("heading", section.heading);
+                context.put("label", section.label);
+                context.put("isFirst", isFirst);
+                isFirst = false;
+                Utilities.serialiseToTemplate("eu/dilcis/csip/out/appendix_heading.mustache", context,
+                        writer);
+            }
+            section.serialise(writer, isPdf);
+            writer.write("\n");
+        }
+        if (Part.BODY.equals(part)) {
+            writer.write("!INCLUDE \"appendices.md\"\n");
+        }
+        writer.flush();
+    }
+
     @Parameters(paramLabel = "FILE", arity = "1..*", description = "A list of METS Profile documents to be processed.")
     private File[] metsProfiles;
 
@@ -75,54 +107,8 @@ public Integer call() {
         try {
             final StructFileParser structParser = StructFileParser.parserInstance(this.processProfiles());
             final SpecificationStructure specStructure = structParser.parseStructureFile(this.structureFile.toPath());
-            boolean isFirst = true;
-            for (Entry<Part, List<Source>> entry : specStructure.content.entrySet()) {
-                try (Writer writer = new FileWriter(this.destination.resolve(entry.getKey().getFileName()).toFile())) {
-                    if (Part.BODY.equals(entry.getKey())) {
-                        writer.write("!TOC\n\n");
-                    }
-                    for (Source section : entry.getValue()) {
-                        if (Part.APPENDICES.equals(entry.getKey())) {
-                            Map<String, Object> context = new java.util.HashMap<>();
-                            context.put("heading", section.heading);
-                            context.put("label", section.label);
-                            context.put("isFirst", isFirst);
-                            isFirst = false;
-                            Utilities.serialiseToTemplate("eu/dilcis/csip/out/appendix_heading.mustache", context,
-                                    writer);
-                        }
-                        section.serialise(writer, false);
-                        writer.write("\n");
-                    }
-                    if (Part.BODY.equals(entry.getKey())) {
-                        writer.write("!INCLUDE \"appendices.md\"\n");
-                    }
-                    writer.flush();
-                }
-            }
-            for (Entry<Part, List<Source>> entry : specStructure.content.entrySet()) {
-                isFirst = true;
-                try (Writer writer = new FileWriter(
-                        this.destination.resolve("../pdf").resolve(entry.getKey().getFileName()).toFile())) {
-                    for (Source section : entry.getValue()) {
-                        if (Part.APPENDICES.equals(entry.getKey())) {
-                            Map<String, Object> context = new java.util.HashMap<>();
-                            context.put("heading", section.heading);
-                            context.put("label", section.label);
-                            context.put("isFirst", isFirst);
-                            isFirst = false;
-                            Utilities.serialiseToTemplate("eu/dilcis/csip/out/appendix_heading.mustache", context,
-                                    writer);
-                        }
-                        section.serialise(writer, true);
-                        writer.write("\n");
-                    }
-                    if (Part.BODY.equals(entry.getKey())) {
-                        writer.write("!INCLUDE \"appendices.md\"\n");
-                    }
-                    writer.flush();
-                }
-            }
+            serialiseProfile(specStructure.content.entrySet(), false, this.destination);
+            serialiseProfile(specStructure.content.entrySet(), true, this.destination.resolve("../pdf"));
         } catch (SAXException | IOException excep) {
             // Basic for now, print the stack trace and trhow it
             excep.printStackTrace();
@@ -136,9 +122,9 @@ public Integer call() {
 
     private List<MetsProfile> processProfiles() throws SAXException, IOException {
         final List<MetsProfile> profiles = new ArrayList<>();
-        final MetsProfileParser parser = MetsProfileParser.newInstance();
         for (final File profileXmlFile : this.metsProfiles) {
             try {
+                final MetsProfileParser parser = MetsProfileParser.newInstance();
                 final MetsProfile profile = parser.processXmlProfile(profileXmlFile.toPath());
                 profiles.add(profile);
             } catch (SAXException | IOException excep) {

src/main/java/eu/dilcis/csip/profile/Appendix.java

@@ -7,12 +7,37 @@
 import org.xml.sax.Attributes;
 
 public final class Appendix {
+    static final class Builder extends XmlFragmentGenerator {
+        private int number;
+        private String label;
+
+        Builder(final Attributes attributes) {
+            this.number = Integer.valueOf(Utilities.getNumber(attributes));
+            this.label = (Utilities.getLabel(attributes));
+        }
+
+        Builder number(final int number) {
+            this.number = number;
+            return this;
+        }
+
+        Builder label(final String label) {
+            this.label = label;
+            return this;
+        }
+
+        Appendix build() {
+            return Appendix.fromValues(number, label, content);
+        }
+    }
+
     public static Appendix fromValues(final int number, final String label, final List<String> content) {
         return new Appendix(number, label, content);
     }
 
     public final int number;
     public final String label;
+
     public final List<String> content;
 
     private Appendix(final int number, final String label, final List<String> content) {
@@ -35,28 +60,4 @@ public boolean equals(final Object obj) {
         final Appendix other = (Appendix) obj;
         return number == other.number && Objects.equals(label, other.label) && Objects.equals(content, other.content);
     }
-
-    static final class Builder extends XmlFragmentGenerator {
-        private int number;
-        private String label;
-
-        Builder(Attributes attributes) {
-            this.number = Integer.valueOf(Utilities.getNumber(attributes));
-            this.label = (Utilities.getLabel(attributes));
-        }
-
-        Builder number(final int number) {
-            this.number = number;
-            return this;
-        }
-
-        Builder label(final String label) {
-            this.label = label;
-            return this;
-        }
-
-        Appendix build() {
-            return Appendix.fromValues(number, label, content);
-        }
-    }
 }

src/main/java/eu/dilcis/csip/profile/ControlledVocabulary.java

@@ -4,6 +4,7 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
+import java.util.Objects;
 
 /**
  * @author  <a href="mailto:carl@openpreservation.org">Carl Wilson</a>
@@ -71,7 +72,25 @@ public ControlledVocabulary build( ) {
 			return new ControlledVocabulary(this.ident, this.nm, this.mntnceAgncy, this.ri, this.cntxt, this.desc);
 		}
 	}
-	public final String id;
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(id, name, maintenanceAgency, uri, context);
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (this == obj)
+            return true;
+        if (!(obj instanceof ControlledVocabulary))
+            return false;
+        ControlledVocabulary other = (ControlledVocabulary) obj;
+        return Objects.equals(id, other.id) && Objects.equals(name, other.name)
+                && Objects.equals(maintenanceAgency, other.maintenanceAgency) && Objects.equals(uri, other.uri)
+                && Objects.equals(context, other.context);
+    }
+
+    public final String id;
 	public final String name;
 	public final String maintenanceAgency;
 	public final URI uri;

src/main/java/eu/dilcis/csip/profile/Example.java

@@ -1,39 +1,41 @@
 package eu.dilcis.csip.profile;
 
 import java.util.List;
+import java.util.Objects;
 
 import org.xml.sax.Attributes;
 
 public final class Example {
-    final String id;
-    final String label;
-    final List<String> content;
-
-    private Example(String id, String label, List<String> content) {
-        this.id = id;
-        this.label = label;
-        this.content = content;
-    }
-
-    static Example fromValues(String id, String label, List<String> content) {
-        return new Example(id, label, content);
-    }
-
     static class Builder extends XmlFragmentGenerator {
         private String id;
         private String label;
 
-        Builder(Attributes attributes) {
+        Builder(final Attributes attributes) {
             this.id = Utilities.getId(attributes);
             this.label = Utilities.getLabel(attributes);
         }
 
-        Builder id(String id) {
+        @Override
+        public int hashCode() {
+            return Objects.hash(id, label);
+        }
+
+        @Override
+        public boolean equals(final Object obj) {
+            if (this == obj)
+                return true;
+            if (!(obj instanceof Builder))
+                return false;
+            final Builder other = (Builder) obj;
+            return Objects.equals(id, other.id) && Objects.equals(label, other.label);
+        }
+
+        Builder id(final String id) {
             this.id = id;
             return this;
         }
 
-        Builder label(String label) {
+        Builder label(final String label) {
             this.label = label;
             return this;
         }
@@ -42,4 +44,36 @@ Example build() {
             return Example.fromValues(id, label, content);
         }
     }
+
+    static Example fromValues(final String id, final String label, final List<String> content) {
+        return new Example(id, label, content);
+    }
+
+    final String id;
+
+    final String label;
+
+    final List<String> content;
+
+    private Example(final String id, final String label, final List<String> content) {
+        this.id = id;
+        this.label = label;
+        this.content = content;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(id, label, content);
+    }
+
+    @Override
+    public boolean equals(final Object obj) {
+        if (this == obj)
+            return true;
+        if (!(obj instanceof Example))
+            return false;
+        final Example other = (Example) obj;
+        return Objects.equals(id, other.id) && Objects.equals(label, other.label)
+                && Objects.equals(content, other.content);
+    }
 }