web

Type Members

sealed trait AskResult[+A, Html] extends AnyRef

An abstracted result from asking the user for a value via a web interface.
An abstracted result from asking the user for a value via a web interface. Each web interpreter will want to convert this into it's own representation
type Breadcrumbs = List[List[String]]

Definition Classes
webcommon
trait Codec[A] extends AnyRef
trait CoproductFieldList[A, Html] extends AnyRef
type DB = Map[List[String], String]

Definition Classes
webcommon
trait FormField[A, Html] extends Codec[A]

Defines both the rendering and the encoding for a given datatype
trait FormFieldEncoding[A] extends AnyRef

A codec for a datatype to make it usable as a form field inside a uniform web interpreter.
A codec for a datatype to make it usable as a form field inside a uniform web interpreter. Technically this is a split epimorphism between Input => Either[ErrorTree,A] and A => Input.
trait FormFieldPresentation[A, Html] extends AnyRef

Controls the rendering of a field in a web form
case class FormFieldStats(children: Int = 0, compoundChildren: Int = 0) extends Product with Serializable
case class FutureAdapter[Html]() extends Product with Serializable
trait GenericWebInterpreter[Html] extends AnyRef
trait GenericWebTell[A, Html] extends AnyRef

Represents rendering a type for a tell interaction used in a web interpreter
trait InferFormFieldCoProduct[Html] extends AnyRef
trait InferFormFieldProduct[Html] extends AnyRef
trait InferListingPages[Html] extends AnyRef

Produces pages for List[A] where a user can enter multiple items of a given datatype via a central page that enumerates the items already, allows them to add new items and edit or delete existing ones.
Produces pages for List[A] where a user can enter multiple items of a given datatype via a central page that enumerates the items already, allows them to add new items and edit or delete existing ones.
There are two ways you can produce a listing - the first works by infering the page for A automatically. To use this approach simply use an ask[List[A]] in your journey and it will pick up and use the add/edit part from inference, falling back to InferFormField if necessary.
The second approach works by explicitly supplying a subjourney and interpreting this into a WebMonadConstructor, by using the listingPageWM method.
trait InferTell[Html] extends AnyRef
case class JourneyConfig(leapAhead: Boolean = true, askFirstListItem: Boolean = false) extends Product with Serializable

leapAhead
fast forward to the first empty question in a journey
askFirstListItem
when asking for list A with a minimum number of A required then go straight to add A subjourney rather than to the empty listing index page
sealed trait ListAction extends AnyRef
sealed trait ListActionGeneral extends ListAction
sealed trait ListActionRow extends ListAction
trait ListingTell[Html, A] extends AnyRef

A representation of how to render a listing of a type of object
case class ListingTellRow[A](value: A, editLink: String, deleteLink: String) extends Product with Serializable
case class PageIn(targetId: List[String], breadcrumbs: web.Breadcrumbs, request: Option[Input], state: web.DB, pathPrefix: List[String], config: JourneyConfig) extends Product with Serializable
final case class PageOut[A, Html](breadcrumbs: web.Breadcrumbs, db: web.DB, output: AskResult[A, Html], pathPrefix: List[String], config: JourneyConfig) extends Product with Serializable

The combined output of web execution
abstract class PostAndGetPage[A, Html] extends WebMonadConstructor[A, Html]
trait ProductFieldList[A, Html] extends AnyRef
implicit final class RichDateTime extends AnyVal
implicit class RichList[A] extends AnyRef
class SimplePostAndGetPage[A, Html] extends PostAndGetPage[A, Html]
abstract class WebMonad[A, Html] extends AnyRef
trait WebMonadConstructor[A, Html] extends AnyRef
trait webcommon extends AnyRef

Value Members

object AskResult
object DB

Definition Classes
webcommon
object ListAction

The data type returned form the branching part of a listing page.
object Pos

Attributes
protected
object PostAndGetPage
object WebMonad
implicit def formToWebMonad[A, Html](implicit ff: FormField[A, Html]): WebMonadConstructor[A, Html]

