├── .gitignore ├── App.kt ├── BaseService.kt ├── BaseUseCase.kt ├── LICENSE ├── NetworkProvider.kt ├── README.md ├── Resource.kt ├── ResourceProvidersModule.kt ├── StringResourceProvider.kt ├── build.gradle (module).gradle ├── build.gradle (project).gradle ├── dependencies.gradle ├── file_templates.zip ├── mvvm.gif ├── sample └── MyApplication │ ├── .gitignore │ ├── .idea │ ├── .gitignore │ ├── .name │ ├── compiler.xml │ ├── gradle.xml │ └── misc.xml │ ├── app │ ├── .gitignore │ ├── build.gradle │ ├── dependencies.gradle │ ├── proguard-rules.pro │ └── src │ │ ├── androidTest │ │ └── java │ │ │ └── com │ │ │ └── example │ │ │ └── myapplication │ │ │ └── ExampleInstrumentedTest.kt │ │ ├── main │ │ ├── AndroidManifest.xml │ │ ├── java │ │ │ └── com │ │ │ │ └── example │ │ │ │ └── myapplication │ │ │ │ ├── MainActivity.kt │ │ │ │ ├── common │ │ │ │ ├── App.kt │ │ │ │ └── BaseUseCase.kt │ │ │ │ ├── login │ │ │ │ ├── api │ │ │ │ │ ├── LoginApi.kt │ │ │ │ │ └── LoginService.kt │ │ │ │ ├── di │ │ │ │ │ ├── LoginBindings.kt │ │ │ │ │ └── LoginModule.kt │ │ │ │ ├── domain │ │ │ │ │ └── LoginUseCase.kt │ │ │ │ ├── models │ │ │ │ │ ├── LoginRequest.kt │ │ │ │ │ ├── LoginRequestDto.kt │ │ │ │ │ ├── LoginResponse.kt │ │ │ │ │ └── LoginState.kt │ │ │ │ ├── view │ │ │ │ │ └── LoginFragment.kt │ │ │ │ └── vm │ │ │ │ │ └── LoginViewModel.kt │ │ │ │ ├── network │ │ │ │ ├── BaseService.kt │ │ │ │ ├── NetworkProvider.kt │ │ │ │ └── Resource.kt │ │ │ │ └── resources │ │ │ │ ├── StringResourceProvider.kt │ │ │ │ └── di │ │ │ │ └── ResourceProvidersModule.kt │ │ └── res │ │ │ ├── drawable-v24 │ │ │ └── ic_launcher_foreground.xml │ │ │ ├── drawable │ │ │ └── ic_launcher_background.xml │ │ │ ├── layout │ │ │ └── activity_main.xml │ │ │ ├── mipmap-anydpi-v26 │ │ │ ├── ic_launcher.xml │ │ │ └── ic_launcher_round.xml │ │ │ ├── mipmap-hdpi │ │ │ ├── ic_launcher.webp │ │ │ └── ic_launcher_round.webp │ │ │ ├── mipmap-mdpi │ │ │ ├── ic_launcher.webp │ │ │ └── ic_launcher_round.webp │ │ │ ├── mipmap-xhdpi │ │ │ ├── ic_launcher.webp │ │ │ └── ic_launcher_round.webp │ │ │ ├── mipmap-xxhdpi │ │ │ ├── ic_launcher.webp │ │ │ └── ic_launcher_round.webp │ │ │ ├── mipmap-xxxhdpi │ │ │ ├── ic_launcher.webp │ │ │ └── ic_launcher_round.webp │ │ │ ├── values-night │ │ │ └── themes.xml │ │ │ └── values │ │ │ ├── colors.xml │ │ │ ├── strings.xml │ │ │ └── themes.xml │ │ └── test │ │ └── java │ │ └── com │ │ └── example │ │ └── myapplication │ │ └── ExampleUnitTest.kt │ ├── build.gradle │ ├── gradle.properties │ ├── gradle │ └── wrapper │ │ ├── gradle-wrapper.jar │ │ └── gradle-wrapper.properties │ ├── gradlew │ ├── gradlew.bat │ └── settings.gradle └── template.png /.gitignore: -------------------------------------------------------------------------------- 1 | # Built application files 2 | *.apk 3 | *.aar 4 | *.ap_ 5 | *.aab 6 | 7 | # Files for the ART/Dalvik VM 8 | *.dex 9 | 10 | # Java class files 11 | *.class 12 | 13 | # Generated files 14 | bin/ 15 | gen/ 16 | out/ 17 | # Uncomment the following line in case you need and you don't have the release build type files in your app 18 | # release/ 19 | 20 | # Gradle files 21 | .gradle/ 22 | build/ 23 | 24 | # Local configuration file (sdk path, etc) 25 | local.properties 26 | 27 | # Proguard folder generated by Eclipse 28 | proguard/ 29 | 30 | # Log Files 31 | *.log 32 | 33 | # Android Studio Navigation editor temp files 34 | .navigation/ 35 | 36 | # Android Studio captures folder 37 | captures/ 38 | 39 | # IntelliJ 40 | *.iml 41 | .idea/workspace.xml 42 | .idea/tasks.xml 43 | .idea/gradle.xml 44 | .idea/assetWizardSettings.xml 45 | .idea/dictionaries 46 | .idea/libraries 47 | # Android Studio 3 in .gitignore file. 48 | .idea/caches 49 | .idea/modules.xml 50 | # Comment next line if keeping position of elements in Navigation Editor is relevant for you 51 | .idea/navEditor.xml 52 | 53 | # Keystore files 54 | # Uncomment the following lines if you do not want to check your keystore files in. 55 | #*.jks 56 | #*.keystore 57 | 58 | # External native build folder generated in Android Studio 2.2 and later 59 | .externalNativeBuild 60 | .cxx/ 61 | 62 | # Google Services (e.g. APIs or Firebase) 63 | # google-services.json 64 | 65 | # Freeline 66 | freeline.py 67 | freeline/ 68 | freeline_project_description.json 69 | 70 | # fastlane 71 | fastlane/report.xml 72 | fastlane/Preview.html 73 | fastlane/screenshots 74 | fastlane/test_output 75 | fastlane/readme.md 76 | 77 | # Version control 78 | vcs.xml 79 | 80 | # lint 81 | lint/intermediates/ 82 | lint/generated/ 83 | lint/outputs/ 84 | lint/tmp/ 85 | # lint/reports/ 86 | -------------------------------------------------------------------------------- /App.kt: -------------------------------------------------------------------------------- 1 | package 2 | 3 | import android.app.Application 4 | import dagger.hilt.android.HiltAndroidApp 5 | 6 | @HiltAndroidApp 7 | class App : Application() -------------------------------------------------------------------------------- /BaseService.kt: -------------------------------------------------------------------------------- 1 | package 2 | 3 | import .R 4 | import .StringResourceProvider 5 | import kotlinx.coroutines.CoroutineDispatcher 6 | import retrofit2.HttpException 7 | import java.io.EOFException 8 | import java.io.IOException 9 | import java.net.SocketTimeoutException 10 | import java.net.UnknownHostException 11 | import java.util.concurrent.TimeoutException 12 | 13 | abstract class BaseService( 14 | private val coroutineDispatcher: CoroutineDispatcher, 15 | private val stringResourceProvider: StringResourceProvider 16 | ) { 17 | 18 | protected suspend fun requestApiResource(apiCall: suspend () -> T): Resource { 19 | return try { 20 | val result = apiCall.invoke() 21 | Resource.Data(result) 22 | } catch (throwable: Throwable) { 23 | when (throwable) { 24 | is HttpException -> handleHttpExceptions(throwable) 25 | is TimeoutException -> handleTimeOut() 26 | is EOFException -> handleEmptyResult() 27 | is IOException -> handleNetworkError(throwable) 28 | else -> createUnexpectedError(throwable) 29 | } 30 | } 31 | 32 | } 33 | 34 | private fun handleNetworkError(throwable: IOException): Resource.Error { 35 | return when (throwable) { 36 | is SocketTimeoutException -> createDefaultResponseError( 37 | stringResourceProvider.getString( 38 | R.string.internet_issue_message 39 | ) 40 | ) 41 | is UnknownHostException -> createDefaultResponseError(stringResourceProvider.getString(R.string.server_not_responding)) 42 | else -> createDefaultResponseError(stringResourceProvider.getString(R.string.internet_issue_message)) 43 | } 44 | } 45 | 46 | private fun handleTimeOut(): Resource.Error { 47 | return Resource.Error( 48 | stringResourceProvider.getString(R.string.internet_issue_message), 49 | DEFAULT_ERROR_CODE 50 | ) 51 | } 52 | 53 | private fun handleEmptyResult(): Resource.Error { 54 | return Resource.Error( 55 | stringResourceProvider.getString(R.string.no_data_found), 56 | DEFAULT_ERROR_CODE 57 | ) 58 | } 59 | 60 | private fun handleHttpExceptions(throwable: HttpException): Resource.Error { 61 | return when (throwable.code()) { 62 | 502 -> createDefaultResponseError(stringResourceProvider.getString(R.string.bad_gateway_message)) 63 | 500 -> createDefaultResponseError(stringResourceProvider.getString(R.string.internal_server_error)) 64 | 404 -> createDefaultResponseError(stringResourceProvider.getString(R.string.url_not_responding)) 65 | else -> { 66 | createUnexpectedError(throwable) 67 | } 68 | } 69 | } 70 | 71 | private fun createUnexpectedError(throwable: Throwable) : Resource.Error = 72 | Resource.Error( 73 | throwable.message ?: stringResourceProvider.getString(R.string.unexpected_error), 74 | DEFAULT_ERROR_CODE 75 | ) 76 | 77 | private fun createDefaultResponseError( 78 | userMessage: String 79 | ): Resource.Error { 80 | return Resource.Error( 81 | userMessage, 82 | DEFAULT_ERROR_CODE 83 | ) 84 | } 85 | 86 | companion object { 87 | private const val DEFAULT_ERROR_CODE = -1 88 | } 89 | } -------------------------------------------------------------------------------- /BaseUseCase.kt: -------------------------------------------------------------------------------- 1 | package 2 | 3 | interface BaseUseCase { 4 | suspend fun execute(input: Input): Output 5 | } -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /NetworkProvider.kt: -------------------------------------------------------------------------------- 1 | package 2 | 3 | import .BuildConfig 4 | import com.squareup.moshi.Moshi 5 | import com.squareup.moshi.kotlin.reflect.KotlinJsonAdapterFactory 6 | import dagger.Module 7 | import dagger.Provides 8 | import dagger.hilt.InstallIn 9 | import dagger.hilt.android.components.ViewModelComponent 10 | import kotlinx.coroutines.CoroutineDispatcher 11 | import kotlinx.coroutines.Dispatchers 12 | import okhttp3.OkHttpClient 13 | import okhttp3.logging.HttpLoggingInterceptor 14 | import retrofit2.Retrofit 15 | import retrofit2.converter.moshi.MoshiConverterFactory 16 | 17 | @Module 18 | @InstallIn(ViewModelComponent::class) 19 | class NetworkProvider { 20 | 21 | @Provides 22 | fun provideNetworkDispatcher(): CoroutineDispatcher = Dispatchers.IO 23 | 24 | @Provides 25 | fun provideMoshi(): Moshi = Moshi.Builder() 26 | .add(KotlinJsonAdapterFactory()) 27 | .build() 28 | 29 | @Provides 30 | fun provideHttpClient(): OkHttpClient { 31 | return OkHttpClient() 32 | .newBuilder() 33 | .addInterceptor(getLogger()) 34 | .build() 35 | } 36 | 37 | private fun getLogger(): HttpLoggingInterceptor { 38 | return HttpLoggingInterceptor().apply { 39 | level = if (BuildConfig.DEBUG) { 40 | HttpLoggingInterceptor.Level.BODY 41 | } else { 42 | HttpLoggingInterceptor.Level.NONE 43 | } 44 | } 45 | } 46 | 47 | @Provides 48 | fun provideRetrofit(client: OkHttpClient, moshi: Moshi): Retrofit = Retrofit.Builder() 49 | .baseUrl(BuildConfig.SERVER_URL) 50 | .client(client) 51 | .addConverterFactory(MoshiConverterFactory.create(moshi)) 52 | .build() 53 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Android MVVM Generator 2 | ![mvvm](https://github.com/talhahasanzia/android-mvvm-generator/blob/main/mvvm.gif) 3 | 4 | ## Pre-requisites 5 | - Project assumes that you use Hilt, Retrofit, Kotlin, Flows, Jetpack ViewModel and MVVM with UseCase layer. 6 | - Import `file_templates.zip` as intelliJ settings file. It only imports file templates, so rest of your settings remain intact. [(How to)](https://www.jetbrains.com/help/idea/sharing-your-ide-settings.html#import-export-settings) 7 | - Copy some base files in your desired directory, which include: 8 | - `NetworkProvider` sets up `retrofit` instance, you can replace with your own 9 | - `BaseUseCase` interface enforces SRP by providing 1 method that works on 1 input and 1 output. 10 | - `BaseService` has api call boilerplate, including default error messages mapped to http codes 11 | - `Resource` sealed class to map network response to `Data` for success else `Error` 12 | - `StringResourceProvider` is wrapper around `strings.xml` resource that is declared in its module 13 | - `dependencies.gradle` file has all the dependencies needed, this is then imported in `build.gradle (app)` 14 | - Setup some dependencies project wide using `build.gradle (project)` and module wide `build.gradle (app)` 15 | 16 | You can always replace/edit these as per your requirements. 17 | 18 | ## Usage 19 | - Create a package for feature in your desired package e.g. `login` 20 | - Right click on target feature package, goto `New` then click `New Feature`, enter name when prompt appears 21 | - Name in `New Feature` is case sensitive, e.g. `Login`, generated classes will be case sensitive with capital `L`- `LoginApi`, `LoginUseCase` etc. 22 | - You will get all the classes generated! 23 | 24 | Few more steps: 25 | 26 | - Since base classes are completely subjective to their creation and placement, you will have to add some import statements. 27 | - Goto generated `ViewModel`, `UseCase` and `ApiService` classes and add imports for base/common classes. (takes <10 seconds). 28 | - Voila ! You have a feature skeleton ready to work on. 29 | 30 | ## Generated Classes 31 | _`<>` replaces your generated feature name_ 32 | - `<>Api` - Retrofit API end point class 33 | - `<>Service` - Network call logic, uses `<>Api` 34 | - `<>UseCase` - Use case to contain pure logic for data transformation/manipulation 35 | - `<>ViewModel` - ViewModel with basic structure having reference to use case and some livedata declared 36 | - `<>Fragment` - Empty Fragment 37 | - `<>Request` - Model for UseCase input, there is room for better naming convention here. 38 | - `<>State` - Model for UseCase output, again, there is room for better naming convention here. 39 | - `<>RequestDto` - Model for request data in API call. This is json annotated to be used with Moshi. 40 | - `<>Response` - Model for response object, this is json annotated to be used with Moshi. 41 | - `<>Bindings` - DI bindings for `Service` and `UseCase` classes/interfaces 42 | - `<>Module` - DI module method to create `<>Api` instance using `retrofit` instance discussed in Pre-requisites. 43 | 44 | ## Extensibility 45 | While this is pretty specific, it very easy to edit or update templates 46 | - Goto `Preferences` in you IntelliJ (dependending on the OS, options may change), select `File and Code Templates` and scroll down in `Files` section. 47 | ![template](https://github.com/talhahasanzia/android-mvvm-generator/blob/main/template.png) 48 | - You will see there custom templates as mentioned in the image. 49 | - You can add, edit, remove or even create an entirely new set of templates from this. 50 | - This uses [Apache Velocity](https://velocity.apache.org/engine/1.7/user-guide.html) langauage which is also mentioned in this prompt as `VTL`. 51 | - This is fairly simple, declarative, yet very powerful templating language. You can almost achieve everything that a code generator can using this templating engine. 52 | 53 | ## Disclaimer 54 | - This does not in any way, ask you to implement or design apps/solutions with a preference. This might be 1 out of many ways to do things. 55 | - Do not expect this project to work 100% perfectly 100% of the time. 56 | - This is licensed with [Apache 2.0](https://github.com/talhahasanzia/android-mvvm-generator/blob/main/LICENSE) 57 | -------------------------------------------------------------------------------- /Resource.kt: -------------------------------------------------------------------------------- 1 | package 2 | 3 | sealed class Resource{ 4 | data class Data(val data : T) : Resource() 5 | data class Error(val errorMessage : String, val errorCode : Int) : Resource() 6 | } -------------------------------------------------------------------------------- /ResourceProvidersModule.kt: -------------------------------------------------------------------------------- 1 | package 2 | 3 | import .DefaultStringResourceProvider 4 | import .StringResourceProvider 5 | import dagger.Binds 6 | import dagger.Module 7 | import dagger.hilt.InstallIn 8 | import dagger.hilt.components.SingletonComponent 9 | 10 | /** 11 | * Dependencies that help in managing Android based resources or other common logic providers. 12 | */ 13 | @Module 14 | @InstallIn(SingletonComponent::class) 15 | abstract class ResourceProvidersModule { 16 | @Binds 17 | abstract fun bindStringResourceProvider(instance: DefaultStringResourceProvider): StringResourceProvider 18 | } -------------------------------------------------------------------------------- /StringResourceProvider.kt: -------------------------------------------------------------------------------- 1 | package 2 | 3 | import android.content.Context 4 | import androidx.annotation.StringRes 5 | import dagger.hilt.android.qualifiers.ApplicationContext 6 | import javax.inject.Inject 7 | 8 | interface StringResourceProvider { 9 | fun getString(@StringRes id: Int): String 10 | fun getString(@StringRes id: Int, valueToFormat: Int): String 11 | fun getString(@StringRes id: Int, valueToFormat: String): String 12 | } 13 | 14 | class DefaultStringResourceProvider @Inject constructor(@ApplicationContext private val context: Context) : 15 | StringResourceProvider { 16 | 17 | override fun getString(id: Int): String { 18 | return context.getString(id) 19 | } 20 | 21 | override fun getString(id: Int, valueToFormat: Int): String { 22 | return context.getString(id, valueToFormat) 23 | } 24 | 25 | override fun getString(id: Int, valueToFormat: String): String { 26 | return context.getString(id, valueToFormat) 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /build.gradle (module).gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.android.application' 3 | id 'org.jetbrains.kotlin.android' 4 | id 'kotlin-kapt' 5 | id 'kotlin-parcelize' 6 | id 'androidx.navigation.safeargs.kotlin' 7 | id 'dagger.hilt.android.plugin' 8 | } 9 | 10 | android { 11 | compileSdk 32 12 | 13 | defaultConfig { 14 | applicationId "" 15 | minSdk 21 16 | targetSdk 32 17 | versionCode 1 18 | versionName "1.0" 19 | 20 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" 21 | } 22 | 23 | 24 | buildTypes { 25 | debug{ 26 | buildConfigField "String", "SERVER_URL", "\"https://api.company.com\"" 27 | 28 | } 29 | release { 30 | minifyEnabled false 31 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 32 | buildConfigField "String", "SERVER_URL", "\"https://api.company.com\"" 33 | } 34 | } 35 | compileOptions { 36 | sourceCompatibility JavaVersion.VERSION_1_8 37 | targetCompatibility JavaVersion.VERSION_1_8 38 | } 39 | kotlinOptions { 40 | jvmTarget = '1.8' 41 | } 42 | buildFeatures { 43 | dataBinding true 44 | } 45 | } 46 | 47 | apply from: "dependencies.gradle" -------------------------------------------------------------------------------- /build.gradle (project).gradle: -------------------------------------------------------------------------------- 1 | // Top-level build file where you can add configuration options common to all sub-projects/modules. 2 | buildscript { 3 | ext.kotlin_version = '1.6.0' 4 | repositories { 5 | gradlePluginPortal() 6 | google() 7 | mavenCentral() 8 | jcenter() 9 | maven { url "https://jitpack.io" } 10 | 11 | } 12 | dependencies { 13 | classpath 'com.google.gms:google-services:4.3.10' 14 | classpath "androidx.navigation:navigation-safe-args-gradle-plugin:2.4.2" 15 | classpath "com.google.dagger:hilt-android-gradle-plugin:2.42" 16 | classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" 17 | } 18 | } 19 | plugins { 20 | id 'com.android.application' version '7.1.3' apply false 21 | id 'com.android.library' version '7.1.3' apply false 22 | id 'org.jetbrains.kotlin.android' version '1.5.30' apply false 23 | } 24 | 25 | task clean(type: Delete) { 26 | delete rootProject.buildDir 27 | } -------------------------------------------------------------------------------- /dependencies.gradle: -------------------------------------------------------------------------------- 1 | dependencies { 2 | 3 | implementation 'androidx.core:core-ktx:1.8.0' 4 | implementation 'androidx.appcompat:appcompat:1.4.2' 5 | implementation 'com.google.android.material:material:1.6.1' 6 | implementation 'androidx.constraintlayout:constraintlayout:2.1.4' 7 | 8 | implementation "com.squareup.retrofit2:retrofit:2.9.0" 9 | implementation "com.squareup.okhttp3:logging-interceptor:4.9.1" 10 | implementation "com.squareup.retrofit2:converter-moshi:2.9.0" 11 | implementation "com.squareup.moshi:moshi:1.13.0" 12 | implementation "com.squareup.moshi:moshi-kotlin:1.13.0" 13 | implementation 'androidx.legacy:legacy-support-v4:1.0.0' 14 | kapt "com.squareup.moshi:moshi-kotlin-codegen:1.13.0" 15 | 16 | //LifeCycle 17 | implementation "androidx.lifecycle:lifecycle-common-java8:2.4.1" 18 | 19 | // Jetpack Navigation 20 | implementation "androidx.navigation:navigation-ui:2.4.2" 21 | implementation "androidx.navigation:navigation-fragment:2.4.2" 22 | implementation "androidx.navigation:navigation-fragment-ktx:2.4.2" 23 | implementation "androidx.navigation:navigation-ui-ktx:2.4.2" 24 | 25 | // Kotlin Extensions for Lifecycle arch components 26 | implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:2.4.1" 27 | implementation "androidx.lifecycle:lifecycle-runtime-ktx:2.4.1" 28 | implementation "androidx.lifecycle:lifecycle-livedata-ktx:2.4.1" 29 | implementation "androidx.fragment:fragment-ktx:1.4.1" 30 | implementation "androidx.activity:activity-ktx:1.4.0" 31 | 32 | // DI Hilt 33 | implementation "com.google.dagger:hilt-android:2.42" 34 | kapt "com.google.dagger:hilt-android-compiler:2.42" 35 | implementation "androidx.hilt:hilt-navigation-fragment:1.0.0" 36 | 37 | implementation "com.google.android.gms:play-services-maps:18.0.2" 38 | implementation 'com.google.android.gms:play-services-location:20.0.0' 39 | 40 | implementation "io.coil-kt:coil:2.1.0" 41 | 42 | testImplementation 'junit:junit:4.13.2' 43 | testImplementation "org.mockito:mockito-core:2.23.0" 44 | testImplementation "androidx.arch.core:core-testing:2.1.0" 45 | testImplementation "com.nhaarman.mockitokotlin2:mockito-kotlin:2.2.0" 46 | testImplementation "org.jetbrains.kotlinx:kotlinx-coroutines-test:1.6.1" 47 | testImplementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.1" 48 | androidTestImplementation 'androidx.test.ext:junit:1.1.3' 49 | androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0' 50 | } -------------------------------------------------------------------------------- /file_templates.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talhahasanzia/android-mvvm-generator/e66ec91a2b36cd963f903ba09ba56e5972f2d568/file_templates.zip -------------------------------------------------------------------------------- /mvvm.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talhahasanzia/android-mvvm-generator/e66ec91a2b36cd963f903ba09ba56e5972f2d568/mvvm.gif -------------------------------------------------------------------------------- /sample/MyApplication/.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | .gradle 3 | /local.properties 4 | /.idea/caches 5 | /.idea/libraries 6 | /.idea/modules.xml 7 | /.idea/workspace.xml 8 | /.idea/navEditor.xml 9 | /.idea/assetWizardSettings.xml 10 | .DS_Store 11 | /build 12 | /captures 13 | .externalNativeBuild 14 | .cxx 15 | local.properties 16 | -------------------------------------------------------------------------------- /sample/MyApplication/.idea/.gitignore: -------------------------------------------------------------------------------- 1 | # Default ignored files 2 | /shelf/ 3 | /workspace.xml 4 | -------------------------------------------------------------------------------- /sample/MyApplication/.idea/.name: -------------------------------------------------------------------------------- 1 | My Application -------------------------------------------------------------------------------- /sample/MyApplication/.idea/compiler.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /sample/MyApplication/.idea/gradle.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 19 | 20 | -------------------------------------------------------------------------------- /sample/MyApplication/.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 9 | -------------------------------------------------------------------------------- /sample/MyApplication/app/.gitignore: -------------------------------------------------------------------------------- 1 | /build -------------------------------------------------------------------------------- /sample/MyApplication/app/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.android.application' 3 | id 'org.jetbrains.kotlin.android' 4 | id 'kotlin-kapt' 5 | id 'kotlin-parcelize' 6 | id 'androidx.navigation.safeargs.kotlin' 7 | id 'dagger.hilt.android.plugin' 8 | } 9 | 10 | android { 11 | compileSdk 32 12 | 13 | defaultConfig { 14 | applicationId "com.example.myapplication" 15 | minSdk 21 16 | targetSdk 32 17 | versionCode 1 18 | versionName "1.0" 19 | 20 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" 21 | } 22 | 23 | 24 | buildTypes { 25 | debug{ 26 | buildConfigField "String", "SERVER_URL", "\"https://api.company.com\"" 27 | 28 | } 29 | release { 30 | minifyEnabled false 31 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 32 | buildConfigField "String", "SERVER_URL", "\"https://api.company.com\"" 33 | } 34 | } 35 | compileOptions { 36 | sourceCompatibility JavaVersion.VERSION_1_8 37 | targetCompatibility JavaVersion.VERSION_1_8 38 | } 39 | kotlinOptions { 40 | jvmTarget = '1.8' 41 | } 42 | buildFeatures { 43 | dataBinding true 44 | } 45 | } 46 | 47 | apply from: "dependencies.gradle" -------------------------------------------------------------------------------- /sample/MyApplication/app/dependencies.gradle: -------------------------------------------------------------------------------- 1 | dependencies { 2 | 3 | implementation 'androidx.core:core-ktx:1.8.0' 4 | implementation 'androidx.appcompat:appcompat:1.4.2' 5 | implementation 'com.google.android.material:material:1.6.1' 6 | implementation 'androidx.constraintlayout:constraintlayout:2.1.4' 7 | 8 | implementation "com.squareup.retrofit2:retrofit:2.9.0" 9 | implementation "com.squareup.okhttp3:logging-interceptor:4.9.1" 10 | implementation "com.squareup.retrofit2:converter-moshi:2.9.0" 11 | implementation "com.squareup.moshi:moshi:1.13.0" 12 | implementation "com.squareup.moshi:moshi-kotlin:1.13.0" 13 | implementation 'androidx.legacy:legacy-support-v4:1.0.0' 14 | kapt "com.squareup.moshi:moshi-kotlin-codegen:1.13.0" 15 | 16 | //LifeCycle 17 | implementation "androidx.lifecycle:lifecycle-common-java8:2.4.1" 18 | 19 | // Jetpack Navigation 20 | implementation "androidx.navigation:navigation-ui:2.4.2" 21 | implementation "androidx.navigation:navigation-fragment:2.4.2" 22 | implementation "androidx.navigation:navigation-fragment-ktx:2.4.2" 23 | implementation "androidx.navigation:navigation-ui-ktx:2.4.2" 24 | 25 | // Kotlin Extensions for Lifecycle arch components 26 | implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:2.4.1" 27 | implementation "androidx.lifecycle:lifecycle-runtime-ktx:2.4.1" 28 | implementation "androidx.lifecycle:lifecycle-livedata-ktx:2.4.1" 29 | implementation "androidx.fragment:fragment-ktx:1.4.1" 30 | implementation "androidx.activity:activity-ktx:1.4.0" 31 | 32 | // DI Hilt 33 | implementation "com.google.dagger:hilt-android:2.42" 34 | kapt "com.google.dagger:hilt-android-compiler:2.42" 35 | implementation "androidx.hilt:hilt-navigation-fragment:1.0.0" 36 | 37 | implementation "com.google.android.gms:play-services-maps:18.0.2" 38 | implementation 'com.google.android.gms:play-services-location:20.0.0' 39 | 40 | implementation "io.coil-kt:coil:2.1.0" 41 | 42 | testImplementation 'junit:junit:4.13.2' 43 | testImplementation "org.mockito:mockito-core:2.23.0" 44 | testImplementation "androidx.arch.core:core-testing:2.1.0" 45 | testImplementation "com.nhaarman.mockitokotlin2:mockito-kotlin:2.2.0" 46 | testImplementation "org.jetbrains.kotlinx:kotlinx-coroutines-test:1.6.1" 47 | testImplementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.1" 48 | androidTestImplementation 'androidx.test.ext:junit:1.1.3' 49 | androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0' 50 | } -------------------------------------------------------------------------------- /sample/MyApplication/app/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile -------------------------------------------------------------------------------- /sample/MyApplication/app/src/androidTest/java/com/example/myapplication/ExampleInstrumentedTest.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication 2 | 3 | import androidx.test.platform.app.InstrumentationRegistry 4 | import androidx.test.ext.junit.runners.AndroidJUnit4 5 | 6 | import org.junit.Test 7 | import org.junit.runner.RunWith 8 | 9 | import org.junit.Assert.* 10 | 11 | /** 12 | * Instrumented test, which will execute on an Android device. 13 | * 14 | * See [testing documentation](http://d.android.com/tools/testing). 15 | */ 16 | @RunWith(AndroidJUnit4::class) 17 | class ExampleInstrumentedTest { 18 | @Test 19 | fun useAppContext() { 20 | // Context of the app under test. 21 | val appContext = InstrumentationRegistry.getInstrumentation().targetContext 22 | assertEquals("com.example.myapplication", appContext.packageName) 23 | } 24 | } -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 13 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/MainActivity.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication 2 | 3 | import androidx.appcompat.app.AppCompatActivity 4 | import android.os.Bundle 5 | 6 | class MainActivity : AppCompatActivity() { 7 | override fun onCreate(savedInstanceState: Bundle?) { 8 | super.onCreate(savedInstanceState) 9 | setContentView(R.layout.activity_main) 10 | } 11 | } -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/common/App.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication.common 2 | 3 | import android.app.Application 4 | import dagger.hilt.android.HiltAndroidApp 5 | 6 | @HiltAndroidApp 7 | class App : Application() -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/common/BaseUseCase.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication.common 2 | 3 | interface BaseUseCase { 4 | suspend fun execute(input: Input): Output 5 | } -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/login/api/LoginApi.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication.login.api 2 | 3 | import com.example.myapplication.login.models.LoginRequestDto 4 | import com.example.myapplication.login.models.LoginResponse 5 | import retrofit2.http.Body 6 | import retrofit2.http.GET 7 | 8 | interface LoginApi { 9 | @GET("resource") 10 | suspend fun getLogin( 11 | @Body body: LoginRequestDto, 12 | ): LoginResponse 13 | } -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/login/api/LoginService.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication.login.api 2 | 3 | 4 | import com.example.myapplication.login.models.LoginRequest 5 | import com.example.myapplication.login.models.LoginRequestDto 6 | import com.example.myapplication.login.models.LoginResponse 7 | import com.example.myapplication.network.BaseService 8 | import com.example.myapplication.network.Resource 9 | import com.example.myapplication.resources.StringResourceProvider 10 | import kotlinx.coroutines.CoroutineDispatcher 11 | import javax.inject.Inject 12 | 13 | interface LoginService { 14 | suspend fun get(request: LoginRequest): Resource 15 | } 16 | 17 | class DefaultLoginService @Inject constructor( 18 | private val api: LoginApi, 19 | private val dispatcher: CoroutineDispatcher, 20 | private val stringResourceProvider: StringResourceProvider 21 | ) : LoginService, BaseService(dispatcher, stringResourceProvider) { 22 | 23 | override suspend fun get(request: LoginRequest): Resource { 24 | return requestApiResource { api.getLogin(LoginRequestDto(request.data)) } 25 | } 26 | } -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/login/di/LoginBindings.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication.login.di 2 | 3 | import com.example.myapplication.login.api.LoginService 4 | import com.example.myapplication.login.api.DefaultLoginService 5 | import com.example.myapplication.login.domain.LoginUseCase 6 | import com.example.myapplication.login.domain.DefaultLoginUseCase 7 | import dagger.Binds 8 | import dagger.Module 9 | import dagger.hilt.InstallIn 10 | import dagger.hilt.android.components.ViewModelComponent 11 | 12 | @Module 13 | @InstallIn(ViewModelComponent::class) 14 | abstract class LoginBindings { 15 | 16 | @Binds 17 | abstract fun bindLoginService(default: DefaultLoginService): LoginService 18 | 19 | @Binds 20 | abstract fun bindLoginUseCase(default: DefaultLoginUseCase): LoginUseCase 21 | } -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/login/di/LoginModule.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication.login.di 2 | 3 | import com.example.myapplication.login.api.LoginApi 4 | import dagger.Module 5 | import dagger.Provides 6 | import dagger.hilt.InstallIn 7 | import dagger.hilt.android.components.ViewModelComponent 8 | import retrofit2.Retrofit 9 | 10 | @Module 11 | @InstallIn(ViewModelComponent::class) 12 | class LoginModule { 13 | @Provides 14 | fun provideChangePasswordApi(retrofit: Retrofit): LoginApi { 15 | return retrofit.create(LoginApi::class.java) 16 | } 17 | } -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/login/domain/LoginUseCase.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication.login.domain 2 | 3 | import com.example.myapplication.common.BaseUseCase 4 | import com.example.myapplication.login.api.LoginService 5 | import com.example.myapplication.login.models.LoginRequest 6 | import com.example.myapplication.login.models.LoginState 7 | import kotlinx.coroutines.flow.Flow 8 | import kotlinx.coroutines.flow.flow 9 | import javax.inject.Inject 10 | 11 | interface LoginUseCase : BaseUseCase> 12 | 13 | class DefaultLoginUseCase @Inject constructor( 14 | private val service: LoginService, 15 | ) : LoginUseCase { 16 | 17 | override suspend fun execute(request: LoginRequest): Flow { 18 | return flow { 19 | emit(LoginState.Loading) 20 | 21 | 22 | } 23 | } 24 | } -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/login/models/LoginRequest.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication.login.models 2 | 3 | data class LoginRequest( 4 | val data: String 5 | ) -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/login/models/LoginRequestDto.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication.login.models 2 | 3 | import com.squareup.moshi.JsonClass 4 | 5 | @JsonClass(generateAdapter = true) 6 | data class LoginRequestDto( 7 | val data: String 8 | ) -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/login/models/LoginResponse.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication.login.models 2 | 3 | import com.squareup.moshi.JsonClass 4 | 5 | @JsonClass(generateAdapter = true) 6 | data class LoginResponse( 7 | val data: String 8 | ) -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/login/models/LoginState.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication.login.models 2 | 3 | sealed class LoginState { 4 | data class Success(val data: String) : LoginState() 5 | data class Failure(val data: String) : LoginState() 6 | object Loading : LoginState() 7 | } -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/login/view/LoginFragment.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication.login.view 2 | 3 | import androidx.fragment.app.Fragment 4 | import dagger.hilt.android.AndroidEntryPoint 5 | 6 | @AndroidEntryPoint 7 | class LoginFragment : Fragment() { 8 | 9 | } -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/login/vm/LoginViewModel.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication.login.vm 2 | 3 | import androidx.lifecycle.LiveData 4 | import androidx.lifecycle.MutableLiveData 5 | import androidx.lifecycle.ViewModel 6 | import androidx.lifecycle.viewModelScope 7 | import com.example.myapplication.login.models.LoginRequest 8 | import com.example.myapplication.login.models.LoginState 9 | import com.example.myapplication.login.domain.LoginUseCase 10 | import com.example.myapplication.resources.StringResourceProvider 11 | import dagger.hilt.android.lifecycle.HiltViewModel 12 | import kotlinx.coroutines.flow.collectLatest 13 | import kotlinx.coroutines.launch 14 | import javax.inject.Inject 15 | 16 | @HiltViewModel 17 | class LoginViewModel @Inject constructor( 18 | private val useCase: LoginUseCase, 19 | private val stringRes: StringResourceProvider 20 | ) : 21 | ViewModel() { 22 | 23 | private val _state = MutableLiveData() 24 | val state: LiveData 25 | get() = _state 26 | 27 | fun getData() { 28 | viewModelScope.launch { 29 | useCase.execute(LoginRequest("")).collectLatest { 30 | 31 | } 32 | } 33 | } 34 | 35 | } -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/network/BaseService.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication.network 2 | 3 | import com.example.myapplication.R 4 | import com.example.myapplication.resources.StringResourceProvider 5 | import kotlinx.coroutines.CoroutineDispatcher 6 | import retrofit2.HttpException 7 | import java.io.EOFException 8 | import java.io.IOException 9 | import java.net.SocketTimeoutException 10 | import java.net.UnknownHostException 11 | import java.util.concurrent.TimeoutException 12 | 13 | abstract class BaseService( 14 | private val coroutineDispatcher: CoroutineDispatcher, 15 | private val stringResourceProvider: StringResourceProvider 16 | ) { 17 | 18 | protected suspend fun requestApiResource(apiCall: suspend () -> T): Resource { 19 | return try { 20 | val result = apiCall.invoke() 21 | Resource.Data(result) 22 | } catch (throwable: Throwable) { 23 | when (throwable) { 24 | is HttpException -> handleHttpExceptions(throwable) 25 | is TimeoutException -> handleTimeOut() 26 | is EOFException -> handleEmptyResult() 27 | is IOException -> handleNetworkError(throwable) 28 | else -> createUnexpectedError(throwable) 29 | } 30 | } 31 | 32 | } 33 | 34 | private fun handleNetworkError(throwable: IOException): Resource.Error { 35 | return when (throwable) { 36 | is SocketTimeoutException -> createDefaultResponseError( 37 | stringResourceProvider.getString( 38 | R.string.internet_issue_message 39 | ) 40 | ) 41 | is UnknownHostException -> createDefaultResponseError(stringResourceProvider.getString(R.string.server_not_responding)) 42 | else -> createDefaultResponseError(stringResourceProvider.getString(R.string.internet_issue_message)) 43 | } 44 | } 45 | 46 | private fun handleTimeOut(): Resource.Error { 47 | return Resource.Error( 48 | stringResourceProvider.getString(R.string.internet_issue_message), 49 | DEFAULT_ERROR_CODE 50 | ) 51 | } 52 | 53 | private fun handleEmptyResult(): Resource.Error { 54 | return Resource.Error( 55 | stringResourceProvider.getString(R.string.no_data_found), 56 | DEFAULT_ERROR_CODE 57 | ) 58 | } 59 | 60 | private fun handleHttpExceptions(throwable: HttpException): Resource.Error { 61 | return when (throwable.code()) { 62 | 502 -> createDefaultResponseError(stringResourceProvider.getString(R.string.bad_gateway_message)) 63 | 500 -> createDefaultResponseError(stringResourceProvider.getString(R.string.internal_server_error)) 64 | 404 -> createDefaultResponseError(stringResourceProvider.getString(R.string.url_not_responding)) 65 | else -> { 66 | createUnexpectedError(throwable) 67 | } 68 | } 69 | } 70 | 71 | private fun createUnexpectedError(throwable: Throwable) : Resource.Error = 72 | Resource.Error( 73 | throwable.message ?: stringResourceProvider.getString(R.string.unexpected_error), 74 | DEFAULT_ERROR_CODE 75 | ) 76 | 77 | private fun createDefaultResponseError( 78 | userMessage: String 79 | ): Resource.Error { 80 | return Resource.Error( 81 | userMessage, 82 | DEFAULT_ERROR_CODE 83 | ) 84 | } 85 | 86 | companion object { 87 | private const val DEFAULT_ERROR_CODE = -1 88 | } 89 | } -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/network/NetworkProvider.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication.network 2 | 3 | import com.example.myapplication.BuildConfig 4 | import com.squareup.moshi.Moshi 5 | import com.squareup.moshi.kotlin.reflect.KotlinJsonAdapterFactory 6 | import dagger.Module 7 | import dagger.Provides 8 | import dagger.hilt.InstallIn 9 | import dagger.hilt.android.components.ViewModelComponent 10 | import kotlinx.coroutines.CoroutineDispatcher 11 | import kotlinx.coroutines.Dispatchers 12 | import okhttp3.OkHttpClient 13 | import okhttp3.logging.HttpLoggingInterceptor 14 | import retrofit2.Retrofit 15 | import retrofit2.converter.moshi.MoshiConverterFactory 16 | 17 | @Module 18 | @InstallIn(ViewModelComponent::class) 19 | class NetworkProvider { 20 | 21 | @Provides 22 | fun provideNetworkDispatcher(): CoroutineDispatcher = Dispatchers.IO 23 | 24 | @Provides 25 | fun provideMoshi(): Moshi = Moshi.Builder() 26 | .add(KotlinJsonAdapterFactory()) 27 | .build() 28 | 29 | @Provides 30 | fun provideHttpClient(): OkHttpClient { 31 | return OkHttpClient() 32 | .newBuilder() 33 | .addInterceptor(getLogger()) 34 | .build() 35 | } 36 | 37 | private fun getLogger(): HttpLoggingInterceptor { 38 | return HttpLoggingInterceptor().apply { 39 | level = if (BuildConfig.DEBUG) { 40 | HttpLoggingInterceptor.Level.BODY 41 | } else { 42 | HttpLoggingInterceptor.Level.NONE 43 | } 44 | } 45 | } 46 | 47 | @Provides 48 | fun provideRetrofit(client: OkHttpClient, moshi: Moshi): Retrofit = Retrofit.Builder() 49 | .baseUrl(BuildConfig.SERVER_URL) 50 | .client(client) 51 | .addConverterFactory(MoshiConverterFactory.create(moshi)) 52 | .build() 53 | } -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/network/Resource.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication.network 2 | 3 | sealed class Resource{ 4 | data class Data(val data : T) : Resource() 5 | data class Error(val errorMessage : String, val errorCode : Int) : Resource() 6 | } -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/resources/StringResourceProvider.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication.resources 2 | 3 | import android.content.Context 4 | import androidx.annotation.StringRes 5 | import dagger.hilt.android.qualifiers.ApplicationContext 6 | import javax.inject.Inject 7 | 8 | interface StringResourceProvider { 9 | fun getString(@StringRes id: Int): String 10 | fun getString(@StringRes id: Int, valueToFormat: Int): String 11 | fun getString(@StringRes id: Int, valueToFormat: String): String 12 | } 13 | 14 | class DefaultStringResourceProvider @Inject constructor(@ApplicationContext private val context: Context) : 15 | StringResourceProvider { 16 | 17 | override fun getString(id: Int): String { 18 | return context.getString(id) 19 | } 20 | 21 | override fun getString(id: Int, valueToFormat: Int): String { 22 | return context.getString(id, valueToFormat) 23 | } 24 | 25 | override fun getString(id: Int, valueToFormat: String): String { 26 | return context.getString(id, valueToFormat) 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/java/com/example/myapplication/resources/di/ResourceProvidersModule.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication.resources.di 2 | 3 | import com.example.myapplication.resources.DefaultStringResourceProvider 4 | import com.example.myapplication.resources.StringResourceProvider 5 | import dagger.Binds 6 | import dagger.Module 7 | import dagger.hilt.InstallIn 8 | import dagger.hilt.components.SingletonComponent 9 | 10 | /** 11 | * Dependencies that help in managing Android based resources or other common logic providers. 12 | */ 13 | @Module 14 | @InstallIn(SingletonComponent::class) 15 | abstract class ResourceProvidersModule { 16 | @Binds 17 | abstract fun bindStringResourceProvider(instance: DefaultStringResourceProvider): StringResourceProvider 18 | } -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/drawable-v24/ic_launcher_foreground.xml: -------------------------------------------------------------------------------- 1 | 7 | 8 | 9 | 15 | 18 | 21 | 22 | 23 | 24 | 30 | -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/drawable/ic_launcher_background.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 10 | 15 | 20 | 25 | 30 | 35 | 40 | 45 | 50 | 55 | 60 | 65 | 70 | 75 | 80 | 85 | 90 | 95 | 100 | 105 | 110 | 115 | 120 | 125 | 130 | 135 | 140 | 145 | 150 | 155 | 160 | 165 | 170 | 171 | -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/layout/activity_main.xml: -------------------------------------------------------------------------------- 1 | 2 | 8 | 9 | 17 | 18 | -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/mipmap-hdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talhahasanzia/android-mvvm-generator/e66ec91a2b36cd963f903ba09ba56e5972f2d568/sample/MyApplication/app/src/main/res/mipmap-hdpi/ic_launcher.webp -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talhahasanzia/android-mvvm-generator/e66ec91a2b36cd963f903ba09ba56e5972f2d568/sample/MyApplication/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/mipmap-mdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talhahasanzia/android-mvvm-generator/e66ec91a2b36cd963f903ba09ba56e5972f2d568/sample/MyApplication/app/src/main/res/mipmap-mdpi/ic_launcher.webp -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talhahasanzia/android-mvvm-generator/e66ec91a2b36cd963f903ba09ba56e5972f2d568/sample/MyApplication/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/mipmap-xhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talhahasanzia/android-mvvm-generator/e66ec91a2b36cd963f903ba09ba56e5972f2d568/sample/MyApplication/app/src/main/res/mipmap-xhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talhahasanzia/android-mvvm-generator/e66ec91a2b36cd963f903ba09ba56e5972f2d568/sample/MyApplication/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talhahasanzia/android-mvvm-generator/e66ec91a2b36cd963f903ba09ba56e5972f2d568/sample/MyApplication/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talhahasanzia/android-mvvm-generator/e66ec91a2b36cd963f903ba09ba56e5972f2d568/sample/MyApplication/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talhahasanzia/android-mvvm-generator/e66ec91a2b36cd963f903ba09ba56e5972f2d568/sample/MyApplication/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talhahasanzia/android-mvvm-generator/e66ec91a2b36cd963f903ba09ba56e5972f2d568/sample/MyApplication/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/values-night/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 16 | -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/values/colors.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | #FFBB86FC 4 | #FF6200EE 5 | #FF3700B3 6 | #FF03DAC5 7 | #FF018786 8 | #FF000000 9 | #FFFFFFFF 10 | -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | My Application 3 | Resource at given url is not responding. 4 | It seems you have a connection issue, please try again later. 5 | Server is not responding at the moment, please try again later. 6 | No data found against requested resource. 7 | Something went wrong at our end, please try again later. 8 | We are having trouble reaching server, please try again later. 9 | Something unexpected happened, please try again later. 10 | -------------------------------------------------------------------------------- /sample/MyApplication/app/src/main/res/values/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 16 | -------------------------------------------------------------------------------- /sample/MyApplication/app/src/test/java/com/example/myapplication/ExampleUnitTest.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication 2 | 3 | import org.junit.Test 4 | 5 | import org.junit.Assert.* 6 | 7 | /** 8 | * Example local unit test, which will execute on the development machine (host). 9 | * 10 | * See [testing documentation](http://d.android.com/tools/testing). 11 | */ 12 | class ExampleUnitTest { 13 | @Test 14 | fun addition_isCorrect() { 15 | assertEquals(4, 2 + 2) 16 | } 17 | } -------------------------------------------------------------------------------- /sample/MyApplication/build.gradle: -------------------------------------------------------------------------------- 1 | // Top-level build file where you can add configuration options common to all sub-projects/modules. 2 | buildscript { 3 | ext.kotlin_version = '1.6.0' 4 | repositories { 5 | gradlePluginPortal() 6 | google() 7 | mavenCentral() 8 | jcenter() 9 | maven { url "https://jitpack.io" } 10 | 11 | } 12 | dependencies { 13 | classpath 'com.google.gms:google-services:4.3.10' 14 | classpath "androidx.navigation:navigation-safe-args-gradle-plugin:2.4.2" 15 | classpath "com.google.dagger:hilt-android-gradle-plugin:2.42" 16 | classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" 17 | } 18 | } 19 | plugins { 20 | id 'com.android.application' version '7.1.3' apply false 21 | id 'com.android.library' version '7.1.3' apply false 22 | id 'org.jetbrains.kotlin.android' version '1.5.30' apply false 23 | } 24 | 25 | task clean(type: Delete) { 26 | delete rootProject.buildDir 27 | } -------------------------------------------------------------------------------- /sample/MyApplication/gradle.properties: -------------------------------------------------------------------------------- 1 | # Project-wide Gradle settings. 2 | # IDE (e.g. Android Studio) users: 3 | # Gradle settings configured through the IDE *will override* 4 | # any settings specified in this file. 5 | # For more details on how to configure your build environment visit 6 | # http://www.gradle.org/docs/current/userguide/build_environment.html 7 | # Specifies the JVM arguments used for the daemon process. 8 | # The setting is particularly useful for tweaking memory settings. 9 | org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8 10 | # When configured, Gradle will run in incubating parallel mode. 11 | # This option should only be used with decoupled projects. More details, visit 12 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects 13 | # org.gradle.parallel=true 14 | # AndroidX package structure to make it clearer which packages are bundled with the 15 | # Android operating system, and which are packaged with your app"s APK 16 | # https://developer.android.com/topic/libraries/support-library/androidx-rn 17 | android.useAndroidX=true 18 | # Kotlin code style for this project: "official" or "obsolete": 19 | kotlin.code.style=official 20 | # Enables namespacing of each library's R class so that its R class includes only the 21 | # resources declared in the library itself and none from the library's dependencies, 22 | # thereby reducing the size of the R class for that library 23 | android.nonTransitiveRClass=true -------------------------------------------------------------------------------- /sample/MyApplication/gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talhahasanzia/android-mvvm-generator/e66ec91a2b36cd963f903ba09ba56e5972f2d568/sample/MyApplication/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /sample/MyApplication/gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Tue Aug 30 11:10:15 PKT 2022 2 | distributionBase=GRADLE_USER_HOME 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip 4 | distributionPath=wrapper/dists 5 | zipStorePath=wrapper/dists 6 | zipStoreBase=GRADLE_USER_HOME 7 | -------------------------------------------------------------------------------- /sample/MyApplication/gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | # 4 | # Copyright 2015 the original author or authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | ## 21 | ## Gradle start up script for UN*X 22 | ## 23 | ############################################################################## 24 | 25 | # Attempt to set APP_HOME 26 | # Resolve links: $0 may be a link 27 | PRG="$0" 28 | # Need this for relative symlinks. 29 | while [ -h "$PRG" ] ; do 30 | ls=`ls -ld "$PRG"` 31 | link=`expr "$ls" : '.*-> \(.*\)$'` 32 | if expr "$link" : '/.*' > /dev/null; then 33 | PRG="$link" 34 | else 35 | PRG=`dirname "$PRG"`"/$link" 36 | fi 37 | done 38 | SAVED="`pwd`" 39 | cd "`dirname \"$PRG\"`/" >/dev/null 40 | APP_HOME="`pwd -P`" 41 | cd "$SAVED" >/dev/null 42 | 43 | APP_NAME="Gradle" 44 | APP_BASE_NAME=`basename "$0"` 45 | 46 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 47 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 48 | 49 | # Use the maximum available, or set MAX_FD != -1 to use that value. 50 | MAX_FD="maximum" 51 | 52 | warn () { 53 | echo "$*" 54 | } 55 | 56 | die () { 57 | echo 58 | echo "$*" 59 | echo 60 | exit 1 61 | } 62 | 63 | # OS specific support (must be 'true' or 'false'). 64 | cygwin=false 65 | msys=false 66 | darwin=false 67 | nonstop=false 68 | case "`uname`" in 69 | CYGWIN* ) 70 | cygwin=true 71 | ;; 72 | Darwin* ) 73 | darwin=true 74 | ;; 75 | MINGW* ) 76 | msys=true 77 | ;; 78 | NONSTOP* ) 79 | nonstop=true 80 | ;; 81 | esac 82 | 83 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 84 | 85 | 86 | # Determine the Java command to use to start the JVM. 87 | if [ -n "$JAVA_HOME" ] ; then 88 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 89 | # IBM's JDK on AIX uses strange locations for the executables 90 | JAVACMD="$JAVA_HOME/jre/sh/java" 91 | else 92 | JAVACMD="$JAVA_HOME/bin/java" 93 | fi 94 | if [ ! -x "$JAVACMD" ] ; then 95 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 96 | 97 | Please set the JAVA_HOME variable in your environment to match the 98 | location of your Java installation." 99 | fi 100 | else 101 | JAVACMD="java" 102 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 103 | 104 | Please set the JAVA_HOME variable in your environment to match the 105 | location of your Java installation." 106 | fi 107 | 108 | # Increase the maximum file descriptors if we can. 109 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 110 | MAX_FD_LIMIT=`ulimit -H -n` 111 | if [ $? -eq 0 ] ; then 112 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 113 | MAX_FD="$MAX_FD_LIMIT" 114 | fi 115 | ulimit -n $MAX_FD 116 | if [ $? -ne 0 ] ; then 117 | warn "Could not set maximum file descriptor limit: $MAX_FD" 118 | fi 119 | else 120 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 121 | fi 122 | fi 123 | 124 | # For Darwin, add options to specify how the application appears in the dock 125 | if $darwin; then 126 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 127 | fi 128 | 129 | # For Cygwin or MSYS, switch paths to Windows format before running java 130 | if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then 131 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 132 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 133 | 134 | JAVACMD=`cygpath --unix "$JAVACMD"` 135 | 136 | # We build the pattern for arguments to be converted via cygpath 137 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 138 | SEP="" 139 | for dir in $ROOTDIRSRAW ; do 140 | ROOTDIRS="$ROOTDIRS$SEP$dir" 141 | SEP="|" 142 | done 143 | OURCYGPATTERN="(^($ROOTDIRS))" 144 | # Add a user-defined pattern to the cygpath arguments 145 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 146 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 147 | fi 148 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 149 | i=0 150 | for arg in "$@" ; do 151 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 152 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 153 | 154 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 155 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 156 | else 157 | eval `echo args$i`="\"$arg\"" 158 | fi 159 | i=`expr $i + 1` 160 | done 161 | case $i in 162 | 0) set -- ;; 163 | 1) set -- "$args0" ;; 164 | 2) set -- "$args0" "$args1" ;; 165 | 3) set -- "$args0" "$args1" "$args2" ;; 166 | 4) set -- "$args0" "$args1" "$args2" "$args3" ;; 167 | 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 168 | 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 169 | 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 170 | 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 171 | 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 172 | esac 173 | fi 174 | 175 | # Escape application args 176 | save () { 177 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 178 | echo " " 179 | } 180 | APP_ARGS=`save "$@"` 181 | 182 | # Collect all arguments for the java command, following the shell quoting and substitution rules 183 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 184 | 185 | exec "$JAVACMD" "$@" 186 | -------------------------------------------------------------------------------- /sample/MyApplication/gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if "%ERRORLEVEL%"=="0" goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 84 | exit /b 1 85 | 86 | :mainEnd 87 | if "%OS%"=="Windows_NT" endlocal 88 | 89 | :omega 90 | -------------------------------------------------------------------------------- /sample/MyApplication/settings.gradle: -------------------------------------------------------------------------------- 1 | pluginManagement { 2 | repositories { 3 | gradlePluginPortal() 4 | google() 5 | mavenCentral() 6 | } 7 | } 8 | dependencyResolutionManagement { 9 | repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) 10 | repositories { 11 | google() 12 | mavenCentral() 13 | } 14 | } 15 | rootProject.name = "My Application" 16 | include ':app' 17 | -------------------------------------------------------------------------------- /template.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talhahasanzia/android-mvvm-generator/e66ec91a2b36cd963f903ba09ba56e5972f2d568/template.png --------------------------------------------------------------------------------