Add KTX module (#860)

* Add KTX module

* Add contribution note

* Add a few other extensions related to primative support

Author: Jawnnypoo

README.md

@@ -24,6 +24,8 @@ dependencies {
     implementation "com.github.parse-community.Parse-SDK-Android:parse:latest.version.here"
     // for FCM Push support (optional)
     implementation "com.github.parse-community.Parse-SDK-Android:fcm:latest.version.here"
+    // for Kotlin extensions support (optional)
+    implementation "com.github.parse-community.Parse-SDK-Android:ktx:latest.version.here"
 }
 ```
 

build.gradle

@@ -1,4 +1,5 @@
 buildscript {
+    ext.kotlin_version = '1.2.51'
     repositories {
         jcenter()
         google()
@@ -7,6 +8,7 @@ buildscript {
         classpath 'com.android.tools.build:gradle:3.1.3'
         classpath 'org.kt3k.gradle.plugin:coveralls-gradle-plugin:2.8.2'
         classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1'
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
     }
 }
 

fcm/README.md

@@ -4,13 +4,12 @@ FCM support for Parse Android apps
 ## Setup
 
 ### Installation
-
-Add dependency to the application level `build.gradle` file.
+After including JitPack:
 
 ```groovy
 dependencies {
-    implementation 'com.parse:parse-android:latest.version.here'
-    implementation 'com.parse:parse-fcm-android:latest.version.here'
+    implementation "com.github.parse-community.Parse-SDK-Android:parse:latest.version.here"
+    implementation "com.github.parse-community.Parse-SDK-Android:fcm:latest.version.here"
 }
 ```
 Then, follow Google's docs for [setting up an Firebase app](https://firebase.google.com/docs/android/setup). Although the steps are different for setting up FCM with Parse, it is also a good idea to read over the [Firebase FCM Setup](https://firebase.google.com/docs/cloud-messaging/android/client).

gcm/README.md

@@ -7,15 +7,15 @@ Please note that GCM is deprecated in favor of FCM. This module exists as a back
 ## Setup
 
 ### Installation
-
-Add dependency to the application level `build.gradle` file.
+After including JitPack:
 
 ```groovy
 dependencies {
-    implementation 'com.parse:parse-android:latest.version.here'
-    implementation 'com.parse:parse-gcm-android:latest.version.here'
+    implementation "com.github.parse-community.Parse-SDK-Android:parse:latest.version.here"
+    implementation "com.github.parse-community.Parse-SDK-Android:gcm:latest.version.here"
 }
 ```
+
 You will then need to register some things in your manifest, firstly, the GCM sender ID:
 ```xml
 <meta-data

ktx/.gitignore

@@ -0,0 +1 @@
+/build

ktx/README.md

@@ -0,0 +1,49 @@
+# Parse SDK Android KTX
+Kotlin extension support for Parse Android
+
+## Setup
+
+### Installation
+After including JitPack:
+
+```groovy
+dependencies {
+    implementation "com.github.parse-community.Parse-SDK-Android:ktx:latest.version.here"
+}
+```
+Then, you will be able to use the extension functions. For example:
+```kotlin
+/**
+ * A cat, ParseObject subclass. Register with ParseObject.registerSubclass(Cat::class.java)
+ */
+@ParseClassName(Cat.NAME)
+class Cat : ParseObject() {
+
+    companion object {
+        const val NAME = "Cat"
+
+        const val KEY_NAME = "name"
+        const val KEY_AGE = "age"
+    }
+
+    var name: String?
+        get() = getString(KEY_NAME)
+        set(value) = putOrIgnore(KEY_NAME, value)
+
+    var age: Int?
+        get() = getInt(KEY_AGE)
+        set(value) = putOrRemove(KEY_AGE, value)
+}
+
+```
+
+## Contributing
+When contributing to the `ktx` module, please first consider if the extension function you are wanting to add would potentially be better suited in the main `parse` module. If it is something specific to Kotlin users or only useful in a Kotlin project, feel free to make a PR adding it to this module. Otherwise, consider adding the addition to the `parse` module itself, so that it is still usable in Java.
+
+## License
+    Copyright (c) 2015-present, Parse, LLC.
+    All rights reserved.
+
+    This source code is licensed under the BSD-style license found in the
+    LICENSE file in the root directory of this source tree. An additional grant
+    of patent rights can be found in the PATENTS file in the same directory.

ktx/build.gradle

@@ -0,0 +1,36 @@
+apply plugin: 'com.android.library'
+
+apply plugin: 'kotlin-android'
+
+android {
+    compileSdkVersion rootProject.ext.compileSdkVersion
+
+    defaultConfig {
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode 1
+        versionName "1.0"
+
+        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
+
+    }
+
+    lintOptions {
+        abortOnError false
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+
+}
+
+dependencies {
+    api "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+    implementation project(':parse')
+}
+
+apply from: 'https://raw.githubusercontent.com/Commit451/gradle-android-javadocs/1.1.0/gradle-android-javadocs.gradle'

ktx/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

ktx/src/main/AndroidManifest.xml

@@ -0,0 +1 @@
+<manifest package="com.parse.ktx" />

ktx/src/main/java/com/parse/ktx/ParseObject.kt

@@ -0,0 +1,87 @@
+@file:Suppress("unused")
+
+package com.parse.ktx
+
+import com.parse.ParseObject
+
+/**
+ * Get the object as the passed value. This has a chance of throwing an exception if the object
+ * cannot be cast properly
+ * @param key the key
+ * @return the value
+ */
+@Suppress("UNCHECKED_CAST")
+fun <T> ParseObject.getAs(key: String): T = get(key) as T
+
+/**
+ * Get the object optionally as null. This has a chance of throwing an exception if the object
+ * cannot be cast properly
+ * @param key the key
+ * @return the value, or null if nothing is there
+ */
+@Suppress("UNCHECKED_CAST")
+fun <T> ParseObject.getAsOrNull(key: String): T? {
+    if (containsKey(key)) {
+        return get(key) as T?
+    }
+    return null
+}
+
+/**
+ * [ParseObject.put] the value, doing nothing if the value is null
+ */
+fun ParseObject.putOrIgnore(key: String, value: Any?) {
+    if (value != null) {
+        put(key, value)
+    }
+}
+
+/**
+ * [ParseObject.put] the value, or [ParseObject.remove] it if the value is null
+ */
+fun ParseObject.putOrRemove(key: String, value: Any?) {
+    if (value == null) {
+        remove(key)
+    } else {
+        put(key, value)
+    }
+}
+
+/**
+ * Get the boolean optionally as null
+ * @param key the key
+ * @return the value, or null if nothing is there
+ */
+fun ParseObject.getBooleanOrNull(key: String): Boolean? {
+    if (containsKey(key)) {
+        return getBoolean(key)
+    }
+    return null
+}
+
+/**
+ * Get the int optionally as null
+ * @param key the key
+ * @return the value, or null if nothing is there
+ */
+fun ParseObject.getIntOrNull(key: String): Int? {
+    return getNumber(key)?.toInt()
+}
+
+/**
+ * Get the long optionally as null
+ * @param key the key
+ * @return the value, or null if nothing is there
+ */
+fun ParseObject.getLongOrNull(key: String): Long? {
+    return getNumber(key)?.toLong()
+}
+
+/**
+ * Get the double optionally as null
+ * @param key the key
+ * @return the value, or null if nothing is there
+ */
+fun ParseObject.getDoubleOrNull(key: String): Double? {
+    return getNumber(key)?.toDouble()
+}

settings.gradle

@@ -1,2 +1,2 @@
-include ':parse', ':fcm', ':gcm'
+include ':parse', ':fcm', ':gcm', ':ktx'