momentum 1.2.2

momentum: ^1.2.2 copied to clipboard

• Fixed Router error that happens when persistSave is not specified.
• Fixed MomentumError doesn't override toString() so detailed error logs are not printed on the console.

• Issue #7 - Added new capability to globally disable persistent state for all models. Docs here.
• skipPersist(), by default now returns null. Not a breaking change because this method is only meant to be used by momentum internally.

• critical: fix snapshot<T>() where it throws a compile-time type error in older versions of flutter.
• added and refactored test methods.
• added new internal tests.

• Fixed #5
• Improve types system for dependency injection
• Fix extending controllers that cause bug for snapshot<T>(). Click here for the docs.
• Added internal tests.

• Changed license to BSD-3
• critical fix: reset() bug.
• fix config check bug in the "persistSave" parameter.
• (test) fixed dependOn
• added public methods for testability.
• Added internal tests.

TODO

• Add more internal tests.
• Find a workaround for issue #5
• Write docs for project-level testing.
• Refactor tests description/names.

Major changes:

• Persistent state.
• Persistent navigation/routing.
• Equatable support.
• sendEvent<T>(...) and .listen<T>(...).
• Official Documentation: https://xamdev.gq/momentum/#/

Minor changes:

• Momentum.controller<T> is now the recommended way of getting a controller using context instead of Momentum.of<T>.
• Momentum.service<T> is now the recommended way of getting a service using context instead of Momentum.getService<T>.
• enableLogging now defaults to false.

✔ No breaking changes.

• New function added: Momentum.restart(...)
  • Restart the app with a new momentum instance.
  • To easily implement, in you main.dart create a method that returns Momentum instance.

    void main() {
      runApp(momentum()); // call the method here instead of instantiating the Momentum.
    }
    
    Momentum momentum() {
      return Momentum(
        child: MyApp(),
        controllers: [
          LoginController(),
          SessionController()..config(lazy: false, enableLogging: true),
          TimerController()..config(maxTimeTravelSteps: 5),
          TimeclockController(),
          AppController()..config(lazy: false, enableLogging: true),
          SettingsController()..config(lazy: false),
        ],
        services: [
          Router([
            Login(),
            Home(),
            Settings(),
            LanguageSelection(),
            FontScale(),
          ]),
        ],
        enableLogging: false,
        onResetAll: (context, resetAll) async {
          await Momentum.of<SessionController>(context).clearSession();
          resetAll(context);
          Router.goto(context, Login);
        },
      );
    }
    

  • You can then call Momentum.restart(...) down the tree:

    Momentum.restart(context, momentum()); // call momentum() which is a top level function.
    

• New feature added: Services.

• Inject anything into momentum and use them down the tree inside widgets or controllers.

• Example code:

  // main.dart
  Momentum(
    controllers: [...],
    services: [
      ApiService(),
    ],
    child: MyApp(),
    ...
  )
  
  // *.controller.dart
  void loadUser() async {
    model.update(loadingUser: true);
    var apiService = getService<ApiService>();
    var user = await apiService.getUser(); // load data from server. asynchronous
    model.update(loadingUser: false, user: user);
  }
  

• exposed MomentumModel.controller property.

• bootstrap() method is now synchronous only.
• added bootstrapAsync() for separate asynchronous support.
• For the execution order, bootstrap() gets called first then bootstrapAsync().
• added detailed logging for both bootstrap() and bootstrapAsync() so you can see what gets executed first and the time it took.

• Fixed health check: Fix lib/src/momentum_base.dart. (-1 points)

• New feature: Asynchronous bootstrap() method now supports loading widget using appLoader parameter on Momentum root widget. If appLoader is not specified a default loading widget will be shown.
  • You have to turn lazy loading off to enable this feature.
  • Lets say one of your controllers implements bootstrap() method asynchronously and it loads a data that takes seconds to finish:

      @override
      void bootstrap() async {
        // assuming we are loading some complex and big data here.
        var appSettings = await apiService.getAppSettings();
        model.update(appSettings: appSettings);
      }
    

  • Now, imagine apiService.getAppSettings() takes 3-5 seconds to load. Before your MyApp() gets loaded, momentum will await this bootstrap method and show a loading widget until it finishes. Means, you can now do anything you want with the bootstrap() method synchronous or asynchronous. It is safe to call model.update(...) in this method.

• Reformatted the whole readme, reduce the number of headings.

• New feature: dontRebuildIf parameter for MomentumBuilder.

  • This method will be called after model.update(...) right before the builder.

  • isTimeTravel is also provided that indicates if the model was updated by time travel methods .backward() or .forward(), returning it directly means you don't want to rebuild if an update was done with the time travel method.

  • Two new properties were also added: MomentumController.prevModel and MomentumController.nextModel which are properties from model history and their meaning is quite obvious. The prevModel is the previous state and nextModel is the next state which will only have a value if you use .backward() method. If you are on the latest snapshot of the model nextModel will be null.

  • Take a look at this example, The widget is displaying a time format HH: mm and TimerController ticks every 500ms for accuracy. We only need to rebuild if minute property is changed, that's where the dontRebuildIf parameter comes.

      MomentumBuilder(
        controllers: [TimerController],
        dontRebuildIf: (controller, isTimeTravel) {
          var timer = controller<TimerController>();
          var prevMinute = timer.prevModel.dateTime.minute;
          var currentMinute = timer.model.dateTime.minute;
          var minuteUnchanged = currentMinute == prevMinute;
          return minuteUnchanged; // don't rebuild the widget if "minute" is unchanged.
        },
        builder: (context, snapshot) {...},
      )
    

  • WARNING: This method is the same as any other builder or build methods, do not call model.update(...) or anything that calls build method, for example, setState(...). You'll get an infinite loop.

• Major update:
  • updated onResetAll to support widget operation before actually resetting all models.
  • improved README added lots of new content.

• fixed typos on the readme.

• updated readme added MomentumState listener section. and also fix typos.

• fix readme not properly displaying in pub.dev

• updated example project to link the correct momentum version from pub.dev.

• updated readme, now most parts are covered.

• added example app.

• updated error message.

• Initial version.