Skip to content

Commit 401393b

Browse files
committed
Deprecate InstanceMethods namespace handling in ActiveSupport::Concern.
This avoids the unnecessary "yo dawg, I heard you like include, so I put a module that includes your module when it is included" approach when building extensions.
1 parent f312e21 commit 401393b

File tree

2 files changed

+7
-15
lines changed

2 files changed

+7
-15
lines changed

activesupport/lib/active_support/concern.rb

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,12 @@ module ActiveSupport
44
# module M
55
# def self.included(base)
66
# base.extend ClassMethods
7-
# base.send(:include, InstanceMethods)
87
# scope :disabled, where(:disabled => true)
98
# end
109
#
1110
# module ClassMethods
1211
# ...
1312
# end
14-
#
15-
# module InstanceMethods
16-
# ...
17-
# end
1813
# end
1914
#
2015
# By using <tt>ActiveSupport::Concern</tt> the above module could instead be written as:
@@ -31,10 +26,6 @@ module ActiveSupport
3126
# module ClassMethods
3227
# ...
3328
# end
34-
#
35-
# module InstanceMethods
36-
# ...
37-
# end
3829
# end
3930
#
4031
# Moreover, it gracefully handles module dependencies. Given a +Foo+ module and a +Bar+
@@ -118,7 +109,11 @@ def append_features(base)
118109
@_dependencies.each { |dep| base.send(:include, dep) }
119110
super
120111
base.extend const_get("ClassMethods") if const_defined?("ClassMethods")
121-
base.send :include, const_get("InstanceMethods") if const_defined?("InstanceMethods")
112+
if const_defined?("InstanceMethods")
113+
base.send :include, const_get("InstanceMethods")
114+
ActiveSupport::Deprecation.warn "The InstanceMethods module inside ActiveSupport::Concern will be " \
115+
"no longer included automatically. Please define instance methods directly in #{base} instead.", caller
116+
end
122117
base.class_eval(&@_included_block) if instance_variable_defined?("@_included_block")
123118
end
124119
end

activesupport/test/concern_test.rb

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,6 @@ def included_ran
1919
end
2020
end
2121

22-
module InstanceMethods
23-
end
24-
2522
included do
2623
self.included_ran = true
2724
end
@@ -74,7 +71,7 @@ def test_class_methods_are_extended
7471
def test_instance_methods_are_included
7572
@klass.send(:include, Baz)
7673
assert_equal "baz", @klass.new.baz
77-
assert @klass.included_modules.include?(ConcernTest::Baz::InstanceMethods)
74+
assert @klass.included_modules.include?(ConcernTest::Baz)
7875
end
7976

8077
def test_included_block_is_ran
@@ -92,6 +89,6 @@ def test_modules_dependencies_are_met
9289

9390
def test_dependencies_with_multiple_modules
9491
@klass.send(:include, Foo)
95-
assert_equal [ConcernTest::Foo, ConcernTest::Bar, ConcernTest::Baz::InstanceMethods, ConcernTest::Baz], @klass.included_modules[0..3]
92+
assert_equal [ConcernTest::Foo, ConcernTest::Bar, ConcernTest::Baz], @klass.included_modules[0..2]
9693
end
9794
end

0 commit comments

Comments
 (0)