11 |
12 |
--------------------------------------------------------------------------------
/.idea/vcs.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work searchResults from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a searchRecord of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Android Architecute Sample Copyright (C) 2018 Miguel Beltran Febrer
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | **NOTICE**
2 |
3 | This project has been archived due to the lack of activity.
4 |
5 | Feel free to fork and do any changes or continue supporting it by yourself, but please keep the license and copyright notices.
6 |
7 | Miguel, author of the project.
8 |
9 | ---
10 |
11 | # Android Architecture Sample
12 |
13 | Sample Android App to access Discogs API.
14 |
15 | This app performs basic REST call to obtain a public list of records from Discogs API,
16 | with the idea to test and showcase some Android architecture and coding
17 | patterns.
18 |
19 | ## Code Features
20 |
21 | - Kotlin.
22 | - Coroutines.
23 | - Dependency injection with Koin.
24 | - Retrofit + Moshi.
25 | - Architecture Components.
26 | - Modularization.
27 | - Unit Testing.
28 | - Instrumentation Testing with Espresso.
29 |
30 | ## App Modules
31 |
32 | ```
33 | - app (App and MainActivity; Android)
34 | - api (Retrofit Service; Kotlin)
35 | - common-domain (Kotlin)
36 | - collection
37 | | - collection-ui (Fragment and ViewModel; Android)
38 | | - collection-data (Use case; Kotlin)
39 | ```
40 |
41 | 
42 |
43 | ## Cool Examples
44 |
45 | #### Dependency Injection with Koin
46 |
47 | https://github.com/miquelbeltran/android-discogsbrowser/blob/master/app/src/main/java/work/beltran/discogsbrowser/App.kt#L11
48 | ```kotlin
49 | startKoin(this, listOf(
50 | collectionKoinModule
51 | ))
52 | ```
53 | https://github.com/miquelbeltran/android-discogsbrowser/blob/master/collection/collection-ui/src/main/java/work/beltran/discogsbrowser/collection/CollectionFragment.kt#L20
54 | ```kotlin
55 | private val viewModel: CollectionViewModel by viewModel()
56 | ```
57 |
58 | #### Retrofit with Coroutines
59 |
60 | https://github.com/miquelbeltran/android-discogsbrowser/blob/master/api/src/main/java/work/beltran/discogsbrowser/api/DiscogsService.kt#L22
61 |
62 | ```kotlin
63 | @GET("users/{username}/collection/folders/{folder_id}/releases")
64 | fun getCollectionItemsByFolder(
65 | @Path("username") username: String,
66 | @Path("folder_id") folderId: String,
67 | @Query("page") page: Int,
68 | @Query("per_page") perPage: Int
69 | ) : Deferred>
70 | ```
71 |
72 | #### Use Case Implementation with Coroutines and Arrow
73 |
74 | https://github.com/miquelbeltran/android-discogsbrowser/blob/master/collection/collection-data/src/main/java/work/beltran/discogsbrowser/collection/data/GetCollectionUseCase.kt#L17
75 |
76 | ```kotlin
77 | private suspend fun requestItems(
78 | folder: String,
79 | page: Int
80 | ): Response {
81 | return discogsService.getCollectionItemsByFolder(
82 | username = "mike513",
83 | folderId = folder,
84 | page = page,
85 | perPage = PAGE_SIZE
86 | ).await()
87 | }
88 | ```
89 |
90 | #### Use Case Unit Test using Mockk and Coroutines
91 |
92 | https://github.com/miquelbeltran/android-discogsbrowser/blob/master/collection/collection-data/src/test/kotlin/work/beltran/discogsbrowser/collection/data/GetCollectionUseCaseImplTest.kt
93 |
94 | ```kotlin
95 | every {
96 | service.getCollectionItemsByFolder(
97 | username = "mike513",
98 | folderId = "0",
99 | page = 1,
100 | perPage = 20
101 | )
102 | } returns CompletableDeferred(
103 | Response.success(
104 | collectionItemsByFolderResponse
105 | )
106 | )
107 | ```
108 |
109 | #### ViewModel and LiveData with Coroutines (Kotlin 1.3)
110 |
111 | https://github.com/miquelbeltran/android-discogsbrowser/blob/master/collection/collection-ui/src/main/java/work/beltran/discogsbrowser/collection/CollectionViewModel.kt
112 |
113 | ```kotlin
114 | loadingJob = launch(dispatcher) {
115 | val result = collectionUseCase.getCollectionPage("0", page)
116 | when (result) {
117 | is Either.Left -> Log.e("CollectionViewModel", result.a)
118 | is Either.Right -> {
119 | pages[page] = result.b.data
120 | nextPage = result.b.nextPage
121 | }
122 | }
123 | updateCollectionScreenState()
124 | }
125 | ```
126 |
127 | #### ViewModel Unit Test
128 |
129 | https://github.com/miquelbeltran/android-discogsbrowser/blob/master/collection/collection-ui/src/test/java/work/beltran/discogsbrowser/collection/CollectionViewModelTest.kt
130 |
131 | ```kotlin
132 | val viewModel = CollectionViewModel(
133 | collectionUseCase = useCase,
134 | dispatcher = Dispatchers.Unconfined
135 | )
136 |
137 | val data = viewModel.liveData.value!!
138 | assertEquals(1, data.size)
139 |
140 | val item = data[0] as CollectionItem.AlbumItem
141 | assertEquals(album, item.album)
142 | ```
143 |
144 | #### Fragment Instrumentation Test with Espresso
145 |
146 | https://github.com/miquelbeltran/android-discogsbrowser/blob/master/collection/collection-ui/src/androidTest/java/work/beltran/discogsbrowser/collection/CollectionFragmentTest.kt
147 |
148 | ```kotlin
149 | @Test
150 | fun load_single_item_page() {
151 |
152 | // Mock the use case to return a single item
153 | val collectionUseCase = mockUseCaseForSingleItem()
154 |
155 | // Configure dependency injection to provide ViewModel with Use Case
156 | configureKoin(collectionUseCase)
157 |
158 | // Launch Fragment in a Test Activity
159 | launchFragment()
160 |
161 | // Assert Album title is displayed in the list
162 | onView(withText("title")).check(matches(isDisplayed()))
163 | }
164 | ```
165 |
166 | ## License
167 |
168 | Android Architecute Sample Copyright (C) 2018 Miguel Beltran Febrer
169 | This program comes with ABSOLUTELY NO WARRANTY.
170 | This is free software, and you are welcome to redistribute it
171 | under certain conditions.
172 |
--------------------------------------------------------------------------------
/api/.gitignore:
--------------------------------------------------------------------------------
1 | /build
2 |
--------------------------------------------------------------------------------
/api/build.gradle:
--------------------------------------------------------------------------------
1 | apply plugin: 'java-library'
2 | apply plugin: 'kotlin'
3 |
4 | dependencies {
5 | implementation fileTree(dir: 'libs', include: ['*.jar'])
6 | implementation Libs.kotlin
7 | implementation Libs.retrofit
8 | implementation Libs.converterMoshi
9 | implementation 'com.squareup.moshi:moshi-kotlin:1.7.0'
10 | implementation 'com.jakewharton.retrofit:retrofit2-kotlin-coroutines-adapter:0.9.2'
11 |
12 | }
13 |
14 | sourceCompatibility = "7"
15 | targetCompatibility = "7"
16 |
--------------------------------------------------------------------------------
/api/src/main/java/work/beltran/discogsbrowser/api/CLI.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser.api
2 |
3 | import kotlinx.coroutines.runBlocking
4 |
5 |
6 | fun main(args: Array) = runBlocking {
7 | val response = provideService().getCollectionItemsByFolder("mike513", "0",1, 2)
8 | print(response.await().body())
9 | }
10 |
11 |
--------------------------------------------------------------------------------
/api/src/main/java/work/beltran/discogsbrowser/api/CollectionItemsByFolderResponse.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser.api
2 |
3 | import com.squareup.moshi.Json
4 |
5 | data class CollectionItemsByFolderResponse(
6 | val pagination: Pagination,
7 | val releases: List
8 | )
9 |
10 | data class Release(
11 | val id: String,
12 | @Json(name = "basic_information") val basicInfo: BasicInfo
13 | )
14 |
15 | data class BasicInfo(
16 | val title: String,
17 | val thumb: String,
18 | val artists: List
19 | )
20 |
21 | data class Artist(
22 | val id: String,
23 | val name: String
24 | )
25 |
26 | data class Pagination(
27 | @Json(name = "per_page") val perPage: Int,
28 | val pages: Int,
29 | val page: Int,
30 | val items: Int
31 | )
32 |
--------------------------------------------------------------------------------
/api/src/main/java/work/beltran/discogsbrowser/api/DiscogsService.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser.api
2 |
3 | import com.jakewharton.retrofit2.adapter.kotlin.coroutines.CoroutineCallAdapterFactory
4 | import com.squareup.moshi.Moshi
5 | import com.squareup.moshi.kotlin.reflect.KotlinJsonAdapterFactory
6 | import kotlinx.coroutines.Deferred
7 | import retrofit2.Response
8 | import retrofit2.Retrofit
9 | import retrofit2.converter.moshi.MoshiConverterFactory
10 | import retrofit2.http.GET
11 | import retrofit2.http.Path
12 | import retrofit2.http.Query
13 |
14 | interface DiscogsService {
15 |
16 | @GET("users/{username}/collection/folders/{folder_id}/releases")
17 | fun getCollectionItemsByFolder(
18 | @Path("username") username: String,
19 | @Path("folder_id") folderId: String,
20 | @Query("page") page: Int,
21 | @Query("per_page") perPage: Int
22 | ) : Deferred>
23 | }
24 |
25 | fun provideService(): DiscogsService {
26 |
27 | val moshi = Moshi.Builder()
28 | .add(KotlinJsonAdapterFactory())
29 | .build()
30 |
31 | return Retrofit
32 | .Builder()
33 | .baseUrl("https://api.discogs.com")
34 | .addConverterFactory(MoshiConverterFactory.create(moshi))
35 | .addCallAdapterFactory(CoroutineCallAdapterFactory())
36 | .build()
37 | .create(DiscogsService::class.java)
38 | }
39 |
--------------------------------------------------------------------------------
/app/.gitignore:
--------------------------------------------------------------------------------
1 | /build
2 |
--------------------------------------------------------------------------------
/app/build.gradle:
--------------------------------------------------------------------------------
1 | apply plugin: 'com.android.application'
2 | apply plugin: 'kotlin-android'
3 | apply plugin: 'kotlin-android-extensions'
4 |
5 | android {
6 | compileSdkVersion 28
7 | defaultConfig {
8 | applicationId "work.beltran.discogsbrowser"
9 | minSdkVersion 23
10 | targetSdkVersion 28
11 | versionCode 1
12 | versionName "1.0"
13 | }
14 | buildTypes {
15 | release {
16 | minifyEnabled false
17 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
18 | }
19 | }
20 | }
21 |
22 | dependencies {
23 | implementation fileTree(dir: 'libs', include: ['*.jar'])
24 | implementation project(':common-domain')
25 | implementation project(':collection:collection-ui')
26 | implementation project(':collection:collection-data')
27 |
28 | implementation Libs.constraintLayout
29 | implementation Libs.koinAndroid
30 | implementation Libs.koinViewModel
31 | implementation Libs.kotlin
32 | implementation Libs.navigationFragment
33 | implementation Libs.navigationUi
34 | implementation Libs.supportAppcompatV7
35 | implementation Libs.supportV4
36 | }
37 |
--------------------------------------------------------------------------------
/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
22 |
--------------------------------------------------------------------------------
/app/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
6 |
7 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
--------------------------------------------------------------------------------
/app/src/main/java/work/beltran/discogsbrowser/App.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser
2 |
3 | import android.app.Application
4 | import org.koin.android.ext.android.startKoin
5 |
6 | class App: Application() {
7 |
8 | override fun onCreate() {
9 | super.onCreate()
10 |
11 | startKoin(this, listOf(
12 | collectionKoinModule
13 | ))
14 | }
15 |
16 | }
17 |
18 |
--------------------------------------------------------------------------------
/app/src/main/java/work/beltran/discogsbrowser/CollectionKoinModule.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser
2 |
3 | import org.koin.android.viewmodel.ext.koin.viewModel
4 | import org.koin.dsl.module.module
5 | import work.beltran.discogsbrowser.collection.CollectionViewModel
6 | import work.beltran.discogsbrowser.collection.data.provideGetCollectionUseCase
7 |
8 | val collectionKoinModule = module {
9 | single { provideGetCollectionUseCase() }
10 | viewModel { CollectionViewModel(get()) }
11 | }
12 |
--------------------------------------------------------------------------------
/app/src/main/java/work/beltran/discogsbrowser/MainActivity.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser
2 |
3 | import android.os.Bundle
4 | import androidx.appcompat.app.AppCompatActivity
5 | import org.koin.android.ext.android.startKoin
6 |
7 | class MainActivity : AppCompatActivity() {
8 |
9 | override fun onCreate(savedInstanceState: Bundle?) {
10 | super.onCreate(savedInstanceState)
11 | setContentView(R.layout.activity_main)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/app/src/main/res/drawable-v24/ic_launcher_foreground.xml:
--------------------------------------------------------------------------------
1 |
7 |
12 |
13 |
19 |
22 |
25 |
26 |
27 |
28 |
34 |
35 |
--------------------------------------------------------------------------------
/app/src/main/res/drawable/ic_launcher_background.xml:
--------------------------------------------------------------------------------
1 |
2 |
8 |
10 |
12 |
14 |
16 |
18 |
20 |
22 |
24 |
26 |
28 |
30 |
32 |
34 |
36 |
38 |
40 |
42 |
44 |
46 |
48 |
50 |
52 |
54 |
56 |
58 |
60 |
62 |
64 |
66 |
68 |
70 |
72 |
74 |
75 |
--------------------------------------------------------------------------------
/app/src/main/res/layout/activity_main.xml:
--------------------------------------------------------------------------------
1 |
2 |
9 |
10 |
18 |
19 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-hdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/miquelbeltran/android-architecture-sample/2691a4385a1d3d6ee9ad93eab28fed22f6ab5fbc/app/src/main/res/mipmap-hdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-hdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/miquelbeltran/android-architecture-sample/2691a4385a1d3d6ee9ad93eab28fed22f6ab5fbc/app/src/main/res/mipmap-hdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-mdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/miquelbeltran/android-architecture-sample/2691a4385a1d3d6ee9ad93eab28fed22f6ab5fbc/app/src/main/res/mipmap-mdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-mdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/miquelbeltran/android-architecture-sample/2691a4385a1d3d6ee9ad93eab28fed22f6ab5fbc/app/src/main/res/mipmap-mdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/miquelbeltran/android-architecture-sample/2691a4385a1d3d6ee9ad93eab28fed22f6ab5fbc/app/src/main/res/mipmap-xhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/miquelbeltran/android-architecture-sample/2691a4385a1d3d6ee9ad93eab28fed22f6ab5fbc/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/miquelbeltran/android-architecture-sample/2691a4385a1d3d6ee9ad93eab28fed22f6ab5fbc/app/src/main/res/mipmap-xxhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/miquelbeltran/android-architecture-sample/2691a4385a1d3d6ee9ad93eab28fed22f6ab5fbc/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/miquelbeltran/android-architecture-sample/2691a4385a1d3d6ee9ad93eab28fed22f6ab5fbc/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/miquelbeltran/android-architecture-sample/2691a4385a1d3d6ee9ad93eab28fed22f6ab5fbc/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/navigation/nav_graph.xml:
--------------------------------------------------------------------------------
1 |
2 |
6 |
7 |
11 |
--------------------------------------------------------------------------------
/app/src/main/res/values/colors.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | #008577
4 | #00574B
5 | #D81B60
6 |
7 |
--------------------------------------------------------------------------------
/app/src/main/res/values/strings.xml:
--------------------------------------------------------------------------------
1 |
2 | Discogs Browser
3 |
4 |
5 | Hello blank fragment
6 |
7 |
--------------------------------------------------------------------------------
/app/src/main/res/values/styles.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/build.gradle:
--------------------------------------------------------------------------------
1 | // Top-level build file where you can add configuration options common to all sub-projects/modules.
2 |
3 | buildscript {
4 | ext.kotlin_version = '1.3.0'
5 | repositories {
6 | google()
7 | jcenter()
8 | }
9 | dependencies {
10 | classpath 'com.android.tools.build:gradle:3.2.1'
11 | classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
12 |
13 | // NOTE: Do not place your application dependencies here; they belong
14 | // in the individual module build.gradle files
15 | }
16 | }
17 |
18 | allprojects {
19 | repositories {
20 | google()
21 | jcenter()
22 | }
23 | }
24 |
25 | task clean(type: Delete) {
26 | delete rootProject.buildDir
27 | }
28 |
29 | apply from: file('gradle/projectDependencyGraph.gradle')
--------------------------------------------------------------------------------
/buildSrc/build.gradle.kts:
--------------------------------------------------------------------------------
1 | plugins {
2 | `kotlin-dsl`
3 | }
--------------------------------------------------------------------------------
/buildSrc/src/main/kotlin/Dependencies.kt:
--------------------------------------------------------------------------------
1 | @file:Suppress("unused", "MayBeConstant")
2 |
3 | object Versions {
4 | val appCompat = "1.0.0-alpha1"
5 | val arrow = "0.7.3"
6 | val constraint = "1.1.3"
7 | val coreTesting = "1.1.1"
8 | val coroutines = "1.0.1"
9 | val koin = "1.0.1"
10 | val kotlin = "1.3.0"
11 | val mockk = "1.8.13.kotlin13"
12 | val navigation = "1.0.0-alpha06"
13 | val paging = "1.0.0"
14 | val retrofit = "2.4.0"
15 | val supportLib = "28.0.0"
16 | val testEspresso = "3.0.2"
17 | val testRunner = "1.0.2"
18 | val fragmentTestRule = "1.1.0"
19 | }
20 |
21 | object Libs {
22 | val appCompat = "androidx.appcompat:appcompat:${Versions.appCompat}"
23 | val arrow = "io.arrow-kt:arrow-data:${Versions.arrow}"
24 | val constraintLayout = "com.android.support.constraint:constraint-layout:${Versions.constraint}"
25 | val converterMoshi = "com.squareup.retrofit2:converter-moshi:${Versions.retrofit}"
26 | val coreTesting = "android.arch.core:core-testing:${Versions.coreTesting}"
27 | val coroutines = "org.jetbrains.kotlinx:kotlinx-coroutines-core:${Versions.coroutines}"
28 | val corroutinesAndroid = "org.jetbrains.kotlinx:kotlinx-coroutines-android:${Versions.coroutines}"
29 | val junit = "junit:junit:4.12"
30 | val koinAndroid = "org.koin:koin-android:${Versions.koin}"
31 | val koinViewModel = "org.koin:koin-android-viewmodel:${Versions.koin}"
32 | val kotlin = "org.jetbrains.kotlin:kotlin-stdlib-jdk7:${Versions.kotlin}"
33 | val mockk = "io.mockk:mockk:${Versions.mockk}"
34 | val navigationFragment = "android.arch.navigation:navigation-fragment-ktx:${Versions.navigation}"
35 | val navigationUi = "android.arch.navigation:navigation-ui:${Versions.navigation}"
36 | val paging = "android.arch.paging:runtime:${Versions.paging}"
37 | val recycler = "com.android.support:recyclerview-v7:${Versions.supportLib}"
38 | val retrofit = "com.squareup.retrofit2:retrofit:${Versions.retrofit}"
39 | val supportAppcompatV7 = "com.android.support:appcompat-v7:${Versions.supportLib}"
40 | val supportV4 = "com.android.support:support-v4:${Versions.supportLib}"
41 | val testEspresso = "com.android.support.test.espresso:espresso-core:${Versions.testEspresso}"
42 | val testRunner = "com.android.support.test:runner:${Versions.testRunner}"
43 | val mockkAndroid = "io.mockk:mockk-android:${Versions.mockk}"
44 | val testRules = "com.android.support.test:rules:${Versions.testRunner}"
45 | val fragmentTestRule = "com.21buttons:fragment-test-rule:${Versions.fragmentTestRule}"
46 | val fragmentTestRuleExtras = "com.21buttons:fragment-test-rule-extras:${Versions.fragmentTestRule}"
47 | }
--------------------------------------------------------------------------------
/collection/collection-data/.gitignore:
--------------------------------------------------------------------------------
1 | /build
2 |
--------------------------------------------------------------------------------
/collection/collection-data/build.gradle:
--------------------------------------------------------------------------------
1 | apply plugin: 'java-library'
2 | apply plugin: 'kotlin'
3 |
4 | dependencies {
5 | implementation fileTree(dir: 'libs', include: ['*.jar'])
6 | implementation project(':api')
7 | implementation project(':common-domain')
8 | implementation Libs.arrow
9 | implementation Libs.coroutines
10 | implementation Libs.kotlin
11 | implementation Libs.retrofit
12 |
13 | testImplementation Libs.junit
14 | testImplementation Libs.mockk
15 | }
16 |
17 | sourceCompatibility = "7"
18 | targetCompatibility = "7"
19 |
--------------------------------------------------------------------------------
/collection/collection-data/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
22 |
--------------------------------------------------------------------------------
/collection/collection-data/src/main/java/work/beltran/discogsbrowser/collection/data/GetCollectionUseCase.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser.collection.data
2 |
3 | import arrow.core.Either
4 | import arrow.core.Try
5 | import retrofit2.Response
6 | import work.beltran.discogsbrowser.api.CollectionItemsByFolderResponse
7 | import work.beltran.discogsbrowser.api.DiscogsService
8 | import work.beltran.discogsbrowser.api.provideService
9 | import work.beltran.discogsbrowser.common.domain.Album
10 | import work.beltran.discogsbrowser.common.domain.GetCollectionUseCase
11 | import work.beltran.discogsbrowser.common.domain.Pagination
12 |
13 | fun provideGetCollectionUseCase(): GetCollectionUseCase {
14 | return GetCollectionUseCaseImpl(provideService())
15 | }
16 |
17 | class GetCollectionUseCaseImpl(
18 | private val discogsService: DiscogsService
19 | ) : GetCollectionUseCase {
20 |
21 | override suspend fun getCollectionPage(
22 | folder: String,
23 | page: Int
24 | ): Either>> {
25 |
26 | return Try {
27 | requestItems(folder, page)
28 | }.fold({
29 | // e.g. Networking errors
30 | processException(it)
31 | }, { result ->
32 | // Results from service
33 | processResult(result, page)
34 | })
35 | }
36 |
37 | private suspend fun requestItems(
38 | folder: String,
39 | page: Int
40 | ): Response {
41 | return discogsService.getCollectionItemsByFolder(
42 | username = "mike513",
43 | folderId = folder,
44 | page = page,
45 | perPage = PAGE_SIZE
46 | ).await()
47 | }
48 |
49 | private fun processException(it: Throwable) = Either.left(it.localizedMessage)
50 |
51 | private fun processResult(
52 | result: Response,
53 | page: Int
54 | ): Either>> {
55 | val body = result.body()
56 | return if (result.isSuccessful && body != null) {
57 | val albums = body.releases.toAlbums()
58 | val pagination = body.pagination
59 | val nextPage = pagination.getNextPage()
60 | Either.right(Pagination(albums, page, nextPage, pagination.items))
61 | } else {
62 | // Errors from service (e.g. too many requests)
63 | Either.left(result.errorBody()?.string() ?: "Unknown Error")
64 | }
65 | }
66 |
67 | private fun work.beltran.discogsbrowser.api.Pagination.getNextPage(): Int? =
68 | if (page < pages) {
69 | page + 1
70 | } else {
71 | null
72 | }
73 |
74 | companion object {
75 | private const val PAGE_SIZE = 20
76 | }
77 | }
78 |
79 |
--------------------------------------------------------------------------------
/collection/collection-data/src/main/java/work/beltran/discogsbrowser/collection/data/ReleaseMapper.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser.collection.data
2 |
3 | import arrow.data.NonEmptyList
4 | import work.beltran.discogsbrowser.api.Release
5 | import work.beltran.discogsbrowser.common.domain.Album
6 | import work.beltran.discogsbrowser.common.domain.Artist
7 |
8 | fun List.toAlbums(): List {
9 | return map {release ->
10 | Album(
11 | id = release.id,
12 | title = release.basicInfo.title,
13 | thumb = release.basicInfo.thumb,
14 | artist = release.basicInfo.artists.toDomain()
15 | )
16 | }
17 | }
18 |
19 | typealias ArtistApi = work.beltran.discogsbrowser.api.Artist
20 |
21 | fun List.toDomain(): NonEmptyList {
22 | return NonEmptyList.fromListUnsafe(map { artist ->
23 | Artist(
24 | id = artist.id,
25 | name = artist.name
26 | )
27 | })
28 | }
29 |
30 |
--------------------------------------------------------------------------------
/collection/collection-data/src/test/kotlin/work/beltran/discogsbrowser/collection/data/GetCollectionUseCaseImplTest.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser.collection.data
2 |
3 |
4 | import arrow.core.orNull
5 | import io.mockk.every
6 | import io.mockk.mockk
7 | import kotlinx.coroutines.CompletableDeferred
8 | import kotlinx.coroutines.runBlocking
9 | import org.junit.Test
10 | import retrofit2.Response
11 | import work.beltran.discogsbrowser.api.*
12 |
13 | class GetCollectionUseCaseImplTest {
14 |
15 | @Test
16 | fun `get a collection page`() {
17 | runBlocking {
18 | val service = mockk()
19 | val element = Release(
20 | id = "id",
21 | basicInfo = BasicInfo(
22 | title = "title",
23 | thumb = "thumb",
24 | artists = listOf(
25 | ArtistApi(
26 | id = "id",
27 | name = "name"
28 | )
29 | )
30 | )
31 | )
32 | val collectionItemsByFolderResponse = CollectionItemsByFolderResponse(
33 | pagination = Pagination(
34 | perPage = 20,
35 | pages = 1,
36 | page = 1,
37 | items = 1
38 | ),
39 | releases = listOf(
40 | element
41 | )
42 | )
43 |
44 | every {
45 | service.getCollectionItemsByFolder(
46 | username = "mike513",
47 | folderId = "0",
48 | page = 1,
49 | perPage = 20
50 | )
51 | } returns CompletableDeferred(
52 | Response.success(
53 | collectionItemsByFolderResponse
54 | )
55 | )
56 |
57 | val usecase = GetCollectionUseCaseImpl(service)
58 | val result = usecase.getCollectionPage("0", 1)
59 | val pagination = result.orNull()!!
60 |
61 | assert(pagination.currentPage == 1)
62 | assert(pagination.nextPage == null)
63 | assert(pagination.totalItems == 1)
64 | assert(pagination.data[0].id == "id")
65 | assert(pagination.data[0].title == "title")
66 | assert(pagination.data[0].thumb == "thumb")
67 | assert(pagination.data[0].artist.head.name == "name")
68 | }
69 | }
70 |
71 | }
--------------------------------------------------------------------------------
/collection/collection-ui/.gitignore:
--------------------------------------------------------------------------------
1 | /build
2 |
--------------------------------------------------------------------------------
/collection/collection-ui/build.gradle:
--------------------------------------------------------------------------------
1 | apply plugin: 'com.android.library'
2 | apply plugin: 'kotlin-android'
3 | apply plugin: 'kotlin-android-extensions'
4 |
5 | android {
6 | compileSdkVersion 28
7 |
8 | defaultConfig {
9 | minSdkVersion 23
10 | targetSdkVersion 28
11 | versionCode 1
12 | versionName "1.0"
13 |
14 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
15 |
16 | }
17 |
18 | testOptions {
19 | unitTests.returnDefaultValues = true
20 | }
21 |
22 | buildTypes {
23 | release {
24 | minifyEnabled false
25 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
26 | }
27 | }
28 | }
29 |
30 | androidExtensions {
31 | experimental = true
32 | }
33 |
34 | dependencies {
35 | implementation fileTree(dir: 'libs', include: ['*.jar'])
36 | implementation project(':common-domain')
37 | implementation Libs.constraintLayout
38 | implementation Libs.koinAndroid
39 | implementation Libs.koinViewModel
40 | implementation Libs.kotlin
41 | implementation Libs.paging
42 | implementation Libs.recycler
43 | implementation Libs.retrofit
44 | implementation Libs.supportAppcompatV7
45 | implementation Libs.supportV4
46 | implementation Libs.arrow
47 | implementation Libs.coroutines
48 | implementation Libs.corroutinesAndroid
49 |
50 | testImplementation Libs.coreTesting
51 | testImplementation Libs.junit
52 | testImplementation Libs.mockk
53 |
54 | androidTestImplementation Libs.fragmentTestRule
55 | androidTestImplementation Libs.mockk
56 | androidTestImplementation Libs.mockkAndroid
57 | androidTestImplementation Libs.testEspresso
58 | androidTestImplementation Libs.testRunner
59 | androidTestImplementation Libs.testRunner
60 |
61 | debugImplementation Libs.fragmentTestRuleExtras
62 | }
63 |
--------------------------------------------------------------------------------
/collection/collection-ui/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
22 |
--------------------------------------------------------------------------------
/collection/collection-ui/src/androidTest/java/work/beltran/discogsbrowser/collection/CollectionFragmentTest.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser.collection
2 |
3 | import androidx.test.espresso.Espresso.onView
4 | import androidx.test.espresso.assertion.ViewAssertions.matches
5 | import androidx.test.espresso.matcher.ViewMatchers.isDisplayed
6 | import androidx.test.espresso.matcher.ViewMatchers.withText
7 | import androidx.test.runner.AndroidJUnit4
8 | import arrow.core.Either
9 | import arrow.data.NonEmptyList
10 | import com.android21buttons.fragmenttestrule.FragmentTestRule
11 | import io.mockk.every
12 | import io.mockk.mockk
13 | import kotlinx.coroutines.runBlocking
14 | import org.junit.Rule
15 | import org.junit.Test
16 | import org.junit.runner.RunWith
17 | import org.koin.android.viewmodel.ext.koin.viewModel
18 | import org.koin.dsl.module.module
19 | import org.koin.standalone.StandAloneContext.startKoin
20 | import work.beltran.discogsbrowser.common.domain.Album
21 | import work.beltran.discogsbrowser.common.domain.Artist
22 | import work.beltran.discogsbrowser.common.domain.GetCollectionUseCase
23 | import work.beltran.discogsbrowser.common.domain.Pagination
24 |
25 |
26 | @RunWith(AndroidJUnit4::class)
27 | class CollectionFragmentTest {
28 |
29 | @get:Rule
30 | val fragmentTestRule = FragmentTestRule.create(CollectionFragment::class.java, true, false)
31 |
32 | @Test
33 | fun load_single_item_page() {
34 |
35 | // Mock the use case to return a single item
36 | val collectionUseCase = mockUseCaseForSingleItem()
37 |
38 | // Configure dependency injection to provide ViewModel with Use Case
39 | configureKoin(collectionUseCase)
40 |
41 | // Launch Fragment in a Test Activity
42 | launchFragment()
43 |
44 | // Assert Album title is displayed in the list
45 | onView(withText("title")).check(matches(isDisplayed()))
46 | }
47 |
48 | private fun launchFragment() {
49 | val fragment = CollectionFragment()
50 | fragmentTestRule.launchFragment(fragment)
51 | }
52 |
53 | private fun configureKoin(collectionUseCase: GetCollectionUseCase) {
54 | val collectionKoinModule = module {
55 | viewModel { CollectionViewModel(collectionUseCase) }
56 | }
57 | startKoin(listOf(collectionKoinModule))
58 | }
59 |
60 | private fun mockUseCaseForSingleItem(): GetCollectionUseCase {
61 | val collectionUseCase = mockk()
62 | val album = Album(
63 | id = "id",
64 | title = "title",
65 | thumb = "thumb",
66 | artist = NonEmptyList.just(Artist(id = "id", name = "name"))
67 | )
68 | every {
69 | runBlocking {
70 | collectionUseCase.getCollectionPage("0", 1)
71 | }
72 | } returns Either.right(
73 | Pagination(
74 | data = listOf(
75 | album
76 | ),
77 | currentPage = 1,
78 | nextPage = null,
79 | totalItems = 1
80 | )
81 | )
82 | return collectionUseCase
83 | }
84 |
85 |
86 | }
87 |
--------------------------------------------------------------------------------
/collection/collection-ui/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
3 |
--------------------------------------------------------------------------------
/collection/collection-ui/src/main/java/work/beltran/discogsbrowser/collection/CollectionFragment.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser.collection
2 |
3 | import android.os.Bundle
4 | import android.view.LayoutInflater
5 | import android.view.View
6 | import android.view.ViewGroup
7 | import androidx.fragment.app.Fragment
8 | import androidx.lifecycle.Observer
9 | import androidx.recyclerview.widget.LinearLayoutManager
10 | import androidx.recyclerview.widget.RecyclerView
11 | import kotlinx.android.synthetic.main.fragment_collection.view.*
12 | import org.koin.android.viewmodel.ext.android.viewModel
13 | import org.koin.core.parameter.ParameterDefinition
14 | import org.koin.core.parameter.ParameterList
15 | import org.koin.core.parameter.parametersOf
16 | import work.beltran.discogsbrowser.collection.adapter.CollectionAdapter
17 | import work.beltran.discogsbrowser.collection.adapter.CollectionItem
18 |
19 | private const val THRESHOLD = 5
20 |
21 | class CollectionFragment : Fragment() {
22 |
23 | private val viewModel: CollectionViewModel by viewModel()
24 |
25 | override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
26 | val view = inflater.inflate(R.layout.fragment_collection, container, false)
27 | val adapter = CollectionAdapter()
28 | configureRecyclerView(view, adapter)
29 | viewModel.liveData.observe(viewLifecycleOwner, Observer> {
30 | adapter.submitList(it)
31 | })
32 | return view
33 | }
34 |
35 | private fun configureRecyclerView(
36 | view: View,
37 | adapter: CollectionAdapter
38 | ) {
39 | view.recycler.adapter = adapter
40 | val linearLayoutManager = LinearLayoutManager(view.context)
41 | view.recycler.layoutManager = linearLayoutManager
42 | createScrollListener(view, linearLayoutManager)
43 | }
44 |
45 | private fun createScrollListener(
46 | view: View,
47 | linearLayoutManager: LinearLayoutManager
48 | ) {
49 | view.recycler.addOnScrollListener(object : RecyclerView.OnScrollListener() {
50 | override fun onScrolled(recyclerView: RecyclerView, dx: Int, dy: Int) {
51 | super.onScrolled(recyclerView, dx, dy)
52 | val totalItemCount = linearLayoutManager.itemCount
53 | val lastVisibleItem = linearLayoutManager.findLastVisibleItemPosition()
54 | if (totalItemCount <= lastVisibleItem + THRESHOLD) {
55 | viewModel.loadMore()
56 | }
57 | }
58 | })
59 | }
60 | }
61 |
--------------------------------------------------------------------------------
/collection/collection-ui/src/main/java/work/beltran/discogsbrowser/collection/CollectionViewHolder.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser.collection
2 |
3 | import android.view.View
4 | import androidx.recyclerview.widget.RecyclerView
5 | import work.beltran.discogsbrowser.collection.adapter.CollectionItem
6 |
7 | abstract class CollectionViewHolder(itemView: View): RecyclerView.ViewHolder(itemView) {
8 | abstract fun bind(item: CollectionItem)
9 | }
--------------------------------------------------------------------------------
/collection/collection-ui/src/main/java/work/beltran/discogsbrowser/collection/CollectionViewModel.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser.collection
2 |
3 | import android.util.Log
4 | import androidx.lifecycle.MutableLiveData
5 | import androidx.lifecycle.ViewModel
6 | import arrow.core.Either
7 | import kotlinx.coroutines.*
8 | import work.beltran.discogsbrowser.collection.adapter.CollectionItem
9 | import work.beltran.discogsbrowser.common.domain.Album
10 | import work.beltran.discogsbrowser.common.domain.GetCollectionUseCase
11 | import kotlin.coroutines.CoroutineContext
12 |
13 | class CollectionViewModel(
14 | private val collectionUseCase: GetCollectionUseCase,
15 | private val dispatcher: CoroutineDispatcher = Dispatchers.IO
16 | ) : ViewModel(), CoroutineScope {
17 |
18 | private val contextJob = Job()
19 | private var loadingJob: Job? = null
20 | private var nextPage: Int? = null
21 | // Store the different network pages in a map
22 | private val pages = HashMap>()
23 |
24 | override val coroutineContext: CoroutineContext
25 | get() = Dispatchers.Main + contextJob
26 |
27 | // Represents the data to be displayed in the RecyclerView
28 | val liveData = MutableLiveData>()
29 |
30 | init {
31 | launchGetCollectionPage(1)
32 | }
33 |
34 | private fun launchGetCollectionPage(
35 | page: Int
36 | ) {
37 | loadingJob = launch(dispatcher) {
38 |
39 | Log.d("CollectionViewModel", "Loading page: $page")
40 | updateCollectionScreenState(loading = true)
41 |
42 | val result = collectionUseCase.getCollectionPage("0", page)
43 | when (result) {
44 | // TODO Show loading errors on UI
45 | is Either.Left -> Log.e("CollectionViewModel", result.a)
46 | is Either.Right -> {
47 | // Update page in the pages map
48 | pages[page] = result.b.data
49 | // Update nextPage, it can be null
50 | // this means we are at the final page
51 | nextPage = result.b.nextPage
52 | }
53 | }
54 |
55 | Log.d("CollectionViewModel", "Loaded! page: $page")
56 | updateCollectionScreenState(loading = false)
57 | }
58 | }
59 |
60 | private fun updateCollectionScreenState(loading: Boolean) {
61 | val albums = pages.flatMap { it.value }.map { CollectionItem.AlbumItem(it) as CollectionItem }
62 | val list = if (loading) {
63 | albums + CollectionItem.LoadingItem
64 | } else {
65 | albums
66 | }
67 | liveData.postValue(list)
68 | }
69 |
70 | fun loadMore() {
71 | // current loading job is active, then do not load more
72 | if (loadingJob?.isActive == true) return
73 | // load if next page is not null
74 | nextPage?.let { launchGetCollectionPage(it) }
75 | }
76 |
77 | override fun onCleared() {
78 | // Cancel any running job
79 | contextJob.cancel()
80 | }
81 | }
82 |
83 |
--------------------------------------------------------------------------------
/collection/collection-ui/src/main/java/work/beltran/discogsbrowser/collection/adapter/AlbumDiffCallback.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser.collection.adapter
2 |
3 | import androidx.recyclerview.widget.DiffUtil
4 |
5 | class AlbumDiffCallback(
6 | private val oldList: List,
7 | private val newList: List
8 | ) : DiffUtil.Callback() {
9 | override fun areItemsTheSame(oldItemPosition: Int, newItemPosition: Int): Boolean {
10 | val oldItem = oldList[oldItemPosition]
11 | val newItem = newList[newItemPosition]
12 | return when {
13 | oldItem is CollectionItem.LoadingItem && newItem is CollectionItem.LoadingItem -> true
14 | oldItem is CollectionItem.AlbumItem && newItem is CollectionItem.AlbumItem -> {
15 | oldItem.album.id == newItem.album.id
16 | }
17 | else -> false
18 | }
19 | }
20 |
21 | override fun getOldListSize(): Int {
22 | return oldList.size
23 | }
24 |
25 | override fun getNewListSize(): Int {
26 | return newList.size
27 | }
28 |
29 | override fun areContentsTheSame(oldItemPosition: Int, newItemPosition: Int): Boolean {
30 | return oldList[oldItemPosition] == newList[newItemPosition]
31 | }
32 | }
--------------------------------------------------------------------------------
/collection/collection-ui/src/main/java/work/beltran/discogsbrowser/collection/adapter/AlbumViewHolder.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser.collection.adapter
2 |
3 | import android.view.LayoutInflater
4 | import android.view.View
5 | import android.view.ViewGroup
6 | import kotlinx.android.extensions.LayoutContainer
7 | import kotlinx.android.synthetic.main.view_album_item.view.*
8 | import work.beltran.discogsbrowser.collection.CollectionViewHolder
9 | import work.beltran.discogsbrowser.collection.R
10 |
11 | class AlbumViewHolder(override val containerView: View): CollectionViewHolder(containerView), LayoutContainer {
12 |
13 | override fun bind(item: CollectionItem) {
14 | item as CollectionItem.AlbumItem
15 | itemView.nameTextView.text = item.album.title
16 | itemView.artistsTextView.text = item.album.artist.map { it.name }.all.joinToString()
17 | }
18 |
19 | companion object {
20 | fun create(parent: ViewGroup): AlbumViewHolder {
21 | val view = LayoutInflater.from(parent.context).inflate(R.layout.view_album_item, parent, false)
22 | return AlbumViewHolder(view)
23 | }
24 | }
25 |
26 | }
27 |
--------------------------------------------------------------------------------
/collection/collection-ui/src/main/java/work/beltran/discogsbrowser/collection/adapter/CollectionAdapter.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser.collection.adapter
2 |
3 | import android.view.ViewGroup
4 | import androidx.recyclerview.widget.DiffUtil
5 | import androidx.recyclerview.widget.RecyclerView
6 | import work.beltran.discogsbrowser.collection.CollectionViewHolder
7 | import work.beltran.discogsbrowser.common.domain.Album
8 |
9 | class CollectionAdapter : RecyclerView.Adapter() {
10 |
11 | private var items = emptyList()
12 |
13 | override fun getItemCount(): Int = items.size
14 |
15 | override fun getItemViewType(position: Int): Int {
16 | return when (items[position]) {
17 | is CollectionItem.AlbumItem -> TYPE_ALBUM
18 | is CollectionItem.LoadingItem -> TYPE_LOADING
19 | }
20 | }
21 |
22 | override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): CollectionViewHolder {
23 | return when (viewType) {
24 | TYPE_LOADING -> LoadingViewHolder.create(parent)
25 | TYPE_ALBUM -> AlbumViewHolder.create(parent)
26 | else -> error("Unknown ViewHolder type $viewType")
27 | }
28 | }
29 |
30 | override fun onBindViewHolder(holder: CollectionViewHolder, position: Int) {
31 | holder.bind(items[position])
32 | }
33 |
34 | fun submitList(albums: List) {
35 | val oldList = items
36 | items = albums
37 | val diffResult = DiffUtil.calculateDiff(
38 | AlbumDiffCallback(
39 | oldList,
40 | items
41 | )
42 | )
43 | diffResult.dispatchUpdatesTo(this)
44 | }
45 | }
46 |
47 | const val TYPE_ALBUM = 0
48 | const val TYPE_LOADING = 1
49 |
50 | sealed class CollectionItem {
51 | class AlbumItem(val album: Album) : CollectionItem()
52 | object LoadingItem : CollectionItem()
53 | }
54 |
55 |
--------------------------------------------------------------------------------
/collection/collection-ui/src/main/java/work/beltran/discogsbrowser/collection/adapter/LoadingViewHolder.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser.collection.adapter
2 |
3 | import android.view.LayoutInflater
4 | import android.view.View
5 | import android.view.ViewGroup
6 | import work.beltran.discogsbrowser.collection.CollectionViewHolder
7 | import work.beltran.discogsbrowser.collection.R
8 |
9 | class LoadingViewHolder(itemView: View): CollectionViewHolder(itemView) {
10 | override fun bind(item: CollectionItem) {
11 |
12 | }
13 |
14 | companion object {
15 | fun create(parent: ViewGroup): LoadingViewHolder {
16 | val view = LayoutInflater.from(parent.context)
17 | .inflate(R.layout.view_loading_item, parent, false)
18 | return LoadingViewHolder(view)
19 | }
20 | }
21 | }
--------------------------------------------------------------------------------
/collection/collection-ui/src/main/res/drawable/ic_album_black_24dp.xml:
--------------------------------------------------------------------------------
1 |
6 |
9 |
10 |
--------------------------------------------------------------------------------
/collection/collection-ui/src/main/res/layout/fragment_collection.xml:
--------------------------------------------------------------------------------
1 |
2 |
6 |
7 |
11 |
12 |
--------------------------------------------------------------------------------
/collection/collection-ui/src/main/res/layout/view_album_item.xml:
--------------------------------------------------------------------------------
1 |
2 |
9 |
10 |
24 |
25 |
39 |
40 |
53 |
54 |
--------------------------------------------------------------------------------
/collection/collection-ui/src/main/res/layout/view_loading_item.xml:
--------------------------------------------------------------------------------
1 |
2 |
6 |
7 |
17 |
--------------------------------------------------------------------------------
/collection/collection-ui/src/main/res/values/strings.xml:
--------------------------------------------------------------------------------
1 |
2 | Collection
3 | Album art
4 |
5 |
--------------------------------------------------------------------------------
/collection/collection-ui/src/test/java/work/beltran/discogsbrowser/collection/CollectionViewModelTest.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser.collection
2 |
3 | import androidx.arch.core.executor.testing.InstantTaskExecutorRule
4 | import arrow.core.Either
5 | import arrow.data.NonEmptyList
6 | import io.mockk.every
7 | import io.mockk.mockk
8 | import kotlinx.coroutines.Dispatchers
9 | import kotlinx.coroutines.runBlocking
10 | import org.junit.Assert.*
11 | import org.junit.Before
12 | import org.junit.Rule
13 | import org.junit.Test
14 | import work.beltran.discogsbrowser.collection.adapter.CollectionItem
15 | import work.beltran.discogsbrowser.common.domain.Album
16 | import work.beltran.discogsbrowser.common.domain.Artist
17 | import work.beltran.discogsbrowser.common.domain.GetCollectionUseCase
18 | import work.beltran.discogsbrowser.common.domain.Pagination
19 |
20 | class CollectionViewModelTest {
21 |
22 | @get:Rule
23 | val rule = InstantTaskExecutorRule()
24 |
25 | val useCase = mockk()
26 | val album = Album(
27 | id = "id",
28 | title = "title",
29 | thumb = "thumb",
30 | artist = NonEmptyList.just(Artist(id = "id", name = "name"))
31 | )
32 |
33 | @Test
34 | fun `load initial page`() {
35 | every {
36 | runBlocking {
37 | useCase.getCollectionPage("0", 1)
38 | }
39 | } returns Either.right(
40 | Pagination(
41 | data = listOf(
42 | album
43 | ),
44 | currentPage = 1,
45 | nextPage = null,
46 | totalItems = 1
47 | )
48 | )
49 |
50 | val viewModel = CollectionViewModel(
51 | collectionUseCase = useCase,
52 | dispatcher = Dispatchers.Unconfined
53 | )
54 |
55 | val data = viewModel.liveData.value!!
56 | assertEquals(1, data.size)
57 |
58 | val item = data[0] as CollectionItem.AlbumItem
59 | assertEquals(album, item.album)
60 | }
61 |
62 | @Test
63 | fun `load second page`() {
64 | every {
65 | runBlocking {
66 | useCase.getCollectionPage("0", 1)
67 | }
68 | } returns Either.right(
69 | Pagination(
70 | data = listOf(
71 | album
72 | ),
73 | currentPage = 1,
74 | nextPage = 2,
75 | totalItems = 2
76 | )
77 | )
78 |
79 | every {
80 | runBlocking {
81 | useCase.getCollectionPage("0", 2)
82 | }
83 | } returns Either.right(
84 | Pagination(
85 | data = listOf(
86 | album
87 | ),
88 | currentPage = 2,
89 | nextPage = null,
90 | totalItems = 2
91 | )
92 | )
93 |
94 | // Loads page 1
95 | val viewModel = CollectionViewModel(
96 | collectionUseCase = useCase,
97 | dispatcher = Dispatchers.Unconfined
98 | )
99 |
100 | // Loads page 2
101 | viewModel.loadMore()
102 |
103 |
104 | val data = viewModel.liveData.value!!
105 | assertEquals(2, data.size)
106 | }
107 | }
--------------------------------------------------------------------------------
/common-domain/.gitignore:
--------------------------------------------------------------------------------
1 | /build
2 |
--------------------------------------------------------------------------------
/common-domain/build.gradle:
--------------------------------------------------------------------------------
1 | apply plugin: 'java-library'
2 | apply plugin: 'kotlin'
3 |
4 | dependencies {
5 | implementation fileTree(dir: 'libs', include: ['*.jar'])
6 | implementation Libs.kotlin
7 | implementation Libs.arrow
8 | }
9 |
10 | sourceCompatibility = "7"
11 | targetCompatibility = "7"
12 |
--------------------------------------------------------------------------------
/common-domain/src/main/java/work/beltran/discogsbrowser/common/domain/Album.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser.common.domain
2 |
3 | import arrow.data.NonEmptyList
4 |
5 | data class Album(
6 | val id: String,
7 | val title: String,
8 | val artist: NonEmptyList,
9 | val thumb: String
10 | )
11 |
12 | data class Artist(
13 | val id: String,
14 | val name: String
15 | )
16 |
17 |
--------------------------------------------------------------------------------
/common-domain/src/main/java/work/beltran/discogsbrowser/common/domain/GetCollectionUseCase.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser.common.domain
2 |
3 | import arrow.core.Either
4 |
5 | interface GetCollectionUseCase {
6 | suspend fun getCollectionPage(
7 | folder: String,
8 | page: Int
9 | ): Either>>
10 | }
11 |
12 |
--------------------------------------------------------------------------------
/common-domain/src/main/java/work/beltran/discogsbrowser/common/domain/Pagination.kt:
--------------------------------------------------------------------------------
1 | package work.beltran.discogsbrowser.common.domain
2 |
3 | data class Pagination(
4 | val data: T,
5 | val currentPage: Int,
6 | val nextPage: Int?,
7 | val totalItems: Int
8 | )
9 |
10 |
--------------------------------------------------------------------------------
/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=-Xmx1536m
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 | # Kotlin code style for this project: "official" or "obsolete":
15 | kotlin.code.style=official
16 |
17 | android.useAndroidX=true
18 | android.enableJetifier=true
19 |
--------------------------------------------------------------------------------
/gradle/projectDependencyGraph.gradle:
--------------------------------------------------------------------------------
1 | // Copyright JakeWharton https://github.com/JakeWharton/SdkSearch/blob/6980feb15adbb528dfb83634a1a179042008bf7e/gradle/projectDependencyGraph.gradle
2 | task projectDependencyGraph {
3 | doLast {
4 | def dot = new File(rootProject.buildDir, 'reports/dependency-graph/project.dot')
5 | dot.parentFile.mkdirs()
6 | dot.delete()
7 |
8 | dot << 'digraph {\n'
9 | dot << " graph [label=\"${rootProject.name}\\n \",labelloc=t,fontsize=30];\n"
10 | dot << ' node [style=filled, fillcolor="#bbbbbb"];\n'
11 | dot << ' rankdir=TB;\n'
12 |
13 | def rootProjects = []
14 | def queue = [rootProject]
15 | while (!queue.isEmpty()) {
16 | def project = queue.remove(0)
17 | rootProjects.add(project)
18 | queue.addAll(project.childProjects.values())
19 | }
20 |
21 | def projects = new LinkedHashSet()
22 | def dependencies = new LinkedHashMap, List>()
23 | def multiplatformProjects = []
24 | def jsProjects = []
25 | def androidProjects = []
26 | def javaProjects = []
27 |
28 | queue = [rootProject]
29 | while (!queue.isEmpty()) {
30 | def project = queue.remove(0)
31 | queue.addAll(project.childProjects.values())
32 |
33 | if (project.plugins.hasPlugin('org.jetbrains.kotlin.multiplatform')) {
34 | multiplatformProjects.add(project)
35 | }
36 | if (project.plugins.hasPlugin('kotlin2js')) {
37 | jsProjects.add(project)
38 | }
39 | if (project.plugins.hasPlugin('com.android.library') || project.plugins.hasPlugin('com.android.application')) {
40 | androidProjects.add(project)
41 | }
42 | if (project.plugins.hasPlugin('java-library') || project.plugins.hasPlugin('java')) {
43 | javaProjects.add(project)
44 | }
45 |
46 | project.configurations.all { config ->
47 | config.dependencies
48 | .withType(ProjectDependency)
49 | .collect { it.dependencyProject }
50 | .each { dependency ->
51 | projects.add(project)
52 | projects.add(dependency)
53 | rootProjects.remove(dependency)
54 |
55 | def graphKey = new Tuple2(project, dependency)
56 | def traits = dependencies.computeIfAbsent(graphKey) { new ArrayList() }
57 |
58 | if (config.name.toLowerCase().endsWith('implementation')) {
59 | traits.add('style=dotted')
60 | }
61 | }
62 | }
63 | }
64 |
65 | projects = projects.sort { it.path }
66 |
67 | dot << '\n # Projects\n\n'
68 | for (project in projects) {
69 | def traits = []
70 |
71 | if (rootProjects.contains(project)) {
72 | traits.add('shape=box')
73 | }
74 |
75 | if (multiplatformProjects.contains(project)) {
76 | traits.add('fillcolor="#ffd2b3"')
77 | } else if (jsProjects.contains(project)) {
78 | traits.add('fillcolor="#ffffba"')
79 | } else if (androidProjects.contains(project)) {
80 | traits.add('fillcolor="#baffc9"')
81 | } else if (javaProjects.contains(project)) {
82 | traits.add('fillcolor="#ffb3ba"')
83 | } else {
84 | traits.add('fillcolor="#eeeeee"')
85 | }
86 |
87 | dot << " \"${project.path}\" [${traits.join(", ")}];\n"
88 | }
89 |
90 | dot << '\n {rank = same;'
91 | for (project in projects) {
92 | if (rootProjects.contains(project)) {
93 | dot << " \"${project.path}\";"
94 | }
95 | }
96 | dot << '}\n'
97 |
98 | dot << '\n # Dependencies\n\n'
99 | dependencies.forEach { key, traits ->
100 | dot << " \"${key.first.path}\" -> \"${key.second.path}\""
101 | if (!traits.isEmpty()) {
102 | dot << " [${traits.join(", ")}]"
103 | }
104 | dot << '\n'
105 | }
106 |
107 | dot << '}\n'
108 |
109 | def p = 'dot -Tpng -O project.dot'.execute([], dot.parentFile)
110 | p.waitFor()
111 | if (p.exitValue() != 0) {
112 | throw new RuntimeException(p.errorStream.text)
113 | }
114 |
115 | println("Project module dependency graph created at ${dot.absolutePath}.png")
116 | }
117 | }
118 |
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/miquelbeltran/android-architecture-sample/2691a4385a1d3d6ee9ad93eab28fed22f6ab5fbc/gradle/wrapper/gradle-wrapper.jar
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionBase=GRADLE_USER_HOME
2 | distributionPath=wrapper/dists
3 | distributionUrl=https\://services.gradle.org/distributions/gradle-4.6-all.zip
4 | zipStoreBase=GRADLE_USER_HOME
5 | zipStorePath=wrapper/dists
6 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Attempt to set APP_HOME
10 | # Resolve links: $0 may be a link
11 | PRG="$0"
12 | # Need this for relative symlinks.
13 | while [ -h "$PRG" ] ; do
14 | ls=`ls -ld "$PRG"`
15 | link=`expr "$ls" : '.*-> \(.*\)$'`
16 | if expr "$link" : '/.*' > /dev/null; then
17 | PRG="$link"
18 | else
19 | PRG=`dirname "$PRG"`"/$link"
20 | fi
21 | done
22 | SAVED="`pwd`"
23 | cd "`dirname \"$PRG\"`/" >/dev/null
24 | APP_HOME="`pwd -P`"
25 | cd "$SAVED" >/dev/null
26 |
27 | APP_NAME="Gradle"
28 | APP_BASE_NAME=`basename "$0"`
29 |
30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31 | DEFAULT_JVM_OPTS=""
32 |
33 | # Use the maximum available, or set MAX_FD != -1 to use that value.
34 | MAX_FD="maximum"
35 |
36 | warn () {
37 | echo "$*"
38 | }
39 |
40 | die () {
41 | echo
42 | echo "$*"
43 | echo
44 | exit 1
45 | }
46 |
47 | # OS specific support (must be 'true' or 'false').
48 | cygwin=false
49 | msys=false
50 | darwin=false
51 | nonstop=false
52 | case "`uname`" in
53 | CYGWIN* )
54 | cygwin=true
55 | ;;
56 | Darwin* )
57 | darwin=true
58 | ;;
59 | MINGW* )
60 | msys=true
61 | ;;
62 | NONSTOP* )
63 | nonstop=true
64 | ;;
65 | esac
66 |
67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68 |
69 | # Determine the Java command to use to start the JVM.
70 | if [ -n "$JAVA_HOME" ] ; then
71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72 | # IBM's JDK on AIX uses strange locations for the executables
73 | JAVACMD="$JAVA_HOME/jre/sh/java"
74 | else
75 | JAVACMD="$JAVA_HOME/bin/java"
76 | fi
77 | if [ ! -x "$JAVACMD" ] ; then
78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79 |
80 | Please set the JAVA_HOME variable in your environment to match the
81 | location of your Java installation."
82 | fi
83 | else
84 | JAVACMD="java"
85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86 |
87 | Please set the JAVA_HOME variable in your environment to match the
88 | location of your Java installation."
89 | fi
90 |
91 | # Increase the maximum file descriptors if we can.
92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93 | MAX_FD_LIMIT=`ulimit -H -n`
94 | if [ $? -eq 0 ] ; then
95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96 | MAX_FD="$MAX_FD_LIMIT"
97 | fi
98 | ulimit -n $MAX_FD
99 | if [ $? -ne 0 ] ; then
100 | warn "Could not set maximum file descriptor limit: $MAX_FD"
101 | fi
102 | else
103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104 | fi
105 | fi
106 |
107 | # For Darwin, add options to specify how the application appears in the dock
108 | if $darwin; then
109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110 | fi
111 |
112 | # For Cygwin, switch paths to Windows format before running java
113 | if $cygwin ; then
114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116 | JAVACMD=`cygpath --unix "$JAVACMD"`
117 |
118 | # We build the pattern for arguments to be converted via cygpath
119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120 | SEP=""
121 | for dir in $ROOTDIRSRAW ; do
122 | ROOTDIRS="$ROOTDIRS$SEP$dir"
123 | SEP="|"
124 | done
125 | OURCYGPATTERN="(^($ROOTDIRS))"
126 | # Add a user-defined pattern to the cygpath arguments
127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129 | fi
130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
131 | i=0
132 | for arg in "$@" ; do
133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135 |
136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138 | else
139 | eval `echo args$i`="\"$arg\""
140 | fi
141 | i=$((i+1))
142 | done
143 | case $i in
144 | (0) set -- ;;
145 | (1) set -- "$args0" ;;
146 | (2) set -- "$args0" "$args1" ;;
147 | (3) set -- "$args0" "$args1" "$args2" ;;
148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154 | esac
155 | fi
156 |
157 | # Escape application args
158 | save () {
159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160 | echo " "
161 | }
162 | APP_ARGS=$(save "$@")
163 |
164 | # Collect all arguments for the java command, following the shell quoting and substitution rules
165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166 |
167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169 | cd "$(dirname "$0")"
170 | fi
171 |
172 | exec "$JAVACMD" "$@"
173 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @if "%DEBUG%" == "" @echo off
2 | @rem ##########################################################################
3 | @rem
4 | @rem Gradle startup script for Windows
5 | @rem
6 | @rem ##########################################################################
7 |
8 | @rem Set local scope for the variables with windows NT shell
9 | if "%OS%"=="Windows_NT" setlocal
10 |
11 | set DIRNAME=%~dp0
12 | if "%DIRNAME%" == "" set DIRNAME=.
13 | set APP_BASE_NAME=%~n0
14 | set APP_HOME=%DIRNAME%
15 |
16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
17 | set DEFAULT_JVM_OPTS=
18 |
19 | @rem Find java.exe
20 | if defined JAVA_HOME goto findJavaFromJavaHome
21 |
22 | set JAVA_EXE=java.exe
23 | %JAVA_EXE% -version >NUL 2>&1
24 | if "%ERRORLEVEL%" == "0" goto init
25 |
26 | echo.
27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28 | echo.
29 | echo Please set the JAVA_HOME variable in your environment to match the
30 | echo location of your Java installation.
31 |
32 | goto fail
33 |
34 | :findJavaFromJavaHome
35 | set JAVA_HOME=%JAVA_HOME:"=%
36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37 |
38 | if exist "%JAVA_EXE%" goto init
39 |
40 | echo.
41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42 | echo.
43 | echo Please set the JAVA_HOME variable in your environment to match the
44 | echo location of your Java installation.
45 |
46 | goto fail
47 |
48 | :init
49 | @rem Get command-line arguments, handling Windows variants
50 |
51 | if not "%OS%" == "Windows_NT" goto win9xME_args
52 |
53 | :win9xME_args
54 | @rem Slurp the command line arguments.
55 | set CMD_LINE_ARGS=
56 | set _SKIP=2
57 |
58 | :win9xME_args_slurp
59 | if "x%~1" == "x" goto execute
60 |
61 | set CMD_LINE_ARGS=%*
62 |
63 | :execute
64 | @rem Setup the command line
65 |
66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
67 |
68 | @rem Execute Gradle
69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
70 |
71 | :end
72 | @rem End local scope for the variables with windows NT shell
73 | if "%ERRORLEVEL%"=="0" goto mainEnd
74 |
75 | :fail
76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
77 | rem the _cmd.exe /c_ return code!
78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
79 | exit /b 1
80 |
81 | :mainEnd
82 | if "%OS%"=="Windows_NT" endlocal
83 |
84 | :omega
85 |
--------------------------------------------------------------------------------
/project.dot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/miquelbeltran/android-architecture-sample/2691a4385a1d3d6ee9ad93eab28fed22f6ab5fbc/project.dot.png
--------------------------------------------------------------------------------
/settings.gradle:
--------------------------------------------------------------------------------
1 | include ':app', ':collection:collection-ui', ':api', ':collection:collection-data', ':common-domain'
2 |
--------------------------------------------------------------------------------