his package provides a Clock class which encapsulates the notion of the "current time" and provides easy access to points relative to the current time.

This fixes a problem that analysis on pub.dev showed with the description in pubspec, and adds a small example of how to use the clock package with fake_async for testing.

I've been using the clock and fake_async packages a lot and just wrote a blog post about them. While doing that I noticed that they hadn't been updated in a while and their pub.dev score is suffering. I see in the repo that there is a new version ready to post to pub-dev but not yet done. I'm hoping this small PR helps. There are no implementation changes in this PR, just example and docs.

If you're interested in PRs like this I'll do the same for fake_async.

I'm trying to figure out who the copyright holder is for this package.

CONTRIBUTING.md instructs contributors to us a copyright in the source files of: Copyright (c) 2017, the Dart project authors. but the source files actually have copyrights for Google Inc., the pub spec has an author of "Dart Team", and the LICENSE file does not contain a copyright.

Many open source packages have a copyright statement at the beginning of the LICENSE file which is what I'd suggest if possible.

Thanks

Hello! According to the Appendix of Apache License 2.0, if you want to license your software under this License you should "attach the boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information". This condition is not met now. Please add a copyright notice in the appropriate form, including the year of the software development and your name and surname. Thank you in advance

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Consider this code:

import 'package:clock/clock.dart';
import 'package:test/test.dart';

void main() {
  final fakeClock = Clock.fixed(DateTime(2020, 1, 1));

  test('inner withClock', () {
    withClock(fakeClock, () {
      expect(clock, same(fakeClock));
    });
  });

  withClock(fakeClock, () {
    test('outer withClock', () {
      expect(clock, same(fakeClock));
    });
  });
}

I don't see anything in the withClock documentation that indicates whether one form is preferred over the other. When I run this with dart this_test.dart, I get:

00:00 +0: inner withClock
00:00 +1: outer withClock
00:00 +1 -1: outer withClock [E]

  Expected: same instance as <Instance of 'Clock'>
    Actual: <Instance of 'Clock'>

More weirdness, part 1

If I reverse the tests, they pass when running it through dart.

More weirdness, part 2

The "outer withClock" test by itself fails with flutter test or with pub run test. Each test passes individually when run directly through dart.

Ultimately I'd like to do:

withClock(fakeClock, () {
  test(...);
  test(...);
  test(...);
});

but all of this weirdness seems to prevent that.

(I'm using Dart 2.8.1 with clock 1.0.1.)

Switches linter from the deprecated Pedantic linter to Lints' recommended set. All rules are enabled, bar one - this enabled passing without any need for further code changes (although very open to discussing/fixing/amending)

Use a 2.12.0 lower bound since pub does not understand allowed experiments for earlier versions.

Use a 3.0.0 upper bound to avoid a warning in pub and to give some flexibility in publishing for stable.

This package still uses deprecated Dart 1 SCREAMING CAPS CONSTANTS. These will be removed shortly in Dart 2. This rewriting tool is available for the migration: This tool is available for the migration: https://github.com/dart-lang/dart2_fix .

Now that the analyzer correctly computes the type of int.clamp(int, int) as int (for libraries opted into null safety), we no longer need to cast the result to an int.

If flutter app starts with:

void main() {
  WidgetsFlutterBinding.ensureInitialized();

Then clock.now() prints not mocked value if outside of build method.

Minimum reproduceable code:

import 'package:clock/clock.dart';
import 'package:flutter/material.dart';

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  
  withClock(Clock.fixed(DateTime(1990)), () {
    runApp(const MyApp());
  });
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  void _printClockNow() {
    print('_printClockNow is: ${clock.now()}'); // prints real NOW
    setState(() {});
  }

  @override
  Widget build(BuildContext context) {
    print('build clock.now() is: ${clock.now()}'); // prints mocked NOW

    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[Dummy()],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _printClockNow,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}

class Dummy extends StatelessWidget {
  @override
  Widget build(Object context) {
    return Text('t: ${clock.now()}');
  }
}

Expected behavior: clock.now() to have mocked value despite WidgetsFlutterBinding.ensureInitialized()

EDIT: Changed because I discovered that culprit is WidgetsFlutterBinding.ensureInitialized().