Merge pull request #693 from Flutterando/modular_5

feat!: Add New auto-dispose, selector and setArguments [Modular 5]

Author: Bwolfs2

flutter_modular_test/.gitignore renamed to (deprecated)flutter_modular_test/.gitignore

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 3
 ---
 
 # Dependency Injection
@@ -174,7 +174,6 @@ run an instance destruction routine and are automatically removed from memory. H
 
 - Stream/Sink (Dart Native).
 - ChangeNotifier/ValueNotifier (Flutter Native).
-- Store (Triple Pattern).
 
 For registered objects that are not part of this list, we can implement a **Disposable** interface on the instance where we want to run an algorithm before dispose:
 
@@ -189,9 +188,19 @@ class MyController implements Disposable {
 }
 ```
 
+The dispose of an instance can be set directly in `Bind` by implementing the `onDispose` property:
+
+```dart
+@override
+final List<Bind> binds = [
+  Bind.singleton((i) => MyBloc(), onDispose: (bloc) => bloc.close()),
+];
+```
+
 :::tip TIP
 
-As BLoC is based on Streams, the memory release takes effect automatically.
+There are pre-configured `Bind` for BLoC and Triple.
+See the packages [modular_bloc_bind](https://pub.dev/packages/modular_bloc_bind) and [modular_triple_bind](https://pub.dev/packages/modular_triple_bind)
 
 :::
 

flutter_modular_test/.metadata renamed to (deprecated)flutter_modular_test/.metadata

@@ -113,16 +113,16 @@ using square brackets notation (['parameter_name']).
 - *Query*: like the web environment, we can send parameters using query. This doesn't allows you to let the route dynamic, but it has the same effect when recovering a parameter;
 
 ```dart
-ChildRoute('/second', child: (context, args) => SecondPage(name: args.query['name'])),
+ChildRoute('/second', child: (context, args) => SecondPage(name: args.queryParams['name'])),
 ```
 
-Note that the route name is the same, so we can use **Modular.args.query** to get the parameter.
+Note that the route name is the same, so we can use **Modular.args.queryParams** to get the parameter.
 Let’s see how we can navigate using queries:
-
+∂
 ```dart
-Modular.to.navigate('/second?name=jacob');  // args.query['name'] -> 'jacob'
-Modular.to.navigate('/second?name=sara');   // args.query['name'] -> 'sara'
-Modular.to.navigate('/second?name=rie');    // args.query['name'] -> 'rie'
+Modular.to.navigate('/second?name=jacob');  // args.queryParams['name'] -> 'jacob'
+Modular.to.navigate('/second?name=sara');   // args.queryParams['name'] -> 'sara'
+Modular.to.navigate('/second?name=rie');    // args.queryParams['name'] -> 'rie'
 ```
 
 :::tip TIP

flutter_modular_test/CHANGELOG.md renamed to (deprecated)flutter_modular_test/CHANGELOG.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 4
 ---
 
 # Watch
@@ -25,11 +25,7 @@ Used in `ChangeNotifier/ValueNotifier` classes and in RxNotifier.
 
 - [Stream](https://api.dart.dev/stable/2.15.0/dart-async/Stream-class.html)
 
-Used in StreamController or BLoC/Cubit
-
-- [Store](https://triple.flutterando.com.br/docs/getting-started/using-flutter-triple)
-
-Used in Triple Pattern in StreamStore and NotifierStore classes.
+Used in StreamController.
 
 :::tip TIP
 
@@ -70,3 +66,19 @@ class OnlyErrorWidget extends StatelessWidget {
 }
 ```
 
