Skip to content

Commit

Permalink
Deprecate duplicated enum LocalPackageType -> PlacementLocation
Browse files Browse the repository at this point in the history 
Two enums, both have the same values, in the same order.
  • Loading branch information
@Geod24
Geod24 committed Aug 1, 2022
1 parent 67a58e4 commit da98e59
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 32 deletions.
8 changes: 4 additions & 4 deletions source/dub/commandline.d
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2190,7 +2190,7 @@ class AddOverrideCommand : Command {
{
enforceUsage(app_args.length == 0, "Unexpected application arguments.");
enforceUsage(free_args.length == 3, "Expected three arguments, not "~free_args.length.to!string);
auto scope_ = m_system ? LocalPackageType.system : LocalPackageType.user;
auto scope_ = m_system ? PlacementLocation.system : PlacementLocation.user;
auto pack = free_args[0];
auto ver = Dependency(free_args[1]);
if (existsFile(NativePath(free_args[2]))) {
Expand Down Expand Up @@ -2232,7 +2232,7 @@ class RemoveOverrideCommand : Command {
{
enforceUsage(app_args.length == 0, "Unexpected application arguments.");
enforceUsage(free_args.length == 2, "Expected two arguments, not "~free_args.length.to!string);
auto scope_ = m_system ? LocalPackageType.system : LocalPackageType.user;
auto scope_ = m_system ? PlacementLocation.system : PlacementLocation.user;
dub.packageManager.removeOverride(scope_, free_args[0], Dependency(free_args[1]));
return 0;
}
Expand Down Expand Up @@ -2260,8 +2260,8 @@ class ListOverridesCommand : Command {
else logInfo("%s %s => %s", ovr.package_, ovr.version_, ovr.targetVersion);
}
}
printList(dub.packageManager.getOverrides(LocalPackageType.user), "User wide overrides");
printList(dub.packageManager.getOverrides(LocalPackageType.system), "System wide overrides");
printList(dub.packageManager.getOverrides(PlacementLocation.user), "User wide overrides");
printList(dub.packageManager.getOverrides(PlacementLocation.system), "System wide overrides");
return 0;
}
}
Expand Down
8 changes: 4 additions & 4 deletions source/dub/dub.d
View file
Original file line number Diff line number Diff line change
Expand Up @@ -964,7 +964,7 @@ class Dub {
void addLocalPackage(string path, string ver, bool system)
{
if (m_dryRun) return;
m_packageManager.addLocalPackage(makeAbsolute(path), ver, system ? LocalPackageType.system : LocalPackageType.user);
m_packageManager.addLocalPackage(makeAbsolute(path), ver, system ? PlacementLocation.system : PlacementLocation.user);
}

/** Removes a directory from the list of locally known packages.
Expand All @@ -981,7 +981,7 @@ class Dub {
void removeLocalPackage(string path, bool system)
{
if (m_dryRun) return;
m_packageManager.removeLocalPackage(makeAbsolute(path), system ? LocalPackageType.system : LocalPackageType.user);
m_packageManager.removeLocalPackage(makeAbsolute(path), system ? PlacementLocation.system : PlacementLocation.user);
}

/** Registers a local directory to search for packages to use for satisfying
Expand All @@ -997,7 +997,7 @@ class Dub {
void addSearchPath(string path, bool system)
{
if (m_dryRun) return;
m_packageManager.addSearchPath(makeAbsolute(path), system ? LocalPackageType.system : LocalPackageType.user);
m_packageManager.addSearchPath(makeAbsolute(path), system ? PlacementLocation.system : PlacementLocation.user);
}

/** Unregisters a local directory search path.
Expand All @@ -1012,7 +1012,7 @@ class Dub {
void removeSearchPath(string path, bool system)
{
if (m_dryRun) return;
m_packageManager.removeSearchPath(makeAbsolute(path), system ? LocalPackageType.system : LocalPackageType.user);
m_packageManager.removeSearchPath(makeAbsolute(path), system ? PlacementLocation.system : PlacementLocation.user);
}

/** Queries all package suppliers with the given query string.
Expand Down
49 changes: 25 additions & 24 deletions source/dub/packagemanager.d
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ class PackageManager {
import std.algorithm.iteration : map;
import std.array : array;

m_repositories.length = LocalPackageType.max+1;
m_repositories.length = PlacementLocation.max+1;
m_repositories ~= custom_cache_paths.map!(p => Repository(p)).array;

refresh(false);
Expand Down Expand Up @@ -319,7 +319,7 @@ class PackageManager {

string gitReference = versionSpec.chompPrefix("~");
NativePath destination = getPackagePath(
m_repositories[LocalPackageType.user].packagePath,
m_repositories[PlacementLocation.user].packagePath,
name, versionSpec);
// For libraries leaking their import path
destination ~= name;
Expand Down Expand Up @@ -475,28 +475,28 @@ class PackageManager {

/** Returns a list of all package overrides for the given scope.
*/
const(PackageOverride)[] getOverrides(LocalPackageType scope_)
const(PackageOverride)[] getOverrides(PlacementLocation scope_)
const {
return m_repositories[scope_].overrides;
}

/** Adds a new override for the given package.
*/
void addOverride(LocalPackageType scope_, string package_, Dependency version_spec, Version target)
void addOverride(PlacementLocation scope_, string package_, Dependency version_spec, Version target)
{
m_repositories[scope_].overrides ~= PackageOverride(package_, version_spec, target);
writeLocalPackageOverridesFile(scope_);
}
/// ditto
void addOverride(LocalPackageType scope_, string package_, Dependency version_spec, NativePath target)
void addOverride(PlacementLocation scope_, string package_, Dependency version_spec, NativePath target)
{
m_repositories[scope_].overrides ~= PackageOverride(package_, version_spec, target);
writeLocalPackageOverridesFile(scope_);
}

/** Removes an existing package override.
*/
void removeOverride(LocalPackageType scope_, string package_, Dependency version_spec)
void removeOverride(PlacementLocation scope_, string package_, Dependency version_spec)
{
Repository* rep = &m_repositories[scope_];
foreach (i, ovr; rep.overrides) {
Expand Down Expand Up @@ -643,7 +643,7 @@ class PackageManager {
remove(pack);
}

Package addLocalPackage(NativePath path, string verName, LocalPackageType type)
Package addLocalPackage(NativePath path, string verName, PlacementLocation type)
{
path.endsWithSlash = true;
auto pack = Package.load(path);
Expand All @@ -669,7 +669,7 @@ class PackageManager {
return pack;
}

void removeLocalPackage(NativePath path, LocalPackageType type)
void removeLocalPackage(NativePath path, PlacementLocation type)
{
path.endsWithSlash = true;

Expand All @@ -693,14 +693,14 @@ class PackageManager {
}

/// For the given type add another path where packages will be looked up.
void addSearchPath(NativePath path, LocalPackageType type)
void addSearchPath(NativePath path, PlacementLocation type)
{
m_repositories[type].searchPath ~= path;
writeLocalPackageList(type);
}

/// Removes a search path from the given type.
void removeSearchPath(NativePath path, LocalPackageType type)
void removeSearchPath(NativePath path, PlacementLocation type)
{
m_repositories[type].searchPath = m_repositories[type].searchPath.filter!(p => p != path)().array();
writeLocalPackageList(type);
Expand All @@ -711,7 +711,7 @@ class PackageManager {
logDiagnostic("Refreshing local packages (refresh existing: %s)...", refresh_existing_packages);

// load locally defined packages
void scanLocalPackages(LocalPackageType type)
void scanLocalPackages(PlacementLocation type)
{
NativePath list_path = m_repositories[type].packagePath;
Package[] packs;
Expand Down Expand Up @@ -770,9 +770,9 @@ class PackageManager {
}
if (!m_disableDefaultSearchPaths)
{
scanLocalPackages(LocalPackageType.system);
scanLocalPackages(LocalPackageType.user);
scanLocalPackages(LocalPackageType.package_);
scanLocalPackages(PlacementLocation.system);
scanLocalPackages(PlacementLocation.user);
scanLocalPackages(PlacementLocation.local);
}

auto old_packages = m_packages;
Expand Down Expand Up @@ -825,7 +825,7 @@ class PackageManager {
foreach (p; this.completeSearchPath)
scanPackageFolder(p);

void loadOverrides(LocalPackageType type)
void loadOverrides(PlacementLocation type)
{
m_repositories[type].overrides = null;
auto ovrfilepath = m_repositories[type].packagePath ~ LocalOverridesFilename;
Expand All @@ -842,9 +842,9 @@ class PackageManager {
}
if (!m_disableDefaultSearchPaths)
{
loadOverrides(LocalPackageType.package_);
loadOverrides(LocalPackageType.user);
loadOverrides(LocalPackageType.system);
loadOverrides(PlacementLocation.local);
loadOverrides(PlacementLocation.user);
loadOverrides(PlacementLocation.system);
}
}

Expand Down Expand Up @@ -878,7 +878,7 @@ class PackageManager {
return hash[].dup;
}

private void writeLocalPackageList(LocalPackageType type)
private void writeLocalPackageList(PlacementLocation type)
{
Json[] newlist;
foreach (p; m_repositories[type].searchPath) {
Expand All @@ -902,7 +902,7 @@ class PackageManager {
writeJsonFile(path ~ LocalPackagesFilename, Json(newlist));
}

private void writeLocalPackageOverridesFile(LocalPackageType type)
private void writeLocalPackageOverridesFile(PlacementLocation type)
{
Json[] newlist;
foreach (ovr; m_repositories[type].overrides) {
Expand Down Expand Up @@ -975,10 +975,11 @@ struct PackageOverride {
}
}

enum LocalPackageType {
package_,
user,
system
deprecated("Use `PlacementLocation` instead")
enum LocalPackageType : PlacementLocation {
package_ = PlacementLocation.local,
user = PlacementLocation.user,
system = PlacementLocation.system,
}

private enum LocalPackagesFilename = "local-packages.json";
Expand Down

0 comments on commit da98e59

Please sign in to comment.