Merge pull request #329 from brunobowden/update

j2objc => J2ObjC for user facing messages and docs

Author: brunobowden

FAQ.md

@@ -14,7 +14,7 @@ You have to first create the [Gradle wrapper](https://docs.gradle.org/current/us
 Go to your project folder and do ``gradle wrapper``. Refresh your Eclipse project.
 
 
-### How do I properly pass multiple arguments to j2objc?
+### How do I properly pass multiple arguments to J2ObjC?
 
 Make sure your arguments are separate strings, not a single space-concatenated string.
 
@@ -118,11 +118,11 @@ disable the `j2objcTest` task, do the following:
     }
 
 
-### How do I setup multiple related j2objc or native projects?
+### How do I setup multiple related J2ObjC or native projects?
 
 You can express three kinds of dependencies within j2objcConfig:
 
-1. The common case is that Java and j2objc Project B depends on Java and j2objc Project A,
+1. The common case is that Java and j2objc Project B depends on Java and J2ObjC Project A,
 and you need the Project B J2ObjC generated library to depend on the Project A J2ObjC
 generated library. In this case add to B.gradle:
 
@@ -170,8 +170,8 @@ Objects that are part of a memory cycle on iOS won't be deleted as it doesn't su
 garbage collection.
 
 The basic setup will implicitly check for 40 memory cycles - this is the expected number
