ref(measure): make measure pkg internal (#138)

builders.go

@@ -4,10 +4,10 @@ import (
 	"github.com/snivilised/traverse/core"
 	"github.com/snivilised/traverse/enums"
 	"github.com/snivilised/traverse/internal/kernel"
+	"github.com/snivilised/traverse/internal/measure"
 	"github.com/snivilised/traverse/internal/override"
 	"github.com/snivilised/traverse/internal/third/lo"
 	"github.com/snivilised/traverse/internal/types"
-	"github.com/snivilised/traverse/measure"
 	"github.com/snivilised/traverse/pref"
 )
 

core/core-defs.go

@@ -2,8 +2,6 @@ package core
 
 import (
 	"time"
-
-	"github.com/snivilised/traverse/measure"
 )
 
 // 📦 pkg: core - contains universal definitions and handles user facing cross
@@ -28,7 +26,7 @@ type (
 
 	// TraverseResult
 	TraverseResult interface {
-		Metrics() measure.Reporter
+		Metrics() Reporter
 		Session() Session
 		Error() error
 	}

core/measure.go

@@ -0,0 +1,22 @@
+package core
+
+import (
+	"github.com/snivilised/traverse/enums"
+)
+
+type (
+	MetricValue = uint
+
+	// Metric represents query access to the metric. The client
+	// registering the metric should maintain it's mutate access
+	// to the metric so they can update it.
+	Metric interface {
+		Type() enums.Metric
+		Value() MetricValue
+	}
+
+	// Reporter represents query access to the metrics Supervisor
+	Reporter interface {
+		Count(enums.Metric) MetricValue
+	}
+)

internal/feat/refine/filter-plugin.go

@@ -6,8 +6,8 @@ import (
 	"github.com/snivilised/traverse/core"
 	"github.com/snivilised/traverse/enums"
 	"github.com/snivilised/traverse/internal/kernel"
+	"github.com/snivilised/traverse/internal/measure"
 	"github.com/snivilised/traverse/internal/types"
-	"github.com/snivilised/traverse/measure"
 	"github.com/snivilised/traverse/pref"
 )
 

internal/feat/refine/sampler-scheme.go

@@ -5,9 +5,9 @@ import (
 
 	"github.com/snivilised/traverse/core"
 	"github.com/snivilised/traverse/enums"
+	"github.com/snivilised/traverse/internal/measure"
 	"github.com/snivilised/traverse/internal/third/lo"
 	"github.com/snivilised/traverse/internal/types"
-	"github.com/snivilised/traverse/measure"
 	"github.com/snivilised/traverse/nfs"
 	"github.com/snivilised/traverse/pref"
 )

internal/kernel/guardian.go

@@ -4,9 +4,9 @@ import (
 	"github.com/snivilised/traverse/collections"
 	"github.com/snivilised/traverse/core"
 	"github.com/snivilised/traverse/enums"
+	"github.com/snivilised/traverse/internal/measure"
 	"github.com/snivilised/traverse/internal/third/lo"
 	"github.com/snivilised/traverse/internal/types"
-	"github.com/snivilised/traverse/measure"
 )
 
 type (

internal/kernel/mediator.go

@@ -7,8 +7,8 @@ import (
 	"github.com/snivilised/traverse/cycle"
 	"github.com/snivilised/traverse/enums"
 	"github.com/snivilised/traverse/internal/level"
+	"github.com/snivilised/traverse/internal/measure"
 	"github.com/snivilised/traverse/internal/types"
-	"github.com/snivilised/traverse/measure"
 	"github.com/snivilised/traverse/pref"
 )
 

internal/measure/measure-defs.go

@@ -0,0 +1,43 @@
+package measure
+
+import (
+	"github.com/snivilised/traverse/core"
+	"github.com/snivilised/traverse/enums"
+)
+
+// 📦 pkg: measure - defines facilities for counting things
+// represented by metrics.
+
+type (
+	// MutableMetric represents write access to the metric
+	MutableMetric interface {
+		core.Metric
+		Tick() core.MetricValue
+		Times(increment uint) core.MetricValue
+	}
+
+	BaseMetric struct {
+		t       enums.Metric
+		counter core.MetricValue
+	}
+)
+
+func (m *BaseMetric) Type() enums.Metric {
+	return m.t
+}
+
+func (m *BaseMetric) Value() core.MetricValue {
+	return m.counter
+}
+
+func (m *BaseMetric) Tick() core.MetricValue {
+	m.counter++
+
+	return m.counter
+}
+
+func (m *BaseMetric) Times(increment uint) core.MetricValue {
+	m.counter += increment
+
+	return m.counter
+}

measure/supervisor.go → internal/measure/supervisor.go

@@ -1,11 +1,12 @@
 package measure
 
 import (
+	"github.com/snivilised/traverse/core"
 	"github.com/snivilised/traverse/enums"
 )
 
 type (
-	Metrics        map[enums.Metric]Metric
+	Metrics        map[enums.Metric]core.Metric
 	MutableMetrics map[enums.Metric]MutableMetric
 
 	Supervisor struct {
@@ -46,7 +47,7 @@ func (s *Supervisor) Many(metrics ...enums.Metric) MutableMetrics {
 	return result
 }
 
-func (s *Supervisor) Count(mt enums.Metric) MetricValue {
+func (s *Supervisor) Count(mt enums.Metric) core.MetricValue {
 	if metric, exists := s.metrics[mt]; exists {
 		return metric.Value()
 	}

internal/override/actions.go

@@ -2,7 +2,7 @@ package override
 
 import (
 	"github.com/snivilised/traverse/core"
-	"github.com/snivilised/traverse/measure"
+	"github.com/snivilised/traverse/internal/measure"
 	"github.com/snivilised/traverse/tapable"
 )
 

internal/types/definitions.go

@@ -6,8 +6,8 @@ import (
 
 	"github.com/snivilised/traverse/core"
 	"github.com/snivilised/traverse/enums"
+	"github.com/snivilised/traverse/internal/measure"
 	"github.com/snivilised/traverse/internal/override"
-	"github.com/snivilised/traverse/measure"
 	"github.com/snivilised/traverse/nfs"
 	"github.com/snivilised/traverse/pref"
 )
@@ -108,7 +108,7 @@ type (
 // KernelResult is the internal representation of core.TraverseResult
 type KernelResult struct {
 	session  core.Session
-	reporter measure.Reporter
+	reporter core.Reporter
 	complete bool
 	err      error
 }
@@ -140,7 +140,7 @@ func (r *KernelResult) Session() core.Session {
 	return r.session
 }
 
-func (r *KernelResult) Metrics() measure.Reporter {
+func (r *KernelResult) Metrics() core.Reporter {
 	return r.reporter
 }