diff --git a/docs/jsonloader.md b/docs/jsonloader.md new file mode 100644 index 00000000..047c4b74 --- /dev/null +++ b/docs/jsonloader.md @@ -0,0 +1,24 @@ +SPDX-License-Identifier: CC-BY-4.0 + +## Working + +A UnmarshallJSON function on the spdx.Document2_2 struct is defined so that when the JSON is unmarshalled in it the function is called and we can implement the process in a custom way . Then a new map[string]interface{} is deifined which temporarily holds the unmarshalled json . The map is then parsed into the spdx.Document2_2 using functions defined for it’s different sections . + +JSON → map[string]interface{} → spdx.Document2_2 + +## Some Key Points + +- The packages have a property "hasFiles" defined in the schema which is an array of the SPDX Identifiers of the files of that pacakge . The parses first parses all the files into the Unpackaged files map of the document and then when it parses the packages , it removes the respective files from the unpackaged files map and places it inside the files map of that package . + +- The snippets have a property "snippetFromFile" which has the SPDX identiifer of the file to which the snippet is related . Thus the snippets require the files to be parsed before them . Then the snippets are parsed one by one and inserted into the respective files using this property . + + +The json file loader in `package jsonloader` makes the following assumptions: + + +### Order of appearance of the properties +* The parser does not make any pre-assumptions based on the order in which the properties appear . + + +### Annotations +* The json spdx schema does not define the SPDX Identifier property for the annotation object . The parser assumes the spdx Identifier of the parent property of the currently being parsed annotation array to be the SPDX Identifer for all the annotation objects of that array. \ No newline at end of file diff --git a/docs/jsonsaver.md b/docs/jsonsaver.md new file mode 100644 index 00000000..8531cd3e --- /dev/null +++ b/docs/jsonsaver.md @@ -0,0 +1,28 @@ +SPDX-License-Identifier: CC-BY-4.0 + +## Working + +The spdx document is converted to map[string]interface{} and then the entire map is converted to json using a single json Marshall function call . The saver uses a tempoarary storage to store all the files (Paackaged and Unpackaged) together in a single data structure in order to comply with the json schema defined by spdx . + +spdx.Document2_2 → map[string]interface{} → JSON + +## Some Key Points + +- The packages have a property "hasFiles" defined in the schema which is an array of the SPDX Identifiers of the files of that pacakge . The saver iterates through the files of a package and inserted all the SPDX Identifiers of the files in the "hasFiles" array . In addition it adds the file to a temporary storage map to store all the files of the entire document at a single place . + +- The files require the packages to be saved before them in order to ensure that the packaged files are added to the temporary storage before the files are saved . + +- The snippets are saved after the files and a property "snippetFromFile" identifies the file of the snippets. + +The json file loader in `package jsonsaver` makes the following assumptions: + + +### Order of appearance of the properties +* The saver does not make any pre-assumptions based on the order in which the properties are saved . + + +### Annotations +* The json spdx schema does not define the SPDX Identifier property for the annotation object . The saver inserts the annotation inside the element who spdx identifier mathches the annotation SPDX identifier . + +### Indentation +* The jsonsaver uses the marshall indent function with "" as he prefix and "\t" as the indent character , passed as funtion parameters . \ No newline at end of file diff --git a/jsonsaver/jsonsaver.go b/jsonsaver/jsonsaver.go index 11ee58d7..4748e16c 100644 --- a/jsonsaver/jsonsaver.go +++ b/jsonsaver/jsonsaver.go @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later + package jsonsaver import ( diff --git a/jsonsaver/jsonsaver_test.go b/jsonsaver/jsonsaver_test.go index 79926067..3d5daa93 100644 --- a/jsonsaver/jsonsaver_test.go +++ b/jsonsaver/jsonsaver_test.go @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later + package jsonsaver import (