[binderator] Add binding type and use it to remove 'gson' template. (#941)

Some of the final pieces needed to start removing package-specific templates:

- We use the top level `mavenRepositoryType` to default all packages to Google's Maven, and then use the templates to override this to `MavenCentral`. Without templates we will need to specify this directly on the artifact, so add support for an artifact level `mavenRepositoryType`.

- We have several different "types" of packages that we create today:
  - `EmbeddedJar` - Basic use of `<EmbeddedJar>` to include the Java payload in the NuGet package next to the managed bindings `.dll`. (This is equivalent to the preferred `<AndroidLibrary>` in .NET 6+.)
  - `Targets` - Uses `<InputJar>` to create the binding `.dll` and `<None>` to add the Java payload manually into the NuGet package and uses a `.targets` file to add it to the Android application.
  - `NoBindings` - Uses `<None>` to add the Java payload manually into the NuGet package and uses a `.targets` file to add it to the Android application. Does not create managed bindings.
  - `XBD` - Uses `<InputJar>` to create the binding `.dll`. The Java payload is not included in the NuGet package. Instead a `.targets` file is used to download the payload at compile time using `Xamarin.Build.Download`.

The default package type is `targets`, which is what the current default template uses. That is, this is the one that all AndroidX packages currently use.

To specify a different package type, we add a new artifact level `type` attribute. The only currently supported value for this is `androidlibrary` which provides the `EmbeddedJar` package type behavior.

As a proof of concept, migrate `GoogleGson` from the `gson` template to the default template.

### Results
Before:
```json
{
  "groupId": "com.google.code.gson",
  "artifactId": "gson",
  "version": "2.11.0",
  "nugetVersion": "2.11.0.1",
  "nugetId": "GoogleGson",
  "dependencyOnly": false,
  "templateSet": "gson"
}
```
![image](https://github.com/user-attachments/assets/968d3251-52fc-449f-a629-f28c86b44321)

After:
```json
{
  "groupId": "com.google.code.gson",
  "artifactId": "gson",
  "version": "2.11.0",
  "nugetVersion": "2.11.0.1",
  "nugetId": "GoogleGson",
  "dependencyOnly": false,
  "type": "androidlibrary",
  "mavenRepositoryType": "MavenCentral"
}
```
![image](https://github.com/user-attachments/assets/97bed63c-10c3-4827-992c-669f153f8c12)
This commit is contained in:
Jonathan Pobst 2024-08-22 08:36:57 -10:00 коммит произвёл GitHub
Родитель ff23d907e5
Коммит a9594744db
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: B5690EEEBB952194
9 изменённых файлов: 46 добавлений и 311 удалений

Просмотреть файл

@ -2455,7 +2455,8 @@
"nugetVersion": "2.11.0.1",
"nugetId": "GoogleGson",
"dependencyOnly": false,
"templateSet": "gson"
"type": "androidlibrary",
"mavenRepositoryType": "MavenCentral"
},
{
"groupId": "com.google.crypto.tink",
@ -2947,7 +2948,7 @@
"nugetVersion": "121.5.0.1",
"nugetId": "Xamarin.GooglePlayServices.Cast.Framework",
"dependencyOnly": true
},
},
{
"groupId": "com.google.android.gms",
"artifactId": "play-services-cronet",
@ -3193,24 +3194,6 @@
}
]
},
{
"name": "gson",
"mavenRepositoryType": "MavenCentral",
"templates": [
{
"templateFile": "templates/gson/Project.cshtml",
"outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
},
{
"templateFile": "source/AndroidXNuGetReadMe.cshtml",
"outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
},
{
"templateFile": "source/AndroidXSolutionFilter.cshtml",
"outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
}
]
},
{
"name": "auto-value",
"mavenRepositoryType": "MavenCentral",

Просмотреть файл

@ -50,7 +50,7 @@
<!-- Packaging files -->
<ItemGroup>
@if (Model.ShouldIncludeArtifact) {
@if (Model.ShouldIncludeArtifact && Model.Type == AndroidBinderator.BindingType.Targets) {
<None Include="@(Model.NuGetPackageId).targets" Pack="True" PackagePath="@@(AndroidXNuGetTargetFolders)" />
}
<None Include="..\..\source\PackageLicense.md" Pack="True" PackagePath="LICENSE.md" />
@ -96,6 +96,7 @@
</TransformFile>
</ItemGroup>
@if (Model.Type == AndroidBinderator.BindingType.Targets) {
@if (@Model.MavenArtifacts.Count > 0) {
<!-- Java artifacts to bind -->
<ItemGroup>
@ -138,6 +139,16 @@
}
}
</ItemGroup>
}
@if (Model.Type == AndroidBinderator.BindingType.AndroidLibrary) {
<ItemGroup>
@foreach (var art in @Model.MavenArtifacts)
{
<AndroidLibrary Include="..\..\externals\@(art.MavenGroupId)\@(art.MavenArtifactId).@(art.MavenArtifactPackaging)" />
}
</ItemGroup>
}
<!-- ProjectReferences -->
<ItemGroup>

Просмотреть файл

@ -1,222 +0,0 @@
THIRD-PARTY SOFTWARE NOTICES AND INFORMATION
Do not translate or localize
Xamarin Components for GoogleGson incorporates
third party material from the projects listed below. The original copyright
notice and the license under which Microsoft received such third party
material are set forth below. Microsoft reserves all other rights not
expressly granted, whether by implication, estoppel or otherwise.
########################################
# GoogleGson
# https://github.com/google/gson
########################################
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
########################################
# End - GoogleGson
########################################

Просмотреть файл

@ -1,67 +0,0 @@
<Project Sdk="Xamarin.Legacy.Sdk">
<PropertyGroup>
<TargetFrameworks>$(_DefaultTargetFrameworks)</TargetFrameworks>
<IsBindingProject>true</IsBindingProject>
<RootNamespace>GoogleGson</RootNamespace>
<AssemblyName>GoogleGson</AssemblyName>
<!--
No warnings for:
- CS0618: 'member' is obsolete: 'text'
- CS0109: The member 'member' does not hide an inherited member. The new keyword is not required
- CS0114: 'function1' hides inherited member 'function2'. To make the current method override that implementation, add the override keyword. Otherwise add the new keyword.
- CS0628: 'member' : new protected member declared in sealed class
- CS0108: 'member1' hides inherited member 'member2'. Use the new keyword if hiding was intended.
- CS0809: Obsolete member 'member' overrides non-obsolete member 'member'
-->
<NoWarn>0618;0109;0114;0628;0108;0809</NoWarn>
</PropertyGroup>
<PropertyGroup>
<AndroidClassParser>class-parse</AndroidClassParser>
<AndroidCodegenTarget>XAJavaInterop1</AndroidCodegenTarget>
</PropertyGroup>
<PropertyGroup>
<PackageId>@(Model.NuGetPackageId)</PackageId>
<Title>Google Gson bindings for .NET for Android (formerly Xamarin.Android)</Title>
<PackageDescription>Gson is a library that can be used to convert Java Objects into their JSON representation. It can also be used to convert a JSON string to an equivalent Java object.</PackageDescription>
<PackageLicenseExpression>MIT AND Apache-2.0</PackageLicenseExpression>
<PackageVersion>@(Model.NuGetVersion)</PackageVersion>
<PackageTags>.NET dotnet Xamarin Android artifact=@(Model.MavenGroupId):@(Model.Name) artifact_versioned=@(Model.MavenGroupId):@(Model.Name):@(Model.MavenArtifacts[0].MavenArtifactVersion)</PackageTags>
</PropertyGroup>
<ItemGroup>
<TransformFile Include="..\..\source\@(Model.MavenArtifacts[0].MavenGroupId)\@(Model.MavenArtifacts[0].MavenArtifactId)\Transforms\*.xml" Link="Transforms\%(Filename)%(Extension)" />
</ItemGroup>
<ItemGroup>
<Compile Include="..\..\source\@(Model.MavenArtifacts[0].MavenGroupId)\@(Model.MavenArtifacts[0].MavenArtifactId)\Additions\*.cs" Link="Additions\%(Filename)%(Extension)" />
</ItemGroup>
<ItemGroup>
@foreach (var art in @Model.MavenArtifacts) {
<EmbeddedJar Include="..\..\externals\@(art.MavenGroupId)\@(art.MavenArtifactId).jar" Link="Jars\%(Filename)%(Extension)" />
<JavaSourcesJar Include="..\..\externals\@(art.MavenGroupId)\@(art.MavenArtifactId)-sources.jar" Link="Jars\%(Filename)%(Extension)" />
}
</ItemGroup>
<ItemGroup>
@foreach (var dep in @Model.NuGetDependencies) {
if (dep.IsProjectReference) {
<ProjectReference Include="..\..\generated\@(dep.MavenArtifact.MavenGroupId).@(dep.MavenArtifact.MavenArtifactId)\@(dep.MavenArtifact.MavenGroupId).@(dep.MavenArtifact.MavenArtifactId).csproj" PrivateAssets="none" />
} else {
<PackageReference Include="@(dep.NuGetPackageId)" Version="@(dep.NuGetVersion)" />
}
}
</ItemGroup>
<ItemGroup>
<None Include="..\..\source\PackageLicense.md" Pack="True" PackagePath="LICENSE.md" />
<None Include="..\..\templates\gson\External-Dependency-Info.txt" Pack="true" PackagePath="THIRD-PARTY-NOTICES.txt" />
</ItemGroup>
<ItemGroup>
<None Include=".\readme.md" Pack="True" PackagePath="readme.md" />
</ItemGroup>
</Project>

Просмотреть файл

@ -5,6 +5,7 @@ using System.IO;
using System.Linq;
using System.Net.Http;
using System.Runtime.InteropServices.ComTypes;
using System.Runtime.Serialization;
using System.Threading.Tasks;
using Microsoft.Extensions.Options;
using Newtonsoft.Json;
@ -31,6 +32,9 @@ namespace AndroidBinderator
[JsonProperty ("strictRuntimeDependencies")]
public bool StrictRuntimeDependencies { get; set; }
[JsonProperty ("defaultBindingsType")]
public BindingType DefaultBindingsType { get; set; } = BindingType.Targets;
[JsonProperty ("excludedRuntimeDependencies")]
public string? ExcludedRuntimeDependencies { get; set; }
@ -167,4 +171,14 @@ namespace AndroidBinderator
Google,
MavenCentral
}
public enum BindingType
{
[EnumMember (Value = "targets")]
Targets,
[EnumMember (Value = "androidlibrary")]
AndroidLibrary,
[EnumMember (Value = "no-bindings")]
NoBindings
}
}

