Skip to content

[WIP] Documentation for 3.3 #227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions app/controllers/Application.scala
Original file line number Diff line number Diff line change
@@ -139,7 +139,7 @@ class Application @Inject() (cc: ControllerComponents) extends AbstractControlle

object Application {

val latestVersion = "3.2.19"
val latestVersion = "3.3.0"
val latestSuperSafeVersion = "1.1.12"
val supersafeScalaVersion = "2.13.14"
val milestoneVersion = "3.2.0"
@@ -159,13 +159,13 @@ object Application {
val latestJUnit5Version = "5-10"
val latestMockitoVersion = "5-12"
val latestScalaCheckVersion = "1-18"
val latestScalaCheckPlusVersion = "3.2.19.0"
val latestScalaCheckPlusVersion = "3.3.0.0"
val latestTestNGVersion = "7-10"
val quickStartXmlJar = "https://repo1.maven.org/maven2/org/scala-lang/modules/scala-xml_3/2.3.0/scala-xml_3-2.3.0.jar"
val latestPlusScalaCheckDoc = "plus-scalacheck-1.18/3.2.19.0"
val latestPlusEasyMockDoc = "plus-easymock-5.3/3.2.19.0"
val latestPlusJMockDoc = "plus-jmock-2.13/3.2.19.0"
val latestPlusMockitoDoc = "plus-mockito-5.12/3.2.19.0"
val latestPlusScalaCheckDoc = "plus-scalacheck-1.18/3.3.0.0"
val latestPlusEasyMockDoc = "plus-easymock-5.3/3.3.0.0"
val latestPlusJMockDoc = "plus-jmock-2.13/3.3.0.0"
val latestPlusMockitoDoc = "plus-mockito-5.12/3.3.0.0"

def scaladocsPageUrl(file: String, version: String = latestVersion): String = {
val oldScaladocStyle30Releases = List("3.0.0", "3.0.1", "3.0.2", "3.0.3", "3.0.4")
3 changes: 3 additions & 0 deletions app/controllers/ReleaseNotes.scala
Original file line number Diff line number Diff line change
@@ -25,6 +25,9 @@ class ReleaseNotes @Inject() (cc: ControllerComponents) extends AbstractControll
Ok(views.html.releaseNotes.releaseNotesIndex())
}

def v330 = Action {
Ok(views.html.releaseNotes.v330())
}
def v3219 = Action {
Ok(views.html.releaseNotes.v3219())
}
12 changes: 12 additions & 0 deletions app/controllers/UserGuide.scala
Original file line number Diff line number Diff line change
@@ -69,6 +69,10 @@ class UserGuide @Inject() (cc: ControllerComponents) extends AbstractController(
Ok(views.html.userGuide.propertyBasedTesting())
}

def scalacheckPropertyBasedTesting = Action {
Ok(views.html.userGuide.scalacheckPropertyBasedTesting())
}

def otherGoodies = Action {
Ok(views.html.userGuide.otherGoodies())
}
@@ -97,10 +101,18 @@ class UserGuide @Inject() (cc: ControllerComponents) extends AbstractController(
Ok(views.html.userGuide.tableDrivenPropertyChecks())
}

def scalacheckTableDrivenPropertyChecks = Action {
Ok(views.html.userGuide.scalacheckTableDrivenPropertyChecks())
}

def generatorDrivenPropertyChecks = Action {
Ok(views.html.userGuide.generatorDrivenPropertyChecks())
}

def scalacheckDrivenPropertyChecks = Action {
Ok(views.html.userGuide.scalacheckDrivenPropertyChecks())
}

def writingScalacheckStyleProperties = Action {
Ok(views.html.userGuide.writingScalacheckStyleProperties())
}
2 changes: 1 addition & 1 deletion app/views/homePage.scala.html
Original file line number Diff line number Diff line change
@@ -25,7 +25,7 @@
height="200" alt="ScalaTest: Simply Productive"/>
</div>
<p style="align: center">
<span style="font-size: 150%">Latest Release - <a href="@routes.ReleaseNotes.v3219">ScalaTest and Scalactic @latestVersion</a>!</span>
<span style="font-size: 150%">Latest Release - <a href="@routes.ReleaseNotes.v330">ScalaTest and Scalactic @latestVersion</a>!</span>
</p>
}

6 changes: 6 additions & 0 deletions app/views/plus/easymockVersions.scala.html
Original file line number Diff line number Diff line change
@@ -31,6 +31,12 @@ <h1>ScalaTest + EasyMock Versions, Versions, Versions</h1>
<table style="border-collapse: collapse; border: 1px solid black">
<tr><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">ScalaTest + EasyMock Version</th><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">ScalaTest Version</th><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">EasyMock Versions</th></tr>

<tr>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center"><a href="@routes.Assets.at("/public/scaladoc", "plus-easymock-5.3/3.3.0.0/org/scalatestplus/easymock/EasyMockSugar.html")">3.3.0.0</a></td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">3.3.0</td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">5.3</td>
</tr>

<tr>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center"><a href="@routes.Assets.at("/public/scaladoc", "plus-easymock-5.3/3.2.19.0/org/scalatestplus/easymock/EasyMockSugar.html")">3.2.19.0</a></td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">3.2.19</td>
6 changes: 6 additions & 0 deletions app/views/plus/jmockVersions.scala.html
Original file line number Diff line number Diff line change
@@ -31,6 +31,12 @@ <h1>ScalaTest + JMock Versions, Versions, Versions</h1>
<table style="border-collapse: collapse; border: 1px solid black">
<tr><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">ScalaTest + JMock Version</th><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">ScalaTest Version</th><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">JMock Versions</th></tr>

<tr>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center"><a href="@routes.Assets.at("/public/scaladoc", "plus-jmock-2.13/3.3.0.0/org/scalatestplus/jmock/JMockCycle.html")">3.3.0.0</a></td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">3.3.0</td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">2.13.x</td>
</tr>

<tr>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center"><a href="@routes.Assets.at("/public/scaladoc", "plus-jmock-2.13/3.2.19.0/org/scalatestplus/jmock/JMockCycle.html")">3.2.19.0</a></td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">3.2.19</td>
6 changes: 6 additions & 0 deletions app/views/plus/junit4Versions.scala.html
Original file line number Diff line number Diff line change
@@ -31,6 +31,12 @@ <h1>ScalaTest + JUnit 4 Versions, Versions, Versions</h1>
<table style="border-collapse: collapse; border: 1px solid black">
<tr><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">ScalaTest + JUnit 4 Version</th><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">ScalaTest Version</th><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">JUnit 4 Versions</th></tr>

<tr>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center"><a href="@routes.Assets.at("/public/scaladoc", "plus-junit-4.13/3.3.0.0/org/scalatestplus/junit/AssertionsForJUnit.html")">3.3.0.0</a></td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">3.3.0</td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">4.13</td>
</tr>

<tr>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center"><a href="@routes.Assets.at("/public/scaladoc", "plus-junit-4.13/3.2.19.0/org/scalatestplus/junit/AssertionsForJUnit.html")">3.2.19.0</a></td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">3.2.19</td>
6 changes: 6 additions & 0 deletions app/views/plus/junit5Versions.scala.html
Original file line number Diff line number Diff line change
@@ -31,6 +31,12 @@ <h1>ScalaTest + JUnit 5 Versions, Versions, Versions</h1>
<table style="border-collapse: collapse; border: 1px solid black">
<tr><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">ScalaTest + JUnit 5 Version</th><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">ScalaTest Version</th><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">JUnit 5 Versions</th></tr>

<tr>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center"><a href="@routes.Assets.at("/public/scaladoc", "plus-junit-5.10/3.3.0.0/org/scalatestplus/junit5/AssertionsForJUnit.html")">3.3.0.0</a></td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">3.3.0</td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">5.10</td>
</tr>

<tr>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center"><a href="@routes.Assets.at("/public/scaladoc", "plus-junit-5.10/3.2.19.0/org/scalatestplus/junit5/AssertionsForJUnit.html")">3.2.19.0</a></td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">3.2.19</td>
6 changes: 6 additions & 0 deletions app/views/plus/mockitoVersions.scala.html
Original file line number Diff line number Diff line change
@@ -31,6 +31,12 @@ <h1>ScalaTest + Mockito Versions, Versions, Versions</h1>
<table style="border-collapse: collapse; border: 1px solid black">
<tr><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">ScalaTest + Mockito Version</th><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">ScalaTest Version</th><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">Mockito Versions</th></tr>

<tr>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center"><a href="@routes.Assets.at("/public/scaladoc", "plus-mockito-5.12/3.3.0.0/org/scalatestplus/mockito/MockitoSugar.html")">3.3.0.0</a></td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">3.3.0</td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">5.12</td>
</tr>

<tr>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center"><a href="@routes.Assets.at("/public/scaladoc", "plus-mockito-5.12/3.2.19.0/org/scalatestplus/mockito/MockitoSugar.html")">3.2.19.0</a></td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">3.2.19</td>
2 changes: 1 addition & 1 deletion app/views/plus/scalacheck.scala.html
Original file line number Diff line number Diff line change
@@ -46,7 +46,7 @@ <h1>ScalaTest + ScalaCheck</h1>
</pre>

<p>
You may also refer to <a href="@routes.UserGuide.propertyBasedTesting()">Property-based testing</a> for detailed usage documentation.
You may also refer to <a href="@routes.UserGuide.scalacheckPropertyBasedTesting()">Property-based testing using ScalaCheck</a> for detailed usage documentation.
</p>

</div>
5 changes: 5 additions & 0 deletions app/views/plus/scalacheckVersions.scala.html
Original file line number Diff line number Diff line change
@@ -31,6 +31,11 @@ <h1>ScalaTest + ScalaCheck Versions, Versions, Versions</h1>
<table style="border-collapse: collapse; border: 1px solid black">
<tr><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">ScalaTest + ScalaCheck Version</th><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">ScalaTest Version</th><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">ScalaCheck Versions</th></tr>

<tr>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center"><a href="@routes.Assets.at("/public/scaladoc", "plus-scalacheck-1.18/3.3.0.0/org/scalatestplus/scalacheck/ScalaCheckPropertyChecks.html")">3.3.0.0</a></td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">3.3.0</td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">1.18.x</td>
/tr>
<tr>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center"><a href="@routes.Assets.at("/public/scaladoc", "plus-scalacheck-1.18/3.2.19.0/org/scalatestplus/scalacheck/ScalaCheckPropertyChecks.html")">3.2.19.0</a></td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">3.2.19</td>
6 changes: 6 additions & 0 deletions app/views/plus/seleniumVersions.scala.html
Original file line number Diff line number Diff line change
@@ -31,6 +31,12 @@ <h1>ScalaTest + Selenium Versions, Versions, Versions</h1>
<table style="border-collapse: collapse; border: 1px solid black">
<tr><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">ScalaTest + Selenium Version</th><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">ScalaTest Version</th><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">Selenium Versions</th></tr>

<tr>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center"><a href="@routes.Assets.at("/public/scaladoc", "plus-selenium-4.21/3.3.0.0/org/scalatestplus/selenium/WebBrowser.html")">3.3.0.0</a></td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">3.3.0</td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">4.21</td>
</tr>

<tr>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center"><a href="@routes.Assets.at("/public/scaladoc", "plus-selenium-4.21/3.2.19.0/org/scalatestplus/selenium/WebBrowser.html")">3.2.19.0</a></td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">3.2.19</td>
6 changes: 6 additions & 0 deletions app/views/plus/testngVersions.scala.html
Original file line number Diff line number Diff line change
@@ -31,6 +31,12 @@ <h1>ScalaTest + TestNG Versions, Versions, Versions</h1>
<table style="border-collapse: collapse; border: 1px solid black">
<tr><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">ScalaTest + TestNG Version</th><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">ScalaTest Version</th><th style="background-color: #CCCCCC; border-width: 1px; padding: 10px; text-align: center; border: 1px solid black">TestNG Versions</th></tr>

<tr>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center"><a href="@routes.Assets.at("/public/scaladoc", "plus-testng-7.10/3.3.0.0/org/scalatestplus/testng/TestNGSuite.html")">3.3.0.0</a></td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">3.3.0</td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">7.10</td>
</tr>

<tr>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center"><a href="@routes.Assets.at("/public/scaladoc", "plus-testng-7.10/3.2.19.0/org/scalatestplus/testng/TestNGSuite.html")">3.2.19.0</a></td>
<td style="border-width: 1px; padding: 3px; border: 1px solid black; text-align: center">3.2.19</td>
7 changes: 2 additions & 5 deletions app/views/quickStart.scala.html
Original file line number Diff line number Diff line change
@@ -69,14 +69,11 @@ <h1>ScalaTest quick start</h1>
</pre>

<p>
To run it, you will need one more artifact,
<a href="@{quickStartXmlJar}">the Jar file for Scala's XML module</a>.
Once you've downloaded that Jar file, you can run <code>ExampleSpec</code> like this:
You can run <code>ExampleSpec</code> like this:
</p>

<pre class="scala">
$ CLASSPATH=scalatest-app_@{majorMinorScalaVersion}-@{latestVersion}.jar:scala-xml_3-2.3.0.jar
$ scala -cp $CLASSPATH org.scalatest.run ExampleSpec
$ scala -cp scalatest-app_@{majorMinorScalaVersion}-@{latestVersion}.jar org.scalatest.run ExampleSpec
<span class="cyanincolor">Run starting. Expected test count is: 2</span>
<span class="greenincolor">ExampleSpec:
A Stack
Loading