tlinkowski / unij Goto Github PK

• interface UnmodifiableSetFactory
• abstract test AbstractUnmodifiableSetFactorySpec in unij-test
• JDK10 implementation Jdk10UnmodifiableSetFactory
• JDK10 test Jdk10UnmodifiableSetFactorySpec
• add UniSets utility class
• add UniSetsSpec test

• pl.tlinkowski.unij.sample.enduser
• pl.tlinkowski.unij.sample.lib
• pl.tlinkowski.unij.sample.lib.usage.eclipse
• pl.tlinkowski.unij.sample.lib.usage.guava
• pl.tlinkowski.unij.sample.lib.usage.jdk8
• pl.tlinkowski.unij.sample.lib.usage.jdk11

Occurs for all unij-bundle-* projects and empty unij-collect-* and unij-misc-* projects.

We probably just need to disable javadoc until the project contents are filled.

Maven Central reports missing Javadoc JARs in all modules.

Missing: no javadoc jar found in folder '/pl/tlinkowski/unij/pl.tlinkowski.unij.service.collect.jdk8/0.1.0'
Missing: no javadoc jar found in folder '/pl/tlinkowski/unij/pl.tlinkowski.unij.service.collect.jdk10/0.1.0'
Missing: no javadoc jar found in folder '/pl/tlinkowski/unij/pl.tlinkowski.unij.bundle.guava_jdk8/0.1.0'
Missing: no javadoc jar found in folder '/pl/tlinkowski/unij/pl.tlinkowski.unij.service.api/0.1.0'
Missing: no javadoc jar found in folder '/pl/tlinkowski/unij/pl.tlinkowski.unij.bundle.eclipse_jdk8/0.1.0'
Missing: no javadoc jar found in folder '/pl/tlinkowski/unij/pl.tlinkowski.unij.service.misc.jdk11/0.1.0'
Missing: no javadoc jar found in folder '/pl/tlinkowski/unij/pl.tlinkowski.unij.api/0.1.0'
Missing: no javadoc jar found in folder '/pl/tlinkowski/unij/pl.tlinkowski.unij.bundle.jdk8/0.1.0'
Missing: no javadoc jar found in folder '/pl/tlinkowski/unij/pl.tlinkowski.unij.service.misc.jdk8/0.1.0'
Missing: no javadoc jar found in folder '/pl/tlinkowski/unij/pl.tlinkowski.unij.service.collect.eclipse/0.1.0'
Missing: no javadoc jar found in folder '/pl/tlinkowski/unij/pl.tlinkowski.unij.test/0.1.0'
Missing: no javadoc jar found in folder '/pl/tlinkowski/unij/pl.tlinkowski.unij.service.collect.guava/0.1.0'
Missing: no javadoc jar found in folder '/pl/tlinkowski/unij/pl.tlinkowski.unij.bundle.jdk11/0.1.0'
Dropping existing partial staging repository.

Related to tlinkowski/basic-annotations#13.

Jdk8MiscellaneousCollectorProvider + spec

Blocked by #24.

We'll also publish unij-test in case someone wants to create (and test) their custom bindings.

JMH Gradle plugin

Blocked by #17.

Logging facades: https://stackoverflow.com/questions/9740569/logger-for-java-library/9741118#9741118

Hook into UniJ.load().

Candidates:

• kordamp-gradle-plugins
• nebula.project

If it so happens that there's more than one UniJ service, they should be selected according to some priority.

Options:

• priority inside an annotation, e.g. @UniJService(priority = 10)
• priority as configuration, e.g. in a ".properties" file:

  service1.priority = 10
  service2.priority = 20
  

Blocked by #18.

• Jdk8UnmodifiableListFactory + spec
• Jdk8UnmodifiableSetFactory + spec
• Jdk8UnmodifiableMapFactory + spec

https://docs.gradle.org/current/userguide/upgrading_version_4.html

• GuavaImmutableListFactory + spec
• GuavaImmutableSetFactory + spec
• GuavaImmutableMapFactory + spec

nebula.maven-publish + nebula.javadoc-jar + nebula.source-jar + nebula.publish-verification

Target:

