mirror of
https://github.com/fluencelabs/codec
synced 2025-04-25 06:42:14 +00:00
Compare commits
13 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
cf36fdb00e | ||
|
70dae6edca | ||
|
3c4a7fc722 | ||
|
e0d046b197 | ||
|
b8b07d2a8d | ||
|
d23e60f516 | ||
|
7dee94d09b | ||
|
744e5b92b8 | ||
|
cfd132db76 | ||
|
a3de737d45 | ||
|
6efaac148b | ||
|
6378af3658 | ||
|
e1b5bfb947 |
@ -2,7 +2,7 @@ sudo: required
|
|||||||
|
|
||||||
language: scala
|
language: scala
|
||||||
scala:
|
scala:
|
||||||
- 2.12.5
|
- 2.12.8
|
||||||
jdk:
|
jdk:
|
||||||
- oraclejdk8
|
- oraclejdk8
|
||||||
|
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
[](https://travis-ci.org/fluencelabs/codec) [](https://gitter.im/fluencelabs/codec?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
[](https://travis-ci.org/fluencelabs/codec)
|
||||||
|
|
||||||
# Codec
|
# Codec
|
||||||
|
|
||||||
@ -64,7 +64,7 @@ In case of complex algorithms, it's worthy to share codebase between platforms.
|
|||||||
// Bintray repo is used so far. Migration to Maven Central is planned
|
// Bintray repo is used so far. Migration to Maven Central is planned
|
||||||
resolvers += Resolver.bintrayRepo("fluencelabs", "releases")
|
resolvers += Resolver.bintrayRepo("fluencelabs", "releases")
|
||||||
|
|
||||||
val codecV = "0.0.1"
|
val codecV = "0.0.4"
|
||||||
|
|
||||||
libraryDependencies ++= Seq(
|
libraryDependencies ++= Seq(
|
||||||
"one.fluence" %%% "codec-core" % codecV, // basic types
|
"one.fluence" %%% "codec-core" % codecV, // basic types
|
||||||
|
@ -29,18 +29,36 @@ object BitsCodecs {
|
|||||||
implicit val byteArrayToVector: PureCodec[Array[Byte], ByteVector] =
|
implicit val byteArrayToVector: PureCodec[Array[Byte], ByteVector] =
|
||||||
liftB(ByteVector.apply, _.toArray)
|
liftB(ByteVector.apply, _.toArray)
|
||||||
|
|
||||||
// Notice the use of default Base64 alphabet
|
object Base64 {
|
||||||
implicit val base64ToVector: PureCodec[String, ByteVector] =
|
// Notice the use of default Base64 alphabet
|
||||||
base64AlphabetToVector(Bases.Alphabets.Base64)
|
implicit val base64ToVector: PureCodec[String, ByteVector] =
|
||||||
|
alphabetToVector(Bases.Alphabets.Base64)
|
||||||
|
|
||||||
def base64AlphabetToVector(alphabet: Bases.Base64Alphabet): PureCodec[String, ByteVector] =
|
def alphabetToVector(alphabet: Bases.Base64Alphabet): PureCodec[String, ByteVector] =
|
||||||
liftEitherB(
|
liftEitherB(
|
||||||
str ⇒
|
str ⇒
|
||||||
ByteVector
|
ByteVector
|
||||||
.fromBase64Descriptive(str, alphabet)
|
.fromBase64Descriptive(str, alphabet)
|
||||||
.left
|
.left
|
||||||
.map(CodecError(_)),
|
.map(CodecError(_)),
|
||||||
vec ⇒ Right(vec.toBase64(alphabet))
|
vec ⇒ Right(vec.toBase64(alphabet))
|
||||||
)
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
object Base58 {
|
||||||
|
// Notice the use of default Base64 alphabet
|
||||||
|
implicit val base58ToVector: PureCodec[String, ByteVector] =
|
||||||
|
alphabetToVector(Bases.Alphabets.Base58)
|
||||||
|
|
||||||
|
def alphabetToVector(alphabet: Bases.Alphabet): PureCodec[String, ByteVector] =
|
||||||
|
liftEitherB(
|
||||||
|
str ⇒
|
||||||
|
ByteVector
|
||||||
|
.fromBase58Descriptive(str, alphabet)
|
||||||
|
.left
|
||||||
|
.map(CodecError(_)),
|
||||||
|
vec ⇒ Right(vec.toBase58(alphabet))
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@ -22,6 +22,7 @@ import cats.syntax.compose._
|
|||||||
import org.scalatest.prop.Checkers
|
import org.scalatest.prop.Checkers
|
||||||
import org.scalatest.{Matchers, WordSpec}
|
import org.scalatest.{Matchers, WordSpec}
|
||||||
import scodec.bits.ByteVector
|
import scodec.bits.ByteVector
|
||||||
|
import BitsCodecs.Base64._
|
||||||
import BitsCodecs._
|
import BitsCodecs._
|
||||||
import fluence.codec.PureCodec
|
import fluence.codec.PureCodec
|
||||||
|
|
||||||
@ -32,7 +33,7 @@ class BitsCodecsSpec extends WordSpec with Matchers with Checkers {
|
|||||||
val arrCodec = implicitly[PureCodec[Array[Byte], ByteVector]]
|
val arrCodec = implicitly[PureCodec[Array[Byte], ByteVector]]
|
||||||
val b64Codec = implicitly[PureCodec[ByteVector, String]]
|
val b64Codec = implicitly[PureCodec[ByteVector, String]]
|
||||||
|
|
||||||
check { (bytes: List[Byte]) ⇒
|
check { bytes: List[Byte] ⇒
|
||||||
(arrCodec andThen arrCodec.swap).direct.apply[Id](bytes.toArray).value.map(_.toList).contains(bytes) &&
|
(arrCodec andThen arrCodec.swap).direct.apply[Id](bytes.toArray).value.map(_.toList).contains(bytes) &&
|
||||||
(arrCodec andThen b64Codec andThen b64Codec.swap andThen arrCodec.swap).direct
|
(arrCodec andThen b64Codec andThen b64Codec.swap andThen arrCodec.swap).direct
|
||||||
.apply[Id](bytes.toArray)
|
.apply[Id](bytes.toArray)
|
||||||
|
24
build.sbt
24
build.sbt
@ -1,6 +1,6 @@
|
|||||||
import de.heikoseeberger.sbtheader.License
|
import de.heikoseeberger.sbtheader.License
|
||||||
import org.scalajs.sbtplugin.ScalaJSPlugin.autoImport._
|
import org.scalajs.sbtplugin.ScalaJSPlugin.autoImport._
|
||||||
import sbtcrossproject.crossProject
|
import sbtcrossproject.CrossPlugin.autoImport.crossProject
|
||||||
|
|
||||||
name := "codec"
|
name := "codec"
|
||||||
|
|
||||||
@ -10,11 +10,12 @@ javaOptions in Test ++= Seq("-ea")
|
|||||||
|
|
||||||
skip in publish := true // Skip root project
|
skip in publish := true // Skip root project
|
||||||
|
|
||||||
val scalaV = scalaVersion := "2.12.5"
|
val scalaV = scalaVersion := "2.12.8"
|
||||||
|
|
||||||
val commons = Seq(
|
val commons = Seq(
|
||||||
scalaV,
|
scalaV,
|
||||||
version := "0.0.2",
|
//crossScalaVersions := Seq(scalaVersion.value, "2.13.0-RC1"),
|
||||||
|
version := "0.0.5",
|
||||||
fork in Test := true,
|
fork in Test := true,
|
||||||
parallelExecution in Test := false,
|
parallelExecution in Test := false,
|
||||||
organization := "one.fluence",
|
organization := "one.fluence",
|
||||||
@ -30,17 +31,19 @@ val commons = Seq(
|
|||||||
|
|
||||||
commons
|
commons
|
||||||
|
|
||||||
val kindProjector = addCompilerPlugin("org.spire-math" %% "kind-projector" % "0.9.6")
|
val kindProjector = addCompilerPlugin("org.typelevel" % "kind-projector" % "0.10.0" cross CrossVersion.binary)
|
||||||
|
|
||||||
val Cats1V = "1.1.0"
|
val Cats1V = "1.6.0"
|
||||||
val ScodecBitsV = "1.1.5"
|
val ScodecBitsV = "1.1.10"
|
||||||
val CirceV = "0.9.3"
|
val CirceV = "0.11.1"
|
||||||
val ShapelessV = "2.3.+"
|
val ShapelessV = "2.3.+"
|
||||||
|
|
||||||
val chill = "com.twitter" %% "chill" % "0.9.2"
|
val chill = "com.twitter" %% "chill" % "0.9.3"
|
||||||
|
|
||||||
val ScalatestV = "3.0.+"
|
val ScalatestV = "3.0.5"
|
||||||
val ScalacheckV = "1.13.4"
|
|
||||||
|
// Note that cats-laws 1.5 are compiled against scalacheck 1.13, and scalacheck-shapeless should also not introduce the upgrade
|
||||||
|
val ScalacheckV = "1.13.5"
|
||||||
|
|
||||||
val protobuf = Seq(
|
val protobuf = Seq(
|
||||||
PB.targets in Compile := Seq(
|
PB.targets in Compile := Seq(
|
||||||
@ -62,7 +65,6 @@ lazy val `codec-core` = crossProject(JVMPlatform, JSPlatform)
|
|||||||
kindProjector,
|
kindProjector,
|
||||||
libraryDependencies ++= Seq(
|
libraryDependencies ++= Seq(
|
||||||
"org.typelevel" %%% "cats-core" % Cats1V,
|
"org.typelevel" %%% "cats-core" % Cats1V,
|
||||||
"org.typelevel" %%% "cats-laws" % Cats1V % Test,
|
|
||||||
"org.typelevel" %%% "cats-testkit" % Cats1V % Test,
|
"org.typelevel" %%% "cats-testkit" % Cats1V % Test,
|
||||||
"com.github.alexarchambault" %%% "scalacheck-shapeless_1.13" % "1.1.8" % Test,
|
"com.github.alexarchambault" %%% "scalacheck-shapeless_1.13" % "1.1.8" % Test,
|
||||||
"org.scalacheck" %%% "scalacheck" % ScalacheckV % Test,
|
"org.scalacheck" %%% "scalacheck" % ScalacheckV % Test,
|
||||||
|
@ -1,97 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (C) 2017 Fluence Labs Limited
|
|
||||||
*
|
|
||||||
* This program is free software: you can redistribute it and/or modify
|
|
||||||
* it under the terms of the GNU Affero General Public License as
|
|
||||||
* published by the Free Software Foundation, either version 3 of the
|
|
||||||
* License, or (at your option) any later version.
|
|
||||||
*
|
|
||||||
* This program is distributed in the hope that it will be useful,
|
|
||||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
* GNU Affero General Public License for more details.
|
|
||||||
*
|
|
||||||
* You should have received a copy of the GNU Affero General Public License
|
|
||||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
*/
|
|
||||||
|
|
||||||
package fluence.codec
|
|
||||||
|
|
||||||
import cats.data.Kleisli
|
|
||||||
import cats.{Applicative, FlatMap, Traverse}
|
|
||||||
import cats.syntax.applicative._
|
|
||||||
|
|
||||||
import scala.language.{higherKinds, implicitConversions}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Base trait for serialize/deserialize objects.
|
|
||||||
*
|
|
||||||
* @tparam A The type of plain object representation
|
|
||||||
* @tparam B The type of binary representation
|
|
||||||
* @tparam F Encoding/decoding effect
|
|
||||||
*/
|
|
||||||
@deprecated(
|
|
||||||
"Codec is planned for removing soon, as it's impure and not properly tested. Use PureCodec instead.",
|
|
||||||
"6.4.2018"
|
|
||||||
)
|
|
||||||
final case class Codec[F[_], A, B](encode: A ⇒ F[B], decode: B ⇒ F[A]) {
|
|
||||||
self ⇒
|
|
||||||
|
|
||||||
implicit val direct: Kleisli[F, A, B] = Kleisli(encode)
|
|
||||||
|
|
||||||
implicit val inverse: Kleisli[F, B, A] = Kleisli(decode)
|
|
||||||
|
|
||||||
def andThen[C](other: Codec[F, B, C])(implicit F: FlatMap[F]): Codec[F, A, C] =
|
|
||||||
Codec((self.direct andThen other.direct).run, (other.inverse andThen self.inverse).run)
|
|
||||||
|
|
||||||
def compose[C](other: Codec[F, C, A])(implicit F: FlatMap[F]): Codec[F, C, B] =
|
|
||||||
Codec((other.direct andThen self.direct).run, (self.inverse andThen other.inverse).run)
|
|
||||||
|
|
||||||
def swap: Codec[F, B, A] = Codec(decode, encode)
|
|
||||||
}
|
|
||||||
|
|
||||||
@deprecated(
|
|
||||||
"Codec is planned for removing soon, as it's impure and not properly tested. Use PureCodec instead.",
|
|
||||||
"6.4.2018"
|
|
||||||
)
|
|
||||||
object Codec {
|
|
||||||
implicit def identityCodec[F[_]: Applicative, T]: Codec[F, T, T] =
|
|
||||||
Codec(_.pure[F], _.pure[F])
|
|
||||||
|
|
||||||
implicit def traverseCodec[F[_]: Applicative, G[_]: Traverse, O, B](
|
|
||||||
implicit codec: Codec[F, O, B]
|
|
||||||
): Codec[F, G[O], G[B]] =
|
|
||||||
Codec[F, G[O], G[B]](Traverse[G].traverse[F, O, B](_)(codec.encode), Traverse[G].traverse[F, B, O](_)(codec.decode))
|
|
||||||
|
|
||||||
implicit def toDirect[F[_], A, B](implicit cod: Codec[F, A, B]): Kleisli[F, A, B] =
|
|
||||||
cod.direct
|
|
||||||
|
|
||||||
implicit def toInverse[F[_], A, B](implicit cod: Codec[F, A, B]): Kleisli[F, B, A] =
|
|
||||||
cod.inverse
|
|
||||||
|
|
||||||
implicit def swap[F[_], A, B](implicit cod: Codec[F, A, B]): Codec[F, B, A] =
|
|
||||||
Codec[F, B, A](cod.decode, cod.encode)
|
|
||||||
|
|
||||||
@deprecated(
|
|
||||||
"Codec is planned for removing soon, as it's impure and not properly tested. Use PureCodec instead.",
|
|
||||||
"6.4.2018"
|
|
||||||
)
|
|
||||||
def codec[F[_], O, B](implicit codec: Codec[F, O, B]): Codec[F, O, B] = codec
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Constructs a Codec from pure encode/decode functions and an Applicative
|
|
||||||
*
|
|
||||||
* @param encodeFn Encode function that never fail
|
|
||||||
* @param decodeFn Decode function that never fail
|
|
||||||
* @tparam F Applicative effect
|
|
||||||
* @tparam O Raw type
|
|
||||||
* @tparam B Encoded type
|
|
||||||
* @return New codec for O and B
|
|
||||||
*/
|
|
||||||
@deprecated(
|
|
||||||
"Codec is planned for removing soon, as it's impure and not properly tested. Use PureCodec instead.",
|
|
||||||
"6.4.2018"
|
|
||||||
)
|
|
||||||
def pure[F[_]: Applicative, O, B](encodeFn: O ⇒ B, decodeFn: B ⇒ O): Codec[F, O, B] =
|
|
||||||
Codec(encodeFn(_).pure[F], decodeFn(_).pure[F])
|
|
||||||
}
|
|
@ -24,7 +24,7 @@ import cats.data.{EitherT, Kleisli}
|
|||||||
import cats.syntax.flatMap._
|
import cats.syntax.flatMap._
|
||||||
import cats.syntax.compose._
|
import cats.syntax.compose._
|
||||||
|
|
||||||
import scala.language.higherKinds
|
import scala.language.{existentials, higherKinds}
|
||||||
import scala.util.Try
|
import scala.util.Try
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -49,6 +49,7 @@ abstract class MonadicalEitherArrow[E <: Throwable] {
|
|||||||
* @tparam B Successful result type
|
* @tparam B Successful result type
|
||||||
*/
|
*/
|
||||||
abstract class Func[A, B] {
|
abstract class Func[A, B] {
|
||||||
|
f ⇒
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Run the func on input, using the given monad.
|
* Run the func on input, using the given monad.
|
||||||
@ -62,9 +63,10 @@ abstract class MonadicalEitherArrow[E <: Throwable] {
|
|||||||
* Run the func on input, lifting the error into MonadError effect.
|
* Run the func on input, lifting the error into MonadError effect.
|
||||||
*
|
*
|
||||||
* @param input Input
|
* @param input Input
|
||||||
* @param F All internal maps and composes, as well as errors, are to be executed with this Monad
|
* @param F All internal maps and composes, as well as errors, are to be executed with this MonadError.
|
||||||
|
* Error type should be a supertype for this arrow's error E.
|
||||||
*/
|
*/
|
||||||
def runF[F[_]](input: A)(implicit F: MonadError[F, Throwable]): F[B] =
|
def runF[F[_]](input: A)(implicit F: MonadError[F, EE] forSome { type EE >: E }): F[B] =
|
||||||
runEither(input).flatMap(F.fromEither)
|
runEither(input).flatMap(F.fromEither)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -75,12 +77,37 @@ abstract class MonadicalEitherArrow[E <: Throwable] {
|
|||||||
*/
|
*/
|
||||||
def apply[F[_]: Monad](input: A): EitherT[F, E, B]
|
def apply[F[_]: Monad](input: A): EitherT[F, E, B]
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Shortcut for function composition
|
||||||
|
*
|
||||||
|
* @param other Other function to run after
|
||||||
|
* @tparam C Resulting input type
|
||||||
|
* @return Composed function
|
||||||
|
*/
|
||||||
|
def on[C](other: Func[C, A]): Func[C, B] =
|
||||||
|
catsMonadicalEitherArrowChoice.compose(this, other)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Convert this Func into another one, lifting the error
|
||||||
|
*
|
||||||
|
* @param m Another instance of MonadicalEitherArrow
|
||||||
|
* @param convertE Convert error
|
||||||
|
* @tparam EE Error type
|
||||||
|
* @return Converted function
|
||||||
|
*/
|
||||||
|
def to[EE <: Throwable](m: MonadicalEitherArrow[EE])(implicit convertE: E ⇒ EE): m.Func[A, B] =
|
||||||
|
new m.Func[A, B] {
|
||||||
|
override def apply[F[_]: Monad](input: A): EitherT[F, EE, B] =
|
||||||
|
f[F](input).leftMap(convertE)
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Converts this Func to Kleisli, using MonadError to execute upon and to lift errors into.
|
* Converts this Func to Kleisli, using MonadError to execute upon and to lift errors into.
|
||||||
*
|
*
|
||||||
* @param F All internal maps and composes, as well as errors, are to be executed with this Monad
|
* @param F All internal maps and composes, as well as errors, are to be executed with this MonadError.
|
||||||
|
* Error type should be a supertype for this arrow's error E.
|
||||||
*/
|
*/
|
||||||
def toKleisli[F[_]](implicit F: MonadError[F, Throwable]): Kleisli[F, A, B] =
|
def toKleisli[F[_]](implicit F: MonadError[F, EE] forSome { type EE >: E }): Kleisli[F, A, B] =
|
||||||
Kleisli(input ⇒ runF[F](input))
|
Kleisli(input ⇒ runF[F](input))
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -93,6 +120,15 @@ abstract class MonadicalEitherArrow[E <: Throwable] {
|
|||||||
import cats.instances.try_._
|
import cats.instances.try_._
|
||||||
runF[Try](input).get
|
runF[Try](input).get
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Picks a point from the arrow, using the initial element (Unit) on the left.
|
||||||
|
*
|
||||||
|
* @param input Point to pick
|
||||||
|
* @return Picked point
|
||||||
|
*/
|
||||||
|
def pointAt(input: A): Point[B] =
|
||||||
|
catsMonadicalEitherArrowChoice.lmap(this)(_ ⇒ input)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -110,13 +146,6 @@ abstract class MonadicalEitherArrow[E <: Throwable] {
|
|||||||
*/
|
*/
|
||||||
lazy val swap: Bijection[B, A] = Bijection(inverse, direct)
|
lazy val swap: Bijection[B, A] = Bijection(inverse, direct)
|
||||||
|
|
||||||
@deprecated(
|
|
||||||
"You should keep codec Pure until running direct or inverse on it: there's no reason to bind effect into Codec",
|
|
||||||
"6.4.2018"
|
|
||||||
)
|
|
||||||
def toCodec[F[_]](implicit F: MonadError[F, Throwable]): Codec[F, A, B] =
|
|
||||||
Codec(direct.runF[F], inverse.runF[F])
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Splits the input and puts it to either bijection, then merges output.
|
* Splits the input and puts it to either bijection, then merges output.
|
||||||
* It could have been achieved with `Strong` typeclass in case it doesn't extend `Profunctor`; but it does.
|
* It could have been achieved with `Strong` typeclass in case it doesn't extend `Profunctor`; but it does.
|
||||||
@ -182,6 +211,26 @@ abstract class MonadicalEitherArrow[E <: Throwable] {
|
|||||||
EitherT.rightT[F, E](input).subflatMap(f)
|
EitherT.rightT[F, E](input).subflatMap(f)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check a condition, lifted with a Func.
|
||||||
|
*
|
||||||
|
* @param error Error to produce when condition is not met
|
||||||
|
* @return Func that takes boolean, checks it, and returns Unit or fails with given error
|
||||||
|
*/
|
||||||
|
def cond(error: ⇒ E): Func[Boolean, Unit] =
|
||||||
|
liftFuncEither(Either.cond(_, (), error))
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Lift a function which returns a Func arrow with Unit on the left side.
|
||||||
|
*
|
||||||
|
* @param f Function to lift
|
||||||
|
*/
|
||||||
|
def liftFuncPoint[A, B](f: A ⇒ Point[B]): Func[A, B] =
|
||||||
|
new Func[A, B] {
|
||||||
|
override def apply[F[_]: Monad](input: A): EitherT[F, E, B] =
|
||||||
|
f(input).apply[F](())
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Func that does nothing with input.
|
* Func that does nothing with input.
|
||||||
*/
|
*/
|
||||||
@ -215,6 +264,42 @@ abstract class MonadicalEitherArrow[E <: Throwable] {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Point type maps from Unit to a particular value of A, so it's just a lazy Func.
|
||||||
|
*
|
||||||
|
* @tparam A Output value type
|
||||||
|
*/
|
||||||
|
type Point[A] = Func[Unit, A]
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Point must obey MonadErrorLaws
|
||||||
|
*/
|
||||||
|
implicit object catsMonadicalEitherPointMonad extends MonadError[Point, E] {
|
||||||
|
override def flatMap[A, B](fa: Point[A])(f: A ⇒ Point[B]): Point[B] =
|
||||||
|
new Func[Unit, B] {
|
||||||
|
override def apply[F[_]: Monad](input: Unit): EitherT[F, E, B] =
|
||||||
|
fa[F](()).flatMap(f(_).apply[F](()))
|
||||||
|
}
|
||||||
|
|
||||||
|
override def tailRecM[A, B](a: A)(f: A ⇒ Point[Either[A, B]]): Point[B] =
|
||||||
|
new Func[Unit, B] {
|
||||||
|
override def apply[F[_]: Monad](input: Unit): EitherT[F, E, B] =
|
||||||
|
Monad[EitherT[F, E, ?]].tailRecM(a)(f(_).apply[F](()))
|
||||||
|
}
|
||||||
|
|
||||||
|
override def raiseError[A](e: E): Point[A] =
|
||||||
|
liftFuncEither(_ ⇒ Left(e))
|
||||||
|
|
||||||
|
override def handleErrorWith[A](fa: Point[A])(f: E ⇒ Point[A]): Point[A] =
|
||||||
|
new Func[Unit, A] {
|
||||||
|
override def apply[F[_]: Monad](input: Unit): EitherT[F, E, A] =
|
||||||
|
fa[F](()).leftFlatMap(e ⇒ f(e).apply[F](()))
|
||||||
|
}
|
||||||
|
|
||||||
|
override def pure[A](x: A): Point[A] =
|
||||||
|
liftFunc(_ ⇒ x)
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Lifts pure direct and inverse functions into Bijection.
|
* Lifts pure direct and inverse functions into Bijection.
|
||||||
*
|
*
|
||||||
@ -237,6 +322,12 @@ abstract class MonadicalEitherArrow[E <: Throwable] {
|
|||||||
def liftEitherB[A, B](direct: A ⇒ Either[E, B], inverse: B ⇒ Either[E, A]): Bijection[A, B] =
|
def liftEitherB[A, B](direct: A ⇒ Either[E, B], inverse: B ⇒ Either[E, A]): Bijection[A, B] =
|
||||||
Bijection(liftFuncEither(direct), liftFuncEither(inverse))
|
Bijection(liftFuncEither(direct), liftFuncEither(inverse))
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Lifts point functions into Bijection.
|
||||||
|
*/
|
||||||
|
def liftPointB[A, B](direct: A ⇒ Point[B], inverse: B ⇒ Point[A]): Bijection[A, B] =
|
||||||
|
Bijection(liftFuncPoint(direct), liftFuncPoint(inverse))
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Bijection that does no transformation.
|
* Bijection that does no transformation.
|
||||||
*/
|
*/
|
||||||
|
@ -23,6 +23,13 @@ import org.scalacheck.{Arbitrary, Cogen, Gen}
|
|||||||
import org.scalacheck.ScalacheckShapeless._
|
import org.scalacheck.ScalacheckShapeless._
|
||||||
|
|
||||||
object PureCodecFuncTestInstances {
|
object PureCodecFuncTestInstances {
|
||||||
|
implicit def arbCodecError: Arbitrary[CodecError] =
|
||||||
|
Arbitrary(Gen.alphaLowerStr.map(CodecError(_)))
|
||||||
|
|
||||||
|
implicit def eqCodecError: Eq[CodecError] = Eq.fromUniversalEquals
|
||||||
|
|
||||||
|
implicit def cogenE: Cogen[CodecError] = Cogen.cogenString.contramap[CodecError](_.message)
|
||||||
|
|
||||||
implicit def arbFunc[A: Arbitrary: Cogen, B: Arbitrary]: Arbitrary[PureCodec.Func[A, B]] =
|
implicit def arbFunc[A: Arbitrary: Cogen, B: Arbitrary]: Arbitrary[PureCodec.Func[A, B]] =
|
||||||
Arbitrary(
|
Arbitrary(
|
||||||
Gen
|
Gen
|
||||||
|
@ -0,0 +1,52 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (C) 2017 Fluence Labs Limited
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package fluence.codec
|
||||||
|
|
||||||
|
import cats.{Applicative, Eq, Invariant}
|
||||||
|
import cats.data.EitherT
|
||||||
|
import cats.syntax.functor._
|
||||||
|
import cats.laws.discipline.{MonadErrorTests, SemigroupalTests}
|
||||||
|
import cats.tests.CatsSuite
|
||||||
|
import fluence.codec
|
||||||
|
import org.scalacheck.Arbitrary
|
||||||
|
import org.scalacheck.Arbitrary._
|
||||||
|
import org.scalacheck.ScalacheckShapeless._
|
||||||
|
|
||||||
|
class PureCodecPointLawsSpec extends CatsSuite {
|
||||||
|
|
||||||
|
import PureCodecFuncTestInstances._
|
||||||
|
|
||||||
|
implicit def eqEitherTFEA: Eq[EitherT[PureCodec.Point, CodecError, Int]] =
|
||||||
|
Eq.instance{
|
||||||
|
case (aa,bb) ⇒
|
||||||
|
aa.value.unsafe(()) == bb.value.unsafe(())
|
||||||
|
}
|
||||||
|
|
||||||
|
implicit val iso = SemigroupalTests.Isomorphisms.invariant[PureCodec.Point](
|
||||||
|
new Invariant[PureCodec.Point]{
|
||||||
|
override def imap[A, B](fa: codec.PureCodec.Point[A])(f: A ⇒ B)(g: B ⇒ A): codec.PureCodec.Point[B] =
|
||||||
|
fa.map(f)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
checkAll(
|
||||||
|
"PureCodec.Point.MonadErrorLaws",
|
||||||
|
MonadErrorTests[PureCodec.Point, CodecError]
|
||||||
|
.monadError[Int, String, Double]
|
||||||
|
)
|
||||||
|
}
|
@ -17,36 +17,29 @@
|
|||||||
|
|
||||||
package fluence.codec.kryo
|
package fluence.codec.kryo
|
||||||
|
|
||||||
import cats.MonadError
|
|
||||||
import com.twitter.chill.KryoPool
|
import com.twitter.chill.KryoPool
|
||||||
import fluence.codec.{Codec, CodecError, PureCodec}
|
import fluence.codec.{CodecError, PureCodec}
|
||||||
import shapeless._
|
import shapeless._
|
||||||
|
|
||||||
import scala.language.higherKinds
|
import scala.language.higherKinds
|
||||||
import scala.reflect.ClassTag
|
import scala.reflect.ClassTag
|
||||||
import scala.util.Try
|
|
||||||
import scala.util.control.NonFatal
|
import scala.util.control.NonFatal
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Wrapper for a KryoPool with a list of registered classes
|
* Wrapper for a KryoPool with a list of registered classes
|
||||||
*
|
*
|
||||||
* @param pool Pre-configured KryoPool
|
* @param pool Pre-configured KryoPool
|
||||||
* @param F Applicative error
|
|
||||||
* @tparam L List of classes registered with kryo
|
* @tparam L List of classes registered with kryo
|
||||||
* @tparam F Effect
|
|
||||||
*/
|
*/
|
||||||
class KryoCodecs[F[_], L <: HList] private (pool: KryoPool)(implicit F: MonadError[F, Throwable]) {
|
class KryoCodecs[L <: HList] private (pool: KryoPool) {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns a codec for any registered type
|
* Returns a codec for any registered type
|
||||||
*
|
*
|
||||||
* @param sel Shows the presence of type T within list L
|
* @param sel Shows the presence of type T within list L
|
||||||
* @tparam T Object type
|
* @tparam T Object type
|
||||||
* @return Freshly created Codec with Kryo inside
|
* @return Freshly created PureCodec with Kryo inside
|
||||||
*/
|
*/
|
||||||
implicit def codec[T](implicit sel: ops.hlist.Selector[L, T]): Codec[F, T, Array[Byte]] =
|
|
||||||
pureCodec[T].toCodec[F]
|
|
||||||
|
|
||||||
implicit def pureCodec[T](implicit sel: ops.hlist.Selector[L, T]): PureCodec[T, Array[Byte]] =
|
implicit def pureCodec[T](implicit sel: ops.hlist.Selector[L, T]): PureCodec[T, Array[Byte]] =
|
||||||
PureCodec.Bijection(
|
PureCodec.Bijection(
|
||||||
PureCodec.liftFuncEither { input ⇒
|
PureCodec.liftFuncEither { input ⇒
|
||||||
@ -112,10 +105,10 @@ object KryoCodecs {
|
|||||||
* @tparam F Effect type
|
* @tparam F Effect type
|
||||||
* @return Configured instance of KryoCodecs
|
* @return Configured instance of KryoCodecs
|
||||||
*/
|
*/
|
||||||
def build[F[_]](
|
def build(
|
||||||
poolSize: Int = Runtime.getRuntime.availableProcessors
|
poolSize: Int = Runtime.getRuntime.availableProcessors
|
||||||
)(implicit F: MonadError[F, Throwable]): KryoCodecs[F, L] =
|
): KryoCodecs[L] =
|
||||||
new KryoCodecs[F, L](
|
new KryoCodecs[L](
|
||||||
KryoPool.withByteArrayOutputStream(
|
KryoPool.withByteArrayOutputStream(
|
||||||
poolSize,
|
poolSize,
|
||||||
KryoFactory(klasses, registrationRequired = true) // registrationRequired should never be needed, as codec derivation is typesafe
|
KryoFactory(klasses, registrationRequired = true) // registrationRequired should never be needed, as codec derivation is typesafe
|
||||||
|
@ -18,6 +18,7 @@
|
|||||||
package fluence.codec.kryo
|
package fluence.codec.kryo
|
||||||
|
|
||||||
import cats.instances.try_._
|
import cats.instances.try_._
|
||||||
|
import cats.syntax.profunctor._
|
||||||
import org.scalatest.{Matchers, WordSpec}
|
import org.scalatest.{Matchers, WordSpec}
|
||||||
|
|
||||||
import scala.util.Try
|
import scala.util.Try
|
||||||
@ -31,15 +32,15 @@ class KryoCodecsSpec extends WordSpec with Matchers {
|
|||||||
KryoCodecs()
|
KryoCodecs()
|
||||||
.add[Array[Array[Byte]]]
|
.add[Array[Array[Byte]]]
|
||||||
.addCase(classOf[TestClass])
|
.addCase(classOf[TestClass])
|
||||||
.build[Try]()
|
.build()
|
||||||
|
|
||||||
"encode and decode" should {
|
"encode and decode" should {
|
||||||
"be inverse functions" when {
|
"be inverse functions" when {
|
||||||
"object defined" in {
|
"object defined" in {
|
||||||
|
|
||||||
val codec = testCodecs.codec[TestClass]
|
val codec = testCodecs.pureCodec[TestClass]
|
||||||
|
|
||||||
val result = codec.encode(testClass).flatMap(codec.decode).get
|
val result = codec.inverse.unsafe(codec.direct.unsafe(testClass))
|
||||||
|
|
||||||
result.str shouldBe "one"
|
result.str shouldBe "one"
|
||||||
result.num shouldBe 2
|
result.num shouldBe 2
|
||||||
@ -47,8 +48,8 @@ class KryoCodecsSpec extends WordSpec with Matchers {
|
|||||||
}
|
}
|
||||||
|
|
||||||
"object is null" in {
|
"object is null" in {
|
||||||
val codec = testCodecs.codec[TestClass]
|
val codec = testCodecs.pureCodec[TestClass]
|
||||||
val result = codec.encode(null).flatMap(codec.decode)
|
val result = codec.direct.runF[Try](null).flatMap(codec.inverse.runF[Try])
|
||||||
result.isFailure shouldBe true
|
result.isFailure shouldBe true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -57,9 +58,8 @@ class KryoCodecsSpec extends WordSpec with Matchers {
|
|||||||
"encode" should {
|
"encode" should {
|
||||||
"not write full class name to binary representation" when {
|
"not write full class name to binary representation" when {
|
||||||
"class registered" in {
|
"class registered" in {
|
||||||
//val codec = KryoCodec[TestClass](Seq(classOf[TestClass], classOf[Array[Byte]], classOf[Array[Array[Byte]]]), registerRequired = true)
|
val codec = testCodecs.pureCodec[TestClass]
|
||||||
val codec = testCodecs.codec[TestClass]
|
val encoded = codec.direct.rmap(new String(_)).unsafe(testClass)
|
||||||
val encoded = codec.encode(testClass).map(new String(_)).get
|
|
||||||
val reasonableMaxSize = 20 // bytes
|
val reasonableMaxSize = 20 // bytes
|
||||||
encoded should not contain "TestClass"
|
encoded should not contain "TestClass"
|
||||||
encoded.length should be < reasonableMaxSize
|
encoded.length should be < reasonableMaxSize
|
||||||
|
@ -1 +1 @@
|
|||||||
sbt.version = 1.1.4
|
sbt.version = 1.2.8
|
||||||
|
@ -1,21 +1,21 @@
|
|||||||
addSbtPlugin("com.geirsson" % "sbt-scalafmt" % "1.4.0")
|
addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.0.0")
|
||||||
|
|
||||||
addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.3.2")
|
addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.3.20")
|
||||||
|
|
||||||
addSbtPlugin("de.heikoseeberger" % "sbt-header" % "4.1.0")
|
addSbtPlugin("de.heikoseeberger" % "sbt-header" % "5.2.0")
|
||||||
|
|
||||||
addSbtPlugin("com.thesamet" % "sbt-protoc" % "0.99.18")
|
addSbtPlugin("com.thesamet" % "sbt-protoc" % "0.99.20")
|
||||||
|
|
||||||
addSbtPlugin("org.scala-js" % "sbt-scalajs" % "0.6.22")
|
addSbtPlugin("org.scala-js" % "sbt-scalajs" % "0.6.27")
|
||||||
addSbtPlugin("org.portable-scala" % "sbt-crossproject" % "0.3.1")
|
addSbtPlugin("org.portable-scala" % "sbt-crossproject" % "0.6.0")
|
||||||
addSbtPlugin("org.portable-scala" % "sbt-scalajs-crossproject" % "0.3.1")
|
addSbtPlugin("org.portable-scala" % "sbt-scalajs-crossproject" % "0.6.0")
|
||||||
|
|
||||||
addSbtPlugin("ch.epfl.scala" % "sbt-scalajs-bundler" % "0.10.0")
|
addSbtPlugin("ch.epfl.scala" % "sbt-scalajs-bundler" % "0.14.0")
|
||||||
|
|
||||||
addSbtPlugin("net.virtual-void" % "sbt-dependency-graph" % "0.9.0")
|
addSbtPlugin("net.virtual-void" % "sbt-dependency-graph" % "0.9.2")
|
||||||
|
|
||||||
addSbtPlugin("com.lihaoyi" % "workbench" % "0.4.0")
|
addSbtPlugin("com.lihaoyi" % "workbench" % "0.4.1")
|
||||||
|
|
||||||
libraryDependencies += "com.thesamet.scalapb" %% "compilerplugin" % "0.7.1"
|
libraryDependencies += "com.thesamet.scalapb" %% "compilerplugin" % "0.8.4"
|
||||||
|
|
||||||
addSbtPlugin("org.foundweekends" % "sbt-bintray" % "0.5.4")
|
addSbtPlugin("org.foundweekends" % "sbt-bintray" % "0.5.4")
|
||||||
|
Loading…
x
Reference in New Issue
Block a user