Skip to content

Commit aa3f37a

Browse files
author
Stewart Miles
committed
Rename Package Manager Resolver component.
Change-Id: I9208638ce73fc0e09f7565f8f2d4b233d1998148
1 parent fb3fe26 commit aa3f37a

30 files changed

+323
-327
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Unity plugin that requires:
1111
[AARs](https://developer.android.com/studio/projects/android-library.html)).
1212
* iOS [CocoaPods](https://cocoapods.org/).
1313
* Version management of transitive dependencies.
14-
* Management of Unity Package Manager Registries.
14+
* Management of Unity Package Manager (UPM) Registries.
1515

1616
Updated releases are available on
1717
[GitHub](https://github.com/googlesamples/unity-jar-resolver)
@@ -77,7 +77,7 @@ hosting and provides ways to discover, install, upgrade and uninstall packages.
7777
This makes it easier for developers to manage plugins within their projects.
7878

7979
However, installing additional package registries requires a few manual steps
80-
that can potentially be error prone. The *Unity Package Manager Resolver*
80+
that can potentially be error prone. The *Package Manager Resolver*
8181
component of this plugin integrates with
8282
[UPM](https://docs.unity3d.com/Manual/Packages.html) to provide a way to
8383
auto-install UPM package registries when a `.unitypackage` is installed which
@@ -132,7 +132,7 @@ with Unity version 4.6.8 or higher.
132132
The *Version Handler* component only works with Unity 5.x or higher as it
133133
depends upon the `PluginImporter` UnityEditor API.
134134

135-
The *Unity Package Manager Resolver* component only works with
135+
The *Package Manager Resolver* component only works with
136136
Unity 2018.4 or above, when
137137
[scoped registry](https://docs.unity3d.com/Manual/upm-scoped.html)
138138
support was added to the Unity Package Manager.
@@ -456,11 +456,11 @@ private static void PostProcessBuild_iOS(BuildTarget target, string buildPath)
456456
}
457457
```
458458

459-
# Unity Package Manager Resolver Usage
459+
# Package Manager Resolver Usage
460460

461461
Adding registries to the
462462
[Unity Package Manager](https://docs.unity3d.com/Manual/Packages.html)
463-
(UPM) is a manual process. The Unity Package Manager Resolver (UPMR) component
463+
(UPM) is a manual process. The Package Manager Resolver (PMR) component
464464
of this plugin makes it easy for plugin maintainers to distribute new UPM
465465
registry servers and easy for plugin users to manage UPM registry servers.
466466

@@ -497,30 +497,30 @@ For example, to add a registry for plugins in the scope `com.coolstuff`:
497497
</registries>
498498
```
499499

500-
When UPMR is loaded it will prompt the developer to add the registry to their
500+
When PMR is loaded it will prompt the developer to add the registry to their
501501
project if it isn't already present in the `Packages/manifest.json` file.
502502

503503
For more information, see Unity's documentation on
504504
[scoped package registries](https://docs.unity3d.com/Manual/upm-scoped.html).
505505

506506
## Managing Registries
507507

508-
It's possible to add and remove registries that are specified via UPMR
508+
It's possible to add and remove registries that are specified via PMR
509509
XML configuration files via the following menu options:
510510

511-
* `Assets > External Dependency Manager > Unity Package Manager Resolver >
511+
* `Assets > External Dependency Manager > Package Manager Resolver >
512512
Add Registries` will prompt the user with a window which allows them to
513513
add registries discovered in the project to the Unity Package Manager.
514-
* `Assets > External Dependency Manager > Unity Package Manager Resolver >
514+
* `Assets > External Dependency Manager > Package Manager Resolver >
515515
Remove Registries` will prompt the user with a window which allows them to
516516
remove registries discovered in the project from the Unity Package Manager.
517-
* `Assets > External Dependency Manager > Unity Package Manager Resolver >
517+
* `Assets > External Dependency Manager > Package Manager Resolver >
518518
Modify Registries` will prompt the user with a window which allows them to
519519
add or remove registries discovered in the project.
520520

521521
## Migration
522522

523-
UPMR can migrate Version Handler packages installed in the `Assets` folder
523+
PMR can migrate Version Handler packages installed in the `Assets` folder
524524
to UPM packages. This requires the plugins to implement the following:
525525

526526
* `.unitypackage` must include a Version Handler manifests that describes
@@ -535,7 +535,7 @@ to UPM packages. This requires the plugins to implement the following:
535535
in the *Version Handler Usage* section.
536536

537537
When using the `Assets > External Dependency Manager >
538-
Unity Package Manager Resolver > Migrate Packages` menu option, UPMR then
538+
Package Manager Resolver > Migrate Packages` menu option, PMR then
539539
will:
540540

541541
* List all Version Handler manager packages in the project.
@@ -549,8 +549,8 @@ will:
549549

550550
## Configuration
551551

552-
UPMR can be configured via the `Assets > External Dependency Manager >
553-
Unity Package Manager Resolver > Settings` menu option:
552+
PMR can be configured via the `Assets > External Dependency Manager >
553+
Package Manager Resolver > Settings` menu option:
554554

555555
* `Add package registries` when enabled, when the plugin loads or registry
556556
configuration files change, this will prompt the user to add registries

build.gradle

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1381,9 +1381,9 @@ Task buildAndroidResolver = createBuildPluginDllTask(
13811381
Task buildIosResolver = createBuildPluginDllTask(
13821382
"IosResolver", "IOSResolver", "Google.IOSResolver.dll", true,
13831383
[buildAndroidResolver])
1384-
Task buildUnityPackageManagerResolver = createBuildPluginDllTask(
1385-
"UnityPackageManagerResolver", "UnityPackageManagerResolver",
1386-
"Google.UnityPackageManagerResolver.dll", true,
1384+
Task buildPackageManagerResolver = createBuildPluginDllTask(
1385+
"PackageManagerResolver", "PackageManagerResolver",
1386+
"Google.PackageManagerResolver.dll", true,
13871387
[buildVersionHandlerImpl])
13881388

13891389
task preparePluginStagingAreaDir(type: Task) {
@@ -1446,7 +1446,7 @@ Iterable<Task> copyComponentsToStagingAreaTasks = [
14461446
copyVersionHandlerStaging,
14471447
copyVersionHandlerImplStaging,
14481448
copyIosResolverStaging,
1449-
copyUnityPackageManagerResolverStaging].collect {
1449+
copyPackageManagerResolverStaging].collect {
14501450
task ->
14511451
createCopyFilesTask(
14521452
sprintf("copy%sToStagingArea", task.ext.componentName),
@@ -1721,28 +1721,28 @@ createNUnitTask(
17211721
compileVersionHandlerImplTests.outputs.files[0],
17221722
[compileVersionHandlerImplTests])
17231723

1724-
Task compileUnityPackageManagerResolverTests = createXbuildTask(
1725-
"compileUnityPackageManagerResolverTests",
1726-
"Compile tests for UnityPackageManagerResolver.",
1724+
Task compilePackageManagerResolverTests = createXbuildTask(
1725+
"compilePackageManagerResolverTests",
1726+
"Compile tests for PackageManagerResolver.",
17271727
project.ext.pluginSolutionFile,
1728-
"UnityPackageManagerResolverTests",
1728+
"PackageManagerResolverTests",
17291729
fileTree(new File(
17301730
new File(
17311731
new File(project.ext.pluginSourceDir,
1732-
"UnityPackageManagerResolver"),
1732+
"PackageManagerResolver"),
17331733
"unit_tests"),
17341734
"src")),
1735-
new File(project.ext.testDir, "UnityPackageManagerResolverTests"),
1736-
[new File("Google.UnityPackageManagerResolverTests.dll")],
1737-
[buildUnityPackageManagerResolver]).with {
1735+
new File(project.ext.testDir, "PackageManagerResolverTests"),
1736+
[new File("Google.PackageManagerResolverTests.dll")],
1737+
[buildPackageManagerResolver]).with {
17381738
doFirst { checkNUnitDllPath() }
17391739
}
17401740

17411741
createNUnitTask(
1742-
"testUnityPackageManagerResolver",
1743-
"Runs tests for the UnityPackageManagerResolver module",
1744-
compileUnityPackageManagerResolverTests.outputs.files[0],
1745-
[compileUnityPackageManagerResolverTests])
1742+
"testPackageManagerResolver",
1743+
"Runs tests for the PackageManagerResolver module",
1744+
compilePackageManagerResolverTests.outputs.files[0],
1745+
[compilePackageManagerResolverTests])
17461746

17471747
createUnityTestBatchAndNonBatch(
17481748
"testVersionHandlerActivation",
@@ -1860,32 +1860,32 @@ createUnityIntegrationTest(
18601860
["-buildTarget", "android"])
18611861

18621862
createUnityIntegrationTest(
1863-
"testUnityPackageManagerClientIntegrationTests",
1863+
"testPackageManagerClientIntegrationTests",
18641864
("Imports the plugin into a Unity project and uses the Unity Package " +
18651865
"Manager client to list, search, install and remove packages. "),
1866-
[compileUnityPackageManagerResolver],
1867-
"UnityPackageManagerClientIntegrationTests",
1866+
[compilePackageManagerResolver],
1867+
"PackageManagerClientIntegrationTests",
18681868
fileTree(new File(new File(new File(project.ext.pluginSourceDir,
1869-
"UnityPackageManagerResolver"), "test"),
1870-
"UnityPackageManagerClientIntegrationTests")),
1871-
[new File("Google.UnityPackageManagerClientIntegrationTests.dll"),
1872-
new File("Google.UnityPackageManagerClientIntegrationTests.dll.mdb")],
1869+
"PackageManagerResolver"), "test"),
1870+
"PackageManagerClientIntegrationTests")),
1871+
[new File("Google.PackageManagerClientIntegrationTests.dll"),
1872+
new File("Google.PackageManagerClientIntegrationTests.dll.mdb")],
18731873
null, [])
18741874

18751875
createUnityIntegrationTest(
18761876
"testPackageMigratorIntegrationTests",
18771877
("Imports the plugin into a Unity project and uses the Package Migrator " +
18781878
"list packages that can be migrated and self migrate EDM to UPM. "),
1879-
[compileUnityPackageManagerResolver],
1879+
[compilePackageManagerResolver],
18801880
"PackageMigratorIntegrationTests",
18811881
fileTree(new File(new File(new File(project.ext.pluginSourceDir,
1882-
"UnityPackageManagerResolver"), "test"),
1882+
"PackageManagerResolver"), "test"),
18831883
"PackageMigratorIntegrationTests")),
18841884
[new File("Google.PackageMigratorIntegrationTests.dll"),
18851885
new File("Google.PackageMigratorIntegrationTests.dll.mdb")],
18861886
new File(
18871887
project.ext.scriptDirectory,
1888-
"source/UnityPackageManagerResolver/test/" +
1888+
"source/PackageManagerResolver/test/" +
18891889
"PackageMigratorIntegrationTestsUnityProject"),
18901890
[])
18911891

export_unity_package_config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"ExternalDependencyManager/Editor/Google.IOSResolver_*.*",
1919
"ExternalDependencyManager/Editor/Google.JarResolver_*.*",
2020
"ExternalDependencyManager/Editor/Google.VersionHandlerImpl_*.*",
21-
"ExternalDependencyManager/Editor/Google.UnityPackageManagerResolver_*.*"
21+
"ExternalDependencyManager/Editor/Google.PackageManagerResolver_*.*"
2222
],
2323
"override_metadata_upm": {
2424
"PluginImporter": {

source/ExternalDependencyManager.sln

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "VersionHandlerImplTests", "
1919
EndProject
2020
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "IOSResolver", "IOSResolver\IOSResolver.csproj", "{5B581BAE-D432-41AB-AEED-FD269AEA081D}"
2121
EndProject
22-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UnityPackageManagerResolver", "UnityPackageManagerResolver\UnityPackageManagerResolver.csproj", "{77EBE819-CBE6-4CA8-A791-ED747EA29D30}"
22+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PackageManagerResolver", "PackageManagerResolver\PackageManagerResolver.csproj", "{77EBE819-CBE6-4CA8-A791-ED747EA29D30}"
2323
EndProject
24-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UnityPackageManagerResolverTests", "UnityPackageManagerResolver\unit_tests\UnityPackageManagerResolverTests.csproj", "{FEECDCE1-F528-4931-A4CF-808DDBCE1A8D}"
24+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PackageManagerResolverTests", "PackageManagerResolver\unit_tests\PackageManagerResolverTests.csproj", "{FEECDCE1-F528-4931-A4CF-808DDBCE1A8D}"
2525
EndProject
26-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UnityPackageManagerClientIntegrationTests", "UnityPackageManagerResolver\test\UnityPackageManagerClientIntegrationTests.csproj", "{00A0DB5E-1120-24C9-331A-BE692C1F7C01}"
26+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PackageManagerClientIntegrationTests", "PackageManagerResolver\test\PackageManagerClientIntegrationTests.csproj", "{00A0DB5E-1120-24C9-331A-BE692C1F7C01}"
2727
EndProject
28-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PackageMigratorIntegrationTests", "UnityPackageManagerResolver\test\PackageMigratorIntegrationTests.csproj", "{4DBDEE33-4B6C-A866-93FE-04C15486BB03}"
28+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PackageMigratorIntegrationTests", "PackageManagerResolver\test\PackageMigratorIntegrationTests.csproj", "{4DBDEE33-4B6C-A866-93FE-04C15486BB03}"
2929
EndProject
3030
Global
3131
GlobalSection(SolutionConfigurationPlatforms) = preSolution

source/UnityPackageManagerResolver/UnityPackageManagerResolver.csproj renamed to source/PackageManagerResolver/PackageManagerResolver.csproj

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<ProjectGuid>{77EBE819-CBE6-4CA8-A791-ED747EA29D30}</ProjectGuid>
99
<OutputType>Library</OutputType>
1010
<RootNamespace>Google</RootNamespace>
11-
<AssemblyName>Google.UnityPackageManagerResolver</AssemblyName>
11+
<AssemblyName>Google.PackageManagerResolver</AssemblyName>
1212
<ReleaseVersion>1.2</ReleaseVersion>
1313
<TargetFrameworkVersion>v3.5</TargetFrameworkVersion>
1414
</PropertyGroup>
@@ -62,10 +62,10 @@
6262
<Compile Include="src\PackageManifestModifier.cs" />
6363
<Compile Include="src\PackageMigrator.cs" />
6464
<Compile Include="src\SettingsDialog.cs" />
65-
<Compile Include="src\UnityPackageManagerClient.cs" />
66-
<Compile Include="src\UnityPackageManagerResolver.cs" />
67-
<Compile Include="src\XmlUnityPackageManagerRegistries.cs" />
68-
<Compile Include="src\UnityPackageManagerRegistry.cs" />
65+
<Compile Include="src\PackageManagerClient.cs" />
66+
<Compile Include="src\PackageManagerResolver.cs" />
67+
<Compile Include="src\XmlPackageManagerRegistries.cs" />
68+
<Compile Include="src\PackageManagerRegistry.cs" />
6969
<Compile Include="src\VersionNumber.cs" />
7070
<Compile Include="Properties\AssemblyInfo.cs" />
7171
</ItemGroup>

source/UnityPackageManagerResolver/Properties/AssemblyInfo.cs renamed to source/PackageManagerResolver/Properties/AssemblyInfo.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
// Information about this assembly is defined by the following attributes.
2121
// Change them to the values specific to your project.
22-
[assembly: AssemblyTitle("Google.UnityPackageManagerResolver")]
22+
[assembly: AssemblyTitle("Google.PackageManagerResolver")]
2323
[assembly: AssemblyDescription("")]
2424
[assembly: AssemblyConfiguration("")]
2525
[assembly: AssemblyCompany("Google LLC")]
@@ -54,5 +54,5 @@
5454
// </copyright>[assembly: AssemblyKeyFile("")]
5555

5656
[assembly: InternalsVisibleTo("Google.PackageMigratorIntegrationTests")]
57-
[assembly: InternalsVisibleTo("Google.UnityPackageManagerResolverTests")]
58-
[assembly: InternalsVisibleTo("Google.UnityPackageManagerClientIntegrationTests")]
57+
[assembly: InternalsVisibleTo("Google.PackageManagerResolverTests")]
58+
[assembly: InternalsVisibleTo("Google.PackageManagerClientIntegrationTests")]

source/UnityPackageManagerResolver/src/UnityPackageManagerClient.cs renamed to source/PackageManagerResolver/src/PackageManagerClient.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ namespace Google {
2626
/// Provides a safe, simple interface that can be used across any Unity version for interaction
2727
/// with the Unity Package Manager.
2828
/// </summary>
29-
internal static class UnityPackageManagerClient {
29+
internal static class PackageManagerClient {
3030

3131
/// <summary>
3232
/// Wrapper object.
@@ -671,7 +671,7 @@ public bool IsComplete {
671671
public Error Error {
672672
get {
673673
var error = errorProperty.GetValue(instance, null);
674-
return error != null ? new UnityPackageManagerClient.Error(error) : null;
674+
return error != null ? new PackageManagerClient.Error(error) : null;
675675
}
676676
}
677677
}
@@ -986,7 +986,7 @@ protected void ReportProgress(float itemProgress, string item) {
986986
try {
987987
progress(itemProgress, item);
988988
} catch (Exception e) {
989-
UnityPackageManagerClient.Logger.Log(
989+
PackageManagerClient.Logger.Log(
990990
String.Format("Progress reporter raised exception {0}", e),
991991
level: LogLevel.Error);
992992
}
@@ -1204,7 +1204,7 @@ private void SearchNext() {
12041204
/// <summary>
12051205
/// Logger for this class.
12061206
/// </summary>
1207-
public static Logger Logger = UnityPackageManagerResolver.logger;
1207+
public static Logger Logger = PackageManagerResolver.logger;
12081208

12091209
/// <summary>
12101210
/// Job queue for package managers jobs.

source/UnityPackageManagerResolver/src/UnityPackageManagerRegistry.cs renamed to source/PackageManagerResolver/src/PackageManagerRegistry.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// <copyright file="UnityPackageManagerRegistry.cs" company="Google Inc.">
1+
// <copyright file="PackageManagerRegistry.cs" company="Google Inc.">
22
// Copyright (C) 2020 Google Inc. All Rights Reserved.
33
//
44
// Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,12 +21,12 @@ namespace Google {
2121
/// <summary>
2222
/// UPM/NPM package registry.
2323
/// </summary>
24-
internal class UnityPackageManagerRegistry {
24+
internal class PackageManagerRegistry {
2525

2626
/// <summary>
2727
/// Construct an empty registry.
2828
/// </summary>
29-
public UnityPackageManagerRegistry() {
29+
public PackageManagerRegistry() {
3030
Scopes = new List<string>();
3131
}
3232

@@ -96,7 +96,7 @@ public override string ToString() {
9696
/// <returns>true if both objects have the same contents excluding CreatedBy,
9797
/// false otherwise.</returns>
9898
public override bool Equals(System.Object obj) {
99-
var other = obj as UnityPackageManagerRegistry;
99+
var other = obj as PackageManagerRegistry;
100100
return other != null &&
101101
Name == other.Name &&
102102
Url == other.Url &&
@@ -127,12 +127,12 @@ public override int GetHashCode() {
127127
}
128128

129129
/// <summary>
130-
/// Convert a list of UnityPackageManagerRegistry instances to a list of strings.
130+
/// Convert a list of PackageManagerRegistry instances to a list of strings.
131131
/// </summary>
132132
/// <param name="registries">List of registries to convert to strings.</param>
133133
/// <returns>List of strings.</returns>
134134
public static List<string> ToStringList(
135-
IEnumerable<UnityPackageManagerRegistry> registries) {
135+
IEnumerable<PackageManagerRegistry> registries) {
136136
var registryStrings = new List<string>();
137137
foreach (var registry in registries) {
138138
registryStrings.Add(registry.ToString());
@@ -141,11 +141,11 @@ public static List<string> ToStringList(
141141
}
142142

143143
/// <summary>
144-
/// Convert a list of UnityPackageManagerRegistry instance to a newline separated string.
144+
/// Convert a list of PackageManagerRegistry instance to a newline separated string.
145145
/// </summary>
146146
/// <param name="registries">List of registries to convert to strings.</param>
147147
/// <returns>String representation of the list.</returns>
148-
public static string ToString(IEnumerable<UnityPackageManagerRegistry> registries) {
148+
public static string ToString(IEnumerable<PackageManagerRegistry> registries) {
149149
return String.Join("\n", ToStringList(registries).ToArray());
150150
}
151151
}

0 commit comments

Comments
 (0)