chore: renaming of evaluation components (#1064)

This PR improves the naming of the evaluation components. Changes made: - Renamed `eval` package to `evaluator` - Removed the `Evaluation`/`Evaluator` suffixes of structs within the `evaluator ` package Signed-off-by: Florian Bacher <[email protected]>
open-feature · Dec 14, 2023 · d39f31d · d39f31d
1 parent c86dff0
commit d39f31d
Show file tree

Hide file tree

Showing 20 changed files with 117 additions and 117 deletions.
diff --git a/core/pkg/eval/fractional_evaluation.go → core/pkg/evaluator/fractional.go b/core/pkg/eval/fractional_evaluation.go → core/pkg/evaluator/fractional.go
@@ -1,4 +1,4 @@
-package eval
+package evaluator
 
 import (
 	"errors"
@@ -11,7 +11,7 @@ import (
 
 const FractionEvaluationName = "fractional"
 
-type FractionalEvaluator struct {
+type Fractional struct {
 	Logger *logger.Logger
 }
 
@@ -20,11 +20,11 @@ type fractionalEvaluationDistribution struct {
 	percentage int
 }
 
-func NewFractionalEvaluator(logger *logger.Logger) *FractionalEvaluator {
-	return &FractionalEvaluator{Logger: logger}
+func NewFractional(logger *logger.Logger) *Fractional {
+	return &Fractional{Logger: logger}
 }
 
-func (fe *FractionalEvaluator) FractionalEvaluation(values, data any) any {
+func (fe *Fractional) Evaluate(values, data any) any {
 	valueToDistribute, feDistributions, err := parseFractionalEvaluationData(values, data)
 	if err != nil {
 		fe.Logger.Error(fmt.Sprintf("parse fractional evaluation data: %v", err))

diff --git a/core/pkg/eval/fractional_evaluation_test.go → core/pkg/evaluator/fractional_test.go b/core/pkg/eval/fractional_evaluation_test.go → core/pkg/evaluator/fractional_test.go
@@ -1,4 +1,4 @@
-package eval
+package evaluator
 
 import (
 	"testing"
@@ -323,12 +323,12 @@ func TestFractionalEvaluation(t *testing.T) {
 	for name, tt := range tests {
 		t.Run(name, func(t *testing.T) {
 			log := logger.NewLogger(nil, false)
-			je := NewJSONEvaluator(
+			je := NewJSON(
 				log,
 				store.NewFlags(),
 				WithEvaluator(
 					FractionEvaluationName,
-					NewFractionalEvaluator(log).FractionalEvaluation,
+					NewFractional(log).Evaluate,
 				),
 			)
 			je.store.Flags = tt.flags.Flags
@@ -457,12 +457,12 @@ func BenchmarkFractionalEvaluation(b *testing.B) {
 	for name, tt := range tests {
 		b.Run(name, func(b *testing.B) {
 			log := logger.NewLogger(nil, false)
-			je := NewJSONEvaluator(
+			je := NewJSON(
 				log,
 				&store.Flags{Flags: tt.flags.Flags},
 				WithEvaluator(
 					FractionEvaluationName,
-					NewFractionalEvaluator(log).FractionalEvaluation,
+					NewFractional(log).Evaluate,
 				),
 			)
 			for i := 0; i < b.N; i++ {

diff --git a/core/pkg/eval/ievaluator.go → core/pkg/evaluator/ievaluator.go b/core/pkg/eval/ievaluator.go → core/pkg/evaluator/ievaluator.go
@@ -1,4 +1,4 @@
-package eval
+package evaluator
 
 import (
 	"context"

diff --git a/core/pkg/eval/ievaluator_test.go → core/pkg/evaluator/ievaluator_test.go b/core/pkg/eval/ievaluator_test.go → core/pkg/evaluator/ievaluator_test.go
@@ -1,4 +1,4 @@
-package eval
+package evaluator
 
 import (
 	"fmt"

diff --git a/core/pkg/eval/json_evaluator.go → core/pkg/evaluator/json.go b/core/pkg/eval/json_evaluator.go → core/pkg/evaluator/json.go
@@ -1,4 +1,4 @@
-package eval
+package evaluator
 
 import (
 	"bytes"
@@ -50,7 +50,7 @@ func init() {
 type variantEvaluator func(string, string, map[string]any) (
 	variant string, variants map[string]interface{}, reason string, metadata map[string]interface{}, error error)
 
-type JSONEvaluator struct {
+type JSON struct {
 	store          *store.Flags
 	Logger         *logger.Logger
 	jsonEvalTracer trace.Tracer
@@ -64,16 +64,16 @@ const (
 	Disabled = "DISABLED"
 )
 
-type JSONEvaluatorOption func(je *JSONEvaluator)
+type JSONEvaluatorOption func(je *JSON)
 
 func WithEvaluator(name string, evalFunc func(interface{}, interface{}) interface{}) JSONEvaluatorOption {
-	return func(_ *JSONEvaluator) {
+	return func(_ *JSON) {
 		jsonlogic.AddOperator(name, evalFunc)
 	}
 }
 
-func NewJSONEvaluator(logger *logger.Logger, s *store.Flags, opts ...JSONEvaluatorOption) *JSONEvaluator {
-	ev := JSONEvaluator{
+func NewJSON(logger *logger.Logger, s *store.Flags, opts ...JSONEvaluatorOption) *JSON {
+	ev := JSON{
 		Logger: logger.WithFields(
 			zap.String("component", "evaluator"),
 			zap.String("evaluator", "json"),
@@ -89,15 +89,15 @@ func NewJSONEvaluator(logger *logger.Logger, s *store.Flags, opts ...JSONEvaluat
 	return &ev
 }
 
-func (je *JSONEvaluator) GetState() (string, error) {
+func (je *JSON) GetState() (string, error) {
 	s, err := je.store.String()
 	if err != nil {
 		return "", fmt.Errorf("unable to fetch evaluator state: %w", err)
 	}
 	return s, nil
 }
 
-func (je *JSONEvaluator) SetState(payload sync.DataSync) (map[string]interface{}, bool, error) {
+func (je *JSON) SetState(payload sync.DataSync) (map[string]interface{}, bool, error) {
 	_, span := je.jsonEvalTracer.Start(
 		context.Background(),
 		"flagSync",
@@ -136,7 +136,7 @@ func (je *JSONEvaluator) SetState(payload sync.DataSync) (map[string]interface{}
 	return events, reSync, nil
 }
 
-func (je *JSONEvaluator) ResolveAllValues(ctx context.Context, reqID string, context map[string]any) []AnyValue {
+func (je *JSON) ResolveAllValues(ctx context.Context, reqID string, context map[string]any) []AnyValue {
 	_, span := je.jsonEvalTracer.Start(ctx, "resolveAll")
 	defer span.End()
 
@@ -192,7 +192,7 @@ func (je *JSONEvaluator) ResolveAllValues(ctx context.Context, reqID string, con
 	return values
 }
 
-func (je *JSONEvaluator) ResolveBooleanValue(
+func (je *JSON) ResolveBooleanValue(
 	ctx context.Context, reqID string, flagKey string, context map[string]any) (
 	value bool,
 	variant string,
@@ -207,7 +207,7 @@ func (je *JSONEvaluator) ResolveBooleanValue(
 	return resolve[bool](reqID, flagKey, context, je.evaluateVariant)
 }
 
-func (je *JSONEvaluator) ResolveStringValue(
+func (je *JSON) ResolveStringValue(
 	ctx context.Context, reqID string, flagKey string, context map[string]any) (
 	value string,
 	variant string,
@@ -222,7 +222,7 @@ func (je *JSONEvaluator) ResolveStringValue(
 	return resolve[string](reqID, flagKey, context, je.evaluateVariant)
 }
 
-func (je *JSONEvaluator) ResolveFloatValue(
+func (je *JSON) ResolveFloatValue(
 	ctx context.Context, reqID string, flagKey string, context map[string]any) (
 	value float64,
 	variant string,
@@ -238,7 +238,7 @@ func (je *JSONEvaluator) ResolveFloatValue(
 	return
 }
 
-func (je *JSONEvaluator) ResolveIntValue(ctx context.Context, reqID string, flagKey string, context map[string]any) (
+func (je *JSON) ResolveIntValue(ctx context.Context, reqID string, flagKey string, context map[string]any) (
 	value int64,
 	variant string,
 	reason string,
@@ -255,7 +255,7 @@ func (je *JSONEvaluator) ResolveIntValue(ctx context.Context, reqID string, flag
 	return
 }
 
-func (je *JSONEvaluator) ResolveObjectValue(
+func (je *JSON) ResolveObjectValue(
 	ctx context.Context, reqID string, flagKey string, context map[string]any) (
 	value map[string]any,
 	variant string,
@@ -289,7 +289,7 @@ func resolve[T constraints](reqID string, key string, context map[string]any, va
 
 // runs the rules (if defined) to determine the variant, otherwise falling through to the default
 // nolint: funlen
-func (je *JSONEvaluator) evaluateVariant(reqID string, flagKey string, context map[string]any) (
+func (je *JSON) evaluateVariant(reqID string, flagKey string, context map[string]any) (
 	variant string, variants map[string]interface{}, reason string, metadata map[string]interface{}, err error,
 ) {
 	metadata = map[string]interface{}{}
@@ -362,7 +362,7 @@ func (je *JSONEvaluator) evaluateVariant(reqID string, flagKey string, context m
 	return flag.DefaultVariant, flag.Variants, model.StaticReason, metadata, nil
 }
 
-func (je *JSONEvaluator) setFlagdProperties(
+func (je *JSON) setFlagdProperties(
 	context map[string]any,
 	properties flagdProperties,
 ) map[string]any {
@@ -401,7 +401,7 @@ func getFlagdProperties(context map[string]any) (flagdProperties, bool) {
 }
 
 // configToFlags convert string configurations to flags and store them to pointer newFlags
-func (je *JSONEvaluator) configToFlags(config string, newFlags *Flags) error {
+func (je *JSON) configToFlags(config string, newFlags *Flags) error {
 	schemaLoader := gojsonschema.NewStringLoader(schema.FlagdDefinitions)
 	flagStringLoader := gojsonschema.NewStringLoader(config)
 
@@ -438,7 +438,7 @@ func validateDefaultVariants(flags *Flags) error {
 	return nil
 }
 
-func (je *JSONEvaluator) transposeEvaluators(state string) (string, error) {
+func (je *JSON) transposeEvaluators(state string) (string, error) {
 	var evaluators Evaluators
 	if err := json.Unmarshal([]byte(state), &evaluators); err != nil {
 		return "", fmt.Errorf("unmarshal: %w", err)

diff --git a/core/pkg/eval/json_evaluator_model.go → core/pkg/evaluator/json_model.go b/core/pkg/eval/json_evaluator_model.go → core/pkg/evaluator/json_model.go
@@ -1,4 +1,4 @@
-package eval
+package evaluator
 
 import (
 	"encoding/json"