import and export all the named ranges in the workbook

Author: hilkoc

README.md

@@ -1,23 +1,30 @@
 VbaDeveloper
 ============
 
-VbaDeveloper is an excel addin for easy version control of all your vba code.
-It will automatically export all your classes and modules to plain text, whenever you save your vba project. In this way changes can easily be committed using git or svn or any other source control system.
+VbaDeveloper is an excel addin for easy version control of all your vba code. If you write VBA code in excel, all your files are stored in binary format. You can commit those, but a version control system cannot do much more than that with them. Merging code from different branches, reverting commits (other than the last one), or viewing differences between two commits is very troublesome for binary files. The VbaDeveloper Addin aims to solve this problem.
 
-VbaDeveloper can also import the code again into your excel workbook. This is particularly useful after reverting an earlier commit or after merging branches. When you open an excel workbook it will ask if you want to import the code for that project.
 
-A code formatter for VBA is also included. It is implemented in VBA and can be directly run as a macro within the VBA Editor, so you can format your code as you write it. The most convenient way to run it is by opening the immediate window and then typing 'format'. This will format the active codepane.
+Features
+--------------
+
+Whenever you save your vba project the addin will *automatically* export all your classes and modules to plain text. In this way your changes can easily be committed using git or svn or any other source control system. You only need to save your VBA project, no other manual steps are needed. It feels like you are working in plain text files.
+
+VbaDeveloper can also import the code again into your excel workbook. This is particularly useful after reverting an earlier commit or after merging branches. Whenever you open an excel workbook it will ask if you want to import the code for that project.
+
+A code formatter for VBA is also included. It is implemented in VBA and can be directly run as a macro within the VBA Editor, so you can format your code as you write it. The most convenient way to run it is by opening the immediate window and then typing ' application.run "format" '. This will format the active codepane.
+
+Besides the vba code, the addin also imports and exports any named ranges. This makes it easy to track in your commit history how those have changed or you can use this feature to easily transport them from one workbook to another.
 
 All functionality is also easily accessible via a menu. Look for the vbaDeveloper menu in the ribbon, under the addins section.
 
 Building the addin
 -----------------------
 
-This repository does not contain the addin itself, only the files needed to build it.  In short it come downs to these steps:
+This repository does not contain the addin itself which is an excel addin in binary format, only the files needed to build it.  In short it come downs to these steps:
 
  - Manually import the Build module into a new excel workbook.
  - Add the required vba references.
  - Save the workbook as an excel add-in.
- - Close it, then open it again and import the other modules.
+ - Close it, then open it again and let the Build module import the other modules.
 
-Detailed instructions can be found in *src/vbaDeveloper.xlam/Build.bas*.
+Read the detailed instructions in *src/vbaDeveloper.xlam/Build.bas*.

src/vbaDeveloper.xlam/Build.bas

@@ -46,33 +46,65 @@ Public Sub testExport()
 End Sub
 
 
