Merge pull request rails#45348 from tiramizoo/fix-tsrange-array-timezones

Fix supporting timezone awareness for `tsrange` array columns.

Author: yahonda

activerecord/CHANGELOG.md

@@ -1,3 +1,16 @@
+*   Fix supporting timezone awareness for `tsrange` and `tstzrange` array columns.
+
+    ```ruby
+    # In database migrations
+    add_column :shops, :open_hours, :tsrange, array: true
+    # In app config
+    ActiveRecord::Base.time_zone_aware_types += [:tsrange]
+    # In the code times are properly converted to app time zone
+    Shop.create!(open_hours: [Time.current..8.hour.from_now])
+    ```
+
+    *Wojciech Wnętrzak*
+
 *   Introduce strategy pattern for executing migrations.
 
     By default, migrations will use a strategy object that delegates the method

activerecord/lib/active_record/attribute_methods/time_zone_conversion.rb

@@ -19,6 +19,8 @@ def cast(value)
 
           if value.is_a?(Hash)
             set_time_zone_without_conversion(super)
+          elsif value.is_a?(Range)
+            Range.new(user_input_in_time_zone(value.begin), user_input_in_time_zone(value.end), value.exclude_end?)
           elsif value.respond_to?(:in_time_zone)
             begin
               super(user_input_in_time_zone(value)) || super
@@ -40,6 +42,8 @@ def convert_time_to_time_zone(value)
               value.in_time_zone
             elsif value.respond_to?(:infinite?) && value.infinite?
               value
+            elsif value.is_a?(Range)
+              Range.new(convert_time_to_time_zone(value.begin), convert_time_to_time_zone(value.end), value.exclude_end?)
             else
               map_avoiding_infinite_recursion(value) { |v| convert_time_to_time_zone(v) }
             end

activerecord/test/cases/adapters/postgresql/range_test.rb

@@ -31,7 +31,9 @@ def setup
         t.daterange :date_range
         t.numrange  :num_range
         t.tsrange   :ts_range
+        t.tsrange   :ts_ranges, array: true
         t.tstzrange :tstz_range
+        t.tstzrange :tstz_ranges, array: true
         t.int4range :int4_range
         t.int8range :int8_range
       end
@@ -187,6 +189,31 @@ def test_timezone_awareness_tzrange
     end
   end
 
+  def test_timezone_array_awareness_tzrange
+    tz = "Pacific Time (US & Canada)"
+
+    in_time_zone tz do
+      PostgresqlRange.reset_column_information
+
+      from_time_string = Time.current.to_s
+      from_time = Time.zone.parse(from_time_string)
+      to_time_string = (from_time + 1.hour).to_s
+      to_time = Time.zone.parse(to_time_string)
+
+      record = PostgresqlRange.new(tstz_ranges: [from_time_string...to_time_string, from_time_string..to_time_string])
+      assert_equal [from_time...to_time, from_time..to_time], record.tstz_ranges
+      assert_equal ActiveSupport::TimeZone[tz], record.tstz_ranges.first.begin.time_zone
+      assert_equal ActiveSupport::TimeZone[tz], record.tstz_ranges.last.begin.time_zone
+
+      record.save!
+      record.reload
+
+      assert_equal [from_time...to_time, from_time..to_time], record.tstz_ranges
+      assert_equal ActiveSupport::TimeZone[tz], record.tstz_ranges.first.begin.time_zone
+      assert_equal ActiveSupport::TimeZone[tz], record.tstz_ranges.last.begin.time_zone
+    end
+  end
+
   def test_create_tstzrange
     tstzrange = Time.parse("2010-01-01 14:30:00 +0100")...Time.parse("2011-02-02 14:30:00 CDT")
     round_trip(@new_range, :tstz_range, tstzrange)
@@ -257,6 +284,31 @@ def test_timezone_awareness_tsrange
     end
   end
 
+  def test_timezone_array_awareness_tsrange
+    tz = "Pacific Time (US & Canada)"
+
+    in_time_zone tz do
+      PostgresqlRange.reset_column_information
+
+      from_time_string = Time.current.to_s
+      from_time = Time.zone.parse(from_time_string)
+      to_time_string = (from_time + 1.hour).to_s
+      to_time = Time.zone.parse(to_time_string)
+
+      record = PostgresqlRange.new(ts_ranges: [from_time_string...to_time_string, from_time_string..to_time_string])
+      assert_equal [from_time...to_time, from_time..to_time], record.ts_ranges
+      assert_equal ActiveSupport::TimeZone[tz], record.ts_ranges.first.begin.time_zone
+      assert_equal ActiveSupport::TimeZone[tz], record.ts_ranges.last.begin.time_zone
+
+      record.save!
+      record.reload
+
+      assert_equal [from_time...to_time, from_time..to_time], record.ts_ranges
+      assert_equal ActiveSupport::TimeZone[tz], record.ts_ranges.first.begin.time_zone
+      assert_equal ActiveSupport::TimeZone[tz], record.ts_ranges.last.begin.time_zone
+    end
+  end
+
   def test_create_tstzrange_preserve_usec
     tstzrange = Time.parse("2010-01-01 14:30:00.670277 +0100")...Time.parse("2011-02-02 14:30:00.745125 CDT")
     round_trip(@new_range, :tstz_range, tstzrange)