Skip to content

Commit e335d44

Browse files
pbolingpboling
authored
Merge pull request #162 from omniauth/feat/documentation
2 parents 9a76823 + a184477 commit e335d44

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+4013
-679
lines changed

‎.rubocop_gradual.lock‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,42 @@
11
{
2-
"README.md:969477879": [
2+
"README.md:2294530640": [
33
[275, 3, 100, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 3592044714]
44
],
55
"bin/bundle:247448467": [
66
[64, 5, 20, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 2485198147]
77
],
8-
"lib/omniauth/identity/model.rb:1162570792": [
9-
[53, 11, 9, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 4045031525],
10-
[54, 11, 9, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 4045031525],
11-
[54, 40, 9, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 4045031525],
12-
[54, 54, 9, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 4045031525],
13-
[56, 11, 9, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 4045031525]
14-
],
15-
"lib/omniauth/identity/models/active_record.rb:1552301885": [
16-
[19, 9, 113, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 2104861380],
17-
[24, 9, 189, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 3443171851]
18-
],
19-
"lib/omniauth/identity/models/couch_potato.rb:2051092700": [
20-
[14, 9, 663, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 2599559599],
21-
[22, 13, 125, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 3604044426],
22-
[27, 13, 83, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 902334745]
23-
],
24-
"lib/omniauth/identity/models/mongoid.rb:1652584382": [
25-
[12, 9, 566, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 3754562029],
26-
[20, 13, 125, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 3604044426],
27-
[25, 13, 83, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 902334745]
28-
],
29-
"lib/omniauth/identity/models/nobrainer.rb:3355783297": [
30-
[12, 9, 568, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 4204154330],
31-
[20, 13, 125, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 3604044426],
32-
[25, 13, 83, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 902334745]
33-
],
34-
"lib/omniauth/identity/models/sequel.rb:3343978269": [
35-
[15, 9, 1972, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 496918361]
36-
],
37-
"lib/omniauth/identity/secure_password.rb:2767570368": [
38-
[13, 7, 113, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 353293128],
39-
[23, 9, 23, "ThreadSafety/ClassAndModuleAttributes: Avoid mutating class and module attributes.", 1578198260]
8+
"lib/omniauth/identity/model.rb:4176389330": [
9+
[71, 11, 9, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 4045031525],
10+
[72, 11, 9, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 4045031525],
11+
[72, 40, 9, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 4045031525],
12+
[72, 54, 9, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 4045031525],
13+
[74, 11, 9, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 4045031525]
14+
],
15+
"lib/omniauth/identity/models/active_record.rb:430408575": [
16+
[54, 9, 113, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 2104861380],
17+
[68, 9, 189, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 3443171851]
18+
],
19+
"lib/omniauth/identity/models/couch_potato.rb:3316956333": [
20+
[42, 9, 1762, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 832901360],
21+
[60, 13, 125, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 3604044426],
22+
[72, 13, 83, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 902334745]
23+
],
24+
"lib/omniauth/identity/models/mongoid.rb:235149629": [
25+
[40, 9, 1350, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 3626154135],
26+
[58, 13, 125, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 3604044426],
27+
[70, 13, 83, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 902334745]
28+
],
29+
"lib/omniauth/identity/models/nobrainer.rb:1006812696": [
30+
[39, 9, 1343, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 1011141886],
31+
[57, 13, 125, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 3604044426],
32+
[69, 13, 83, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 902334745]
33+
],
34+
"lib/omniauth/identity/models/sequel.rb:101522047": [
35+
[44, 9, 3379, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 3595458005]
36+
],
37+
"lib/omniauth/identity/secure_password.rb:2725073634": [
38+
[31, 7, 113, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 353293128],
39+
[46, 9, 23, "ThreadSafety/ClassAndModuleAttributes: Avoid mutating class and module attributes.", 1578198260]
4040
],
4141
"spec/omniauth/identity/model_spec.rb:3920022856": [
4242
[3, 1, 40, "RSpec/SpecFilePathFormat: Spec path should end with `omni_auth/identity/model*_spec.rb`.", 1316823397]

‎docs/OmniAuth.html‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,17 @@
8585

8686
</div>
8787

88-
<h2>Defined Under Namespace</h2>
88+
<h2>Overview</h2><div class="docstring">
89+
<div class="discussion">
90+
<p>Contains version information for the OmniAuth Identity gem.</p>
91+
92+
93+
</div>
94+
</div>
95+
<div class="tags">
96+
97+
98+
</div><h2>Defined Under Namespace</h2>
8999
<p class="children">
90100

91101

@@ -107,7 +117,7 @@ <h2>Defined Under Namespace</h2>
107117
</div>
108118

109119
<div id="footer">
110-
Generated on Sun Oct 12 11:50:39 2025 by
120+
Generated on Mon Oct 13 11:53:19 2025 by
111121
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
112122
0.9.37 (ruby-3.4.7).
113123
</div>

‎docs/OmniAuth/Identity.html‎

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,47 @@
8585

8686
</div>
8787

88-
<h2>Defined Under Namespace</h2>
88+
<h2>Overview</h2><div class="docstring">
89+
<div class="discussion">
90+
<p>OmniAuth Identity provides a way to authenticate users using a username and password<br />
91+
stored in your application’s database. It supports multiple ORMs and provides<br />
92+
secure password hashing.</p>
93+
94+
95+
</div>
96+
</div>
97+
<div class="tags">
98+
99+
<div class="examples">
100+
<h4 class="tag_title">Examples:</h4>
101+
102+
103+
<h5 class="example_title"><div class='inline'><p>Basic Setup</p>
104+
</div></h5>
105+
106+
<pre class="example code"><code><span class='comment'># In your Gemfile
107+
</span><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>omniauth-identity</span><span class='tstring_end'>&#39;</span></span>
108+
109+
<span class='comment'># In your OmniAuth configuration
110+
</span><span class='id identifier rubyid_use'>use</span> <span class='const'><span class='object_link'><a href="../OmniAuth.html" title="OmniAuth (module)">OmniAuth</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Strategies.html" title="OmniAuth::Strategies (module)">Strategies</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Strategies/Identity.html" title="OmniAuth::Strategies::Identity (class)">Identity</a></span></span><span class='comma'>,</span>
111+
<span class='label'>fields:</span> <span class='lbracket'>[</span><span class='symbol'>:email</span><span class='rbracket'>]</span><span class='comma'>,</span>
112+
<span class='label'>model:</span> <span class='const'>User</span></code></pre>
113+
114+
</div>
115+
116+
117+
<p class="tag_title">See Also:</p>
118+
<ul class="see">
119+
120+
<li><span class='object_link'><a href="Strategies/Identity.html" title="OmniAuth::Strategies::Identity (class)">Strategies::Identity</a></span></li>
121+
122+
<li><span class='object_link'><a href="Identity/Model.html" title="OmniAuth::Identity::Model (module)">Model</a></span></li>
123+
124+
<li><span class='object_link'><a href="Identity/SecurePassword.html" title="OmniAuth::Identity::SecurePassword (module)">SecurePassword</a></span></li>
125+
126+
</ul>
127+
128+
</div><h2>Defined Under Namespace</h2>
89129
<p class="children">
90130

91131

@@ -107,7 +147,7 @@ <h2>Defined Under Namespace</h2>
107147
</div>
108148

109149
<div id="footer">
110-
Generated on Sun Oct 12 11:50:39 2025 by
150+
Generated on Mon Oct 13 11:53:19 2025 by
111151
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
112152
0.9.37 (ruby-3.4.7).
113153
</div>

0 commit comments

Comments
 (0)