GH-97 Add basic support for passing annotations to the generated Java stubs #171

ilx · 2019-04-23T09:53:43Z

Hi, we have a custom javadoc doclet that relies on some annotations to be present in Java files. In order to be able to use Scala for the code that needs to be processed with that doclet I have added very limited support that will pass annotations without any parameters to Java stubs generated by genjavadoc plugin. Can you please take a look and maybe merge it / improve it?

P.S. Are tests up-to-date? I'm not sbt user, so maybe I skipped something important but I could not get test task to pass:

[IJ]sbt:genjavadoc> {file:/Users/ilx/work/xebialabs/xlr-project/genjavadoc/}genjavadoc-plugin/test
[info] Updating genjavadoc-plugin...
[info] Done updating.
[info] Compiling 9 Scala sources to /Users/ilx/work/xebialabs/xlr-project/genjavadoc/plugin/target/scala-2.13.0-RC1/classes ...
[error] /Users/ilx/work/xebialabs/xlr-project/genjavadoc/plugin/src/main/scala/com/typesafe/genjavadoc/Plugin.scala:65:30: not found: type CompilationUnit
[error]     def newTransformer(unit: CompilationUnit) = new GenJavadocTransformer(unit)
[error]                              ^
[error] /Users/ilx/work/xebialabs/xlr-project/genjavadoc/plugin/src/main/scala/com/typesafe/genjavadoc/Plugin.scala:67:68: not found: type Transformer
[error]     class GenJavadocTransformer(val unit: CompilationUnit) extends Transformer with TransformCake {
[error]                                                                    ^
[error] /Users/ilx/work/xebialabs/xlr-project/genjavadoc/plugin/src/main/scala/com/typesafe/genjavadoc/Plugin.scala:67:43: not found: type CompilationUnit
[error]     class GenJavadocTransformer(val unit: CompilationUnit) extends Transformer with TransformCake {
[error]                                           ^
[error] /Users/ilx/work/xebialabs/xlr-project/genjavadoc/plugin/src/main/scala/com/typesafe/genjavadoc/Plugin.scala:65:49: type mismatch;
[error]  found   : com.typesafe.genjavadoc.GenJavadocPlugin.MyComponent.GenJavadocTransformer
[error]  required: com.typesafe.genjavadoc.GenJavadocPlugin.MyComponent.global.Transformer
[error]     def newTransformer(unit: CompilationUnit) = new GenJavadocTransformer(unit)

… Java stubs

lightbend-cla-validator · 2019-04-23T09:53:44Z

Hi @ilx,

Thank you for your contribution! We really value the time you've taken to put this together.

Before we proceed with reviewing this pull request, please sign the Lightbend Contributors License Agreement:

http://www.lightbend.com/contribute/cla

ilx · 2019-04-23T10:33:18Z

Just to inform you I have signed individual CLA

raboof · 2019-04-23T10:56:41Z

Hi ilx, thanks for your contribution! The tests should be up-to-date, as they're ran on Travis - I'll have a quick look if I can explain that error.

raboof

Might be good to add a test demonstrating the new feature?

raboof · 2019-04-23T11:03:26Z

plugin/src/main/scala/com/typesafe/genjavadoc/AST.scala

-    def sig = pattern(s"$ret $name")
+  case class MethodInfo(access: String, pattern: String => String, ret: String, name: String, comment: Seq[String], d: Option[DefDef] = None) extends Templ {
+    def sig: String = {
+      s"""


The additional whitespace here makes tests fail

raboof · 2019-04-23T11:03:39Z

plugin/src/main/scala/com/typesafe/genjavadoc/Plugin.scala


  private object MyComponent extends PluginComponent with Transform {

-    import global._


Apparently this imported CompilationUnit, perhaps best to bring it back?

… line as Java class stubs and write a simple test that demonstrates how to create Java stub with some annotation

ilx · 2019-04-23T16:51:37Z

@raboof tnx for the feedback - I've added an artificial scenario with @SupressWarnings annotation - arguments are ignored.

ilx · 2019-05-06T08:29:04Z

Hi, can someone take a look?

raboof

Sorry, I missed your update!

A couple of minor comments, but you can address those in a follow-up PR if you want. LGTM!

raboof · 2019-05-06T08:30:53Z

README.md

@@ -103,6 +103,36 @@ GenJavadoc can also be integrated into a Maven build (inspired by [this answer o
 </profile>
 ~~~

+You can integrate genjavadoc with gradle build:


Great! Could've been a separate PR but 👍 :)

raboof · 2019-05-06T08:33:03Z

plugin/src/main/scala/com/typesafe/genjavadoc/AST.scala

@@ -93,9 +108,27 @@ trait AST { this: TransformCake =>
    }
  }

-  case class MethodInfo(access: String, pattern: String => String, ret: String, name: String, comment: Seq[String]) extends Templ {
-    def sig = pattern(s"$ret $name")
+  case class MethodInfo(access: String, pattern: String => String, ret: String, name: String, comment: Seq[String], d: Option[DefDef] = None) extends Templ {


Might have been nice to only include the annotations here rather than the full DefDef?

raboof · 2019-05-06T08:33:45Z

plugin/src/main/scala/com/typesafe/genjavadoc/AST.scala

+        } else {
+          annotations
+        }
+      }


A bit simpler might be:

.map { a => s"@${a.symbol.fullName('.')}${System.lineSeparator}" } .mkString

perhaps?

ilx added 2 commits April 23, 2019 10:15

lightbendGH-97 Add basic support for passing annotations to generated…

129d7a2

… Java stubs

lightbendGH-97 Remove xebialabs specific annotations

be7edbb

raboof reviewed Apr 23, 2019

View reviewed changes

lightbendGH-97 Bring back import global._, output annotations on same…

1f6ab9e

… line as Java class stubs and write a simple test that demonstrates how to create Java stub with some annotation

lightbendGH-97 Add an example how to invoke plugin from gradle

a2aa9b1

raboof approved these changes May 6, 2019

View reviewed changes

raboof merged commit 044f052 into lightbend:master May 6, 2019

raboof added this to the 0.14 milestone Sep 17, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GH-97 Add basic support for passing annotations to the generated Java stubs #171

GH-97 Add basic support for passing annotations to the generated Java stubs #171

ilx commented Apr 23, 2019 •

edited

Loading

lightbend-cla-validator commented Apr 23, 2019

ilx commented Apr 23, 2019

raboof commented Apr 23, 2019

raboof left a comment

raboof Apr 23, 2019

raboof Apr 23, 2019

ilx commented Apr 23, 2019 •

edited

Loading

ilx commented May 6, 2019

raboof left a comment

raboof May 6, 2019

raboof May 6, 2019

raboof May 6, 2019


		private object MyComponent extends PluginComponent with Transform {

		import global._

GH-97 Add basic support for passing annotations to the generated Java stubs #171

GH-97 Add basic support for passing annotations to the generated Java stubs #171

Conversation

ilx commented Apr 23, 2019 • edited Loading

lightbend-cla-validator commented Apr 23, 2019

ilx commented Apr 23, 2019

raboof commented Apr 23, 2019

raboof left a comment

Choose a reason for hiding this comment

raboof Apr 23, 2019

Choose a reason for hiding this comment

raboof Apr 23, 2019

Choose a reason for hiding this comment

ilx commented Apr 23, 2019 • edited Loading

ilx commented May 6, 2019

raboof left a comment

Choose a reason for hiding this comment

raboof May 6, 2019

Choose a reason for hiding this comment

raboof May 6, 2019

Choose a reason for hiding this comment

raboof May 6, 2019

Choose a reason for hiding this comment

ilx commented Apr 23, 2019 •

edited

Loading

ilx commented Apr 23, 2019 •

edited

Loading