Refactor and add ConversionConfig class as argument to createDcat
Description
This pull request addresses issue #22 and makes it possible to specify a working directory where files are produced when calling the method Manager.createDcat. As part of that, I made the following changes:
Add a new class ConversionConfig that contains (1) the apiSpecMap and (2) the workDir working directory. This class wraps the data consumed by Manager.createDcat.
Move some of the logic from the methods Manager.createFromFile and Manager.createFromDirectory to this new ConversionConfig class as methods fromDirectory and fromFile.
Make the Manager.createDcat implementation take a ConversionConfig instead of a MultiValueMap.
Output files to the workDir of the ConversionConfig.
Fix a bug in the Manager.createFromList method where the exception message will be pushed twice to results if createDcat throws an exception. This bug was fixed as a consequence of the refactoring.
Fixes #22
Discussion
The motivation for this PR was that I wanted to add a way of specifying the path where files are produced, as a workDir parameter. For that, I added the ConversionConfig class that now groups the apiSpecMap and workDir parameter. However, the workDir parameter could also be part of the Manager. I am unsure about what is best. If we would move workDir from the ConversionConfig class to Manager, then the ConversionConfig class would only contain one instance variable, apiSpecMap, and wouldn't be necessary anymore. At the same time, I am not sure it is a bad idea to have a ConversionConfig class that wraps the apiSpecMap parameter, because it makes clarifies intent and makes the code more easily extendable to adding more parameters.
Checklist
[ ] My contributions and commit messages follows the style guidelines of this project
[ ] I have made corresponding changes to the documentation
[ ] New and existing unit tests pass locally with my changes
[ ] The Pull Request has an informative and human-readable title
[ ] Changes are limited to a single goal (avoid scope creep)
[ ] Code can be automatically merged (no conflicts)
[ ] I confirm that I have read any Contribution guidelines (CONTRIBUTING)
[ ] I confirm that I wrote and/or have the right to submit the contents of my PR, by agreeing to the Developer Certificate of Origin, by adding a 'sign-off' to my commits
Refactor and add ConversionConfig class as argument to createDcat
Description
This pull request addresses issue #22 and makes it possible to specify a working directory where files are produced when calling the method
Manager.createDcat. As part of that, I made the following changes:ConversionConfigthat contains (1) theapiSpecMapand (2) theworkDirworking directory. This class wraps the data consumed byManager.createDcat.Manager.createFromFileandManager.createFromDirectoryto this newConversionConfigclass as methodsfromDirectoryandfromFile.Manager.createDcatimplementation take aConversionConfiginstead of aMultiValueMap.ConversionConfig.Manager.createFromListmethod where the exception message will be pushed twice toresultsifcreateDcatthrows an exception. This bug was fixed as a consequence of the refactoring.Fixes #22
Discussion
The motivation for this PR was that I wanted to add a way of specifying the path where files are produced, as a
workDirparameter. For that, I added theConversionConfigclass that now groups theapiSpecMapandworkDirparameter. However, theworkDirparameter could also be part of theManager. I am unsure about what is best. If we would moveworkDirfrom theConversionConfigclass toManager, then theConversionConfigclass would only contain one instance variable,apiSpecMap, and wouldn't be necessary anymore. At the same time, I am not sure it is a bad idea to have aConversionConfigclass that wraps theapiSpecMapparameter, because it makes clarifies intent and makes the code more easily extendable to adding more parameters.Checklist