• Maven Central
• JCenter?

Tool: Codacy.

Shield: https://shields.io/category/analysis

Package-private UniJ class should:

• make use of ServiceLoader
• provide static methods with e.g. UnmodifiableListProvider

Blocked by #16.

Find out if module-info.java in unij-bundle-* should declare uses. For sure, module-info.java should somehow reflect the runtimeOnly dependency we have on unij-collect-* and unij-misc-*.

Related to #40.

• interface MiscellaneousApiProvider
• abstract test AbstractMiscellaneousApiProviderSpec in unij-test
• JDK11 implementation Jdk11MiscellaneousApiProvider
• JDK11 test Jdk11MiscellaneousApiProviderSpec
• add methods to UniCollectors class
• add feature methods to UniCollectorsSpec class

• create unit test in unij-core for UniLists and UniCollectors to test the forwarding (use unij-jdk11 for testing)

Blocked by #18.

  /**
   * Equivalent of {@link Collectors#teeing(Collector, Collector, BiFunction)}.
   */
  <T, R1, R2, R> Collector<T, ?, R> teeingCollector(Collector<? super T, ?, R1> downstream1,
          Collector<? super T, ?, R2> downstream2, BiFunction<? super R1, ? super R2, R> merger);

More JDK 12 APIs:

• https://dzone.com/articles/39-new-features-and-apis-in-jdk-12

When ready: https://github.com/tlinkowski/basic-annotations/milestone/2

Requirements:

• overview of features
• usage (consumer: api+collect+misc, implementor: service-api)
• nice badges at the top (version, build state, coverage)
• Kotlin interop-ready → https://github.com/tlinkowski/basic-annotations

In Gradle: JaCoCo
GitHub plugin: Codecov

Integration:

• example-gradle
• org.kordamp.gradle.jacoco
• codecov-python

Coverage enforcement:

• JaCoCo Gradle plugin
• blog post

https://vorba.ch/2015/java-gradle-travis-jacoco-codecov.html

In spirit of "convention over configuration", "bundle" modules have no own source code, and simply aggregate other modules:

• bundle-jdk8: collect-jdk8 + misc-jdk8
• bundle-jdk11: collect-jdk10 + misc-jdk11 (this bundle would make sense only when using a library based on unij-api)
• bundle-guava-jdk8: collect-guava + misc-jdk8
• bundle-guava-jdk11: collect-guava + misc-jdk11
• bundle-eclipse-jdk8: collect-eclipse + misc-jdk8
• bundle-eclipse-jdk11: collect-eclipse + misc-jdk11

Other bundles can be added per request.

Related to #31.

https://github.com/google/auto/tree/master/service

• interface UnmodifiableListFactory
• abstract test AbstractUnmodifiableListFactoryTest in unij-test
• JDK11 implementation Jdk11UnmodifiableListFactory
• JDK11 test Jdk11UnmodifiableListFactoryTest

• interface UnmodifiableMapFactory
• abstract test AbstractUnmodifiableMapFactorySpec in unij-test
• JDK10 implementation Jdk10UnmodifiableMapFactory
• JDK10 test Jdk10UnmodifiableMapFactorySpec
• add UniMaps utility class
• add UniMapsSpec test

• https://github.com/ksoichiro/awesome-gradle#releasing
• nebula.release

When ready: https://github.com/tlinkowski/tlinkowski-superpom/milestone/7

https://aalmiray.github.io/kordamp-gradle-plugins/#_org_kordamp_gradle_settings

Also, rename pl.tlinkowski.unij.service module to pl.tlinkowski.unij.service.api.

Include:

• code style settings
• inspection profiles
• Lombok IntelliJ plugin dependency
• license headers in every file

Currently, our specs only test if a service is properly registered on classpath ("proper service is registered on classpath"). It's easy to check, because we're testing on classpath only (due to Groovy 2). However, we should find some way to also test if a service is properly registered on modulepath (and generally test everything on modulepath too - should be possible with Groovy 3).

Make the architecture depend on two parts - "collect" and "misc":

