Deprecate passing hash as first parameter into ActionController::Head #20407

meinac · 2015-06-01T16:22:17Z

Deprecate passing hash as first parameter into ActionController::Head head method
By deprecating this, also implicit status code will be deprecated too.
See #20372 for more information.
/cc @rafaelfranca

kaspth · 2015-06-01T16:36:50Z

Shouldn't the hidden default :ok be deprecated?

rafaelfranca · 2015-06-01T16:45:33Z

Shouldn't the hidden default :ok be deprecated?

yes

meinac · 2015-06-01T19:30:42Z

I've deprecated both; passing hash as first parameter and default status code for this method. I asked this @rafaelfranca and he said deprecate both.

kaspth · 2015-06-01T21:33:54Z

Shouldn't the status key be deprecated too then?

meinac · 2015-06-01T21:38:09Z

I've already deprecated passing Hash so passing :status as a key also deprecated.

kaspth · 2015-06-01T22:04:14Z

Ah sorry, I didn't realize the code had been updated more.

meinac · 2015-06-01T22:11:04Z

@kaspth no problem bro 😄 what do you think about this pr now?

kaspth · 2015-06-02T20:03:18Z

actionpack/lib/action_controller/metal/head.rb

+        msg = "Passing Hash as first parameter"
+        options, status = status, nil
+        status ||= options.delete(:status) || (
+          (msg += " and default status code") && :ok


"Passing Hash as first parameter and default status code" doesn't make sense to me. What about and the implicit :ok status has been deprecated.?

It's okay to not have the code be completely DRY. I'd prefer making this more readable 😄

meinac · 2015-06-02T20:17:36Z

@kaspth I've updated the pr.

kaspth · 2015-06-02T20:21:41Z

actionpack/lib/action_controller/metal/head.rb

+        status ||= options.delete(:status) || (
+          (msg += " and the implicit :ok status") && :ok
+        )
+        ActiveSupport::Deprecation.warn(msg + " for `head` method has been deprecated and will be removed in Rails 5.1. Please visit http://api.rubyonrails.org/classes/ActionController/Head.html for usage.")


We should wrap this to 80 chars, right @zzak?

@kaspth there are some deprecation warnings more then 200 line length.

meinac · 2015-06-02T21:27:33Z

@kaspth I've removed doc link from the deprecation message.

kaspth · 2015-06-06T12:12:41Z

actionpack/lib/action_controller/metal/head.rb

+        status ||= options.delete(:status) || (
+          (msg += " and the implicit :ok status") && :ok
+        )
+        ActiveSupport::Deprecation.warn(msg + " for `head` method has been deprecated and will be removed in Rails 5.1.")


Actually, I don't think we need method here.

meinac · 2015-06-06T12:17:50Z

@kaspth I've removed method from deprecation warning.

kaspth · 2015-06-06T12:20:30Z

actionpack/lib/action_controller/metal/head.rb

+          (msg += " and the implicit :ok status") && :ok
+        )
+        ActiveSupport::Deprecation.warn(msg + " for `head` has been deprecated and will be removed in Rails 5.1.")
+      end


Let's simplify this to:

if status.is_a?(Hash) msg = "Passing Hash as first parameter" msg << "and the implicit :ok status" unless status.key?(:status) options, status = status, status.delete(:status) || :ok ActiveSupport::Deprecation.warn(msg + "for `head`...") end

Should also add a line break between the if status.is_a?(Hash) and location = options.delete(:location)

Just a minor nit as well, Hash#delete accepts a block, which can be used to set defaults.

E.g. status.delete(:status) { :ok }

kaspth · 2015-06-06T12:22:25Z

@rafaelfranca once my final comments have been addressed, this is ready 👍

@meinac well done 👏

meinac · 2015-06-06T12:34:39Z

@kaspth done. Thanks 💛

kaspth · 2015-06-06T12:35:17Z

actionpack/lib/action_controller/metal/head.rb

+      if status.is_a?(Hash)
+        msg = "Passing Hash as first parameter"
+        msg << " and the implicit :ok status" unless status.key?(:status)
+        options, status = status, (status.delete(:status) || :ok)


As a tiny nitpick I don't like the parens here, I understand you're worried about the execution order. Would it help to follow @gsamokovarov's suggestion and use the block version?

meinac · 2015-06-06T12:52:28Z

👍

zzak · 2015-06-07T03:16:22Z

LGTM

kaspth · 2015-06-07T07:30:20Z

I'd just hit me - we're should deprecate the status argument too, right?
head :ok, status: :no_content doesn't make sense to me.

zzak · 2015-06-07T17:01:38Z

@kaspth I thought that :no_content would be the 1st argument in this case?

kaspth · 2015-06-07T17:35:01Z

Right, I guess what I'm trying to guard against is a non issue. Though the warning says nothing about how to comply with the changes, so we should add something like: Pass the status as the first argument instead.

matthewd · 2015-06-07T23:49:36Z

I'll have a go at a more natural-sounding deprecation message after I get some sleep. But note there are two behaviour changes around nil status values here, neither of which seem to be intended... so we probably shouldn't merge as is.

kaspth · 2015-06-09T11:29:58Z

