提交 06f06750 编写于 作者: T Tomas Valent

add private: true option for ActiveSupport delegate

上级 87de79e9
## Rails 6.0.0.alpha (Unreleased) ##
* Add `private: true` option to ActiveSupport's `delegate`.
In order to delegate methods as private methods:
class User < ActiveRecord::Base
has_one :profile
delegate :date_of_birth, to: :profile, private: true
def age
Date.today.year - date_of_birth.year
end
end
# User.new.age # => 29
# User.new.date_of_birth
# => NoMethodError: private method `date_of_birth' called for #<User:0x00000008221340>
More information in #31944.
*Tomas Valent*
* Return all mappings for a timezone identifier in `country_zones`
Some timezones like `Europe/London` have multiple mappings in
`ActiveSupport::TimeZone::MAPPING` so return all of them instead
of the first one found by using `Hash#value`. e.g:
# Before
ActiveSupport::TimeZone.country_zones("GB") # => ["Edinburgh"]
# After
ActiveSupport::TimeZone.country_zones("GB") # => ["Edinburgh", "London"]
Fixes #31668.
*Andrew White*
* `String#truncate_bytes` to truncate a string to a maximum bytesize without
breaking multibyte characters or grapheme clusters like 👩‍👩‍👦‍👦.
......
......@@ -114,6 +114,24 @@ class DelegationError < NoMethodError; end
# invoice.customer_name # => 'John Doe'
# invoice.customer_address # => 'Vimmersvej 13'
#
# If you want the delegated method to be a private method,
# use the <tt>:private</tt> option.
#
# class User < ActiveRecord::Base
# has_one :profile
# delegate :first_name, to: :profile
# delegate :date_of_birth, :religion, to: :profile, private: true
#
# def age
# Date.today.year - date_of_birth.year
# end
# end
#
# User.new.age # 2
# User.new.first_name # Tomas
# User.new.date_of_birth # NoMethodError: private method `date_of_birth' called for #<User:0x00000008221340>
# User.new.religion # NoMethodError: private method `religion' called for #<User:0x00000008221340>
#
# If the target is +nil+ and does not respond to the delegated method a
# +Module::DelegationError+ is raised. If you wish to instead return +nil+,
# use the <tt>:allow_nil</tt> option.
......@@ -151,7 +169,7 @@ class DelegationError < NoMethodError; end
# Foo.new("Bar").name # raises NoMethodError: undefined method `name'
#
# The target method must be public, otherwise it will raise +NoMethodError+.
def delegate(*methods, to: nil, prefix: nil, allow_nil: nil)
def delegate(*methods, to: nil, prefix: nil, allow_nil: nil, private: nil)
unless to
raise ArgumentError, "Delegation needs a target. Supply an options hash with a :to key as the last argument (e.g. delegate :hello, to: :greeter)."
end
......@@ -173,7 +191,7 @@ def delegate(*methods, to: nil, prefix: nil, allow_nil: nil)
to = to.to_s
to = "self.#{to}" if DELEGATION_RESERVED_METHOD_NAMES.include?(to)
methods.map do |method|
method_names = methods.map do |method|
# Attribute writer methods only accept one argument. Makes sure []=
# methods still accept two arguments.
definition = /[^\]]=$/.match?(method) ? "arg" : "*args, &block"
......@@ -213,6 +231,9 @@ def delegate(*methods, to: nil, prefix: nil, allow_nil: nil)
module_eval(method_def, file, line)
end
private(*method_names) if private
method_names
end
# When building decorators, a common pattern may emerge:
......
......@@ -440,4 +440,61 @@ def initialize(place)
assert_not_respond_to place, :the_city
assert place.respond_to?(:the_city, true)
end
def test_private_delegate_with_private_option
location = Class.new do
def initialize(place)
@place = place
end
delegate(:street, :city, to: :@place, private: true)
end
place = location.new(Somewhere.new("Such street", "Sad city"))
assert_not_respond_to place, :street
assert_not_respond_to place, :city
assert place.respond_to?(:street, true) # Asking for private method
assert place.respond_to?(:city, true)
end
def test_some_public_some_private_delegate_with_private_option
location = Class.new do
def initialize(place)
@place = place
end
delegate(:street, to: :@place)
delegate(:city, to: :@place, private: true)
end
place = location.new(Somewhere.new("Such street", "Sad city"))
assert_respond_to place, :street
assert_not_respond_to place, :city
assert place.respond_to?(:city, true) # Asking for private method
end
def test_private_delegate_prefixed_with_private_option
location = Class.new do
def initialize(place)
@place = place
end
end
assert_equal %i(the_street the_city),
location.delegate(:street, :city, to: :@place, prefix: :the, private: true)
place = location.new(Somewhere.new("Such street", "Sad city"))
assert_not_respond_to place, :street
assert_not_respond_to place, :city
assert_not_respond_to place, :the_street
assert place.respond_to?(:the_street, true)
assert_not_respond_to place, :the_city
assert place.respond_to?(:the_city, true)
end
end
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册