-of erroneous matches with `jre_emul` library for j2objc version 0.9.6.1. This may cause
-issues if this number changes with future versions of j2objc libraries.
+of erroneous matches with `jre_emul` library for J2ObjC version 0.9.6.1. This may cause
+issues if this number changes with future versions of J2ObjC libraries.
 
     j2objcCycleFinder {
         enabled = true
@@ -186,7 +186,7 @@ This uses a specially annotated version of the `jre_emul` source that marks all
 erroneously matched cycles such that they can be ignored. It requires downloading
 and building the J2ObjC source:
 
-1. Download the j2objc source to a directory (hereafter J2OJBC_REPO):
+1. Download the J2ObjC source to a directory (hereafter J2OJBC_REPO):
 
     https://github.com/google/j2objc
 

README.md

@@ -1,14 +1,16 @@
-# j2objc-gradle
-Gradle Plugin for [J2ObjC](https://github.com/google/j2objc), which is an open-source tool
-from Google that translates Java source code to Objective-C for the iOS (iPhone/iPad) platform.
-The plugin is not affiliated with Google but was developed by former Google Engineers and others.
-J2ObjC enables Java source to be part of an iOS application's build, as no editing of the
-generated files is necessary. The goal is to write an app's non-UI code (such as application
+# J2ObjC Gradle Plugin
+
+This is the Gradle Plugin for [J2ObjC](https://github.com/google/j2objc), which is an open-source
+tool from Google that translates Java source code to Objective-C for the iOS (iPhone/iPad)
+platform. The plugin is not affiliated with Google but was developed by former Google Engineers
+and others. J2ObjC enables Java source to be part of an iOS application's build, as no editing of
+the generated files is necessary. The goal is to write an app's non-UI code (such as application
 logic and data models) in Java, which is then shared by web apps (using GWT), Android apps,
 and iOS apps.
 
 
 ### Usage
+
 At HEAD, this plugin is in a state of significant flux as we refactor it into a first-class
 Gradle plugin for our beta. You may wish to wait for the beta release as we may make backwards
 incompatible changes before that point.
@@ -109,7 +111,7 @@ may want to disable the release build temporarily by adding to your `local.prope
 
     j2objc.release.enabled=false
 
-This should cut the j2objc build time up to 50%.  You can also do this for `j2objc.debug.enabled`.
+This should cut the J2ObjC build time up to 50%.  You can also do this for `j2objc.debug.enabled`.
 
 
 ### FAQ

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

@@ -312,9 +312,9 @@ class J2objcConfig {
         project.evaluationDependsOn beforeProject.path
 
         if (!beforeProject.plugins.hasPlugin(J2objcPlugin)) {
-            String message = "$beforeProject does not use the j2objc plugin.\n" +
+            String message = "$beforeProject does not use the J2ObjC Gradle Plugin.\n" +
                           "dependsOnJ2objcLib can be used only with another project that\n" +
-                          "itself uses the j2objc plugin."
+                          "itself uses the J2ObjC Gradle Plugin."
             throw new InvalidUserDataException(message)
         }
 

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

@@ -95,7 +95,7 @@ class J2objcPlugin implements Plugin<Project> {
             tasks.create(name: 'j2objcTranslate', type: TranslateTask,
                     dependsOn: 'j2objcCycleFinder') {
                 group 'build'
-                description "Translates all the java source files in to Objective-C using j2objc"
+                description "Translates all the java source files in to Objective-C using 'j2objc'"
                 additionalSrcFiles = files(
                         fileTree(dir: "build/source/apt",
                                 include: "**/*.java")
@@ -127,7 +127,7 @@ class J2objcPlugin implements Plugin<Project> {
             tasks.create(name: 'j2objcTest', type: DefaultTask,
                     dependsOn: ['j2objcTestDebug', 'j2objcTestRelease']) {
                 group 'build'
-                description "Marker task for all test tasks that take part in regular j2objc builds"
+                description "Marker task for all test tasks that take part in regular J2ObjC builds"
             }
             // 'check' task is added by 'java' plugin, it depends on 'test' and
             // all the other verification tasks, now including 'j2objcTest'.

src/main/groovy/com/github/j2objccontrib/j2objcgradle/tasks/AssembleSourceTask.groovy

@@ -66,8 +66,8 @@ class AssembleSourceTask extends DefaultTask {
         // Warn if deleting non-generated objc files from destDir
         nonObjcDestFiles.each { File file ->
             String message =
-                    "Unexpected files in $name - this folder should contain ONLY j2objc\n" +
-                    "generated files Objective-C. The folder contents are deleted to remove\n" +
+                    "Unexpected files in $name - this folder should contain ONLY J2ObjC\n" +
+                    "generated Objective-C files. The folder contents are deleted to remove\n" +
                     "files that are nolonger generated. Please check the directory and remove\n" +
                     "any files that don't end with Objective-C extensions '.h' and '.m'.\n" +
                     "$name: ${destDir.path}\n" +

src/main/groovy/com/github/j2objccontrib/j2objcgradle/tasks/TestTask.groovy

@@ -136,7 +136,8 @@ class TestTask extends DefaultTask {
         } catch (Exception exception) {
             String message =
                     "The j2objcTest task failed. Given that the java plugin 'test' task\n" +
-                    "completed successfully, this is an error specific to the j2objc build.\n" +
+                    "completed successfully, this is an error specific to the J2ObjC Gradle\n" +
+                    "Plugin build.\n" +
                     "\n" +
                     "1) Check BOTH 'Standard Output' and 'Error Output' above for problems.\n" +
                     "\n" +

src/main/groovy/com/github/j2objccontrib/j2objcgradle/tasks/Utils.groovy

@@ -55,8 +55,8 @@ class Utils {
     static void throwIfNoJavaPlugin(Project proj) {
         if (!proj.plugins.hasPlugin('java')) {
             String message =
-                    "j2objc plugin didn't find the 'java' plugin in the '${proj.name}' project.\n" +
-                    "This is a requirement for using j2objc. Please see usage information at:\n" +
+                    "J2ObjC Gradle Plugin: missing 'java' plugin for '${proj.name}' project.\n" +
+                    "This is a requirement for using J2ObjC. Please see usage information at:\n" +
                     "https://github.com/j2objc-contrib/j2objc-gradle/#usage"
             throw new InvalidUserDataException(message)
         }
@@ -96,7 +96,7 @@ class Utils {
                             propKey.substring(PROPERTY_KEY_PREFIX.length(), propKey.length())
                     if (!(withoutPrefix in PROPERTIES_VALID_KEYS)) {
                         throw new InvalidUserDataException(
-                                "Invalid j2objc property: $propKey\n" +
+                                "Invalid J2ObjC Gradle Plugin property: $propKey\n" +
                                 "From local.properties: $localPropertiesFile.absolutePath\n" +
                                 "Valid Keys: $PROPERTIES_VALID_KEYS")
                     }
@@ -117,19 +117,19 @@ class Utils {
         }
         if (result == null) {
             String message =
-                    "j2objc home not set, this should be configured either:\n" +
+                    "J2ObjC Home not set, this should be configured either:\n" +
                     "1) in a 'local.properties' file in the project root directory as:\n" +
-                    "   j2objc.home=/PATH/TO/J2OBJC/DISTRIBUTION\n" +
+                    "   j2objc.home=/LOCAL_J2OBJC_PATH\n" +
                     "2) as the J2OBJC_HOME system environment variable\n" +
                     "\n" +
                     "If both are configured the value in the properties file will be used.\n" +
                     "\n" +
-                    "It must be the path of the unzipped j2objc distribution. Download releases here:\n" +
+                    "It must be the path of the unzipped J2ObjC distribution. Download releases here:\n" +
                     "https://github.com/google/j2objc/releases"
             throw new InvalidUserDataException(message)
         }
         if (!proj.file(result).exists()) {
-            String message = "j2objc directory not found, expected location: ${result}"
+            String message = "J2OjcC Home directory not found, expected location: ${result}"
             throw new InvalidUserDataException(message)
         }
         // Trailing slashes cause problems with string concatenation logic.