Remove deprecated class IAppUser

Author: tencnivel

Project.toml

@@ -1,7 +1,7 @@
 name = "PostgresORM"
 uuid = "748b5efa-ed57-4836-b183-a38105a77fdd"
 authors = ["Vincent Laugier <vincent.laugier@gmail.com>"]
-version = "0.1.5"
+version = "0.1.6"
 
 [deps]
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"

docs/src/getting-started.md

@@ -227,3 +227,67 @@ PostgresORM.Tool.generate_julia_code(dbconn,out_dir)
 
 close(dbconn)
 ```
+
+## How to record changes
+
+### Record the changes in the modified class itself
+You can ask PostgresORM to record the following information inside the class itself :
+  - the creator of an instance,
+  - the last editor of an instance,
+  - the creation time  of an instance,
+  - the last edition time  of an instance
+
+To do this you need to declare the following functions in the ORM of the class:
+```
+get_creator_property() = :your_creator_prop
+get_editor_property() = :your_lastEditor_prop
+get_creation_time_property() = :your_creationTime_prop
+get_update_time_property() = :your_updateTime_prop
+```
+
+NOTE: You can decide to only declare some of these functions
+
+### Record the changes in a 'modification' table
+
+You can also ask PostgresORM to record the details of the modifications of a class
+in a table.
+
+To do this you need:
+- Tell the ORM of the class that you want to record the changes
+- A table where to write those modifications
+
+#### Declare the following functions in the ORM of the class:
+```
+get_track_changes() = true
+```
+
+#### The `Modification` table
+
+PostgresORM ships a class `Modification` that inherits from `IEntity`.
+It also has the accompanying ORM mapping module `PostgresORM.ModificationORM`.
+By default, this class is serialized to a table `modification` in the schema `public`.
+
+Here is the SQL for the creation of the table if you want to use the default mapping of ModificationORM:
+
+```
+CREATE TABLE public.modification
+(
+    id uuid NOT NULL DEFAULT uuid_generate_v4(),
+    entity_type character varying COLLATE pg_catalog."default",
+    entity_id character varying COLLATE pg_catalog."default",
+    attrname character varying COLLATE pg_catalog."default",
+    oldvalue text COLLATE pg_catalog."default",
+    user_id character varying COLLATE pg_catalog."default",
+    newvalue text COLLATE pg_catalog."default",
+    action_id uuid,
+    action_type character varying(10) COLLATE pg_catalog."default",
+    creation_time timestamp without time zone,
+    CONSTRAINT modification_pkey PRIMARY KEY (id)
+)
+```
+
+Suppose the modification table is in a different schema, you can tell PostgresORM where it is by overwriting the functions of `PostgresORM.ModificationORM`.
+Eg.
+```
+PostgresORM.ModificationORM.get_schema_name() = "my_schema"
+```

src/Controller/ModificationORM.jl

@@ -526,7 +526,7 @@ function util_dict2entity(props_dict::Dict{Symbol,T},
 
               # Check that the elements type is not abstract
               if isabstracttype(eltype(ptype))
-                  throw(DomainError("Cannot instantiate $ptype because it's a vector of abstract elements. "
+                  throw(DomainError("Cannot instantiate type[$ptype] of property[:$fsymbol] because it's a vector of abstract elements. "
                                   * " Please set a non-abstract vector in 'types_override'"
                                   * " in the ORM[$(PostgresORM.get_orm(dummy_object))]"))
               end
@@ -570,11 +570,11 @@ function util_get_property_real_type(datatype::DataType, propname::Symbol)
 
     # Check if there is a type override for this property, if not we
     #   use the property type
+
     if (isdefined(orm_module,:types_override)
         && propname in collect(keys(orm_module.types_override)))
         ptype = PostgresORM.get_orm(dummy_object).types_override[propname]
     end
-
     return ptype
 end
 

src/Controller/coreORM.utils.part1.jl

@@ -1,7 +1,7 @@
 module PostgresORM
 
   # Exposed types of PostgresORM
-  export IEntity, IAppUser, Modification
+  export IEntity, IEntity, Modification
 
   # Exposed functions of PostgresORM
   export get_orm, create_entity!,create_in_bulk_using_copy,retrieve_entity,
@@ -22,6 +22,13 @@ module PostgresORM
   include("./model/abstract_types.jl")
   include("./model/Modification.jl")
 
+  module ModificationORM
+    using ..PostgresORM
+    # using ..PostgresORMUtil
+    # using ..Controller
+    include("./ModificationORM.jl")
+  end
+
   # This is a failed attempt to put the API in the module.
   # It works, but despite Revise, the web server does not take into account the
   #   changes. Therefore we prefer to have it put in the main module so that we
@@ -85,12 +92,12 @@ module PostgresORM
     include("./Controller/coreORM.delete.jl")
     include("./Controller/coreORM.utils.part2.jl")
 
-    module ModificationORM
-      using ..PostgresORM
-      using ..PostgresORMUtil
-      using ..Controller
-      include("./Controller/ModificationORM.jl")
-    end
+    # module ModificationORM
+    #   using ..PostgresORM
+    #   using ..PostgresORMUtil
+    #   using ..Controller
+    #   include("./Controller/ModificationORM.jl")
+    # end
 
   end # module Controller
 

src/PostgresORM.jl

@@ -2,7 +2,7 @@
 """
     create_entity!(new_object::IEntity,
                    dbconn::LibPQ.Connection;
-                   creator::Union{IAppUser,Missing} = missing)
+                   creator::Union{IEntity,Missing} = missing)
 
 Persists an instance to the database.
 Properties of type vector of IEntity are not persisted
@@ -15,7 +15,7 @@ modification table
 """
 function create_entity!(new_object::IEntity,
                        dbconn::LibPQ.Connection;
-                       creator::Union{IAppUser,Missing} = missing)
+                       creator::Union{IEntity,Missing} = missing)
 
    Controller.create_entity!(new_object,
                              dbconn;
@@ -82,7 +82,7 @@ end
 """
     update_entity!(updated_object::IEntity,
                    dbconn::LibPQ.Connection;
-                   editor::Union{IAppUser,Missing} = missing)
+                   editor::Union{IEntity,Missing} = missing)
 
 Updates an instance to the database.
 Properties of type vector of IEntity are not updated
@@ -95,7 +95,7 @@ modification table
 """
 function update_entity!(updated_object::IEntity,
                        dbconn::LibPQ.Connection;
-                       editor::Union{IAppUser,Missing} = missing
+                       editor::Union{IEntity,Missing} = missing
                        )
     Controller.update_entity!(updated_object,
                               dbconn;
@@ -107,15 +107,15 @@ end
     update_vector_property!(updated_object::IEntity,
                             updated_property::Symbol,
                             dbconn::Union{Missing, LibPQ.Connection};
-                            editor::Union{Missing, IAppUser} = missing)
+                            editor::Union{Missing, IEntity} = missing)
 
 Updates a property of type vector of IEntity
 
 """
 function update_vector_property!(updated_object::IEntity,
                                  updated_property::Symbol,
                                  dbconn::Union{Missing, LibPQ.Connection};
-                                 editor::Union{Missing, IAppUser} = missing)
+                                 editor::Union{Missing, IEntity} = missing)
 
       Controller.update_vector_property!(updated_object,
                                         updated_property,
@@ -127,13 +127,13 @@ end
 """
     delete_entity(deleted_object::IEntity,
                   dbconn::LibPQ.Connection;
-                  editor::Union{IAppUser,Missing} = missing)
+                  editor::Union{IEntity,Missing} = missing)
 
 Deletes an entity on the basis of its ID
 """
 function delete_entity(deleted_object::IEntity,
                        dbconn::LibPQ.Connection;
-                       editor::Union{IAppUser,Missing} = missing
+                       editor::Union{IEntity,Missing} = missing
                        )
     Controller.delete_entity(deleted_object,
                              dbconn;
@@ -144,13 +144,13 @@ end
 """
     delete_entity_alike(filter_object::IEntity,
                         dbconn::LibPQ.Connection;
-                        editor::Union{IAppUser,Missing} = missing)
+                        editor::Union{IEntity,Missing} = missing)
 
 Deletes all entities matching the the filter
 """
 function delete_entity_alike(filter_object::IEntity,
                        dbconn::LibPQ.Connection;
-                       editor::Union{IAppUser,Missing} = missing
+                       editor::Union{IEntity,Missing} = missing
                        )
     Controller.delete_entity_alike(filter_object,
                                    dbconn;

src/exposed-functions-from-submodules.jl

@@ -3,5 +3,3 @@
 #
 abstract type IEntity end
 abstract type IModification <: IEntity end
-abstract type IAppUser <: IEntity end # DEPRECATED, kept because some applications
-                                      #  where inheriting from this class