MONGOID-5488 - Bugfix: Date#__evolve_time__ should use the configured zone instead of Time.local (i.e. respecting Mongoid.use_activesupport_time_zone) (#5471)

* Date#__evolve_time__ should use the configured zone. Currently it uses "local" (not "UTC") which is not affected by Rails configuration.

* Make consistent with Mongoize

* Add changelog

* Update docs/release-notes/mongoid-9.0.txt

* Update docs/release-notes/mongoid-9.0.txt

* Update mongoid-9.0.txt

Co-authored-by: shields <shields@tablecheck.com>
Co-authored-by: Oleg Pudeyev <39304720+p-mongo@users.noreply.github.com>

Author: johnnyshields

docs/release-notes/mongoid-9.0.txt

@@ -40,3 +40,36 @@ any Mongoid-specific usages of this class, and change them to
 ``Mongoid::Errors::AttributeNotLoaded``. Note additionally that
 ``AttributeNotLoaded`` inherits from ``Mongoid::Errors::MongoidError``,
 while ``ActiveModel::MissingAttributeError`` does not.
+
+
+Use configured time zone to typecast Date to Time in queries
+-------------------------------------------------------------
+
+When querying for a Time field using a Date value, Mongoid now correctly
+considers the ``Mongoid.use_activesupport_time_zone`` configuration option
+to perform type conversion.
+
+.. code-block:: ruby
+
+  Mongoid.use_activesupport_time_zone = true
+
+  class Magazine
+    include Mongoid::Document
+
+    field :published_at, type: Time
+  end
+
+  Time.zone = 'Asia/Tokyo'
+
+  Magazine.gte(published_at: Date.parse('2022-09-26'))
+  #=> will return all results on or after Sept 26th, 2022
+  #   at 0:00 in Asia/Tokyo time zone.
+
+In prior Mongoid versions, the above code would ignore the
+``Mongoid.use_activesupport_time_zone`` setting and behave as if
+it were false, i.e. always using the system time zone to perform
+the type conversion.
+
+Note that in prior Mongoid versions, typecasting Date to Time during
+persistence operations was already correctly using the
+``Mongoid.use_activesupport_time_zone`` setting.

lib/mongoid/criteria/queryable/extensions/date.rb

@@ -23,9 +23,9 @@ def __evolve_date__
           # @example Evolve the date.
           #   date.__evolve_time__
           #
-          # @return [ Time ] The date as a local time.
+          # @return [ Time | ActiveSupport::TimeWithZone ] The date as a local time.
           def __evolve_time__
-            ::Time.local(year, month, day)
+            ::Time.configured.local(year, month, day)
           end
 
           module ClassMethods

spec/mongoid/criteria/queryable/extensions/date_spec.rb

@@ -25,20 +25,54 @@
 
   describe "#__evolve_time__" do
 
-    let(:date) do
-      Date.new(2010, 1, 1)
-    end
+    context "when using ActiveSupport's time zone" do
+      include_context 'using AS time zone'
 
-    let(:evolved) do
-      date.__evolve_time__
-    end
+      let(:date) do
+        Date.new(2010, 1, 1)
+      end
 
-    let(:expected) do
-      Time.local(2010, 1, 1, 0, 0, 0)
+      let(:expected_time) do
+        Time.zone.local(2010, 1, 1, 0, 0, 0, 0)
+      end
+
+      let(:evolved) do
+        date.__evolve_time__
+      end
+
+      it 'is an AS::TimeWithZone' do
+        expect(evolved.class).to eq(ActiveSupport::TimeWithZone)
+      end
+
+      it 'is equal to expected time' do
+        expect(expected_time).to be_a(ActiveSupport::TimeWithZone)
+        expect(evolved).to eq(expected_time)
+      end
     end
 
-    it "returns the time" do
-      expect(evolved).to eq(expected)
+    context "when not using ActiveSupport's time zone" do
+      include_context 'not using AS time zone'
+
+      let(:date) do
+        Date.new(2010, 1, 1)
+      end
+
+      let(:expected_time) do
+        Time.local(2010, 1, 1, 0, 0, 0, 0)
+      end
+
+      let(:evolved) do
+        date.__evolve_time__
+      end
+
+      it 'is a Time' do
+        expect(evolved.class).to eq(Time)
+      end
+
+      it 'is equal to expected time' do
+        expect(expected_time).to be_a(Time)
+        expect(evolved).to eq(expected_time)
+      end
     end
   end