Skip to content
Browse files

Add warning for Mongoid users in UPGRADING file

  • Loading branch information...
1 parent 5f54cd0 commit 486589c0a233e99e914487cb11e6ebd79a6942b1 @johnnyshields johnnyshields committed Jan 13, 2014
Showing with 7 additions and 2 deletions.
  1. +1 −1 CHANGELOG.md
  2. +6 −1 UPGRADING
View
2 CHANGELOG.md
@@ -13,7 +13,7 @@
* `by_week` always returns a calendar week (i.e. beginning Monday or as specified by Rails setting), regardless of whether Date or Fixnum is given as a parameter.
* `by_week` and `by_calendar_month` now supports optional `:start_day` option (:monday, :tuesday, etc)
* Separate `by_calendar_month` into it's own class
-* Rename `between` to `between_times` internally, as Mongoid already defines `between`. ActiveRecord has an alias of `between` to interface stays consistent.
+* Rename `between` method to `between_times` internally, as Mongoid already defines `between`. ActiveRecord has an alias of `between` so interface stays consistent.
* Add `:offset` option to all query methods, in order to offset the time the day begins/ends (for example supposing business cycle begins at 8:00 each day until 7:59:59 the next day)
* `by_weekend` can now take a fixnum (parsing logic is same as by_week)
* Two-digit year now considers 70 to be 1970, and 69 to be 2069 (was previously 40 -> 1940)
View
7 UPGRADING
@@ -1,5 +1,10 @@
Upgrading to ByStar 2.2.0
-------------------------
-Chronic gem (used for time string parsing) has been removed as a dependency for ByStar,
+
+* For Mongoid only, ByStar's `.between` method has been removed and replaced with `.between_times`
+(previously `.between_times` was an alias to `.between`). Mongoid already provides a native `.between`
+finder method that we do not want to mask. ActiveRecord users may continue to use either method.
+
+* Chronic gem (used for time string parsing) has been removed as a hard dependency for ByStar,
however it is still supported. If you would like to use Chronic with ByStar, please explicitly
include `gem chronic` into your Gemfile.

0 comments on commit 486589c

Please sign in to comment.
Something went wrong with that request. Please try again.