Merge pull request #131 from brunobowden/plugin-publish

Workaround for plugins {} + Usage Instructions

Author: brunobowden

CONTRIBUTING.md

@@ -86,4 +86,4 @@ git push -f
 ```
 
 For guidance on doing the merge itself, see
-http://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging
+https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging

README.md

@@ -7,17 +7,30 @@ You may wish to wait for the beta release as we will not support the alpha relea
 
 You should start with a clean java only project without any android dependencies, preferably named `'shared'`. This must be buildable using Gradle's standard `'java'` plugin. It may start as an empty project and allows you to gradually shift over code from an existing Android application.
 
-Within the `'shared'` project's `build.gradle`, apply the j2objc plugin before the java plugin:
-
-    // 'shared' build.gradle
-    plugins {
-        id "com.github.j2objccontrib.j2objcgradle" version "0.2.1-alpha"
+Within the `'shared'` project's `build.gradle`, apply the j2objc plugin before the java plugin.
+
+Note: the plugins {...} syntax does not work for the j2objc plugin, so you must use the old buildscript style
+For more info see: https://github.com/j2objc-contrib/j2objc-gradle/issues/130
+
+    // File: shared/build.gradle
+    buildscript {
+        repositories {
+            maven {
+                url "https://plugins.gradle.org/m2/"
+            }
+        }
+        dependencies {
+            // Current Version: https://plugins.gradle.org/plugin/com.github.j2objccontrib.j2objcgradle
+            classpath "gradle.plugin.com.github.j2objccontrib.j2objcgradle:j2objc-gradle:X.Y.Z-alpha"
+        }
     }
+
     apply plugin: 'java'
+    apply plugin: 'com.github.j2objccontrib.j2objcgradle'
 
 Within the Android application's project `build.gradle`, make it dependent on the `shared` project:
 
-    // 'android-app' build.gradle
+    // File: android/build.gradle
     dependencies {
         compile project(':shared')
     }
@@ -28,13 +41,15 @@ The preferred folder structure is:
     │   .gitignore
     │   build.gradle
     ├───android
-    |   │   build.gradle          // dependency on ':shared'
-    |   └   src                   // src/main/java/...
+    │   │   build.gradle          // dependency on ':shared'
+    │   └   src                   // src/main/java/...
     ├───shared
-    |   │   build.gradle          // apply 'j2objc' then 'java' plugins
-    |   │   build/j2objcOutputs   // j2objc generated headers and libraries 
-    |   └   src                   // src/main/java/...
-    └───Xcode
+    │   │   build.gradle          // apply 'j2objc' then 'java' plugins
+    │   ├   build                 // build directory
+    │   │   │ ...                 // build output
+    │   │   └ j2objcOutputs       // j2objc generated headers and libraries
+    │   └   src                   // src/main/java/...
+    └───xcode
         │   Project
         └   ProjectTests
 
@@ -51,11 +66,13 @@ java project's build.gradle:
 ```
 buildscript {
     dependencies {
-        classpath files('/PATH_TO_J2OBJC_PLUGIN/j2objc-gradle/build/libs/j2objc-gradle-0.1.0-alpha.jar')
+        // Update using "version = X.Y.Z-alpha" defined in build.gradle
+        classpath files('/PATH_TO_J2OBJC_PLUGIN/j2objc-gradle/build/libs/j2objc-gradle-X.Y.Z-alpha.jar')
     }
 }
 