Просмотреть файл

@ -55,6 +55,15 @@ namespace AndroidBinderator
[JsonProperty("extraDependencies")]
public string? ExtraDependencies { get; set; }
[JsonProperty ("type")]
public BindingType? BindingsType { get; set; }
[JsonProperty ("mavenRepositoryType")]
public MavenRepoType? MavenRepositoryType { get; set; }
[JsonProperty ("mavenRepositoryLocation")]
public string? MavenRepositoryLocation { get; set; } = null;
[JsonProperty("templateSet")]
public string? TemplateSet { get; set; }

Просмотреть файл

@ -293,7 +293,8 @@ namespace AndroidBinderator
Config = config,
MavenDescription = mavenProject.Description,
MavenUrl = mavenProject.Url,
JavaSourceRepository = mavenProject.Scm?.Url
JavaSourceRepository = mavenProject.Scm?.Url,
Type = mavenArtifact.BindingsType ?? config.DefaultBindingsType,
};
var licenses = mavenProject.Licenses;

Просмотреть файл

@ -45,6 +45,10 @@ namespace AndroidBinderator
static (MavenRepoType type, string location) GetMavenInfoForArtifact(BindingConfig config, MavenArtifactConfig artifact)
{
// Precendence: Artifact > TemplateSet > Config
if (artifact.MavenRepositoryType.HasValue)
return (artifact.MavenRepositoryType.Value, artifact.MavenRepositoryLocation!);
var template = config.GetTemplateSet(artifact.TemplateSet);
if (template.MavenRepositoryType.HasValue)

Просмотреть файл

@ -13,6 +13,8 @@ namespace AndroidBinderator
public string? MavenGroupId { get; set; }
public BindingType Type { get; set; }
public List<MavenArtifactModel> MavenArtifacts { get; set; } = new List<MavenArtifactModel>();
public string? NuGetPackageId { get; set; }