├── .DS_Store ├── LICENSE ├── README.md └── imgs ├── image1.png ├── image2.png └── img3.png /.DS_Store: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Flutterando/minicore/c1f07d08d67a50427501a714f68c652f1339bc77/.DS_Store -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # MiniCore Arch 2 | 3 | Flutter/Dart Architecture proposal inspired by Clean Architecture. 4 | 5 | ![Image 1](imgs/image2.png) 6 | 7 | ## Clean Dart Proposal 8 | 9 | If you need something more robust, try Clean Dart! 10 | 11 | - [pt-BR](1.0/README.md) 12 | - [en-US](1.0/README_en.md) 13 | 14 | # Start 15 | 16 | Using Flutter as an example, we will then have three layers maintaining the “Plugin Architecture”, with the main focus on the State of the Application, which is the layer that hosts the events/actions for state changes. 17 | 18 | ![Image 1](imgs/image1.png) 19 | 20 | The Architecture proposal proposes to decouple the outermost layers and preserve the Business Rule. 21 | 22 | ## UI 23 | 24 | The **UI** Layer is responsible for declaring the application's inputs, outputs and interactions. 25 | 26 | Using Flutter as an example, we will host the Widgets and Pages, in the backend as an example, it would be in this layer where we would place the Handlers or Commands of our API. 27 | 28 | ## INTERACTOR 29 | 30 | The **Interactor** layer will host the application's Business Rules along with their states. 31 | The core of the layer will be state elaboration and scheduling through some state management approach. 32 | 33 | Taking a Repository as an example, we will only have to have the interfaces contract (Abstractions) and the responsibility for implementing this object will have to be transferred to another lower layer. 34 | 35 | ## DATA 36 | 37 | This layer supports the **Interactor** layer by implementing its interfaces. To do this, it adapts external data so that it can fulfill the domain's contracts. 38 | 39 | Most likely in this layer we will implement some Repository or Services interface that may or may not depend on external data such as an API or access to some Hardware such as Bluetooth. 40 | 41 | In order for the Repository to be able to process and adapt external data, we must create contracts for these services in order to pass the implementation responsibility to the lowest layer of our architecture. 42 | 43 | Basically, the **DATA** layer should contain everything that will have a high chance of being changed without the programmer being able to intervene directly in the project. 44 | 45 | # Design Patterns 46 | 47 | ## Isolate Layers - Service 48 | 49 | The `Service` pattern will be used for code types that don't have a predefined pattern but need to be separated. 50 | 51 | [Service layer pattern documentation](https://en.wikipedia.org/wiki/Service_layer_pattern) 52 | 53 | ## Dependency Injection 54 | 55 | Necessary to apply the Dependency Inversion Principle (DIP). 56 | 57 | [Flutterando Video - Dependency Injection](https://www.youtube.com/watch?v=KpPnDHpgHnA) 58 | 59 | ## State management 60 | 61 | In cases of multiple sucessful states the _[State Pattern](https://refactoring.guru/design-patterns/state)_ can be used: 62 | 63 | ```dart 64 | sealed class UserState {} 65 | 66 | final class UnregisteredUserState implements UserState {...} 67 | final class RegisteredUserState implements UserState {...} 68 | ``` 69 | 70 | Use any state management approach to propagate states. Suggestions: 71 | 72 | - [ValueNotifier](https://api.flutter.dev/flutter/foundation/ValueNotifier-class.html?gclid=Cj0KCQjwkqSlBhDaARIsAFJANki5MzNFMZ_zHkydtK6igQyyyDdJHteXp3steWclG70LsnJYFiE98JsaAqebEALw_wcB&gclsrc=aw.ds) 73 | - [Triple](https://triple.flutterando.com.br/) 74 | - [ASP](https://github.com/Flutterando/asp) 75 | - [BLoC/Cubit](https://bloclibrary.dev/#/) 76 | - [MobX](https://pub.dev/packages/mobx) 77 |
78 | 79 | 80 | ## Adaptation and conversion 81 | 82 | Data types conversion should be made using the `Adapter` pattern.
83 | 84 | [Adapter Pattern documentation](https://refactoring.guru/design-patterns/adapter) 85 | 86 |
87 | 88 | ## External API Access (REST OR GRAPHQL) 89 | 90 | `Repository Pattern` with `Datasource`.
91 | [Repository Documentation form Microsoft](https://learn.microsoft.com/en-us/dotnet/architecture/microservices/microservice-ddd-cqrs-patterns/infrastructure-persistence-layer-design) 92 |
OR
93 | 94 | `Gateway Pattern`.
95 | [Martin Fowler Gateway definitions](https://martinfowler.com/articles/gateway-pattern.html) 96 |
97 | 98 | ## Data Transfer Object 99 | 100 | Can be used to transfer data between layers.
101 | [Martin Fowler Text about DTO](https://martinfowler.com/eaaCatalog/dataTransferObject.html) 102 | 103 | # Tests 104 | 105 | Tests must follow the triple-A pattern (Arrange, Act, Assert). 106 | [Triple-A Article](https://medium.com/@pjbgf/title-testing-code-ocd-and-the-aaa-pattern-df453975ab80) 107 | 108 | Example: 109 | 110 | ```dart 111 | test('should execute a sum correctly', (){ 112 | 113 | // arrange 114 | int number1 = 2; 115 | int number2 = 1; 116 | 117 | // act 118 | final result = sumFunction(number1, number2); 119 | 120 | // assert 121 | expect(result, 3); 122 | 123 | }); 124 | 125 | ``` 126 | 127 |
128 | 129 | ## Test description 130 | 131 | The test description should represent the expected result, according to the action performed. 132 | You should _NOT_ use descriptions that are obvious like, for example, when a result of a list is expected to be a List you have to avoid a description as such: "Should return a `List` object". 133 | 134 |
135 | 136 | ## Test group 137 | 138 | The groups must be named according to the class name, which may or may not be followed by the method. 139 | At the end of the description, you must add " | " (space, pipe, space). 140 | 141 |
142 | 143 | Store example: 144 | 145 | ```dart 146 | group('ProductStore | ', (){ 147 | 148 | // all ProductStore`s test 149 | 150 | }); 151 | 152 | ``` 153 | 154 | Repository exemple: 155 | 156 | ```dart 157 | 158 | group('ProductRepository.fetchAll | ', (){ 159 | 160 | // all ProductRepository.fetchAll`s test 161 | 162 | }); 163 | ``` 164 | 165 |
166 |
167 | 168 | --- 169 | 170 | 171 | # Tips 172 | 173 | ## Modularize 174 | 175 | Obviously we can keep our layers for the entire application but we can get more out of it by creating Interactor, Data and UI layers for each feature. Example: 176 | 177 | ``` 178 | module 179 | ├── data 180 | │ ├── datasources 181 | │ └── repositories 182 | ├── domain 183 | │ ├── entities 184 | │ └── usecases 185 | └── presenter 186 | ├── stores 187 | ├── controllers 188 | ├── pages 189 | └── widgets 190 | ``` 191 | 192 | ## Think by layer 193 | 194 | When developing, start thinking by layer, we shouldn't worry about what's in the **UI** or **DATA** layer at the beginning of the functionality. If we think about the outermost layers, we can end up orienting ourselves (mistakenly) by these layers. Thus, we must get used to developing layer by layer, from the inside out and not the other way around. 195 | 196 | Perhaps at the beginning of your "Clean" journey some layers may seem "useless", this happens when our mind is not yet **Thinking in Layers** (or because your Business Rule is too simple for that). 197 | 198 | ## Unit Testing will be your new UI 199 | 200 | It is very common for developers to first create their Views so that they can then "test" the Business Rules. But we already have a proper tool for this and a dedicated place to store these tests. 201 | 202 | Developing in a "clean" way is in total synergy with TDD (Test Driven Development) as the UI layer will be one of the last things we will think about in the development of our feature. 203 | 204 | # Sign 205 | 206 | We appreciate your feedback! 207 | 208 | If you agree with the "MiniCore Architecture" proposal, leave a Star on this repository. A Star is the same as signing a "clean manifesto" agreeing with this proposal. 209 | 210 | We are open to suggestions and improvements in documentation! 211 | Do this through the issues, our team will be very pleased with your interest in improving this tool for the community. 212 | 213 | Feel free to open a PR with corrections to the documentation of this proposal. 214 | 215 | # Examples 216 | 217 | - [Clean Dart Burgers Cart using BLoC, Cubit, Triple, Asp, MobX, etc](https://github.com/jacobaraujo7/bloc_atom) 218 | - Clean Dart Login with Firebase, MobX and Modular 219 | - [Clean Dart Github Search with BLoC and Modular](https://github.com/Flutterando/clean-dart-search-bloc) 220 | - [Clean Dart Github Search with MobX and Modular](https://github.com/jacobaraujo7/clean-dart-search-mobx) 221 | - [Simple App with MiniCore](https://github.com/viniciusddrft/mini_core_exemple) 222 | - [Todo App with MiniCore](https://github.com/EdsonMello-code/todoapp) 223 | 224 | # Links 225 | 226 | - [Resumo do livro "Arquitetura Limpa"](https://medium.com/@deividchari/desvendando-a-arquitetura-limpa-de-uncle-bob-3e60d9aa9cce) 227 | - [Sua Arquitetura está limpa?](https://medium.com/flutterando/sua-arquitetura-est%C3%A1-limpa-clean-architecture-no-flutter-458c68fad120) 228 | - [Os tijolos do Clean Architecture](https://www.youtube.com/watch?v=C8mpy3pwqQc) 229 | - [The Clean Code Blog](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html) -------------------------------------------------------------------------------- /imgs/image1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Flutterando/minicore/c1f07d08d67a50427501a714f68c652f1339bc77/imgs/image1.png -------------------------------------------------------------------------------- /imgs/image2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Flutterando/minicore/c1f07d08d67a50427501a714f68c652f1339bc77/imgs/image2.png -------------------------------------------------------------------------------- /imgs/img3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Flutterando/minicore/c1f07d08d67a50427501a714f68c652f1339bc77/imgs/img3.png --------------------------------------------------------------------------------