-apply plugin: 'j2objc'
+apply plugin: 'java'
+apply plugin: 'com.github.j2objccontrib.j2objcgradle'
 
 // (regular j2objcConfig here...)
 ```

build.gradle

@@ -14,28 +14,37 @@
  * limitations under the License.
  */
 
+// Based on https://plugins.gradle.org/docs/publish-plugin
+
+// First, apply the publishing plugin
+plugins {
+    id "com.gradle.plugin-publish" version "0.9.0"
+}
 apply plugin: 'groovy'
-apply plugin: 'java'
-apply plugin: 'maven'
 
 dependencies {
     compile gradleApi()
-    compile localGroovy()
 }
 
+
 task wrapper(type: Wrapper) {
     gradleVersion = '2.4'
     distributionUrl = 'https://services.gradle.org/distributions/gradle-2.4-all.zip'
 }
 
-repositories {
-    mavenCentral()
-}
-
 group = 'com.github.j2objccontrib.j2objcgradle'
-version = '0.2.0-alpha'
+version = '0.2.1-alpha'
 
-dependencies {
-    testCompile group: 'junit', name: 'junit', version: '4.12'
-}
+pluginBundle {
+    website = 'https://www.github.com/j2objc-contrib/j2objc-gradle/'
+    vcsUrl = 'https://github.com/j2objc-contrib/j2objc-gradle'
+    description = 'J2ObjC Gradle Build Plugin'
+    tags = ['j2objc']
 
+    plugins {
+        j2objcPlugin {
+            id = 'com.github.j2objccontrib.j2objcgradle'
+            displayName = 'J2ObjC Gradle Build Plugin'
+        }
+    }
+}

src/main/groovy/com/github/j2objccontrib/j2objcgradle/J2objcPlugin.groovy

@@ -75,24 +75,13 @@ class J2objcPlugin implements Plugin<Project> {
             if (!plugins.hasPlugin('java')) {
                 def message =
                         "j2objc plugin didn't find the 'java' plugin in the '${project.name}' project.\n"+
-                        "This is a requirement for using j2objc. If you are migrating an existing\n" +
-                        "Android app, it is suggested that you create a separate project that is\n" +
-                        "named 'shared'. This should not have any android dependencies. Then gradually\n"
-                        "migrate shared code there. Within that project, first apply the 'java' then\n"
-                        "'j2objc' plugins by adding the following lines to the build.gradle file:\n" +
+                        "This is a requirement for using j2objc. Please see usage information at:\n" +
                         "\n" +
-                        "apply plugin: 'java'\n" +
-                        "apply plugin: 'j2objc'\n" +
-                        "\n" +
-                        "j2objcConfig {\n" +
-                        "    // j2objc settings here\n" +
-                        "}\n" +
-                        "\n" +
-                        "More Info: https://github.com/j2objc-contrib/j2objc-gradle/#usage"
+                        "https://github.com/j2objc-contrib/j2objc-gradle/#usage"
                 throw new InvalidUserDataException(message)
             }
 
-            extensions.create("j2objcConfig", J2objcPluginExtension)
+            extensions.create('j2objcConfig', J2objcPluginExtension)
             afterEvaluate { evaluatedProject ->
                 // Validate minimally required parameters.
                 // j2objcHome() will throw the appropriate exception internally.
@@ -109,20 +98,20 @@ class J2objcPlugin implements Plugin<Project> {
 
             // If users need to generate extra files that j2objc depends on, they can make this task dependent
             // on such generation.
-            tasks.create(name: "j2objcPreBuild", type: DefaultTask,
+            tasks.create(name: 'j2objcPreBuild', type: DefaultTask,
                     dependsOn: 'test') {
                 description "Marker task for all tasks that must be complete before j2objc building"
             }
 
-            tasks.create(name: "j2objcCycleFinder", type: J2objcCycleFinderTask,
+            tasks.create(name: 'j2objcCycleFinder', type: J2objcCycleFinderTask,
                     dependsOn: 'j2objcPreBuild') {
                 description "Run the cycle_finder tool on all Java source files"
             }
 
             // TODO @Bruno "build/source/apt" must be project.j2objcConfig.generatedSourceDirs no idea how to set it
             // there
             // Dependency may be added in project.plugins.withType for Java or Android plugin
-            tasks.create(name: "j2objcTranslate", type: J2objcTranslateTask,
+            tasks.create(name: 'j2objcTranslate', type: J2objcTranslateTask,
                     dependsOn: 'j2objcCycleFinder') {
                 description "Translates all the java source files in to Objective-C using j2objc"
                 additionalSrcFiles = files(
@@ -138,13 +127,14 @@ class J2objcPlugin implements Plugin<Project> {
 
             // Note the 'debugTestJ2objcExecutable' task is dynamically created by the objective-c plugin applied
             // on the above line.  It is specified by the testJ2objc native component.
-            tasks.create(name: "j2objcTest", type: J2objcTestTask,
+            tasks.create(name: 'j2objcTest', type: J2objcTestTask,
                     dependsOn: ['test', 'debugTestJ2objcExecutable']) {
+                // This transitively depends on the 'test' task from the java plugin
                 description 'Runs all tests in the generated Objective-C code'
                 testBinaryFile = file("${buildDir}/binaries/testJ2objcExecutable/debug/testJ2objc")
             }
-            // 'check' task is added by 'java' plugin, it depends on 'test' and all the other verification tasks,
-            // now including 'j2objcTest'.
+            // 'check' task is added by 'java' plugin, it depends on 'test' and
+            // all the other verification tasks, now including 'j2objcTest'.
             lateDependsOn(project, 'check', 'j2objcTest')
 
             tasks.create(name: 'j2objcPackLibrariesDebug', type: J2objcPackLibrariesTask,

src/main/groovy/com/github/j2objccontrib/j2objcgradle/J2objcPluginExtension.groovy

@@ -59,8 +59,7 @@ class J2objcPluginExtension {
     // TRANSLATE
     // Flags copied verbatim to j2objc command.
     // A list of all possible flag can be found here:
-    // https://github.com/google/j2objc/blob/master/translator/src/main/resources/com/google/devtools/j2objc/J2ObjC
-    // .properties
+    // https://github.com/google/j2objc/blob/master/translator/src/main/resources/com/google/devtools/j2objc/J2ObjC.properties
     String translateFlags = ""
     // -classpath library additions from ${projectDir}/lib/, e.g.: "json-20140107.jar", "somelib.jar"
     String[] translateClassPaths = []