Repository: techyourchance/thread-poster Branch: master Commit: 52f91fa160a5 Files: 38 Total size: 72.2 KB Directory structure: gitextract_6jbuhoh3/ ├── .gitignore ├── LICENSE.txt ├── README.md ├── build.gradle ├── gradle/ │ └── wrapper/ │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradle.properties ├── gradlew ├── gradlew.bat ├── sample/ │ ├── .gitignore │ ├── build.gradle │ ├── proguard-rules.pro │ └── src/ │ ├── main/ │ │ ├── AndroidManifest.xml │ │ ├── java/ │ │ │ └── com/ │ │ │ └── techyourchance/ │ │ │ └── threadposters/ │ │ │ ├── FakeDataFetcher.java │ │ │ ├── FetchDataUseCase.java │ │ │ ├── SampleActivity.java │ │ │ └── SampleApplication.java │ │ └── res/ │ │ ├── layout/ │ │ │ └── activity_sample.xml │ │ └── values/ │ │ ├── colors.xml │ │ ├── strings.xml │ │ └── styles.xml │ └── test/ │ └── java/ │ └── com/ │ └── techyourchance/ │ └── threadposters/ │ └── FetchDataUseCaseTest.java ├── settings.gradle └── threadposter/ ├── .gitignore ├── build.gradle ├── proguard-rules.pro ├── publish-maven.gradle └── src/ ├── main/ │ ├── AndroidManifest.xml │ ├── java/ │ │ └── com/ │ │ └── techyourchance/ │ │ └── threadposter/ │ │ ├── BackgroundThreadPoster.java │ │ ├── UiThreadPoster.java │ │ └── testdoubles/ │ │ ├── BackgroundThreadPosterTestDouble.java │ │ ├── ThreadPostersTestDouble.java │ │ └── UiThreadPosterTestDouble.java │ └── res/ │ └── values/ │ └── strings.xml └── test/ └── java/ └── com/ └── techyourchance/ └── threadposter/ ├── BackgroundThreadPosterTest.java ├── UiThreadPosterTest.java └── testdoubles/ ├── BackgroundThreadPosterTestDoubleTest.java └── UiThreadPosterTestDoubleTest.java ================================================ FILE CONTENTS ================================================ ================================================ FILE: .gitignore ================================================ sonatype.properties #built application files *.apk *.ap_ # files for the dex VM *.dex # Java class files *.class # generated files bin/ gen/ # Local configuration file (sdk path, etc) local.properties # Windows thumbnail db Thumbs.db # OSX files .DS_Store # Android Studio .idea/ .gradle build/ *.iml captures/ .externalNativeBuild ================================================ FILE: LICENSE.txt ================================================ Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ================================================ FILE: README.md ================================================ # ThreadPoster Lightweight library for unit testable and expressive multi-threading in Android. **ThreadPoster is in public beta**. I'm actively looking for feedback on project's structure, naming and usability. Bug reports are also welcome, of course. ## Install To use ThreadPoster in your project, make sure that you have Maven Central set up in your root `build.gradle` script: ``` allprojects { repositories { google() mavenCentral() } } ``` Then add ThreadPoster as a dependency into your main module's (called `app` by default) `build.gradle` script: ``` dependencies { implementation 'com.techyourchance:threadposter:1.0.1' } ``` ## Usage At the core of this library are two simple classes: `UiThreadPoster` and `BackgroundThreadPoster`. ### Executing code on UI thread In the following example, `updateText(String)` can be safely called on any thread. The actual UI update will always take place on UI thread: ```java public class TextUpdater { private final UiThreadPoster mUiThreadPoster; private final TextView mTxtSample; public void updateText(final String text) { mUiThreadPoster.post(() -> { mTxtSample.setText(text); }); } } ``` ### Executing code on "background" thread In the following example, `fetchAndCacheUserDetails(String)` can be safely called on any thread. The actual network request and data caching will always take place on background thread (non-UI thread): ```java public class UpdateUserDetailsUseCase { private final BackgroundThreadPoster mBackgroundThreadPoster; private final UserDetailsEndpoint mUserDetailsEndpoint; private final UserDetailsCache mUserDetailsCache; public void fetchAndCacheUserDetails(final String userId) { mBackgroundThreadPoster.post(() -> { UserDetails userDetails = mUserDetailsEndpoint.fetchUserDetails(userId); mUserDetailsCache.cacheUserDetails(userDetails); }); } } ``` ### Executing code on "background" thread and notifying Observers on UI thread In the [following example](sample/src/main/java/com/techyourchance/threadposters/FetchDataUseCase.java), `fetchData()` can be safely called on any thread. The actual data fetch will always take place on background thread, and the observers will always be notified on UI thread: ```java public class FetchDataUseCase { public interface Listener { void onDataFetched(String data); void onDataFetchFailed(); } private final FakeDataFetcher mFakeDataFetcher; private final BackgroundThreadPoster mBackgroundThreadPoster; private final UiThreadPoster mUiThreadPoster; public void fetchData() { // offload work to background thread mBackgroundThreadPoster.post(() -> { fetchDataSync(); }); } @WorkerThread private void fetchDataSync() { try { final String data = mFakeDataFetcher.getData(); mUiThreadPoster.post(() -> { notifySuccess(data); // notify listeners on UI thread }); } catch (FakeDataFetcher.DataFetchException e) { mUiThreadPoster.post(() -> { notifyFailure(); // notify listeners on UI thread }); } } @UiThread private void notifyFailure() { for (Listener listener : mListeners) { listener.onDataFetchFailed(); } } @UiThread private void notifySuccess(String data) { for (Listener listener : mListeners) { listener.onDataFetched(data); } } } ``` ## Unit Testing This library allows for easy unit testing of multithreaded code. **Important note: no amount of unit testing can guarantee that your code is thread-safe. In other words, even if your unit tests pass, your code can still be subject to race conditions, deadlocks, livelocks, etc.** To support unit testing, ThreadPosters library is shipped with test double implementations for both `UiThreadPoster` and `BackgroundThreadPoster`. The core feature of these test doubles is that they are truly multi-threaded. In other words, when you unit test using these test doubles, you exercise your code in real multi-threaded environment which is the best approximation of the real production setting. ### Benefits and drawbacks of multi-threaded unit testing The approach employed by ThreadPoster's test doubles has its benefits and drawbacks. **Benefits of multi-threaded unit testing:** 1. Exercises the code in real production setting. 2. Has a chance to find multi-threading bugs. This will manifest itself in the form of "flaky" tests (tests that fail ocassionally). **Drawbacks of multi-threaded unit testing:** 1. Longer unit tests execution times. 2. Requires user assistance in the form of an additional step in each test case (`join()` calls in the examples below). On my machine, test cases that use ThreadPoster test doubles execute in ~10ms (as opposed to <1ms for plain Java). That's not an issue if you have 100 multi-threaded test cases, but it's a show stopper for proper TDD if you have 1000. The upside is that absolute majority of your classes shoudln't be multi-threaded, which means that the overall percentage of slow unit tests should be low. I'm currently working on ways to optimize the test times, but you should definitely keep this drawback in mind if you intend to unit test using ThreadPoster test doubles. ### Example unit test Below code shows a unit test that makes use of ThreadPoster test doubles. It's part of the sample project. Note the calls to `mThreadPostersTestDouble.join()` in tests - that's the drawback number two. Since test cases become multithreaded, JUnit can't control tests' execution by itself anymore. Therefore, you'll need to call `mThreadPostersTestDouble.join()` before the assertions stage in each of your test cases. This makes sure that all involved threads run to completion and their side effects will be visible during assertions stage. ```java public class FetchDataUseCaseTest { private static final String TEST_DATA = "testData"; private ThreadPostersTestDouble mThreadPostersTestDouble = new ThreadPostersTestDouble(); private FakeDataFetcher mFakeDataFetcherMock; private FetchDataUseCase.Listener mListener1; private FetchDataUseCase.Listener mListener2; private FetchDataUseCase SUT; @Before public void setup() throws Exception { mFakeDataFetcherMock = mock(FakeDataFetcher.class); SUT = new FetchDataUseCase( mFakeDataFetcherMock, mThreadPostersTestDouble.getBackgroundTestDouble(), mThreadPostersTestDouble.getUiTestDouble()); mListener1 = mock(FetchDataUseCase.Listener.class); mListener2 = mock(FetchDataUseCase.Listener.class); } @Test public void fetchData_successNoListeners_completesWithoutErrors() throws Exception { // Arrange when(mFakeDataFetcherMock.getData()).thenReturn(TEST_DATA); // Act SUT.fetchData(); // Assert // needs to be called before assertions in order for all threads to complete and // all side effects to be present mThreadPostersTestDouble.join(); assertThat(true, is(true)); } @Test public void fetchData_successMultipleListeners_notifiedWithCorrectData() throws Exception { // Arrange when(mFakeDataFetcherMock.getData()).thenReturn(TEST_DATA); ArgumentCaptor ac = ArgumentCaptor.forClass(String.class); // Act SUT.registerListener(mListener1); SUT.registerListener(mListener2); SUT.fetchData(); // Assert // needs to be called before assertions in order for all threads to complete and // all side effects to be present mThreadPostersTestDouble.join(); verify(mListener1).onDataFetched(TEST_DATA); verify(mListener2).onDataFetched(TEST_DATA); } @Test public void fetchData_failureMultipleListeners_notifiedOfFailure() throws Exception { // Arrange doThrow(new FakeDataFetcher.DataFetchException()).when(mFakeDataFetcherMock).getData(); // Act SUT.registerListener(mListener1); SUT.registerListener(mListener2); SUT.fetchData(); // Assert // needs to be called before assertions in order for all threads to complete and // all side effects to be present mThreadPostersTestDouble.join(); verify(mListener1).onDataFetchFailed(); verify(mListener2).onDataFetchFailed(); } } ``` ## License This project is licensed under the Apache-2.0 License - see the [LICENSE.txt](LICENSE.txt) file for details ================================================ FILE: build.gradle ================================================ // Top-level build file where you can add configuration options common to all sub-projects/modules. buildscript { repositories { google() mavenCentral() } dependencies { classpath 'com.android.tools.build:gradle:4.1.1' } } allprojects { repositories { google() mavenCentral() } } ext { compileSdkVersion = 30 buildToolsVersion = "30.0.2" supportLibVersion = "27.1.1" junitVersion = "4.13" mockitoVersion = "2.19.0" } task clean(type: Delete) { delete rootProject.buildDir } ================================================ FILE: gradle/wrapper/gradle-wrapper.properties ================================================ #Wed Nov 18 09:35:17 CET 2020 distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists distributionUrl=https\://services.gradle.org/distributions/gradle-6.5-all.zip ================================================ FILE: gradle.properties ================================================ # 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 ================================================ FILE: gradlew ================================================ #!/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 "$@" ================================================ FILE: gradlew.bat ================================================ @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 ================================================ FILE: sample/.gitignore ================================================ /build ================================================ FILE: sample/build.gradle ================================================ apply plugin: 'com.android.application' android { compileSdkVersion rootProject.ext.compileSdkVersion buildToolsVersion rootProject.ext.buildToolsVersion defaultConfig { applicationId "com.techyourchance.threadposters" minSdkVersion 16 targetSdkVersion 28 versionCode 1 versionName "1.0" } buildTypes { release { minifyEnabled false proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' } } } dependencies { implementation project(path: ':threadposter') implementation fileTree(dir: 'libs', include: ['*.jar']) implementation "com.android.support:appcompat-v7:${rootProject.ext.supportLibVersion}" testImplementation "junit:junit:${rootProject.ext.junitVersion}" testImplementation "org.mockito:mockito-core:${rootProject.ext.mockitoVersion}" } ================================================ FILE: sample/proguard-rules.pro ================================================ # Add project specific ProGuard rules here. # By default, the flags in this file are appended to flags specified # in /Users/Vasiliy/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 ================================================ FILE: sample/src/main/AndroidManifest.xml ================================================ ================================================ FILE: sample/src/main/java/com/techyourchance/threadposters/FakeDataFetcher.java ================================================ package com.techyourchance.threadposters; import android.support.annotation.WorkerThread; public class FakeDataFetcher { public static class DataFetchException extends Exception {} private boolean mIsError = true; @WorkerThread public String getData() throws DataFetchException { // simulate 2 seconds worth of work try { Thread.sleep(2000); } catch (InterruptedException e) { e.printStackTrace(); } mIsError = !mIsError; // error response every other time if (mIsError) { throw new DataFetchException(); } else { return "fake data"; } } } ================================================ FILE: sample/src/main/java/com/techyourchance/threadposters/FetchDataUseCase.java ================================================ package com.techyourchance.threadposters; import android.support.annotation.UiThread; import android.support.annotation.WorkerThread; import com.techyourchance.threadposter.UiThreadPoster; import com.techyourchance.threadposter.BackgroundThreadPoster; import java.util.Collections; import java.util.Set; import java.util.concurrent.ConcurrentHashMap; public class FetchDataUseCase { public interface Listener { void onDataFetched(String data); void onDataFetchFailed(); } private final FakeDataFetcher mFakeDataFetcher; private final BackgroundThreadPoster mBackgroundThreadPoster; private final UiThreadPoster mUiThreadPoster; private final Set mListeners = Collections.newSetFromMap( new ConcurrentHashMap()); public FetchDataUseCase(FakeDataFetcher fakeDataFetcher, BackgroundThreadPoster backgroundThreadPoster, UiThreadPoster uiThreadPoster) { mFakeDataFetcher = fakeDataFetcher; mBackgroundThreadPoster = backgroundThreadPoster; mUiThreadPoster = uiThreadPoster; } public void registerListener(Listener listener) { mListeners.add(listener); } public void unregisterListener(Listener listener) { mListeners.remove(listener); } public void fetchData() { // offload work to background thread mBackgroundThreadPoster.post(new Runnable() { @Override public void run() { fetchDataSync(); } }); } @WorkerThread private void fetchDataSync() { try { final String data = mFakeDataFetcher.getData(); mUiThreadPoster.post(new Runnable() { // notify listeners on UI thread @Override public void run() { notifySuccess(data); } }); } catch (FakeDataFetcher.DataFetchException e) { mUiThreadPoster.post(new Runnable() { // notify listeners on UI thread @Override public void run() { notifyFailure(); } }); } } @UiThread private void notifyFailure() { for (Listener listener : mListeners) { listener.onDataFetchFailed(); } } @UiThread private void notifySuccess(String data) { for (Listener listener : mListeners) { listener.onDataFetched(data); } } } ================================================ FILE: sample/src/main/java/com/techyourchance/threadposters/SampleActivity.java ================================================ package com.techyourchance.threadposters; import android.os.Bundle; import android.support.v7.app.AppCompatActivity; import android.view.View; import android.widget.Button; import android.widget.ProgressBar; import android.widget.TextView; public class SampleActivity extends AppCompatActivity implements FetchDataUseCase.Listener { private Button mBtnFetchData; private ProgressBar mProgressWorking; private TextView mTxtData; private TextView mTxtError; private FetchDataUseCase mFetchDataUseCase; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_sample); mFetchDataUseCase = ((SampleApplication)getApplication()).getFetchDataUseCase(); mBtnFetchData = (Button) findViewById(R.id.btn_fetch_data); mProgressWorking = (ProgressBar) findViewById(R.id.progress_working); mTxtData = (TextView) findViewById(R.id.txt_data); mTxtError = (TextView) findViewById(R.id.txt_error); mBtnFetchData.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { fetchData(); } }); } @Override protected void onStart() { super.onStart(); mFetchDataUseCase.registerListener(this); } @Override protected void onStop() { super.onStop(); mFetchDataUseCase.unregisterListener(this); } private void fetchData() { showProgressIndicationAndHideOthers(); mFetchDataUseCase.fetchData(); } @Override public void onDataFetched(String data) { hideProgressIndication(); showData(data); } private void showData(String data) { mTxtData.setText(data); mTxtData.setVisibility(View.VISIBLE); mBtnFetchData.setVisibility(View.VISIBLE); } @Override public void onDataFetchFailed() { hideProgressIndication(); showError(); } private void showError() { mTxtError.setVisibility(View.VISIBLE); mBtnFetchData.setVisibility(View.VISIBLE); } private void showProgressIndicationAndHideOthers() { mBtnFetchData.setVisibility(View.GONE); mTxtData.setVisibility(View.GONE); mTxtError.setVisibility(View.GONE); mProgressWorking.setVisibility(View.VISIBLE); } private void hideProgressIndication() { mProgressWorking.setVisibility(View.GONE); } } ================================================ FILE: sample/src/main/java/com/techyourchance/threadposters/SampleApplication.java ================================================ package com.techyourchance.threadposters; import android.app.Application; import com.techyourchance.threadposter.BackgroundThreadPoster; import com.techyourchance.threadposter.UiThreadPoster; public class SampleApplication extends Application { /* IMPORTANT: Both BackgroundThreadPoster and UiThreadPoster should be global objects (single instance). */ private final BackgroundThreadPoster mBackgroundThreadPoster = new BackgroundThreadPoster(); private final UiThreadPoster mUiThreadPoster = new UiThreadPoster(); private final FakeDataFetcher mFakeDataFetcher = new FakeDataFetcher(); private final FetchDataUseCase mFetchDataUseCase = new FetchDataUseCase(mFakeDataFetcher, mBackgroundThreadPoster, mUiThreadPoster); public FetchDataUseCase getFetchDataUseCase() { return mFetchDataUseCase; } } ================================================ FILE: sample/src/main/res/layout/activity_sample.xml ================================================