refactor!: rename OrElse() to Or()

moznion · Dec 8, 2022 · 9202070 · 9202070
1 parent 54d6aaa
commit 9202070
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -60,7 +60,7 @@ and more detailed examples are here: [./examples_test.go](./examples_test.go).
 - [Option[T]#Take() (T, error)](https://pkg.go.dev/github.com/moznion/go-optional#Option.Take)
 - [Option[T]#TakeOr(fallbackValue T) T](https://pkg.go.dev/github.com/moznion/go-optional#Option.TakeOr)
 - [Option[T]#TakeOrElse(fallbackFunc func() T) T](https://pkg.go.dev/github.com/moznion/go-optional#Option.TakeOrElse)
-- [Option[T]#OrElse(fallbackOptionValue Option[T]) Option[T]](https://pkg.go.dev/github.com/moznion/go-optional#Option.OrElse)
+- [Option[T]#Or(fallbackOptionValue Option[T]) Option[T]](https://pkg.go.dev/github.com/moznion/go-optional#Option.Or)
 - [Option[T]#Filter(predicate func(v T) bool) Option[T]](https://pkg.go.dev/github.com/moznion/go-optional#Option.Filter)
 - [Option[T]#IfSome(f func(v T))](https://pkg.go.dev/github.com/moznion/go-optional#Option.IfSome)
 - [Option[T]#IfSomeWithError(f func(v T) error) error](https://pkg.go.dev/github.com/moznion/go-optional#Option.IfSomeWithError)

diff --git a/examples_test.go b/examples_test.go
@@ -551,14 +551,14 @@ func ExampleFlatMapOrWithError() {
 	//
 }
 
-func ExampleOption_OrElse() {
+func ExampleOption_Or() {
 	fallback := Some[string]("fallback")
 
 	some := Some[string]("actual")
-	fmt.Printf("%s\n", some.OrElse(fallback))
+	fmt.Printf("%s\n", some.Or(fallback))
 
 	none := None[string]()
-	fmt.Printf("%s\n", none.OrElse(fallback))
+	fmt.Printf("%s\n", none.Or(fallback))
 
 	// Output:
 	// Some[actual]

diff --git a/option.go b/option.go
@@ -102,9 +102,9 @@ func (o Option[T]) TakeOrElse(fallbackFunc func() T) T {
 	return o[value]
 }
 
-// OrElse returns the Option value according to the actual value existence.
+// Or returns the Option value according to the actual value existence.
 // If the receiver's Option value is Some, this function pass-through that to return. Otherwise, this value returns the `fallbackOptionValue`.
-func (o Option[T]) OrElse(fallbackOptionValue Option[T]) Option[T] {
+func (o Option[T]) Or(fallbackOptionValue Option[T]) Option[T] {
 	if o.IsNone() {
 		return fallbackOptionValue
 	}

diff --git a/option_test.go b/option_test.go
@@ -569,9 +569,9 @@ func TestOption_String(t *testing.T) {
 	assert.Equal(t, "None[]", None[*MyStringer]().String())
 }
 
-func TestOption_OrElse(t *testing.T) {
+func TestOption_Or(t *testing.T) {
 	fallback := Some[string]("fallback")
 
-	assert.EqualValues(t, Some[string]("actual").OrElse(fallback).Unwrap(), "actual")
-	assert.EqualValues(t, None[string]().OrElse(fallback).Unwrap(), "fallback")
+	assert.EqualValues(t, Some[string]("actual").Or(fallback).Unwrap(), "actual")
+	assert.EqualValues(t, None[string]().Or(fallback).Unwrap(), "fallback")
 }