Item7611: SET and GET with support for JSON objects and JSON path

This is an enhancement of the SetGetPlugin that allows using JSON syntax to set and get variables. JSON (JavaScript Object Notation) is a lightweight data-interchange format. It is easy for humans to read and write. It is easy for machines to parse and generate. It is based on a subset of the JavaScript Programming Language. JSON is explained at http://www.json.org/

Test cases:

• %SET{ "normal" value="normal value" }%

  /normal value/

• %SET{ value="missing name" }%

  //

• not existing variable

  //

• %SET{ json_string = "json string value" }%

  /json string value/

• %SET{ json_n_string = "json string
  new line" }%

  /json string
       new line/

• %SET{ array = [ 1, 2, 3 ] }%

  /[1,2,3]/

• %SET{ json_array = [ "a", "b", "c" ] }%

  /["a","b","c"]/

  • %GET{ json_array[1] }%

    /b/

  • %SET{ json_array[4] = "d" }% - set value using JSON path
  • %GET{ json_array }%

    /["a","b","c",null,"d"]/

• %SET{ new_array[1] = "x" }% - set new array using JSON path
  • %GET{ new_array }%

    /[null,"x"]/

  • %SET{ new_array[2] = "y" }% - set new array using JSON path
  • %GET{ new_array }%

    /[null,"x","y"]/

• %GET{ persistent_array }%

  /["a","b","c","d"]/

  • %SET{ persistent_array[1] = "x" remember="1" }% - set new persistent array using JSON path
  • %GET{ persistent_array }%

    /["a","x","c","d"]/

  • %SET{ persistent_array[2] = "y" remember="1" }% - set new persistent array using JSON path
  • %GET{ persistent_array }%

    /["a","x","y","d"]/

  • %SET{ persistent_array = [ "a", "b", "c", "d" ] remember="1" }% - set new persistent array using JSON path
  • %GET{ persistent_array }%

    /["a","b","c","d"]/

• %SET{ arrayOfArray = [ [ "a", "b", "c" ], [ "d", "e", "f" ], [ "g", "h", "i" ] ] }%

  /[["a","b","c"],["d","e","f"],["g","h","i"]]/

  • %GET{ arrayOfArray[2] }%

    /["g","h","i"]/

  • %GET{ arrayOfArray[2][1] }%

    /h/

• %SET{ json_object = { "a": "A", "b": "B", "c": "C" } }%

  /{"c":"C","a":"A","b":"B"}/

  • %GET{ json_object.b }%

    /B/

  • %SET{ json_object.d = "D" }% - set value using JSON path
  • %GET{ json_object }%

    /{"c":"C","a":"A","b":"B","d":"D"}/

• %SET{ new_object.x = "X" }% - set new object using JSON path
  • %GET{ new_object }%

    /{"x":"X"}/

  • %SET{ new_object.y = "Y" }% - set new object using JSON path
  • %GET{ new_object }%

    /{"y":"Y","x":"X"}/

• %SET{ arrayOfObj = [ { "a": "A", "b": "B", "c": "C" }, { "d": "D", "e": "E", "f": "F" }, { "g": "G", "h": "H", "i": "I" } ] }%

  /[{"c":"C","a":"A","b":"B"},{"e":"E","d":"D","f":"F"},{"h":"H","g":"G","i":"I"}]/

  • %GET{ arrayOfObj[2] }%

    /{"h":"H","g":"G","i":"I"}/

  • %GET{ arrayOfObj[2].h }%

    /H/

  • %GET{ arrayOfObj[2].x }%

    /ERROR: Invalid JSON path, syntax or range./

  • %GET{ arrayOfObj }%

    /[{"c":"C","a":"A","b":"B"},{"e":"E","d":"D","f":"F"},{"h":"H","g":"G","i":"I"}]/

  • %SET{ arrayOfObj[2].x = "X" }% - set deep value using JSON path
  • %GET{ arrayOfObj }%

    /[{"c":"C","a":"A","b":"B"},{"e":"E","d":"D","f":"F"},{"h":"H","g":"G","x":"X","i":"I"}]/

• %SET{ menu = { "File": { "New": [ "new", "F" ], "Open": [ "open", "F" ] }, "Edit": { "Copy": [ "cpy", "F" ], "Paste": [ "pst", "F" ] } } }%

  /{"File":{"New":["new","F"],"Open":["open","F"]},"Edit":{"Copy":["cpy","F"],"Paste":["pst","F"]}}/

  • %SET{ menu.File.Open[1] = "T" }% - set deep value using JSON path
  • %GET{ menu }%

    /{"File":{"New":["new","F"],"Open":["open","T"]},"Edit":{"Copy":["cpy","F"],"Paste":["pst","F"]}}/

  • %SET{ menu.Edit.Cut = [ "cut", "T" ] }% - set deep value using JSON path
  • %GET{ menu }%

    /{"File":{"New":["new","F"],"Open":["open","T"]},"Edit":{"Copy":["cpy","F"],"Cut":["cut","T"],"Paste":["pst","F"]}}/

• %SET{ complex = {"method": "handleMessage", "params": ["user1", "we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7, true,  false]} }%

  /{"array":[1,11,234,-5,100000,10000000,true,false],"params":["user1","we were just talking"],"id":null,"method":"handleMessage"}/

  • %GET{ complex.array[3] }%

    /-5/

  • %GET{ complex.params[1] }%

    /we were just talking/

• %SET{ complexWidget = {"widget": {
      "debug": "on",
      "window": {
          "title": "Sample Konfabulator Widget",
          "name": "main_window",
          "width": 500,
          "height": 500
      },
      "image": { 
          "src": "Images/Sun.png",
          "name": "sun1",
          "hOffset": 250,
          "vOffset": 250,
          "alignment": "center"
      },
      "text": {
          "data": "Click Here",
          "size": 36,
          "style": "bold",
          "name": "text1",
          "hOffset": 250,
          "vOffset": 100,
          "alignment": "center",
          "onMouseUp": "sun1.opacity = (sun1.opacity / 100) * 90;"
      }
    }} }%

  

  /{"widget":{"window":{"width":500,"name":"main_window","title":"Sample Konfabulator Widget","height":500},"text":{"hOffset":250,"vOffset":100,"name":"text1","style":"bold","data":"Click Here","size":36,"onMouseUp":"sun1.opacity = (sun1.opacity / 100) * 90;","alignment":"center"},"debug":"on","image":{"hOffset":250,"src":"Images/Sun.png","alignment":"center","vOffset":250,"name":"sun1"}}}/

  • %GET{ complexWidget.widget.window }%

    /{"width":500,"name":"main_window","title":"Sample Konfabulator Widget","height":500}/

  • %GET{ complexWidget.widget.window.title }%

    /Sample Konfabulator Widget/

• %SET{ error = [ 1, 2, } ] }%

  /ERROR: malformed JSON string, neither array, object, number, string or atom, at character offset 8 (before "} ]")/

-- TWiki:Main/PeterThoeny - 2015-02-05