Definition Classes
webcommon
implicit val orderLocalDateTime: Order[LocalDateTime]
def relativePath(from: List[String], to: List[String]): String

Returns a relative path as used in a URI or *nix directory - with '..' used to denote navigating up one element in the tree.
Returns a relative path as used in a URI or *nix directory - with '..' used to denote navigating up one element in the tree.
```
scala> relativePath(List("1","2"),{1 to 5}.map{_.toString}.toList)
res0: String = 3/4/5

scala> relativePath(List("1","other","thing"),{1 to 5}.map{_.toString}.toList)
res1: String = ../2/3/4/5
```
Definition Classes
webcommon
final def removeCommon[B](x: List[B], y: List[B])(implicit arg0: Eq[B]): (List[B], List[B])

Returns the lists given as arguments with any sequence common to the two removed from the start
Returns the lists given as arguments with any sequence common to the two removed from the start
```
scala> removeCommon({1 to 5}.toList, List(1,2))
res0: (List[Int], List[Int]) = (List(3, 4, 5),List())
```
Definition Classes
webcommon
Annotations
@tailrec()

package web

Type Members

sealed trait AskResult[+A, Html] extends AnyRef

type Breadcrumbs = List[List[String]]

trait Codec[A] extends AnyRef

trait CoproductFieldList[A, Html] extends AnyRef

type DB = Map[List[String], String]

trait FormField[A, Html] extends Codec[A]

trait FormFieldEncoding[A] extends AnyRef

trait FormFieldPresentation[A, Html] extends AnyRef

case class FormFieldStats(children: Int = 0, compoundChildren: Int = 0) extends Product with Serializable

case class FutureAdapter[Html]() extends Product with Serializable

trait GenericWebInterpreter[Html] extends AnyRef

trait GenericWebTell[A, Html] extends AnyRef

trait InferFormFieldCoProduct[Html] extends AnyRef

trait InferFormFieldProduct[Html] extends AnyRef

trait InferListingPages[Html] extends AnyRef

trait InferTell[Html] extends AnyRef

case class JourneyConfig(leapAhead: Boolean = true, askFirstListItem: Boolean = false) extends Product with Serializable

sealed trait ListAction extends AnyRef

sealed trait ListActionGeneral extends ListAction

sealed trait ListActionRow extends ListAction

trait ListingTell[Html, A] extends AnyRef

case class ListingTellRow[A](value: A, editLink: String, deleteLink: String) extends Product with Serializable

case class PageIn(targetId: List[String], breadcrumbs: web.Breadcrumbs, request: Option[Input], state: web.DB, pathPrefix: List[String], config: JourneyConfig) extends Product with Serializable

final case class PageOut[A, Html](breadcrumbs: web.Breadcrumbs, db: web.DB, output: AskResult[A, Html], pathPrefix: List[String], config: JourneyConfig) extends Product with Serializable

abstract class PostAndGetPage[A, Html] extends WebMonadConstructor[A, Html]

trait ProductFieldList[A, Html] extends AnyRef

implicit final class RichDateTime extends AnyVal

implicit class RichList[A] extends AnyRef

class SimplePostAndGetPage[A, Html] extends PostAndGetPage[A, Html]

abstract class WebMonad[A, Html] extends AnyRef

trait WebMonadConstructor[A, Html] extends AnyRef

trait webcommon extends AnyRef

Value Members

object AskResult

object DB

object ListAction

object Pos

object PostAndGetPage

object WebMonad

implicit def formToWebMonad[A, Html](implicit ff: FormField[A, Html]): WebMonadConstructor[A, Html]

implicit val orderLocalDateTime: Order[LocalDateTime]

def relativePath(from: List[String], to: List[String]): String

final def removeCommon[B](x: List[B], y: List[B])(implicit arg0: Eq[B]): (List[B], List[B])

Inherited from webcommon

Inherited from AnyRef

Inherited from Any

Ungrouped