@matthewd have you come up with anything? I'm mostly drawing blanks here.

matthewd · 2015-06-09T12:18:24Z

How about:

(status[:status] ? "The :status option" : "The implicit :ok status") <<
  " on `head` has been deprecated and will be removed in Rails 5.1. Please pass the status as a separate parameter before the options, instead."

To elaborate on my previous comment, this seems to currently change the behaviour of both:

head(nil, {})
# and
head({ status: nil })

Unreasonable as those both may be, it seems unnecessary to break them while we're introducing a deprecation message.

kaspth · 2015-06-09T14:08:45Z

Completely agree that we shouldn't break them and I think your deprecation message is spot on. @meinac, are you okay with that? 😄

meinac · 2015-06-09T15:36:11Z

@kaspth I'm ok with this suggestion, I've changed the message but the line takes a little bit long 😄 I hope this is not a problem because there are some deprecation messages longer than this one.

kaspth · 2015-06-09T18:46:24Z

actionpack/lib/action_controller/metal/head.rb

+        msg = status[:status] ? 'The :status option' : 'The implicit :ok status'
+        options, status = status, status.delete(:status) { :ok }
+
+        ActiveSupport::Deprecation.warn(msg + ' on `head` has been deprecated and will be removed in Rails 5.1. Please pass the status as a separate parameter before the options, instead.')


We could use squish here to great effect:

rails/activerecord/lib/active_record/relation/predicate_builder/class_handler.rb

Lines 19 to 23 in 3179b4a

def print_deprecation_warning

ActiveSupport::Deprecation.warn(<<-MSG.squish)

Passing a class as a value in an Active Record query is deprecated and

will be removed. Pass a string instead.

MSG

meinac · 2015-06-09T21:52:35Z

@kaspth what about this one?

kaspth · 2015-06-10T06:46:00Z

@meinac that's it! Lovely ❤️

@matthewd @rafaelfranca can one of you merge this?

matthewd · 2015-06-10T12:53:33Z

Still doesn't address my concerns about nil statuses

kaspth · 2015-06-10T13:01:42Z

True, I missed that. We should handle those gracefully too.

meinac · 2015-06-10T19:10:06Z

I think in this version we've covered the nil status situation. WDYT @kaspth , @matthewd ?

matthewd · 2015-06-10T20:09:29Z

It technically won't give a warning for head(nil, {}), which we'll presumably break in 5.1... but I don't think that's something we ever supported. Just better that we do all the breaking together, rather than accidentally changing the one case now.

👍

@kaspth?

kaspth · 2015-06-15T20:03:59Z

Sounds good, now you just need to rebase @meinac 😄

meinac · 2015-06-15T20:54:36Z

@kaspth done 👍

kaspth · 2015-06-15T20:55:31Z

Great. @matthewd, you know what to do 😄

…ad_method Deprecate passing hash as first parameter into ActionController::Head

kaspth reviewed Jun 2, 2015
View reviewed changes

kaspth reviewed Jun 6, 2015
View reviewed changes

kaspth reviewed Jun 9, 2015
View reviewed changes

Deprecate passing hash as first parameter into ActionController::Head

cf81a3b

matthewd added a commit that referenced this pull request Jun 15, 2015

Merge pull request #20407 from vngrs/deprecate_implicit_status_for_he…

57941f0

…ad_method Deprecate passing hash as first parameter into ActionController::Head

matthewd merged commit 57941f0 into rails:master Jun 15, 2015

	def print_deprecation_warning
	ActiveSupport::Deprecation.warn(<<-MSG.squish)
	Passing a class as a value in an Active Record query is deprecated and
	will be removed. Pass a string instead.
	MSG

Deprecate passing hash as first parameter into ActionController::Head #20407

Deprecate passing hash as first parameter into ActionController::Head #20407

Conversation

meinac commented Jun 1, 2015

kaspth commented Jun 1, 2015

rafaelfranca commented Jun 1, 2015

meinac commented Jun 1, 2015

kaspth commented Jun 1, 2015

meinac commented Jun 1, 2015

kaspth commented Jun 1, 2015

meinac commented Jun 1, 2015

Choose a reason for hiding this comment

meinac commented Jun 2, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

meinac commented Jun 2, 2015

Choose a reason for hiding this comment

meinac commented Jun 6, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kaspth commented Jun 6, 2015

meinac commented Jun 6, 2015

Choose a reason for hiding this comment

meinac commented Jun 6, 2015

zzak commented Jun 7, 2015

kaspth commented Jun 7, 2015

zzak commented Jun 7, 2015

kaspth commented Jun 7, 2015

matthewd commented Jun 7, 2015

kaspth commented Jun 9, 2015

matthewd commented Jun 9, 2015

kaspth commented Jun 9, 2015

meinac commented Jun 9, 2015

Choose a reason for hiding this comment

meinac commented Jun 9, 2015

kaspth commented Jun 10, 2015

matthewd commented Jun 10, 2015

kaspth commented Jun 10, 2015

meinac commented Jun 10, 2015

matthewd commented Jun 10, 2015

kaspth commented Jun 15, 2015

meinac commented Jun 15, 2015

kaspth commented Jun 15, 2015