Mercurial > repos > public > matlab_path_manager

annotate +mpm/MatlabPathManager.m @ 35:3a28f6de13c2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add function to test if a folder is project
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 02 Nov 2018 13:10:57 +0100
parents cbeef8175d59
children 16d56bf04117
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
1 classdef MatlabPathManager
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
2 properties
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
3 projectFileName = '.subpaths';
23
0b4be0d4e207 Use new class for state management
Jonatan Werpers <jonatan@werpers.com>
parents: 19
diff changeset
4 stateFileName = 'state';
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
5 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
6
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
7 methods
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
8 function obj = MatlabPathManager()
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
9 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
10
24
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
11 function p = installLocation(obj)
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
12 nameCurrentFile = mfilename('fullpath');
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
13 pathParts = split(nameCurrentFile, filesep);
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
14
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
15 p = join(pathParts(1:end-2), filesep);
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
16 p = p{1};
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
17 end
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
18
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
19 function p = stateFilePath(obj)
24
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
20 p = fullfile(obj.installLocation(), obj.stateFileName);
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
21 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
22
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
23 % Load a given subpath into the state file and the matlab path and do savepath(), atomically
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
24 function loadSubpath(obj, p)
23
0b4be0d4e207 Use new class for state management
Jonatan Werpers <jonatan@werpers.com>
parents: 19
diff changeset
25 state = mpm.PersistentState(obj.stateFilePath);
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
26
18
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
27 addpath(p);
25
e2c18217aee0 Fix some reference errors
Jonatan Werpers <jonatan@werpers.com>
parents: 24
diff changeset
28 state.subpaths(p) = true;
23
0b4be0d4e207 Use new class for state management
Jonatan Werpers <jonatan@werpers.com>
parents: 19
diff changeset
29 state.saveState();
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
30
27
05a8b30ee4a7 Make loaded paths persistent across matlab restarts
Jonatan Werpers <jonatan@werpers.com>
parents: 25
diff changeset
31 savepath() % after save state to make sure saved paths are always present in the state
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
32 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
33
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
34 % Unload a given subpath from the state file and the matlab path and do savepath(), atomically
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
35 function unloadSubpath(obj, p)
23
0b4be0d4e207 Use new class for state management
Jonatan Werpers <jonatan@werpers.com>
parents: 19
diff changeset
36 state = mpm.PersistentState(obj.stateFilePath);
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
37
18
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
38 rmpath(p);
27
05a8b30ee4a7 Make loaded paths persistent across matlab restarts
Jonatan Werpers <jonatan@werpers.com>
parents: 25
diff changeset
39 savepath() % before save state to make sure saved paths are always present in the state
25
e2c18217aee0 Fix some reference errors
Jonatan Werpers <jonatan@werpers.com>
parents: 24
diff changeset
40 state.subpaths.remove(p);
23
0b4be0d4e207 Use new class for state management
Jonatan Werpers <jonatan@werpers.com>
parents: 19
diff changeset
41 state.saveState();
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
42 end
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
43
35
3a28f6de13c2 Add function to test if a folder is project
Jonatan Werpers <jonatan@werpers.com>
parents: 32
diff changeset
44 function b = isProject(obj, projectFolder)
3a28f6de13c2 Add function to test if a folder is project
Jonatan Werpers <jonatan@werpers.com>
parents: 32
diff changeset
45 b = exist(fullfile(projectFolder, obj.projectFileName), 'file');
3a28f6de13c2 Add function to test if a folder is project
Jonatan Werpers <jonatan@werpers.com>
parents: 32
diff changeset
46 end
3a28f6de13c2 Add function to test if a folder is project
Jonatan Werpers <jonatan@werpers.com>
parents: 32
diff changeset
47
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
48 % Read project file in a folder and return cell array of all subpaths
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
49 function sp = projectSubpaths(obj, projectFolder)
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
50 try
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
51 fstr = fileread(fullfile(projectFolder, obj.projectFileName));
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
52 catch
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
53 error('Subpath definition file ''%s'' not found.', obj.projectFileName);
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
54 end
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
55 sp = splitlines(strtrim(fstr));
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
56 end
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
57
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
58 function s = loadedSubpaths(obj)
23
0b4be0d4e207 Use new class for state management
Jonatan Werpers <jonatan@werpers.com>
parents: 19
diff changeset
59 state = mpm.PersistentState(obj.stateFilePath);
32
cbeef8175d59 Make .loadedSubpath return paths in the order they appear on the matlab path
Jonatan Werpers <jonatan@werpers.com>
parents: 30
diff changeset
60 s_unordered = state.subpaths.keys();
cbeef8175d59 Make .loadedSubpath return paths in the order they appear on the matlab path
Jonatan Werpers <jonatan@werpers.com>
parents: 30
diff changeset
61
cbeef8175d59 Make .loadedSubpath return paths in the order they appear on the matlab path
Jonatan Werpers <jonatan@werpers.com>
parents: 30
diff changeset
62 mpath = obj.matlabPath();
cbeef8175d59 Make .loadedSubpath return paths in the order they appear on the matlab path
Jonatan Werpers <jonatan@werpers.com>
parents: 30
diff changeset
63 [ok, I] = ismember(s_unordered, mpath);
cbeef8175d59 Make .loadedSubpath return paths in the order they appear on the matlab path
Jonatan Werpers <jonatan@werpers.com>
parents: 30
diff changeset
64 s = mpath(sort(I));
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
65 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
66
18
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
67 function ps = matlabPath(obj)
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
68 ps = split(path(), pathsep);
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
69 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
70
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
71 % Load all subpaths for a project
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
72 function checkin(obj, projectFolder)
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
73 sp = obj.projectSubpaths(projectFolder);
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
74
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
75 for i = 1:length(sp)
18
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
76 fullSubpath = fullfile(projectFolder, sp{i});
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
77 obj.loadSubpath(fullSubpath);
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
78 end
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
79 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
80
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
81 % Unload all subpaths for a project
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
82 function checkout(obj, projectFolder)
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
83 sp = obj.projectSubpaths(projectFolder);
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
84
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
85 for i = 1:length(sp)
18
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
86 fullSubpath = fullfile(projectFolder, sp{i});
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
87 obj.unloadSubpath(fullSubpath);
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
88 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
89 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
90
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
91 % Check if the projects settings are correct
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
92 % Is the project file correct?
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
93 % The right version is in the matlab path
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
94 % The right version is at the top of the path
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
95 function b = verify(obj, projectFolder)
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
96 mpath = obj.matlabPath();
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
97 sp = obj.projectSubpaths(projectFolder);
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
98
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
99 for i = 1:length(sp)
30
d9f899b1dfd0 Add status command and make subpathIsActive a static method
Jonatan Werpers <jonatan@werpers.com>
parents: 29
diff changeset
100 if ~obj.subpathIsActive(fullfile(projectFolder,sp{i}), mpath)
18
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
101 b = false;
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
102 return;
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
103 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
104 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
105 b = true;
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
106 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
107
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
108 % Unload all loaded subpaths. The matlab path should be returned to it's original state
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
109 function clear(obj)
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
110 sp = obj.loadedSubpaths();
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
111
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
112 for i = 1:length(sp)
25
e2c18217aee0 Fix some reference errors
Jonatan Werpers <jonatan@werpers.com>
parents: 24
diff changeset
113 obj.unloadSubpath(sp{i});
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
114 end
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
115 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
116 end
24
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
117
30
d9f899b1dfd0 Add status command and make subpathIsActive a static method
Jonatan Werpers <jonatan@werpers.com>
parents: 29
diff changeset
118 methods (Static)
d9f899b1dfd0 Add status command and make subpathIsActive a static method
Jonatan Werpers <jonatan@werpers.com>
parents: 29
diff changeset
119 % Test if the path p is active among folders in path with the same final foldername
d9f899b1dfd0 Add status command and make subpathIsActive a static method
Jonatan Werpers <jonatan@werpers.com>
parents: 29
diff changeset
120 function b = subpathIsActive(p, paths)
d9f899b1dfd0 Add status command and make subpathIsActive a static method
Jonatan Werpers <jonatan@werpers.com>
parents: 29
diff changeset
121 pathparts = split(p, filesep);
d9f899b1dfd0 Add status command and make subpathIsActive a static method
Jonatan Werpers <jonatan@werpers.com>
parents: 29
diff changeset
122 foldername = pathparts{end};
28
0842a1b2ac7e Factor out function for checking if a subpath is active
Jonatan Werpers <jonatan@werpers.com>
parents: 27
diff changeset
123
30
d9f899b1dfd0 Add status command and make subpathIsActive a static method
Jonatan Werpers <jonatan@werpers.com>
parents: 29
diff changeset
124 for i = 1:length(paths)
d9f899b1dfd0 Add status command and make subpathIsActive a static method
Jonatan Werpers <jonatan@werpers.com>
parents: 29
diff changeset
125 if ~endsWith(paths{i}, foldername)
d9f899b1dfd0 Add status command and make subpathIsActive a static method
Jonatan Werpers <jonatan@werpers.com>
parents: 29
diff changeset
126 % Ignore files with different end foldername
d9f899b1dfd0 Add status command and make subpathIsActive a static method
Jonatan Werpers <jonatan@werpers.com>
parents: 29
diff changeset
127 continue
d9f899b1dfd0 Add status command and make subpathIsActive a static method
Jonatan Werpers <jonatan@werpers.com>
parents: 29
diff changeset
128 end
28
0842a1b2ac7e Factor out function for checking if a subpath is active
Jonatan Werpers <jonatan@werpers.com>
parents: 27
diff changeset
129
30
d9f899b1dfd0 Add status command and make subpathIsActive a static method
Jonatan Werpers <jonatan@werpers.com>
parents: 29
diff changeset
130 b = strcmp(p, paths{i});
d9f899b1dfd0 Add status command and make subpathIsActive a static method
Jonatan Werpers <jonatan@werpers.com>
parents: 29
diff changeset
131 return
d9f899b1dfd0 Add status command and make subpathIsActive a static method
Jonatan Werpers <jonatan@werpers.com>
parents: 29
diff changeset
132 end
d9f899b1dfd0 Add status command and make subpathIsActive a static method
Jonatan Werpers <jonatan@werpers.com>
parents: 29
diff changeset
133
d9f899b1dfd0 Add status command and make subpathIsActive a static method
Jonatan Werpers <jonatan@werpers.com>
parents: 29
diff changeset
134 b = false;
d9f899b1dfd0 Add status command and make subpathIsActive a static method
Jonatan Werpers <jonatan@werpers.com>
parents: 29
diff changeset
135 end
28
0842a1b2ac7e Factor out function for checking if a subpath is active
Jonatan Werpers <jonatan@werpers.com>
parents: 27
diff changeset
136 end
0842a1b2ac7e Factor out function for checking if a subpath is active
Jonatan Werpers <jonatan@werpers.com>
parents: 27
diff changeset
137 end
0842a1b2ac7e Factor out function for checking if a subpath is active
Jonatan Werpers <jonatan@werpers.com>
parents: 27
diff changeset
138
24
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
139 % TODO: Organize order of methods
25
e2c18217aee0 Fix some reference errors
Jonatan Werpers <jonatan@werpers.com>
parents: 24
diff changeset
140 % TODO: Add flag for being persistent or not? (savepath or not)