Merge pull request #6 from aljoshakoecher/prepare-for-release

aljoshakoecher · web-flow · commit 03492d3e5ec5 · 2020-03-16T18:40:21.000+01:00
Prepare for release
diff --git a/README.md b/README.md
@@ -81,22 +81,33 @@ Work in progress, coming soon
 
 
 ## Usage
-It's very easy to use this library in your own projects. If you're working with Maven, simply add this dependency to the `<dependencies>` in you pom.xml.
+With Maven, it's very easy to use this library in your own projects. Releases are published to the Maven Central Repo, snapshot version can be obtained from Sonatype.
+
+### Releases
+Releases can be found on the Maven Central repository. Just add this dependency to your pom.xml:
 
 ```xml
 <dependency>
-   <groupId>de.hsu-hh.aut</groupId>
+	<groupId>com.github.aljoshakoecher</groupId>
 	<artifactId>isa88-state-machine</artifactId>
 	<version>1.0.0</version>
 </dependency>
 ```
 
-### Releases
-I'm currently working on publishing releases to the Sonatype Maven repo. Coming soon..
+### Snapshots
+Make sure to add the Sonatype repo to your POM if you want to grab a snapshot version:
+
+```
+<repository>
+    <id>oss-sonatype</id>
+    <name>oss-sonatype</name>
+    <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
+</repository>
+```
 
 ### Building from source
