diff --git a/README.md b/README.md index 7bae04895..07bff6d5d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ -# mapbox-plugins-android +# Mapbox Plugins for Android + Experimental plugins to supercharge your maps ⚡️ + +### About plugins + +Plugins are single-purpose libraries built on top of the Mapbox Android SDK that you can include in your apps like any other Android library. + +These are the plugins currently available: + +* **Traffic.** Adds a traffic layer to any Mapbox basemap. + +### Contributing + +We welcome contributions to this plugin repository! If you're interested in building and sharing your own, please follow these steps: + +1. [Open a ticket](https://github.com/mapbox/mapbox-plugins-android/issues) to kick off a conversation and feel free to tag the `@mapbox/android` team. It's a good idea to explain your plans before you push any code to make sure noone else is working on something similar and to discuss the best approaches to tackle your particular idea. + +1. Create a new branch that will contain the code for your plugin. + +1. Create a new Android library module inside the `plugins` project with Android Studio. Each plugin is a separate library that depends on the Mapbox Android SDK, and potentially on other third-party libraries. Besides the code for the plugin, make sure you include: + + * Tests. + * Javadoc that documents the plugin usage and purpose in detail. + +1. Create a new activity inside the demo app that showcases how to use your plugin. As important as having a working plugin is to show how to use it so that anyone can include it in their projects easily. + +1. Finally, once you're ready to share your code, list your plugin in this file and then open a PR for the `@mapbox/android` team to review. + +Please note that a plugin is simply a library module built on top of the Mapbox Android SDK. For now, we are not requiring plugins to register themselves or to implement any specific interfaces. This might change in the future as we build more plugins and learn how developers use them. We'd love to [hear your ideas](https://github.com/mapbox/mapbox-plugins-android/issues). diff --git a/plugins/.gitignore b/plugins/.gitignore new file mode 100644 index 000000000..09b993d06 --- /dev/null +++ b/plugins/.gitignore @@ -0,0 +1,8 @@ +*.iml +.gradle +/local.properties +/.idea +.DS_Store +/build +/captures +.externalNativeBuild diff --git a/plugins/app/.gitignore b/plugins/app/.gitignore new file mode 100644 index 000000000..796b96d1c --- /dev/null +++ b/plugins/app/.gitignore @@ -0,0 +1 @@ +/build diff --git a/plugins/app/build.gradle b/plugins/app/build.gradle new file mode 100644 index 000000000..3bcc7e663 --- /dev/null +++ b/plugins/app/build.gradle @@ -0,0 +1,30 @@ +apply plugin: 'com.android.application' + +android { + compileSdkVersion 25 + buildToolsVersion "25.0.2" + defaultConfig { + applicationId "com.mapbox.mapboxsdk.plugins.testapp" + minSdkVersion 15 + targetSdkVersion 25 + versionCode 1 + versionName "1.0" + testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" + } + buildTypes { + release { + minifyEnabled false + proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' + } + } +} + +dependencies { + compile fileTree(dir: 'libs', include: ['*.jar']) + androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', { + exclude group: 'com.android.support', module: 'support-annotations' + }) + compile 'com.android.support:appcompat-v7:25.3.1' + compile 'com.android.support.constraint:constraint-layout:1.0.0-alpha7' + testCompile 'junit:junit:4.12' +} diff --git a/plugins/app/proguard-rules.pro b/plugins/app/proguard-rules.pro new file mode 100644 index 000000000..0ccb82433 --- /dev/null +++ b/plugins/app/proguard-rules.pro @@ -0,0 +1,25 @@ +# Add project specific ProGuard rules here. +# By default, the flags in this file are appended to flags specified +# in /Users/antonio/Library/Android/sdk/tools/proguard/proguard-android.txt +# You can edit the include path and order by changing the proguardFiles +# directive in build.gradle. +# +# For more details, see +# http://developer.android.com/guide/developing/tools/proguard.html + +# Add any project specific keep options here: + +# 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 diff --git a/plugins/app/src/androidTest/java/com/mapbox/mapboxsdk/plugins/testapp/ExampleInstrumentedTest.java b/plugins/app/src/androidTest/java/com/mapbox/mapboxsdk/plugins/testapp/ExampleInstrumentedTest.java new file mode 100644 index 000000000..5f1ffcf19 --- /dev/null +++ b/plugins/app/src/androidTest/java/com/mapbox/mapboxsdk/plugins/testapp/ExampleInstrumentedTest.java @@ -0,0 +1,26 @@ +package com.mapbox.mapboxsdk.plugins.testapp; + +import android.content.Context; +import android.support.test.InstrumentationRegistry; +import android.support.test.runner.AndroidJUnit4; + +import org.junit.Test; +import org.junit.runner.RunWith; + +import static org.junit.Assert.*; + +/** + * Instrumentation test, which will execute on an Android device. + * + * @see Testing documentation + */ +@RunWith(AndroidJUnit4.class) +public class ExampleInstrumentedTest { + @Test + public void useAppContext() throws Exception { + // Context of the app under test. + Context appContext = InstrumentationRegistry.getTargetContext(); + + assertEquals("com.mapbox.mapboxsdk.plugins.testapp", appContext.getPackageName()); + } +} diff --git a/plugins/app/src/main/AndroidManifest.xml b/plugins/app/src/main/AndroidManifest.xml new file mode 100644 index 000000000..26d06d72e --- /dev/null +++ b/plugins/app/src/main/AndroidManifest.xml @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/plugins/app/src/main/java/com/mapbox/mapboxsdk/plugins/testapp/FeatureOverviewActivity.java b/plugins/app/src/main/java/com/mapbox/mapboxsdk/plugins/testapp/FeatureOverviewActivity.java new file mode 100644 index 000000000..777e97f24 --- /dev/null +++ b/plugins/app/src/main/java/com/mapbox/mapboxsdk/plugins/testapp/FeatureOverviewActivity.java @@ -0,0 +1,13 @@ +package com.mapbox.mapboxsdk.plugins.testapp; + +import android.support.v7.app.AppCompatActivity; +import android.os.Bundle; + +public class FeatureOverviewActivity extends AppCompatActivity { + + @Override + protected void onCreate(Bundle savedInstanceState) { + super.onCreate(savedInstanceState); + setContentView(R.layout.activity_feature_overview); + } +} diff --git a/plugins/app/src/main/res/layout/activity_feature_overview.xml b/plugins/app/src/main/res/layout/activity_feature_overview.xml new file mode 100644 index 000000000..3debee030 --- /dev/null +++ b/plugins/app/src/main/res/layout/activity_feature_overview.xml @@ -0,0 +1,19 @@ + + + + + + diff --git a/plugins/app/src/main/res/mipmap-hdpi/ic_launcher.png b/plugins/app/src/main/res/mipmap-hdpi/ic_launcher.png new file mode 100644 index 000000000..cde69bccc Binary files /dev/null and b/plugins/app/src/main/res/mipmap-hdpi/ic_launcher.png differ diff --git a/plugins/app/src/main/res/mipmap-hdpi/ic_launcher_round.png b/plugins/app/src/main/res/mipmap-hdpi/ic_launcher_round.png new file mode 100644 index 000000000..9a078e3e1 Binary files /dev/null and b/plugins/app/src/main/res/mipmap-hdpi/ic_launcher_round.png differ diff --git a/plugins/app/src/main/res/mipmap-mdpi/ic_launcher.png b/plugins/app/src/main/res/mipmap-mdpi/ic_launcher.png new file mode 100644 index 000000000..c133a0cbd Binary files /dev/null and b/plugins/app/src/main/res/mipmap-mdpi/ic_launcher.png differ diff --git a/plugins/app/src/main/res/mipmap-mdpi/ic_launcher_round.png b/plugins/app/src/main/res/mipmap-mdpi/ic_launcher_round.png new file mode 100644 index 000000000..efc028a63 Binary files /dev/null and b/plugins/app/src/main/res/mipmap-mdpi/ic_launcher_round.png differ diff --git a/plugins/app/src/main/res/mipmap-xhdpi/ic_launcher.png b/plugins/app/src/main/res/mipmap-xhdpi/ic_launcher.png new file mode 100644 index 000000000..bfa42f0e7 Binary files /dev/null and b/plugins/app/src/main/res/mipmap-xhdpi/ic_launcher.png differ diff --git a/plugins/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png b/plugins/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png new file mode 100644 index 000000000..3af2608a4 Binary files /dev/null and b/plugins/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png differ diff --git a/plugins/app/src/main/res/mipmap-xxhdpi/ic_launcher.png b/plugins/app/src/main/res/mipmap-xxhdpi/ic_launcher.png new file mode 100644 index 000000000..324e72cdd Binary files /dev/null and b/plugins/app/src/main/res/mipmap-xxhdpi/ic_launcher.png differ diff --git a/plugins/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png b/plugins/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png new file mode 100644 index 000000000..9bec2e623 Binary files /dev/null and b/plugins/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png differ diff --git a/plugins/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png b/plugins/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png new file mode 100644 index 000000000..aee44e138 Binary files /dev/null and b/plugins/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png differ diff --git a/plugins/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png b/plugins/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png new file mode 100644 index 000000000..34947cd6b Binary files /dev/null and b/plugins/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png differ diff --git a/plugins/app/src/main/res/values/colors.xml b/plugins/app/src/main/res/values/colors.xml new file mode 100644 index 000000000..3ab3e9cbc --- /dev/null +++ b/plugins/app/src/main/res/values/colors.xml @@ -0,0 +1,6 @@ + + + #3F51B5 + #303F9F + #FF4081 + diff --git a/plugins/app/src/main/res/values/strings.xml b/plugins/app/src/main/res/values/strings.xml new file mode 100644 index 000000000..8193e8b8a --- /dev/null +++ b/plugins/app/src/main/res/values/strings.xml @@ -0,0 +1,3 @@ + + Mapbox Android Plugins + diff --git a/plugins/app/src/main/res/values/styles.xml b/plugins/app/src/main/res/values/styles.xml new file mode 100644 index 000000000..5885930df --- /dev/null +++ b/plugins/app/src/main/res/values/styles.xml @@ -0,0 +1,11 @@ + + + + + + diff --git a/plugins/app/src/test/java/com/mapbox/mapboxsdk/plugins/testapp/ExampleUnitTest.java b/plugins/app/src/test/java/com/mapbox/mapboxsdk/plugins/testapp/ExampleUnitTest.java new file mode 100644 index 000000000..1d0712fee --- /dev/null +++ b/plugins/app/src/test/java/com/mapbox/mapboxsdk/plugins/testapp/ExampleUnitTest.java @@ -0,0 +1,17 @@ +package com.mapbox.mapboxsdk.plugins.testapp; + +import org.junit.Test; + +import static org.junit.Assert.*; + +/** + * Example local unit test, which will execute on the development machine (host). + * + * @see Testing documentation + */ +public class ExampleUnitTest { + @Test + public void addition_isCorrect() throws Exception { + assertEquals(4, 2 + 2); + } +} \ No newline at end of file diff --git a/plugins/build.gradle b/plugins/build.gradle new file mode 100644 index 000000000..1ea4bd055 --- /dev/null +++ b/plugins/build.gradle @@ -0,0 +1,23 @@ +// Top-level build file where you can add configuration options common to all sub-projects/modules. + +buildscript { + repositories { + jcenter() + } + dependencies { + classpath 'com.android.tools.build:gradle:2.3.0' + + // NOTE: Do not place your application dependencies here; they belong + // in the individual module build.gradle files + } +} + +allprojects { + repositories { + jcenter() + } +} + +task clean(type: Delete) { + delete rootProject.buildDir +} diff --git a/plugins/gradle.properties b/plugins/gradle.properties new file mode 100644 index 000000000..aac7c9b46 --- /dev/null +++ b/plugins/gradle.properties @@ -0,0 +1,17 @@ +# Project-wide Gradle settings. + +# IDE (e.g. Android Studio) users: +# Gradle settings configured through the IDE *will override* +# any settings specified in this file. + +# For more details on how to configure your build environment visit +# http://www.gradle.org/docs/current/userguide/build_environment.html + +# Specifies the JVM arguments used for the daemon process. +# The setting is particularly useful for tweaking memory settings. +org.gradle.jvmargs=-Xmx1536m + +# When configured, Gradle will run in incubating parallel mode. +# This option should only be used with decoupled projects. More details, visit +# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects +# org.gradle.parallel=true diff --git a/plugins/gradle/wrapper/gradle-wrapper.jar b/plugins/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000..13372aef5 Binary files /dev/null and b/plugins/gradle/wrapper/gradle-wrapper.jar differ diff --git a/plugins/gradle/wrapper/gradle-wrapper.properties b/plugins/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..db8c6b0f8 --- /dev/null +++ b/plugins/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Wed Apr 05 09:15:49 EDT 2017 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-3.3-all.zip diff --git a/plugins/gradlew b/plugins/gradlew new file mode 100755 index 000000000..9d82f7891 --- /dev/null +++ b/plugins/gradlew @@ -0,0 +1,160 @@ +#!/usr/bin/env bash + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn ( ) { + echo "$*" +} + +die ( ) { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; +esac + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules +function splitJvmOpts() { + JVM_OPTS=("$@") +} +eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS +JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" + +exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" diff --git a/plugins/gradlew.bat b/plugins/gradlew.bat new file mode 100644 index 000000000..aec99730b --- /dev/null +++ b/plugins/gradlew.bat @@ -0,0 +1,90 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windowz variants + +if not "%OS%" == "Windows_NT" goto win9xME_args +if "%@eval[2+2]" == "4" goto 4NT_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* +goto execute + +:4NT_args +@rem Get arguments from the 4NT Shell from JP Software +set CMD_LINE_ARGS=%$ + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/plugins/settings.gradle b/plugins/settings.gradle new file mode 100644 index 000000000..e7b4def49 --- /dev/null +++ b/plugins/settings.gradle @@ -0,0 +1 @@ +include ':app'