Skip to content

Commit

Permalink
Use a whitelist to delegate methods to array
Browse files Browse the repository at this point in the history
  • Loading branch information
laurocaetano committed Dec 12, 2013
1 parent e87c3da commit aa85bdb
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 75 deletions.
24 changes: 6 additions & 18 deletions activerecord/lib/active_record/relation/delegation.rb
Expand Up @@ -36,7 +36,11 @@ def inherited(child_class)
# may vary depending on the klass of a relation, so we create a subclass of Relation # may vary depending on the klass of a relation, so we create a subclass of Relation
# for each different klass, and the delegations are compiled into that subclass only. # for each different klass, and the delegations are compiled into that subclass only.


delegate :to_xml, :to_yaml, :length, :collect, :map, :each, :all?, :include?, :to_ary, :to => :to_a delegate :&, :+, :[], :all?, :collect, :detect, :each, :each_cons,
:each_with_index, :flat_map, :group_by, :include?, :length,
:map, :none?, :one?, :reverse, :sample, :second, :sort, :sort_by,
:to_ary, :to_set, :to_xml, :to_yaml, :to => :to_a

delegate :table_name, :quoted_table_name, :primary_key, :quoted_primary_key, delegate :table_name, :quoted_table_name, :primary_key, :quoted_primary_key,
:connection, :columns_hash, :to => :klass :connection, :columns_hash, :to => :klass


Expand Down Expand Up @@ -84,9 +88,6 @@ def method_missing(method, *args, &block)
if @klass.respond_to?(method) if @klass.respond_to?(method)
self.class.delegate_to_scoped_klass(method) self.class.delegate_to_scoped_klass(method)
scoping { @klass.send(method, *args, &block) } scoping { @klass.send(method, *args, &block) }
elsif array_delegable?(method)
self.class.delegate method, :to => :to_a
to_a.send(method, *args, &block)
elsif arel.respond_to?(method) elsif arel.respond_to?(method)
self.class.delegate method, :to => :arel self.class.delegate method, :to => :arel
arel.send(method, *args, &block) arel.send(method, *args, &block)
Expand All @@ -109,28 +110,15 @@ def relation_class_for(klass)
end end


def respond_to?(method, include_private = false) def respond_to?(method, include_private = false)
super || array_delegable?(method) || super || @klass.respond_to?(method, include_private) ||
@klass.respond_to?(method, include_private) ||
arel.respond_to?(method, include_private) arel.respond_to?(method, include_private)
end end


protected protected


def array_delegable?(method)
defined = Array.method_defined?(method)
if defined && method.to_s.ends_with?('!')
ActiveSupport::Deprecation.warn(
"Association will no longer delegate #{method} to #to_a as of Rails 4.2. You instead must first call #to_a on the association to expose the array to be acted on."
)
end
defined
end

def method_missing(method, *args, &block) def method_missing(method, *args, &block)
if @klass.respond_to?(method) if @klass.respond_to?(method)
scoping { @klass.send(method, *args, &block) } scoping { @klass.send(method, *args, &block) }
elsif array_delegable?(method)
to_a.send(method, *args, &block)
elsif arel.respond_to?(method) elsif arel.respond_to?(method)
arel.send(method, *args, &block) arel.send(method, *args, &block)
else else
Expand Down
89 changes: 32 additions & 57 deletions activerecord/test/cases/relation/delegation_test.rb
Expand Up @@ -6,22 +6,21 @@ module ActiveRecord
class DelegationTest < ActiveRecord::TestCase class DelegationTest < ActiveRecord::TestCase
fixtures :posts fixtures :posts


def assert_responds(target, method) def call_method(target, method)
assert target.respond_to?(method) method_arity = target.to_a.method(method).arity
assert_nothing_raised do
method_arity = target.to_a.method(method).arity


if method_arity.zero? if method_arity.zero?
target.send(method)
elsif method_arity < 0
if method == :shuffle!
target.send(method) target.send(method)
elsif method_arity < 0
if method == :shuffle!
target.send(method)
else
target.send(method, 1)
end
else else
raise NotImplementedError target.send(method, 1)
end end
elsif method_arity == 1
target.send(method, 1)
else
raise NotImplementedError
end end
end end
end end
Expand All @@ -31,31 +30,20 @@ def target
Post.first.comments Post.first.comments
end end


[:map, :collect].each do |method| [:&, :+, :[], :all?, :collect, :detect, :each, :each_cons,
test "##{method} is delegated" do :each_with_index, :flat_map, :group_by, :include?, :length,
assert_responds(target, method) :map, :none?, :one?, :reverse, :sample, :second, :sort, :sort_by,
assert_equal(target.pluck(:body), target.send(method) {|post| post.body }) :to_ary, :to_set, :to_xml, :to_yaml].each do |method|
end test "association delegates #{method} to Array" do

assert_respond_to target, method
test "##{method}! is not delegated" do
assert_deprecated do
assert_responds(target, "#{method}!")
end
end end
end end


[:compact!, :flatten!, :reject!, :reverse!, :rotate!, [:compact!, :flatten!, :reject!, :reverse!, :rotate!,
:shuffle!, :slice!, :sort!, :sort_by!].each do |method| :shuffle!, :slice!, :sort!, :sort_by!, :delete_if,
test "##{method} delegation is deprecated" do :keep_if, :pop, :shift, :delete_at, :compact].each do |method|
assert_deprecated do test "#{method} is not delegated to Array" do
assert_responds(target, method) assert_raises(NoMethodError) { call_method(target, method) }
end
end
end

[:select!, :uniq!].each do |method|
test "##{method} is implemented" do
assert_responds(target, method)
end end
end end
end end
Expand All @@ -64,36 +52,23 @@ class DelegationRelationTest < DelegationTest
fixtures :comments fixtures :comments


def target def target
Comment.where(body: 'Normal type') Comment.all
end end


[:map, :collect].each do |method| [:&, :+, :[], :all?, :collect, :detect, :each, :each_cons,
test "##{method} is delegated" do :each_with_index, :flat_map, :group_by, :include?, :length,
assert_responds(target, method) :map, :none?, :one?, :reverse, :sample, :second, :sort, :sort_by,
assert_equal(target.pluck(:body), target.send(method) {|post| post.body }) :to_ary, :to_set, :to_xml, :to_yaml].each do |method|
end test "relation delegates #{method} to Array" do

assert_respond_to target, method
test "##{method}! is not delegated" do
assert_deprecated do
assert_responds(target, "#{method}!")
end
end end
end end


[:compact!, :flatten!, :reject!, :reverse!, :rotate!, [:compact!, :flatten!, :reject!, :reverse!, :rotate!,
:shuffle!, :slice!, :sort!, :sort_by!].each do |method| :shuffle!, :slice!, :sort!, :sort_by!, :delete_if,
test "##{method} delegation is deprecated" do :keep_if, :pop, :shift, :delete_at, :compact].each do |method|
assert_deprecated do test "#{method} is not delegated to Array" do
assert_responds(target, method) assert_raises(NoMethodError) { call_method(target, method) }
end
end
end

[:select!, :uniq!].each do |method|
test "##{method} triggers an immutable error" do
assert_raises ActiveRecord::ImmutableRelation do
assert_responds(target, method)
end
end end
end end
end end
Expand Down

0 comments on commit aa85bdb

Please sign in to comment.