Deprecate using #quoted_id in quoting / type casting

[kamipo]

Originally quoted_id was used in legacy quoting mechanism. Now we use
type casting mechanism for that. Let's deprecate quoted_id.

[rafaelfranca]

Is this necessary here? quoted_id was not being called here.

[kamipo]

If value is an AR::Base object, using value.id has potentially a bug.
If id: :datetime, precision: 3, typed cast value should be 2017-02-14 12:34:56.789000 by quoted_date, not 2017-02-14 12:34:56 +0000.

[rafaelfranca]

If there is a potential bug in the current code we should add a test to it and fix before changing the behavior. Care to add the test?

[rafaelfranca]

We don't need to deprecate here, it is only being used to make sure it is a AR::Base object.

[kamipo]

Originally using only value.id (skipping cast_type.serialize and _type_cast) has potentially a bug.
Do we keep the return value.id without deprecating?

[rafaelfranca]

I understand the problem but in this case here quoted_id was never called and the deprecation message say it was. If using value.id is a bug we should just fix the bug and remove the deprecation.

[kamipo]

I added the test that type casting serialization and removed deprecation message.

[metaskills]

Thanks for this change. The quoted_id was a technique promoted in the SQL Server adapter to bypass global national N'string' quoting in TSQL. Now that we have the type system, using our Type::Char implicitly via simple conditions or explicitly is the right way.

[grosser]

not very helpful error message ... would be great to point out the source_location ... just ran into this without having the slightest hint on where the quote_id is coming from ... had to open up the gem to debug ...

turns out to be active_hash ... but when I remove the quote_id support then it just blows up :/

class Role < ActiveHash::Base
  undef quoted_id

...

TypeError: can't quote Role
    activerecord-5.1.0/lib/active_record/connection_adapters/abstract/quoting.rb:189:in `_quote'

so had to go through all places that use the fake AR and change them to call .id and then pass that into queries ...

[sevenseacat]

Sounds like you should file a bug with ActiveHash if the problem is there...

[rainchen]

DEPRECATION WARNING: quoted_id is deprecated and will be removed from Rails 5.2
What is the replacement method for quoted_id? the deprecation warning message is not helpful enough.

[rafaelfranca]

There is no replacement for that method. If you need to quote you id differently you need to define a different type for that column.

[pjrebsch]

@rainchen

The replacement appears to be defining a value_for_database instance method:

rails/activerecord/lib/active_record/connection_adapters/abstract/quoting.rb

Lines 9 to 19 in 8c62aab

	# Quotes the column value to help prevent
	# {SQL injection attacks}[https://en.wikipedia.org/wiki/SQL_injection].
	def quote(value)
	value = id_value_for_database(value) if value.is_a?(Base)
	if value.respond_to?(:value_for_database)
	value = value.value_for_database
	end
	_quote(value)
	end

[rafaelfranca]

No, that is not the replacement, the value_for_database is called on the column type, not in the Active Record instance. So, like I said above, the replacement is defining a different type for the column.

[pjrebsch]

Sorry, then I misunderstood the intent here.

My use case for quoted_id was to be able to pass a custom class instance which acts like an integer into an AR query without having to bother manually calling a method on it to convert it into a type that _quote expected.

Overly simplified example:

class CustomClass
  def initialize( val )
    @val = val
  end
  
  # for Rails >= 5.2
  def value_for_database
    @val.to_i
  end

  # for Rails < 5.2
  alias_method :quoted_id, :value_for_database
end

obj = CustomClass.new('2')
SomeModel.where( some_integer_column: obj )

Implementing quoted_id / value_for_database as an instance method on my custom class allows this to work without raising a "cannot quote" exception.

[leifcr]

If you need to quote you id differently you need to define a different type for that column.

@rafaelfranca Can you point in a direction for looking into definining a different type for a column? I see some AR addons are 'stuck' on 5.1 due to the quoted_id change.

[rafaelfranca]

http://api.rubyonrails.org/classes/ActiveRecord/Attributes/ClassMethods.html#method-i-attribute
http://api.rubyonrails.org/classes/ActiveRecord/Type.html
http://api.rubyonrails.org/classes/ActiveModel/Type/Value.html

rails/activemodel/lib/active_model/attribute.rb

Lines 54 to 56 in 936676d

	def value_for_database
	type.serialize(value)
	end

[leifcr]

@rafaelfranca Thanks!