From 161589d6ad43a6a52a38339f1d71476c050ea463 Mon Sep 17 00:00:00 2001 From: davidgnabasik Date: Thu, 8 Feb 2024 08:49:42 +0100 Subject: [PATCH] Changes(2) for clauses 9.3, 9.5, 9.6, 9.7, 9.8. --- .../ci/saref/CLIExecution.java | 13 +++------- .../ci/saref/SAREFPipeline.java | 6 ++--- .../ci/saref/checkers/Clause_9_8_Checker.java | 26 +++---------------- .../ci/saref/checkers/Clause_9_Checker.java | 7 +++-- .../ci/saref/gui/FunctionalitiesPanel.java | 11 -------- .../ci/saref/gui/MainFrame.java | 8 +----- .../ci/saref/managers/VersionSiteManager.java | 7 ----- src/main/resources/messages/SAREF.properties | 2 -- 8 files changed, 12 insertions(+), 68 deletions(-) diff --git a/src/main/java/fr/mines_stetienne/ci/saref/CLIExecution.java b/src/main/java/fr/mines_stetienne/ci/saref/CLIExecution.java index 2c83bf9..08fce0f 100644 --- a/src/main/java/fr/mines_stetienne/ci/saref/CLIExecution.java +++ b/src/main/java/fr/mines_stetienne/ci/saref/CLIExecution.java @@ -63,15 +63,10 @@ public class CLIExecution implements SAREFCredentialsProvider { private static final String ARG_IGNORE_TERMS_LONG = "no-terms"; private static final String ARG_IGNORE_TERMS_MAN = "Do not generate the static portal for terms"; - private static final String ARG_IGNORE_DOCUMENTATION = "d"; - private static final String ARG_IGNORE_DOCUMENTATION_LONG = "no-documentation"; - private static final String ARG_IGNORE_DOCUMENTATION_MAN = "Do not check documentation"; - private static final Options OPTIONS = new Options() .addOption(ARG_IGNORE_EXAMPLES, ARG_IGNORE_EXAMPLES_LONG, false, ARG_IGNORE_EXAMPLES_MAN) .addOption(ARG_IGNORE_TERMS, ARG_IGNORE_TERMS_LONG, false, ARG_IGNORE_TERMS_MAN) - .addOption(ARG_IGNORE_SITE, ARG_IGNORE_SITE_LONG, false, ARG_IGNORE_SITE_MAN) - .addOption(ARG_IGNORE_DOCUMENTATION, ARG_IGNORE_DOCUMENTATION_LONG, false, ARG_IGNORE_DOCUMENTATION_MAN); + .addOption(ARG_IGNORE_SITE, ARG_IGNORE_SITE_LONG, false, ARG_IGNORE_SITE_MAN); private static final Console console = System.console(); @@ -84,7 +79,6 @@ public class CLIExecution implements SAREFCredentialsProvider { final boolean ignoreExamples; final boolean ignoreTerms; final boolean ignoreSite; - final boolean ignoreDocumentation; final File directory; try { @@ -135,9 +129,8 @@ public class CLIExecution implements SAREFCredentialsProvider { ignoreExamples = cl.hasOption(ARG_IGNORE_EXAMPLES); ignoreTerms = cl.hasOption(ARG_IGNORE_TERMS); ignoreSite = cl.hasOption(ARG_IGNORE_SITE); - ignoreDocumentation = cl.hasOption(ARG_IGNORE_DOCUMENTATION); - - return new SAREFPipeline(this, directory, mode, ignoreExamples, ignoreTerms, ignoreSite, ignoreDocumentation); + + return new SAREFPipeline(this, directory, mode, ignoreExamples, ignoreTerms, ignoreSite); } catch (IOException | ParseException ex) { LOG.debug("Exception while parsing arguments", ex); throw new RuntimeException(); diff --git a/src/main/java/fr/mines_stetienne/ci/saref/SAREFPipeline.java b/src/main/java/fr/mines_stetienne/ci/saref/SAREFPipeline.java index 819e182..670457d 100644 --- a/src/main/java/fr/mines_stetienne/ci/saref/SAREFPipeline.java +++ b/src/main/java/fr/mines_stetienne/ci/saref/SAREFPipeline.java @@ -69,8 +69,7 @@ public class SAREFPipeline { public final boolean ignoreExamples; public final boolean ignoreTerms; public final boolean ignoreSite; - public final boolean ignoreDocumentation; - + private Logger logger; private DatasetManager datasetManager; private SiteManager siteManager; @@ -93,7 +92,7 @@ public class SAREFPipeline { return ontologyManager; } - public SAREFPipeline(SAREFCredentialsProvider credentialsProvider, File directory, Mode mode, boolean ignoreExamples, boolean ignoreTerms, boolean ignoreSite, boolean ignoreDocumentation) { + public SAREFPipeline(SAREFCredentialsProvider credentialsProvider, File directory, Mode mode, boolean ignoreExamples, boolean ignoreTerms, boolean ignoreSite) { this.credentialsProvider = credentialsProvider; this.directory = directory; targetDir = new File(directory, NAME_TARGET); @@ -101,7 +100,6 @@ public class SAREFPipeline { this.ignoreExamples = ignoreExamples; this.ignoreTerms = ignoreTerms; this.ignoreSite = ignoreSite; - this.ignoreDocumentation = ignoreDocumentation; } public TestSuites run() { diff --git a/src/main/java/fr/mines_stetienne/ci/saref/checkers/Clause_9_8_Checker.java b/src/main/java/fr/mines_stetienne/ci/saref/checkers/Clause_9_8_Checker.java index 970bff8..fef92e3 100644 --- a/src/main/java/fr/mines_stetienne/ci/saref/checkers/Clause_9_8_Checker.java +++ b/src/main/java/fr/mines_stetienne/ci/saref/checkers/Clause_9_8_Checker.java @@ -26,31 +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.nio.file.Files; import java.util.List; -import java.util.stream.Collectors; - -import fr.mines_stetienne.ci.saref.SAREF; 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.8: Vocabularies @@ -60,8 +41,8 @@ public class Clause_9_8_Checker extends AbstractClauseChecker { private static final String FIRST_LINE = "Id;Vocabulary;Requirement"; //<<< - private static enum MESSAGE { - missing, ioexception, line; + private enum MESSAGE { + missing, ioexception, line } public Clause_9_8_Checker(RepositoryManager repositoryManager) { @@ -87,9 +68,8 @@ public class Clause_9_8_Checker extends AbstractClauseChecker { return; } List lines = FileUtils.readLines(file, StandardCharsets.UTF_8); - if (lines.size() < 1 || !lines.get(0).equals(FIRST_LINE)) { + if (lines.isEmpty() || !lines.get(0).equals(FIRST_LINE)) { logError(getMessage(MESSAGE.line)); - return; } } catch (IOException ex) { logError(getMessage(MESSAGE.ioexception), ex); diff --git a/src/main/java/fr/mines_stetienne/ci/saref/checkers/Clause_9_Checker.java b/src/main/java/fr/mines_stetienne/ci/saref/checkers/Clause_9_Checker.java index 415f06c..41f7b7c 100644 --- a/src/main/java/fr/mines_stetienne/ci/saref/checkers/Clause_9_Checker.java +++ b/src/main/java/fr/mines_stetienne/ci/saref/checkers/Clause_9_Checker.java @@ -34,8 +34,8 @@ import fr.mines_stetienne.ci.saref.managers.RepositoryManager; */ public class Clause_9_Checker extends AbstractClauseChecker { - private static enum MESSAGE { - error; + private enum MESSAGE { + error } public Clause_9_Checker(RepositoryManager repositoryManager) { @@ -51,9 +51,8 @@ public class Clause_9_Checker extends AbstractClauseChecker { new Clause_9_5_Checker(repositoryManager).check(); if(!pipeline.ignoreExamples) { new Clause_9_6_Checker(repositoryManager).check(); - } - if(!pipeline.ignoreDocumentation) { new Clause_9_7_Checker(repositoryManager).check(); + new Clause_9_8_Checker(repositoryManager).check(); } } catch (SAREFPipelineException ex) { logError(getMessage(MESSAGE.error), ex); diff --git a/src/main/java/fr/mines_stetienne/ci/saref/gui/FunctionalitiesPanel.java b/src/main/java/fr/mines_stetienne/ci/saref/gui/FunctionalitiesPanel.java index 3bca727..f2be19b 100644 --- a/src/main/java/fr/mines_stetienne/ci/saref/gui/FunctionalitiesPanel.java +++ b/src/main/java/fr/mines_stetienne/ci/saref/gui/FunctionalitiesPanel.java @@ -51,7 +51,6 @@ public class FunctionalitiesPanel extends JPanel { final JCheckBox ignoreSite; final JCheckBox ignoreExamples; final JCheckBox ignoreTerms; - final JCheckBox ignoreDocumentation; public FunctionalitiesPanel(MainFrame mainFrame) { super(); @@ -141,22 +140,12 @@ public class FunctionalitiesPanel extends JPanel { } }); - ignoreDocumentation = new JCheckBox(SAREF.getMessage("ignoreDocumentation"), false); - ignoreDocumentation.setToolTipText(SAREF.getMessage("ignoreDocumentation_tooltip")); - ignoreDocumentation.addActionListener(new ActionListener() { - @Override - public void actionPerformed(ActionEvent e) { - mainFrame.setIgnoreDocumentation(ignoreDocumentation.isSelected()); - } - }); - JPanel panel3 = new JPanel(); panel3.setLayout(new BoxLayout(panel3, BoxLayout.Y_AXIS)); panel3.add(new JLabel(SAREF.getMessage("options"))); panel3.add(ignoreSite); panel3.add(ignoreExamples); panel3.add(ignoreTerms); - panel3.add(ignoreDocumentation); add(panel3); start = new JButton(SAREF.getMessage("run")); diff --git a/src/main/java/fr/mines_stetienne/ci/saref/gui/MainFrame.java b/src/main/java/fr/mines_stetienne/ci/saref/gui/MainFrame.java index 231f03e..830f115 100644 --- a/src/main/java/fr/mines_stetienne/ci/saref/gui/MainFrame.java +++ b/src/main/java/fr/mines_stetienne/ci/saref/gui/MainFrame.java @@ -62,7 +62,6 @@ public class MainFrame extends JFrame implements SAREFCredentialsProvider { private boolean ignoreExamples = false; private boolean ignoreTerms = false; private boolean ignoreSite = false; - private boolean ignoreDocumentation = false; private final InfoPanel infoPanel = new InfoPanel(); private final FunctionalitiesPanel functionalitiesPanel = new FunctionalitiesPanel(this); @@ -110,10 +109,6 @@ public class MainFrame extends JFrame implements SAREFCredentialsProvider { this.ignoreTerms = ignoreTerms; } - public void setIgnoreDocumentation(boolean ignoreDocumentation) { - this.ignoreDocumentation = ignoreDocumentation; - } - private class FileChooserActionListener implements ActionListener { private final MainFrame mainFrame; @@ -144,8 +139,7 @@ public class MainFrame extends JFrame implements SAREFCredentialsProvider { @Override public void actionPerformed(ActionEvent e) { - SAREFPipeline pipeline = new SAREFPipeline(mainFrame, directory, mode, ignoreExamples, ignoreTerms, - ignoreSite, ignoreDocumentation); + SAREFPipeline pipeline = new SAREFPipeline(mainFrame, directory, mode, ignoreExamples, ignoreTerms, ignoreSite); consolePanel.clear(); TestSuites testSuites = pipeline.run(); if(pipeline.mode == Mode.CLEAN) { diff --git a/src/main/java/fr/mines_stetienne/ci/saref/managers/VersionSiteManager.java b/src/main/java/fr/mines_stetienne/ci/saref/managers/VersionSiteManager.java index b3ef36e..4b461d6 100644 --- a/src/main/java/fr/mines_stetienne/ci/saref/managers/VersionSiteManager.java +++ b/src/main/java/fr/mines_stetienne/ci/saref/managers/VersionSiteManager.java @@ -100,13 +100,6 @@ public class VersionSiteManager extends SAREFRepositoryVersionErrorLogger { generateHTMLFile(example); } } - /* <<< if (!pipeline.ignoreDocumentation) { - for(SAREFDocumentation documentation : version.getDocumentation().values()) { - LOG.info("Generating documentation for " + documentation); - generateRDFFiles(documentation); - generateHTMLFiles(documentation); - } - }*/ } private File prepareDirectory() throws SAREFPipelineException { diff --git a/src/main/resources/messages/SAREF.properties b/src/main/resources/messages/SAREF.properties index f62d3fd..687b582 100644 --- a/src/main/resources/messages/SAREF.properties +++ b/src/main/resources/messages/SAREF.properties @@ -28,8 +28,6 @@ ignoreTerms=do not generate the HTML pages for terms ignoreTerms_tooltip=do not generate the HTML pages for terms ignoreExamples=ignore examples ignoreExamples_tooltip=Only generates the report for the ontology -ignoreDocumentation=ignore Documentation -ignoreDocumentation_tooltip=Only generates the Documentation for the ontology options=3. Select execution options run=4. Run the Pipeline turtle=The document %s shall contain the sources of an ontology in the Turtle 1.1 format. See detailed error below. -- GitLab