-This project is built with Maven. You can simply build this library from source if you have Maven installed. Simply clone or download this repository and run
-run `mvn clean install` from the project root.
+This project is built with Maven. You can simply build this library from source if you have Maven installed. Clone or download this repository and run
+`mvn clean install` from the project root.
 
 ## Disclaimer
 Please note that the figure above and all definitions of states and transitions have been taken from the [OMAC PackML Implementation Guide](http://omac.org/wp-content/uploads/2016/11/PackML_Unit_Machine_Implementation_Guide-V1-00.pdf) for ISA 88. 
diff --git a/pom.xml b/pom.xml
@@ -2,11 +2,51 @@
 	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">
 	<modelVersion>4.0.0</modelVersion>
-	<groupId>de.hsu-hh.aut</groupId>
+	<groupId>com.github.aljoshakoecher</groupId>
 	<artifactId>isa88-state-machine</artifactId>
 	<version>1.0.0</version>
+	<packaging>jar</packaging>
+
 	<name>ISA 88 State Machine</name>
 	<description>State Machine according to ISA 88 that can be used to quickly implement a behavior that is consistent with ISA 88</description>
+	<url>https://github.com/aljoshakoecher/ISA88-StateMachine</url>
+
+	<properties>
+		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+	</properties>
+	
+	<developers>
+		<developer>
+			<name>Aljosha Koecher</name>
+			<email>aljosha.koecher@hsu-hh.de</email>
+			<organization>Helmut-Schmidt-University, Institute of Automation</organization>
+			<organizationUrl>http://www.hsu-hh.de/aut</organizationUrl>
+		</developer>
+	</developers>
+
+	<licenses>
+		<license>
+			<name>MIT License</name>
+			<url>http://www.opensource.org/licenses/mit-license.php</url>
+		</license>
+	</licenses>
+
+	<distributionManagement>
+		<snapshotRepository>
+			<id>ossrh</id>
+			<url>https://oss.sonatype.org/content/repositories/snapshots</url>
+		</snapshotRepository>
+		<repository>
+			<id>ossrh</id>
+			<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
+		</repository>
+	</distributionManagement>
+
+	<scm>
+		<connection>scm:git:git://github.com/aljoshakoecher/ISA88-StateMachine</connection>
+		<developerConnection>scm:git:ssh://github.com/aljoshakoecher/ISA88-StateMachine</developerConnection>
+		<url>https://github.com/aljoshakoecher/ISA88-StateMachine</url>
+	</scm>
 
 	<build>
 		<plugins>
@@ -35,6 +75,57 @@
 					</dependency>
 				</dependencies>
 			</plugin>
+			<plugin>
+				<groupId>org.sonatype.plugins</groupId>
+				<artifactId>nexus-staging-maven-plugin</artifactId>
+				<version>1.6.7</version>
+				<extensions>true</extensions>
+				<configuration>
+					<serverId>ossrh</serverId>
+					<nexusUrl>https://oss.sonatype.org/</nexusUrl>
+					<autoReleaseAfterClose>true</autoReleaseAfterClose>
+				</configuration>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-source-plugin</artifactId>
+				<version>2.2.1</version>
+				<executions>
+					<execution>
+						<id>attach-sources</id>
+						<goals>
+							<goal>jar-no-fork</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-javadoc-plugin</artifactId>
+				<version>2.9.1</version>
+				<executions>
+					<execution>
+						<id>attach-javadocs</id>
+						<goals>
+							<goal>jar</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-gpg-plugin</artifactId>
+				<version>1.5</version>
+				<executions>
+					<execution>
+						<id>sign-artifacts</id>
+						<phase>verify</phase>
+						<goals>
+							<goal>sign</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
 		</plugins>
 	</build>
 
@@ -53,4 +144,6 @@
 		</dependency>
 	</dependencies>
 
+
+
 </project>
diff --git a/src/main/java/statemachine/StateMachine.java b/src/main/java/statemachine/StateMachine.java
@@ -90,15 +90,15 @@ public State getState() {
 
 	/**
 	 * Sets the current state of the StateMachine
-	 * @param newState The new state that will be set as the current state
+	 * @param state The new state that will be set as the current state
 	 */
 	protected void setState(State state) {
 		this.currentState = state;
 	}
 	
 	/**
 	 * Sets the current state of the StateMachine and runs this state's action
-	 * @param newState The new state that will be set as the current state
+	 * @param state The new state that will be set as the current state
 	 */
 	public void setStateAndRunAction(State state) {
 		this.currentState = state;
diff --git a/src/main/java/states/IState.java b/src/main/java/states/IState.java
@@ -23,56 +23,65 @@ public interface IState {
 
 	/**
 	 * The start command does only have an effect in {@link IdleState}. With this command, the state machine will change to the {@link ExecuteState}
+	 * @param stateMachine A reference to the current {@link StateMachine} instance 
 	 */
 	public void start(StateMachine stateMachine);
 
 	/**
 	 * The hold command is used when interal reasons of a machine should bring it to an halt. Such reasons could be e.g. necessary refill of material.
 	 * With this command, the state machine will transition to a {@link HoldingState} and eventually come to a full {@link HeldState}.
+	 * @param stateMachine A reference to the current {@link StateMachine} instance 
 	 */
 	public void hold(StateMachine stateMachine);
 
 	/**
 	 * The unhold command brings the machine into an {@link UnholdingState} that eventually leads back to the {@link ExecuteState}. The hold command
 	 * should be used when the internal reasons that brought a machine into a {@link HeldState} have been cleared.
+	 * @param stateMachine A reference to the current {@link StateMachine} instance 
 	 */
 	public void unhold(StateMachine stateMachine);
 
 	/**
 	 * The suspend command is used when extenal reasons of a machine should bring it to an halt. Such reasons could be e.g. waiting for following
 	 * machines to accept a workpiece. With this command, the state machine will transition to a {@link SuspendingState} and eventually come to a full
 	 * {@link SuspendedState}.
+	 * @param stateMachine A reference to the current {@link StateMachine} instance 
 	 */
 	public void suspend(StateMachine stateMachine);
 
 	/**
 	 * The unsuspend command brings the machine into an {@link UnsuspendingState} that eventually leads back to the {@link ExecuteState}. The
 	 * unsuspend command should be used when the external reasons that brought a machine into a {@link SuspendedState} have been cleared.
+	 * @param stateMachine A reference to the current {@link StateMachine} instance 
 	 */
 	public void unsuspend(StateMachine stateMachine);
 
 	/**
 	 * The reset command brings the machine into a {@link ResettingState} that eventually leads back to the {@link IdleState}. The reset command can
 	 * be used when the machine has been brought to a sudden halt (e.g. with stop or abort command)
+	 * @param stateMachine A reference to the current {@link StateMachine} instance 
 	 */
 	public void reset(StateMachine stateMachine);
 
 	/**
 	 * The stop command can be triggered by an external system such as an MES. Stop brings the state machine to a {@link StoppingState} and from there
 	 * to a {@link StoppedState}. The currently produced product should not be destroyed and production can continue after the machine has been reset.
+	  * @param stateMachine A reference to the current {@link StateMachine} instance 
 	 */
 	public void stop(StateMachine stateMachine);
 
 	/**
 	 * The abort command can be triggered by an external system such as an MES. Abort brings the state machine to a sudden stop by transitioning to
 	 * the {@link AbortingState} and eventually to the {@link AbortedState}. The machine is switched off, the currently produced product might have to
 	 * be destroyed and production of it can not be continued.
+	  * @param stateMachine A reference to the current {@link StateMachine} instance 
 	 */
 	public void abort(StateMachine stateMachine);
 
 	/**
 	 * After a machine has been brought to the {@link AbortedState}, a clear command can be used to bring it to a {@link ClearingState} to e.g. remove
 	 * destroyed products. From the {@link ClearingState}, the machine will come to the {@link StoppedState} from which it then can be reset.
+	  * @param stateMachine A reference to the current {@link StateMachine} instance 
 	 */
 	public void clear(StateMachine stateMachine);
 	
diff --git a/src/main/java/states/State.java b/src/main/java/states/State.java
@@ -14,7 +14,7 @@ public void executeActionAndComplete(StateMachine stateMachine) {
 	
 	/**
 	 * Default of a simple runAction implementation. Could be overriden if e.g. an action has to run in a separate thread
-	 * @param action
+	 * @param action {@link IStateAction} that is going to be executed
 	 */
 	protected void executeAction(IStateAction action) {
 		action.execute();
diff --git a/src/main/java/states/impl/SuspendedState.java b/src/main/java/states/impl/SuspendedState.java
@@ -34,14 +34,6 @@ public void reset(StateMachine stateMachine) {
 		// Reset cannot be fired from Suspended -> Do nothing except maybe giving a warning
 	}
 	@Override
-	public void stop(StateMachine stateMachine) {
-		// Stop cannot be fired from Suspended -> Do nothing except maybe giving a warning
-	}
-	@Override
-	public void abort(StateMachine stateMachine) {
-		// Abort cannot be fired from Suspended -> Do nothing except maybe giving a warning
-	}
-	@Override
 	public void clear(StateMachine stateMachine) {
 		// Clear cannot be fired from Suspended -> Do nothing except maybe giving a warning
 	}
diff --git a/src/test/java/transitioning/TestTransitioningWithDummyActions.java b/src/test/java/transitioning/TestTransitioningWithDummyActions.java
