Merge pull request #66 from open-simulation-platform/release/0.11.0

release/0.11.0

Author: mrindar

CONTRIBUTING.md

@@ -0,0 +1,42 @@
+Contributor guidelines
+======================
+
+This document contains a set of rules and guidelines for everyone who wishes
+to contribute to the contents of this repository, hereafter referred to as
+"the software".
+
+
+General
+-------
+All contributors implicitly agree to license their contribution under the same
+terms as the rest of the software, and accept that those terms may change in the
+future.  See the `LICENCE.txt` file for details.
+
+All contributions to the software, in the form of changes, removals or
+additions to source code and other files under source control, shall be made
+via pull requests.  A pull request must always be reviewed and merged by someone
+other than its author.
+
+Before a pull request can be approved and merged into the code base, the author 
+must sign the "OSP Contributor License Agreement". This agreement is pending, but 
+will be included in this repository with guidelines once concluded.
+
+
+Workflow
+--------
+This repository uses the [gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) 
+workflow
+
+
+Creating new releases
+---------------------
+Create new releases by running the `release.sh` script. It will prompt you for the version number to release, and the 
+bump version. Typically, the bump increases the `minor` version by 1 and adds `-SNAPSHOT` at the end. The script will 
+then create a release branch with the given version number, and a new commit on the develop branch with the bump 
+version. The script updates all version numbers in the `pom.xml` files. 
+
+When ready to release:
+
+ - Merge the release branch into the master branch _and_ the develop branch
+ - Run `mvn clean package` on the master branch
+ - Upload binaries to new github release with the same name as the version number

LICENSE

@@ -1,19 +1,31 @@
-# Description
-This is a java project consisting of a java library and a command line interface tool to validate FMUs and simulation
-configurations against the [open simulation platform](https://www.opensimulationplatform.com) specification.
-
-# Prerequisites
-### Windows
-java: https://github.com/AdoptOpenJDK/openjdk8-binaries/releases/download/jdk8u222-b10/OpenJDK8U-jdk_x64_windows_hotspot_8u222b10.msi
+Description
+===========
+Supports version 1.0 of [OSP-IS](https://www.opensimulationplatform.com/assets/osp-is.pdf)
+
+This is a java project consisting of a java library, and a command line interface tool to validate FMUs and simulation
+configurations against OSP-IS.
+
+IMPORTRANT
+----------
+This `osp-validator` version only works with `OspSystemStructure.xml` files based on 
+[this](https://opensimulationplatform.com/xsd/OspSystemStructure-0.1.xsd) xsd
+
+Prerequisites
+=============
+Windows
+-------
+[java](https://github.com/AdoptOpenJDK/openjdk8-binaries/releases/download/jdk8u222-b10/OpenJDK8U-jdk_x64_windows_hotspot_8u222b10.msi)
 \
-maven: http://apache.uib.no/maven/maven-3/3.6.0/binaries/apache-maven-3.6.0-bin.zip
+[maven](http://apache.uib.no/maven/maven-3/3.6.0/binaries/apache-maven-3.6.0-bin.zip)
 
-### Linux
-java: https://github.com/AdoptOpenJDK/openjdk8-binaries/releases/download/jdk8u222-b10/OpenJDK8U-jdk_x64_linux_hotspot_8u222b10.tar.gz
+Linux
+-----
+[java](https://github.com/AdoptOpenJDK/openjdk8-binaries/releases/download/jdk8u222-b10/OpenJDK8U-jdk_x64_linux_hotspot_8u222b10.tar.gz)
 \
-maven: http://apache.uib.no/maven/maven-3/3.6.0/binaries/apache-maven-3.6.0-bin.tar.gz
+[maven](http://apache.uib.no/maven/maven-3/3.6.0/binaries/apache-maven-3.6.0-bin.tar.gz)
 
-# Modules
+Modules
+=======
 [osp-validator-api](/osp-validator-api/README.md)
 
 [osp-validator-core](/osp-validator-core/README.md)
@@ -26,10 +38,11 @@ maven: http://apache.uib.no/maven/maven-3/3.6.0/binaries/apache-maven-3.6.0-bin.
 
 [osp-validator-gen](/osp-validator-gen/README.md)
 
-# Build
+Build
+=====
 ```
-$ git clone git@github.com:open-simulation-platform/msmi-validator.git
-$ cd msmi-validator
+$ git clone git@github.com:open-simulation-platform/osp-validator.git
+$ cd osp-validator
 $ mvn clean package
 ```
 

README.md

@@ -1,3 +1,3 @@
-# Description
-
+Description
+===========
 Implements parsers and converters to generate `osp-validator-core` data model from `OspModelDescription.xml`

TODO.md

@@ -1,11 +1,17 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ This Source Code Form is subject to the terms of the Mozilla Public
+  ~ License, v. 2.0. If a copy of the MPL was not distributed with this
+  ~ file, You can obtain one at https://mozilla.org/MPL/2.0/.
+  -->
+
 <project xmlns="http://maven.apache.org/POM/4.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <parent>
-    <artifactId>msmi-validator</artifactId>
+    <artifactId>osp-validator</artifactId>
     <groupId>com.opensimulationplatform</groupId>
-    <version>0.10.0</version>
+    <version>0.11.0</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
 

osp-model-description/README.md

@@ -1,3 +1,9 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
 package com.opensimulationplatform.modeldescription.util;
 
 import com.opensimulationplatform.core.model.modeldescription.Unit;

osp-model-description/pom.xml

@@ -1,3 +1,9 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
 package com.opensimulationplatform.modeldescription.util;
 
 import no.ntnu.ihb.fmi4j.modeldescription.ModelDescriptionParser;

osp-model-description/src/main/java/com/opensimulationplatform/modeldescription/util/FmiModelDescription.java

@@ -1,3 +1,9 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
 package com.opensimulationplatform.modeldescription.util;
 
 import no.ntnu.ihb.fmi4j.modeldescription.ModelDescriptionParser;

osp-model-description/src/main/java/com/opensimulationplatform/modeldescription/util/FmuHelper_Fmi1.java

@@ -1,6 +1,13 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
 package com.opensimulationplatform.modeldescription.xml.converter;
 
 import java.util.List;
+import java.util.stream.Collectors;
 
 public abstract class Converter<FROM, TO> {
   protected final ConverterContext context;
@@ -15,5 +22,7 @@ public Converter() {
 
   public abstract TO convert(FROM object);
 
-  public abstract List<TO> convert(List<FROM> object);
+  public List<TO> convert(List<FROM> object) {
+    return object.stream().map(this::convert).collect(Collectors.toList());
+  }
 }