diff options
author | Eileen M. Uchitelle <eileencodes@users.noreply.github.com> | 2017-02-04 10:02:52 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-02-04 10:02:52 -0500 |
commit | 28934172042505156f7c60ac2534dd92f32170d9 (patch) | |
tree | 183f7b1f569e53e13dc8f83fb5c3b80d766c7a35 | |
parent | d13bc5df902a2c82c3096b627830be97acbedf50 (diff) | |
parent | e014042bad65b7d017b739124b7cd0e2d8f5105b (diff) | |
download | rails-28934172042505156f7c60ac2534dd92f32170d9.tar.gz rails-28934172042505156f7c60ac2534dd92f32170d9.tar.bz2 rails-28934172042505156f7c60ac2534dd92f32170d9.zip |
Merge pull request #27898 from jaredbeck/docs_module_delegation_error
Docs: Correction: Module::DelegationError
-rw-r--r-- | activesupport/lib/active_support/core_ext/module/delegation.rb | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/activesupport/lib/active_support/core_ext/module/delegation.rb b/activesupport/lib/active_support/core_ext/module/delegation.rb index 19f692e943..d82758e40d 100644 --- a/activesupport/lib/active_support/core_ext/module/delegation.rb +++ b/activesupport/lib/active_support/core_ext/module/delegation.rb @@ -20,7 +20,8 @@ class Module # ==== Options # * <tt>:to</tt> - Specifies the target object # * <tt>:prefix</tt> - Prefixes the new method with the target name or a custom prefix - # * <tt>:allow_nil</tt> - if set to true, prevents a +NoMethodError+ from being raised + # * <tt>:allow_nil</tt> - if set to true, prevents a +Module::DelegationError+ + # from being raised # # The macro receives one or more method names (specified as symbols or # strings) and the name of the target object via the <tt>:to</tt> option @@ -112,18 +113,19 @@ class Module # invoice.customer_address # => 'Vimmersvej 13' # # If the target is +nil+ and does not respond to the delegated method a - # +NoMethodError+ is raised, as with any other value. Sometimes, however, it - # makes sense to be robust to that situation and that is the purpose of the - # <tt>:allow_nil</tt> option: If the target is not +nil+, or it is and - # responds to the method, everything works as usual. But if it is +nil+ and - # does not respond to the delegated method, +nil+ is returned. + # +Module::DelegationError+ is raised, as with any other value. Sometimes, + # however, it makes sense to be robust to that situation and that is the + # purpose of the <tt>:allow_nil</tt> option: If the target is not +nil+, or it + # is and responds to the method, everything works as usual. But if it is +nil+ + # and does not respond to the delegated method, +nil+ is returned. # # class User < ActiveRecord::Base # has_one :profile # delegate :age, to: :profile # end # - # User.new.age # raises NoMethodError: undefined method `age' + # User.new.age + # # => Module::DelegationError: User#age delegated to profile.age, but profile is nil # # But if not having a profile yet is fine and should not be an error # condition: |