kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity

document the instance_reader option for class_attribute

Browse source
This commit is contained in:
Vijay Dev 2011-06-20 00:36:52 +05:30
parent d0c4fd75f2
commit 427b07baa1
1 changed files with 15 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
railties/guides/source/active_support_core_extensions.textile
View file

@ -947,7 +947,7 @@ h4. Class Attributes
h5. +class_attribute+
The method +class_attribute+ declares one or more inheritable class attributes that can be overridden at any level down the hierarchy:
The method +class_attribute+ declares one or more inheritable class attributes that can be overridden at any level down the hierarchy.
<ruby>
class A
@ -983,7 +983,7 @@ self.default_params = {
}.freeze
</ruby>
They can be also accessed and overridden at the instance level:
They can be also accessed and overridden at the instance level.
<ruby>
A.x = 1
@ -996,7 +996,7 @@ a1.x # => 1, comes from A
a2.x # => 2, overridden in a2
</ruby>
The generation of the writer instance method can be prevented by setting the option +:instance_writer+ to false, as in
The generation of the writer instance method can be prevented by setting the option +:instance_writer+ to +false+.
<ruby>
module ActiveRecord
@ -1009,8 +1009,20 @@ end
A model may find that option useful as a way to prevent mass-assignment from setting the attribute.
The generation of the reader instance method can be prevented by setting the option +:instance_reader+ to +false+.
<ruby>
class A
class_attribute :x, :instance_reader => false
end
A.x = 1 # NoMethodError
</ruby>
For convenience +class_attribute+ also defines an instance predicate which is the double negation of what the instance reader returns. In the examples above it would be called +x?+.
When +:instance_reader+ is +false+, the instance predicate returns a +NoMethodError+ just like the reader method.
NOTE: Defined in +active_support/core_ext/class/attribute.rb+
h5. +cattr_reader+, +cattr_writer+, and +cattr_accessor+