Improve export/import of VBE forms

VBE form export and import is now working correctly again. We have changed the primary source file for this component to be the serialized json file, which will highlight changes much better than the form definition (which doesn't actually include any of the control layout).

Author: joyfullservice

Version Control.accda.src/dbs-properties.json

@@ -41,7 +41,7 @@
       "Type": 10
     },
     "AppVersion": {
-      "Value": "4.0.21",
+      "Value": "4.0.22",
       "Type": 10
     },
     "Auto Compact": {

Version Control.accda.src/modules/clsDbVbeForm.cls

@@ -47,6 +47,7 @@ Implements IDbComponent
 Private Sub IDbComponent_Export(Optional strAlternatePath As String)
 
     Dim strContent As String
+    Dim strBasePath As String
     Dim strJsonPath  As String
     Dim strFormPath As String
     Dim strBinaryPath As String
@@ -55,30 +56,33 @@ Private Sub IDbComponent_Export(Optional strAlternatePath As String)
     ' Get the JSON representation of the current database object
     strContent = GetSource
 
-    ' Before exporting the file, let's see if the source files exist, just in case
-    ' the database object already matches the source file.
-    If strAlternatePath = vbNullString Then
-
-        ' Build out all three source file paths.
-        strJsonPath = IDbComponent_BaseFolder & GetSafeFileName(m_Form.Name) & ".json"
-        strBinaryPath = IDbComponent_BaseFolder & GetSafeFileName(m_Form.Name) & ".frx"
-        strFormPath = IDbComponent_BaseFolder & GetSafeFileName(m_Form.Name) & ".frm"
+    ' Build out all three normal source file paths.
+    strBasePath = IDbComponent_BaseFolder & GetSafeFileName(m_Form.Name)
+    strJsonPath = strBasePath & ".json"
+    strBinaryPath = strBasePath & ".frx"
+    strFormPath = strBasePath & ".frm"
 
-        ' See if all three files already exist.
-        If FSO.FileExists(strJsonPath) And FSO.FileExists(strBinaryPath) And FSO.FileExists(strFormPath) Then
-            ' If so, compare the hash of the json file to the database object.
-            blnUnchanged = (GetStringHash(strContent, True) = GetFileHash(strJsonPath))
-        End If
+    ' Before exporting the VBE file, let's see if the source files exist, just in case
+    ' the database object already matches the source file.
+    If FSO.FileExists(strJsonPath) And FSO.FileExists(strBinaryPath) And FSO.FileExists(strFormPath) Then
+        ' If so, compare the hash of the json file to the database object.
+        blnUnchanged = (GetStringHash(strContent, True) = GetFileHash(strJsonPath))
     End If
 
     ' This is the serialized output file in JSON format to track changes in version control
-    WriteFile strContent, Nz2(strAlternatePath, IDbComponent_BaseFolder & GetSafeFileName(m_Form.Name) & ".json")
+    ' Always ouput this file during an export
+    WriteFile strContent, strJsonPath
 
-    ' Only export the VBE object (including binary source) if the form has changed.
+    ' Only export the VBE object (including binary source) if the form has changed
+    ' or if the VBE files are missing in the original source location
     If Not blnUnchanged Then
-
-        ' This is the binary export file used when building from source
-        m_Form.Export IDbComponent_SourceFile
+        If Len(strAlternatePath) Then
+            ' Save to alternate path
+            m_Form.Export SwapExtension(strAlternatePath, "frm")
+        Else
+            ' This is the binary export file used when building from source
+            m_Form.Export strFormPath
+        End If
     End If
 
     ' Update index with a hash of the serialized content. (Since the binary content changes frequently)
@@ -97,17 +101,33 @@ End Sub
 Private Sub IDbComponent_Import(strFile As String)
 
     Dim proj As VBProject
+    Dim strTestFile As String
 
     If DebugMode(True) Then On Error GoTo 0 Else On Error Resume Next
 
-    ' Only import files with the correct extension.
-    If Not strFile Like "*.frm" Then Exit Sub
+    ' Only import files with the correct (primary) extension.
+    If Not strFile Like "*.json" Then Exit Sub
+
+    ' Make sure the other two companion files also exist
+    strTestFile = SwapExtension(strFile, "frm")
+    If Not FSO.FileExists(strTestFile) Then
+        Log.Error eelError, "VBE Form definition file not found: " & strTestFile, ModuleName(Me) & ".Import"
+        Exit Sub
+    Else
+        ' Check binary file
+        strTestFile = SwapExtension(strFile, "frx")
+        If Not FSO.FileExists(strTestFile) Then
+            Log.Error eelError, "VBE Form binary file not found: " & strTestFile, ModuleName(Me) & ".Import"
+            Exit Sub
+        End If
+    End If
 
+    ' With the files verified, we can move forward with the actual import
     Set proj = CurrentVBProject
     With proj.VBComponents
 
-        ' Import the source file
-        .Import strFile
+        ' Import the VBE source file
+        .Import SwapExtension(strFile, "frm")
 
         ' Set reference to form after import
         Set m_Form = .Item(GetObjectNameFromFileName(strFile))
@@ -127,8 +147,9 @@ Private Sub IDbComponent_Import(strFile As String)
     End With
 
     ' Update index (based on serialized representation)
-    VCSIndex.Update Me, eatImport, GetDictionaryHash(GetDictionary)
+    VCSIndex.Update Me, eatImport, GetStringHash(GetSource, True)
 
+    ' Log any errors while importing the VBE form
     CatchAny eelError, "Error importing " & strFile, ModuleName(Me) & ".Import"
 
 End Sub
@@ -179,8 +200,8 @@ End Sub
 '
 Private Sub IDbComponent_MoveSource(strFromFolder As String, strToFolder As String)
     MoveFileIfExists strFromFolder & FSO.GetFileName(IDbComponent_SourceFile), strToFolder
+    MoveFileIfExists strFromFolder & FSO.GetBaseName(IDbComponent_SourceFile) & ".frm", strToFolder
     MoveFileIfExists strFromFolder & FSO.GetBaseName(IDbComponent_SourceFile) & ".frx", strToFolder
-    MoveFileIfExists strFromFolder & FSO.GetBaseName(IDbComponent_SourceFile) & ".json", strToFolder
 End Sub
 
 
@@ -249,7 +270,7 @@ End Function
 '---------------------------------------------------------------------------------------
 '
 Private Function IDbComponent_GetFileList() As Dictionary
-    If m_FileList Is Nothing Then Set m_FileList = GetFilePathsInFolder(IDbComponent_BaseFolder, "*.frm")
+    If m_FileList Is Nothing Then Set m_FileList = GetFilePathsInFolder(IDbComponent_BaseFolder, "*.json")
     Set IDbComponent_GetFileList = m_FileList
 End Function
 
@@ -366,7 +387,7 @@ End Property
 '
 Private Property Get IDbComponent_SourceFile() As String
     If m_Form Is Nothing Then Exit Property
-    IDbComponent_SourceFile = IDbComponent_BaseFolder & GetSafeFileName(m_Form.Name) & ".frm"
+    IDbComponent_SourceFile = IDbComponent_BaseFolder & GetSafeFileName(m_Form.Name) & ".json"
 End Property
 
 

Version Control.accda.src/modules/modFunctions.bas

@@ -877,6 +877,21 @@ Public Function DeDupString(strText As String, strDuplicated As String) As Strin
 End Function
 
 
+'---------------------------------------------------------------------------------------
+' Procedure : SwapExtension
+' Author    : Adam Waller
+' Date      : 8/9/2023
+' Purpose   : Return the file path with a different file extension.
+'           : I.e.  c:\test.bas > c:\test.cls
+'---------------------------------------------------------------------------------------
+'
+Public Function SwapExtension(strFilePath As String, strNewExtension As String) As String
+    Dim strCurrentExt As String
+    strCurrentExt = FSO.GetExtensionName(strFilePath)
+    SwapExtension = Left(strFilePath, Len(strFilePath) - Len(strCurrentExt)) & strNewExtension
+End Function
+
+
 '---------------------------------------------------------------------------------------
 ' Procedure : LikeAny
 ' Author    : Adam Waller

Version Control.accda.src/vbe-project.json

@@ -5,7 +5,7 @@
   },
   "Items": {
     "Name": "MSAccessVCS",
-    "Description": "Version 4.0.21 deployed on 9/6/2023",
+    "Description": "Version 4.0.22 deployed on 9/20/2023",
     "FileName": "Version Control.accda",
     "HelpFile": "",
     "HelpContextId": 0,

Version Control.accda.src/vcs-options.json

@@ -1,6 +1,6 @@
 {
   "Info": {
-    "AddinVersion": "4.0.21",
+    "AddinVersion": "4.0.22",
     "AccessVersion": "14.0 32-bit"
   },
   "Options": {