Merge pull request flutter#2 from dart-lang/features

Add a zone-scoped clock and features from the old clock package

Author: nex3

CHANGELOG.md

@@ -1,3 +1,33 @@
 ## 1.0.0
 
-* Initial version.
+This release contains the `Clock` class that was defined in [`quiver`][]. It's
+backwards-compatible with the `quiver` version, and *mostly*
+backwards-compatible with the old version of the `clock` package.
+
+[`quiver`]: https://pub.dartlang.org/packages/quiver
+
+### New Features
+
+* A top-level `clock` field has been added that provides a default `Clock`
+  implementation. It can be controlled by the `withClock()` function. It should
+  generally be used in preference to manual dependency-injection, since it will
+  work with the [`fake_async`][] package.
+
+* A `Clock.stopwatch()` method has been added that creates a `Stopwatch` that
+  uses the clock as its source of time.
+
+[`fake_async`]: https://pub.dartlang.org/packages/fake_async
+
+### Changes Relative to `clock` 0.1
+
+* The top-level `new` getter and `getStopwatch()` methods are deprecated.
+  `clock.new()` and `clock.stopwatch()` should be used instead.
+
+* `Clock.getStopwatch()` is deprecated. `Clock.stopwatch()` should be used instead.
+
+* The `isFinal` argument to `withClock()` is deprecated.
+
+* `new Clock()` now takes an optional positional argument that returns the
+  current time as a `DateTime` instead of its old arguments.
+
+* `Clock.now()` is now a method rather than a getter.

README.md

