Merge pull request #20 from sadespresso/sadespresso/fix-endof-week

fix #19, add min/max

Author: sadespresso

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.2.0
+
+- Fixed `.endOf(DurationUnit.week)` was incorrectly returning 7 days ahead [#19](https://github.com/sadespresso/moment_dart/issues/19)
+- Renamed `DateTime.to` to `.rangeTo` for clarity. Old method will be removed on the next released.
+- Added `Moment.maxValue` and `Moment.minValue`. For example, now you can use `CustomTimeRange(now, Moment.maxValue)` or `epoch.to(Moment.maxValue)`
+
 ## 2.1.0
 
 - Fixed `LocalWeekTimeRange` and `IsoWeekTimeRange`'s `to` being 1 microsecond ahead

lib/src/extensions/benefits.dart

@@ -221,11 +221,25 @@ extension MomentBenefits on DateTime {
   /// Returns [CustomTimeRange] from [this] to [other]
   ///
   /// If [this] is after [other], it will be swapped.
-  CustomTimeRange to(DateTime other) {
-    if (this <= other) return CustomTimeRange(this, other);
+  CustomTimeRange rangeTo(DateTime other) {
+    if (this < other) return CustomTimeRange(this, other);
 
     return CustomTimeRange(other, this);
   }
+
+  /// Returns [CustomTimeRange] from [this] to [other]
+  ///
+  /// If [this] is after [other], it will be swapped.
+  CustomTimeRange rangeToMax() => CustomTimeRange(this, Moment.maxValue);
+
+  /// Returns [CustomTimeRange] from [this] to [other]
+  ///
+  /// If [this] is after [other], it will be swapped.
+  @Deprecated(
+    "This will be deprecated in the next major"
+    "release. Please use [rangeTo] instead.",
+  )
+  CustomTimeRange to(DateTime other) => rangeTo(other);
 }
 
 extension MomentBenefitsPlus on Moment {

lib/src/extensions/end_of.dart

@@ -150,10 +150,7 @@ extension EndOfUnit on DateTime {
   DateTime endOfLocalWeek([int? weekStart]) {
     weekStart ??= Moment.defaultLocalization.weekStart;
 
-    int delta = (weekStart + 6) - weekday;
-    if (delta > 7) {
-      delta -= 7;
-    }
+    final int delta = (weekStart + 6 - weekday) % 7;
 
     return add(Duration(days: delta)).endOfDay();
   }

lib/src/extensions/start_of.dart

@@ -106,11 +106,7 @@ extension StartOfUnit on DateTime {
   DateTime startOfLocalWeek([int? weekStart]) {
     weekStart ??= Moment.defaultLocalization.weekStart;
 
-    int delta = weekday - weekStart;
-
-    if (delta < 0) {
-      delta += 7;
-    }
+    final int delta = (weekday - weekStart + 7) % 7;
 
     return subtract(Duration(days: delta)).startOfDay();
   }

lib/src/localization.dart

@@ -315,7 +315,7 @@ abstract class MomentLocalization {
   /// Language name in English
   String get languageNameInEnglish;
 
-  /// Start of week. For example, Monday for most countries, Sunday for weird ones
+  /// Start of week. For example, Monday for most countries, Sunday for the weird ones
   int get weekStart => DateTime.monday;
 }
 

lib/src/moment.dart

@@ -576,4 +576,9 @@ class Moment extends DateTime {
   /// epoch in UTC
   static DateTime epochUtc =
       DateTime.fromMicrosecondsSinceEpoch(0, isUtc: true);
+
+  static DateTime maxValue =
+      DateTime.fromMicrosecondsSinceEpoch(8640000000000000000);
+  static DateTime minValue =
+      DateTime.fromMicrosecondsSinceEpoch(-8640000000000000000);
 }

lib/src/time_range/day.dart

@@ -9,6 +9,8 @@ class DayTimeRange extends TimeRange with PageableRange<DayTimeRange> {
   final int month;
   final int day;
 
+  /// Please note that [hour], [minute], [second], [millisecond], [microsecond]
+  /// will be ignored.
   const DayTimeRange(
     this.year,
     this.month,

lib/src/time_range/hour.dart

@@ -10,6 +10,8 @@ class HourTimeRange extends TimeRange with PageableRange<HourTimeRange> {
   final int day;
   final int hour;
 
+  /// Please note that  [minute], [second], [millisecond], [microsecond]
+  /// will be ignored.
   const HourTimeRange(
     this.year,
     this.month,

lib/src/time_range/month.dart

@@ -8,6 +8,8 @@ class MonthTimeRange extends TimeRange with PageableRange<MonthTimeRange> {
   final int year;
   final int month;
 
+  /// Please note that [day], [hour], [minute], [second], [millisecond], [microsecond]
+  /// will be ignored.
   const MonthTimeRange(
     this.year,
     this.month, {

lib/src/time_range/week.dart

@@ -6,6 +6,7 @@ class LocalWeekTimeRange extends CustomTimeRange
     implements PageableRange<LocalWeekTimeRange> {
   final int? weekStart;
 
+  /// from `.startOfLocalWeek` to `.endOfLocalWeek`, inclusive
   LocalWeekTimeRange(DateTime dateTime, [this.weekStart])
       : super(
           dateTime.startOfLocalWeek(weekStart),

lib/src/time_range/year.dart

@@ -13,6 +13,9 @@ class YearTimeRange extends TimeRange with PageableRange<YearTimeRange> {
   });
 
   /// Will preserve the timezone of [dateTime]
+  ///
+  /// Please note that [month], [day], [hour], [minute], [second], [millisecond], [microsecond]
+  /// will be ignored.
   factory YearTimeRange.fromDateTime(DateTime dateTime) =>
       YearTimeRange(dateTime.year, isUtc: dateTime.isUtc);
 

pubspec.yaml

@@ -1,6 +1,6 @@
 name: moment_dart
 description: Multi-purpose immutable DateTime subclass. Supports multiple localizations to easily convert DateTime and Duration into human-readable format
-version: 2.1.0
+version: 2.2.0
 homepage: https://github.com/sadespresso/moment_dart
 issue_tracker: https://github.com/sadespresso/moment_dart/issues
 funding: