Release 2.0.0 (#33)

kerrykimbrough · web-flow · commit 1443b7fe1923 · 2018-07-08T18:41:43.000-05:00
diff --git a/README.md b/README.md
@@ -2,9 +2,11 @@
 
 ## What's New? ##
 
-  * The latest version (Tcases 1.5.4) is now available at the Maven Central Repository. See [HowToDownload](HowToDownload.md) for download instructions. 
+  * The latest version (Tcases 2.0.0) is now available at the Maven Central Repository. See [HowToDownload](HowToDownload.md) for download instructions. 
 
-  * Tcases 1.5.4 includes [several improvements](ReleaseNotes.md) to existing features.
+  * Tcases 2.0.0 is a major release designed to open Tcases up to a much broader community of applications. The [features included](ReleaseNotes.md)
+    will be especially helpful for applications that use the Tcases API to embed Tcases capabilities into larger programs.
+    Some changes are not compatible with previous releases.
 
   * Subscribe to the [Tcases Forum](https://groups.google.com/d/forum/tcases) group to get notifications and share experiences with other Tcases users.
 
diff --git a/ReleaseNotes.md b/ReleaseNotes.md
@@ -1,5 +1,48 @@
 # Release Notes #
 
+## 2.0.0 ##
+
+  * This is a major release designed to open Tcases up to a much broader community of applications. The features included will be
+    especially helpful for applications that use the Tcases API to embed Tcases capabilities into larger programs.
+    Some changes are not compatible with previous releases -- details are listed in the **Compatibility** notes below.
+
+  * :trophy: Major props go to [Thibault Kruse](https://github.com/tkruse), who proposed and contributed to all of the key features of this release.
+
+  * **Reduced dependencies for `tcases-lib`**
+    * Relocated Ant support to a new `tcases-ant` module
+    * Relocated command line support from the `Tcases` class to a new `TcasesCommand` class
+    * Removed direct dependency on `logback-classic` to allow different bindings for the `slf4j` API
+
+  * **Expanded characters allowed in names and values**
+    * Names for input model elements like `System`, `Function`, and `Var` can now contain any Unicode alphabetic character.
+      (See [DefUtils.isIdentifier()](tcases-lib/src/main/java/org/cornutum/tcases/DefUtils.java#L22).)
+    * Names for variable `Value` elements can now contain nearly any character -- only XML markup characters disallowed.
+      Even empty strings are allowed.
+      (See [DefUtils.isVarValue()](tcases-lib/src/main/java/org/cornutum/tcases/DefUtils.java#L56).)
+
+  * **Property annotations**: The `Value` properties that characterize a test case can be useful metadata for further transformations of test case definitions.
+    So Tcases now automatially attaches an output annotation named `properties` to each `TestCase`.
+
+  * **"Not applicable" variables**: Tcases may designate a variable as ["not applicable"](http://www.cornutum.org/tcases/docs/Tcases-Guide.htm#varConditions)
+    to a test case. But the way this was done was a bit of a hack. Previously, such variables would just be assigned a special value of `"NA"`. But
+    what if `"NA"` actually means something different in your input domain ("North America", maybe)? You could have used it as a `Value` in your system input
+    definition, and Tcases wouldn't complain. But when you looked at the resulting test cases generated by Tcases, you couldn't tell which `"NA"`
+    meant "not applicable" and which meant "North America". Not cool! But this release fixes that problem. Now, you can use `"NA"` as a value however
+    you like, and Tcases will use a different XML markup to show when a variable is "not applicable". This change will affect existing XML test case documents --
+    see the **Compatability** notes for details. This also changes how "not applicable" bindings are represented in the API.
+
+  * **Compatibility**: The following changes are not backward compatible with previous releases.
+    * Tcases API
+      * The Tcases command line interface is now implemented by the `TcasesCommand` class. But programs using the Tcases API directly can continue
+        to use the basic `Tcases` class.
+      * Programs using `TcaseTask` API for Ant support must add a dependency on the `tcases-ant` module.
+      * Programs that use the Tcases API must add a runtime dependency for some binding of the `slf4j` API. For equivalence with previous releases,
+        add a dependency for `logback-classic`.
+    * System test documents
+      * To designate "not applicable" variables, replace all instances of `<Var name="..." value="NA"/>` with `<Var name="..." NA="true"/>`.
+        Otherwise, for system test documents used to define base test case inputs, test cases containing `"NA"` values may not be
+        preserved.
+
 ## 1.5.4 ##
 
   * Fixes the ```tcases``` and ```tcases-reducer``` commands to correctly support the ```-R``` option.
diff --git a/pom.xml b/pom.xml
@@ -4,16 +4,10 @@
 
   <modelVersion>4.0.0</modelVersion>
 
-  <parent>
-    <groupId>org.sonatype.oss</groupId>
-    <artifactId>oss-parent</artifactId>
-    <version>7</version>
-  </parent>
-
   <groupId>org.cornutum.tcases</groupId>
   <artifactId>tcases</artifactId>
   <packaging>pom</packaging>
-  <version>1.5.5-SNAPSHOT</version>
+  <version>2.0.0</version>
 
   <name>Tcases</name>
   <description>Generates test cases from system input space models</description>
@@ -60,6 +54,17 @@
       <post>https://groups.google.com/d/forum/tcases</post>
     </mailingList>  
   </mailingLists>
+
+  <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>
   
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -97,14 +102,15 @@
           </executions>
         </plugin>
         <plugin>
-          <groupId>org.apache.maven.plugins</groupId>
-          <artifactId>maven-release-plugin</artifactId>
-          <version>2.5</version>
-          <configuration>
-            <mavenExecutorId>forked-path</mavenExecutorId>
-            <useReleaseProfile>false</useReleaseProfile>
-            <arguments>${arguments} -Psonatype-oss-release</arguments>
-          </configuration>
+            <groupId>org.sonatype.plugins</groupId>
+            <artifactId>nexus-staging-maven-plugin</artifactId>
+            <version>1.6.8</version>
+            <extensions>true</extensions>
+            <configuration>
+                <serverId>ossrh</serverId>
+                <nexusUrl>https://oss.sonatype.org/</nexusUrl>
+                <autoReleaseAfterClose>true</autoReleaseAfterClose>
+            </configuration>
         </plugin>
       </plugins>
     </pluginManagement>
@@ -158,17 +164,14 @@
           <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-gpg-plugin</artifactId>
-            <version>1.5</version>
+            <version>1.6</version>
             <executions>
               <execution>
                 <id>sign-artifacts</id>
                 <phase>verify</phase>
                 <goals>
                   <goal>sign</goal>
                 </goals>
-                <configuration>
-                  <useAgent>false</useAgent>
-                </configuration>
               </execution>
             </executions>
           </plugin>          
diff --git a/tcases-ant/pom.xml b/tcases-ant/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>org.cornutum.tcases</groupId>
     <artifactId>tcases</artifactId>
-    <version>1.5.5-SNAPSHOT</version>
+    <version>2.0.0</version>
   </parent>
 
   <artifactId>tcases-ant</artifactId>
diff --git a/tcases-lib/pom.xml b/tcases-lib/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>org.cornutum.tcases</groupId>
     <artifactId>tcases</artifactId>
-    <version>1.5.5-SNAPSHOT</version>
+    <version>2.0.0</version>
   </parent>
 
   <artifactId>tcases-lib</artifactId>
diff --git a/tcases-lib/src/main/java/org/cornutum/tcases/DefUtils.java b/tcases-lib/src/main/java/org/cornutum/tcases/DefUtils.java
@@ -51,7 +51,7 @@ public static void assertIdentifier( String id) throws IllegalArgumentException
     }
 
   /**
-   * Returns true if the given string is a valid identifier.
+   * Returns true if the given string is a valid variable value.
    */
   public static boolean isVarValue( String val)
     {
diff --git a/tcases-maven-plugin/pom.xml b/tcases-maven-plugin/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>org.cornutum.tcases</groupId>
     <artifactId>tcases</artifactId>
-    <version>1.5.5-SNAPSHOT</version>
+    <version>2.0.0</version>
   </parent>
 
   <artifactId>tcases-maven-plugin</artifactId>
diff --git a/tcases-shell/docs/Tcases-Guide.htm b/tcases-shell/docs/Tcases-Guide.htm
@@ -10,7 +10,7 @@
         <IMG src="cornutum-logo.png"/>
         <SPAN class="title"> Tcases: The Complete Guide </SPAN> <BR/>
         <SPAN class="subtitle">Version ${shell.version} (${shell.timestamp})</SPAN><BR/>
-        <SPAN class="subtitle">&copy; 2012-2016 Cornutum Project</SPAN>
+        <SPAN class="subtitle">&copy; 2012-2018 Cornutum Project</SPAN>
       </DIV>
 
       <H2>Contents</H2>
diff --git a/tcases-shell/pom.xml b/tcases-shell/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>org.cornutum.tcases</groupId>
     <artifactId>tcases</artifactId>
-    <version>1.5.5-SNAPSHOT</version>
+    <version>2.0.0</version>
   </parent>
 
   <artifactId>tcases-shell</artifactId>

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public static void assertIdentifier( String id) throws IllegalArgumentException`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`/**`
`54`		`- * Returns true if the given string is a valid identifier.`
	`54`	`+ * Returns true if the given string is a valid variable value.`
`55`	`55`	`*/`
`56`	`56`	`public static boolean isVarValue( String val)`
`57`	`57`	`{`