value.toJsonKeyName ( value )

Given a value, makes it safe for use as a JSON key name by removing invalid characters, and spaces, and replacing them with underscores. Also, if the key name is a reserved word, it will be prefixed with an underscore.

Be the first to rate this function Log in to vote

Cristos Lianides-Chin - Show more from this author
Codence
https://www.codence.com

Sample input:

value.toJsonKeyName ( "My Value" )

Sample output:

"My_Value"

Function definition: (Copy & paste into FileMaker's Edit Custom Function window)

/** 
# value.toJsonKeyName ( // Given a value, makes it safe for use as a JSON key name by removing invalid characters, and spaces, and replacing them with underscores. Also, if the key name is a reserved word, it will be prefixed with an underscore.
    value               // (string) The value to make safe as a JSON key name
)

## USAGE
```
value.toJsonKeyName ( "My Value" ) // Returns "My_Value"
```

You can test with the following data viewer snippet:
```

Let (
[   // Define the test strings
    ~testStrings = List (
        "My Value" ;
        "  Trim Spaces  " ;
        "Multi\¶Line" ;
        "error" ;
        "1startsWithNumber" ;
        "Áccentèd" ;
        "!@#$%^&*()_+{}|:<>?[];',./" ;
        "json" ;
        "json_array" ;
        "🙂 Emoji" ;
        "中文 Chinese" ;
        "русский Russian" ;
        "العربية Arabic"
    )

]

;   // Use the While() function to loop through the test strings
    While (
        [   // Initialize the loop variables
            ~index = 1
		;   ~resultsList = ""
        ]
    ;   ~index ≤ ValueCount ( ~testStrings )
    ;   
    [   ~testString = GetValue ( ~testStrings ; ~index )
    ;   ~result = value.toJsonKeyName ( ~testString )
    ;   ~resultsList = List ( ~resultsList ; "Input: " & ~testString & " | Output: " & jsonsetelement ( "{}" ; ~result ; "bar" ; JSONString ) )
    ;   ~index = ~index + 1
    ]
    ;   ~resultsList
	)
)
```

## REQUIRES
 - None

## CONTRIBUTORS
 - CLC | Cristos Lianides-Chin | cristos.lianides-chin@codence.com

## CHANGELOG
### v1.0 | CLC | 2023-05-05
 - Function created
**/

Let (
[   ~value.toJsonKeyName.profiling.startMs = Get ( CurrentTimeUTCMilliseconds )

;   ~value = value

    // Trim leading & trailing spaces
;   ~safeValue = Trim ( ~value )

    // Make a list of reserved words
;   ~listReservedWords = List(
        // JSON reserved words
        "absent" ; 
        "array" ; 
        "empty" ; 
        "error" ; 
        "format" ; 
        "json" ; 
        "json_array" ; 
        "json_arrayagg" ; 
        "json_exists" ; 
        "json_object" ; 
        "json_objectagg" ; 
        "json_query" ; 
        "json_value" ; 
        "keep" ; 
        "key" ; 
        "keys" ; 
        "passing" ; 
        "returning" ; 
        "unconditional" ; 
        "value" ; 
        "wrapper" ;

        // FileMaker reserved words
        "AllStyles" ; 
        "And" ; 
        "Bold" ; 
        "CentralEurope" ; 
        "Condense" ; 
        "Cyrillic" ; 
        "DatabaseNames" ; 
        "DoubleUnderline" ; 
        "Extend" ; 
        "False" ; 
        "Greek" ; 
        "Higher" ; 
        "HighlightYellow" ; 
        "Italic" ; 
        "JSONArray" ; 
        "JSONBoolean" ; 
        "JSONNull" ; 
        "JSONNumber" ; 
        "JSONObject" ; 
        "JSONRaw" ; 
        "List" ; 
        "Lower" ; 
        "Lowercase" ; 
        "Not" ; 
        "OEM" ; 
        "Or" ; 
        "Other" ; 
        "Pi" ; 
        "Plain" ; 
        "PosixPath" ; 
        "Random" ; 
        "Roman" ; 
        "Self" ; 
        "ShiftJIS" ; 
        "SimplifiedChinese" ; 
        "SmallCaps" ; 
        "Strikethrough" ; 
        "Subscript" ; 
        "Superscript" ; 
        "Symbol" ; 
        "Titlecase" ; 
        "TraditionalChinese" ; 
        "True" ; 
        "Underline" ; 
        "Uppercase" ; 
        "URLPath" ; 
        "WinDrivePath" ; 
        "WinUNCPath" ; 
        "WordUnderline" ; 
        "Xor"
    )
    // If the value is a reserved word or begins with a number, prefix it with an underscore. `Position()` is case-INsensitive
;   ~isReservedWord = Position ( "¶" & ~listReservedWords & "¶" ; "¶" & ~safeValue & "¶" ; 0 ; 1 ) > 0
;   ~isStartsWithNumber = Position ( "0123456789" ; Left ( ~safeValue ; 1 ) ; 0 ; 1 ) > 0
;   ~safeValue = If ( ~isReservedWord or ~isStartsWithNumber ; "_" ) & ~safeValue

    // If ~safeValue is empty, use "empty" with a UTCMillisecond suffix
;   ~safeValue = If ( IsEmpty ( ~safeValue ) ; "empty_" & Get ( CurrentTimeUTCMilliseconds ) ; ~safeValue )

    // Iterate over each character and see if it's a non-ASCII or illegal character by using `Code()` and comparing to a list of illegal characters. If it is, replace it with an underscore.
;   ~listIllegalChars = List
        (   "\""
        ;   "\\"
        ;   "/"
        ;   "["
        ;   "]"
        ;   "{"
        ;   "}"
        ;   ":"
        ;   ","
        ;   " "
        ;   "¶"
        ;   "@"
        ;   "#"
        ;   "$"
        ;   "%"
        ;   "^"
        ;   "&"
        ;   "*"
        ;   "("
        ;   ")"
        ;   "+"
        ;   "="
        ;   "|"
        ;   ";"
        ;   "<"
        ;   ">"
        ;   "?"
        ;   "`"
        ;   "~"
        ;   "!"
        ;   "'"
        ;   "’"
        ;   "‘"
        ;   " "
        ;   "."
        )

;   ~safeValue = While (
    [   ~sourceText = ~safeValue
    ;   ~sourceText.length = Length ( ~safeValue )
    ;   ~i = 1
    ;   ~char = ""
    ;   ~charCode = ""
    ;   ~charIsAscii = ""
    ;   ~newValue = ~safeValue
    ]
    ;   ~i ≤ ~sourceText.length
    ;   [   ~char = Middle ( ~sourceText ; ~i ; 1 )
        ;   ~charCode = Code ( ~char )
        ;   ~charIsAscii = ~charCode ≤ 127
        ;   ~charIsIllegal = Position ( "¶" & ~listIllegalChars & "¶" ; "¶" & ~char & "¶" ; 0 ; 1 ) > 0
        ;   ~newValue = If ( (not ~charIsAscii ) or ~charIsIllegal ; Substitute ( ~newValue ; ~char ; "_" ) ; /** ELSE **/ ~newValue )
        ;   ~i = ~i + 1
        ]
    ;   ~newValue
    )

    // Return the result
;   ~returnValue = ~safeValue

    // Capture profiling data
;   ~value.toJsonKeyName.profiling.stopMs = Get ( CurrentTimeUTCMilliseconds )
;   ~value.toJsonKeyName.profiling.durationMs = ~value.toJsonKeyName.profiling.stopMs - ~value.toJsonKeyName.profiling.startMs
;   $$~value.toJsonKeyName.durationMs = If ( ~value.toJsonKeyName.profiling.durationMs > 200 ; ~value.toJsonKeyName.profiling.durationMs ; "" )
]
;   Case ( IsEmpty ( ~value ) ; "? - value is empty" ; /** ELSE **/ ~returnValue )
)

You can test with the following data viewer snippet:
```

Let (
[ // Define the test strings
~testStrings = List (
"My Value" ;
" Trim Spaces " ;
"Multi\¶Line" ;
"error" ;
"1startsWithNumber" ;
"Áccentèd" ;
"!@#$%^&*()_+{}|:<>?[];',./" ;
"json" ;
"json_array" ;
"🙂 Emoji" ;
"中文 Chinese" ;
"русский Russian" ;
"العربية Arabic"
)

]

; // Use the While() function to loop through the test strings
While (
[ // Initialize the loop variables
~index = 1
; ~resultsList = ""
]
; ~index ≤ ValueCount ( ~testStrings )
;
[ ~testString = GetValue ( ~testStrings ; ~index )
; ~result = value.toJsonKeyName ( ~testString )
; ~resultsList = List ( ~resultsList ; "Input: " & ~testString & " | Output: " & jsonsetelement ( "{}" ; ~result ; "bar" ; JSONString ) )
; ~index = ~index + 1
]
; ~resultsList
)
)
```

Comments

Note: these functions are not guaranteed or supported by BrianDunning.com. Please contact the individual developer with any questions or problems.

value.toJsonKeyName ( value )

Comments

Support this website.

Support this website.