9 | }
10 |
--------------------------------------------------------------------------------
/app/models/Widget.scala:
--------------------------------------------------------------------------------
1 | package models
2 |
3 | /**
4 | * Presentation object used for displaying data in a template.
5 | *
6 | * Note that it's a good practice to keep the presentation DTO,
7 | * which are used for reads, distinct from the form processing DTO,
8 | * which are used for writes.
9 | */
10 | case class Widget(name: String, price: Int)
--------------------------------------------------------------------------------
/NOTICE:
--------------------------------------------------------------------------------
1 | Written by Lightbend
2 |
3 | To the extent possible under law, the author(s) have dedicated all copyright and
4 | related and neighboring rights to this software to the public domain worldwide.
5 | This software is distributed without any warranty.
6 |
7 | You should have received a copy of the CC0 Public Domain Dedication along with
8 | this software. If not, see .
9 |
--------------------------------------------------------------------------------
/scripts/test-gradle:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | set -e
4 | set -o pipefail
5 |
6 | # Using cut because TRAVIS_SCALA_VERSION is the full Scala
7 | # version (for example 2.12.4), but Gradle expects just the
8 | # binary version (for example 2.12)
9 | scala_binary_version=$(echo $TRAVIS_SCALA_VERSION | cut -c1-4)
10 |
11 | echo "+------------------------------+"
12 | echo "| Executing tests using Gradle |"
13 | echo "+------------------------------+"
14 | ./gradlew -Dscala.binary.version=$scala_binary_version check -i --stacktrace
15 |
--------------------------------------------------------------------------------
/app/views/main.scala.html:
--------------------------------------------------------------------------------
1 | @(title: String)(content: Html)
2 |
3 |
4 |
5 |
6 |
7 | @title
8 |
9 |
10 |
11 |
12 |
13 | @content
14 |
15 |
16 |
--------------------------------------------------------------------------------
/conf/routes:
--------------------------------------------------------------------------------
1 | # Routes
2 | # This file defines all application routes (Higher priority routes first)
3 | # ~~~~
4 |
5 | # Home page
6 | GET / controllers.WidgetController.index
7 |
8 | # Widgets
9 | GET /widgets controllers.WidgetController.listWidgets
10 | POST /widgets controllers.WidgetController.createWidget
11 |
12 | # Map static resources from the /public folder to the /assets URL path
13 | GET /assets/*file controllers.Assets.versioned(path="/public", file: Asset)
14 |
--------------------------------------------------------------------------------
/conf/logback.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 | %coloredLevel %logger{15} - %message%n%xException{10}
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
--------------------------------------------------------------------------------
/app/controllers/WidgetForm.scala:
--------------------------------------------------------------------------------
1 | package controllers
2 |
3 | object WidgetForm {
4 | import play.api.data.Forms._
5 | import play.api.data.Form
6 |
7 | /**
8 | * A form processing DTO that maps to the form below.
9 | *
10 | * Using a class specifically for form binding reduces the chances
11 | * of a parameter tampering attack and makes code clearer.
12 | */
13 | case class Data(name: String, price: Int)
14 |
15 | /**
16 | * The form definition for the "create a widget" form.
17 | * It specifies the form fields and their types,
18 | * as well as how to convert from a Data to form data and vice versa.
19 | */
20 | val form = Form(
21 | mapping(
22 | "name" -> nonEmptyText,
23 | "price" -> number(min = 0)
24 | )(Data.apply)(Data.unapply)
25 | )
26 | }
27 |
--------------------------------------------------------------------------------
/.mergify.yml:
--------------------------------------------------------------------------------
1 | pull_request_rules:
2 | - name: Merge PRs that are ready
3 | conditions:
4 | - status-success=Travis CI - Pull Request
5 | - status-success=typesafe-cla-validator
6 | - "#approved-reviews-by>=1"
7 | - "#review-requested=0"
8 | - "#changes-requested-reviews-by=0"
9 | - label!=status:block-merge
10 | actions:
11 | merge:
12 | method: squash
13 | strict: smart
14 |
15 | - name: Merge TemplateControl's PRs that are ready
16 | conditions:
17 | - status-success=Travis CI - Pull Request
18 | - "#review-requested=0"
19 | - "#changes-requested-reviews-by=0"
20 | - label!=status:block-merge
21 | - label=status:merge-when-green
22 | - label!=status:block-merge
23 | actions:
24 | merge:
25 | method: squash
26 | strict: smart
27 |
28 | - name: Delete the PR branch after merge
29 | conditions:
30 | - merged
31 | actions:
32 | delete_head_branch: {}
33 |
--------------------------------------------------------------------------------
/app/views/listWidgets.scala.html:
--------------------------------------------------------------------------------
1 | @(widgets: Seq[Widget], form: Form[WidgetForm.Data], postUrl: Call)(implicit request: MessagesRequestHeader)
2 |
3 | @main("Widgets") {
4 |
5 |
Widgets
6 |
7 | @* Flash shows updates to a page *@
8 | @request.flash.data.map{ case (name, value) =>
9 |
@name: @value
10 | }
11 |
12 |
13 |
14 |
Name
Price
15 |
16 |
17 | @for(w <- widgets) {
18 |
@w.name
@w.price
19 | }
20 |
21 |
22 |
23 |
24 |
25 | @* Global errors are not tied to any particular form field *@
26 | @if(form.hasGlobalErrors) {
27 | @form.globalErrors.map { error: FormError =>
28 |
29 | @error.key: @error.message
30 |
31 | }
32 | }
33 |
34 | @helper.form(postUrl) {
35 | @helper.CSRF.formField
36 |
37 | @helper.inputText(form("name"))
38 |
39 | @helper.inputText(form("price"))
40 |
41 |
42 | }
43 | }
44 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: scala
2 | scala: 2.12.8
3 | script: $SCRIPT
4 |
5 | env:
6 | matrix:
7 | - SCRIPT=scripts/test-sbt TRAVIS_JDK=adopt@1.8.202-08
8 | - SCRIPT=scripts/test-sbt TRAVIS_JDK=adopt@1.11.0-2
9 | - SCRIPT=scripts/test-gradle TRAVIS_JDK=adopt@1.8.202-08
10 | - SCRIPT=scripts/test-gradle TRAVIS_JDK=adopt@1.11.0-2
11 |
12 | matrix:
13 | fast_finish: true
14 | allow_failures:
15 | - env: SCRIPT=scripts/test-gradle TRAVIS_JDK=adopt@1.8.202-08 # current gradle doesn't support play 2.7
16 | - env: SCRIPT=scripts/test-gradle TRAVIS_JDK=adopt@1.11.0-2 # current gradle doesn't support play 2.7
17 | - env: SCRIPT=scripts/test-sbt TRAVIS_JDK=adopt@1.11.0-2 # not fully supported but allows problem discovery
18 |
19 | before_install: curl -Ls https://git.io/jabba | bash && . ~/.jabba/jabba.sh
20 | install: jabba install "$TRAVIS_JDK" && jabba use "$_" && java -Xmx32m -version
21 |
22 | cache:
23 | directories:
24 | - "$HOME/.gradle/caches"
25 | - "$HOME/.ivy2/cache"
26 | - "$HOME/.jabba/jdk"
27 | - "$HOME/.sbt"
28 |
29 | before_cache:
30 | - find $HOME/.ivy2 -name "ivydata-*.properties" -delete
31 | - find $HOME/.sbt -name "*.lock" -delete
32 |
--------------------------------------------------------------------------------
/test/browser/BrowserSpec.scala:
--------------------------------------------------------------------------------
1 | package browser
2 |
3 | import org.scalatestplus.play._
4 | import org.scalatestplus.play.guice._
5 |
6 | /**
7 | * To get the full round trip experience, you can use ScalaTest with Selenium.
8 | *
9 | * For browser testing, you need both a server (here "GuiceOneServerPerSuite") and a
10 | * browser driver (here "HtmlUnitFactory") to get running.
11 | *
12 | * The syntax comes from Scalatest's WebBrowser class, and for more details you can see:
13 | *
14 | * http://www.scalatest.org/user_guide/using_selenium
15 | */
16 | class BrowserSpec extends PlaySpec with GuiceOneServerPerSuite with OneBrowserPerSuite with HtmlUnitFactory {
17 |
18 | "The browser should" must {
19 | "successfully process a form" in {
20 | val listWidgetsURL = controllers.routes.WidgetController.listWidgets().absoluteURL(false, s"localhost:$port")
21 |
22 | go to listWidgetsURL
23 |
24 | // Enter in the form fields...
25 | textField("name").value = "Foo"
26 | textField("price").value = "100"
27 |
28 | // Press enter button...
29 | submit()
30 |
31 | // Wait for server to process...
32 | eventually {
33 | // Check to see that the value made into Flash message!
34 | pageSource contains "Foo"
35 | }
36 | }
37 | }
38 | }
--------------------------------------------------------------------------------
/test/functional/FunctionalSpec.scala:
--------------------------------------------------------------------------------
1 | package functional
2 |
3 | import controllers.{WidgetController, routes}
4 | import org.scalatest.concurrent.ScalaFutures
5 | import org.scalatestplus.play.PlaySpec
6 | import org.scalatestplus.play.guice.GuiceOneAppPerSuite
7 | import play.api.http.Status
8 | import play.api.mvc._
9 | import play.api.test.Helpers._
10 | import play.api.test._
11 |
12 | import scala.concurrent.Future
13 |
14 | /**
15 | * Functional specification that has a running Play application.
16 | *
17 | * This is good for testing filter functionality, such as CSRF token and template checks.
18 | *
19 | * See https://www.playframework.com/documentation/2.6.x/ScalaFunctionalTestingWithScalaTest for more details.
20 | */
21 | class FunctionalSpec extends PlaySpec with GuiceOneAppPerSuite with Injecting with ScalaFutures {
22 |
23 | // CSRF token helper adds "withCSRFToken" to FakeRequest:
24 | // https://www.playframework.com/documentation/2.6.x/ScalaCsrf#Testing-CSRF
25 | import CSRFTokenHelper._
26 |
27 | "WidgetController" must {
28 |
29 | "process a POST request successfully" in {
30 | // Pull the controller from the already running Play application, using Injecting
31 | val controller = inject[WidgetController]
32 |
33 | // Call using the FakeRequest and the correct body information and CSRF token
34 | val request = FakeRequest(routes.WidgetController.createWidget())
35 | .withFormUrlEncodedBody("name" -> "foo", "price" -> "100")
36 | .withCSRFToken
37 | val futureResult: Future[Result] = controller.createWidget().apply(request)
38 |
39 | // And we can get the results out using Scalatest's "Futures" trait, which gives us whenReady
40 | whenReady(futureResult) { result =>
41 | result.header.headers(LOCATION) must equal(routes.WidgetController.listWidgets().url)
42 | }
43 | }
44 |
45 | "reject a POST request when given bad input" in {
46 | val controller = inject[WidgetController]
47 |
48 | // Call the controller with negative price...
49 | val request = FakeRequest(routes.WidgetController.createWidget())
50 | .withFormUrlEncodedBody("name" -> "foo", "price" -> "-100")
51 | .withCSRFToken
52 | val futureResult: Future[Result] = controller.createWidget().apply(request)
53 |
54 | status(futureResult) must be(Status.BAD_REQUEST)
55 | }
56 | }
57 |
58 | }
59 |
--------------------------------------------------------------------------------
/app/controllers/WidgetController.scala:
--------------------------------------------------------------------------------
1 | package controllers
2 |
3 | import javax.inject.Inject
4 |
5 | import models.Widget
6 | import play.api.data._
7 | import play.api.i18n._
8 | import play.api.mvc._
9 |
10 | /**
11 | * The classic WidgetController using MessagesAbstractController.
12 | *
13 | * Instead of MessagesAbstractController, you can use the I18nSupport trait,
14 | * which provides implicits that create a Messages instance from a request
15 | * using implicit conversion.
16 | *
17 | * See https://www.playframework.com/documentation/2.6.x/ScalaForms#passing-messagesprovider-to-form-helpers
18 | * for details.
19 | */
20 | class WidgetController @Inject()(cc: MessagesControllerComponents) extends MessagesAbstractController(cc) {
21 | import WidgetForm._
22 |
23 | private val widgets = scala.collection.mutable.ArrayBuffer(
24 | Widget("Widget 1", 123),
25 | Widget("Widget 2", 456),
26 | Widget("Widget 3", 789)
27 | )
28 |
29 | // The URL to the widget. You can call this directly from the template, but it
30 | // can be more convenient to leave the template completely stateless i.e. all
31 | // of the "WidgetController" references are inside the .scala file.
32 | private val postUrl = routes.WidgetController.createWidget()
33 |
34 | def index = Action {
35 | Ok(views.html.index())
36 | }
37 |
38 | def listWidgets = Action { implicit request: MessagesRequest[AnyContent] =>
39 | // Pass an unpopulated form to the template
40 | Ok(views.html.listWidgets(widgets, form, postUrl))
41 | }
42 |
43 | // This will be the action that handles our form post
44 | def createWidget = Action { implicit request: MessagesRequest[AnyContent] =>
45 | val errorFunction = { formWithErrors: Form[Data] =>
46 | // This is the bad case, where the form had validation errors.
47 | // Let's show the user the form again, with the errors highlighted.
48 | // Note how we pass the form with errors to the template.
49 | BadRequest(views.html.listWidgets(widgets, formWithErrors, postUrl))
50 | }
51 |
52 | val successFunction = { data: Data =>
53 | // This is the good case, where the form was successfully parsed as a Data object.
54 | val widget = Widget(name = data.name, price = data.price)
55 | widgets.append(widget)
56 | Redirect(routes.WidgetController.listWidgets()).flashing("info" -> "Widget added!")
57 | }
58 |
59 | val formValidationResult = form.bindFromRequest
60 | formValidationResult.fold(errorFunction, successFunction)
61 | }
62 | }
63 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @if "%DEBUG%" == "" @echo off
2 | @rem ##########################################################################
3 | @rem
4 | @rem Gradle startup script for Windows
5 | @rem
6 | @rem ##########################################################################
7 |
8 | @rem Set local scope for the variables with windows NT shell
9 | if "%OS%"=="Windows_NT" setlocal
10 |
11 | set DIRNAME=%~dp0
12 | if "%DIRNAME%" == "" set DIRNAME=.
13 | set APP_BASE_NAME=%~n0
14 | set APP_HOME=%DIRNAME%
15 |
16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
17 | set DEFAULT_JVM_OPTS=
18 |
19 | @rem Find java.exe
20 | if defined JAVA_HOME goto findJavaFromJavaHome
21 |
22 | set JAVA_EXE=java.exe
23 | %JAVA_EXE% -version >NUL 2>&1
24 | if "%ERRORLEVEL%" == "0" goto init
25 |
26 | echo.
27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28 | echo.
29 | echo Please set the JAVA_HOME variable in your environment to match the
30 | echo location of your Java installation.
31 |
32 | goto fail
33 |
34 | :findJavaFromJavaHome
35 | set JAVA_HOME=%JAVA_HOME:"=%
36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37 |
38 | if exist "%JAVA_EXE%" goto init
39 |
40 | echo.
41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42 | echo.
43 | echo Please set the JAVA_HOME variable in your environment to match the
44 | echo location of your Java installation.
45 |
46 | goto fail
47 |
48 | :init
49 | @rem Get command-line arguments, handling Windows variants
50 |
51 | if not "%OS%" == "Windows_NT" goto win9xME_args
52 |
53 | :win9xME_args
54 | @rem Slurp the command line arguments.
55 | set CMD_LINE_ARGS=
56 | set _SKIP=2
57 |
58 | :win9xME_args_slurp
59 | if "x%~1" == "x" goto execute
60 |
61 | set CMD_LINE_ARGS=%*
62 |
63 | :execute
64 | @rem Setup the command line
65 |
66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
67 |
68 | @rem Execute Gradle
69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
70 |
71 | :end
72 | @rem End local scope for the variables with windows NT shell
73 | if "%ERRORLEVEL%"=="0" goto mainEnd
74 |
75 | :fail
76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
77 | rem the _cmd.exe /c_ return code!
78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
79 | exit /b 1
80 |
81 | :mainEnd
82 | if "%OS%"=="Windows_NT" endlocal
83 |
84 | :omega
85 |
--------------------------------------------------------------------------------
/.github/settings.yml:
--------------------------------------------------------------------------------
1 | # These settings are synced to GitHub by https://probot.github.io/apps/settings/
2 | repository:
3 | homepage: "https://developer.lightbend.com/start/?group=play"
4 | topics: playframework, example, example-project, sample, sample-app, jvm, webapp
5 | private: false
6 | has_issues: true
7 | # We don't need projects in sample projects
8 | has_projects: false
9 | # We don't need wiki in sample projects
10 | has_wiki: false
11 | has_downloads: true
12 | default_branch: 2.7.x
13 | allow_squash_merge: true
14 | allow_merge_commit: false
15 | allow_rebase_merge: false
16 |
17 | teams:
18 | - name: core
19 | permission: admin
20 | - name: integrators
21 | permission: write
22 | - name: write-bots
23 | permission: write
24 |
25 | branches:
26 | - name: "[0-9].*.x"
27 | protection:
28 | # We don't require reviews for sample applications because they are mainly
29 | # updated by template-control, which is an automated process
30 | required_pull_request_reviews: null
31 | # Required. Require status checks to pass before merging. Set to null to disable
32 | required_status_checks:
33 | # Required. The list of status checks to require in order to merge into this branch
34 | contexts: ["Travis CI - Pull Request", "typesafe-cla-validator"]
35 |
36 | # Labels: tailored list of labels to be used by sample applications
37 | labels:
38 | - color: f9d0c4
39 | name: "closed:declined"
40 | - color: f9d0c4
41 | name: "closed:duplicated"
42 | oldname: duplicate
43 | - color: f9d0c4
44 | name: "closed:invalid"
45 | oldname: invalid
46 | - color: f9d0c4
47 | name: "closed:question"
48 | oldname: question
49 | - color: f9d0c4
50 | name: "closed:wontfix"
51 | oldname: wontfix
52 | - color: 7057ff
53 | name: "good first issue"
54 | - color: 7057ff
55 | name: "Hacktoberfest"
56 | - color: 7057ff
57 | name: "help wanted"
58 | - color: cceecc
59 | name: "status:backlog"
60 | oldname: backlog
61 | - color: b60205
62 | name: "status:block-merge"
63 | oldname: block-merge
64 | - color: b60205
65 | name: "status:blocked"
66 | - color: 0e8a16
67 | name: "status:in-progress"
68 | - color: 0e8a16
69 | name: "status:merge-when-green"
70 | oldname: merge-when-green
71 | - color: fbca04
72 | name: "status:needs-backport"
73 | - color: fbca04
74 | name: "status:needs-forwardport"
75 | - color: fbca04
76 | name: "status:needs-info"
77 | - color: fbca04
78 | name: "status:needs-verification"
79 | - color: 0e8a16
80 | name: "status:ready"
81 | - color: fbca04
82 | name: "status:to-review"
83 | oldname: review
84 | - color: c5def5
85 | name: "topic:build/tests"
86 | - color: c5def5
87 | name: "topic:dev-environment"
88 | - color: c5def5
89 | name: "topic:documentation"
90 | - color: c5def5
91 | name: "topic:jdk-next"
92 | - color: b60205
93 | name: "type:defect"
94 | oldname: bug
95 | - color: 0052cc
96 | name: "type:feature"
97 | - color: 0052cc
98 | name: "type:improvement"
99 | oldname: enhancement
100 | - color: 0052cc
101 | name: "type:updates"
102 | - color: bf0d92
103 | name: "type:template-control"
104 | oldname: template-control
105 |
--------------------------------------------------------------------------------
/test/unit/UnitSpec.scala:
--------------------------------------------------------------------------------
1 | package unit
2 |
3 | import controllers.WidgetForm
4 | import org.scalatestplus.play.PlaySpec
5 | import play.api.data.FormError
6 | import play.api.i18n._
7 | import play.api.mvc._
8 | import play.api.test._
9 |
10 | /**
11 | * Unit tests that do not require a running Play application.
12 | *
13 | * This is useful for testing forms and constraints.
14 | */
15 | class UnitSpec extends PlaySpec {
16 |
17 | "WidgetForm" must {
18 |
19 | "apply successfully from request" in {
20 | // The easiest way to test a form is by passing it a fake request.
21 | val call = controllers.routes.WidgetController.createWidget()
22 | implicit val request: Request[_] = FakeRequest(call).withFormUrlEncodedBody("name" -> "foo", "price" -> "100")
23 | // A successful binding using an implicit request will give you a form with a value.
24 | val boundForm = WidgetForm.form.bindFromRequest()
25 | // You can then get the widget data out and test it.
26 | val widgetData = boundForm.value.get
27 |
28 | widgetData.name must equal("foo")
29 | widgetData.price must equal(100)
30 | }
31 |
32 | "apply successfully from map" in {
33 | // You can also bind directy from a map, if you don't have a request handy.
34 | val data = Map("name" -> "foo", "price" -> "100")
35 | // A successful binding will give you a form with a value.
36 | val boundForm = WidgetForm.form.bind(data)
37 | // You can then get the widget data out and test it.
38 | val widgetData = boundForm.value.get
39 |
40 | widgetData.name must equal("foo")
41 | widgetData.price must equal(100)
42 | }
43 |
44 | "show errors when applied unsuccessfully" in {
45 | // Pass in a negative price that fails the constraints...
46 | val data = Map("name" -> "foo", "price" -> "-100")
47 |
48 | // ...and binding the form will show errors.
49 | val errorForm = WidgetForm.form.bind(data)
50 | // You can then get the widget data out and test it.
51 | val listOfErrors = errorForm.errors
52 |
53 | // Note that the FormError's key is the field it was bound to.
54 | // If there is no key, then it is a "global error".
55 | val formError: FormError = listOfErrors.head
56 | formError.key must equal("price")
57 |
58 | // In this case, we don't have any global errors -- they're caused
59 | // when a constraint on the form itself fails.
60 | errorForm.hasGlobalErrors mustBe false
61 |
62 | // The message is in the language that was "preferred" by the request's Messages
63 | // component. The closest messages file i.e. messages.en is looked up, and then
64 | // the constraint key ("error.min") is looked up. If there is no user defined
65 | // mapping, then the default messages file is "messages.default", which has
66 | //
67 | // error.min=Must be greater or equal to {0}
68 | //
69 | // but in this case, we haven't passed in a request, because we called bind instead of bindFromRequest!
70 | //
71 | // As such, when there is nothing in scope, the error message is the key itself.
72 | formError.message must equal("error.min")
73 |
74 | // You get the content of the message by calling Messages(key, args) with an in scope MessagesProvider.
75 | //
76 | // Usually you'll do this through dependency injection with
77 | // app.inject[MessagesApi] and messageApi.preferred(request), but we can
78 | // do it by hand here just to demonstrate what happens underneath the hood:
79 | val lang: Lang = Lang.defaultLang
80 | val messagesApi: MessagesApi = new DefaultMessagesApi(Map(lang.code -> Map("error.min" -> "Must be greater or equal to {0}")))
81 | val messagesProvider: MessagesProvider = messagesApi.preferred(Seq(lang))
82 | val message: String = Messages(formError.message, formError.args: _*)(messagesProvider)
83 |
84 | // And the message will be run through with the arguments:
85 | message must equal("Must be greater or equal to 0")
86 | }
87 |
88 | }
89 |
90 |
91 | }
92 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Attempt to set APP_HOME
10 | # Resolve links: $0 may be a link
11 | PRG="$0"
12 | # Need this for relative symlinks.
13 | while [ -h "$PRG" ] ; do
14 | ls=`ls -ld "$PRG"`
15 | link=`expr "$ls" : '.*-> \(.*\)$'`
16 | if expr "$link" : '/.*' > /dev/null; then
17 | PRG="$link"
18 | else
19 | PRG=`dirname "$PRG"`"/$link"
20 | fi
21 | done
22 | SAVED="`pwd`"
23 | cd "`dirname \"$PRG\"`/" >/dev/null
24 | APP_HOME="`pwd -P`"
25 | cd "$SAVED" >/dev/null
26 |
27 | APP_NAME="Gradle"
28 | APP_BASE_NAME=`basename "$0"`
29 |
30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31 | DEFAULT_JVM_OPTS=""
32 |
33 | # Use the maximum available, or set MAX_FD != -1 to use that value.
34 | MAX_FD="maximum"
35 |
36 | warn () {
37 | echo "$*"
38 | }
39 |
40 | die () {
41 | echo
42 | echo "$*"
43 | echo
44 | exit 1
45 | }
46 |
47 | # OS specific support (must be 'true' or 'false').
48 | cygwin=false
49 | msys=false
50 | darwin=false
51 | nonstop=false
52 | case "`uname`" in
53 | CYGWIN* )
54 | cygwin=true
55 | ;;
56 | Darwin* )
57 | darwin=true
58 | ;;
59 | MINGW* )
60 | msys=true
61 | ;;
62 | NONSTOP* )
63 | nonstop=true
64 | ;;
65 | esac
66 |
67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68 |
69 | # Determine the Java command to use to start the JVM.
70 | if [ -n "$JAVA_HOME" ] ; then
71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72 | # IBM's JDK on AIX uses strange locations for the executables
73 | JAVACMD="$JAVA_HOME/jre/sh/java"
74 | else
75 | JAVACMD="$JAVA_HOME/bin/java"
76 | fi
77 | if [ ! -x "$JAVACMD" ] ; then
78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79 |
80 | Please set the JAVA_HOME variable in your environment to match the
81 | location of your Java installation."
82 | fi
83 | else
84 | JAVACMD="java"
85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86 |
87 | Please set the JAVA_HOME variable in your environment to match the
88 | location of your Java installation."
89 | fi
90 |
91 | # Increase the maximum file descriptors if we can.
92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93 | MAX_FD_LIMIT=`ulimit -H -n`
94 | if [ $? -eq 0 ] ; then
95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96 | MAX_FD="$MAX_FD_LIMIT"
97 | fi
98 | ulimit -n $MAX_FD
99 | if [ $? -ne 0 ] ; then
100 | warn "Could not set maximum file descriptor limit: $MAX_FD"
101 | fi
102 | else
103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104 | fi
105 | fi
106 |
107 | # For Darwin, add options to specify how the application appears in the dock
108 | if $darwin; then
109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110 | fi
111 |
112 | # For Cygwin, switch paths to Windows format before running java
113 | if $cygwin ; then
114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116 | JAVACMD=`cygpath --unix "$JAVACMD"`
117 |
118 | # We build the pattern for arguments to be converted via cygpath
119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120 | SEP=""
121 | for dir in $ROOTDIRSRAW ; do
122 | ROOTDIRS="$ROOTDIRS$SEP$dir"
123 | SEP="|"
124 | done
125 | OURCYGPATTERN="(^($ROOTDIRS))"
126 | # Add a user-defined pattern to the cygpath arguments
127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129 | fi
130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
131 | i=0
132 | for arg in "$@" ; do
133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135 |
136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138 | else
139 | eval `echo args$i`="\"$arg\""
140 | fi
141 | i=$((i+1))
142 | done
143 | case $i in
144 | (0) set -- ;;
145 | (1) set -- "$args0" ;;
146 | (2) set -- "$args0" "$args1" ;;
147 | (3) set -- "$args0" "$args1" "$args2" ;;
148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154 | esac
155 | fi
156 |
157 | # Escape application args
158 | save () {
159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160 | echo " "
161 | }
162 | APP_ARGS=$(save "$@")
163 |
164 | # Collect all arguments for the java command, following the shell quoting and substitution rules
165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166 |
167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169 | cd "$(dirname "$0")"
170 | fi
171 |
172 | exec "$JAVACMD" "$@"
173 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | CC0 1.0 Universal
2 |
3 | Statement of Purpose
4 |
5 | The laws of most jurisdictions throughout the world automatically confer
6 | exclusive Copyright and Related Rights (defined below) upon the creator and
7 | subsequent owner(s) (each and all, an "owner") of an original work of
8 | authorship and/or a database (each, a "Work").
9 |
10 | Certain owners wish to permanently relinquish those rights to a Work for the
11 | purpose of contributing to a commons of creative, cultural and scientific
12 | works ("Commons") that the public can reliably and without fear of later
13 | claims of infringement build upon, modify, incorporate in other works, reuse
14 | and redistribute as freely as possible in any form whatsoever and for any
15 | purposes, including without limitation commercial purposes. These owners may
16 | contribute to the Commons to promote the ideal of a free culture and the
17 | further production of creative, cultural and scientific works, or to gain
18 | reputation or greater distribution for their Work in part through the use and
19 | efforts of others.
20 |
21 | For these and/or other purposes and motivations, and without any expectation
22 | of additional consideration or compensation, the person associating CC0 with a
23 | Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
24 | and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
25 | and publicly distribute the Work under its terms, with knowledge of his or her
26 | Copyright and Related Rights in the Work and the meaning and intended legal
27 | effect of CC0 on those rights.
28 |
29 | 1. Copyright and Related Rights. A Work made available under CC0 may be
30 | protected by copyright and related or neighboring rights ("Copyright and
31 | Related Rights"). Copyright and Related Rights include, but are not limited
32 | to, the following:
33 |
34 | i. the right to reproduce, adapt, distribute, perform, display, communicate,
35 | and translate a Work;
36 |
37 | ii. moral rights retained by the original author(s) and/or performer(s);
38 |
39 | iii. publicity and privacy rights pertaining to a person's image or likeness
40 | depicted in a Work;
41 |
42 | iv. rights protecting against unfair competition in regards to a Work,
43 | subject to the limitations in paragraph 4(a), below;
44 |
45 | v. rights protecting the extraction, dissemination, use and reuse of data in
46 | a Work;
47 |
48 | vi. database rights (such as those arising under Directive 96/9/EC of the
49 | European Parliament and of the Council of 11 March 1996 on the legal
50 | protection of databases, and under any national implementation thereof,
51 | including any amended or successor version of such directive); and
52 |
53 | vii. other similar, equivalent or corresponding rights throughout the world
54 | based on applicable law or treaty, and any national implementations thereof.
55 |
56 | 2. Waiver. To the greatest extent permitted by, but not in contravention of,
57 | applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
58 | unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
59 | and Related Rights and associated claims and causes of action, whether now
60 | known or unknown (including existing as well as future claims and causes of
61 | action), in the Work (i) in all territories worldwide, (ii) for the maximum
62 | duration provided by applicable law or treaty (including future time
63 | extensions), (iii) in any current or future medium and for any number of
64 | copies, and (iv) for any purpose whatsoever, including without limitation
65 | commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
66 | the Waiver for the benefit of each member of the public at large and to the
67 | detriment of Affirmer's heirs and successors, fully intending that such Waiver
68 | shall not be subject to revocation, rescission, cancellation, termination, or
69 | any other legal or equitable action to disrupt the quiet enjoyment of the Work
70 | by the public as contemplated by Affirmer's express Statement of Purpose.
71 |
72 | 3. Public License Fallback. Should any part of the Waiver for any reason be
73 | judged legally invalid or ineffective under applicable law, then the Waiver
74 | shall be preserved to the maximum extent permitted taking into account
75 | Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
76 | is so judged Affirmer hereby grants to each affected person a royalty-free,
77 | non transferable, non sublicensable, non exclusive, irrevocable and
78 | unconditional license to exercise Affirmer's Copyright and Related Rights in
79 | the Work (i) in all territories worldwide, (ii) for the maximum duration
80 | provided by applicable law or treaty (including future time extensions), (iii)
81 | in any current or future medium and for any number of copies, and (iv) for any
82 | purpose whatsoever, including without limitation commercial, advertising or
83 | promotional purposes (the "License"). The License shall be deemed effective as
84 | of the date CC0 was applied by Affirmer to the Work. Should any part of the
85 | License for any reason be judged legally invalid or ineffective under
86 | applicable law, such partial invalidity or ineffectiveness shall not
87 | invalidate the remainder of the License, and in such case Affirmer hereby
88 | affirms that he or she will not (i) exercise any of his or her remaining
89 | Copyright and Related Rights in the Work or (ii) assert any associated claims
90 | and causes of action with respect to the Work, in either case contrary to
91 | Affirmer's express Statement of Purpose.
92 |
93 | 4. Limitations and Disclaimers.
94 |
95 | a. No trademark or patent rights held by Affirmer are waived, abandoned,
96 | surrendered, licensed or otherwise affected by this document.
97 |
98 | b. Affirmer offers the Work as-is and makes no representations or warranties
99 | of any kind concerning the Work, express, implied, statutory or otherwise,
100 | including without limitation warranties of title, merchantability, fitness
101 | for a particular purpose, non infringement, or the absence of latent or
102 | other defects, accuracy, or the present or absence of errors, whether or not
103 | discoverable, all to the greatest extent permissible under applicable law.
104 |
105 | c. Affirmer disclaims responsibility for clearing rights of other persons
106 | that may apply to the Work or any use thereof, including without limitation
107 | any person's Copyright and Related Rights in the Work. Further, Affirmer
108 | disclaims responsibility for obtaining any necessary consents, permissions
109 | or other rights required for any use of the Work.
110 |
111 | d. Affirmer understands and acknowledges that Creative Commons is not a
112 | party to this document and has no duty or obligation with respect to this
113 | CC0 or use of the Work.
114 |
115 | For more information, please see
116 |
117 |
--------------------------------------------------------------------------------