+It's also possible to configure a selector directly in bind:
+
+```dart
+@override
+final List<Bind> binds = [
+  //notifier return stream or listenable to use context.watch()
+  Bind.singleton((i) => MyBloc(), selector: (bloc) => bloc.stream),
+];
+```
+
+:::tip TIP
+
+Existem `Bind` pré-configurados para BLoC e Triple.
+Veja os packages [modular_bloc_bind](https://pub.dev/packages/modular_bloc_bind) e [modular_triple_bind](https://pub.dev/packages/modular_triple_bind)
+
+:::

flutter_modular_test/LICENSE renamed to (deprecated)flutter_modular_test/LICENSE

@@ -1,3 +1,77 @@
+## [5.0.0] - 2022-04-21
+- [BREAK CHANGE]: Removed `MaterialApp.modular()` and `Cupertino().modular()`.
+  Use instead:
+  ```dart
+    return MaterialApp.router(
+      routeInformationParser: Modular.routeInformationParser,
+      routerDelegate: Modular.routerDelegate,
+    );
+
+  ```
+This modification aims to keep Modular support independent of `WidgetApp` updates, and can be used in other bootstraps such as `FluentApp [fluent_ui]`.
+
+- [BREAK CHANGE]: New auto-dispose configuration.
+Previously Modular had automatic closing or destruction calls for objects of type `ChangeNotifier/ValueNotifier`, `Stream` and Triple\`s `Stores`.
+Starting with version 5.0, Modular will provide the `Bind.onDispose` property for calls to destroy, close or dispose methods FOR EACH BIND. This will make the dispose settings more straightforward and less universal. Therefore, Modular will manage the destruction of Binds that implement `Disposable` only. This is the new configuration:
+```dart
+@override
+final List<Bind> binds = [
+  Bind.singleton((i) => MyBloc(), onDispose: (bloc) => bloc.close()),
+];
+```
+The `Bind.onDispose` CANNOT be used in Bind type factory.
+You can choose to use `Bind.onDispose` or implement the `Disposable` class.
+
+- Added `Bind.selector`. Generates a reactivity (Listenable/Stream) to be listened to when `context.watch()` is called.
+```dart
+@override
+final List<Bind> binds = [
+  //notifier return stream or listenable to use context.watch()
+  Bind.singleton((i) => MyBloc(), onDispose: (bloc) => bloc.close(), selector: (bloc) => bloc.stream),
+];
+```
+
+- [BREAK CHANGE]: As already described above, the reactivities worked externally to Modular, providing a
+longer life to the project. For this reason, BLoC or Triple users should use special `Bind's` in order to use the `context.watch()` and auto dispose functionality. They are: `BlocBind()` and `TripleBind()`, which are available through external packages.
+[modular_bloc_bind](https://pub.dev/packages/modular_bloc_bind) -> BlocBind <br>
+[modular_triple_bind](https://pub.dev/packages/modular_triple_bind) -> TripleBind
+
+Example: 
+```dart
+
+@override
+final List<Bind> binds = [
+  BlocBind.singleton((i) => MyBloc()),
+];
+```
+
+- [BREAK CHANGE] `Bind.export` works only after imported.
+- @deprecated `ModularState`.
+A few months of research showed us that ModularState caused unnecessary coupling with the view and made it difficult for those who used it to understand. For this reason, we decided to deprecate it to ensure code congruence for all professionals who use Modular.
+
+- Removed `triple` dependency.
+- Simplify docs.
+- Added `Modular.setArguments`.
+```dart
+Modular.setArguments('cody1024d');
+
+// get
+Modular.args.data; // -> cody1024d
+//or
+Bind((i) => MyClass(i.args.data));
+
+```
+
+### Issues
+
+- Fix [#615](https://github.com/Flutterando/modular/issues/615)
+- Fix [#643](https://github.com/Flutterando/modular/issues/643)
+- Fix [#644](https://github.com/Flutterando/modular/issues/644)
+- Fix [#666](https://github.com/Flutterando/modular/issues/666)
+- Fix [#668](https://github.com/Flutterando/modular/issues/668)
+- Fix [#681](https://github.com/Flutterando/modular/issues/681)
+- Fix [#694](https://github.com/Flutterando/modular/issues/694)
+
 ## [4.5.1+1] - 2022-04-05
 - Fixed `modular_core` and resolve issues [#699] [#671] [#678].
 

flutter_modular_test/README.md renamed to (deprecated)flutter_modular_test/README.md

@@ -0,0 +1,29 @@
+# This file configures the analyzer, which statically analyzes Dart code to
+# check for errors, warnings, and lints.
+#
+# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
+# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
+# invoked from the command line by running `flutter analyze`.
+
+# The following line activates a set of recommended lints for Flutter apps,
+# packages, and plugins designed to encourage good coding practices.
+include: package:flutter_lints/flutter.yaml
+
+linter:
+  # The lint rules applied to this project can be customized in the
+  # section below to disable rules from the `package:flutter_lints/flutter.yaml`
+  # included above or to enable additional rules. A list of all available lints
+  # and their documentation is published at
+  # https://dart-lang.github.io/linter/lints/index.html.
+  #
+  # Instead of disabling a lint rule for the entire project in the
+  # section below, it can also be suppressed for a single line of code
+  # or a specific dart file by using the `// ignore: name_of_lint` and
+  # `// ignore_for_file: name_of_lint` syntax on the line or in the file
+  # producing the lint.
+  rules:
+    # avoid_print: false  # Uncomment to disable the `avoid_print` rule
+    # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options

flutter_modular_test/analysis_options.yaml renamed to (deprecated)flutter_modular_test/analysis_options.yaml

@@ -9,3 +9,5 @@ GeneratedPluginRegistrant.java
 # Remember to never publicly share your keystore.
 # See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
 key.properties
+**/*.keystore
+**/*.jks

flutter_modular_test/lib/flutter_modular_test.dart renamed to (deprecated)flutter_modular_test/lib/flutter_modular_test.dart

@@ -26,17 +26,26 @@ apply plugin: 'kotlin-android'
 apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
 
 android {
-    compileSdkVersion 30
+    compileSdkVersion flutter.compileSdkVersion
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+
+    kotlinOptions {
+        jvmTarget = '1.8'
+    }
 
     sourceSets {
         main.java.srcDirs += 'src/main/kotlin'
     }
 
     defaultConfig {
         // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
-        applicationId "com.example.search"
-        minSdkVersion 16
-        targetSdkVersion 30
+        applicationId "com.example.example"
+        minSdkVersion flutter.minSdkVersion
+        targetSdkVersion flutter.targetSdkVersion
         versionCode flutterVersionCode.toInteger()
         versionName flutterVersionName
     }

flutter_modular_test/pubspec.yaml renamed to (deprecated)flutter_modular_test/pubspec.yaml

@@ -1,5 +1,5 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.example.search">
+    package="com.example.example">
     <!-- Flutter needs it to communicate with the running application
          to allow setting breakpoints, to provide hot reload, etc.
     -->

flutter_modular_test/test/flutter_modular_test_test.dart renamed to (deprecated)flutter_modular_test/test/flutter_modular_test_test.dart

@@ -1,10 +1,12 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.example.search">
+    package="com.example.example">
    <application
-        android:label="search"
+        android:label="example"
+        android:name="${applicationName}"
         android:icon="@mipmap/ic_launcher">
         <activity
             android:name=".MainActivity"
+            android:exported="true"
             android:launchMode="singleTop"
             android:theme="@style/LaunchTheme"
             android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
@@ -18,15 +20,6 @@
               android:name="io.flutter.embedding.android.NormalTheme"
               android:resource="@style/NormalTheme"
               />
-            <!-- Displays an Android View that continues showing the launch screen
-                 Drawable until Flutter paints its first frame, then this splash
-                 screen fades out. A splash screen is useful to avoid any visual
-                 gap between the end of Android's launch screen and the painting of
-                 Flutter's first frame. -->
-            <meta-data
-              android:name="io.flutter.embedding.android.SplashScreenDrawable"
-              android:resource="@drawable/launch_background"
-              />
             <intent-filter>
                 <action android:name="android.intent.action.MAIN"/>
                 <category android:name="android.intent.category.LAUNCHER"/>

doc/docs/flutter_modular/dependency-injection.md

@@ -10,7 +10,7 @@
          This theme determines the color of the Android Window while your
          Flutter UI initializes, as well as behind your Flutter UI while its
          running.
-         
+
          This Theme is only used starting with V2 of Flutter's Android embedding. -->
     <style name="NormalTheme" parent="@android:style/Theme.Black.NoTitleBar">
         <item name="android:windowBackground">?android:colorBackground</item>

doc/docs/flutter_modular/navegation.md

@@ -10,7 +10,7 @@
          This theme determines the color of the Android Window while your
          Flutter UI initializes, as well as behind your Flutter UI while its
          running.
-         
+
          This Theme is only used starting with V2 of Flutter's Android embedding. -->
     <style name="NormalTheme" parent="@android:style/Theme.Light.NoTitleBar">
         <item name="android:windowBackground">?android:colorBackground</item>

doc/docs/flutter_modular/triple-integration.md

@@ -1,5 +1,5 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.example.search">
+    package="com.example.example">
     <!-- Flutter needs it to communicate with the running application
          to allow setting breakpoints, to provide hot reload, etc.
     -->