Merge pull request #24385 from morgoth/deprecate-datetime_field_tag

Deprecate `datetime_field` and `datetime_field_tag` helpers.

5 files changed, 41 insertions, 9 deletions

diff --git a/actionview/CHANGELOG.md b/actionview/CHANGELOG.md
index ecc1e764a5..a1901e8a17 100644
--- a/actionview/CHANGELOG.md
+++ b/actionview/CHANGELOG.md
@@ -1,3 +1,9 @@
+*   Deprecate `datetime_field` and `datetime_field_tag` helpers.
+    Datetime input type was removed from HTML specification.
+    One can use `datetime_local_field` and `datetime_local_field_tag` instead.
+
+    *Wojciech Wnętrzak*
+
 *   Added log "Rendering ...", when starting to render a template to log that
     we have started rendering something. This helps to easily identify the origin
     of queries in the log whether they came from controller or views.
diff --git a/actionview/lib/action_view/helpers/form_helper.rb b/actionview/lib/action_view/helpers/form_helper.rb
index e91b3443c5..7ced37572e 100644
--- a/actionview/lib/action_view/helpers/form_helper.rb
+++ b/actionview/lib/action_view/helpers/form_helper.rb
@@ -1118,6 +1118,10 @@ module ActionView
       #   # => <input id="user_born_on" name="user[born_on]" type="datetime" min="2014-05-20T00:00:00.000+0000" />
       #
       def datetime_field(object_name, method, options = {})
+        ActiveSupport::Deprecation.warn(<<-MESSAGE.squish)
+          datetime_field is deprecated and will be removed in Rails 5.1.
+          Use datetime_local_field instead.
+        MESSAGE
         Tags::DatetimeField.new(object_name, method, self, options).render
       end
 
diff --git a/actionview/lib/action_view/helpers/form_tag_helper.rb b/actionview/lib/action_view/helpers/form_tag_helper.rb
index 82e9ace428..cfff0bef5d 100644
--- a/actionview/lib/action_view/helpers/form_tag_helper.rb
+++ b/actionview/lib/action_view/helpers/form_tag_helper.rb
@@ -691,6 +691,10 @@ module ActionView
       # * <tt>:step</tt> - The acceptable value granularity.
       # * Otherwise accepts the same options as text_field_tag.
       def datetime_field_tag(name, value = nil, options = {})
+        ActiveSupport::Deprecation.warn(<<-MESSAGE.squish)
+          datetime_field_tag is deprecated and will be removed in Rails 5.1.
+          Use datetime_local_field_tag instead.
+        MESSAGE
         text_field_tag(name, value, options.merge(type: :datetime))
       end
 
diff --git a/actionview/test/template/form_helper_test.rb b/actionview/test/template/form_helper_test.rb
index e77183e39f..310d0ce514 100644
--- a/actionview/test/template/form_helper_test.rb
+++ b/actionview/test/template/form_helper_test.rb
@@ -1139,13 +1139,17 @@ class FormHelperTest < ActionView::TestCase
 
   def test_datetime_field
     expected = %{<input id="post_written_on" name="post[written_on]" type="datetime" value="2004-06-15T00:00:00.000+0000" />}
-    assert_dom_equal(expected, datetime_field("post", "written_on"))
+    assert_deprecated do
+      assert_dom_equal(expected, datetime_field("post", "written_on"))
+    end
   end
 
   def test_datetime_field_with_datetime_value
     expected = %{<input id="post_written_on" name="post[written_on]" type="datetime" value="2004-06-15T01:02:03.000+0000" />}
     @post.written_on = DateTime.new(2004, 6, 15, 1, 2, 3)
-    assert_dom_equal(expected, datetime_field("post", "written_on"))
+    assert_deprecated do
+      assert_dom_equal(expected, datetime_field("post", "written_on"))
+    end
   end
 
   def test_datetime_field_with_extra_attrs
