rails 3.2.22.2 → 4.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/README.md +85 -0
- data/guides/CHANGELOG.md +31 -0
- data/guides/Rakefile +79 -0
- data/guides/assets/images/akshaysurve.jpg +0 -0
- data/guides/assets/images/belongs_to.png +0 -0
- data/guides/assets/images/book_icon.gif +0 -0
- data/guides/assets/images/bullet.gif +0 -0
- data/guides/assets/images/chapters_icon.gif +0 -0
- data/guides/assets/images/check_bullet.gif +0 -0
- data/guides/assets/images/credits_pic_blank.gif +0 -0
- data/guides/assets/images/csrf.png +0 -0
- data/guides/assets/images/edge_badge.png +0 -0
- data/guides/assets/images/favicon.ico +0 -0
- data/guides/assets/images/feature_tile.gif +0 -0
- data/guides/assets/images/footer_tile.gif +0 -0
- data/guides/assets/images/fxn.png +0 -0
- data/guides/assets/images/getting_started/article_with_comments.png +0 -0
- data/guides/assets/images/getting_started/challenge.png +0 -0
- data/guides/assets/images/getting_started/confirm_dialog.png +0 -0
- data/guides/assets/images/getting_started/forbidden_attributes_for_new_article.png +0 -0
- data/guides/assets/images/getting_started/form_with_errors.png +0 -0
- data/guides/assets/images/getting_started/index_action_with_edit_link.png +0 -0
- data/guides/assets/images/getting_started/new_article.png +0 -0
- data/guides/assets/images/getting_started/rails_welcome.png +0 -0
- data/guides/assets/images/getting_started/routing_error_no_controller.png +0 -0
- data/guides/assets/images/getting_started/routing_error_no_route_matches.png +0 -0
- data/guides/assets/images/getting_started/show_action_for_articles.png +0 -0
- data/guides/assets/images/getting_started/template_is_missing_articles_new.png +0 -0
- data/guides/assets/images/getting_started/unknown_action_create_for_articles.png +0 -0
- data/guides/assets/images/getting_started/unknown_action_new_for_articles.png +0 -0
- data/guides/assets/images/grey_bullet.gif +0 -0
- data/guides/assets/images/habtm.png +0 -0
- data/guides/assets/images/has_many.png +0 -0
- data/guides/assets/images/has_many_through.png +0 -0
- data/guides/assets/images/has_one.png +0 -0
- data/guides/assets/images/has_one_through.png +0 -0
- data/guides/assets/images/header_backdrop.png +0 -0
- data/guides/assets/images/header_tile.gif +0 -0
- data/guides/assets/images/i18n/demo_html_safe.png +0 -0
- data/guides/assets/images/i18n/demo_localized_pirate.png +0 -0
- data/guides/assets/images/i18n/demo_translated_en.png +0 -0
- data/guides/assets/images/i18n/demo_translated_pirate.png +0 -0
- data/guides/assets/images/i18n/demo_translation_missing.png +0 -0
- data/guides/assets/images/i18n/demo_untranslated.png +0 -0
- data/guides/assets/images/icons/README +5 -0
- data/guides/assets/images/icons/callouts/1.png +0 -0
- data/guides/assets/images/icons/callouts/10.png +0 -0
- data/guides/assets/images/icons/callouts/11.png +0 -0
- data/guides/assets/images/icons/callouts/12.png +0 -0
- data/guides/assets/images/icons/callouts/13.png +0 -0
- data/guides/assets/images/icons/callouts/14.png +0 -0
- data/guides/assets/images/icons/callouts/15.png +0 -0
- data/guides/assets/images/icons/callouts/2.png +0 -0
- data/guides/assets/images/icons/callouts/3.png +0 -0
- data/guides/assets/images/icons/callouts/4.png +0 -0
- data/guides/assets/images/icons/callouts/5.png +0 -0
- data/guides/assets/images/icons/callouts/6.png +0 -0
- data/guides/assets/images/icons/callouts/7.png +0 -0
- data/guides/assets/images/icons/callouts/8.png +0 -0
- data/guides/assets/images/icons/callouts/9.png +0 -0
- data/guides/assets/images/icons/caution.png +0 -0
- data/guides/assets/images/icons/example.png +0 -0
- data/guides/assets/images/icons/home.png +0 -0
- data/guides/assets/images/icons/important.png +0 -0
- data/guides/assets/images/icons/next.png +0 -0
- data/guides/assets/images/icons/note.png +0 -0
- data/guides/assets/images/icons/prev.png +0 -0
- data/guides/assets/images/icons/tip.png +0 -0
- data/guides/assets/images/icons/up.png +0 -0
- data/guides/assets/images/icons/warning.png +0 -0
- data/guides/assets/images/nav_arrow.gif +0 -0
- data/guides/assets/images/oscardelben.jpg +0 -0
- data/guides/assets/images/polymorphic.png +0 -0
- data/guides/assets/images/radar.png +0 -0
- data/guides/assets/images/rails4_features.png +0 -0
- data/guides/assets/images/rails_guides_kindle_cover.jpg +0 -0
- data/guides/assets/images/rails_guides_logo.gif +0 -0
- data/guides/assets/images/rails_logo_remix.gif +0 -0
- data/guides/assets/images/session_fixation.png +0 -0
- data/guides/assets/images/tab_grey.gif +0 -0
- data/guides/assets/images/tab_info.gif +0 -0
- data/guides/assets/images/tab_note.gif +0 -0
- data/guides/assets/images/tab_red.gif +0 -0
- data/guides/assets/images/tab_yellow.gif +0 -0
- data/guides/assets/images/tab_yellow.png +0 -0
- data/guides/assets/images/vijaydev.jpg +0 -0
- data/guides/assets/javascripts/guides.js +59 -0
- data/guides/assets/javascripts/jquery.min.js +4 -0
- data/guides/assets/javascripts/responsive-tables.js +43 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushAS3.js +59 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushAppleScript.js +75 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushBash.js +59 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushCSharp.js +65 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushColdFusion.js +100 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushCpp.js +97 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushCss.js +91 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushDelphi.js +55 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushDiff.js +41 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushErlang.js +52 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushGroovy.js +67 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushJScript.js +52 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushJava.js +57 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushJavaFX.js +58 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushPerl.js +72 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushPhp.js +88 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushPlain.js +33 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushPowerShell.js +74 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushPython.js +64 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushRuby.js +55 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushSass.js +94 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushScala.js +51 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushSql.js +66 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushVb.js +56 -0
- data/guides/assets/javascripts/syntaxhighlighter/shBrushXml.js +69 -0
- data/guides/assets/javascripts/syntaxhighlighter/shCore.js +17 -0
- data/guides/assets/stylesheets/fixes.css +16 -0
- data/guides/assets/stylesheets/kindle.css +11 -0
- data/guides/assets/stylesheets/main.css +713 -0
- data/guides/assets/stylesheets/print.css +52 -0
- data/guides/assets/stylesheets/reset.css +43 -0
- data/guides/assets/stylesheets/responsive-tables.css +50 -0
- data/guides/assets/stylesheets/style.css +13 -0
- data/guides/assets/stylesheets/syntaxhighlighter/shCore.css +226 -0
- data/guides/assets/stylesheets/syntaxhighlighter/shCoreDefault.css +328 -0
- data/guides/assets/stylesheets/syntaxhighlighter/shCoreDjango.css +331 -0
- data/guides/assets/stylesheets/syntaxhighlighter/shCoreEclipse.css +339 -0
- data/guides/assets/stylesheets/syntaxhighlighter/shCoreEmacs.css +324 -0
- data/guides/assets/stylesheets/syntaxhighlighter/shCoreFadeToGrey.css +328 -0
- data/guides/assets/stylesheets/syntaxhighlighter/shCoreMDUltra.css +324 -0
- data/guides/assets/stylesheets/syntaxhighlighter/shCoreMidnight.css +324 -0
- data/guides/assets/stylesheets/syntaxhighlighter/shCoreRDark.css +324 -0
- data/guides/assets/stylesheets/syntaxhighlighter/shThemeDefault.css +117 -0
- data/guides/assets/stylesheets/syntaxhighlighter/shThemeDjango.css +120 -0
- data/guides/assets/stylesheets/syntaxhighlighter/shThemeEclipse.css +128 -0
- data/guides/assets/stylesheets/syntaxhighlighter/shThemeEmacs.css +113 -0
- data/guides/assets/stylesheets/syntaxhighlighter/shThemeFadeToGrey.css +117 -0
- data/guides/assets/stylesheets/syntaxhighlighter/shThemeMDUltra.css +113 -0
- data/guides/assets/stylesheets/syntaxhighlighter/shThemeMidnight.css +113 -0
- data/guides/assets/stylesheets/syntaxhighlighter/shThemeRDark.css +113 -0
- data/guides/assets/stylesheets/syntaxhighlighter/shThemeRailsGuides.css +116 -0
- data/guides/bug_report_templates/action_controller_gem.rb +47 -0
- data/guides/bug_report_templates/action_controller_master.rb +54 -0
- data/guides/bug_report_templates/active_record_gem.rb +40 -0
- data/guides/bug_report_templates/active_record_master.rb +49 -0
- data/guides/rails_guides/generator.rb +248 -0
- data/guides/rails_guides/helpers.rb +53 -0
- data/guides/rails_guides/indexer.rb +68 -0
- data/guides/rails_guides/kindle.rb +119 -0
- data/guides/rails_guides/levenshtein.rb +39 -0
- data/guides/rails_guides/markdown/renderer.rb +82 -0
- data/guides/rails_guides/markdown.rb +167 -0
- data/guides/rails_guides.rb +63 -0
- data/guides/source/2_2_release_notes.md +435 -0
- data/guides/source/2_3_release_notes.md +621 -0
- data/guides/source/3_0_release_notes.md +611 -0
- data/guides/source/3_1_release_notes.md +559 -0
- data/guides/source/3_2_release_notes.md +568 -0
- data/guides/source/4_0_release_notes.md +279 -0
- data/guides/source/4_1_release_notes.md +730 -0
- data/guides/source/4_2_release_notes.md +850 -0
- data/guides/source/_license.html.erb +2 -0
- data/guides/source/_welcome.html.erb +19 -0
- data/guides/source/action_controller_overview.md +1249 -0
- data/guides/source/action_mailer_basics.md +752 -0
- data/guides/source/action_view_overview.md +1620 -0
- data/guides/source/active_job_basics.md +318 -0
- data/guides/source/active_model_basics.md +554 -0
- data/guides/source/active_record_basics.md +374 -0
- data/guides/source/active_record_callbacks.md +413 -0
- data/guides/source/active_record_migrations.md +1018 -0
- data/guides/source/active_record_postgresql.md +433 -0
- data/guides/source/active_record_querying.md +1783 -0
- data/guides/source/active_record_validations.md +1178 -0
- data/guides/source/active_support_core_extensions.md +3904 -0
- data/guides/source/active_support_instrumentation.md +499 -0
- data/guides/source/api_documentation_guidelines.md +361 -0
- data/guides/source/asset_pipeline.md +1360 -0
- data/guides/source/association_basics.md +2236 -0
- data/guides/source/caching_with_rails.md +379 -0
- data/guides/source/command_line.md +625 -0
- data/guides/source/configuring.md +1045 -0
- data/guides/source/constant_autoloading_and_reloading.md +1297 -0
- data/guides/source/contributing_to_ruby_on_rails.md +624 -0
- data/guides/source/credits.html.erb +80 -0
- data/guides/source/debugging_rails_applications.md +861 -0
- data/guides/source/development_dependencies_install.md +289 -0
- data/guides/source/documents.yaml +205 -0
- data/guides/source/engines.md +1412 -0
- data/guides/source/form_helpers.md +1024 -0
- data/guides/source/generators.md +676 -0
- data/guides/source/getting_started.md +2085 -0
- data/guides/source/i18n.md +1086 -0
- data/guides/source/index.html.erb +28 -0
- data/guides/source/initialization.md +704 -0
- data/guides/source/kindle/copyright.html.erb +1 -0
- data/guides/source/kindle/layout.html.erb +27 -0
- data/guides/source/kindle/rails_guides.opf.erb +52 -0
- data/guides/source/kindle/toc.html.erb +24 -0
- data/guides/source/kindle/toc.ncx.erb +64 -0
- data/guides/source/kindle/welcome.html.erb +5 -0
- data/guides/source/layout.html.erb +143 -0
- data/guides/source/layouts_and_rendering.md +1227 -0
- data/guides/source/maintenance_policy.md +78 -0
- data/guides/source/nested_model_forms.md +228 -0
- data/guides/source/plugins.md +444 -0
- data/guides/source/rails_application_templates.md +266 -0
- data/guides/source/rails_on_rack.md +336 -0
- data/guides/source/routing.md +1141 -0
- data/guides/source/ruby_on_rails_guides_guidelines.md +127 -0
- data/guides/source/security.md +1024 -0
- data/guides/source/testing.md +1123 -0
- data/guides/source/upgrading_ruby_on_rails.md +1154 -0
- data/guides/source/working_with_javascript_in_rails.md +407 -0
- data/guides/w3c_validator.rb +97 -0
- metadata +290 -44
@@ -0,0 +1,554 @@
|
|
1
|
+
Active Model Basics
|
2
|
+
===================
|
3
|
+
|
4
|
+
This guide should provide you with all you need to get started using model
|
5
|
+
classes. Active Model allows for Action Pack helpers to interact with
|
6
|
+
plain Ruby objects. Active Model also helps build custom ORMs for use
|
7
|
+
outside of the Rails framework.
|
8
|
+
|
9
|
+
After reading this guide, you will be able to add to plain Ruby objects:
|
10
|
+
|
11
|
+
* The ability to behave like an Active Record model.
|
12
|
+
* Callbacks and validations like Active Record.
|
13
|
+
* Serializers.
|
14
|
+
* Integration with the Rails internationalization (i18n) framework.
|
15
|
+
|
16
|
+
--------------------------------------------------------------------------------
|
17
|
+
|
18
|
+
Introduction
|
19
|
+
------------
|
20
|
+
|
21
|
+
Active Model is a library containing various modules used in developing
|
22
|
+
classes that need some features present on Active Record.
|
23
|
+
Some of these modules are explained below.
|
24
|
+
|
25
|
+
### Attribute Methods
|
26
|
+
|
27
|
+
The `ActiveModel::AttributeMethods` module can add custom prefixes and suffixes
|
28
|
+
on methods of a class. It is used by defining the prefixes and suffixes and
|
29
|
+
which methods on the object will use them.
|
30
|
+
|
31
|
+
```ruby
|
32
|
+
class Person
|
33
|
+
include ActiveModel::AttributeMethods
|
34
|
+
|
35
|
+
attribute_method_prefix 'reset_'
|
36
|
+
attribute_method_suffix '_highest?'
|
37
|
+
define_attribute_methods 'age'
|
38
|
+
|
39
|
+
attr_accessor :age
|
40
|
+
|
41
|
+
private
|
42
|
+
def reset_attribute(attribute)
|
43
|
+
send("#{attribute}=", 0)
|
44
|
+
end
|
45
|
+
|
46
|
+
def attribute_highest?(attribute)
|
47
|
+
send(attribute) > 100
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
person = Person.new
|
52
|
+
person.age = 110
|
53
|
+
person.age_highest? # => true
|
54
|
+
person.reset_age # => 0
|
55
|
+
person.age_highest? # => false
|
56
|
+
```
|
57
|
+
|
58
|
+
### Callbacks
|
59
|
+
|
60
|
+
`ActiveModel::Callbacks` gives Active Record style callbacks. This provides an
|
61
|
+
ability to define callbacks which run at appropriate times.
|
62
|
+
After defining callbacks, you can wrap them with before, after and around
|
63
|
+
custom methods.
|
64
|
+
|
65
|
+
```ruby
|
66
|
+
class Person
|
67
|
+
extend ActiveModel::Callbacks
|
68
|
+
|
69
|
+
define_model_callbacks :update
|
70
|
+
|
71
|
+
before_update :reset_me
|
72
|
+
|
73
|
+
def update
|
74
|
+
run_callbacks(:update) do
|
75
|
+
# This method is called when update is called on an object.
|
76
|
+
end
|
77
|
+
end
|
78
|
+
|
79
|
+
def reset_me
|
80
|
+
# This method is called when update is called on an object as a before_update callback is defined.
|
81
|
+
end
|
82
|
+
end
|
83
|
+
```
|
84
|
+
|
85
|
+
### Conversion
|
86
|
+
|
87
|
+
If a class defines `persisted?` and `id` methods, then you can include the
|
88
|
+
`ActiveModel::Conversion` module in that class and call the Rails conversion
|
89
|
+
methods on objects of that class.
|
90
|
+
|
91
|
+
```ruby
|
92
|
+
class Person
|
93
|
+
include ActiveModel::Conversion
|
94
|
+
|
95
|
+
def persisted?
|
96
|
+
false
|
97
|
+
end
|
98
|
+
|
99
|
+
def id
|
100
|
+
nil
|
101
|
+
end
|
102
|
+
end
|
103
|
+
|
104
|
+
person = Person.new
|
105
|
+
person.to_model == person # => true
|
106
|
+
person.to_key # => nil
|
107
|
+
person.to_param # => nil
|
108
|
+
```
|
109
|
+
|
110
|
+
### Dirty
|
111
|
+
|
112
|
+
An object becomes dirty when it has gone through one or more changes to its
|
113
|
+
attributes and has not been saved. `ActiveModel::Dirty` gives the ability to
|
114
|
+
check whether an object has been changed or not. It also has attribute based
|
115
|
+
accessor methods. Let's consider a Person class with attributes `first_name`
|
116
|
+
and `last_name`:
|
117
|
+
|
118
|
+
```ruby
|
119
|
+
class Person
|
120
|
+
include ActiveModel::Dirty
|
121
|
+
define_attribute_methods :first_name, :last_name
|
122
|
+
|
123
|
+
def first_name
|
124
|
+
@first_name
|
125
|
+
end
|
126
|
+
|
127
|
+
def first_name=(value)
|
128
|
+
first_name_will_change!
|
129
|
+
@first_name = value
|
130
|
+
end
|
131
|
+
|
132
|
+
def last_name
|
133
|
+
@last_name
|
134
|
+
end
|
135
|
+
|
136
|
+
def last_name=(value)
|
137
|
+
last_name_will_change!
|
138
|
+
@last_name = value
|
139
|
+
end
|
140
|
+
|
141
|
+
def save
|
142
|
+
# do save work...
|
143
|
+
changes_applied
|
144
|
+
end
|
145
|
+
end
|
146
|
+
```
|
147
|
+
|
148
|
+
#### Querying object directly for its list of all changed attributes.
|
149
|
+
|
150
|
+
```ruby
|
151
|
+
person = Person.new
|
152
|
+
person.changed? # => false
|
153
|
+
|
154
|
+
person.first_name = "First Name"
|
155
|
+
person.first_name # => "First Name"
|
156
|
+
|
157
|
+
# returns if any attribute has changed.
|
158
|
+
person.changed? # => true
|
159
|
+
|
160
|
+
# returns a list of attributes that have changed before saving.
|
161
|
+
person.changed # => ["first_name"]
|
162
|
+
|
163
|
+
# returns a hash of the attributes that have changed with their original values.
|
164
|
+
person.changed_attributes # => {"first_name"=>nil}
|
165
|
+
|
166
|
+
# returns a hash of changes, with the attribute names as the keys, and the values will be an array of the old and new value for that field.
|
167
|
+
person.changes # => {"first_name"=>[nil, "First Name"]}
|
168
|
+
```
|
169
|
+
|
170
|
+
#### Attribute based accessor methods
|
171
|
+
|
172
|
+
Track whether the particular attribute has been changed or not.
|
173
|
+
|
174
|
+
```ruby
|
175
|
+
# attr_name_changed?
|
176
|
+
person.first_name # => "First Name"
|
177
|
+
person.first_name_changed? # => true
|
178
|
+
```
|
179
|
+
|
180
|
+
Track what was the previous value of the attribute.
|
181
|
+
|
182
|
+
```ruby
|
183
|
+
# attr_name_was accessor
|
184
|
+
person.first_name_was # => nil
|
185
|
+
```
|
186
|
+
|
187
|
+
Track both previous and current value of the changed attribute. Returns an array
|
188
|
+
if changed, else returns nil.
|
189
|
+
|
190
|
+
```ruby
|
191
|
+
# attr_name_change
|
192
|
+
person.first_name_change # => [nil, "First Name"]
|
193
|
+
person.last_name_change # => nil
|
194
|
+
```
|
195
|
+
|
196
|
+
### Validations
|
197
|
+
|
198
|
+
`ActiveModel::Validations` module adds the ability to validate class objects
|
199
|
+
like in Active Record.
|
200
|
+
|
201
|
+
```ruby
|
202
|
+
class Person
|
203
|
+
include ActiveModel::Validations
|
204
|
+
|
205
|
+
attr_accessor :name, :email, :token
|
206
|
+
|
207
|
+
validates :name, presence: true
|
208
|
+
validates_format_of :email, with: /\A([^\s]+)((?:[-a-z0-9]\.)[a-z]{2,})\z/i
|
209
|
+
validates! :token, presence: true
|
210
|
+
end
|
211
|
+
|
212
|
+
person = Person.new
|
213
|
+
person.token = "2b1f325"
|
214
|
+
person.valid? # => false
|
215
|
+
person.name = 'vishnu'
|
216
|
+
person.email = 'me'
|
217
|
+
person.valid? # => false
|
218
|
+
person.email = 'me@vishnuatrai.com'
|
219
|
+
person.valid? # => true
|
220
|
+
person.token = nil
|
221
|
+
person.valid? # => raises ActiveModel::StrictValidationFailed
|
222
|
+
```
|
223
|
+
|
224
|
+
### Naming
|
225
|
+
|
226
|
+
`ActiveModel::Naming` adds a number of class methods which make the naming and routing
|
227
|
+
easier to manage. The module defines the `model_name` class method which
|
228
|
+
will define a number of accessors using some `ActiveSupport::Inflector` methods.
|
229
|
+
|
230
|
+
```ruby
|
231
|
+
class Person
|
232
|
+
extend ActiveModel::Naming
|
233
|
+
end
|
234
|
+
|
235
|
+
Person.model_name.name # => "Person"
|
236
|
+
Person.model_name.singular # => "person"
|
237
|
+
Person.model_name.plural # => "people"
|
238
|
+
Person.model_name.element # => "person"
|
239
|
+
Person.model_name.human # => "Person"
|
240
|
+
Person.model_name.collection # => "people"
|
241
|
+
Person.model_name.param_key # => "person"
|
242
|
+
Person.model_name.i18n_key # => :person
|
243
|
+
Person.model_name.route_key # => "people"
|
244
|
+
Person.model_name.singular_route_key # => "person"
|
245
|
+
```
|
246
|
+
|
247
|
+
### Model
|
248
|
+
|
249
|
+
`ActiveModel::Model` adds the ability to a class to work with Action Pack and
|
250
|
+
Action View right out of the box.
|
251
|
+
|
252
|
+
```ruby
|
253
|
+
class EmailContact
|
254
|
+
include ActiveModel::Model
|
255
|
+
|
256
|
+
attr_accessor :name, :email, :message
|
257
|
+
validates :name, :email, :message, presence: true
|
258
|
+
|
259
|
+
def deliver
|
260
|
+
if valid?
|
261
|
+
# deliver email
|
262
|
+
end
|
263
|
+
end
|
264
|
+
end
|
265
|
+
```
|
266
|
+
|
267
|
+
When including `ActiveModel::Model` you get some features like:
|
268
|
+
|
269
|
+
- model name introspection
|
270
|
+
- conversions
|
271
|
+
- translations
|
272
|
+
- validations
|
273
|
+
|
274
|
+
It also gives you the ability to initialize an object with a hash of attributes,
|
275
|
+
much like any Active Record object.
|
276
|
+
|
277
|
+
```ruby
|
278
|
+
email_contact = EmailContact.new(name: 'David',
|
279
|
+
email: 'david@example.com',
|
280
|
+
message: 'Hello World')
|
281
|
+
email_contact.name # => 'David'
|
282
|
+
email_contact.email # => 'david@example.com'
|
283
|
+
email_contact.valid? # => true
|
284
|
+
email_contact.persisted? # => false
|
285
|
+
```
|
286
|
+
|
287
|
+
Any class that includes `ActiveModel::Model` can be used with `form_for`,
|
288
|
+
`render` and any other Action View helper methods, just like Active Record
|
289
|
+
objects.
|
290
|
+
|
291
|
+
### Serialization
|
292
|
+
|
293
|
+
`ActiveModel::Serialization` provides a basic serialization for your object.
|
294
|
+
You need to declare an attributes hash which contains the attributes you want to
|
295
|
+
serialize. Attributes must be strings, not symbols.
|
296
|
+
|
297
|
+
```ruby
|
298
|
+
class Person
|
299
|
+
include ActiveModel::Serialization
|
300
|
+
|
301
|
+
attr_accessor :name
|
302
|
+
|
303
|
+
def attributes
|
304
|
+
{'name' => nil}
|
305
|
+
end
|
306
|
+
end
|
307
|
+
```
|
308
|
+
|
309
|
+
Now you can access a serialized hash of your object using the `serializable_hash`.
|
310
|
+
|
311
|
+
```ruby
|
312
|
+
person = Person.new
|
313
|
+
person.serializable_hash # => {"name"=>nil}
|
314
|
+
person.name = "Bob"
|
315
|
+
person.serializable_hash # => {"name"=>"Bob"}
|
316
|
+
```
|
317
|
+
|
318
|
+
#### ActiveModel::Serializers
|
319
|
+
|
320
|
+
Rails provides two serializers `ActiveModel::Serializers::JSON` and
|
321
|
+
`ActiveModel::Serializers::Xml`. Both of these modules automatically include
|
322
|
+
the `ActiveModel::Serialization`.
|
323
|
+
|
324
|
+
##### ActiveModel::Serializers::JSON
|
325
|
+
|
326
|
+
To use the `ActiveModel::Serializers::JSON` you only need to change from
|
327
|
+
`ActiveModel::Serialization` to `ActiveModel::Serializers::JSON`.
|
328
|
+
|
329
|
+
```ruby
|
330
|
+
class Person
|
331
|
+
include ActiveModel::Serializers::JSON
|
332
|
+
|
333
|
+
attr_accessor :name
|
334
|
+
|
335
|
+
def attributes
|
336
|
+
{'name' => nil}
|
337
|
+
end
|
338
|
+
end
|
339
|
+
```
|
340
|
+
|
341
|
+
With the `as_json` you have a hash representing the model.
|
342
|
+
|
343
|
+
```ruby
|
344
|
+
person = Person.new
|
345
|
+
person.as_json # => {"name"=>nil}
|
346
|
+
person.name = "Bob"
|
347
|
+
person.as_json # => {"name"=>"Bob"}
|
348
|
+
```
|
349
|
+
|
350
|
+
From a JSON string you define the attributes of the model.
|
351
|
+
You need to have the `attributes=` method defined on your class:
|
352
|
+
|
353
|
+
```ruby
|
354
|
+
class Person
|
355
|
+
include ActiveModel::Serializers::JSON
|
356
|
+
|
357
|
+
attr_accessor :name
|
358
|
+
|
359
|
+
def attributes=(hash)
|
360
|
+
hash.each do |key, value|
|
361
|
+
send("#{key}=", value)
|
362
|
+
end
|
363
|
+
end
|
364
|
+
|
365
|
+
def attributes
|
366
|
+
{'name' => nil}
|
367
|
+
end
|
368
|
+
end
|
369
|
+
```
|
370
|
+
|
371
|
+
Now it is possible to create an instance of person and set the attributes using `from_json`.
|
372
|
+
|
373
|
+
```ruby
|
374
|
+
json = { name: 'Bob' }.to_json
|
375
|
+
person = Person.new
|
376
|
+
person.from_json(json) # => #<Person:0x00000100c773f0 @name="Bob">
|
377
|
+
person.name # => "Bob"
|
378
|
+
```
|
379
|
+
|
380
|
+
##### ActiveModel::Serializers::Xml
|
381
|
+
|
382
|
+
To use the `ActiveModel::Serializers::Xml` you only need to change from
|
383
|
+
`ActiveModel::Serialization` to `ActiveModel::Serializers::Xml`.
|
384
|
+
|
385
|
+
```ruby
|
386
|
+
class Person
|
387
|
+
include ActiveModel::Serializers::Xml
|
388
|
+
|
389
|
+
attr_accessor :name
|
390
|
+
|
391
|
+
def attributes
|
392
|
+
{'name' => nil}
|
393
|
+
end
|
394
|
+
end
|
395
|
+
```
|
396
|
+
|
397
|
+
With the `to_xml` you have a XML representing the model.
|
398
|
+
|
399
|
+
```ruby
|
400
|
+
person = Person.new
|
401
|
+
person.to_xml # => "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<person>\n <name nil=\"true\"/>\n</person>\n"
|
402
|
+
person.name = "Bob"
|
403
|
+
person.to_xml # => "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<person>\n <name>Bob</name>\n</person>\n"
|
404
|
+
```
|
405
|
+
|
406
|
+
From a XML string you define the attributes of the model.
|
407
|
+
You need to have the `attributes=` method defined on your class:
|
408
|
+
|
409
|
+
```ruby
|
410
|
+
class Person
|
411
|
+
include ActiveModel::Serializers::Xml
|
412
|
+
|
413
|
+
attr_accessor :name
|
414
|
+
|
415
|
+
def attributes=(hash)
|
416
|
+
hash.each do |key, value|
|
417
|
+
send("#{key}=", value)
|
418
|
+
end
|
419
|
+
end
|
420
|
+
|
421
|
+
def attributes
|
422
|
+
{'name' => nil}
|
423
|
+
end
|
424
|
+
end
|
425
|
+
```
|
426
|
+
|
427
|
+
Now it is possible to create an instance of person and set the attributes using `from_xml`.
|
428
|
+
|
429
|
+
```ruby
|
430
|
+
xml = { name: 'Bob' }.to_xml
|
431
|
+
person = Person.new
|
432
|
+
person.from_xml(xml) # => #<Person:0x00000100c773f0 @name="Bob">
|
433
|
+
person.name # => "Bob"
|
434
|
+
```
|
435
|
+
|
436
|
+
### Translation
|
437
|
+
|
438
|
+
`ActiveModel::Translation` provides integration between your object and the Rails
|
439
|
+
internationalization (i18n) framework.
|
440
|
+
|
441
|
+
```ruby
|
442
|
+
class Person
|
443
|
+
extend ActiveModel::Translation
|
444
|
+
end
|
445
|
+
```
|
446
|
+
|
447
|
+
With the `human_attribute_name` you can transform attribute names into a more
|
448
|
+
human format. The human format is defined in your locale file.
|
449
|
+
|
450
|
+
* config/locales/app.pt-BR.yml
|
451
|
+
|
452
|
+
```yml
|
453
|
+
pt-BR:
|
454
|
+
activemodel:
|
455
|
+
attributes:
|
456
|
+
person:
|
457
|
+
name: 'Nome'
|
458
|
+
```
|
459
|
+
|
460
|
+
```ruby
|
461
|
+
Person.human_attribute_name('name') # => "Nome"
|
462
|
+
```
|
463
|
+
|
464
|
+
### Lint Tests
|
465
|
+
|
466
|
+
`ActiveModel::Lint::Tests` allow you to test whether an object is compliant with
|
467
|
+
the Active Model API.
|
468
|
+
|
469
|
+
* app/models/person.rb
|
470
|
+
|
471
|
+
```ruby
|
472
|
+
class Person
|
473
|
+
include ActiveModel::Model
|
474
|
+
|
475
|
+
end
|
476
|
+
```
|
477
|
+
|
478
|
+
* test/models/person_test.rb
|
479
|
+
|
480
|
+
```ruby
|
481
|
+
require 'test_helper'
|
482
|
+
|
483
|
+
class PersonTest < ActiveSupport::TestCase
|
484
|
+
include ActiveModel::Lint::Tests
|
485
|
+
|
486
|
+
def setup
|
487
|
+
@model = Person.new
|
488
|
+
end
|
489
|
+
end
|
490
|
+
```
|
491
|
+
|
492
|
+
```bash
|
493
|
+
$ rake test
|
494
|
+
|
495
|
+
Run options: --seed 14596
|
496
|
+
|
497
|
+
# Running:
|
498
|
+
|
499
|
+
......
|
500
|
+
|
501
|
+
Finished in 0.024899s, 240.9735 runs/s, 1204.8677 assertions/s.
|
502
|
+
|
503
|
+
6 runs, 30 assertions, 0 failures, 0 errors, 0 skips
|
504
|
+
```
|
505
|
+
|
506
|
+
An object is not required to implement all APIs in order to work with
|
507
|
+
Action Pack. This module only intends to provide guidance in case you want all
|
508
|
+
features out of the box.
|
509
|
+
|
510
|
+
### SecurePassword
|
511
|
+
|
512
|
+
`ActiveModel::SecurePassword` provides a way to securely store any
|
513
|
+
password in an encrypted form. On including this module, a
|
514
|
+
`has_secure_password` class method is provided which defines
|
515
|
+
an accessor named `password` with certain validations on it.
|
516
|
+
|
517
|
+
#### Requirements
|
518
|
+
|
519
|
+
`ActiveModel::SecurePassword` depends on the [`bcrypt`](https://github.com/codahale/bcrypt-ruby 'BCrypt'),
|
520
|
+
so include this gem in your Gemfile to use `ActiveModel::SecurePassword` correctly.
|
521
|
+
In order to make this work, the model must have an accessor named `password_digest`.
|
522
|
+
The `has_secure_password` will add the following validations on the `password` accessor:
|
523
|
+
|
524
|
+
1. Password should be present.
|
525
|
+
2. Password should be equal to its confirmation.
|
526
|
+
3. This maximum length of a password is 72 (required by `bcrypt` on which ActiveModel::SecurePassword depends)
|
527
|
+
|
528
|
+
#### Examples
|
529
|
+
|
530
|
+
```ruby
|
531
|
+
class Person
|
532
|
+
include ActiveModel::SecurePassword
|
533
|
+
has_secure_password
|
534
|
+
attr_accessor :password_digest
|
535
|
+
end
|
536
|
+
|
537
|
+
person = Person.new
|
538
|
+
|
539
|
+
# When password is blank.
|
540
|
+
person.valid? # => false
|
541
|
+
|
542
|
+
# When the confirmation doesn't match the password.
|
543
|
+
person.password = 'aditya'
|
544
|
+
person.password_confirmation = 'nomatch'
|
545
|
+
person.valid? # => false
|
546
|
+
|
547
|
+
# When the length of password, exceeds 72.
|
548
|
+
person.password = person.password_confirmation = 'a' * 100
|
549
|
+
person.valid? # => false
|
550
|
+
|
551
|
+
# When all validations are passed.
|
552
|
+
person.password = person.password_confirmation = 'aditya'
|
553
|
+
person.valid? # => true
|
554
|
+
```
|