Commit bd00c913 authored by David Gnabasik's avatar David Gnabasik
Browse files

Removed ignoreDocumentation in clause 9. Added clauses 10, 10.2, 10.2.

parent 161589d6

src/main/java/fr/mines_stetienne/ci/saref/checkers/Clause_9_7_1_Checker.java

+2 −20
Original line number Diff line number Diff line
@@ -26,30 +26,12 @@ 
package fr.mines_stetienne.ci.saref.checkers;



import java.io.File;

import java.io.FileOutputStream;

import java.io.FileReader;

import java.io.IOException;

import java.nio.charset.StandardCharsets;

import java.util.HashMap;

import java.util.List;

import java.util.Map;



import org.apache.commons.io.FileUtils;

import org.apache.jena.rdf.model.Model;

import org.apache.jena.rdf.model.Resource;

import org.apache.jena.vocabulary.DCTerms;

import org.apache.jena.vocabulary.RDF;



import com.opencsv.CSVParser;

import com.opencsv.CSVParserBuilder;

import com.opencsv.CSVReader;

import com.opencsv.CSVReaderBuilder;



import fr.mines_stetienne.ci.saref.SAREFPipelineException;

import fr.mines_stetienne.ci.saref.managers.GenerateRDFaManager;

import fr.mines_stetienne.ci.saref.managers.RepositoryManager;

import fr.mines_stetienne.ci.saref.utils.Languages;

import fr.mines_stetienne.ci.saref.vocabs.VTC;



/**

 * Checks TS 103 673 Clause 9.7.1: documentation files.
@@ -57,8 +39,8 @@ import fr.mines_stetienne.ci.saref.vocabs.VTC; 
 */

public class Clause_9_7_1_Checker extends AbstractClauseChecker {



	private static enum MESSAGE {

		ioexception;

	private enum MESSAGE {

		ioexception

	}



	private static final Map<String, String> DEFAULTVALUES = new HashMap<String, String>();

src/main/java/fr/mines_stetienne/ci/saref/checkers/Clause_9_7_2_Checker.java

+2 −22
Original line number Diff line number Diff line
@@ -26,29 +26,9 @@ 
package fr.mines_stetienne.ci.saref.checkers;



import java.io.File;

import java.io.FileOutputStream;

import java.io.FileReader;

import java.io.IOException;

import java.nio.charset.StandardCharsets;

import java.util.List;

import java.util.Map;



import org.apache.commons.io.FileUtils;

import org.apache.jena.rdf.model.Model;

import org.apache.jena.rdf.model.Resource;

import org.apache.jena.vocabulary.DCTerms;

import org.apache.jena.vocabulary.RDF;



import com.opencsv.CSVParser;

import com.opencsv.CSVParserBuilder;

import com.opencsv.CSVReader;

import com.opencsv.CSVReaderBuilder;



import fr.mines_stetienne.ci.saref.SAREFPipelineException;

import fr.mines_stetienne.ci.saref.managers.GenerateRDFaManager;

import fr.mines_stetienne.ci.saref.managers.RepositoryManager;

import fr.mines_stetienne.ci.saref.utils.Languages;

import fr.mines_stetienne.ci.saref.vocabs.VTC;



/**

 * Checks TS 103 673 Clause 9.7.2: documentation diagrams.
@@ -56,8 +36,8 @@ import fr.mines_stetienne.ci.saref.vocabs.VTC; 
 */

public class Clause_9_7_2_Checker extends AbstractClauseChecker {



	private static enum MESSAGE {

		ioexception, one;

	private enum MESSAGE {

		ioexception, one

	}



	public Clause_9_7_2_Checker(RepositoryManager repositoryManager) {

src/main/java/fr/mines_stetienne/ci/saref/checkers/Clause_9_7_Checker.java

+10 −6
Original line number Diff line number Diff line
@@ -25,11 +25,7 @@ 
 */

package fr.mines_stetienne.ci.saref.checkers;



import java.io.File;

import java.io.IOException;



import fr.mines_stetienne.ci.saref.SAREFPipelineException;

import fr.mines_stetienne.ci.saref.entities.SAREFExample;

import fr.mines_stetienne.ci.saref.managers.RepositoryManager;



/**
@@ -38,13 +34,21 @@ import fr.mines_stetienne.ci.saref.managers.RepositoryManager; 
 */

public class Clause_9_7_Checker extends AbstractClauseChecker {



	private enum MESSAGE {

		error

	}



	public Clause_9_7_Checker(RepositoryManager repositoryManager) {

		super(repositoryManager, Clause_9_7_Checker.class);

	}



	@Override

	public void checkClause() throws SAREFPipelineException {

		try {

			new Clause_9_7_1_Checker(repositoryManager).check();

			new Clause_9_7_2_Checker(repositoryManager).check();

		} catch (SAREFPipelineException ex) {

			logError(getMessage(Clause_9_7_Checker.MESSAGE.error), ex);

		}

	}

}

src/main/java/fr/mines_stetienne/ci/saref/managers/SourcesManager.java

+3 −0
Original line number Diff line number Diff line
@@ -56,6 +56,7 @@ import fr.mines_stetienne.ci.saref.SAREFPipeline; 
import fr.mines_stetienne.ci.saref.SAREFPipelineException;

import fr.mines_stetienne.ci.saref.SAREFPipeline.Mode;

import fr.mines_stetienne.ci.saref.checkers.Clause_9_Checker;

import fr.mines_stetienne.ci.saref.checkers.Clause_10_Checker;

import fr.mines_stetienne.ci.saref.checkers.TermsChecker;

import fr.mines_stetienne.ci.saref.entities.SAREFProject;

import fr.mines_stetienne.ci.saref.entities.SAREFRepository;
@@ -254,6 +255,7 @@ public class SourcesManager extends SAREFErrorLogger { 
		if (targetRepositoryManager != null) {

			// Mode is DEVELOP or RELEASE.

			new Clause_9_Checker(targetRepositoryManager).check();

			new Clause_10_Checker(targetRepositoryManager).check();

		} else {

			// Mode is PORTAL. Check every source

			boolean hasErrors = false;
@@ -266,6 +268,7 @@ public class SourcesManager extends SAREFErrorLogger { 
					try {

						repositoryManager.checkoutVersion(versionName);

						new Clause_9_Checker(repositoryManager).check();

						new Clause_10_Checker(repositoryManager).check();

					} catch (SAREFPipelineException ex) {

						hasErrors = true;

					}

src/main/resources/messages/Clause_9_7_Checker.properties

+1 −3
Original line number Diff line number Diff line 
directories=The `documentation` directory shall contain a directory `diagrams`. The `documentation` directory should optionally contain the following files in html format (with file extension .html) or markdown format (with file extension .md): creators.html, contributors.html, abstract.html, description.html, examples.html, references.html, and acknowledgement.html. These optional files shall conform to the documentation specification as defined in clause 9.7.1 in TS 103 673.

ioexception=Error while checking the `documentation` directory.

error=Clause 9.4 cannot be checked due to some error
 
 No newline at end of file