First commit

.github/workflows/dart.yml

@@ -0,0 +1,23 @@
+name: Dart CI
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: subosito/flutter-action@v1
+        with:
+          channel: 'stable'
+          flutter-version: '3.0.5'
+      - name: Install dependencies
+        run: flutter pub get
+      - name: Run tests
+        run: flutter test
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        if: startsWith(github.ref, 'refs/tags/')
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1,30 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+migrate_working_dir/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
+/pubspec.lock
+**/doc/api/
+.dart_tool/
+.packages
+build/

.metadata

@@ -0,0 +1,10 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: f1875d570e39de09040c8f79aa13cc56baab8db1
+  channel: stable
+
+project_type: package

CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0.
+
+* Initial release.

LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2022 MyLittleSuite
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,254 @@
+# Pine
+
+<img align="center" src="assets/pine_logo.png" width="350" alt="Pine logo" border="0">
+
+A lightweight architecture helper for your Flutter projects
+
+[![Pub](https://img.shields.io/pub/v/pine.svg)](https://pub.dev/packages/pine)
+![Dart CI](https://github.com/MyLittleSuite/pine/workflows/Dart%20CI/badge.svg)
+[![Star on GitHub](https://img.shields.io/github/stars/MyLittleSuite/pine.svg?style=flat&logo=github&colorB=deeppink&label=stars)](https://github.com/MyLittleSuite/pine)
+[![License: MIT](https://img.shields.io/badge/license-MIT-purple.svg)](https://opensource.org/licenses/MIT)
+
+If you want to support this project,
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/angeloavv)
+
+## Getting started
+
+Pine relies on the following dependencies:
+* [Provider](https://pub.dev/packages/provider)
+* [Flutter BLoC](https://pub.dev/packages/flutter_bloc)
+
+With this tool, you will easily define the architecture of your Flutter application using Provider to inject elements in the widget tree and BLoC as a state manager.
+
+### Installation
+
+This package is intended to support development of Flutter projects. In
+general, put it under
+[dependencies](https://dart.dev/tools/pub/dependencies),
+in your [pubspec.yaml](https://dart.dev/tools/pub/pubspec):
+
+```yaml
+dev_dependencies:
+  pine: ^1.0.0
+```
+
+You can install packages from the command line:
+
+```terminal
+flutter pub get
+```
+
+or simply add it through the command line:
+
+```terminal
+flutter pub add pine
+```
+
+## How it Works
+
+#### The architecture
+Elements are injected from top to bottom. 
+1. The first elements added in the widget tree are mappers, particularly useful to convert data coming from data layers to something that should be used in the presentation layer.
+2. The second elements are providers: here you can inject services that manipulate data or access to it like REST clients or DAOs interfaces.
+3. The third layer is used to inject the repositories that access to the data layer using an abstraction layer.
+4. The last layer is used to inject the logic: Pine relies on BLoC as a state manager, that's why we'll inject global scoped BLoCs.
+
+Each element might rely on the top level ones and are generally accessed from the bottom level ones: for instance a repository may need to access to a REST client service to gather data, save it into a database, and the return it to a BLoC.
+To access top-level items, you can use the read and watch functions exposed by Provider.
+
+<img src="assets/architecture.png" alt="Pine logo" border="0">
+
+#### The interactions
+<img src="assets/interaction.png" alt="Pine logo" border="0">
+
+## Usage
+
+A pine architecture can be achieved by using the DependencyInjectorHelper widget, which helps you to inject different types of elements into the widget tree.
+If you are working on a simple project, you should use the DependencyInjectorHelper straight into your main app widget.
+
+Example:
+```dart
+class App extends StatelessWidget {
+  const App({Key? key}) : super(key: key);
+
+  @override
+  Widget build(BuildContext context) => DependencyInjectorHelper(
+    blocs: [
+      BlocProvider<NewsBloc>(
+        create: (context) => NewsBloc(
+          newsRepository: context.read(),
+        )..fetchNews(),
+      ),
+    ],
+    mappers: [
+      Provider<DTOMapper<ArticleDTO, Article>>(
+        create: (_) => ArticleMapper(),
+      ),
+    ],
+    providers: [
+      Provider<Dio>(
+        create: (_) => Dio(),
+      ),
+      Provider<NewsService>(
+        create: (context) => NewsService(
+          context.read(),
+          baseUrl: 'https://newsapi.org/v2/',
+        ),
+      ),
+    ],
+    repositories: [
+      RepositoryProvider<NewsRepository>(
+        create: (context) => NewsRepositoryImpl(
+          newsService: context.read(),
+          mapper: context.read(),
+        ),
+      ),
+    ],
+    child: MaterialApp(
+      debugShowCheckedModeBanner: false,
+      title: 'News App',
+      theme: ThemeData(
+        primarySwatch: Colors.blue,
+        visualDensity: VisualDensity.adaptivePlatformDensity,
+      ),
+      home: const HomePage(),
+    ),
+  );
+}
+```
+
+As the project grows, it's better to create a new widget that wraps all of these items in different files. We can name this widget DependencyInjector.
+dependency_injector.dart:
+```dart
+
+part 'blocs.dart';
+part 'mappers.dart';
+part 'providers.dart';
+part 'repositories.dart';
+
+class DependencyInjector extends StatelessWidget {
+  final Widget child;
+
+  const DependencyInjector({
+    Key? key,
+    required this.child,
+  }) : super(key: key);
+
+  @override
+  Widget build(BuildContext context) => DependencyInjectorHelper(
+    blocs: _blocs,
+    providers: _providers,
+    mappers: _mappers,
+    repositories: _repositories,
+    child: child,
+  );
+}
+```
+
+In this widget, we need to define all the dependencies that are required in our project. I prefer splitting these elements into different files according to their type.
+In our example, we will create four different files because we inject blocs, mappers, providers, and repositories.
+
+blocs.dart
+```dart
+part of 'dependency_injector.dart';
+
+final List<BlocProvider> _blocs = [
+  BlocProvider<NewsBloc>(
+    create: (context) => NewsBloc(
+      newsRepository: context.read(),
+    )..fetchNews(),
+  ),
+];
+```
+
+mappers.dart
+```dart
+part of 'dependency_injector.dart';
+
+final List<SingleChildWidget> _mappers = [
+  Provider<DTOMapper<ArticleDTO, Article>>(
+    create: (_) => ArticleMapper(),
+  ),
+];
+```
+
+providers.dart
+```dart
+part of 'dependency_injector.dart';
+
+final List<SingleChildWidget> _providers = [
+  Provider<Dio>(
+    create: (_) => Dio(),
+  ),
+  Provider<NewsService>(
+    create: (context) => NewsService(
+      context.read(),
+      baseUrl: 'https://newsapi.org/v2/',
+    ),
+  ),
+];
+```
+
+repositories.dart
+```dart
+part of 'dependency_injector.dart';
+
+final List<RepositoryProvider> _repositories = [
+  RepositoryProvider<NewsRepository>(
+    create: (context) => NewsRepositoryImpl(
+      newsService: context.read(),
+      mapper: context.read(),
+    ),
+  ),
+];
+```
+
+Once we finished defining the global dependencies to inject into the widget tree, we need to wrap our MaterialApp/CupertinoApp with the DependencyInjector widget as follows:
+```dart
+class App extends StatelessWidget {
+  const App({Key? key}) : super(key: key);
+
+  @override
+  Widget build(BuildContext context) => DependencyInjector(
+    child: MaterialApp(
+      debugShowCheckedModeBanner: false,
+      title: 'News App',
+      theme: ThemeData(
+        primarySwatch: Colors.blue,
+        visualDensity: VisualDensity.adaptivePlatformDensity,
+      ),
+      home: const HomePage(),
+    ),
+  );
+}
+```
+
+### Testing
+With the DependencyInjectorHelper it's easy to inject dependencies into the widget tree.
+Simply wrap the widget you need to test with the DependencyInjectorHelper class and inject the dependencies you need.
+
+In the following example, we will test the HomePage widget which relies on NewsBloc. Before pumping the MaterialApp containing the HomePage, we will wrap it as follows:
+
+```dart
+    await tester.pumpWidget(
+      DependencyInjectorHelper(
+        blocs: [
+          BlocProvider<NewsBloc>.value(value: newsBloc),
+        ],
+        child: const MaterialApp(
+          home: HomePage(),
+        ),
+      ),
+    );
+```
+
+Of course, since we are testing the HomePage, we are injecting a mocked newsBloc. 
+
+## License
+
+Pine is available under the MIT license. See the LICENSE file for more info.
+
+## Additional information
+
+<a href="https://www.flaticon.com/free-icons/pine" title="pine icons">Pine icons created by Freepik - Flaticon</a>

analysis_options.yaml

@@ -0,0 +1,4 @@
+include: package:flutter_lints/flutter.yaml
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options