renamed json.checkExists to json.exists (#146)

rename checkExists to exists
project-flogo · Oct 28, 2021 · 9ac17b8 · 9ac17b8
1 parent 4740d71
commit 9ac17b8
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 13 deletions.
diff --git a/function/json/README.md b/function/json/README.md
@@ -6,7 +6,7 @@ weight: 4601
 # JSON Functions
 This function package exposes common json functions.
 
-## checkExists()
+## exists()
 Check if the key/JSONPath is present in the json object. Refer https://github.com/oliveagle/jsonpath for expression format.
 ### Input Args
 

diff --git a/function/json/descriptor.json b/function/json/descriptor.json
@@ -7,9 +7,9 @@
   "homepage": "https://github.com/prject-flogo/contrib/tree/master/function/json",
   "functions": [
     {
-      "name": "checkExists",
+      "name": "exists",
       "description": "Check if the key/JSONPath is present in the json object. Refer https://github.com/oliveagle/jsonpath for expression format.",
-      "example": "json.checkExists(jsonObject, \"$.key\") => value",
+      "example": "json.exists(jsonObject, \"$.key\") => value",
       "args": [
         {
           "name": "jsonObject",

diff --git a/function/json/checkexists.go → function/json/exists.go b/function/json/checkexists.go → function/json/exists.go
@@ -10,24 +10,24 @@ import (
 )
 
 func init() {
-	_ = function.Register(&fnCheckExists{})
+	_ = function.Register(&fnExists{})
 }
 
-type fnCheckExists struct {
+type fnExists struct {
 }
 
 // Name returns the name of the function
-func (fnCheckExists) Name() string {
-	return "checkExists"
+func (fnExists) Name() string {
+	return "exists"
 }
 
 // Sig returns the function signature
-func (fnCheckExists) Sig() (paramTypes []data.Type, isVariadic bool) {
+func (fnExists) Sig() (paramTypes []data.Type, isVariadic bool) {
 	return []data.Type{data.TypeAny, data.TypeString}, false
 }
 
 // Eval executes the function
-func (fnCheckExists) Eval(params ...interface{}) (interface{}, error) {
+func (fnExists) Eval(params ...interface{}) (interface{}, error) {
 	expression, ok := params[1].(string)
 	if !ok {
 		return false, fmt.Errorf("The JSON key/path must be a string")

diff --git a/function/json/checkexists_test.go → function/json/exists_test.go b/function/json/checkexists_test.go → function/json/exists_test.go
@@ -38,7 +38,7 @@ func TestFnCheckExists(t *testing.T) {
 	err := json.Unmarshal([]byte(inputCheckExists), &inputJSON)
 	assert.Nil(t, err)
 
-	f := &fnCheckExists{}
+	f := &fnExists{}
 	v, err := function.Eval(f, inputJSON, "$.store.book[?(@.price == 12.99)].price[0]")
 	assert.Nil(t, err)
 	assert.Equal(t, true, v)
@@ -49,7 +49,7 @@ func TestFnCheckExistsLoop(t *testing.T) {
 	err := json.Unmarshal([]byte(inputCheckExists), &inputJSON)
 	assert.Nil(t, err)
 
-	f := &fnCheckExists{}
+	f := &fnExists{}
 	v, err := function.Eval(f, inputJSON, "$loop.store.book[?(@.price == 22.99)].price[0]")
 	assert.NotNil(t, err)
 	assert.Equal(t, false, v)
@@ -60,7 +60,7 @@ func TestFnCheckExistsNegative(t *testing.T) {
 	err := json.Unmarshal([]byte(inputCheckExists), &inputJSON)
 	assert.Nil(t, err)
 
-	f := &fnCheckExists{}
+	f := &fnExists{}
 	v, err := function.Eval(f, inputJSON, "$.store.abc")
 	assert.NotNil(t, err)
 	assert.Equal(t, false, v)
@@ -71,7 +71,7 @@ func TestFnCheckExistsEmpty(t *testing.T) {
 	err := json.Unmarshal([]byte(inputCheckExists), &inputJSON)
 	assert.Nil(t, err)
 
-	f := &fnCheckExists{}
+	f := &fnExists{}
 	v, err := function.Eval(f, inputJSON, "$.emptyString")
 	assert.Nil(t, err)
 	assert.Equal(t, true, v)