Merge pull request #15 from JuliaPostgresORM/generate-typescript

Add generation of typescript model and support for array of custom types

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.6"
+version = "0.1.7"
 
 [deps]
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"

src/Controller/coreORM.utils.part1.jl

@@ -72,6 +72,7 @@ function util_get_entity_props_for_db_actions(entity::IEntity,
                                              columns_selection_and_mapping,
                                              entity_type)
     props = util_replace_enums_by_id_if_needed(props, orm_module, dbconn)
+    props = util_replace_empty_vector_of_enums_by_missing(props)
     props = util_replace_dict_types(props, orm_module, dbconn)
 
 end
@@ -114,6 +115,7 @@ function util_get_entity_props_for_comparison(entity::IEntity,
                                              columns_selection_and_mapping,
                                              entity_type)
     props = util_replace_enums_by_id_if_needed(props,orm_module,dbconn)
+    props = util_replace_empty_vector_of_enums_by_missing(props)
     props = util_replace_dict_types(props,orm_module,dbconn)
 
     return(props)
@@ -421,6 +423,8 @@ function util_dict2entity(props_dict::Dict{Symbol,T},
           # @info props_dict[fsymbol]
           props_dict[fsymbol] =
             PostgresORMUtil.postgresql_string_array_2_string_vector(props_dict[fsymbol])
+      elseif ftype <: Vector{T} where T <: Base.Enums.Enum
+          props_dict[fsymbol] = string2vector_of_enums(ftype,props_dict[fsymbol])
       elseif ftype <: Enum
 
           if ismissing(props_dict[fsymbol])
@@ -899,6 +903,23 @@ function util_replace_enums_by_id_if_needed(props::Dict,
     return props
 end
 
+"""
+    util_replace_empty_vector_of_enums_by_missing(props::Dict)
+
+Replace empty vector of an enum by missing. This allows developers to avoid testing both for
+nullity and emptiness of the property
+"""
+function util_replace_empty_vector_of_enums_by_missing(props::Dict)
+    for (prop_symbol, prop_val) in props
+        if typeof(prop_val) <: Vector{T} where T <: Base.Enums.Enum
+            if isempty(prop_val)
+                props[prop_symbol] = missing
+            end
+        end
+    end
+    return props
+end
+
 function util_replace_dict_types(props::Dict,
                                  orm_module::Module,
                                  dbconn::LibPQ.Connection)

src/PostgresORM.jl

@@ -39,7 +39,7 @@ module PostgresORM
   #   include("./web-api-definition.jl")
   # end
 
-  greet() = return ("Hello World!")
+  greet() = return ("Hello World from PostgresORM!")
 
   module PostgresORMUtil
       using ..PostgresORM
@@ -48,7 +48,8 @@ module PostgresORM
       export opendbconn, closedbconn, dict2namedtuple, namedtuple2dict, tovector,
             get_nonmissing_typeof_uniontype, dataframe2vector_of_namedtuples,
             dataframerow2namedtuple, getdictvalues, getpropertiesvalues,
-            setpropertiesvalues!, remove_spaces_and_split, diff_dict, string2enum,
+            setpropertiesvalues!, remove_spaces_and_split, diff_dict,
+            string2enum, string2vector_of_enums,
             int2enum, enum2int, dictstringkeys2symbol, dictnothingvalues2missing,
             getproperties_asdict, string2zoneddatetime
 
@@ -108,8 +109,9 @@ module PostgresORM
     using ..CRUDType
     using ..PostgresORMUtil, ..SchemaInfo
     # using .ModificationORM # no need (because ModificationORM is a children module ?)
-    using Tables, DataFrames, Query, LibPQ, Dates, UUIDs, TickTock
+    using Tables, DataFrames, Query, LibPQ, Dates, TimeZones, UUIDs, TickTock
     include("./Tool/Tool.jl")
+    include("./Tool/Tool-typescript.jl")
 
   end # module Tool
 

src/PostgresORMUtil/utils.jl

@@ -137,6 +137,27 @@ function string2enum(enumType::DataType,str::String)
 
 end
 
+"""
+"""
+function string2vector_of_enums(vectorOfEnumsTypes::Type{Vector{T}},
+                                str::Union{String,Missing}) where T <: Base.Enums.Enum
+    enumType = eltype(vectorOfEnumsTypes)
+
+    if ismissing(str)
+        return missing
+    end
+
+    # If no element in the array return an empty array
+    if str == "{}"
+        return T[]
+    end
+
+    chop(str,head = 1,tail = 1) |> n -> split(n,",") |>
+        n -> string.(n) |>
+        n -> string2enum.(enumType,n)
+
+end
+
 function string2zoneddatetime(str)
     # eg. "2019-09-03T11:00:00.000Z"
     date_match_GMT =

src/Tool/Tool.jl

@@ -76,11 +76,14 @@ function build_field_name(str_arr::Vector{String},
     return field_name
 end
 
-function get_fieldtype_from_coltype(coltype::String,elttype::String
+function get_fieldtype_from_coltype(coltype::String,
+                                    elttype::String,
+                                    customtypes::Dict,
                                     ;tablename::String = "",
                                      colname::String = "")
 
    attrtype = missing
+   customtypes_names = keys(customtypes) |> collect |> n -> string.(n)
 
    if (coltype == "character"
       || coltype == "character varying"
@@ -110,6 +113,9 @@ function get_fieldtype_from_coltype(coltype::String,elttype::String
    elseif (coltype == "ARRAY")
       if (elttype == "_text" || elttype == "_varchar")
         attrtype = "Vector{String}"
+      elseif elttype[2:end] in customtypes_names
+        elttype = elttype[2:end] # remove the leading underscore
+        attrtype = "Vector{$(build_enum_name_w_module(elttype))}"
       else
         error("Unknown array type[$elttype] for table[$tablename] column[$colname]")
       end
@@ -140,6 +146,7 @@ function generate_julia_code(dbconn::LibPQ.Connection,
 
 end
 
+
 function generate_object_model(
    dbconn::LibPQ.Connection,
    lang_code::String
@@ -222,6 +229,7 @@ function generate_object_model(
                manytoone_field[:is_manytoone] = true
             end
             manytoone_field[:is_onetomany] = false
+            manytoone_field[:is_enum] = false
 
             # Build a field name by one of the following options:
             # Case 1: The FK is composed of one column only. In this case we use
@@ -304,12 +312,19 @@ function generate_object_model(
             id_field[:is_manytoone] = false
             id_field[:is_onetoone] = false
             id_field[:is_onetomany] = false
+            id_field[:is_enum] = false
             field_name = build_field_name(pkcol,lang_code)
             id_field[:name] = field_name
 
             field_type =
                get_fieldtype_from_coltype(tabledef[:cols][pkcol][:type],
-                                          tabledef[:cols][pkcol][:elttype_if_array])
+                                          tabledef[:cols][pkcol][:elttype_if_array],
+                                          custom_types)
+
+            # Check if it is an enum
+            if tabledef[:cols][pkcol][:type] == "USER-DEFINED"
+                id_field[:is_enum] = true
+            end
 
             id_field[:field_type] = field_type
             push!(struct_id_fields, id_field)
@@ -329,14 +344,21 @@ function generate_object_model(
             basic_field[:is_manytoone] = false
             basic_field[:is_onetoone] = false
             basic_field[:is_onetomany] = false
+            basic_field[:is_enum] = false
             field_name = build_field_name(colname,lang_code)
             basic_field[:name] = field_name
 
             field_type =
                get_fieldtype_from_coltype(coldef[:type],
-                                          coldef[:elttype_if_array]
+                                          coldef[:elttype_if_array],
+                                          custom_types
                                           ;tablename = table, colname = colname)
 
+            # Check if it is an enum
+            if coldef[:type] == "USER-DEFINED"
+                basic_field[:is_enum] = true
+            end
+
             basic_field[:field_type] = field_type
             push!(struct_basic_fields, basic_field)
 
@@ -362,6 +384,7 @@ function generate_object_model(
       onetomany_field[:is_manytoone] = false
       onetomany_field[:is_onetoone] = false
       onetomany_field[:is_onetomany] = true
+      onetomany_field[:is_enum] = false
       onetomany_type_name_w_module = manytoone_field[:field_type] # Public.Staff
 
       # Build a field_name using one of the following options:
@@ -496,6 +519,11 @@ function generate_structs_from_object_model(object_model::Dict, outdir::String)
          f[:field_type]
       end
       str = "  $field_name::Union{Missing,$field_type}\n"
+
+      if f[:name] == "policeOfficerRequests"
+        @info "$(f[:name]) -> $str"
+      end
+
       _struct[:struct_content] *= str
    end