Merge pull request #3 from raphasampaio/feature/plain

Add plain instance

Author: raphasampaio

Project.toml

@@ -1,6 +1,6 @@
 name = "SharedPreferences"
 uuid = "a5a92e11-d0bb-45ff-9fc3-c070cd77387a"
-version = "0.1.1"
+version = "0.2.0"
 
 [deps]
 Nettle = "49dea1ee-f6fa-5aa6-9a11-8816cee7d4b9"

src/instance.jl

@@ -1,9 +1,24 @@
-struct Instance
+abstract type AbstractInstance end
+
+struct Instance <: AbstractInstance
+    path::String
+
+    function Instance(file::AbstractString)
+        directory = tempdir()
+        path = joinpath(directory, "$file.toml")
+
+        return new(
+            path,
+        )
+    end
+end
+
+struct InstanceEncrypted <: AbstractInstance
     encryptor::Nettle.Encryptor
     decryptor::Nettle.Decryptor
     path::String
 
-    function Instance(key::AbstractString)
+    function InstanceEncrypted(key::AbstractString)
         @assert length(key) == 32
 
         directory = tempdir()
@@ -23,6 +38,14 @@ function load(instance::Instance)
         return Dict{String, Any}()
     end
 
+    return TOML.parsefile(instance.path)
+end
+
+function load(instance::InstanceEncrypted)
+    if !isfile(instance.path)
+        return Dict{String, Any}()
+    end
+
     file = open(instance.path, "r")
     encrypted = read(file, String)
     close(file)
@@ -33,6 +56,14 @@ function load(instance::Instance)
 end
 
 function save(instance::Instance, content::Dict)
+    open(instance.path, "w") do io
+        TOML.print(io, content)
+    end
+
+    return nothing
+end
+
+function save(instance::InstanceEncrypted, content::Dict)
     serialized = sprint(io -> TOML.print(io, content))
     encrypted = encrypt(instance.encryptor, add_padding_PKCS5(Vector{UInt8}(serialized), 16))
 
@@ -43,31 +74,31 @@ function save(instance::Instance, content::Dict)
     return nothing
 end
 
-function set!(instance::Instance, key::AbstractString, value::Any)
+function set!(instance::AbstractInstance, key::AbstractString, value::Any)
     dict = load(instance)
     dict[key] = value
     save(instance, dict)
     return nothing
 end
 
-function Base.get(instance::Instance, key::AbstractString)
+function Base.get(instance::AbstractInstance, key::AbstractString)
     dict = load(instance)
     return dict[key]
 end
 
-function Base.get(instance::Instance, key::AbstractString, default::Any)
+function Base.get(instance::AbstractInstance, key::AbstractString, default::Any)
     dict = load(instance)
     return get(dict, key, default)
 end
 
-function remove!(instance::Instance, key::AbstractString)
+function remove!(instance::AbstractInstance, key::AbstractString)
     dict = load(instance)
     delete!(dict, key)
     save(instance, dict)
     return nothing
 end
 
-function clean!(instance::Instance)
+function clean!(instance::AbstractInstance)
     rm(instance.path, force = true)
     return nothing
 end

test/runtests.jl

@@ -3,51 +3,57 @@ using SharedPreferences
 using Aqua
 using Test
 
-function test_all()
-    @testset "Aqua.jl" begin
-        @testset "Ambiguities" begin
-            Aqua.test_ambiguities(SharedPreferences, recursive = false)
-        end
-        Aqua.test_all(SharedPreferences, ambiguities = false)
+function test_aqua()
+    @testset "Ambiguities" begin
+        Aqua.test_ambiguities(SharedPreferences, recursive = false)
     end
+    Aqua.test_all(SharedPreferences, ambiguities = false)
 
-    key = "iZS1EDuzE5dEf3NmN8m3SbwOJEpu4b0i"
+    return nothing
+end
 
-    instance = SharedPreferences.Instance(key)
+function test_shared_preferences(instance::SharedPreferences.AbstractInstance)
     clean!(instance)
 
-    instance = SharedPreferences.Instance(key)
     set!(instance, "string", "value")
     set!(instance, "integer", 42)
     set!(instance, "float", 3.14)
     set!(instance, "boolean", true)
     set!(instance, "array", [1, 2, 3])
 
-    instance = SharedPreferences.Instance(key)
     @test get(instance, "string") == "value"
     @test get(instance, "integer") == 42
     @test get(instance, "float") == 3.14
     @test get(instance, "boolean") == true
     @test get(instance, "array") == [1, 2, 3]
 
-    instance = SharedPreferences.Instance(key)
     remove!(instance, "string")
     remove!(instance, "integer")
     remove!(instance, "float")
     remove!(instance, "boolean")
     remove!(instance, "array")
 
-    instance = SharedPreferences.Instance(key)
     @test_throws KeyError get(instance, "string")
     @test_throws KeyError get(instance, "integer")
     @test_throws KeyError get(instance, "float")
     @test_throws KeyError get(instance, "boolean")
     @test_throws KeyError get(instance, "array")
 
-    instance = SharedPreferences.Instance(key)
     clean!(instance)
 
     return nothing
 end
 
+function test_all()
+    @testset "Aqua.jl" begin test_aqua() end
+
+    instance = SharedPreferences.Instance("vG1Z4i52FR")
+    @testset "instance" begin test_shared_preferences(instance) end
+
+    instance = SharedPreferences.InstanceEncrypted("gIU2iw4p10KnP2HsU5TBJ5Uuj5Khj2R0")
+    @testset "instance encrypted" begin test_shared_preferences(instance) end    
+
+    return nothing
+end
+
 test_all()