Initial commit

Author: torstenrudolf

.gitignore

@@ -0,0 +1,7 @@
+target/
+.cache
+.classpath
+.project
+.settings/
+.idea/
+*.txt

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 TR
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,92 @@
+# FormBinder
+
+FormBinder is a tool to bind reactjs form fields to a DataModel plus validation.
+
+
+## Usage
+
+```scala
+import FormBinder.{ValidationResult, Validator}
+
+
+case class Data(username: String = "", 
+                password1: String = "",
+                password2: String = "")                     
+
+// define validation rules in companion object
+// note: the field names must match to the data model
+object Data {
+  
+  def username(username: String) = {
+    if (username.isEmpty) ValidationResult.withError("Please specify username")
+    else ValidationResult.success
+  }
+
+  def password1(password1: String) = // simpler syntax
+    Validator(password.isEmpty, "Please specify password")
+  
+  def password2(password1: String, password2: Option[String]) = {  
+    // you can "inject" any other fields as Options 
+    if (password1.isEmpty) ValidationResult.withError("Please specify password")
+    else if (password2.nonEmpty && password1 != password2.get) ValidationResult.withError("Must match password.")
+    else ValidationResult.success
+  }
+
+  // define global (not tied to a specific field) validation rules here
+  def $global(data: Data) = {
+    ValidationResult.success
+  }
+  
+  
+  ...
+
+  // then define the form layout fields -- probably inside the component's Backend
+  
+  object FormDescription extends FormBinder.FormDescription[Data] {
+
+    // field names must match the data model's field names
+    val username = FormFieldDescriptor((a: FormFieldArgs[String]) =>
+      MuiTextField(
+        floatingLabelText = "Username",
+        onChange = (e: ReactEventI) => a.onChangeHandler(e.target.value),
+        errorText = a.currentValidationResult.errorMessage)()
+    )
+    val password1 = ...
+    val password2 = ...
+
+    // define what to do after form data and/or form validation changes
+    override def onChange(newData: Option[Data],
+                          allFieldValidationResults: List[ValidationResult],
+                          globalFormValidationResult: ValidationResult): Callback = {
+      $.modState(_.copy(data = newData, globalValidationResult = globalFormValidationResult))
+    }
+  }
+  
+  // this binds the data model, validation rules and form description together
+  val form = FormBinder.bind[Data](FormDescription)
+
+  // use it like this:
+  val handleSubmit: Callback = $.state >>= { (state: State)  =>
+    if (state.globalFormValidationResult.isValid) {
+      // do something with state.data.get
+    } else form.showUninitializedFieldErrors
+  }
+  
+  def render(state: State) = <.div(
+    <.form(
+      ^.onSubmit --> handleSubmit,
+      ^.display.flex,
+      ^.flexDirection.column,
+      loginForm.field(LoginFormDescription.username),
+      loginForm.field(LoginFormDescription.password)
+    ),
+    if (!state.globalValidationResult.isValid) {
+      <.div(state.globalValidationResult.errorMessage)
+    } else ""
+  )
+```
+
+
+## TODO
+
+* add prebuild FormFieldDescriptors for material-ui

build.sbt

@@ -0,0 +1,58 @@
+
+def commonSettings: Project => Project =
+  _.enablePlugins(ScalaJSPlugin)
+    .settings(
+      organization := "com.github.torstenrudolf.scalajs-react-form-binder",
+      version := "0.0.1-SNAPSHOT",
+      homepage := Some(url("https://github.com/torstenrudolf/scalajs-react-form-binder")),
+      licenses += ("MIT", url("https://opensource.org/licenses/MIT")),
+      scalaVersion := "2.11.8")
+
+def preventPublication: Project => Project =
+  _.settings(
+    publishTo := Some(Resolver.file("Unused transient repository", target.value / "fakepublish")),
+    publishArtifact := false)
+
+
+lazy val core = (project in file("core")).configure(commonSettings)
+  .settings(
+    name := "core",
+    libraryDependencies ++= Seq(
+      "org.scala-lang" % "scala-compiler" % scalaVersion.value,
+      "com.github.japgolly.scalajs-react" %%% "extra" % "0.11.2"
+    ),
+    publishTo <<= version { (v: String) =>
+      val nexus = "https://oss.sonatype.org/"
+      if (v.trim.endsWith("SNAPSHOT"))
+        Some("snapshots" at nexus + "content/repositories/snapshots")
+      else
+        Some("releases" at nexus + "service/local/staging/deploy/maven2")
+    },
+    publishArtifact in Test := false,
+    pomExtra :=
+      <url>https://github.com/torstenrudolf/scalajs-react-form-binder</url>
+        <licenses>
+          <license>
+            <name>MIT license</name>
+            <url>http://www.opensource.org/licenses/mit-license.php</url>
+          </license>
+        </licenses>
+        <scm>
+          <url>git://github.com/torstenrudolf/scalajs-react-form-binder.git</url>
+          <connection>scm:git://github.com/torstenrudolf/scalajs-react-form-binder.git</connection>
+        </scm>
+        <developers>
+          <developer>
+            <id>torstenrudolf</id>
+            <name>Torsten Rudolf</name>
+            <url>https://github.com/torstenrudolf</url>
+          </developer>
+        </developers>
+  )
+
+lazy val root = (project in file("."))
+  .aggregate(core)
+  .configure(commonSettings, preventPublication)
+
+
+

core/src/main/scala/torstenrudolf/scalajs/react/formbinder/Form.scala

@@ -0,0 +1,52 @@
+package torstenrudolf.scalajs.react.formbinder
+
+import japgolly.scalajs.react.{Callback, ReactNode}
+
+trait Form[DataModel] {
+
+  def allFields: List[ReactNode]
+
+  def field[T](fd: FormFieldDescriptor[T]): ReactNode
+
+  def setFieldValue[T](fd: FormFieldDescriptor[T], value: T): Callback
+
+  def showUninitializedFieldErrors: Callback
+
+  def fieldValue[A](fd: FormFieldDescriptor[A]): Option[A]
+
+}
+
+
+sealed trait FormFailure
+
+case object FormUninitialized extends Throwable("Uninitialized Field") with FormFailure
+
+case object FormProcessingFailure extends Throwable("Form is actively processing") with FormFailure
+
+
+case class FormFieldArgs[T](fieldName: String,
+                            currentValue: Option[T],
+                            currentValidationResult: ValidationResult,
+                            onChangeCB: (T) => Callback,
+                            // todo: Do they need to be functions?
+                            resetCB: () => Callback, // sets to defaultValue from DataModel if present
+                            clearCB: () => Callback,
+                            private val parentForm: Form[_] with FormAPI[_]) {
+
+  def otherFieldValue[T2](fd: FormFieldDescriptor[T2]): Option[T2] = parentForm.fieldValue(fd)
+
+  def clearOtherField[T2](fd: FormFieldDescriptor[T2]): Callback = parentForm.fieldBinding(fd).clear()
+}
+
+case class FormFieldDescriptor[T](descr: (FormFieldArgs[T]) => ReactNode)
+
+
+abstract class FormLayout[T] {
+  /*
+
+   */
+  def onChange(newData: Option[T],
+               allFieldValidationResults: List[ValidationResult],
+               globalFormValidationResult: ValidationResult): Callback
+
+}