att

Author: mateusmoutinho

README.md

@@ -1,6 +1,140 @@
 # LuaFluidJson
-An json Parser for lua that doesnt require any adaptation
+An json Parser for lua that doesn't require any adaptation
 
 
+Beside others parsers that requires adaptation to load and dump jsons, these LuaFluidJson use 
+the native mechanics of lua to implement the load and dump processing, allowing a super easy way
+to deal with jsons.
 
-s
+<h3 style="color:red;">THESE LIB ITS NOT PRODUCTION READY USE WITH RESPONSIBILITY</h3>
+
+### Platforms supported: 
+**Linux** (Tested on Fedora and Ubuntu)
+
+### Installation
+The instalation doesnt require lua rocks or any package manager, just download the
+[download link](aaa) into your project and copy in the root of your main,and you can start using 
+
+### Dumping Json file
+these code dumps the following struct into a json file 
+```lua
+local json = require("luaFluidJson/luaFluidJson")
+
+local user  ={
+
+    name='Nateus',
+    age=27,
+    maried=false,
+    sons={
+        {name='son1',maried='null'}
+    }
+}
+local ident = true
+json.dumps_to_file(user,"test/target/out.json",ident);
+ 
+```
+
+### Dumping a json String 
+if you need to dump a JSON String its also easy, you can just call the **dumps_to_string** function 
+
+```lua 
+local json = require("luaFluidJson/luaFluidJson")
+
+local user  ={
+
+    name='Nateus',
+    age=27,
+    maried=true,
+    sons={
+        {name='son1',maried=false }
+    }
+}
+local ident = true
+local value = json.dumps_to_string(user,ident);
+
+print(value)
+```
+
+### Loading a Json from File 
+you can easly load a json direct from file
+```lua
+
+local json = require("luaFluidJson/luaFluidJson")
+
+
+local parsed = json.load_from_file("test/target/element.json");
+
+print("name:"..parsed.name)
+print("age:"..parsed.age)
+print("maried:"..tostring(parsed.maried))
+for i,v in ipairs(parsed.sons) do
+    local son_name = v["name"]
+    print("son name:"..son_name)
+end
+```
+### Loading a Json from String 
+its also possible to load a json from string 
+
+```lua
+
+local json = require("luaFluidJson/luaFluidJson")
+
+local test = '{"name":"mateus","age":27}'
+
+local parsed = json.load_from_string(test);
+
+print("name:"..parsed.name)
+print("age:"..parsed.age)
+
+```
+### The Null Terminator
+since the lua nill doesn't work as other languages "nulls" ,the lib consider null as a string 
+so if you put "null" into your code, the lib will consider as a null value
+
+```lua 
+local json = require("luaFluidJson/luaFluidJson")
+
+local user  ={
+
+    name='Nateus',
+    age=27,
+    maried=false,
+    sons='null'
+}
+local ident = true
+json.dumps_to_file(user,"test/target/out.json",ident);
+```
+### Null Scape
+its also possible to scape null putting another code into its place 
+
+```lua 
+
+local json = require("luaFluidJson/luaFluidJson")
+json.set_null_code("custom_null")
+local user  ={
+
+    name='Nateus',
+    age=27,
+    maried=false,
+    sons='custom_null'
+}
+local ident = true
+json.dumps_to_file(user,"test/target/out.json",ident);
+```
+
+### Identifying objects
+if you want to ensure the following table will be parsed as a object, you can just call the 
+**is_table_a_object** function
+
+```lua 
+
+local json = require("luaFluidJson/luaFluidJson")
+
+local test = {1,2,3}
+print(json.is_table_a_object(test))
+
+local test2 = {a=20,b=30}
+
+print(json.is_table_a_object(test2))
+
+```

build.lua

@@ -60,6 +60,20 @@ local function test_unit(unit,start_assignature)
        dtw.write_file(unit.."expected.txt",output)
      end
 
+    print("valgrind testing: "..file_path)
+    os.execute("valgrind  lua "..file_path.." &>> out.txt","r")
+    local output_valgrind  = dtw.load_file("out.txt")
+    local heap_test = string.find(output_valgrind, "All heap blocks were freed ")
+    local error_test = string.find(output_valgrind,"0 errors from 0 contexts")
+    dtw.remove_any("out.txt")
+
+    if heap_test == nil or  error_test == nil then
+        print(output_valgrind)
+        return true
+    end
+
+
+
 
     local test_assignature  = dtw.generate_sha_from_folder_by_content(SIDE_EFFECT)
     --means code generated side effect
@@ -82,7 +96,7 @@ local function exec_tests(start_assignature)
 
     for i, t in ipairs(tests) do
         local error = test_unit(t,start_assignature)
-            dtw.copy_any_overwriting(side_effect_copy_path,SIDE_EFFECT);
+         dtw.copy_any_overwriting(side_effect_copy_path,SIDE_EFFECT);
 
         if error then
             return
@@ -110,7 +124,7 @@ local function main()
     dtw.copy_any_overwriting(side_effect_copy_path,SIDE_EFFECT);
     dtw.remove_any(side_effect_copy_path)
 
-   -- os.execute("zip -r luaDoTheWorld.zip luaDoTheWorld/")
+    os.execute("zip -r luaFluidJson.zip src/")
 end