+' Returns the directory where code is exported to or imported from.
+' When createIfNotExists:=True, the directory will be created if it does not exist yet.
+' This is desired when we get the directory for exporting.
+' When createIfNotExists:=False and the directory does not exist, an empty String is returned.
+' This is desired when we get the directory for importing.
+'
+' Directory names always end with a '\', unless an empty string is returned.
+' Usually called with: fullWorkbookPath = wb.FullName or fullWorkbookPath = vbProject.fileName
+' if the workbook is new and has never been saved,
+' vbProject.fileName will throw an error while wb.FullName will return a name without slashes.
+Public Function getSourceDir(fullWorkbookPath As String, createIfNotExists As Boolean) As String
+    ' First check if the fullWorkbookPath contains a \.
+    If Not InStr(fullWorkbookPath, "\") > 0 Then
+        'In this case it is a new workbook, we skip it
+        Exit Function
+    End If
+
+    Dim fso As New Scripting.FileSystemObject
+    Dim projDir As String
+    projDir = fso.GetParentFolderName(fullWorkbookPath) & "\"
+    Dim srcDir As String
+    srcDir = projDir & "src\"
+    Dim exportDir As String
+    exportDir = srcDir & fso.GetFileName(fullWorkbookPath) & "\"
+
+    If createIfNotExists Then
+        If Not fso.FolderExists(srcDir) Then
+            fso.CreateFolder srcDir
+            Debug.Print "Created Folder " & srcDir
+        End If
+        If Not fso.FolderExists(exportDir) Then
+            fso.CreateFolder exportDir
+            Debug.Print "Created Folder " & exportDir
+        End If
+    Else
+        If Not fso.FolderExists(exportDir) Then
+            Debug.Print "Folder does not exist: " & exportDir
+            exportDir = ""
+        End If
+    End If
+    getSourceDir = exportDir
+End Function
+
 
 ' Usually called after the given workbook is saved
 Public Sub exportVbaCode(vbaProject As VBProject)
-    'locate and create the export directory if necessary
     Dim vbProjectFileName As String
+    On Error Resume Next
+    'this can throw if the workbook has never been saved.
     vbProjectFileName = vbaProject.fileName
+    On Error GoTo 0
     If vbProjectFileName = "" Then
         'In this case it is a new workbook, we skip it
+        Debug.Print "No file name for project " & vbaProject.name & ", skipping"
         Exit Sub
     End If
 
-    Dim fso As New Scripting.FileSystemObject
-    Dim projDir As String
-    projDir = fso.GetParentFolderName(vbProjectFileName)
-    Dim proj_root As String
-    proj_root = projDir & "\src\"
     Dim export_path As String
-    export_path = proj_root & fso.GetFileName(vbProjectFileName)
-
-    If Not fso.FolderExists(proj_root) Then
-        fso.CreateFolder proj_root
-        Debug.Print "Created Folder " & proj_root
-    End If
-    If Not fso.FolderExists(export_path) Then
-        fso.CreateFolder export_path
-        Debug.Print "Created Folder " & export_path
-    End If
+    export_path = getSourceDir(vbProjectFileName, createIfNotExists:=True)
 
     Debug.Print "exporting to " & export_path
     'export all components
@@ -102,7 +134,7 @@ Private Function hasCodeToExport(component As VBComponent) As Boolean
     hasCodeToExport = True
     If component.codeModule.CountOfLines <= 2 Then
         Dim firstLine As String
-        firstLine = Trim(component.codeModule.Lines(1, 1))
+        firstLine = Trim(component.codeModule.lines(1, 1))
         'Debug.Print firstLine
         hasCodeToExport = Not (firstLine = "" Or firstLine = "Option Explicit")
     End If
@@ -126,14 +158,13 @@ Private Sub exportLines(exportPath As String, component As VBComponent)
     Dim fso As New Scripting.FileSystemObject
     Dim outStream As TextStream
     Set outStream = fso.CreateTextFile(fileName, True, False)
-    outStream.Write (component.codeModule.Lines(1, component.codeModule.CountOfLines))
+    outStream.Write (component.codeModule.lines(1, component.codeModule.CountOfLines))
     outStream.Close
 End Sub
 
 
 ' Usually called after the given workbook is opened
 Public Sub importVbaCode(vbaProject As VBProject)
-    'find project files
     Dim vbProjectFileName As String
     On Error Resume Next
     'this can throw if the workbook has never been saved.
@@ -145,20 +176,11 @@ Public Sub importVbaCode(vbaProject As VBProject)
         Exit Sub
     End If
 
-    Dim fso As New Scripting.FileSystemObject
-    Dim projDir As String
-    projDir = fso.GetParentFolderName(vbProjectFileName)
-    Dim proj_root As String
-    proj_root = projDir & "\src\"
     Dim export_path As String
-    export_path = proj_root & fso.GetFileName(vbProjectFileName)
-
-    If Not fso.FolderExists(proj_root) Then
-        Debug.Print "Could not find folder " & proj_root
-        Exit Sub
-    End If
-    If Not fso.FolderExists(export_path) Then
-        Debug.Print "Could not find folder " & export_path
+    export_path = getSourceDir(vbProjectFileName, createIfNotExists:=False)
+    If export_path = "" Then
+        'The source directory does not exist, code has never been exported for this vbaProject.
+        Debug.Print "No import directory for project " & vbaProject.name & ", skipping"
         Exit Sub
     End If
 
@@ -167,6 +189,7 @@ Public Sub importVbaCode(vbaProject As VBProject)
     Set sheetsToImport = New Dictionary
     Set vbaProjectToImport = vbaProject
 
+    Dim fso As New Scripting.FileSystemObject
     Dim projContents As Folder
     Set projContents = fso.GetFolder(export_path)
     Dim file As Object
@@ -189,6 +212,7 @@ Public Sub importVbaCode(vbaProject As VBProject)
     Debug.Print "almost finished importing code for " & vbaProject.name
 End Sub
 
+
 Private Sub checkHowToImport(file As Object)
     Dim fileName As String
     fileName = file.name
@@ -220,6 +244,7 @@ Private Sub checkHowToImport(file As Object)
     End If
 End Sub
 
+
 ' Only removes the vba component if it exists
 Private Sub removeComponent(vbaProject As VBProject, componentName As String)
     If componentExists(vbaProject, componentName) Then
@@ -230,9 +255,10 @@ Private Sub removeComponent(vbaProject As VBProject, componentName As String)
     End If
 End Sub
 
+
 Public Sub importComponents()
     If componentsToImport Is Nothing Then
-        Debug.Print "Failed to import! 'Dictionary 'componentsToImport' was not initialized."
+        Debug.Print "Failed to import! Dictionary 'componentsToImport' was not initialized."
         Exit Sub
     End If
     Dim componentName As String
@@ -249,12 +275,13 @@ Public Sub importComponents()
     Next
 
     Debug.Print "Finished importing code for " & vbaProjectToImport.name
-    'We're done, clear globals explicitly to free memory
+    'We're done, clear globals explicitly to free memory.
     Set componentsToImport = Nothing
     Set vbaProjectToImport = Nothing
 End Sub
 
-' Assumes any component with same name has already been removed
+
+' Assumes any component with same name has already been removed.
 Private Sub importComponent(vbaProject As VBProject, filePath As String)
     Debug.Print "Importing component from  " & filePath
     vbaProject.VBComponents.Import filePath
@@ -266,7 +293,7 @@ Private Sub importLines(vbaProject As VBProject, file As Object)
     componentName = left(file.name, InStr(file.name, ".") - 1)
     Dim c As VBComponent
     If Not componentExists(vbaProject, componentName) Then
-        'Create a sheet to import this code into. We cannot set the ws.codeName property which is read-only,
+        ' Create a sheet to import this code into. We cannot set the ws.codeName property which is read-only,
         ' instead we set its vbComponent.name which leads to the same result.
         Dim addedSheetCodeName As String
         addedSheetCodeName = addSheetToWorkbook(componentName, vbaProject.fileName)
@@ -276,7 +303,7 @@ Private Sub importLines(vbaProject As VBProject, file As Object)
     Set c = vbaProject.VBComponents(componentName)
     Debug.Print "Importing lines from " & componentName & " into component " & c.name
 
-    ' At this point compilation errors may cause a crash, so we ignore those
+    ' At this point compilation errors may cause a crash, so we ignore those.
     On Error Resume Next
     c.codeModule.DeleteLines 1, c.codeModule.CountOfLines
     c.codeModule.AddFromFile file.Path
@@ -310,6 +337,7 @@ Public Function openWorkbook(ByVal filePath As String) As Workbook
     Set openWorkbook = wb
 End Function
 
+
 ' Returns the CodeName of the added sheet or an empty String if the workbook could not be opened.
 Public Function addSheetToWorkbook(sheetName As String, workbookFilePath As String) As String
     Dim wb As Workbook

src/vbaDeveloper.xlam/ErrorHandling.bas

@@ -1,14 +1,15 @@
 Attribute VB_Name = "ErrorHandling"
 Option Explicit
 
-Public Sub RaiseError(errNumber As Integer, Optional errSource As String = "", Optional errMessage As String = "")
+Public Sub RaiseError(errNumber As Integer, Optional errSource As String = "", Optional errDescription As String = "")
     If errSource = "" Then 'set default values
         errSource = Err.Source
-        errMessage = Err.Description
+        errDescription = Err.Description
     End If
-    Err.Raise vbObjectError + errNumber, errSource, errMessage
+    Err.Raise vbObjectError + errNumber, errSource, errDescription
 End Sub
 
+
 Public Sub handleError(Optional errLocation As String = "")
     Dim errorMessage As String
     errorMessage = "Error in " & errLocation & ", [" & Err.Source & "] : error number " & Err.Number & vbNewLine & Err.Description

src/vbaDeveloper.xlam/Formatter.bas

@@ -165,7 +165,7 @@ Public Sub formatCode(codePane As codeModule)
     Dim lineNr As Integer
     For lineNr = 1 To lineCount
         Dim line As String
-        line = Trim(codePane.Lines(lineNr, 1))
+        line = Trim(codePane.lines(lineNr, 1))
         If Not line = "" Then
             If isEqual(ONEWORD_ELSE, line) _
                 Or lineStartsWith(BEG_END_ELSEIF, line) _
@@ -205,7 +205,7 @@ Public Sub removeIndentation(codePane As codeModule)
     Dim lineNr As Integer
     For lineNr = 1 To lineCount
         Dim line As String
-        line = codePane.Lines(lineNr, 1)
+        line = codePane.lines(lineNr, 1)
         line = Trim(line)
         Call codePane.ReplaceLine(lineNr, line)
     Next
@@ -249,6 +249,7 @@ Private Function lineStartsWith(begin As String, strToCheck As String) As Boolea
 End Function
 
 
-Private Function isLabel(line As String) As Boolean
-    isLabel = (right(line, 1) = ":")
+Public Function isLabel(line As String) As Boolean
+    'it must end with a colon: and may not contain a space.
+    isLabel = (right(line, 1) = ":") And (InStr(line, " ") < 1)
 End Function

src/vbaDeveloper.xlam/Menu.bas

@@ -1,7 +1,7 @@
 Attribute VB_Name = "Menu"
 Option Explicit
 
-Private Const MENU_TITLE = "vbaDeveloper"
+Private Const MENU_TITLE = "VbaDeveloper"
 
 Public Sub createMenu()
     Dim rootMenu As CommandBarPopup
@@ -49,6 +49,7 @@ nextProject:
     On Error GoTo 0 'reset the error handling
 End Sub
 
+
 Private Function addMenuItem(menu As CommandBarPopup, ByVal onAction As String, ByVal caption As String) As CommandBarButton
     Dim menuItem As CommandBarButton
     Set menuItem = menu.Controls.Add(Type:=msoControlButton)
@@ -66,6 +67,7 @@ Private Function addSubmenu(menu As CommandBarPopup, ByVal position As Integer,
     Set addSubmenu = subMenu
 End Function
 
+
 Private Sub addMenuSeparator(menuItem As CommandBarPopup)
     menuItem.BeginGroup = True
 End Sub
@@ -89,6 +91,9 @@ Public Sub exportVbProject(ByVal projectName As String)
     Dim project As VBProject
     Set project = Application.VBE.VBProjects(projectName)
     Build.exportVbaCode project
+    Dim wb As Workbook
+    Set wb = Build.openWorkbook(project.fileName)
+    NamedRanges.exportNamedRanges wb
     MsgBox "Finished exporting code for: " & project.name
 
     On Error GoTo 0
@@ -97,12 +102,16 @@ exportVbProject_Error:
     ErrorHandling.handleError "Menu.exportVbProject"
 End Sub
 
+
 Public Sub importVbProject(ByVal projectName As String)
     On Error GoTo importVbProject_Error
 
     Dim project As VBProject
     Set project = Application.VBE.VBProjects(projectName)
     Build.importVbaCode project
+    Dim wb As Workbook
+    Set wb = Build.openWorkbook(project.fileName)
+    NamedRanges.importNamedRanges wb
     MsgBox "Finished importing code for: " & project.name
 
     On Error GoTo 0
@@ -111,6 +120,7 @@ importVbProject_Error:
     ErrorHandling.handleError "Menu.importVbProject"
 End Sub
 
+
 Public Sub formatVbProject(ByVal projectName As String)
     On Error GoTo formatVbProject_Error
 
@@ -119,7 +129,7 @@ Public Sub formatVbProject(ByVal projectName As String)
     Formatter.formatProject project
     MsgBox "Finished formatting code for: " & project.name & vbNewLine _
     & vbNewLine _
-    & "Did you know you can also format your code, while writing it, by typing 'format' in the immediate window?"
+    & "Did you know you can also format your code, while writing it, by typing 'application.Run ""format""' in the immediate window?"
 
     On Error GoTo 0
     Exit Sub