• rename unij-core to unij-api
• extract unij-collect-jdk10 and unij-misc-jdk11 from unij-jdk11; leave unij-bundle-jdk11 as simple aggregation
• extract unij-collect-jdk8 and unij-misc-jdk8 from unij-jdk8; leave unij-bundle-jdk8 as simple aggregation
• rename unij-guava to unij-collect-guava
• rename unij-eclipse to unij-collect-eclipse

https://github.com/tlinkowski/basic-annotations

JDK 9:

• https://www.baeldung.com/new-java-9
• https://www.infoworld.com/article/3227244/java-9-is-here-everything-you-need-to-know.html

JDK 10:

• https://dzone.com/articles/109-new-features-in-jdk-10

JDK 11:

• https://dzone.com/articles/90-new-features-and-apis-in-jdk-11
• https://dzone.com/articles/90-new-features-and-apis-in-jdk-11-part-2

Apply @sormuras' naming convention to this project:

• unij-api -> pl.tlinkowski.unij.api
• unij-bundle-eclipse-jdk8 -> pl.tlinkowski.unij.bundle.eclipse_jdk8
• unij-bundle-guava-jdk8 -> pl.tlinkowski.unij.bundle.guava_jdk8
• unij-bundle-jdk11 -> pl.tlinkowski.unij.bundle.jdk11
• unij-bundle-jdk8 -> pl.tlinkowski.unij.bundle.jdk8
• unij-collect-eclipse -> pl.tlinkowski.unij.service.collect.eclipse
• unij-collect-guava -> pl.tlinkowski.unij.service.collect.guava
• unij-collect-jdk10 -> pl.tlinkowski.unij.service.collect.jdk10
• unij-collect-jdk8 -> pl.tlinkowski.unij.service.collect.jdk8
• unij-misc-jdk11 -> pl.tlinkowski.unij.service.misc.jdk11
• unij-misc-jdk8 -> pl.tlinkowski.unij.service.misc.jdk8
• unij-service-api -> pl.tlinkowski.unij.service.api
• unij-test -> pl.tlinkowski.unij.test

Related to tlinkowski/tlinkowski-superpom#64.

https://docs.oracle.com/en/java/javase/11/tools/javadoc.html => see "-link"

https://javadoc.io/

https://docs.gradle.org/current/javadoc/org/gradle/external/javadoc/StandardJavadocDocletOptions.html

Blocks #6.

https://github.com/gradle/kotlin-dsl
https://medium.com/@napperley/gradle-kotlin-dsl-tutorial-223370af9cd8

• EclipseUnmodifiableListFactory + spec
• EclipseUnmodifiableSetFactory + spec
• EclipseUnmodifiableMapFactory + spec

Requirements:

• Gradle 4.10.3
• Groovy DSL
• build file names like project names
• subprojects in "subprojects" dir?

Modules:

• unij-core (Java 8)
• unij-jdk8 (Java 8)
• unij-jdk11 (Java 11)
• unij-guava (Java 8 & Android)
• unij-eclipse (Eclipse Collections)

Gradle plugins:

• Gradle versions plugin
• any other plugins?

Libraries:

• compile-only: Lombok
• testing: Spock 1.2 (comparison with jUnit)

We currently don't yet test if:

1. null elements are indeed disallowed in collections (all currently tested methods, as parametrized tests)
2. duplicate keys in MapProvider.of() and MapProvider.ofEntries() throw errors
3. factory.of() returns the same instance as empty.collect(factory.collector()), factory.copyOf() and factory.of(array)

There's probably more (read the JDK's unmodifiable List/Set/Map specs to discover).

https://docs.gradle.org/current/userguide/java_library_plugin.html

javadoc: error - The code being documented uses modules but the packages defined in https://oss.sonatype.org/service/local/repositories/releases/archive/org/projectlombok/lombok/1.18.8/lombok-1.18.8-javadoc.jar/!/ are in the unnamed module.

Affects 4d3b870.

• shorter
• cleaner layout ("For End User", "For Library Maintainer", "For Binding Provider" sections?)
• perhaps separated into more files?
• add table of contents

http://andresalmiray.com/the-gradle-superpom/

Consider adding:

• custom loading of IntelliJ code style & inspection profiles