implab/gradle-common Commit - r29:b379fb9b52c4

variants API cleanup

cin -

r29:b379fb9b52c4 default

parent child

Context file:

r29:b379fb9b52c4

Collapse all files

AGENTS.md created 644 +12 0

			@@ -0,0 +1,12
		1	# AGENTS.md
		2
		3	## Проектные договоренности
		4
		5	### Публичное API библиотек
		6
		7	- Предпочтителен `non-null` подход.
		8	- Там, где значение живет в Gradle Provider API, возвращается `Provider<T>` (не `null`).
		9	- Там, где lookup синхронный, возвращается `Optional<T>` (не `null`).
		10	- `find` рассматривается как синоним legacy `get` (поиск без `fail-fast`).
		11	- `require` это `find` + `fail-fast` с понятной ошибкой в месте вызова.
		12	- Для нового API предпочтительны формы `find/require`; новые `get*` по возможности не добавлять.

common/src/main/java/org/implab/gradle/common/sources/BuildVariant.java +27 -17

              import java.util.Collection;
              import java.util.Collections;
              import java.util.LinkedHashMap;
-             import java.util.LinkedHashSet;
              import java.util.List;
-             import java.util.Set;
+             import java.util.Optional;
              import javax.inject.Inject;
                      });
                  }
-                 public BuildRole getRoleByName(String name) {
-                     return roles.get(name);
+                 public Optional<BuildRole> findRole(String name) {
+                     return Optional.ofNullable(roles.get(name));
+                 }
+                 public BuildRole requireRole(String name) {
+                     return findRole(name)
+                             .orElseThrow(() -> new InvalidUserDataException(
+                                     "Variant '" + this.name + "' doesn't define role '" + name + "'"));
                  }
                  public Collection<LayerLink> getLinks() {
                      return artifactSlot(name, Closures.action(configure));
                  }
-                 public BuildArtifactSlot getArtifactSlotByName(String name) {
-                     return artifactSlots.get(name);
+                 public Optional<BuildArtifactSlot> findArtifactSlot(String name) {
+                     return Optional.ofNullable(artifactSlots.get(name));
                  }
-                 Set<String> declaredLayerNames() {
-                     var result = new LinkedHashSet<String>();
-                     for (var role : roles.values())
-                         result.addAll(role.getLayers().getOrElse(java.util.List.of()));
-                     return result;
+                 public BuildArtifactSlot requireArtifactSlot(String name) {
+                     return findArtifactSlot(name)
+                             .orElseThrow(() -> new InvalidUserDataException(
+                                     "Variant '" + this.name + "' doesn't define artifact slot '" + name + "'"));
                  }
                  void finalizeModel() {
                          return BuildVariant.this.getRoles();
                      }
-                     public BuildRole getByName(String name) {
-                         return BuildVariant.this.getRoleByName(name);
+                     public Optional<BuildRole> find(String name) {
+                         return BuildVariant.this.findRole(name);
+                     }
+                     public BuildRole require(String name) {
+                         return BuildVariant.this.requireRole(name);
                      }
                  }
                          return BuildVariant.this.getArtifactSlots();
                      }
-                     public BuildArtifactSlot getByName(String name) {
-                         return BuildVariant.this.getArtifactSlotByName(name);
+                     public Optional<BuildArtifactSlot> find(String name) {
+                         return BuildVariant.this.findArtifactSlot(name);
+                     }
+                     public BuildArtifactSlot require(String name) {
+                         return BuildVariant.this.requireArtifactSlot(name);
                      }
                  }

common/src/main/java/org/implab/gradle/common/sources/BuildVariantsExtension.java +8 -2

              import java.util.LinkedHashSet;
              import java.util.List;
              import java.util.Map;
+             import java.util.Optional;
              import java.util.Set;
              import javax.inject.Inject;
                      return Collections.unmodifiableList(all);
                  }
-                 public BuildVariant getByName(String name) {
-                     return variants.findByName(name);
+                 public Optional<BuildVariant> find(String name) {
+                     return Optional.ofNullable(variants.findByName(name));
+                 }
+                 public BuildVariant require(String name) {
+                     return find(name)
+                             .orElseThrow(() -> new InvalidUserDataException("Variant '" + name + "' isn't defined"));
                  }
                  public void whenFinalized(Action<? super BuildVariantsExtension> action) {

common/src/main/java/org/implab/gradle/common/sources/VariantAttributes.java +14 -2

              public final class VariantAttributes {
                  private final ProviderFactory providers;
                  private final LinkedHashMap<Attribute<?>, Provider<?>> values = new LinkedHashMap<>();
+                 private final Provider<Object> emptyValueProvider;
                  private boolean finalized;
                  VariantAttributes(ProviderFactory providers) {
                      this.providers = providers;
+                     this.emptyValueProvider = providers.provider(() -> null);
                  }
                  public <T> void attribute(Attribute<T> key, T value) {
                  }
                  @SuppressWarnings("unchecked")
-                 public <T> Provider<T> get(Attribute<T> key) {
-                     return (Provider<T>) values.get(key);
+                 public <T> Provider<T> find(Attribute<T> key) {
+                     return providers
+                             .provider(() -> (Provider<T>) values.getOrDefault(key, emptyValueProvider))
+                             .flatMap(provider -> provider);
+                 }
+                 public <T> Provider<T> require(Attribute<T> key) {
+                     var value = find(key);
+                     if (!value.isPresent())
+                         throw new InvalidUserDataException("Attribute '" + key.getName() + "' doesn't have a value");
+                     return value;
                  }
                  public boolean contains(Attribute<?> key) {

common/src/test/java/org/implab/gradle/common/sources/VariantsPluginFunctionalTest.java +4 -4

                              }
                          }
-                         tasks.register('probe') {
-                             doLast {
-                                 def browser = variants.getByName('browser')
+                             tasks.register('probe') {
+                                 doLast {
+                                 def browser = variants.require('browser')
                                  println('attributes=' + browser.attributes.size())
                                  println('roles=' + browser.roles.size())
                                  println('links=' + browser.links.size())
                          }
                          afterEvaluate {
-                             variants.getByName('browser').role('late') { layers('a') }
+                             variants.require('browser').role('late') { layers('a') }
                          }
                          """, "Variant 'browser' is finalized and cannot configure roles");
                  }

common/variants-plugin.md +1 -1

              - `variant(...)` — объявление или конфигурация `BuildVariant`.
              - `layers { ... }`, `variants { ... }` — контейнерный DSL.
              - `all(...)` — callback для всех вариантов.
-             - `getAll()`, `getByName(name)` — доступ к вариантам.
+             - `getAll()`, `find(name)`, `require(name)` — доступ к вариантам.
              - `validate()` — явный запуск валидации.
              - `finalizeModel()` — валидация + финализация модели.
              - `whenFinalized(...)` — callback по завершенной модели (replayable).

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages