github/rails
1
1
Fork 0
mirror of https://github.com/github/rails.git synced 2026-04-26 03:00:59 -04:00
Code Issues Packages Projects Releases Wiki 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
committed by Xavier Noria
parent 98ae4821bb
commit f2d18b83ad
1 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -961,7 +961,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
@@ -997,7 +997,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
@@ -1010,7 +1010,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
@@ -1023,8 +1023,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+