@@ -15,7 +15,7 @@ import 'package:clock/clock.dart';
 
 /// Runs [callback] and prints how long it took.
 T runWithTiming<T>(T callback()) {
-  var stopwatch = clock.getStopwatch()..start();
+  var stopwatch = clock.stopwatch()..start();
   var result = callback();
   print("It took ${stopwatch.elapsed}!");
   return result;

lib/clock.dart

@@ -12,164 +12,23 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import 'src/utils.dart';
+export 'src/clock.dart';
+export 'src/default.dart';
+
+import 'src/default.dart';
 
 /// Returns current time.
 @Deprecated("Pass around an instance of Clock instead.")
 typedef DateTime TimeFunction();
 
-/// Return current system time.
+/// Returns the current system time.
 @Deprecated("Use new DateTime.now() instead.")
 DateTime systemTime() => new DateTime.now();
 
-/// A provider for the "current time" and points relative to the current time.
-///
-/// This class is designed with testability in mind. The current point in time
-/// (or [now()]) is defined by a function that returns a [DateTime]. By
-/// supplying your own time function or using [new Clock.fixed], you can control
-/// exactly what time a [Clock] returns and base your test expectations on that.
-class Clock {
-  /// The function that's called to determine this clock's notion of the current
-  /// time.
-  final DateTime Function() _time;
-
-  /// Creates a clock based on the given [currentTime], or on the system clock
-  /// by default.
-  const Clock([DateTime currentTime()]) : _time = currentTime ?? systemTime;
-
-  /// Creates [Clock] that always considers the current time to be [time].
-  Clock.fixed(DateTime time) : _time = (() => time);
-
-  /// Returns current time.
-  DateTime now() => _time();
-
-  /// Returns the point in time [Duration] amount of time ago.
-  DateTime agoBy(Duration duration) => now().subtract(duration);
-
-  /// Returns the point in time [Duration] amount of time from now.
-  DateTime fromNowBy(Duration duration) => now().add(duration);
-
-  /// Returns the point in time that's given amount of time ago.
-  ///
-  /// The amount of time is the sum of the individual parts.
-  DateTime ago(
-          {int days: 0,
-          int hours: 0,
-          int minutes: 0,
-          int seconds: 0,
-          int milliseconds: 0,
-          int microseconds: 0}) =>
-      agoBy(new Duration(
-          days: days,
-          hours: hours,
-          minutes: minutes,
-          seconds: seconds,
-          milliseconds: milliseconds,
-          microseconds: microseconds));
-
-  /// Returns the point in time that's given amount of time from now.
-  ///
-  /// The amount of time is the sum of the individual parts.
-  DateTime fromNow(
-          {int days: 0,
-          int hours: 0,
-          int minutes: 0,
-          int seconds: 0,
-          int milliseconds: 0,
-          int microseconds: 0}) =>
-      fromNowBy(new Duration(
-          days: days,
-          hours: hours,
-          minutes: minutes,
-          seconds: seconds,
-          milliseconds: milliseconds,
-          microseconds: microseconds));
-
-  /// Return the point in time [microseconds] ago.
-  DateTime microsAgo(int microseconds) => ago(microseconds: microseconds);
-
-  /// Return the point in time [microseconds] from now.
-  DateTime microsFromNow(int microseconds) =>
-      fromNow(microseconds: microseconds);
-
-  /// Return the point in time [milliseconds] ago.
-  DateTime millisAgo(int milliseconds) => ago(milliseconds: milliseconds);
-
-  /// Return the point in time [milliseconds] from now.
-  DateTime millisFromNow(int milliseconds) =>
-      fromNow(milliseconds: milliseconds);
-
-  /// Return the point in time [seconds] ago.
-  DateTime secondsAgo(int seconds) => ago(seconds: seconds);
-
-  /// Return the point in time [seconds] from now.
-  DateTime secondsFromNow(int seconds) => fromNow(seconds: seconds);
-
-  /// Return the point in time [minutes] ago.
-  DateTime minutesAgo(int minutes) => ago(minutes: minutes);
-
-  /// Return the point in time [minutes] from now.
-  DateTime minutesFromNow(int minutes) => fromNow(minutes: minutes);
-
-  /// Return the point in time [hours] ago.
-  DateTime hoursAgo(int hours) => ago(hours: hours);
-
-  /// Return the point in time [hours] from now.
-  DateTime hoursFromNow(int hours) => fromNow(hours: hours);
-
-  /// Return the point in time [days] ago.
-  DateTime daysAgo(int days) => ago(days: days);
-
-  /// Return the point in time [days] from now.
-  DateTime daysFromNow(int days) => fromNow(days: days);
-
-  /// Return the point in time [weeks] ago.
-  DateTime weeksAgo(int weeks) => ago(days: 7 * weeks);
-
-  /// Return the point in time [weeks] from now.
-  DateTime weeksFromNow(int weeks) => fromNow(days: 7 * weeks);
-
-  /// Return the point in time [months] ago on the same date.
-  ///
-  /// If the current day of the month isn't valid in the new month, the nearest
-  /// valid day in the new month will be used.
-  DateTime monthsAgo(int months) {
-    var time = now();
-    var month = (time.month - months - 1) % 12 + 1;
-    var year = time.year - (months + 12 - time.month) ~/ 12;
-    var day = clampDayOfMonth(year: year, month: month, day: time.day);
-    return new DateTime(year, month, day, time.hour, time.minute, time.second,
-        time.millisecond);
-  }
-
-  /// Return the point in time [months] from now on the same date.
-  ///
-  /// If the current day of the month isn't valid in the new month, the nearest
-  /// valid day in the new month will be used.
-  DateTime monthsFromNow(int months) {
-    var time = now();
-    var month = (time.month + months - 1) % 12 + 1;
-    var year = time.year + (months + time.month - 1) ~/ 12;
-    var day = clampDayOfMonth(year: year, month: month, day: time.day);
-    return new DateTime(year, month, day, time.hour, time.minute, time.second,
-        time.millisecond);
-  }
-
-  /// Return the point in time [years] ago on the same date.
-  ///
-  /// If the current day of the month isn't valid in the new year, the nearest
-  /// valid day in the original month will be used.
-  DateTime yearsAgo(int years) {
-    var time = now();
-    var year = time.year - years;
-    var day = clampDayOfMonth(year: year, month: time.month, day: time.day);
-    return new DateTime(year, time.month, day, time.hour, time.minute,
-        time.second, time.millisecond);
-  }
+/// Returns the current time as reported by [clock].
+@Deprecated("Use clock.now() instead.")
+DateTime get now => clock.now();
 
-  /// Return the point in time [years] from now on the same date.
-  ///
-  /// If the current day of the month isn't valid in the new year, the nearest
-  /// valid day in the original month will be used.
-  DateTime yearsFromNow(int years) => yearsAgo(-years);
-}
+/// Returns a stopwatch that uses the current time as reported by [clock].
+@Deprecated("Use clock.stopwatch() instead.")
+Stopwatch getStopwatch() => clock.stopwatch();