metrics.Proportion.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jjm-core_2.13 Show documentation

jjm-core

The newest version!

package jjm.metrics

import cats.Monoid
import cats.implicits._
import io.circe.generic.JsonCodec

// Uses included/excluded to avoid duplicating the included ones.
// not 100% sure if this was the best move.
@JsonCodec case class Proportion[A](
  included: Vector[A] = Vector(),
  excluded: Vector[A] = Vector()) {
  def stats = Proportion.Stats(included.size, excluded.size)
}
object Proportion {
  def included[A](as: A*) = Proportion(included = as.toVector)
  def excluded[A](as: A*) = Proportion(excluded = as.toVector)

  // TODO: change this to use total instead of excluded. doesn't really make sense
  // to use excluded in the stats class.
  @JsonCodec case class Stats(
    included: Int = 0,
    excluded: Int = 0
  ) {
    def total = included + excluded
    def proportion = included.toDouble / total

    def getTree: MapTree[String, Metric] = MapTree.fromPairs(
      "total" -> Metric.int(total),
      "included" -> Metric.int(included),
      "proportion" -> Metric.double(proportion)
    )
  }
  object Stats {
    implicit val proportionStatsMonoid: Monoid[Proportion.Stats] = {
      import cats.derived.auto.monoid._
      cats.derived.semiauto.monoid
    }
    implicit val proportionStatsHasMetrics = new HasMetrics[Proportion.Stats] {
      def getMetrics(acc: Proportion.Stats) = acc.getTree
    }
  }
  implicit def proportionMonoid[A]: Monoid[Proportion[A]] = {
    import cats.derived.auto.monoid._
    cats.derived.semiauto.monoid
  }
  implicit def proportionHasMetrics[A] = new HasMetrics[Proportion[A]] {
    def getMetrics(acc: Proportion[A]) = acc.stats.getTree
  }
}