@@ -1154,20 +1158,26 @@ class FormHelperTest < ActionView::TestCase
     min_value = DateTime.new(2000, 6, 15, 20, 45, 30)
     max_value = DateTime.new(2010, 8, 15, 10, 25, 00)
     step = 60
-    assert_dom_equal(expected, datetime_field("post", "written_on", min: min_value, max: max_value, step: step))
+    assert_deprecated do
+      assert_dom_equal(expected, datetime_field("post", "written_on", min: min_value, max: max_value, step: step))
+    end
   end
 
   def test_datetime_field_with_value_attr
     expected = %{<input id="post_written_on" name="post[written_on]" type="datetime" value="2013-06-29T13:37:00+00:00" />}
     value = DateTime.new(2013,6,29,13,37)
-    assert_dom_equal(expected, datetime_field("post", "written_on", value: value))
+    assert_deprecated do
+      assert_dom_equal(expected, datetime_field("post", "written_on", value: value))
+    end
   end
 
   def test_datetime_field_with_timewithzone_value
     previous_time_zone, Time.zone = Time.zone, 'UTC'
     expected = %{<input id="post_written_on" name="post[written_on]" type="datetime" value="2004-06-15T15:30:45.000+0000" />}
     @post.written_on = Time.zone.parse('2004-06-15 15:30:45')
-    assert_dom_equal(expected, datetime_field("post", "written_on"))
+    assert_deprecated do
+      assert_dom_equal(expected, datetime_field("post", "written_on"))
+    end
   ensure
     Time.zone = previous_time_zone
   end
@@ -1175,7 +1185,9 @@ class FormHelperTest < ActionView::TestCase
   def test_datetime_field_with_nil_value
     expected = %{<input id="post_written_on" name="post[written_on]" type="datetime" />}
     @post.written_on = nil
-    assert_dom_equal(expected, datetime_field("post", "written_on"))
+    assert_deprecated do
+      assert_dom_equal(expected, datetime_field("post", "written_on"))
+    end
   end
 
   def test_datetime_field_with_string_values_for_min_and_max
@@ -1183,7 +1195,9 @@ class FormHelperTest < ActionView::TestCase
     @post.written_on = DateTime.new(2004, 6, 15, 1, 2, 3)
     min_value = "2000-06-15T20:45:30.000+0000"
     max_value = "2010-08-15T10:25:00.000+0000"
-    assert_dom_equal(expected, datetime_field("post", "written_on", min: min_value, max: max_value))
+    assert_deprecated do
+      assert_dom_equal(expected, datetime_field("post", "written_on", min: min_value, max: max_value))
+    end
   end
 
   def test_datetime_field_with_invalid_string_values_for_min_and_max
@@ -1191,7 +1205,9 @@ class FormHelperTest < ActionView::TestCase
     @post.written_on = DateTime.new(2004, 6, 15, 1, 2, 3)
     min_value = "foo"
     max_value = "bar"
-    assert_dom_equal(expected, datetime_field("post", "written_on", min: min_value, max: max_value))
+    assert_deprecated do
+      assert_dom_equal(expected, datetime_field("post", "written_on", min: min_value, max: max_value))
+    end
   end
 
   def test_datetime_local_field
diff --git a/actionview/test/template/form_tag_helper_test.rb b/actionview/test/template/form_tag_helper_test.rb
index 07b3fba754..7b93c8dc29 100644
--- a/actionview/test/template/form_tag_helper_test.rb
+++ b/actionview/test/template/form_tag_helper_test.rb
@@ -622,7 +622,9 @@ class FormTagHelperTest < ActionView::TestCase
 
   def test_datetime_field_tag
     expected = %{<input id="appointment" name="appointment" type="datetime" />}
-    assert_dom_equal(expected, datetime_field_tag("appointment"))
+    assert_deprecated do
+      assert_dom_equal(expected, datetime_field_tag("appointment"))
+    end
   end
 
   def test_datetime_local_field_tag