Skip to content

Commit ee3d5ef

Browse files
JoseAlcerrecaJoseAlcerreca
committed
Merge branch 'todo-mvp' into todo-mvp-dagger
2 parents e297f5a + d1032e1 commit ee3d5ef

File tree

9 files changed

+354
-14
lines changed

9 files changed

+354
-14
lines changed

‎LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
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 2014 The Android Open Source Project
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.

‎README.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# TODO-MVP
2+
3+
### Summary
4+
5+
This sample is the base for many of the variants. It showcases a simple
6+
implementation of the Model-View-Presenter pattern with no architectural
7+
frameworks. It uses manual dependency injection to provide a repository with
8+
local and remote data sources. Asynchronous tasks are handled with callbacks.
9+
10+
<img src="https://github.com/googlesamples/android-architecture/wiki/images/mvp.png" alt="Diagram"/>
11+
12+
Note: in a MVP context, the term "view" is overloaded:
13+
14+
* The class android.view.View will be referred to as "Android View"
15+
* The view that receives commands from a presenter in MVP, will be simply called
16+
"view".
17+
18+
### Fragments
19+
20+
It uses fragments for two reasons:
21+
22+
* The separation between Activity and Fragment fits nicely with this
23+
implementation of MVP: the Activity is the overall controller that creates and
24+
connects views and presenters.
25+
* Tablet layout or screens with multiple views take advantage of the Fragments
26+
framework.
27+
28+
### Key concepts
29+
30+
There are four features in the app:
31+
32+
* <code>Tasks</code>
33+
* <code>TaskDetail</code>
34+
* <code>AddEditTask</code>
35+
* <code>Statistics</code>
36+
37+
Each feature has:
38+
39+
* A contract defining the view and the presenter
40+
* An Activity which is responsible for the creation of fragments and presenters
41+
* A Fragment which implements the view interface.
42+
* A presenter which implements the presenter interface
43+
44+
In general, the business logic lives in the presenter and relies on the view to
45+
do the Android UI work.
46+
47+
The view contains almost no logic: it converts the presenter's commands to UI
48+
actions and listens to user actions, which are passed to the presenter.
49+
50+
Contracts are interfaces used to define the connection between views and
51+
presenters.
52+
53+
### Dependencies
54+
55+
* Common Android support libraries (<code>com.android.support.\*)</code>
56+
* Android Testing Support Library (Espresso, AndroidJUnitRunner…)
57+
* Mockito
58+
* Guava (null checking)
59+
60+
## Features
61+
62+
### Complexity - understandability
63+
64+
#### Use of architectural frameworks/libraries/tools:
65+
66+
None
67+
68+
#### Conceptual complexity
69+
70+
Low, as it's a pure MVP implementation for Android
71+
72+
### Testability
73+
74+
#### Unit testing
75+
76+
High, presenters are unit tested as well as repositories and data sources.
77+
78+
#### UI testing
79+
80+
High, injection of fake modules allow for testing with fake data
81+
82+
### Code metrics
83+
84+
Compared to a traditional project with no architecture in place, this sample
85+
introduces additional classes and interfaces: presenters, a repository,
86+
contracts, etc. So lines of code and number of classes are higher in MVP.
87+
88+
89+
```
90+
-------------------------------------------------------------------------------
91+
Language files blank comment code
92+
-------------------------------------------------------------------------------
93+
Java 46 1075 1451 3451
94+
XML 34 97 337 601
95+
-------------------------------------------------------------------------------
96+
SUM: 80 1172 1788 4052
97+
-------------------------------------------------------------------------------
98+
```
99+
### Maintainability
100+
101+
#### Ease of amending or adding a feature
102+
103+
High.
104+
105+
#### Learning cost
106+
107+
Low. Features are easy to find and the responsibilities are clear. Developers
108+
don't need to be familiar with any external dependency to work on the project.
109+

‎todoapp/app/build.gradle

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,16 @@ android {
1919
debug {
2020
// Run code coverage reports by default on debug builds.
2121
// testCoverageEnabled = true
22+
minifyEnabled true
23+
// Uses new built-in shrinker http://tools.android.com/tech-docs/new-build-system/built-in-shrinker+
24+
useProguard false
25+
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
26+
}
27+
28+
release {
29+
minifyEnabled true
30+
useProguard true
31+
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
2232
}
2333
}
2434

@@ -59,8 +69,8 @@ dependencies {
5969
compile "com.android.support:design:$rootProject.supportLibraryVersion"
6070
compile "com.android.support:recyclerview-v7:$rootProject.supportLibraryVersion"
6171
compile "com.android.support:support-v4:$rootProject.supportLibraryVersion"
62-
compile "com.google.guava:guava:$rootProject.guavaVersion"
6372
compile "com.android.support.test.espresso:espresso-idling-resource:$rootProject.espressoVersion"
73+
compile "com.google.guava:guava:$rootProject.guavaVersion"
6474

6575
// Dagger dependencies
6676
apt "com.google.dagger:dagger-compiler:$rootProject.daggerVersion"

‎todoapp/app/proguard-rules.pro

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# For Guava:
2+
-dontwarn javax.annotation.**
3+
-dontwarn javax.inject.**
4+
-dontwarn sun.misc.Unsafe

‎todoapp/app/src/main/res/layout/statistics_act.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
android:id="@+id/drawer_layout"
2121
android:layout_width="match_parent"
2222
android:layout_height="match_parent"
23-
tools:context=".TasksActivity"
23+
tools:context=".tasks.TasksActivity"
2424
tools:openDrawer="start">
2525

2626
<LinearLayout

‎todoapp/app/src/main/res/layout/taskdetail_act.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
android:layout_width="match_parent"
2121
android:layout_height="match_parent"
2222
android:orientation="vertical"
23-
tools:context=".TaskDetailActivity">
23+
tools:context=".taskdetail.TaskDetailActivity">
2424

2525
<android.support.design.widget.AppBarLayout
2626
android:layout_width="match_parent"

‎todoapp/app/src/main/res/layout/tasks_act.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
android:id="@+id/drawer_layout"
2121
android:layout_width="match_parent"
2222
android:layout_height="match_parent"
23-
tools:context=".TasksActivity"
23+
tools:context=".tasks.TasksActivity"
2424
tools:openDrawer="start">
2525

2626
<LinearLayout

0 commit comments

Comments
 (0)