├── .gitignore
├── AndroidRxViper.iml
├── LICENSE
├── README.md
├── architecture_layers.jpg
├── build.gradle
├── gradle.properties
├── gradle
└── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── lib
├── .gitignore
├── build.gradle
├── proguard-rules.pro
└── src
│ └── main
│ ├── AndroidManifest.xml
│ ├── java
│ └── cz
│ │ └── helmisek
│ │ └── android
│ │ └── androidviper
│ │ ├── core
│ │ ├── contract
│ │ │ ├── InteractorContract.java
│ │ │ ├── PresenterContract.java
│ │ │ ├── ViewModelContract.java
│ │ │ └── ViewPresenterContract.java
│ │ ├── interactor
│ │ │ └── Interactor.java
│ │ ├── presenter
│ │ │ └── Presenter.java
│ │ ├── router
│ │ │ └── Router.java
│ │ ├── util
│ │ │ ├── ViewWrapper.java
│ │ │ ├── ViperConfig.java
│ │ │ ├── ViperHelper.java
│ │ │ └── ViperProvider.java
│ │ └── viewmodel
│ │ │ └── ViewModel.java
│ │ └── ui
│ │ ├── BasePresenterActivity.java
│ │ └── BasePresenterFragment.java
│ └── res
│ └── values
│ └── strings.xml
├── local.properties
├── sample
├── .gitignore
├── build.gradle
├── proguard-rules.pro
└── src
│ └── main
│ ├── AndroidManifest.xml
│ ├── java
│ └── cz
│ │ └── helmisek
│ │ └── android
│ │ └── androidvipersample
│ │ ├── ViperApp.java
│ │ ├── ViperConfig.java
│ │ ├── activity
│ │ └── WeatherActivity.java
│ │ ├── api
│ │ └── WeatherAPIEndpoint.java
│ │ ├── core
│ │ ├── entity
│ │ │ └── api
│ │ │ │ ├── Clouds.java
│ │ │ │ ├── Coord.java
│ │ │ │ ├── CurrentWeatherEntity.java
│ │ │ │ ├── Main.java
│ │ │ │ ├── Sys.java
│ │ │ │ ├── Weather.java
│ │ │ │ └── Wind.java
│ │ ├── interactor
│ │ │ ├── RetrofitApiInteractor.java
│ │ │ ├── WeatherInteractor.java
│ │ │ └── contract
│ │ │ │ └── WeatherViewModelInteractorContract.java
│ │ ├── presenter
│ │ │ └── WeatherActivityPresenter.java
│ │ ├── router
│ │ │ └── WeatherRouter.java
│ │ ├── viewinteractor
│ │ │ ├── WeatherActivityViewInteractor.java
│ │ │ └── WeatherPresenterViewModelContract.java
│ │ └── viewmodel
│ │ │ └── WeatherActivityViewModel.java
│ │ └── util
│ │ └── StringUtils.java
│ └── res
│ ├── drawable
│ └── ic_weather_cloudy.xml
│ ├── layout
│ └── activity_weather.xml
│ ├── mipmap-hdpi
│ └── ic_launcher.png
│ ├── mipmap-mdpi
│ └── ic_launcher.png
│ ├── mipmap-xhdpi
│ └── ic_launcher.png
│ ├── mipmap-xxhdpi
│ └── ic_launcher.png
│ ├── mipmap-xxxhdpi
│ └── ic_launcher.png
│ ├── values-w820dp
│ └── dimens.xml
│ └── values
│ ├── colors.xml
│ ├── dimens.xml
│ ├── strings.xml
│ └── styles.xml
└── settings.gradle
/.gitignore:
--------------------------------------------------------------------------------
1 | # Built application files
2 | *.apk
3 | *.ap_
4 |
5 | # Files for the ART/Dalvik VM
6 | *.dex
7 |
8 | # Java class files
9 | *.class
10 |
11 | # Generated files
12 | bin/
13 | gen/
14 | out/
15 |
16 | # Gradle files
17 | .gradle/
18 | build/
19 |
20 | # Local configuration file (sdk path, etc)
21 | local.properties
22 |
23 | # Proguard folder generated by Eclipse
24 | proguard/
25 |
26 | # Log Files
27 | *.log
28 |
29 | # Android Studio Navigation editor temp files
30 | .navigation/
31 |
32 | # Android Studio captures folder
33 | captures/
34 |
35 | # Intellij
36 | *.iml
37 | .idea/workspace.xml
38 | .idea/
39 |
40 | # Keystore files
41 | *.jks
--------------------------------------------------------------------------------
/AndroidRxViper.iml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright {yyyy} {name of copyright owner}
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Android Viper
2 |
3 | Android implementation of VIPER architecture inspired by Clean Architecture by Robert Martin but extended by ViewModel pattern.
4 |
5 | # Layers
6 |
7 | 
8 |
9 |
10 | # Authors
11 |
12 | Jiří Helmich
--------------------------------------------------------------------------------
/architecture_layers.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/quant-eagle/android-viper/3c094c063cf05310b1595e90b9c94aa9975a0461/architecture_layers.jpg
--------------------------------------------------------------------------------
/build.gradle:
--------------------------------------------------------------------------------
1 | // Top-level build file where you can add configuration options common to all sub-projects/modules.
2 |
3 | buildscript {
4 | repositories {
5 | jcenter()
6 | }
7 | dependencies {
8 | classpath 'com.android.tools.build:gradle:2.2.0'
9 |
10 | // NOTE: Do not place your application dependencies here; they belong
11 | // in the individual module build.gradle files
12 | }
13 | }
14 |
15 | allprojects {
16 | repositories {
17 | jcenter()
18 | }
19 | }
20 |
21 | task clean(type: Delete) {
22 | delete rootProject.buildDir
23 | }
24 |
--------------------------------------------------------------------------------
/gradle.properties:
--------------------------------------------------------------------------------
1 | # Project-wide Gradle settings.
2 |
3 | # IDE (e.g. Android Studio) users:
4 | # Gradle settings configured through the IDE *will override*
5 | # any settings specified in this file.
6 |
7 | # For more details on how to configure your build environment visit
8 | # http://www.gradle.org/docs/current/userguide/build_environment.html
9 |
10 | # Specifies the JVM arguments used for the daemon process.
11 | # The setting is particularly useful for tweaking memory settings.
12 | org.gradle.jvmargs=-Xmx1536m
13 |
14 | # When configured, Gradle will run in incubating parallel mode.
15 | # This option should only be used with decoupled projects. More details, visit
16 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
17 | # org.gradle.parallel=true
18 |
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/quant-eagle/android-viper/3c094c063cf05310b1595e90b9c94aa9975a0461/gradle/wrapper/gradle-wrapper.jar
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | #Mon Dec 28 10:00:20 PST 2015
2 | distributionBase=GRADLE_USER_HOME
3 | distributionPath=wrapper/dists
4 | zipStoreBase=GRADLE_USER_HOME
5 | zipStorePath=wrapper/dists
6 | distributionUrl=https\://services.gradle.org/distributions/gradle-2.14.1-all.zip
7 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
10 | DEFAULT_JVM_OPTS=""
11 |
12 | APP_NAME="Gradle"
13 | APP_BASE_NAME=`basename "$0"`
14 |
15 | # Use the maximum available, or set MAX_FD != -1 to use that value.
16 | MAX_FD="maximum"
17 |
18 | warn ( ) {
19 | echo "$*"
20 | }
21 |
22 | die ( ) {
23 | echo
24 | echo "$*"
25 | echo
26 | exit 1
27 | }
28 |
29 | # OS specific support (must be 'true' or 'false').
30 | cygwin=false
31 | msys=false
32 | darwin=false
33 | case "`uname`" in
34 | CYGWIN* )
35 | cygwin=true
36 | ;;
37 | Darwin* )
38 | darwin=true
39 | ;;
40 | MINGW* )
41 | msys=true
42 | ;;
43 | esac
44 |
45 | # Attempt to set APP_HOME
46 | # Resolve links: $0 may be a link
47 | PRG="$0"
48 | # Need this for relative symlinks.
49 | while [ -h "$PRG" ] ; do
50 | ls=`ls -ld "$PRG"`
51 | link=`expr "$ls" : '.*-> \(.*\)$'`
52 | if expr "$link" : '/.*' > /dev/null; then
53 | PRG="$link"
54 | else
55 | PRG=`dirname "$PRG"`"/$link"
56 | fi
57 | done
58 | SAVED="`pwd`"
59 | cd "`dirname \"$PRG\"`/" >/dev/null
60 | APP_HOME="`pwd -P`"
61 | cd "$SAVED" >/dev/null
62 |
63 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
64 |
65 | # Determine the Java command to use to start the JVM.
66 | if [ -n "$JAVA_HOME" ] ; then
67 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
68 | # IBM's JDK on AIX uses strange locations for the executables
69 | JAVACMD="$JAVA_HOME/jre/sh/java"
70 | else
71 | JAVACMD="$JAVA_HOME/bin/java"
72 | fi
73 | if [ ! -x "$JAVACMD" ] ; then
74 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
75 |
76 | Please set the JAVA_HOME variable in your environment to match the
77 | location of your Java installation."
78 | fi
79 | else
80 | JAVACMD="java"
81 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
82 |
83 | Please set the JAVA_HOME variable in your environment to match the
84 | location of your Java installation."
85 | fi
86 |
87 | # Increase the maximum file descriptors if we can.
88 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then
89 | MAX_FD_LIMIT=`ulimit -H -n`
90 | if [ $? -eq 0 ] ; then
91 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
92 | MAX_FD="$MAX_FD_LIMIT"
93 | fi
94 | ulimit -n $MAX_FD
95 | if [ $? -ne 0 ] ; then
96 | warn "Could not set maximum file descriptor limit: $MAX_FD"
97 | fi
98 | else
99 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
100 | fi
101 | fi
102 |
103 | # For Darwin, add options to specify how the application appears in the dock
104 | if $darwin; then
105 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
106 | fi
107 |
108 | # For Cygwin, switch paths to Windows format before running java
109 | if $cygwin ; then
110 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
111 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
112 | JAVACMD=`cygpath --unix "$JAVACMD"`
113 |
114 | # We build the pattern for arguments to be converted via cygpath
115 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
116 | SEP=""
117 | for dir in $ROOTDIRSRAW ; do
118 | ROOTDIRS="$ROOTDIRS$SEP$dir"
119 | SEP="|"
120 | done
121 | OURCYGPATTERN="(^($ROOTDIRS))"
122 | # Add a user-defined pattern to the cygpath arguments
123 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
124 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
125 | fi
126 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
127 | i=0
128 | for arg in "$@" ; do
129 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
130 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
131 |
132 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
133 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
134 | else
135 | eval `echo args$i`="\"$arg\""
136 | fi
137 | i=$((i+1))
138 | done
139 | case $i in
140 | (0) set -- ;;
141 | (1) set -- "$args0" ;;
142 | (2) set -- "$args0" "$args1" ;;
143 | (3) set -- "$args0" "$args1" "$args2" ;;
144 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
145 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
146 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
147 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
148 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
149 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
150 | esac
151 | fi
152 |
153 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
154 | function splitJvmOpts() {
155 | JVM_OPTS=("$@")
156 | }
157 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
158 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
159 |
160 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"
161 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @if "%DEBUG%" == "" @echo off
2 | @rem ##########################################################################
3 | @rem
4 | @rem Gradle startup script for Windows
5 | @rem
6 | @rem ##########################################################################
7 |
8 | @rem Set local scope for the variables with windows NT shell
9 | if "%OS%"=="Windows_NT" setlocal
10 |
11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
12 | set DEFAULT_JVM_OPTS=
13 |
14 | set DIRNAME=%~dp0
15 | if "%DIRNAME%" == "" set DIRNAME=.
16 | set APP_BASE_NAME=%~n0
17 | set APP_HOME=%DIRNAME%
18 |
19 | @rem Find java.exe
20 | if defined JAVA_HOME goto findJavaFromJavaHome
21 |
22 | set JAVA_EXE=java.exe
23 | %JAVA_EXE% -version >NUL 2>&1
24 | if "%ERRORLEVEL%" == "0" goto init
25 |
26 | echo.
27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28 | echo.
29 | echo Please set the JAVA_HOME variable in your environment to match the
30 | echo location of your Java installation.
31 |
32 | goto fail
33 |
34 | :findJavaFromJavaHome
35 | set JAVA_HOME=%JAVA_HOME:"=%
36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37 |
38 | if exist "%JAVA_EXE%" goto init
39 |
40 | echo.
41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42 | echo.
43 | echo Please set the JAVA_HOME variable in your environment to match the
44 | echo location of your Java installation.
45 |
46 | goto fail
47 |
48 | :init
49 | @rem Get command-line arguments, handling Windowz variants
50 |
51 | if not "%OS%" == "Windows_NT" goto win9xME_args
52 | if "%@eval[2+2]" == "4" goto 4NT_args
53 |
54 | :win9xME_args
55 | @rem Slurp the command line arguments.
56 | set CMD_LINE_ARGS=
57 | set _SKIP=2
58 |
59 | :win9xME_args_slurp
60 | if "x%~1" == "x" goto execute
61 |
62 | set CMD_LINE_ARGS=%*
63 | goto execute
64 |
65 | :4NT_args
66 | @rem Get arguments from the 4NT Shell from JP Software
67 | set CMD_LINE_ARGS=%$
68 |
69 | :execute
70 | @rem Setup the command line
71 |
72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
73 |
74 | @rem Execute Gradle
75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
76 |
77 | :end
78 | @rem End local scope for the variables with windows NT shell
79 | if "%ERRORLEVEL%"=="0" goto mainEnd
80 |
81 | :fail
82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
83 | rem the _cmd.exe /c_ return code!
84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
85 | exit /b 1
86 |
87 | :mainEnd
88 | if "%OS%"=="Windows_NT" endlocal
89 |
90 | :omega
91 |
--------------------------------------------------------------------------------
/lib/.gitignore:
--------------------------------------------------------------------------------
1 | /build
2 |
--------------------------------------------------------------------------------
/lib/build.gradle:
--------------------------------------------------------------------------------
1 | apply plugin: 'com.android.library'
2 |
3 | android {
4 | compileSdkVersion 24
5 | buildToolsVersion "24.0.1"
6 |
7 | defaultConfig {
8 | minSdkVersion 16
9 | targetSdkVersion 24
10 | versionCode 1
11 | versionName "1.0"
12 | }
13 | dataBinding {
14 | enabled = true;
15 | }
16 | buildTypes {
17 | release {
18 | minifyEnabled false
19 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
20 | }
21 | }
22 | }
23 |
24 | dependencies {
25 | compile fileTree(dir: 'libs', include: ['*.jar'])
26 |
27 | compile 'com.android.support:appcompat-v7:24.2.0'
28 | }
29 |
--------------------------------------------------------------------------------
/lib/proguard-rules.pro:
--------------------------------------------------------------------------------
1 | # Add project specific ProGuard rules here.
2 | # By default, the flags in this file are appended to flags specified
3 | # in /Users/jirik/Library/Android/sdk/tools/proguard/proguard-android.txt
4 | # You can edit the include path and order by changing the proguardFiles
5 | # directive in build.gradle.
6 | #
7 | # For more details, see
8 | # http://developer.android.com/guide/developing/tools/proguard.html
9 |
10 | # Add any project specific keep options here:
11 |
12 | # If your project uses WebView with JS, uncomment the following
13 | # and specify the fully qualified class name to the JavaScript interface
14 | # class:
15 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
16 | # public *;
17 | #}
18 |
--------------------------------------------------------------------------------
/lib/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
3 |
4 |
9 |
10 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/lib/src/main/java/cz/helmisek/android/androidviper/core/contract/InteractorContract.java:
--------------------------------------------------------------------------------
1 | package cz.helmisek.android.androidviper.core.contract;
2 |
3 | import android.content.Context;
4 | import android.content.res.Resources;
5 |
6 |
7 | /**
8 | * The interface contract for {@link cz.helmisek.android.androidviper.core.interactor.Interactor} which should provide
9 | * basic needs for every instance of this type and it's descendants.
10 | */
11 | public interface InteractorContract
12 | {
13 | /**
14 | * Get provided {@link Context} to work with.
15 | *
16 | * @return Provided {@link Context} instance
17 | */
18 | Context getContext();
19 |
20 | /**
21 | * Get provided {@link Resources} to work with.
22 | *
23 | * @return Provided {@link Resources} instance
24 | */
25 | Resources getResources();
26 | }
27 |
--------------------------------------------------------------------------------
/lib/src/main/java/cz/helmisek/android/androidviper/core/contract/PresenterContract.java:
--------------------------------------------------------------------------------
1 | package cz.helmisek.android.androidviper.core.contract;
2 |
3 | import cz.helmisek.android.androidviper.core.viewmodel.ViewModel;
4 |
5 | /**
6 | * Default behavior description for every {@link cz.helmisek.android.androidviper.core.presenter.Presenter}.
7 | *
8 | * @param Any descendant of {@link ViewModel} to use with this instance of {@link cz.helmisek.android.androidviper.core.presenter.Presenter}
9 | * */
10 | public interface PresenterContract
11 | {
12 |
13 | /**
14 | * Initialize an instace of ViewModel and return it
15 | *
16 | * @return VM - freshly created instance of {@link ViewModel}
17 | */
18 | VM initViewModel();
19 |
20 | /**
21 | * Return an instance of specific ViewModel
22 | *
23 | * @return VM - instance of {@link ViewModel}
24 | */
25 | VM getViewModel();
26 |
27 | /**
28 | * onPresenterDetached impl for Presenter - should be called in a lifecycle of presenter held by a view
29 | */
30 | void onPresenterDetached(boolean wasDestroyed);
31 |
32 | /**
33 | * onPresenterAttached impl for Presenter - should be called in a lifecycle of presenter held by a view
34 | */
35 | void onPresenterAttached(boolean firstAttachment);
36 |
37 | }
38 |
--------------------------------------------------------------------------------
/lib/src/main/java/cz/helmisek/android/androidviper/core/contract/ViewModelContract.java:
--------------------------------------------------------------------------------
1 | package cz.helmisek.android.androidviper.core.contract;
2 |
3 | import cz.helmisek.android.androidviper.core.interactor.Interactor;
4 |
5 |
6 | /**
7 | * Behavior description for {@link cz.helmisek.android.androidviper.core.viewmodel.ViewModel}
8 | * which should always implement it.
9 | *
10 | * @param any descendant of {@link Interactor} class to use with
11 | * this {@link cz.helmisek.android.androidviper.core.viewmodel.ViewModel} instance.
12 | */
13 | public interface ViewModelContract
14 | {
15 | /**
16 | * Should be called only once on fresh
17 | * {@link cz.helmisek.android.androidviper.core.viewmodel.ViewModel} instance creation.
18 | */
19 | void onViewModelCreated();
20 |
21 | /**
22 | * Should be called when {@link cz.helmisek.android.androidviper.core.presenter.Presenter} is about to get
23 | * removed from the memory and so is going to die as well as its children.
24 | */
25 | void onViewModelRemoved();
26 |
27 | /**
28 | * Called every time {@link cz.helmisek.android.androidviper.core.presenter.Presenter} is reattached to a window or
29 | * when it has been created.
30 | *
31 | * @param firstAttachment - result of expression (if {@link cz.helmisek.android.androidviper.core.presenter.Presenter}
32 | * was attached to the window for the first time)
33 | * */
34 | void onViewModelAttached(boolean firstAttachment);
35 |
36 | /**
37 | * Unsubscribe method is called when {@link cz.helmisek.android.androidviper.core.viewmodel.ViewModel}
38 | * is being detached, finishing or destroyed. (See @param wasDestroyed)
39 | *
40 | * @param wasDestroyed - if true, then this
41 | * instance of {@link cz.helmisek.android.androidviper.core.viewmodel.ViewModel} is not going to live anymore.
42 | * Else it is going to be revived later (on config change etc).
43 | */
44 | void onViewModelDetached(boolean wasDestroyed);
45 |
46 | /**
47 | * Initialization of freshly new {@link Interactor} descendant instance for
48 | * this {@link cz.helmisek.android.androidviper.core.viewmodel.ViewModel} instance.
49 | *
50 | * @return new instance of {@link Interactor} descendant.
51 | */
52 | I initInteractor();
53 | }
54 |
--------------------------------------------------------------------------------
/lib/src/main/java/cz/helmisek/android/androidviper/core/contract/ViewPresenterContract.java:
--------------------------------------------------------------------------------
1 | package cz.helmisek.android.androidviper.core.contract;
2 |
3 | import cz.helmisek.android.androidviper.core.presenter.Presenter;
4 |
5 |
6 | /**
7 | * The interface View presenter default contract.
8 | *
9 | * @param
any descendant of {@link Presenter} to use.
10 | */
11 | public interface ViewPresenterContract
12 | {
13 | /**
14 | * Initialize new instance of {@link Presenter} to use with any view, which should use {@link Presenter}.
15 | *
16 | * @return freshly initialized instance of {@link Presenter}
17 | */
18 | P initPresenter();
19 | }
20 |
--------------------------------------------------------------------------------
/lib/src/main/java/cz/helmisek/android/androidviper/core/interactor/Interactor.java:
--------------------------------------------------------------------------------
1 | package cz.helmisek.android.androidviper.core.interactor;
2 |
3 | import android.content.Context;
4 | import android.content.res.Resources;
5 |
6 | import cz.helmisek.android.androidviper.core.contract.InteractorContract;
7 |
8 |
9 | /**
10 | * Base interactor implementation. Implements contract to use provided {@link Context} and {@link Resources}.
11 | * Interactor class dependants should only take care of raw data gathering and preparation for specific bounded
12 | * instance of {@link cz.helmisek.android.androidviper.core.viewmodel.ViewModel}.
13 | */
14 | public abstract class Interactor implements InteractorContract
15 | {
16 | /**
17 | * Contract which provides all descendants with all
18 | * the basic needs such as {@link Context} or {@link Resources}
19 | * to work with system to gather data
20 | * without any further necessary implementation out of the box.
21 | */
22 | private InteractorContract mInteractorContract;
23 |
24 |
25 | public abstract IDC initDataContract();
26 |
27 |
28 | private IDC mInteractorDataContract;
29 |
30 |
31 | /**
32 | * Bind an already implemented contract.
33 | *
34 | * @param contract An already implemented contract.
35 | */
36 | public void bind(final InteractorContract contract)
37 | {
38 | this.mInteractorContract = contract;
39 | }
40 |
41 |
42 | /**
43 | * Get an already implemented data contract.
44 | */
45 | public IDC getInteractorDataContract()
46 | {
47 | return this.mInteractorDataContract;
48 | }
49 |
50 |
51 | /**
52 | * Initialization method, being run right after {@link #bind(InteractorContract)}.
53 | * If you need to set some more additional things to your Interactor instance you should do it in here.
54 | * At this point unlike by using constructor, you have access to {@link InteractorContract} methods.
55 | */
56 | public void init()
57 | {
58 | this.mInteractorDataContract = initDataContract();
59 | }
60 |
61 |
62 | @Override
63 | public Context getContext()
64 | {
65 | return this.mInteractorContract.getContext();
66 | }
67 |
68 |
69 | @Override
70 | public Resources getResources()
71 | {
72 | return this.mInteractorContract.getResources();
73 | }
74 | }
75 |
--------------------------------------------------------------------------------
/lib/src/main/java/cz/helmisek/android/androidviper/core/presenter/Presenter.java:
--------------------------------------------------------------------------------
1 | package cz.helmisek.android.androidviper.core.presenter;
2 |
3 | import android.content.Context;
4 | import android.databinding.ViewDataBinding;
5 | import android.support.annotation.NonNull;
6 |
7 | import java.io.Serializable;
8 |
9 | import cz.helmisek.android.androidviper.core.contract.PresenterContract;
10 | import cz.helmisek.android.androidviper.core.util.ViewWrapper;
11 | import cz.helmisek.android.androidviper.core.viewmodel.ViewModel;
12 |
13 |
14 | /**
15 | * Presenter class implementation, which is the most important layer between the View and our structure.
16 | * Presenter class should handle View interactions and respond to them by defined actions in our layer structure.
17 | *
18 | * @param an instance of {@link ViewModel} dependant
19 | * @param an instance of {@link ViewDataBinding} dependant
20 | */
21 | public abstract class Presenter implements PresenterContract, Serializable
22 | {
23 | /**
24 | * Bounded {@link ViewModel} descendant instance.
25 | * Used to control View states, behavior and data on View interactions.
26 | */
27 | private VM mViewModel;
28 |
29 | /**
30 | * ViewWrapper instance to provide all necessary View related objects to all of the descendants.
31 | */
32 | private ViewWrapper mWrapper;
33 |
34 | /**
35 | * Describing whether this attachment went trough its initial attachment or not.
36 | */
37 | private boolean firstAttachment = true;
38 |
39 |
40 | /**
41 | * Should be called only once when this instance is created and initialized.
42 | */
43 | public void onPresenterCreated()
44 | {
45 | this.mViewModel = initViewModel();
46 | this.mViewModel.bind(mWrapper);
47 | this.mViewModel.onViewModelCreated();
48 | }
49 |
50 |
51 | /**
52 | * Called when presenter is attached to the View.
53 | *
54 | * @param firstAttachment First attachment of this instance to the View
55 | */
56 | public void onPresenterAttached(boolean firstAttachment)
57 | {
58 | this.mViewModel.onViewModelAttached(firstAttachment);
59 | }
60 |
61 |
62 | /**
63 | * Called when presenter is detached from the View.
64 | *
65 | * @param wasDestroyed Describes whether this instance of presenter has been totally destroyed or just finished.
66 | */
67 | public void onPresenterDetached(boolean wasDestroyed)
68 | {
69 | if(firstAttachment)
70 | {
71 | firstAttachment = false;
72 | }
73 |
74 | this.mViewModel.onViewModelDetached(wasDestroyed);
75 | }
76 |
77 |
78 | /**
79 | * Called when presenter is removed from memory.
80 | */
81 | public void onPresenterRemoved()
82 | {
83 | this.mViewModel.onViewModelRemoved();
84 | }
85 |
86 |
87 | /**
88 | * System life cycle impl method - On resume.
89 | */
90 | public void onResume()
91 | {
92 | }
93 |
94 |
95 | /**
96 | * System life cycle impl method - On pause.
97 | */
98 | public void onPause()
99 | {
100 | }
101 |
102 |
103 | /**
104 | * Is first attachment boolean.
105 | *
106 | * @return the boolean
107 | */
108 | public boolean isFirstAttachment()
109 | {
110 | return firstAttachment;
111 | }
112 |
113 |
114 | /**
115 | * Gets context.
116 | *
117 | * @return the context
118 | */
119 | public Context getContext()
120 | {
121 | return mWrapper.getContext();
122 | }
123 |
124 |
125 | /**
126 | * Gets binding.
127 | *
128 | * @return the binding
129 | */
130 | public VB getBinding()
131 | {
132 | return mWrapper.getBinding();
133 | }
134 |
135 |
136 | @Override
137 | public VM getViewModel()
138 | {
139 | return this.mViewModel;
140 | }
141 |
142 |
143 | /**
144 | * Bind already defined and initialized instance of {@link ViewWrapper} to this instance.
145 | *
146 | * @param viewWrapper NonNull instance of {@link ViewWrapper}
147 | */
148 | public void bind(@NonNull ViewWrapper viewWrapper)
149 | {
150 | this.mWrapper = viewWrapper;
151 |
152 | if(this.mViewModel != null)
153 | this.mViewModel.bind(viewWrapper);
154 | }
155 |
156 | }
157 |
--------------------------------------------------------------------------------
/lib/src/main/java/cz/helmisek/android/androidviper/core/router/Router.java:
--------------------------------------------------------------------------------
1 | package cz.helmisek.android.androidviper.core.router;
2 |
3 | /**
4 | * Router should be used as simple class with defined static methods to start new screen-related actions
5 | * for our screens. So it should implement methods to start a new Activity, provide start Intents or to provide
6 | * new instances of our Fragments.
7 | */
8 | public abstract class Router
9 | {
10 | }
11 |
--------------------------------------------------------------------------------
/lib/src/main/java/cz/helmisek/android/androidviper/core/util/ViewWrapper.java:
--------------------------------------------------------------------------------
1 | package cz.helmisek.android.androidviper.core.util;
2 |
3 | import android.app.Activity;
4 | import android.content.Context;
5 | import android.databinding.ViewDataBinding;
6 |
7 | import cz.helmisek.android.androidviper.core.presenter.Presenter;
8 |
9 |
10 | /**
11 | * The interface describing View holding our {@link Presenter} instance - View could be referred to as one of following
12 | * {@link android.support.v4.app.Fragment} or {@link Activity}.
13 | *
14 | * Methods described here are propagated to our {@link Presenter} instance to be accessed there.
15 | *
16 | * @param any {@link ViewDataBinding} type
17 | * @param any type of {@link Presenter}
18 | */
19 | public interface ViewWrapper
20 | {
21 | /**
22 | * Get layout id for layout inflation to the View.
23 | *
24 | * @return LayoutId from R.java
25 | */
26 | int getLayoutId();
27 |
28 | /**
29 | * Gets context.
30 | *
31 | * @return provided instance of {@link Context}
32 | */
33 | Context getContext();
34 |
35 | /**
36 | * Get specific instance of any {@link Presenter} descendant.
37 | *
38 | * @return Defined instance of {@link Presenter}
39 | */
40 | PR getPresenter();
41 |
42 | /**
43 | * Get provided descendant of {@link ViewDataBinding} instance.
44 | *
45 | * @return Provided instance of {@link ViewDataBinding} instance
46 | */
47 | VB getBinding();
48 |
49 | /**
50 | * Get an instance of {@link Activity} holding our {@link Presenter} instance.
51 | *
52 | * @return Provided instance of {@link Activity}
53 | */
54 | Activity getActivityContext();
55 | }
56 |
--------------------------------------------------------------------------------
/lib/src/main/java/cz/helmisek/android/androidviper/core/util/ViperConfig.java:
--------------------------------------------------------------------------------
1 | package cz.helmisek.android.androidviper.core.util;
2 |
3 | /**
4 | * Viper config implementation.
5 | */
6 | public class ViperConfig
7 | {
8 | private enum ViperConfigMode
9 | {
10 | STANDARD,
11 | NON_STANDARD;
12 | }
13 |
14 |
15 | private int mPresenterVariableId;
16 | private int mViewModelVariableId;
17 | private ViperConfigMode mViperConfigMode = ViperConfigMode.STANDARD;
18 | private CustomBindingVariable[] customBindingVariablesArray;
19 |
20 |
21 | /**
22 | * Instantiates a new Viper config instance.
23 | *
24 | * @param presenterVariableId the {@link cz.helmisek.android.androidviper.core.presenter.Presenter} binding variable id
25 | */
26 | public ViperConfig(int presenterVariableId)
27 | {
28 | this(presenterVariableId, -1);
29 | }
30 |
31 |
32 | /**
33 | * Instantiates a new Viper config instance.
34 | *
35 | * @param presenterVariableId the {@link cz.helmisek.android.androidviper.core.presenter.Presenter} binding variable id
36 | * @param viewModelVariableId the {@link cz.helmisek.android.androidviper.core.viewmodel.ViewModel} binding variable id
37 | */
38 | public ViperConfig(int presenterVariableId, int viewModelVariableId)
39 | {
40 | this.mPresenterVariableId = presenterVariableId;
41 | this.mViewModelVariableId = viewModelVariableId;
42 | }
43 |
44 |
45 | /**
46 | * Instantiates a new Viper config instance.
47 | *
48 | * @param customBindingVariablesArray Array consisting of {@link CustomBindingVariable} objects defining
49 | * binding variables to be rebound to their object after configuration changes.
50 | */
51 | public ViperConfig(CustomBindingVariable[] customBindingVariablesArray)
52 | {
53 | this(-1, -1);
54 | this.customBindingVariablesArray = customBindingVariablesArray;
55 | this.mViperConfigMode = ViperConfigMode.NON_STANDARD;
56 | }
57 |
58 |
59 | /**
60 | * Gets presenter variable id.
61 | *
62 | * @return the presenter variable id
63 | */
64 | int getPresenterVariableId()
65 | {
66 | return this.mPresenterVariableId;
67 | }
68 |
69 |
70 | /**
71 | * Gets view model variable id.
72 | *
73 | * @return the view model variable id
74 | */
75 | int getViewModelVariableId()
76 | {
77 | return this.mViewModelVariableId;
78 | }
79 |
80 |
81 | /**
82 | * Get custom binding variables array custom binding variable [ ].
83 | *
84 | * @return the custom binding variable [ ]
85 | */
86 | CustomBindingVariable[] getCustomBindingVariablesArray()
87 | {
88 | return this.customBindingVariablesArray;
89 | }
90 |
91 |
92 | /**
93 | * Has view model boolean.
94 | *
95 | * @return the boolean
96 | */
97 | boolean hasViewModel()
98 | {
99 | return mViewModelVariableId != -1;
100 | }
101 |
102 |
103 | /**
104 | * Is standard boolean.
105 | *
106 | * @return the boolean
107 | */
108 | boolean isStandard()
109 | {
110 | return this.mViperConfigMode == ViperConfigMode.STANDARD;
111 | }
112 |
113 |
114 | /**
115 | * The type Custom binding variable.
116 | */
117 | static class CustomBindingVariable
118 | {
119 | private int variableId;
120 | private Object mObject;
121 |
122 |
123 | /**
124 | * Instantiates a new Custom binding variable.
125 | *
126 | * @param object the object
127 | * @param variableId the variable id
128 | */
129 | public CustomBindingVariable(Object object, int variableId)
130 | {
131 | this.mObject = object;
132 | this.variableId = variableId;
133 | }
134 |
135 |
136 | /**
137 | * Gets variable id.
138 | *
139 | * @return the variable id
140 | */
141 | int getVariableId()
142 | {
143 | return this.variableId;
144 | }
145 |
146 |
147 | /**
148 | * Gets object.
149 | *
150 | * @return the object
151 | */
152 | Object getObject()
153 | {
154 | return this.mObject;
155 | }
156 |
157 |
158 | @Override
159 | public String toString()
160 | {
161 | return "CustomBindingVariable{" +
162 | "variableId=" + variableId +
163 | ", mObject=" + mObject +
164 | '}';
165 | }
166 | }
167 | }
168 |
--------------------------------------------------------------------------------
/lib/src/main/java/cz/helmisek/android/androidviper/core/util/ViperHelper.java:
--------------------------------------------------------------------------------
1 | package cz.helmisek.android.androidviper.core.util;
2 |
3 | import android.app.Activity;
4 | import android.databinding.DataBindingUtil;
5 | import android.databinding.ViewDataBinding;
6 | import android.os.Bundle;
7 | import android.support.annotation.NonNull;
8 | import android.support.annotation.Nullable;
9 | import android.support.v4.app.Fragment;
10 | import android.util.Log;
11 | import android.view.LayoutInflater;
12 | import android.view.ViewGroup;
13 |
14 | import java.util.UUID;
15 |
16 | import cz.helmisek.android.androidviper.core.contract.ViewPresenterContract;
17 | import cz.helmisek.android.androidviper.core.presenter.Presenter;
18 |
19 |
20 | /**
21 | * ViperHelper utility class should handle all the connections in the VIPER framework
22 | * utilize the background work for all the views and decrease boilerplate code amount in them.
23 | *
24 | * @param the type parameter
25 | * @param the type parameter
26 | */
27 | public class ViperHelper
28 | {
29 |
30 | /**
31 | * Constant TAG for Logcat logging
32 | */
33 | private static final String LOG_TAG = ViperHelper.class.getSimpleName();
34 | /**
35 | * Internal presenter ID for all operations tied to specific type of {@link Presenter}
36 | */
37 | private String mPresenterId;
38 | /**
39 | * View specific type of {@link ViewDataBinding}
40 | */
41 | private VB mBinding;
42 | /**
43 | * View specific type of {@link Presenter}
44 | */
45 | private PR mPresenter;
46 | /**
47 | * An instance of {@link ViperConfig} to control DataBinding variables tied to layouts.
48 | */
49 | private ViperConfig mViperConfig;
50 |
51 | /* ViperHelper specific variables for flow controlling */
52 | private boolean mInstanceRemoved;
53 | private boolean mOnSaveInstanceCalled;
54 | private boolean mAlreadyCreated;
55 |
56 |
57 | /**
58 | * OnCreate implementation for both {@link Fragment} and {@link Activity}.
59 | * Should be called in {@link Fragment#onCreateView(LayoutInflater, ViewGroup, Bundle)} or
60 | * {@link Activity#onCreate(Bundle)} to prepare the {@link Presenter} and provide all the necessary object through
61 | * implementations.
62 | *
63 | * @param view {@link ViewWrapper} initialized instance to provide object to lower levels
64 | * @param presenterContract {@link ViewPresenterContract} initialized contract to allow us init specific
65 | * presenter through abstraction
66 | * @param savedInstanceState Saved instance state provided by {@link Fragment} or {@link Activity}
67 | */
68 | public void onCreate(@NonNull final ViewWrapper view, ViewPresenterContract presenterContract, @Nullable Bundle savedInstanceState)
69 | {
70 | // skip if already created
71 | if(this.mAlreadyCreated) return;
72 | initializeView(view);
73 | obtainPresenterId(savedInstanceState);
74 | setupPresenter(view, presenterContract);
75 | rebind(view);
76 | this.mPresenter.onPresenterAttached(this.mPresenter.isFirstAttachment());
77 | }
78 |
79 |
80 | /**
81 | * Setup presenter for the specific View.
82 | *
83 | * @param view {@link ViewWrapper} initialized instance to provide object to lower levels
84 | * @param presenterDefaultContract {@link ViewPresenterContract} initialized contract to allow us init specific
85 | * presenter through abstraction
86 | */
87 | private void setupPresenter(@NonNull ViewWrapper view, ViewPresenterContract presenterDefaultContract)
88 | {
89 | // get presenter instance for this screen
90 | this.mPresenter = (PR) ViperProvider.getInstance().getPresenter(this.mPresenterId, presenterDefaultContract);
91 | this.mOnSaveInstanceCalled = false;
92 |
93 | bindPresenter(view);
94 | }
95 |
96 |
97 | /**
98 | * Bind {@link ViewWrapper} to {@link Presenter} to ensure we have our View implementation provided in Presenter.
99 | *
100 | * @param view {@link ViewWrapper} initialized instance to provide object to lower levels
101 | */
102 | private void bindPresenter(@NonNull ViewWrapper view)
103 | {
104 | // bind all together
105 | this.mPresenter.bind(view);
106 |
107 | // call Presenter callback
108 | if(this.mPresenter.isFirstAttachment())
109 | this.mPresenter.onPresenterCreated();
110 | }
111 |
112 |
113 | /**
114 | * Obtain PresenterId based on our @param savedInstanceState.
115 | * If null we, therefore we dont have any Presenter saved and we create a new special ID for currently used
116 | * Presenter, else we obtain the PresenterId from the Bundle and assign it to our {@link ViperHelper#mPresenterId}
117 | * for later use.
118 | *
119 | * @param savedInstanceState Saved instance state provided by {@link Fragment} or {@link Activity}
120 | */
121 | private void obtainPresenterId(final @Nullable Bundle savedInstanceState)
122 | {
123 | // obtain unique PresenterId
124 | if(this.mPresenterId == null)
125 | { // screen (activity/fragment) created for first time, attach unique ID
126 | if(savedInstanceState == null)
127 | this.mPresenterId = UUID.randomUUID().toString();
128 | else
129 | this.mPresenterId = savedInstanceState.getString(getPresenterIdFieldName());
130 | }
131 | }
132 |
133 |
134 | /**
135 | * Initialize our implementor view using DataBinding.
136 | *
137 | * @param view {@link ViewWrapper} initialized instance to provide object to lower levels
138 | */
139 | private void initializeView(final @NonNull ViewWrapper view)
140 | {
141 | // perform Data Binding initialization
142 | this.mAlreadyCreated = true;
143 |
144 | if(view instanceof Activity)
145 | this.mBinding = DataBindingUtil.setContentView(((Activity) view), view.getLayoutId());
146 | else if(view instanceof Fragment)
147 | this.mBinding = DataBindingUtil.inflate(LayoutInflater.from(view.getContext()), view.getLayoutId(), null, false);
148 | else
149 | throw new IllegalArgumentException("View must be an instance of Activity or Fragment (support-v4).");
150 | }
151 |
152 |
153 | /**
154 | * Rebind objects to their respective DataBinding variables such as Presenter or ViewModel.
155 | *
156 | * We do recognize 2 types right now. Standard and Non-Standard modes. {@see ViperConfig}
157 | *
158 | * @param view {@link ViewWrapper} initialized instance to provide object to lower levels
159 | */
160 | private void rebind(@NonNull ViewWrapper view)
161 | {
162 | if(this.mViperConfig.isStandard())
163 | {
164 | rebindStandard(view);
165 | }
166 | else
167 | {
168 | rebindNonStandard();
169 | }
170 | }
171 |
172 |
173 | /**
174 | * Rebind objects to DataBinding variables as defined in ViperConfig with use of CustomBindingVariable array.
175 | */
176 | private void rebindNonStandard()
177 | {
178 | for(ViperConfig.CustomBindingVariable bindingVariable : this.mViperConfig.getCustomBindingVariablesArray())
179 | {
180 | if(!this.mBinding.setVariable(bindingVariable.getVariableId(), bindingVariable.getObject()))
181 | {
182 | throw new IllegalArgumentException("Binding variable " + bindingVariable.toString() + " you have defined is not present or does not match any variable in your layout");
183 | }
184 | }
185 | }
186 |
187 |
188 | /**
189 | * Rebind objects do DataBinding variables in standard way, therefore assigning {@link Presenter} instance
190 | * and if present then {@link cz.helmisek.android.androidviper.core.viewmodel.ViewModel} instance as well.
191 | *
192 | * All of that is done with help of {@link ViperConfig}.
193 | *
194 | * @param view {@link ViewWrapper} initialized instance to provide object to lower levels
195 | */
196 | private void rebindStandard(@NonNull ViewWrapper view)
197 | {
198 | if(!this.mBinding.setVariable(this.mViperConfig.getPresenterVariableId(), this.mPresenter))
199 | {
200 | throw new IllegalArgumentException("Binding variable wasn't set successfully. Probably presenterVariableName of your " +
201 | "ViperConfig of " + view.getClass().getSimpleName() + " doesn't match any variable in "
202 | + this.mBinding.getClass().getSimpleName());
203 | }
204 | else
205 | {
206 | if(this.mViperConfig.hasViewModel())
207 | this.mBinding.setVariable(this.mViperConfig.getViewModelVariableId(), this.mPresenter.getViewModel());
208 | }
209 | }
210 |
211 |
212 | /**
213 | * Call from {@link Activity#onResume()} or {@link Fragment#onResume()}
214 | */
215 | public void onResume()
216 | {
217 | if(this.mPresenter != null) this.mPresenter.onResume();
218 | }
219 |
220 |
221 | /**
222 | * Call from {@link Activity#onPause()} or {@link Fragment#onPause()}
223 | */
224 | public void onPause()
225 | {
226 | if(this.mPresenter != null) this.mPresenter.onPause();
227 | }
228 |
229 |
230 | /**
231 | * Use in case this Presenter is associated with an {@link Fragment}
232 | * Call from {@link Fragment#onDestroyView()}.
233 | * Use in case Presenter is associated with Fragment.
234 | *
235 | * @param fragment {@link Fragment} instance
236 | */
237 | public void onDestroyView(@NonNull Fragment fragment)
238 | {
239 | if(this.mPresenter == null) return;
240 |
241 | if(fragment.getActivity() != null && fragment.getActivity().isFinishing())
242 | {
243 | this.mPresenter.onPresenterDetached(true);
244 | removePresenter();
245 | }
246 | else
247 | {
248 | this.mPresenter.onPresenterDetached(false);
249 | this.mAlreadyCreated = false;
250 | }
251 | }
252 |
253 |
254 | /**
255 | * Use in case this Presenter is associated with an {@link Fragment}
256 | * Call from {@link Fragment#onDestroy()}
257 | *
258 | * @param fragment Any instance of type {@link Fragment}
259 | */
260 | public void onDestroy(@NonNull Fragment fragment)
261 | {
262 | if(this.mPresenter == null) return;
263 |
264 | if(fragment.getActivity().isFinishing())
265 | {
266 | removePresenter();
267 | }
268 | else if(fragment.isRemoving() && !this.mOnSaveInstanceCalled)
269 | {
270 | // The fragment can be still in backstack even if isRemoving() is true.
271 | // We check mOnSaveInstanceCalled - if this was not called then the fragment is totally removed.
272 | Log.d(LOG_TAG, "Removing presenter - fragment replaced");
273 | removePresenter();
274 | }
275 | this.mAlreadyCreated = false;
276 | }
277 |
278 |
279 | /**
280 | * Use in case this Presenter is associated with an {@link Activity}
281 | * Call from {@link Activity#onDestroy()}
282 | *
283 | * @param activity the activity
284 | */
285 | public void onDestroy(@NonNull Activity activity)
286 | {
287 | if(this.mPresenter == null) return;
288 |
289 | if(activity.isFinishing())
290 | {
291 | this.mPresenter.onPresenterDetached(true);
292 | removePresenter();
293 | }
294 | else
295 | this.mPresenter.onPresenterDetached(false);
296 | this.mAlreadyCreated = false;
297 | }
298 |
299 |
300 | /**
301 | * Getter for the Presenter
302 | *
303 | * @return {@link Presenter} instance
304 | */
305 | @Nullable
306 | public PR getPresenter()
307 | {
308 | return this.mPresenter;
309 | }
310 |
311 |
312 | /**
313 | * Call from {@link Activity#onSaveInstanceState(Bundle)}
314 | * or {@link Fragment#onSaveInstanceState(Bundle)}.
315 | * This allows the presenter to save its state.
316 | *
317 | * @param bundle InstanceState bundle
318 | */
319 | public void onSaveInstanceState(@NonNull Bundle bundle)
320 | {
321 | bundle.putString(getPresenterIdFieldName(), this.mPresenterId);
322 | if(this.mPresenter != null)
323 | {
324 | ViperProvider.getInstance().addPresenter(this.mPresenterId, this.mPresenter);
325 | this.mOnSaveInstanceCalled = true;
326 | }
327 | }
328 |
329 |
330 | /**
331 | * Getter for the Data Binding instance
332 | *
333 | * @return Data Binding instance
334 | */
335 | public VB getBinding()
336 | {
337 | return this.mBinding;
338 | }
339 |
340 |
341 | /**
342 | * Sets config.
343 | *
344 | * @param viperConfig the viper config
345 | */
346 | public void setConfig(ViperConfig viperConfig)
347 | {
348 | if(this.mViperConfig == null)
349 | this.mViperConfig = viperConfig;
350 | }
351 |
352 |
353 | /**
354 | * This method defines a key under which the Presenter ID will be stored inside SavedInstanceState of the Activity/Fragment.
355 | *