/
active_model_basics.html
702 lines (613 loc) · 27.6 KB
/
active_model_basics.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Active Model Basics — Ruby on Rails Guides</title>
<link rel="stylesheet" type="text/css" href="stylesheets/style.css" data-turbolinks-track="reload">
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print">
<link rel="stylesheet" type="text/css" href="stylesheets/syntaxhighlighter/shCore.css" data-turbolinks-track="reload">
<link rel="stylesheet" type="text/css" href="stylesheets/syntaxhighlighter/shThemeRailsGuides.css" data-turbolinks-track="reload">
<link rel="stylesheet" type="text/css" href="stylesheets/fixes.css" data-turbolinks-track="reload">
<link href="images/favicon.ico" rel="shortcut icon" type="image/x-icon" />
<script src="javascripts/syntaxhighlighter.js" data-turbolinks-track="reload"></script>
<script src="javascripts/turbolinks.js" data-turbolinks-track="reload"></script>
<script src="javascripts/guides.js" data-turbolinks-track="reload"></script>
<script src="javascripts/responsive-tables.js" data-turbolinks-track="reload"></script>
</head>
<body class="guide">
<div>
<img src="images/edge_badge.png" alt="edge-badge" id="edge-badge" />
</div>
<div id="topNav">
<div class="wrapper">
<strong class="more-info-label">Veja mais em <a href="http://rubyonrails.org/">rubyonrails.org:</a> </strong>
<span class="red-button more-info-button">
Mais Ruby on Rails
</span>
<ul class="more-info-links s-hidden">
<li class="more-info"><a href="https://weblog.rubyonrails.org/">Blog</a></li>
<li class="more-info"><a href="https://guides.rubyonrails.org/">Guia</a></li>
<li class="more-info"><a href="http://api.rubyonrails.org/">API</a></li>
<li class="more-info"><a href="https://stackoverflow.com/questions/tagged/ruby-on-rails">Pedir ajuda</a></li>
<li class="more-info"><a href="https://github.com/rails/rails">Contribuir no GitHub</a></li>
</ul>
</div>
</div>
<div id="header">
<div class="wrapper clearfix">
<h1><a href="index.html" title="Return to home page">Guides.rubyonrails.org</a></h1>
<ul class="nav">
<li><a class="nav-item" href="index.html">Home</a></li>
<li class="guides-index guides-index-large">
<a href="index.html" id="guidesMenu" class="guides-index-item nav-item">Guias</a>
<div id="guides" class="clearfix" style="display: none;">
<hr />
<div class="guides-section-container">
<div class="guides-section">
<dt>Comece Aqui</dt>
</div>
<div class="guides-section">
<dt>Models</dt>
</div>
<div class="guides-section">
<dt>Views</dt>
</div>
<div class="guides-section">
<dt>Controllers</dt>
</div>
<div class="guides-section">
<dt>Other Components</dt>
</div>
<div class="guides-section">
<dt>Digging Deeper</dt>
</div>
<div class="guides-section">
<dt>Extending Rails</dt>
<dd><a href="rails_on_rack.html">Rails on Rack</a></dd>
<dd><a href="generators.html">Creating and Customizing Rails Generators & Templates</a></dd>
</div>
<div class="guides-section">
<dt>Contributions</dt>
<dd><a href="contributing_to_ruby_on_rails.html">Contributing to Ruby on Rails</a></dd>
<dd><a href="api_documentation_guidelines.html">API Documentation Guidelines</a></dd>
<dd><a href="ruby_on_rails_guides_guidelines.html">Guides Guidelines</a></dd>
</div>
<div class="guides-section">
<dt>Policies</dt>
<dd><a href="maintenance_policy.html">Maintenance Policy</a></dd>
</div>
<div class="guides-section">
<dt>Release Notes</dt>
<dd><a href="upgrading_ruby_on_rails.html">Upgrading Ruby on Rails</a></dd>
<dd><a href="5_2_release_notes.html">Version 5.2 - April 2018</a></dd>
<dd><a href="5_1_release_notes.html">Version 5.1 - April 2017</a></dd>
<dd><a href="5_0_release_notes.html">Version 5.0 - June 2016</a></dd>
<dd><a href="4_2_release_notes.html">Version 4.2 - December 2014</a></dd>
<dd><a href="4_1_release_notes.html">Version 4.1 - April 2014</a></dd>
<dd><a href="4_0_release_notes.html">Version 4.0 - June 2013</a></dd>
<dd><a href="3_2_release_notes.html">Version 3.2 - January 2012</a></dd>
<dd><a href="3_1_release_notes.html">Version 3.1 - August 2011</a></dd>
<dd><a href="3_0_release_notes.html">Version 3.0 - August 2010</a></dd>
<dd><a href="2_3_release_notes.html">Version 2.3 - March 2009</a></dd>
<dd><a href="2_2_release_notes.html">Version 2.2 - November 2008</a></dd>
</div>
</div>
</div>
</li>
<li><a class="nav-item" href="contributing_to_ruby_on_rails.html">Contribua</a></li>
<li class="guides-index guides-index-small">
<select class="guides-index-item nav-item">
<option value="index.html">Guias</option>
<optgroup label="Comece Aqui">
</optgroup>
<optgroup label="Models">
</optgroup>
<optgroup label="Views">
</optgroup>
<optgroup label="Controllers">
</optgroup>
<optgroup label="Other Components">
</optgroup>
<optgroup label="Digging Deeper">
</optgroup>
<optgroup label="Extending Rails">
<option value="rails_on_rack.html">Rails on Rack</option>
<option value="generators.html">Creating and Customizing Rails Generators & Templates</option>
</optgroup>
<optgroup label="Contributions">
<option value="contributing_to_ruby_on_rails.html">Contributing to Ruby on Rails</option>
<option value="api_documentation_guidelines.html">API Documentation Guidelines</option>
<option value="ruby_on_rails_guides_guidelines.html">Guides Guidelines</option>
</optgroup>
<optgroup label="Policies">
<option value="maintenance_policy.html">Maintenance Policy</option>
</optgroup>
<optgroup label="Release Notes">
<option value="upgrading_ruby_on_rails.html">Upgrading Ruby on Rails</option>
<option value="5_2_release_notes.html">Version 5.2 - April 2018</option>
<option value="5_1_release_notes.html">Version 5.1 - April 2017</option>
<option value="5_0_release_notes.html">Version 5.0 - June 2016</option>
<option value="4_2_release_notes.html">Version 4.2 - December 2014</option>
<option value="4_1_release_notes.html">Version 4.1 - April 2014</option>
<option value="4_0_release_notes.html">Version 4.0 - June 2013</option>
<option value="3_2_release_notes.html">Version 3.2 - January 2012</option>
<option value="3_1_release_notes.html">Version 3.1 - August 2011</option>
<option value="3_0_release_notes.html">Version 3.0 - August 2010</option>
<option value="2_3_release_notes.html">Version 2.3 - March 2009</option>
<option value="2_2_release_notes.html">Version 2.2 - November 2008</option>
</optgroup>
</select>
</li>
</ul>
</div>
</div>
<hr class="hide" />
<div id="feature">
<div class="wrapper">
<h2>Active Model Basics</h2><p>This guide should provide you with all you need to get started using model
classes. Active Model allows for Action Pack helpers to interact with
plain Ruby objects. Active Model also helps build custom ORMs for use
outside of the Rails framework.</p><p>After reading this guide, you will know:</p>
<ul>
<li>How an Active Record model behaves.</li>
<li>How Callbacks and validations work.</li>
<li>How serializers work.</li>
<li>How Active Model integrates with the Rails internationalization (i18n) framework.</li>
</ul>
<div id="subCol">
<h3 class="chapter"><img src="images/chapters_icon.gif" alt="" />Chapters</h3>
<ol class="chapters">
<li>
<a href="#introduction">Introduction</a>
<ul>
<li><a href="#attribute-methods">Attribute Methods</a></li>
<li><a href="#callbacks">Callbacks</a></li>
<li><a href="#conversion">Conversion</a></li>
<li><a href="#dirty">Dirty</a></li>
<li><a href="#validations">Validations</a></li>
<li><a href="#naming">Naming</a></li>
<li><a href="#model">Model</a></li>
<li><a href="#serialization">Serialization</a></li>
<li><a href="#translation">Translation</a></li>
<li><a href="#lint-tests">Lint Tests</a></li>
<li><a href="#securepassword">SecurePassword</a></li>
</ul>
</li>
</ol>
</div>
</div>
</div>
<div id="container">
<div class="wrapper">
<div id="mainCol">
<h3 id="introduction"><a class="anchorlink" href="#introduction">1 Introduction</a></h3><p>Active Model is a library containing various modules used in developing
classes that need some features present on Active Record.
Some of these modules are explained below.</p><h4 id="attribute-methods"><a class="anchorlink" href="#attribute-methods">1.1 Attribute Methods</a></h4><p>The <code>ActiveModel::AttributeMethods</code> module can add custom prefixes and suffixes
on methods of a class. It is used by defining the prefixes and suffixes and
which methods on the object will use them.</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
class Person
include ActiveModel::AttributeMethods
attribute_method_prefix 'reset_'
attribute_method_suffix '_highest?'
define_attribute_methods 'age'
attr_accessor :age
private
def reset_attribute(attribute)
send("#{attribute}=", 0)
end
def attribute_highest?(attribute)
send(attribute) > 100
end
end
person = Person.new
person.age = 110
person.age_highest? # => true
person.reset_age # => 0
person.age_highest? # => false
</pre>
</div>
<h4 id="callbacks"><a class="anchorlink" href="#callbacks">1.2 Callbacks</a></h4><p><code>ActiveModel::Callbacks</code> gives Active Record style callbacks. This provides an
ability to define callbacks which run at appropriate times.
After defining callbacks, you can wrap them with before, after, and around
custom methods.</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
class Person
extend ActiveModel::Callbacks
define_model_callbacks :update
before_update :reset_me
def update
run_callbacks(:update) do
# This method is called when update is called on an object.
end
end
def reset_me
# This method is called when update is called on an object as a before_update callback is defined.
end
end
</pre>
</div>
<h4 id="conversion"><a class="anchorlink" href="#conversion">1.3 Conversion</a></h4><p>If a class defines <code>persisted?</code> and <code>id</code> methods, then you can include the
<code>ActiveModel::Conversion</code> module in that class, and call the Rails conversion
methods on objects of that class.</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
class Person
include ActiveModel::Conversion
def persisted?
false
end
def id
nil
end
end
person = Person.new
person.to_model == person # => true
person.to_key # => nil
person.to_param # => nil
</pre>
</div>
<h4 id="dirty"><a class="anchorlink" href="#dirty">1.4 Dirty</a></h4><p>An object becomes dirty when it has gone through one or more changes to its
attributes and has not been saved. <code>ActiveModel::Dirty</code> gives the ability to
check whether an object has been changed or not. It also has attribute based
accessor methods. Let's consider a Person class with attributes <code>first_name</code>
and <code>last_name</code>:</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
class Person
include ActiveModel::Dirty
define_attribute_methods :first_name, :last_name
def first_name
@first_name
end
def first_name=(value)
first_name_will_change!
@first_name = value
end
def last_name
@last_name
end
def last_name=(value)
last_name_will_change!
@last_name = value
end
def save
# do save work...
changes_applied
end
end
</pre>
</div>
<h5 id="querying-object-directly-for-its-list-of-all-changed-attributes"><a class="anchorlink" href="#querying-object-directly-for-its-list-of-all-changed-attributes">1.4.1 Querying object directly for its list of all changed attributes.</a></h5><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
person = Person.new
person.changed? # => false
person.first_name = "First Name"
person.first_name # => "First Name"
# returns true if any of the attributes have unsaved changes.
person.changed? # => true
# returns a list of attributes that have changed before saving.
person.changed # => ["first_name"]
# returns a Hash of the attributes that have changed with their original values.
person.changed_attributes # => {"first_name"=>nil}
# returns a Hash of changes, with the attribute names as the keys, and the
# values as an array of the old and new values for that field.
person.changes # => {"first_name"=>[nil, "First Name"]}
</pre>
</div>
<h5 id="attribute-based-accessor-methods"><a class="anchorlink" href="#attribute-based-accessor-methods">1.4.2 Attribute based accessor methods</a></h5><p>Track whether the particular attribute has been changed or not.</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
# attr_name_changed?
person.first_name # => "First Name"
person.first_name_changed? # => true
</pre>
</div>
<p>Track the previous value of the attribute.</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
# attr_name_was accessor
person.first_name_was # => nil
</pre>
</div>
<p>Track both previous and current value of the changed attribute. Returns an array
if changed, otherwise returns nil.</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
# attr_name_change
person.first_name_change # => [nil, "First Name"]
person.last_name_change # => nil
</pre>
</div>
<h4 id="validations"><a class="anchorlink" href="#validations">1.5 Validations</a></h4><p>The <code>ActiveModel::Validations</code> module adds the ability to validate objects
like in Active Record.</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
class Person
include ActiveModel::Validations
attr_accessor :name, :email, :token
validates :name, presence: true
validates_format_of :email, with: /\A([^\s]+)((?:[-a-z0-9]\.)[a-z]{2,})\z/i
validates! :token, presence: true
end
person = Person.new
person.token = "2b1f325"
person.valid? # => false
person.name = 'vishnu'
person.email = 'me'
person.valid? # => false
person.email = 'me@vishnuatrai.com'
person.valid? # => true
person.token = nil
person.valid? # => raises ActiveModel::StrictValidationFailed
</pre>
</div>
<h4 id="naming"><a class="anchorlink" href="#naming">1.6 Naming</a></h4><p><code>ActiveModel::Naming</code> adds a number of class methods which make naming and routing
easier to manage. The module defines the <code>model_name</code> class method which
will define a number of accessors using some <code>ActiveSupport::Inflector</code> methods.</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
class Person
extend ActiveModel::Naming
end
Person.model_name.name # => "Person"
Person.model_name.singular # => "person"
Person.model_name.plural # => "people"
Person.model_name.element # => "person"
Person.model_name.human # => "Person"
Person.model_name.collection # => "people"
Person.model_name.param_key # => "person"
Person.model_name.i18n_key # => :person
Person.model_name.route_key # => "people"
Person.model_name.singular_route_key # => "person"
</pre>
</div>
<h4 id="model"><a class="anchorlink" href="#model">1.7 Model</a></h4><p><code>ActiveModel::Model</code> adds the ability for a class to work with Action Pack and
Action View right out of the box.</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
class EmailContact
include ActiveModel::Model
attr_accessor :name, :email, :message
validates :name, :email, :message, presence: true
def deliver
if valid?
# deliver email
end
end
end
</pre>
</div>
<p>When including <code>ActiveModel::Model</code> you get some features like:</p>
<ul>
<li>model name introspection</li>
<li>conversions</li>
<li>translations</li>
<li>validations</li>
</ul>
<p>It also gives you the ability to initialize an object with a hash of attributes,
much like any Active Record object.</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
email_contact = EmailContact.new(name: 'David',
email: 'david@example.com',
message: 'Hello World')
email_contact.name # => 'David'
email_contact.email # => 'david@example.com'
email_contact.valid? # => true
email_contact.persisted? # => false
</pre>
</div>
<p>Any class that includes <code>ActiveModel::Model</code> can be used with <code>form_for</code>,
<code>render</code> and any other Action View helper methods, just like Active Record
objects.</p><h4 id="serialization"><a class="anchorlink" href="#serialization">1.8 Serialization</a></h4><p><code>ActiveModel::Serialization</code> provides basic serialization for your object.
You need to declare an attributes Hash which contains the attributes you want to
serialize. Attributes must be strings, not symbols.</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
class Person
include ActiveModel::Serialization
attr_accessor :name
def attributes
{'name' => nil}
end
end
</pre>
</div>
<p>Now you can access a serialized Hash of your object using the <code>serializable_hash</code> method.</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
person = Person.new
person.serializable_hash # => {"name"=>nil}
person.name = "Bob"
person.serializable_hash # => {"name"=>"Bob"}
</pre>
</div>
<h5 id="activemodel-serializers"><a class="anchorlink" href="#activemodel-serializers">1.8.1 ActiveModel::Serializers</a></h5><p>Active Model also provides the <code>ActiveModel::Serializers::JSON</code> module
for JSON serializing / deserializing. This module automatically includes the
previously discussed <code>ActiveModel::Serialization</code> module.</p><h6 id="activemodel-serializers-json"><a class="anchorlink" href="#activemodel-serializers-json">1.8.1.1 ActiveModel::Serializers::JSON</a></h6><p>To use <code>ActiveModel::Serializers::JSON</code> you only need to change the
module you are including from <code>ActiveModel::Serialization</code> to <code>ActiveModel::Serializers::JSON</code>.</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
class Person
include ActiveModel::Serializers::JSON
attr_accessor :name
def attributes
{'name' => nil}
end
end
</pre>
</div>
<p>The <code>as_json</code> method, similar to <code>serializable_hash</code>, provides a Hash representing
the model.</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
person = Person.new
person.as_json # => {"name"=>nil}
person.name = "Bob"
person.as_json # => {"name"=>"Bob"}
</pre>
</div>
<p>You can also define the attributes for a model from a JSON string.
However, you need to define the <code>attributes=</code> method on your class:</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
class Person
include ActiveModel::Serializers::JSON
attr_accessor :name
def attributes=(hash)
hash.each do |key, value|
send("#{key}=", value)
end
end
def attributes
{'name' => nil}
end
end
</pre>
</div>
<p>Now it is possible to create an instance of <code>Person</code> and set attributes using <code>from_json</code>.</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
json = { name: 'Bob' }.to_json
person = Person.new
person.from_json(json) # => #<Person:0x00000100c773f0 @name="Bob">
person.name # => "Bob"
</pre>
</div>
<h4 id="translation"><a class="anchorlink" href="#translation">1.9 Translation</a></h4><p><code>ActiveModel::Translation</code> provides integration between your object and the Rails
internationalization (i18n) framework.</p><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
class Person
extend ActiveModel::Translation
end
</pre>
</div>
<p>With the <code>human_attribute_name</code> method, you can transform attribute names into a
more human-readable format. The human-readable format is defined in your locale file(s).</p>
<ul>
<li>config/locales/app.pt-BR.yml</li>
</ul>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
pt-BR:
activemodel:
attributes:
person:
name: 'Nome'
</pre>
</div>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
Person.human_attribute_name('name') # => "Nome"
</pre>
</div>
<h4 id="lint-tests"><a class="anchorlink" href="#lint-tests">1.10 Lint Tests</a></h4><p><code>ActiveModel::Lint::Tests</code> allows you to test whether an object is compliant with
the Active Model API.</p>
<ul>
<li>
<p><code>app/models/person.rb</code></p>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
class Person
include ActiveModel::Model
end
</pre>
</div>
</li>
<li>
<p><code>test/models/person_test.rb</code></p>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
require 'test_helper'
class PersonTest < ActiveSupport::TestCase
include ActiveModel::Lint::Tests
setup do
@model = Person.new
end
end
</pre>
</div>
</li>
</ul>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ rails test
Run options: --seed 14596
# Running:
......
Finished in 0.024899s, 240.9735 runs/s, 1204.8677 assertions/s.
6 runs, 30 assertions, 0 failures, 0 errors, 0 skips
</pre>
</div>
<p>An object is not required to implement all APIs in order to work with
Action Pack. This module only intends to provide guidance in case you want all
features out of the box.</p><h4 id="securepassword"><a class="anchorlink" href="#securepassword">1.11 SecurePassword</a></h4><p><code>ActiveModel::SecurePassword</code> provides a way to securely store any
password in an encrypted form. When you include this module, a
<code>has_secure_password</code> class method is provided which defines
a <code>password</code> accessor with certain validations on it by default.</p><h5 id="requirements"><a class="anchorlink" href="#requirements">1.11.1 Requirements</a></h5><p><code>ActiveModel::SecurePassword</code> depends on <a href="https://github.com/codahale/bcrypt-ruby" title="BCrypt"><code>bcrypt</code></a>,
so include this gem in your <code>Gemfile</code> to use <code>ActiveModel::SecurePassword</code> correctly.
In order to make this work, the model must have an accessor named <code>XXX_digest</code>.
Where <code>XXX</code> is the attribute name of your desired password.
The following validations are added automatically:</p>
<ol>
<li>Password should be present.</li>
<li>Password should be equal to its confirmation (provided <code>XXX_confirmation</code> is passed along).</li>
<li>The maximum length of a password is 72 (required by <code>bcrypt</code> on which ActiveModel::SecurePassword depends)</li>
</ol>
<h5 id="examples"><a class="anchorlink" href="#examples">1.11.2 Examples</a></h5><div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
class Person
include ActiveModel::SecurePassword
has_secure_password
has_secure_password :recovery_password, validations: false
attr_accessor :password_digest, :recovery_password_digest
end
person = Person.new
# When password is blank.
person.valid? # => false
# When the confirmation doesn't match the password.
person.password = 'aditya'
person.password_confirmation = 'nomatch'
person.valid? # => false
# When the length of password exceeds 72.
person.password = person.password_confirmation = 'a' * 100
person.valid? # => false
# When only password is supplied with no password_confirmation.
person.password = 'aditya'
person.valid? # => true
# When all validations are passed.
person.password = person.password_confirmation = 'aditya'
person.valid? # => true
person.recovery_password = "42password"
person.authenticate('aditya') # => person
person.authenticate('notright') # => false
person.authenticate_password('aditya') # => person
person.authenticate_password('notright') # => false
person.authenticate_recovery_password('42password') # => person
person.authenticate_recovery_password('notright') # => false
person.password_digest # => "$2a$04$gF8RfZdoXHvyTjHhiU4ZsO.kQqV9oonYZu31PRE4hLQn3xM2qkpIy"
person.recovery_password_digest # => "$2a$04$iOfhwahFymCs5weB3BNH/uXkTG65HR.qpW.bNhEjFP3ftli3o5DQC"
</pre>
</div>
<h3>Feedback</h3>
<p>
You're encouraged to help improve the quality of this guide.
</p>
<p>
Please contribute if you see any typos or factual errors.
To get started, you can read our <a href="https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#contributing-to-the-rails-documentation">documentation contributions</a> section.
</p>
<p>
You may also find incomplete content or stuff that is not up to date.
Please do add any missing documentation for master. Make sure to check
<a href="https://edgeguides.rubyonrails.org">Edge Guides</a> first to verify
if the issues are already fixed or not on the master branch.
Check the <a href="ruby_on_rails_guides_guidelines.html">Ruby on Rails Guides Guidelines</a>
for style and conventions.
</p>
<p>
If for whatever reason you spot something to fix but cannot patch it yourself, please
<a href="https://github.com/rails/rails/issues">open an issue</a>.
</p>
<p>And last but not least, any kind of discussion regarding Ruby on Rails
documentation is very welcome on the <a href="https://groups.google.com/forum/#!forum/rubyonrails-docs">rubyonrails-docs mailing list</a>.
</p>
</div>
</div>
</div>
<hr class="hide" />
<div id="footer">
<div class="wrapper">
<p>This work is licensed under a <a href="https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International</a> License</p>
<p>"Rails", "Ruby on Rails", and the Rails logo are trademarks of David Heinemeier Hansson. All rights reserved.</p>
</div>
</div>
</body>
</html>