Skip to content

Commit

Permalink
#261 Change CreateSzXxx to CreateXxx (#262)
Browse files Browse the repository at this point in the history
* Change CreateSz to Create

* #261 Prepare for versioned release
  • Loading branch information
docktermj authored Dec 10, 2024
1 parent 46f843a commit dcc0ffd
Show file tree
Hide file tree
Showing 7 changed files with 66 additions and 60 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ and this project adheres to [Semantic Versioning].

-

## [0.8.6] - 2024-12-10

### Changed in 0.8.6

- Update dependencies

## [0.8.5] - 2024-11-07

### Changed in 0.8.5
Expand Down
14 changes: 7 additions & 7 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,20 @@ require (
github.com/senzing-garage/go-logging v1.5.1
github.com/senzing-garage/go-messaging v1.5.2
github.com/senzing-garage/go-observing v0.3.3
github.com/senzing-garage/sz-sdk-go v0.14.3
github.com/senzing-garage/sz-sdk-go v0.14.4
github.com/stretchr/testify v1.10.0
)

require (
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
github.com/kr/text v0.2.0 // indirect
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
golang.org/x/exp v0.0.0-20241108190413-2d47ceb2692f // indirect
golang.org/x/net v0.31.0 // indirect
golang.org/x/sys v0.27.0 // indirect
golang.org/x/text v0.20.0 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20241118233622-e639e219e697 // indirect
google.golang.org/grpc v1.68.0 // indirect
golang.org/x/exp v0.0.0-20241210194714-1829a127f884 // indirect
golang.org/x/net v0.32.0 // indirect
golang.org/x/sys v0.28.0 // indirect
golang.org/x/text v0.21.0 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20241209162323-e6fa225c2576 // indirect
google.golang.org/grpc v1.68.1 // indirect
google.golang.org/protobuf v1.35.2 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)
28 changes: 14 additions & 14 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -23,22 +23,22 @@ github.com/senzing-garage/go-messaging v1.5.2 h1:lU9W2HV3zKQsDU9Vs7lwe/C/LbHVCMn
github.com/senzing-garage/go-messaging v1.5.2/go.mod h1:iEWGVuDGWjolIkwLqnn9oJS7ifF3aoZjTtI44tf1gWQ=
github.com/senzing-garage/go-observing v0.3.3 h1:AhQYgOG012sDZtWXYcXVAaS5qEoDjlWmPYJDVCUZ/g0=
github.com/senzing-garage/go-observing v0.3.3/go.mod h1:qFUi5Dwb6vmd7izTZGjGbWKUGRHzWzsgbsX3oNSD198=
github.com/senzing-garage/sz-sdk-go v0.14.3 h1:vcTJDn84bTGuFt2kWw8jDf4FfgUSePB+UJg3C2cPIBk=
github.com/senzing-garage/sz-sdk-go v0.14.3/go.mod h1:rj9HH6qo+kW5PsFSRnEIUQqDZBE34gZjQGsDvAxw6dI=
github.com/senzing-garage/sz-sdk-go v0.14.4 h1:sw4GokZhuIvkoBf/QYyjolD/Uz5IxCQ+Pu2KVUlTSsc=
github.com/senzing-garage/sz-sdk-go v0.14.4/go.mod h1:4VXZYdA6Fg4GkTFsd2HsPxxd3dMRadLD4An4BbhcvWk=
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
golang.org/x/exp v0.0.0-20241108190413-2d47ceb2692f h1:XdNn9LlyWAhLVp6P/i8QYBW+hlyhrhei9uErw2B5GJo=
golang.org/x/exp v0.0.0-20241108190413-2d47ceb2692f/go.mod h1:D5SMRVC3C2/4+F/DB1wZsLRnSNimn2Sp/NPsCrsv8ak=
golang.org/x/net v0.31.0 h1:68CPQngjLL0r2AlUKiSxtQFKvzRVbnzLwMUn5SzcLHo=
golang.org/x/net v0.31.0/go.mod h1:P4fl1q7dY2hnZFxEk4pPSkDHF+QqjitcnDjUQyMM+pM=
golang.org/x/sys v0.27.0 h1:wBqf8DvsY9Y/2P8gAfPDEYNuS30J4lPHJxXSb/nJZ+s=
golang.org/x/sys v0.27.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/text v0.20.0 h1:gK/Kv2otX8gz+wn7Rmb3vT96ZwuoxnQlY+HlJVj7Qug=
golang.org/x/text v0.20.0/go.mod h1:D4IsuqiFMhST5bX19pQ9ikHC2GsaKyk/oF+pn3ducp4=
google.golang.org/genproto/googleapis/rpc v0.0.0-20241118233622-e639e219e697 h1:LWZqQOEjDyONlF1H6afSWpAL/znlREo2tHfLoe+8LMA=
google.golang.org/genproto/googleapis/rpc v0.0.0-20241118233622-e639e219e697/go.mod h1:5uTbfoYQed2U9p3KIj2/Zzm02PYhndfdmML0qC3q3FU=
google.golang.org/grpc v1.68.0 h1:aHQeeJbo8zAkAa3pRzrVjZlbz6uSfeOXlJNQM0RAbz0=
google.golang.org/grpc v1.68.0/go.mod h1:fmSPC5AsjSBCK54MyHRx48kpOti1/jRfOlwEWywNjWA=
golang.org/x/exp v0.0.0-20241210194714-1829a127f884 h1:Y/Mj/94zIQQGHVSv1tTtQBDaQaJe62U9bkDZKKyhPCU=
golang.org/x/exp v0.0.0-20241210194714-1829a127f884/go.mod h1:qj5a5QZpwLU2NLQudwIN5koi3beDhSAlJwa67PuM98c=
golang.org/x/net v0.32.0 h1:ZqPmj8Kzc+Y6e0+skZsuACbx+wzMgo5MQsJh9Qd6aYI=
golang.org/x/net v0.32.0/go.mod h1:CwU0IoeOlnQQWJ6ioyFrfRuomB8GKF6KbYXZVyeXNfs=
golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA=
golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo=
golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
google.golang.org/genproto/googleapis/rpc v0.0.0-20241209162323-e6fa225c2576 h1:8ZmaLZE4XWrtU3MyClkYqqtl6Oegr3235h7jxsDyqCY=
google.golang.org/genproto/googleapis/rpc v0.0.0-20241209162323-e6fa225c2576/go.mod h1:5uTbfoYQed2U9p3KIj2/Zzm02PYhndfdmML0qC3q3FU=
google.golang.org/grpc v1.68.1 h1:oI5oTa11+ng8r8XMMN7jAOmWfPZWbYpCFaMUTACxkM0=
google.golang.org/grpc v1.68.1/go.mod h1:+q1XYFJjShcqn0QZHvCyeR4CXPA+llXIeUIfIe00waw=
google.golang.org/protobuf v1.35.2 h1:8Ar7bF+apOIoThw1EdZl0p1oWvMqTHmpA2fRTyZO8io=
google.golang.org/protobuf v1.35.2/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
Expand Down
10 changes: 5 additions & 5 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,10 @@ func demonstrateConfigFunctions(ctx context.Context, szAbstractFactory senzing.S

// Create Senzing objects.

szConfig, err := szAbstractFactory.CreateSzConfig(ctx)
szConfig, err := szAbstractFactory.CreateConfig(ctx)
failOnError(5101, err)

szConfigManager, err := szAbstractFactory.CreateSzConfigManager(ctx)
szConfigManager, err := szAbstractFactory.CreateConfigManager(ctx)
failOnError(5102, err)

// Using SzConfig: Create a default configuration in memory.
Expand Down Expand Up @@ -153,13 +153,13 @@ func demonstrateSenzingFunctions(ctx context.Context, szAbstractFactory senzing.

// Create Senzing objects.

szDiagnostic, err := szAbstractFactory.CreateSzDiagnostic(ctx)
szDiagnostic, err := szAbstractFactory.CreateDiagnostic(ctx)
failOnError(5201, err)

szEngine, err := szAbstractFactory.CreateSzEngine(ctx)
szEngine, err := szAbstractFactory.CreateEngine(ctx)
failOnError(5202, err)

szProduct, err := szAbstractFactory.CreateSzProduct(ctx)
szProduct, err := szAbstractFactory.CreateProduct(ctx)
failOnError(5203, err)

// Clean the repository.
Expand Down
20 changes: 10 additions & 10 deletions szabstractfactory/szabstractfactory.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ type Szabstractfactory struct {
// ----------------------------------------------------------------------------

/*
Method CreateSzConfig returns an SzConfig object
Method CreateConfig returns an SzConfig object
implemented to use the Senzing native C binary, libSz.so.
Input
Expand All @@ -42,7 +42,7 @@ Input
Output
- An SzConfig object.
*/
func (factory *Szabstractfactory) CreateSzConfig(ctx context.Context) (senzing.SzConfig, error) {
func (factory *Szabstractfactory) CreateConfig(ctx context.Context) (senzing.SzConfig, error) {
var err error
result := &szconfig.Szconfig{}
if !factory.isSzconfigInitialized {
Expand All @@ -55,7 +55,7 @@ func (factory *Szabstractfactory) CreateSzConfig(ctx context.Context) (senzing.S
}

/*
Method CreateSzConfigManager returns an SzConfigManager object
Method CreateConfigManager returns an SzConfigManager object
implemented to use the Senzing native C binary, libSz.so.
Input
Expand All @@ -64,7 +64,7 @@ Input
Output
- An SzConfigManager object.
*/
func (factory *Szabstractfactory) CreateSzConfigManager(ctx context.Context) (senzing.SzConfigManager, error) {
func (factory *Szabstractfactory) CreateConfigManager(ctx context.Context) (senzing.SzConfigManager, error) {
var err error
result := &szconfigmanager.Szconfigmanager{}
if !factory.isSzconfigmanagerInitialized {
Expand All @@ -77,7 +77,7 @@ func (factory *Szabstractfactory) CreateSzConfigManager(ctx context.Context) (se
}

/*
Method CreateSzDiagnostic returns an SzDiagnostic object
Method CreateDiagnostic returns an SzDiagnostic object
implemented to use the Senzing native C binary, libSz.so.
Input
Expand All @@ -86,7 +86,7 @@ Input
Output
- An SzDiagnostic object.
*/
func (factory *Szabstractfactory) CreateSzDiagnostic(ctx context.Context) (senzing.SzDiagnostic, error) {
func (factory *Szabstractfactory) CreateDiagnostic(ctx context.Context) (senzing.SzDiagnostic, error) {
var err error
result := &szdiagnostic.Szdiagnostic{}
if !factory.isSzdiagnosticInitialized {
Expand All @@ -99,7 +99,7 @@ func (factory *Szabstractfactory) CreateSzDiagnostic(ctx context.Context) (senzi
}

/*
Method CreateSzEngine returns an SzEngine object
Method CreateEngine returns an SzEngine object
implemented to use the Senzing native C binary, libSz.so.
Input
Expand All @@ -108,7 +108,7 @@ Input
Output
- An SzEngine object.
*/
func (factory *Szabstractfactory) CreateSzEngine(ctx context.Context) (senzing.SzEngine, error) {
func (factory *Szabstractfactory) CreateEngine(ctx context.Context) (senzing.SzEngine, error) {
var err error
result := &szengine.Szengine{}
if !factory.isSzengineInitialized {
Expand All @@ -121,7 +121,7 @@ func (factory *Szabstractfactory) CreateSzEngine(ctx context.Context) (senzing.S
}

/*
Method CreateSzProduct returns an SzProduct object
Method CreateProduct returns an SzProduct object
implemented to use the Senzing native C binary, libSz.so.
Input
Expand All @@ -130,7 +130,7 @@ Input
Output
- An SzProduct object.
*/
func (factory *Szabstractfactory) CreateSzProduct(ctx context.Context) (senzing.SzProduct, error) {
func (factory *Szabstractfactory) CreateProduct(ctx context.Context) (senzing.SzProduct, error) {
var err error
result := &szproduct.Szproduct{}
if !factory.isSzproductInitialized {
Expand Down
22 changes: 11 additions & 11 deletions szabstractfactory/szabstractfactory_examples_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,64 +13,64 @@ import (
// Interface methods - Examples for godoc documentation
// ----------------------------------------------------------------------------

func ExampleSzabstractfactory_CreateSzConfig() {
func ExampleSzabstractfactory_CreateConfig() {
// For more information, visit https://github.com/senzing-garage/sz-sdk-go-core/blob/main/szabstractfactory/szabstractfactory_examples_test.go
ctx := context.TODO()
szAbstractFactory := getSzAbstractFactoryExample(ctx)
defer func() { handleError(szAbstractFactory.Destroy(ctx)) }()
szConfig, err := szAbstractFactory.CreateSzConfig(ctx)
szConfig, err := szAbstractFactory.CreateConfig(ctx)
if err != nil {
fmt.Println(err)
}
_ = szConfig // szConfig can now be used.
// Output:
}

func ExampleSzabstractfactory_CreateSzConfigManager() {
func ExampleSzabstractfactory_CreateConfigManager() {
// For more information, visit https://github.com/senzing-garage/sz-sdk-go-core/blob/main/szabstractfactory/szabstractfactory_examples_test.go
ctx := context.TODO()
szAbstractFactory := getSzAbstractFactoryExample(ctx)
defer func() { handleError(szAbstractFactory.Destroy(ctx)) }()
szConfigManager, err := szAbstractFactory.CreateSzConfigManager(ctx)
szConfigManager, err := szAbstractFactory.CreateConfigManager(ctx)
if err != nil {
fmt.Println(err)
}
_ = szConfigManager // szConfigManager can now be used.
// Output:
}

func ExampleSzabstractfactory_CreateSzDiagnostic() {
func ExampleSzabstractfactory_CreateDiagnostic() {
// For more information, visit https://github.com/senzing-garage/sz-sdk-go-core/blob/main/szabstractfactory/szabstractfactory_examples_test.go
ctx := context.TODO()
szAbstractFactory := getSzAbstractFactoryExample(ctx)
defer func() { handleError(szAbstractFactory.Destroy(ctx)) }()
szDiagnostic, err := szAbstractFactory.CreateSzDiagnostic(ctx)
szDiagnostic, err := szAbstractFactory.CreateDiagnostic(ctx)
if err != nil {
fmt.Println(err)
}
_ = szDiagnostic // szDiagnostic can now be used.
// Output:
}

func ExampleSzabstractfactory_CreateSzEngine() {
func ExampleSzabstractfactory_CreateEngine() {
// For more information, visit https://github.com/senzing-garage/sz-sdk-go-core/blob/main/szabstractfactory/szabstractfactory_examples_test.go
ctx := context.TODO()
szAbstractFactory := getSzAbstractFactoryExample(ctx)
defer func() { handleError(szAbstractFactory.Destroy(ctx)) }()
szEngine, err := szAbstractFactory.CreateSzEngine(ctx)
szEngine, err := szAbstractFactory.CreateEngine(ctx)
if err != nil {
fmt.Println(err)
}
_ = szEngine // szEngine can now be used.
// Output:
}

func ExampleSzabstractfactory_CreateSzProduct() {
func ExampleSzabstractfactory_CreateProduct() {
// For more information, visit https://github.com/senzing-garage/sz-sdk-go-core/blob/main/szabstractfactory/szabstractfactory_examples_test.go
ctx := context.TODO()
szAbstractFactory := getSzAbstractFactoryExample(ctx)
defer func() { handleError(szAbstractFactory.Destroy(ctx)) }()
szProduct, err := szAbstractFactory.CreateSzProduct(ctx)
szProduct, err := szAbstractFactory.CreateProduct(ctx)
if err != nil {
fmt.Println(err)
}
Expand All @@ -94,7 +94,7 @@ func ExampleSzabstractfactory_Reinitialize() {
ctx := context.TODO()
szAbstractFactory := getSzAbstractFactoryExample(ctx)
defer func() { handleError(szAbstractFactory.Destroy(ctx)) }()
szConfigManager, err := szAbstractFactory.CreateSzConfigManager(ctx)
szConfigManager, err := szAbstractFactory.CreateConfigManager(ctx)
if err != nil {
fmt.Println(err)
}
Expand Down
26 changes: 13 additions & 13 deletions szabstractfactory/szabstractfactory_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ var (
// Interface methods - test
// ----------------------------------------------------------------------------

func TestSzAbstractFactory_CreateSzConfig(test *testing.T) {
func TestSzAbstractFactory_CreateConfig(test *testing.T) {
ctx := context.TODO()
szAbstractFactory := getTestObject(ctx, test)
defer func() { handleError(szAbstractFactory.Destroy(ctx)) }()
szConfig, err := szAbstractFactory.CreateSzConfig(ctx)
szConfig, err := szAbstractFactory.CreateConfig(ctx)
require.NoError(test, err)
configHandle, err := szConfig.CreateConfig(ctx)
require.NoError(test, err)
Expand All @@ -46,44 +46,44 @@ func TestSzAbstractFactory_CreateSzConfig(test *testing.T) {
printActual(test, dataSources)
}

func TestSzAbstractFactory_CreateSzConfigManager(test *testing.T) {
func TestSzAbstractFactory_CreateConfigManager(test *testing.T) {
ctx := context.TODO()
szAbstractFactory := getTestObject(ctx, test)
defer func() { handleError(szAbstractFactory.Destroy(ctx)) }()
szConfigManager, err := szAbstractFactory.CreateSzConfigManager(ctx)
szConfigManager, err := szAbstractFactory.CreateConfigManager(ctx)
require.NoError(test, err)
configList, err := szConfigManager.GetConfigs(ctx)
require.NoError(test, err)
printActual(test, configList)
}

func TestSzAbstractFactory_CreateSzDiagnostic(test *testing.T) {
func TestSzAbstractFactory_CreateDiagnostic(test *testing.T) {
ctx := context.TODO()
szAbstractFactory := getTestObject(ctx, test)
defer func() { handleError(szAbstractFactory.Destroy(ctx)) }()
szDiagnostic, err := szAbstractFactory.CreateSzDiagnostic(ctx)
szDiagnostic, err := szAbstractFactory.CreateDiagnostic(ctx)
require.NoError(test, err)
result, err := szDiagnostic.CheckDatastorePerformance(ctx, 1)
require.NoError(test, err)
printActual(test, result)
}

func TestSzAbstractFactory_CreateSzEngine(test *testing.T) {
func TestSzAbstractFactory_CreateEngine(test *testing.T) {
ctx := context.TODO()
szAbstractFactory := getTestObject(ctx, test)
defer func() { handleError(szAbstractFactory.Destroy(ctx)) }()
szEngine, err := szAbstractFactory.CreateSzEngine(ctx)
szEngine, err := szAbstractFactory.CreateEngine(ctx)
require.NoError(test, err)
stats, err := szEngine.GetStats(ctx)
require.NoError(test, err)
printActual(test, stats)
}

func TestSzAbstractFactory_CreateSzProduct(test *testing.T) {
func TestSzAbstractFactory_CreateProduct(test *testing.T) {
ctx := context.TODO()
szAbstractFactory := getTestObject(ctx, test)
defer func() { handleError(szAbstractFactory.Destroy(ctx)) }()
szProduct, err := szAbstractFactory.CreateSzProduct(ctx)
szProduct, err := szAbstractFactory.CreateProduct(ctx)
require.NoError(test, err)
version, err := szProduct.GetVersion(ctx)
require.NoError(test, err)
Expand All @@ -100,11 +100,11 @@ func TestSzAbstractFactory_Reinitialize(test *testing.T) {
ctx := context.TODO()
szAbstractFactory := getTestObject(ctx, test)
defer func() { handleError(szAbstractFactory.Destroy(ctx)) }()
_, err := szAbstractFactory.CreateSzDiagnostic(ctx)
_, err := szAbstractFactory.CreateDiagnostic(ctx)
require.NoError(test, err)
_, err = szAbstractFactory.CreateSzEngine(ctx)
_, err = szAbstractFactory.CreateEngine(ctx)
require.NoError(test, err)
szConfigManager, err := szAbstractFactory.CreateSzConfigManager(ctx)
szConfigManager, err := szAbstractFactory.CreateConfigManager(ctx)
require.NoError(test, err)
configID, err := szConfigManager.GetDefaultConfigID(ctx)
require.NoError(test, err)
Expand Down

0 comments on commit dcc0ffd

Please sign in to comment.