-
-
Notifications
You must be signed in to change notification settings - Fork 724
/
DirectoryPath.cs
184 lines (167 loc) · 6.59 KB
/
DirectoryPath.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.Linq;
namespace Cake.Core.IO
{
/// <summary>
/// Represents a directory path.
/// </summary>
public sealed class DirectoryPath : Path
{
/// <summary>
/// Initializes a new instance of the <see cref="DirectoryPath"/> class.
/// </summary>
/// <param name="path">The path.</param>
public DirectoryPath(string path)
: base(path)
{
}
/// <summary>
/// Gets the name of the directory.
/// </summary>
/// <returns>The directory name.</returns>
/// <remarks>
/// If this is passed a file path, it will return the file name.
/// This is by-and-large equivalent to how DirectoryInfo handles this scenario.
/// If we wanted to return the *actual* directory name, we'd need to pull in IFileSystem,
/// and do various checks to make sure things exists.
/// </remarks>
public string GetDirectoryName()
{
return Segments.Last();
}
/// <summary>
/// Combines the current path with the file name of a <see cref="FilePath"/>.
/// </summary>
/// <param name="path">The path.</param>
/// <returns>A combination of the current path and the file name of the provided <see cref="FilePath"/>.</returns>
public FilePath GetFilePath(FilePath path)
{
if (path == null)
{
throw new ArgumentNullException(nameof(path));
}
return new FilePath(PathHelper.Combine(FullPath, path.GetFilename().FullPath));
}
/// <summary>
/// Combines the current path with a <see cref="FilePath"/>.
/// The provided <see cref="FilePath"/> must be relative.
/// </summary>
/// <param name="path">The path.</param>
/// <returns>A combination of the current path and the provided <see cref="FilePath"/>.</returns>
public FilePath CombineWithFilePath(FilePath path)
{
if (path == null)
{
throw new ArgumentNullException(nameof(path));
}
if (!path.IsRelative)
{
throw new InvalidOperationException("Cannot combine a directory path with an absolute file path.");
}
return new FilePath(PathHelper.Combine(FullPath, path.FullPath));
}
/// <summary>
/// Combines the current path with another <see cref="DirectoryPath"/>.
/// The provided <see cref="DirectoryPath"/> must be relative.
/// </summary>
/// <param name="path">The path.</param>
/// <returns>A combination of the current path and the provided <see cref="DirectoryPath"/>.</returns>
public DirectoryPath Combine(DirectoryPath path)
{
if (path == null)
{
throw new ArgumentNullException(nameof(path));
}
if (!path.IsRelative)
{
throw new InvalidOperationException("Cannot combine a directory path with an absolute directory path.");
}
return new DirectoryPath(PathHelper.Combine(FullPath, path.FullPath));
}
/// <summary>
/// Makes the path absolute to another (absolute) path.
/// </summary>
/// <param name="path">The path.</param>
/// <returns>An absolute path.</returns>
public DirectoryPath MakeAbsolute(DirectoryPath path)
{
if (path == null)
{
throw new ArgumentNullException(nameof(path));
}
if (path.IsRelative)
{
throw new CakeException("The provided path cannot be relative.");
}
return IsRelative
? path.Combine(this).Collapse()
: new DirectoryPath(FullPath);
}
/// <summary>
/// Makes the path absolute (if relative) using the current working directory.
/// </summary>
/// <param name="environment">The environment.</param>
/// <returns>An absolute path.</returns>
public DirectoryPath MakeAbsolute(ICakeEnvironment environment)
{
if (environment == null)
{
throw new ArgumentNullException(nameof(environment));
}
return IsRelative
? environment.WorkingDirectory.Combine(this).Collapse()
: new DirectoryPath(FullPath);
}
/// <summary>
/// Collapses a <see cref="DirectoryPath"/> containing ellipses.
/// </summary>
/// <returns>A collapsed <see cref="DirectoryPath"/>.</returns>
public DirectoryPath Collapse()
{
return new DirectoryPath(PathCollapser.Collapse(this));
}
/// <summary>
/// Performs an implicit conversion from <see cref="System.String"/> to <see cref="DirectoryPath"/>.
/// </summary>
/// <param name="path">The path.</param>
/// <returns>A <see cref="DirectoryPath"/>.</returns>
public static implicit operator DirectoryPath(string path)
{
return path is null ? null : FromString(path);
}
/// <summary>
/// Performs a conversion from <see cref="System.String"/> to <see cref="DirectoryPath"/>.
/// </summary>
/// <param name="path">The path.</param>
/// <returns>A <see cref="DirectoryPath"/>.</returns>
public static DirectoryPath FromString(string path)
{
return new DirectoryPath(path);
}
/// <summary>
/// Get the relative path to another directory.
/// </summary>
/// <param name="to">The target directory path.</param>
/// <returns>A <see cref="DirectoryPath"/>.</returns>
public DirectoryPath GetRelativePath(DirectoryPath to)
{
return RelativePathResolver.Resolve(this, to);
}
/// <summary>
/// Get the relative path to another file.
/// </summary>
/// <param name="to">The target file path.</param>
/// <returns>A <see cref="FilePath"/>.</returns>
public FilePath GetRelativePath(FilePath to)
{
if (to == null)
{
throw new ArgumentNullException(nameof(to));
}
return GetRelativePath(to.GetDirectory()).GetFilePath(to.GetFilename());
}
}
}