refactor(install): Detect requirements already installed.

Author: mgcooper

icemodel/+icemodel/+internal/installRequiredFiles.m

@@ -140,7 +140,7 @@
 end
 
 function [requirementsList, urlList] = remoteDependencyList( ...
-      requiredFiles, projectPath, localsource, remotesource)
+      requiredFiles, projectPath, localSourcePath, remoteSourcePath)
    %REMOTEDEPENDENCYLIST Get a list of remote url's to function dependencies.
 
    % This operates on one file at a time
@@ -161,20 +161,25 @@
 
       % If the required file exists in the local source repo, add it to the
       % requirementsList and build a full path to the remote file.
-      if contains(requiredFilePath, localsource)
+
+      % Note - this is problematic if the requiredFiles contain files which are
+      % not in localSourcePath e.g. if one project depends on another. So this
+      % needs to be refactored to work with localSourcePaths (plural).
+
+      if contains(requiredFilePath, localSourcePath)
 
          % Add file names to list of external depencies
          requirementsList(ifile) = requiredFileName;
 
          % Get the subfolder path relative to the top-level source repo
-         relativePath = erase(requiredFilePath, localsource);
+         relativePath = erase(requiredFilePath, localSourcePath);
          relativePath = strrep(relativePath, filesep , '/');
          if relativePath(1) == filesep
             relativePath = relativePath(2:end);
          end
 
          % Use '/' not fullfile b/c fullfile is platform specific
-         urlList(ifile) = remotesource + '/' + relativePath + '/' ...
+         urlList(ifile) = remoteSourcePath + '/' + relativePath + '/' ...
             + requirementsList(ifile);
       end
    end

icemodel/+icemodel/+internal/private/getRequiredFiles.m

@@ -88,8 +88,14 @@
    % Call codetools.requiredFilesAndProducts on the file list
    [requiredFiles, requiredProducts] = processFileList(targetFiles);
 
+   % Remove required files which are listed twice - once because they already
+   % exist in the reference list, and again because they are
+   [requiredFiles, installedFiles] = detectInstalledFiles( ...
+      requiredFiles, referenceFiles);
+
    % Find missing files (required files not included in the project)
    missingFiles = setdiff(requiredFiles, referenceFiles);
+   missingFiles = setdiff(missingFiles, installedFiles);
    missingFiles = string(missingFiles);
    requiredFiles = string(requiredFiles);
 
@@ -103,6 +109,49 @@
    Requirements.requiredProducts = requiredProducts;
 end
 
+function [requiredFiles, installedFiles] = detectInstalledFiles( ...
+      requiredFiles, referenceFiles)
+
+   % If the required files exist both within the project (e.g. b/c they were
+   % already installed with this function) and elsewhere on the path (e.g. in
+   % the localSourcePath used by installRequiredFiles), they may be listed twice
+   % in requiredFiles, but only once in referenceFiles (the installed ones).
+   % This may occur b/c matlab.codetools.requiredFilesAndProducts finds them in
+   % localSourcePath first (b/c it is higher on the path), and then finds them
+   % in their installed location within the project. Then the setdiff above only
+   % removes the ones which are installed locally. The next step prunes the ones
+   % which exist locally but are listed as missing. Note, the desired behavior
+   % is unclear here - they could be reinstalled by default.
+
+   % installedFiles are the ones in localSourcePath, not the ones already in the
+   % toolbox b/c those are in referenceList.
+
+   % Extract file names without paths
+   [~, requiredFilenames] = fileparts(requiredFiles);
+   [~, referenceFilenames] = fileparts(referenceFiles);
+
+   % Find duplicates in requiredFilenames
+   [uniqueFilenames, ia, ic] = unique(requiredFilenames, 'stable');
+   duplicateIndices = setdiff(1:numel(requiredFilenames), ia);
+
+   % Filter to get filenames that appear more than once in requiredFiles
+   isDuplicate = accumarray(ic, 1) > 1;
+   duplicateFilenames = uniqueFilenames(isDuplicate);
+
+   % Find which of these duplicate filenames are also in the referenceFiles
+   installedFileIndices = ismember(requiredFilenames, duplicateFilenames) & ...
+      ismember(requiredFilenames, referenceFilenames);
+
+   % Extract the actual paths of these installed files from requiredFiles
+   installedDuplicateFiles = requiredFiles(installedFileIndices);
+
+   % Get the list of installed files (files identified as required but which
+   % already exist in the toolbox).
+   installedFiles = installedDuplicateFiles(~ismember(installedDuplicateFiles, ...
+      referenceFiles));
+end
+
+
 %% Local Functions
 function [requiredFiles, requiredProducts] = processFileList(fileList)
 
@@ -234,3 +283,4 @@
       end
    end
 end
+