Merge pull request #7 from yjbanov/master
Test-friendy time providers and utilities
diff --git a/lib/clock.dart b/lib/clock.dart
new file mode 100644
index 0000000..933dee8
--- /dev/null
+++ b/lib/clock.dart
@@ -0,0 +1,166 @@
+// Copyright 2013 Google Inc. All Rights Reserved.
+//
+// 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.
+
+part of quiver.time;
+
+/// Returns current time.
+typedef DateTime TimeFunction();
+
+/// Return current system time.
+DateTime systemTime() => new DateTime.now();
+
+/// A predefined instance of [Clock] that's based on system clock.
+const SYSTEM_CLOCK = const Clock();
+
+/// Provides points in time relative to the current point in time, for example:
+/// now, 2 days ago, 4 weeks from now, etc.
+///
+/// This class is designed with testability in mind. The current point in time
+/// (or [now()]) is defined by a [TimeFunction]. By supplying your own time
+/// function or by using fixed clock (see constructors), you can control
+/// exactly what time a [Clock] returns and base your test expectations on
+/// that. See specific constructors for how to supply time functions.
+class Clock {
+
+ final TimeFunction _time;
+
+ /// Creates a clock based on the given [timeFunc].
+ ///
+ /// If [timeFunc] is not provided, creates [Clock] based on system clock.
+ ///
+ /// Custom [timeFunc] can be useful in unit-tests. For example, you might
+ /// want to control what time it is now and set date and time expectations in
+ /// your test cases.
+ const Clock([TimeFunction timeFunc = systemTime]) : _time = timeFunc;
+
+ /// Creates [Clock] that returns fixed [time] value. Useful in unit-tests.
+ 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 individual parts. Parts are compatible with
+ /// ones defined in [Duration].
+ 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 individual parts. Parts are compatible with
+ /// ones defined in [Duration].
+ 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 [micros] microseconds ago.
+ DateTime microsAgo(int micros) => ago(microseconds: micros);
+
+ /// Return the point in time [micros] microseconds from now.
+ DateTime microsFromNow(int micros) => fromNow(microseconds: micros);
+
+ /// Return the point in time [millis] milliseconds ago.
+ DateTime millisAgo(int millis) => ago(milliseconds: millis);
+
+ /// Return the point in time [millis] milliseconds from now.
+ DateTime millisFromNow(int millis) => fromNow(milliseconds: millis);
+
+ /// 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.
+ DateTime monthsAgo(int months) {
+ var time = now();
+ return new DateTime(
+ time.year,
+ time.month - months,
+ time.day,
+ time.hour,
+ time.minute,
+ time.second,
+ time.millisecond
+ );
+ }
+
+ /// Return the point in time [months] from now on the same date.
+ DateTime monthsFromNow(int months) => monthsAgo(-months);
+
+ /// Return the point in time [years] ago on the same date.
+ DateTime yearsAgo(int years) {
+ var time = now();
+ return new DateTime(
+ time.year - years,
+ time.month,
+ time.day,
+ time.hour,
+ time.minute,
+ time.second,
+ time.millisecond
+ );
+ }
+
+ /// Return the point in time [years] from now on the same date.
+ DateTime yearsFromNow(int years) => yearsAgo(-years);
+}
diff --git a/test/clock_test.dart b/test/clock_test.dart
new file mode 100644
index 0000000..a9e3bc6
--- /dev/null
+++ b/test/clock_test.dart
@@ -0,0 +1,204 @@
+// Copyright 2013 Google Inc. All Rights Reserved.
+//
+// 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.
+
+library quiver.time.clock_test;
+
+import 'package:unittest/unittest.dart';
+import 'package:quiver/time.dart';
+
+main() {
+ group('clock', () {
+ var subject = new Clock.fixed(new DateTime(2013));
+
+ test("should return a non-null value from system clock", () {
+ expect(new Clock().now(), isNotNull);
+ expect(SYSTEM_CLOCK.now(), isNotNull);
+ });
+
+ // This test may be flaky on certain systems. I ran it over 10 million
+ // cycles on my machine without any failures, but that's no guarantee.
+ test("should be close enough to system clock", () {
+ // I picked 2ms because 1ms was starting to get flaky.
+ var epsilon = 2;
+ expect(new DateTime.now().difference(
+ new Clock().now()).inMilliseconds.abs(),
+ lessThan(epsilon));
+ expect(new DateTime.now().difference(
+ SYSTEM_CLOCK.now()).inMilliseconds.abs(),
+ lessThan(epsilon));
+ });
+
+ test("should return time provided by custom TimeFunction", () {
+ var time = new DateTime(2013);
+ var fixedClock = new Clock(() => time);
+ expect(fixedClock.now(), new DateTime(2013));
+
+ time = new DateTime(2014);
+ expect(fixedClock.now(), new DateTime(2014));
+ });
+
+ test("should return fixed time", () {
+ expect(new Clock.fixed(new DateTime(2013)).now(), new DateTime(2013));
+ });
+
+ test("should return time Duration ago", () {
+ expect(subject.agoBy(new Duration(days: 366)), new DateTime(2012));
+ });
+
+ test("should return time Duration from now", () {
+ expect(subject.fromNowBy(new Duration(days: 365)), new DateTime(2014));
+ });
+
+ test("should return time parts ago", () {
+ expect(subject.ago(
+ days: 1,
+ hours: 1,
+ minutes: 1,
+ seconds: 1,
+ milliseconds: 1,
+ microseconds: 1000), new DateTime(2012, 12, 30, 22, 58, 58, 998));
+ });
+
+ test("should return time parts from now", () {
+ expect(subject.fromNow(
+ days: 1,
+ hours: 1,
+ minutes: 1,
+ seconds: 1,
+ milliseconds: 1,
+ microseconds: 1000), new DateTime(2013, 1, 2, 1, 1, 1, 2));
+ });
+
+ test("should return time micros ago", () {
+ expect(subject.microsAgo(1000),
+ new DateTime(2012, 12, 31, 23, 59, 59, 999));
+ });
+
+ test("should return time micros from now", () {
+ expect(subject.microsFromNow(1000),
+ new DateTime(2013, 1, 1, 0, 0, 0, 1));
+ });
+
+ test("should return time millis ago", () {
+ expect(subject.millisAgo(1000),
+ new DateTime(2012, 12, 31, 23, 59, 59, 000));
+ });
+
+ test("should return time millis from now", () {
+ expect(subject.millisFromNow(3),
+ new DateTime(2013, 1, 1, 0, 0, 0, 3));
+ });
+
+ test("should return time seconds ago", () {
+ expect(subject.secondsAgo(10),
+ new DateTime(2012, 12, 31, 23, 59, 50, 000));
+ });
+
+ test("should return time seconds from now", () {
+ expect(subject.secondsFromNow(3),
+ new DateTime(2013, 1, 1, 0, 0, 3, 0));
+ });
+
+ test("should return time minutes ago", () {
+ expect(subject.minutesAgo(10),
+ new DateTime(2012, 12, 31, 23, 50, 0, 000));
+ });
+
+ test("should return time minutes from now", () {
+ expect(subject.minutesFromNow(3),
+ new DateTime(2013, 1, 1, 0, 3, 0, 0));
+ });
+
+ test("should return time hours ago", () {
+ expect(subject.hoursAgo(10),
+ new DateTime(2012, 12, 31, 14, 0, 0, 000));
+ });
+
+ test("should return time hours from now", () {
+ expect(subject.hoursFromNow(3),
+ new DateTime(2013, 1, 1, 3, 0, 0, 0));
+ });
+
+ test("should return time days ago", () {
+ expect(subject.daysAgo(10),
+ new DateTime(2012, 12, 22, 0, 0, 0, 000));
+ });
+
+ test("should return time days from now", () {
+ expect(subject.daysFromNow(3),
+ new DateTime(2013, 1, 4, 0, 0, 0, 0));
+ });
+
+ test("should return time months ago on the same date", () {
+ expect(subject.monthsAgo(1),
+ new DateTime(2012, 12, 1, 0, 0, 0, 000));
+ expect(subject.monthsAgo(2),
+ new DateTime(2012, 11, 1, 0, 0, 0, 000));
+ expect(subject.monthsAgo(3),
+ new DateTime(2012, 10, 1, 0, 0, 0, 000));
+ expect(subject.monthsAgo(4),
+ new DateTime(2012, 9, 1, 0, 0, 0, 000));
+ });
+
+ test("should return time months from now on the same date", () {
+ expect(subject.monthsFromNow(1),
+ new DateTime(2013, 2, 1, 0, 0, 0, 0));
+ expect(subject.monthsFromNow(2),
+ new DateTime(2013, 3, 1, 0, 0, 0, 0));
+ expect(subject.monthsFromNow(3),
+ new DateTime(2013, 4, 1, 0, 0, 0, 0));
+ expect(subject.monthsFromNow(4),
+ new DateTime(2013, 5, 1, 0, 0, 0, 0));
+ });
+
+ test("should return time years ago on the same date", () {
+ expect(subject.yearsAgo(1),
+ new DateTime(2012, 1, 1, 0, 0, 0, 000)); // leap year
+ expect(subject.yearsAgo(2),
+ new DateTime(2011, 1, 1, 0, 0, 0, 000));
+ expect(subject.yearsAgo(3),
+ new DateTime(2010, 1, 1, 0, 0, 0, 000));
+ expect(subject.yearsAgo(4),
+ new DateTime(2009, 1, 1, 0, 0, 0, 000));
+ expect(subject.yearsAgo(5),
+ new DateTime(2008, 1, 1, 0, 0, 0, 000)); // leap year
+ expect(subject.yearsAgo(6),
+ new DateTime(2007, 1, 1, 0, 0, 0, 000));
+ expect(subject.yearsAgo(30),
+ new DateTime(1983, 1, 1, 0, 0, 0, 000));
+ expect(subject.yearsAgo(2013),
+ new DateTime(0, 1, 1, 0, 0, 0, 000));
+ });
+
+ test("should return time years from now on the same date", () {
+ expect(subject.yearsFromNow(1),
+ new DateTime(2014, 1, 1, 0, 0, 0, 0));
+ expect(subject.yearsFromNow(2),
+ new DateTime(2015, 1, 1, 0, 0, 0, 0));
+ expect(subject.yearsFromNow(3),
+ new DateTime(2016, 1, 1, 0, 0, 0, 0));
+ expect(subject.yearsFromNow(4),
+ new DateTime(2017, 1, 1, 0, 0, 0, 0));
+ expect(subject.yearsFromNow(5),
+ new DateTime(2018, 1, 1, 0, 0, 0, 0));
+ expect(subject.yearsFromNow(6),
+ new DateTime(2019, 1, 1, 0, 0, 0, 0));
+ expect(subject.yearsFromNow(30),
+ new DateTime(2043, 1, 1, 0, 0, 0, 0));
+ expect(subject.yearsFromNow(1000),
+ new DateTime(3013, 1, 1, 0, 0, 0, 0));
+ });
+
+ });
+}
