├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── EasySQLite.iml
├── LICENSE
├── README.md
├── app
├── .gitignore
├── app.iml
├── build.gradle
├── proguard-rules.pro
└── src
│ ├── androidTest
│ └── java
│ │ └── com
│ │ └── tonilopezmr
│ │ └── sample
│ │ └── ApplicationTest.java
│ └── main
│ ├── AndroidManifest.xml
│ ├── java
│ └── com
│ │ └── tonilopezmr
│ │ └── sample
│ │ ├── data
│ │ ├── SQLite
│ │ │ ├── SQLiteManager.java
│ │ │ ├── dao
│ │ │ │ └── SubjectDAO.java
│ │ │ ├── entity
│ │ │ │ ├── SubjectEntity.java
│ │ │ │ └── mapper
│ │ │ │ │ └── SubjectEntityMapper.java
│ │ │ ├── repository
│ │ │ │ └── SubjectDataRepository.java
│ │ │ └── transformer
│ │ │ │ └── SubjectTransformer.java
│ │ └── mock
│ │ │ └── MockSubjectRepository.java
│ │ ├── di
│ │ ├── BaseActivity.java
│ │ ├── BasePresenter.java
│ │ ├── SubjectsApplication.java
│ │ └── modules
│ │ │ ├── ExecutorModule.java
│ │ │ ├── InteractorModule.java
│ │ │ ├── PresenterModule.java
│ │ │ ├── RepositoryModule.java
│ │ │ └── RootModule.java
│ │ ├── domain
│ │ ├── Subject.java
│ │ ├── exception
│ │ │ └── SubjectException.java
│ │ ├── interactor
│ │ │ ├── AbstractSubjectUseCase.java
│ │ │ ├── CreateSubjectUseCaseImp.java
│ │ │ ├── DeleteSubjectUseCaseImp.java
│ │ │ ├── GetSubjectListUseCase.java
│ │ │ ├── GetSubjectListUseCaseImp.java
│ │ │ └── SubjectUseCase.java
│ │ ├── mapper
│ │ │ └── SubjectMapper.java
│ │ └── repository
│ │ │ └── SubjectRepository.java
│ │ ├── executor
│ │ ├── Executor.java
│ │ ├── Interactor.java
│ │ ├── MainThread.java
│ │ ├── MainThreadImp.java
│ │ └── ThreadExecutor.java
│ │ └── ui
│ │ ├── AbstracRecyclerViewHolder.java
│ │ ├── MainActivity.java
│ │ ├── MyRecyclerAdapter.java
│ │ ├── presenter
│ │ ├── Presenter.java
│ │ ├── SubjectListPresenter.java
│ │ └── SubjectListPresenterImp.java
│ │ ├── view
│ │ ├── ModelListView.java
│ │ ├── SubjectListView.java
│ │ └── View.java
│ │ └── viewmodel
│ │ ├── SubjectViewModel.java
│ │ └── SubjectViewModelImp.java
│ └── res
│ ├── drawable-hdpi
│ └── ic_launcher.png
│ ├── drawable-mdpi
│ └── ic_launcher.png
│ ├── drawable-xhdpi
│ └── ic_launcher.png
│ ├── drawable-xxhdpi
│ └── ic_launcher.png
│ ├── drawable
│ ├── ic_add_white.png
│ └── ic_error.png
│ ├── layout
│ ├── activity_main.xml
│ └── item_list.xml
│ ├── menu
│ └── menu_main.xml
│ ├── values-w820dp
│ └── dimens.xml
│ └── values
│ ├── colors.xml
│ ├── dimens.xml
│ ├── strings.xml
│ └── styles.xml
├── build.gradle
├── easysqlite
├── .gitignore
├── build.gradle
├── easysqlite.iml
├── gradle.properties
├── proguard-rules.pro
└── src
│ ├── androidTest
│ └── java
│ │ └── com
│ │ └── tonilopezmr
│ │ └── easysqlite
│ │ └── ApplicationTest.java
│ └── main
│ ├── AndroidManifest.xml
│ └── java
│ └── com
│ └── tonilopezmr
│ └── easysqlite
│ ├── DataAccesObject.java
│ ├── SQLiteDelegate.java
│ ├── SQLiteHelper.java
│ ├── SQLiteTransformer.java
│ └── exception
│ └── SQLiteHelperException.java
├── gradle.properties
├── gradle
└── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── maven_push.gradle
└── settings.gradle
/.gitignore:
--------------------------------------------------------------------------------
1 | #Android generated
2 | bin
3 | gen
4 | lint.xml
5 | lint
6 |
7 | #Eclipse
8 | .project
9 | .classpath
10 | .settings
11 | .checkstyle
12 |
13 | #IntelliJ IDEA
14 | .idea
15 | *.iml
16 | *.ipr
17 | *.iws
18 | classes
19 | gen-external-apklibs
20 |
21 | #gradle
22 | .gradle
23 | local.properties
24 | build/
25 |
26 | #vi
27 | *.swp
28 |
29 | #other editors
30 | *.bak
31 |
32 | #Maven
33 | target
34 | release.properties
35 | pom.xml.*
36 |
37 | #Ant
38 | build.xml
39 | ant.properties
40 | local.properties
41 | proguard.cfg
42 | proguard-project.txt
43 |
44 | #Other
45 | .DS_Store
46 | Thumbs.db
47 | tmp
48 | *.tgz
49 | *.lock
50 | *.lck
51 | com_crashlytics_export_strings.xml
52 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: android
2 | android:
3 | components:
4 | - build-tools-21.1.1
5 | - android-21
6 |
7 | # Additional components
8 | - extra-google-m2repository
9 | - extra-android-m2repository
10 | - extra-android-support
11 |
12 | script:
13 | ./gradlew build
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | #Change Log
2 |
3 | Version 2.0.1 (2016-02-19)
4 | -------------
5 |
6 | Added the method onOpen(SQLiteDatabase) with foreign keys on.
7 |
8 | Version 2.0.1 (2015-02-25)
9 | -------------
10 |
11 | The method setId(T dto, Object id) change (Object id) by (int id).
12 | The methods update and deleteAll return the number of rows affected.
13 |
14 | Version 2.0.0 (2015-02-18)
15 | -------------
16 |
17 | Add the SQLiteHelper.Builder
18 |
19 | Version 1.0.2
20 | -------------
21 |
22 | Bugs fixed
23 |
24 | Version 1.0.1
25 | -------------
26 |
27 | Initial release
--------------------------------------------------------------------------------
/EasySQLite.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 |
203 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | #EasySQLite [](https://travis-ci.org/tonilopezmr/Android-EasySQLite) [](https://maven-badges.herokuapp.com/maven-central/com.github.tonilopezmr/easysqlite) [](http://android-arsenal.com/details/1/1592)
2 |
3 | Use easily the database SQLite on android using the DAO and transformer design patterns, I modified the library of the professor [@jvprofe][11], I learned it from him.
4 |
5 | Basic methods are already implemented in the class `SQLiteDelegate`, if you need further queries you should extend from it.
6 |
7 | #How to use
8 |
9 | ####Import EasySQLite dependency:
10 |
11 | Grab via maven:
12 |
13 | ```xml
14 |
15 | com.github.tonilopezmr
16 | easysqlite
17 | 2.1.0
18 |
19 | ```
20 |
21 | or gradle:
22 |
23 | ```gradle
24 | compile 'com.github.tonilopezmr:easysqlite:2.1.0'
25 | ````
26 |
27 | ####1. Create the object Transformer which implements SQLiteTransformer
28 |
29 | ```java
30 | public class SubjectTransformer implements SQLiteTransformer{
31 |
32 | public static final String ID = "id";
33 | public static final String NAME = "name";
34 |
35 | public static final String TABLE_NAME = "subject";
36 | public static final String[] FIELDS = {ID, NAME};
37 |
38 | @Override
39 | public SubjectEntity transform(Cursor cursor) throws Exception {
40 | int id = cursor.getInt(0);
41 | String name = cursor.getString(1);
42 | return new SubjectEntity(id, name);
43 | }
44 |
45 | @Override
46 | public ContentValues transform(SubjectEntity dto) throws Exception {
47 | ContentValues values = new ContentValues();
48 | //values.put(ID, dto.getId()); it is not necessary, autoincrement!
49 | values.put(NAME, dto.getName());
50 |
51 | return values;
52 | }
53 |
54 | @Override
55 | public String getWhereClause(SubjectEntity dto) throws Exception {
56 | return ID+"="+dto.getId();
57 | }
58 |
59 | @Override
60 | public SubjectEntity setId(SubjectEntity dto, Object id) throws Exception {
61 | dto.setId((Integer.valueOf(id.toString())));
62 | return dto;
63 | }
64 |
65 | @Override
66 | public String[] getFields() throws Exception {
67 | return FIELDS;
68 | }
69 |
70 | @Override
71 | public String getTableName() throws Exception {
72 | return TABLE_NAME;
73 | }
74 | }
75 | ```
76 | ####2. Create the object DAO which extends SQLiteDelegate
77 |
78 | The `SQLiteDelegate` has implemented the following methods:
79 |
80 | //Default methods implement with SQLiteDelegate
81 | T create(T dto)
82 | int update(T dto)
83 | T read(T id)
84 | Collection readAll()
85 | boolean delete(T dto)
86 | int deleteAll()
87 |
88 | ```java
89 | public class SubjectDAO extends SQLiteDelegate {
90 |
91 | public SubjectDAO(SQLiteDatabase db) {
92 | super(db, new SubjectTransformer());
93 | }
94 |
95 | //In the case you need more querys, write this for example:
96 | public List getSubjectsApproved() {
97 | ...
98 | }
99 |
100 | }
101 | ```
102 | ####If you need one relation between objects (foreign key)
103 |
104 | ```java
105 | public class SubjectTransformer implements SQLiteTransformer{
106 |
107 | ...
108 |
109 | private ExamDAO examDAO;
110 |
111 | public SubjectTransformer(SQLiteDatabase db){
112 | examDAO = new ExamDAO(db);
113 | }
114 |
115 | ...
116 | }
117 | ```
118 | ####and
119 |
120 | ```java
121 | public class SubjectDAO extends SQLiteDelegate {
122 |
123 | public SubjectDAO(SQLiteDatabase db) {
124 | super(db, new SubjectTransformer(db));
125 | }
126 |
127 | }
128 | ```
129 |
130 | ####3. Instance the object DAO and use the CRUD methods
131 |
132 | ```java
133 |
134 | ...
135 |
136 | SubjectDAO subjectDAO = new SubjectDAO(database);
137 | Subject subject = new Subject("maths");
138 |
139 | //Create
140 | subject = subjectDAO.create(subject);
141 |
142 | //Delete
143 | boolean isDelete = subjectDAO.delete(subject);
144 | ...
145 |
146 | ```
147 |
148 | Use the SQLiteHelper and get rid of SQLiteOpenHelper
149 | ---------------------------------------------------
150 |
151 | ####If you need one simple database:
152 |
153 | ```java
154 | //Create table
155 | final private String SUBJECT_TABLE =
156 | "CREATE TABLE SUBJECT(" +
157 | "ID INTEGER PRIMARY KEY AUTOINCREMENT," +
158 | "NAME TEXT NOT NULL" +
159 | ")";
160 |
161 | //Table name
162 | final private String SUBJECT = "SUBJECT";
163 |
164 | final private String[] TABLES = {SUBJECT_TABLE};
165 | final private String[] TABLE_NAMES = {SUBJECT};
166 |
167 | ```
168 |
169 | Important:
170 |
171 | - The array `TABLES` in database must be sorted in order of creation, to avoid problems with the foreign keys!.
172 |
173 | - The array tables in database must be sorted in opposite order by the array of creation tables, for example:
174 |
175 | ```java
176 | final private String[] TABLES = {SUBJECT_TABLE, EXAM_TABLE, PROFESSOR_TABLE};
177 | //Very important, sorted in opposite order.
178 | final private String[] TABLE_NAMES = {PROFESSOR, EXAM, SUBJECT_TABLE};
179 | ```
180 |
181 | Create SQLiteHelper:
182 |
183 | ```java
184 | SQLiteHelper helper = SQLiteHelper.builder()
185 | .tables(TABLES)
186 | .tableNames(TABLE_NAMES)
187 | .build(context);
188 |
189 | SQLiteDatabase dataBase = helper.getWritableDatabase();
190 | ```
191 |
192 | In this case, the name and version of the database by default are Name: `com.easysqlite` and Version: `1`. For put the name and version you can do:
193 |
194 | ```java
195 | SQLiteHelper helper = SQLiteHelper.builder()
196 | .tables(TABLES)
197 | .tableNames(TABLE_NAMES)
198 | .build(context, DATABASE_NAME, SQLITE_VERSION);
199 | ```
200 |
201 | OR
202 |
203 | ```java
204 | SQLiteHelper helper = SQLiteHelper.builder()
205 | .tables(TABLES)
206 | .tableNames(TABLE_NAMES)
207 | .name(DATABASE_NAME)
208 | .version(DATABASE_VERSION)
209 | .build(context);
210 | ```
211 |
212 | ####If you need one custom implementation:
213 |
214 | ```java
215 | private static SQLiteHelper.SQLiteHelperCallback helperCallback = new SQLiteHelper.SQLiteHelperCallback() {
216 | @Override
217 | public void onCreate(SQLiteDatabase db) {
218 | db.execSQL(SUBJECT_TABLE);
219 | db.execSQL("INSERT INTO "+SUBJECT+"(name) VALUES ('Maths')");
220 |
221 | ...
222 | }
223 |
224 | @Override
225 | public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
226 | ...
227 | }
228 | };
229 |
230 | ```
231 |
232 | ```java
233 | SQLiteHelper helper = SQLiteHelper.builder()
234 | .beginConfig()
235 | .helperCallback(helperCallback)
236 | .foreignKey(true) //PRAGMA foreign_keys = ON
237 | .endConfig()
238 | .tables(TABLES)
239 | .tableNames(TABLE_NAMES)
240 | .build(context, DATABASE_NAME, cursorFactory, SQLITE_VERSION);
241 | ```
242 |
243 | If you need change only the method `onCreate` or `onUpgrade`, use `onCreateCallback(OnCreateCallback callback)` or `onUpgradeCallback(OnUpgradeCallback callback)`.
244 |
245 |
246 | Sample Clean architecture
247 | -------------------------
248 | The code which uses this library is in the package `'com.tonilopezmr.sample.data.SQLite'`.
249 |
250 | I use the Clean architecture with the pattern MVP, I have been motivated for the speaker [pedrovgs][10] in DroidCon 2014.
251 |
252 | After see the MVP implementations of:
253 |
254 | * [MVPCleanArchitecture][6] by [glmoadrian][5]
255 | * [EffectiveAndroidUI][7] by [pedrovgs][4]
256 | * [Android-CleanArchitecture][8] by [android10][9]
257 |
258 |
259 | Libraries used on the sample project
260 | ------------------------------------
261 |
262 | * [Dagger][1]
263 | * [Butterknife][2]
264 | * [FloatingActionButton][3]
265 |
266 | If anything is wrong contact me
267 | -------------------------------------------
268 |
269 | * Antonio López Marín -
270 |
271 |
272 |
273 |
274 |
275 |
276 |
277 |
278 | ######Sorry for my English :(
279 |
280 | License
281 | -------
282 |
283 | Copyright 2015 Antonio López Marín
284 |
285 | Licensed under the Apache License, Version 2.0 (the "License");
286 | you may not use this file except in compliance with the License.
287 | You may obtain a copy of the License at
288 |
289 | http://www.apache.org/licenses/LICENSE-2.0
290 |
291 | Unless required by applicable law or agreed to in writing, software
292 | distributed under the License is distributed on an "AS IS" BASIS,
293 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
294 | See the License for the specific language governing permissions and
295 | limitations under the License.
296 |
297 |
298 | [1]: https://github.com/square/dagger
299 | [2]: https://github.com/JakeWharton/butterknife
300 | [3]: https://github.com/makovkastar/FloatingActionButton
301 | [4]: https://github.com/pedrovgs
302 | [5]: https://github.com/glomadrian
303 | [6]: https://github.com/glomadrian/MvpCleanArchitecture
304 | [7]: https://github.com/pedrovgs/EffectiveAndroidUI
305 | [8]: https://github.com/android10/Android-CleanArchitecture
306 | [9]: https://github.com/android10
307 | [10]: http://www.slideshare.net/PedroVicenteGmezSnch/effective-android-ui-english
308 | [11]: https://twitter.com/jvprofe
309 |
--------------------------------------------------------------------------------
/app/.gitignore:
--------------------------------------------------------------------------------
1 | /build
2 |
--------------------------------------------------------------------------------
/app/app.iml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 | generateDebugSources
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 |
59 |
60 |
61 |
62 |
63 |
64 |
65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
77 |
78 |
79 |
80 |
81 |
82 |
83 |
84 |
85 |
86 |
87 |
88 |
89 |
90 |
91 |
92 |
93 |
94 |
95 |
96 |
97 |
--------------------------------------------------------------------------------
/app/build.gradle:
--------------------------------------------------------------------------------
1 | apply plugin: 'com.android.application'
2 |
3 | android {
4 | compileSdkVersion 21
5 | buildToolsVersion "21.1.2"
6 | defaultConfig {
7 | applicationId 'com.tonilopezmr.sample'
8 | minSdkVersion 14
9 | targetSdkVersion 21
10 | versionCode 3
11 | versionName "2.0"
12 | }
13 | buildTypes {
14 | release {
15 | minifyEnabled false
16 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
17 | }
18 | }
19 | packagingOptions {
20 | exclude 'META-INF/services/javax.annotation.processing.Processor'
21 | }
22 | }
23 |
24 | dependencies {
25 | compile fileTree(dir: 'libs', include: ['*.jar'])
26 | compile 'com.android.support:appcompat-v7:21.0.3'
27 | compile 'com.android.support:recyclerview-v7:21.0.3'
28 | compile 'com.getbase:floatingactionbutton:1.2.1'
29 | compile 'com.squareup.dagger:dagger-compiler:1.2.2'
30 | compile 'com.squareup.dagger:dagger:1.2.2'
31 | compile 'com.jakewharton:butterknife:6.1.0'
32 | compile 'com.github.navasmdc:MaterialDesign:1.+@aar'
33 | compile project(':easysqlite')
34 | }
35 |
--------------------------------------------------------------------------------
/app/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/toni/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 |
--------------------------------------------------------------------------------
/app/src/androidTest/java/com/tonilopezmr/sample/ApplicationTest.java:
--------------------------------------------------------------------------------
1 | package com.tonilopezmr.sample;
2 |
3 | import android.app.Application;
4 | import android.test.ApplicationTestCase;
5 |
6 | /**
7 | * Testing Fundamentals
8 | */
9 | public class ApplicationTest extends ApplicationTestCase {
10 | public ApplicationTest() {
11 | super(Application.class);
12 | }
13 | }
--------------------------------------------------------------------------------
/app/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
5 |
6 |
9 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
--------------------------------------------------------------------------------
/app/src/main/java/com/tonilopezmr/sample/data/SQLite/SQLiteManager.java:
--------------------------------------------------------------------------------
1 | package com.tonilopezmr.sample.data.SQLite;
2 |
3 | import android.content.Context;
4 | import android.database.sqlite.SQLiteDatabase;
5 | import android.util.Log;
6 |
7 | import com.tonilopezmr.easysqlite.SQLiteHelper;
8 |
9 | /**
10 | *
11 | * @author Toni
12 | */
13 | public class SQLiteManager {
14 |
15 | public final static int SQLITE_VERSION = 1;
16 |
17 | private static final String SUBJECT_TABLE =
18 | "CREATE TABLE SUBJECT(" +
19 | "ID INTEGER PRIMARY KEY AUTOINCREMENT," +
20 | "NAME TEXT NOT NULL" +
21 | ")";
22 |
23 | final static private String SUBJECT = "SUBJECT";
24 |
25 | final static private String[] TABLES = {SUBJECT_TABLE};
26 | final static private String[] TABLE_NAMES = {SUBJECT};
27 |
28 | private static SQLiteDatabase dataBase;
29 |
30 | private SQLiteManager(){}
31 |
32 | public static SQLiteDatabase getDataBase(Context context){
33 | if (dataBase == null){
34 | //Create the SQLiteOpenHelper with the default name
35 | SQLiteHelper conex = SQLiteHelper.builder()
36 | .beginConfig()
37 | .onCreateCallback(onCreateCallback)
38 | .foreignKey(true)
39 | .endConfig()
40 | .tables(TABLES)
41 | .tableNames(TABLE_NAMES)
42 | .version(SQLITE_VERSION)
43 | .build(context);
44 | dataBase = conex.getWritableDatabase();
45 | }
46 | return dataBase;
47 | }
48 |
49 | private static SQLiteHelper.OnCreateCallback onCreateCallback = new SQLiteHelper.OnCreateCallback() {
50 | @Override
51 | public void onCreate(SQLiteDatabase db){
52 | db.execSQL(SUBJECT_TABLE);
53 | db.execSQL("INSERT INTO "+SUBJECT+"(name) VALUES ('Maths')");
54 | db.execSQL("INSERT INTO "+SUBJECT+"(name) VALUES ('Biology')");
55 | db.execSQL("INSERT INTO "+SUBJECT+"(name) VALUES ('Calculus')");
56 | Log.i(this.getClass().toString(), "CREATE VALUES");
57 | }
58 | };
59 | }
60 |
--------------------------------------------------------------------------------
/app/src/main/java/com/tonilopezmr/sample/data/SQLite/dao/SubjectDAO.java:
--------------------------------------------------------------------------------
1 | package com.tonilopezmr.sample.data.SQLite.dao;
2 |
3 | import android.database.sqlite.SQLiteDatabase;
4 |
5 | import com.tonilopezmr.easysqlite.SQLiteDelegate;
6 | import com.tonilopezmr.sample.data.SQLite.entity.SubjectEntity;
7 | import com.tonilopezmr.sample.data.SQLite.transformer.SubjectTransformer;
8 |
9 | /**
10 | * DAO implementation, important extend for SQLiteDelegate and indicate the ObjectEntity.
11 | * Each DAO implementation should have a Transformer.
12 | *
13 | * @author Toni
14 | */
15 | public class SubjectDAO extends SQLiteDelegate {
16 | public SubjectDAO(SQLiteDatabase db) {
17 | super(db, new SubjectTransformer());
18 | }
19 | }
20 |
--------------------------------------------------------------------------------
/app/src/main/java/com/tonilopezmr/sample/data/SQLite/entity/SubjectEntity.java:
--------------------------------------------------------------------------------
1 | package com.tonilopezmr.sample.data.SQLite.entity;
2 |
3 | /**
4 | *
5 | * @author Toni
6 | */
7 | public class SubjectEntity {
8 | int id;
9 | String name;
10 |
11 | public SubjectEntity(int id, String name) {
12 | this.id = id;
13 | this.name = name;
14 | }
15 |
16 | public int getId() {
17 | return id;
18 | }
19 |
20 | public void setId(int id) {
21 | this.id = id;
22 | }
23 |
24 | public String getName() {
25 | return name;
26 | }
27 |
28 | public void setName(String name) {
29 | this.name = name;
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/app/src/main/java/com/tonilopezmr/sample/data/SQLite/entity/mapper/SubjectEntityMapper.java:
--------------------------------------------------------------------------------
1 | package com.tonilopezmr.sample.data.SQLite.entity.mapper;
2 |
3 | import com.tonilopezmr.sample.data.SQLite.entity.SubjectEntity;
4 | import com.tonilopezmr.sample.domain.Subject;
5 | import com.tonilopezmr.sample.domain.mapper.SubjectMapper;
6 |
7 | /**
8 | *
9 | * @author Toni
10 | */
11 | public class SubjectEntityMapper implements SubjectMapper{
12 |
13 | public SubjectEntityMapper() {
14 | }
15 |
16 | public Subject mapToSubject(SubjectEntity subjectEntity){
17 | return new Subject(subjectEntity.getId(), subjectEntity.getName());
18 | }
19 |
20 | public SubjectEntity mapToSubjectEntity(Subject subject){
21 | return new SubjectEntity(subject.getId(), subject.getName());
22 | }
23 | }
24 |
--------------------------------------------------------------------------------
/app/src/main/java/com/tonilopezmr/sample/data/SQLite/repository/SubjectDataRepository.java:
--------------------------------------------------------------------------------
1 | package com.tonilopezmr.sample.data.SQLite.repository;
2 |
3 | import android.content.Context;
4 |
5 | import com.tonilopezmr.sample.data.SQLite.SQLiteManager;
6 | import com.tonilopezmr.sample.data.SQLite.dao.SubjectDAO;
7 | import com.tonilopezmr.sample.data.SQLite.entity.SubjectEntity;
8 | import com.tonilopezmr.sample.domain.Subject;
9 | import com.tonilopezmr.sample.domain.exception.SubjectException;
10 | import com.tonilopezmr.sample.domain.mapper.SubjectMapper;
11 | import com.tonilopezmr.sample.domain.repository.SubjectRepository;
12 |
13 | import java.util.ArrayList;
14 | import java.util.Collection;
15 | import java.util.Random;
16 |
17 | /**
18 | *
19 | * @author Toni
20 | */
21 | public class SubjectDataRepository implements SubjectRepository {
22 |
23 | private SubjectDAO subjectDAO;
24 | private SubjectMapper mapper;
25 |
26 | public SubjectDataRepository(Context context, SubjectMapper mapper) {
27 | subjectDAO = new SubjectDAO(SQLiteManager.getDataBase(context));
28 | this.mapper = mapper;
29 | }
30 |
31 | @Override
32 | public void getSubjectsCollection(SubjectListCallback callback) throws SubjectException{
33 | try {
34 | randomError();
35 | callback.onSubjectListLoader(createCollecitonSubject(subjectDAO.readAll()));
36 | } catch (Exception e) {
37 | e.printStackTrace();
38 | callback.onError(new SubjectException(e));
39 | }
40 | }
41 |
42 | @Override
43 | public void createSubject(Subject subject, SubjectUseCase callback) throws SubjectException {
44 | try {
45 | SubjectEntity subjectEntity = mapper.mapToSubjectEntity(subject);
46 | callback.onMissionAccomplished(mapper.mapToSubject(subjectDAO.create(subjectEntity)));
47 | } catch (Exception e) {
48 | e.printStackTrace();
49 | callback.onError(new SubjectException(e));
50 | }
51 | }
52 |
53 | @Override
54 | public void deleteSubject(Subject subject, SubjectUseCase callback) throws SubjectException {
55 | try {
56 | SubjectEntity subjectEntity = mapper.mapToSubjectEntity(subject);
57 | boolean isDelete = subjectDAO.delete(subjectEntity);
58 | if (isDelete){
59 | callback.onMissionAccomplished(subject);
60 | }else{
61 | callback.onError(new SubjectException("Has not been deleted"));
62 | }
63 | } catch (Exception e) {
64 | e.printStackTrace();
65 | callback.onError(new SubjectException(e));
66 | }
67 | }
68 |
69 | private Collection createCollecitonSubject(Collection entityCollection){
70 | Collection subjects = new ArrayList<>();
71 |
72 | for (SubjectEntity subjectEntity : entityCollection){
73 | subjects.add(mapper.mapToSubject(subjectEntity));
74 | }
75 |
76 | return subjects;
77 | }
78 |
79 | public void randomError(){
80 | Random random = new Random();
81 |
82 | Object[] objects = {3,4,"Oops :(",5,4,"Error :D", 4, 8};
83 | int i = Integer.valueOf(objects[random.nextInt(7+1)].toString());
84 | }
85 | }
86 |
--------------------------------------------------------------------------------
/app/src/main/java/com/tonilopezmr/sample/data/SQLite/transformer/SubjectTransformer.java:
--------------------------------------------------------------------------------
1 | package com.tonilopezmr.sample.data.SQLite.transformer;
2 |
3 | import android.content.ContentValues;
4 | import android.database.Cursor;
5 |
6 | import com.tonilopezmr.easysqlite.SQLiteTransformer;
7 | import com.tonilopezmr.sample.data.SQLite.entity.SubjectEntity;
8 |
9 | /**
10 | *
11 | * @author Toni
12 | */
13 | public class SubjectTransformer implements SQLiteTransformer{
14 |
15 | public static final String ID = "id";
16 | public static final String NAME = "name";
17 |
18 | public static final String TABLE_NAME = "subject";
19 | public static final String[] FIELDS = {ID, NAME};
20 |
21 | @Override
22 | public SubjectEntity transform(Cursor cursor) throws Exception {
23 | int id = cursor.getInt(0);
24 | String name = cursor.getString(1);
25 | return new SubjectEntity(id, name);
26 | }
27 |
28 | @Override
29 | public ContentValues transform(SubjectEntity dto) throws Exception {
30 | ContentValues values = new ContentValues();
31 | // values.put(ID, dto.getId()); it is not necessary, autoincrement!
32 | values.put(NAME, dto.getName());
33 |
34 | return values;
35 | }
36 |
37 | @Override
38 | public String getWhereClause(SubjectEntity dto) throws Exception {
39 | return ID+"="+dto.getId();
40 | }
41 |
42 | @Override
43 | public SubjectEntity setId(SubjectEntity dto, int id) throws Exception {
44 | dto.setId(id);
45 | return dto;
46 | }
47 |
48 | @Override
49 | public String[] getFields() throws Exception {
50 | return FIELDS;
51 | }
52 |
53 | @Override
54 | public String getTableName() throws Exception {
55 | return TABLE_NAME;
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/app/src/main/java/com/tonilopezmr/sample/data/mock/MockSubjectRepository.java:
--------------------------------------------------------------------------------
1 | package com.tonilopezmr.sample.data.mock;
2 |
3 | import com.tonilopezmr.sample.domain.Subject;
4 | import com.tonilopezmr.sample.domain.exception.SubjectException;
5 | import com.tonilopezmr.sample.domain.repository.SubjectRepository;
6 |
7 | import java.util.ArrayList;
8 | import java.util.Collection;
9 |
10 | /**
11 | * Mock repository for testing.
12 | *
13 | * @author Toni
14 | */
15 | public class MockSubjectRepository implements SubjectRepository {
16 |
17 | private Collection generateSubjectCollection() {
18 |
19 | Collection subjects = new ArrayList<>();
20 |
21 | subjects.add(createSubject(1,"Fisica"));
22 | subjects.add(createSubject(2, "Algebra"));
23 | subjects.add(createSubject(3, "Estadistica"));
24 | subjects.add(createSubject(4, "Analisis Matematico"));
25 | subjects.add(createSubject(5, "Iniciación a la programación"));
26 | subjects.add(createSubject(6, "Fundamentos de los computadores"));
27 | subjects.add(createSubject(7, "Empresa"));
28 |
29 | return subjects;
30 | }
31 |
32 | private Subject createSubject(int id, String name) {
33 | return new Subject(id, name);
34 | }
35 |
36 |
37 | @Override
38 | public void getSubjectsCollection(SubjectListCallback subjectListCallback){
39 | subjectListCallback.onSubjectListLoader(generateSubjectCollection());
40 | }
41 |
42 | @Override
43 | public void createSubject(Subject subject, SubjectUseCase callback) throws SubjectException {
44 | subject.setId(10);
45 | subject.setName("Create new Subject");
46 | callback.onMissionAccomplished(subject);
47 | }
48 |
49 | @Override
50 | public void deleteSubject(Subject subject, SubjectUseCase callback) throws SubjectException {
51 | callback.onMissionAccomplished(subject);
52 | }
53 | }
54 |
--------------------------------------------------------------------------------
/app/src/main/java/com/tonilopezmr/sample/di/BaseActivity.java:
--------------------------------------------------------------------------------
1 | package com.tonilopezmr.sample.di;
2 |
3 | import android.app.Activity;
4 | import android.os.Bundle;
5 |
6 | import butterknife.ButterKnife;
7 |
8 | /**
9 | * @author toni.
10 | */
11 | public abstract class BaseActivity extends Activity{
12 |
13 | @Override
14 | protected void onCreate(Bundle savedInstanceState) {
15 | super.onCreate(savedInstanceState);
16 | injectDependencies();
17 | // injectViews(); //TODO no funciona en BaseActivity
18 | }
19 |
20 | private void injectDependencies() {
21 | SubjectsApplication application = (SubjectsApplication)getApplication();
22 | application.inject(this);
23 | }
24 |
25 | private void injectViews(){
26 | ButterKnife.inject(this);
27 | }
28 | }
29 |
--------------------------------------------------------------------------------
/app/src/main/java/com/tonilopezmr/sample/di/BasePresenter.java:
--------------------------------------------------------------------------------
1 | package com.tonilopezmr.sample.di;
2 |
3 | import android.content.Context;
4 |
5 | /**
6 | * @author toni.
7 | */
8 | public class BasePresenter {
9 |
10 | public BasePresenter(Context context) {
11 | ((SubjectsApplication)context.getApplicationContext()).inject(this);
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/app/src/main/java/com/tonilopezmr/sample/di/SubjectsApplication.java:
--------------------------------------------------------------------------------
1 | package com.tonilopezmr.sample.di;
2 |
3 | import android.app.Application;
4 |
5 | import com.tonilopezmr.sample.di.modules.RootModule;
6 |
7 | import java.util.List;
8 |
9 | import dagger.ObjectGraph;
10 |
11 | /**
12 | * @author toni.
13 | */
14 | public class SubjectsApplication extends Application{
15 |
16 | private ObjectGraph objectGraph;
17 |
18 | @Override
19 | public void onCreate() {
20 | super.onCreate();
21 | initializeDependencyInjector();
22 | }
23 |
24 | private void initializeDependencyInjector() {
25 | objectGraph = ObjectGraph.create(new RootModule(this));
26 | objectGraph.inject(this);
27 | }
28 |
29 | public void inject(Object object){
30 | objectGraph.inject(object);
31 | }
32 |
33 |
34 | public ObjectGraph plus(List