├── LICENSE ├── README.md ├── explode_test.go └── gojsonexplode.go /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # gojsonexplode 2 | 3 | 4 | ## What is gojsonexplode? 5 | gojsonexplode go library to flatten/explode nested JSON. 6 | 7 | ## How does it work? 8 | ```go 9 | package main 10 | 11 | import ( 12 | "fmt" 13 | 14 | "github.com/nytlabs/gojsonexplode" 15 | ) 16 | func main() { 17 | input := `{"person":{"name":"Joe", "address":{"street":"123 Main St."}}}` 18 | out, err := gojsonexplode.Explodejsonstr(input, ".") 19 | if err != nil { 20 | // handle error 21 | } 22 | fmt.Println(out) 23 | } 24 | ``` 25 | 26 | should print: 27 | ```javascript 28 | {"person.address.street":"123 Main St.","person.name":"Joe"} 29 | ``` 30 | 31 | ### How are JSON arrays handled? 32 | JSON arrays are flattned using the parent attribute concatenated with a delimiter and the respective index for each of the elements in the array 33 | ```javascript 34 | {"list":[true, false]} 35 | ``` 36 | gets exploded to: 37 | ```javascript 38 | {"list.0": true, "list.1":false} 39 | ``` 40 | -------------------------------------------------------------------------------- /explode_test.go: -------------------------------------------------------------------------------- 1 | package gojsonexplode 2 | 3 | import ( 4 | "testing" 5 | ) 6 | 7 | func TestTrue(t *testing.T) { 8 | input := `[true]` 9 | output := `{"0":true}` 10 | 11 | out, _ := Explodejsonstr(input, ".") 12 | if out != output { 13 | t.Error("got", out) 14 | } 15 | } 16 | 17 | func TestNull(t *testing.T) { 18 | input := `[null]` 19 | output := `{"0":null}` 20 | 21 | out, _ := Explodejsonstr(input, ".") 22 | if out != output { 23 | t.Error("got", out) 24 | } 25 | } 26 | 27 | func TestNesting(t *testing.T) { 28 | input := `{"person":{"name":"Joe", "address":{"street":"123 Main St."}}}` 29 | output := `{"person.address.street":"123 Main St.","person.name":"Joe"}` 30 | out, _ := Explodejsonstr(input, ".") 31 | if out != output { 32 | t.Error("got", out) 33 | } 34 | } 35 | 36 | func TestItems(t *testing.T) { 37 | input := ` 38 | [ 39 | { 40 | "description": "a schema given for items", 41 | "schema": { 42 | "items": {"type": "integer"} 43 | }, 44 | "tests": [ 45 | { 46 | "description": "valid items", 47 | "data": [ 1, 2, 3 ], 48 | "valid": true 49 | }, 50 | { 51 | "description": "wrong type of items", 52 | "data": [1, "x"], 53 | "valid": false 54 | }, 55 | { 56 | "description": "ignores non-arrays", 57 | "data": {"foo" : "bar"}, 58 | "valid": true 59 | } 60 | ] 61 | }, 62 | { 63 | "description": "an array of schemas for items", 64 | "schema": { 65 | "items": [ 66 | {"type": "integer"}, 67 | {"type": "string"} 68 | ] 69 | }, 70 | "tests": [ 71 | { 72 | "description": "correct types", 73 | "data": [ 1, "foo" ], 74 | "valid": true 75 | }, 76 | { 77 | "description": "wrong types", 78 | "data": [ "foo", 1 ], 79 | "valid": false 80 | } 81 | ] 82 | } 83 | ]` 84 | output := `{"0.description":"a schema given for items","0.schema.items.type":"integer","0.tests.0.data.0":1,"0.tests.0.data.1":2,"0.tests.0.data.2":3,"0.tests.0.description":"valid items","0.tests.0.valid":true,"0.tests.1.data.0":1,"0.tests.1.data.1":"x","0.tests.1.description":"wrong type of items","0.tests.1.valid":false,"0.tests.2.data.foo":"bar","0.tests.2.description":"ignores non-arrays","0.tests.2.valid":true,"1.description":"an array of schemas for items","1.schema.items.0.type":"integer","1.schema.items.1.type":"string","1.tests.0.data.0":1,"1.tests.0.data.1":"foo","1.tests.0.description":"correct types","1.tests.0.valid":true,"1.tests.1.data.0":"foo","1.tests.1.data.1":1,"1.tests.1.description":"wrong types","1.tests.1.valid":false}` 85 | out, _ := Explodejsonstr(input, ".") 86 | if out != output { 87 | t.Error("got", out) 88 | } 89 | } 90 | -------------------------------------------------------------------------------- /gojsonexplode.go: -------------------------------------------------------------------------------- 1 | package gojsonexplode 2 | 3 | // TODO: cannot have delimiter be " or \ 4 | 5 | import ( 6 | "encoding/json" 7 | "errors" 8 | "strconv" 9 | ) 10 | 11 | func explodeList(l []interface{}, parent string, delimiter string) (map[string]interface{}, error) { 12 | var err error 13 | var key string 14 | j := make(map[string]interface{}) 15 | if len(l) == 0 { 16 | key = parent 17 | j[key] = nil 18 | } 19 | for k, i := range l { 20 | if len(parent) > 0 { 21 | key = parent + delimiter + strconv.Itoa(k) 22 | } else { 23 | key = strconv.Itoa(k) 24 | } 25 | switch v := i.(type) { 26 | case nil: 27 | j[key] = v 28 | case int: 29 | j[key] = v 30 | case float64: 31 | j[key] = v 32 | case string: 33 | j[key] = v 34 | case bool: 35 | j[key] = v 36 | case []interface{}: 37 | out := make(map[string]interface{}) 38 | out, err = explodeList(v, key, delimiter) 39 | if err != nil { 40 | return nil, err 41 | } 42 | for newkey, value := range out { 43 | j[newkey] = value 44 | } 45 | case map[string]interface{}: 46 | out := make(map[string]interface{}) 47 | out, err = explodeMap(v, key, delimiter) 48 | if err != nil { 49 | return nil, err 50 | } 51 | for newkey, value := range out { 52 | j[newkey] = value 53 | } 54 | default: 55 | // do nothing 56 | } 57 | } 58 | return j, nil 59 | } 60 | 61 | func explodeMap(m map[string]interface{}, parent string, delimiter string) (map[string]interface{}, error) { 62 | var err error 63 | j := make(map[string]interface{}) 64 | for k, i := range m { 65 | if len(parent) > 0 { 66 | k = parent + delimiter + k 67 | } 68 | switch v := i.(type) { 69 | case nil: 70 | j[k] = v 71 | case int: 72 | j[k] = v 73 | case float64: 74 | j[k] = v 75 | case string: 76 | j[k] = v 77 | case bool: 78 | j[k] = v 79 | case []interface{}: 80 | out := make(map[string]interface{}) 81 | out, err = explodeList(v, k, delimiter) 82 | if err != nil { 83 | return nil, err 84 | } 85 | for key, value := range out { 86 | j[key] = value 87 | } 88 | case map[string]interface{}: 89 | out := make(map[string]interface{}) 90 | out, err = explodeMap(v, k, delimiter) 91 | if err != nil { 92 | return nil, err 93 | } 94 | for key, value := range out { 95 | j[key] = value 96 | } 97 | default: 98 | //nothing 99 | } 100 | } 101 | return j, nil 102 | } 103 | 104 | // Explodejson takes in a nested JSON as a byte array and a delimiter and returns an 105 | // exploded/flattened json byte array 106 | func Explodejson(b []byte, d string) ([]byte, error) { 107 | var input interface{} 108 | var exploded map[string]interface{} 109 | var out []byte 110 | var err error 111 | err = json.Unmarshal(b, &input) 112 | if err != nil { 113 | return nil, err 114 | } 115 | switch t := input.(type) { 116 | case map[string]interface{}: 117 | exploded, err = explodeMap(t, "", d) 118 | if err != nil { 119 | return nil, err 120 | } 121 | case []interface{}: 122 | exploded, err = explodeList(t, "", d) 123 | if err != nil { 124 | return nil, err 125 | } 126 | default: 127 | // How did we get here? It is impossible!! 128 | return nil, errors.New("Possible error in JSON") 129 | } 130 | out, err = json.Marshal(exploded) 131 | if err != nil { 132 | return nil, err 133 | } 134 | return out, nil 135 | 136 | } 137 | 138 | // Explodejsonstr explodes a nested JSON string to an unnested one 139 | // parameters to pass to the function are 140 | // * s: the JSON string 141 | // * d: the delimiter to use when unnesting the JSON object. 142 | // {"person":{"name":"Joe", "address":{"street":"123 Main St."}}} 143 | // explodes to: 144 | // {"person.name":"Joe", "person.address.street":"123 Main St."} 145 | func Explodejsonstr(s string, d string) (string, error) { 146 | b := []byte(s) 147 | out, err := Explodejson(b, d) 148 | if err != nil { 149 | return "", err 150 | } 151 | return string(out), nil 152 | } 153 | --------------------------------------------------------------------------------