tristate's Introduction

tristate

Tristate[A] is three-valued variant of Option[A] distinguishing between Present[A](a: A), Absent, and Unspecified.

Name	Description	Scaladoc
`tristate-core`	Main library
`tristate-play`	Play JSON `Reads/Writes`
`tristate-cats`	Cats Typeclasses
`tristate-scalaz`	Scalaz Typeclasses

Installation

Add the following to your sbt build:

libraryDependencies += "org.davidbild" %% "tristate-core" % "0.4.0"

To support de/serialization using Play JSON, also add:

libraryDependencies += "org.davidbild" %% "tristate-play" % "0.4.0"

For Scalaz typeclass instances (Functor, Monad, etc.), also add:

libraryDependencies += "org.davidbild" %% "tristate-scalaz" % "0.4.0"

For Cats typeclass instances (Functor, Monad, etc.), also add:

libraryDependencies += "org.davidbild" %% "tristate-cats" % "0.4.0"

Usage

TODO

Import

import org.davidbild.tristate.Tristate

// For optional Play JSON support
import org.davidbild.tristate.contrib.play._

// For optional Scalaz typeclass support
import org.davidbild.tristate.contrib.scalaz._

// For optional Cats typeclass support
import org.davidbild.tristate.contrib.cats._

Documents

scaladoc (latest stable release)

Contributing

Please submit bugs, questions, suggestions, or (ideally) contributions as issues and pull requests on Github.

Maintainers

David R. Bild https://www.davidbild.org

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License from the LICENSE.txt file or at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

tristate's People

Contributors

Stargazers

Watchers

tristate's Issues

Scala 2.13 support

Please publish a new version with Scala 2.13 and play-json 2.8.1 support

Thanks in advance

Implement cats contrib package

Still active?

I've recently released a json library at https://github.com/kag0/ninny-json which has first class support for distinguishing between null and absent fields in the typeclasses. It seems like a natural partner for what you've got here.
If this project is still active I'll send you a PR to add support.