Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@bjkeller
bjkeller committed Oct 28, 2019
1 parent 367ec9c commit ac5f402
Show file tree
Hide file tree
Showing 35 changed files with 8,594 additions and 3,916 deletions.
1,129 changes: 560 additions & 569 deletions docs/api/Collection.html
View file

Large diffs are not rendered by default.

66 changes: 26 additions & 40 deletions docs/api/DataAssociation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -278,12 +278,12 @@ <h3 class="signature first" id="find_parent-class_method">
<pre class="lines">


24
25
26</pre>
26
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/models/data_association.rb', line 24</span>
<pre class="code"><span class="info file"># File 'app/models/data_association.rb', line 26</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_find_parent'>find_parent</span><span class='lparen'>(</span><span class='id identifier rubyid_parent_class'>parent_class</span><span class='comma'>,</span> <span class='id identifier rubyid_parent_id'>parent_id</span><span class='rparen'>)</span>
<span class='const'>Object</span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='id identifier rubyid_parent_class'>parent_class</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_parent_id'>parent_id</span><span class='rparen'>)</span>
Expand Down Expand Up @@ -323,14 +323,14 @@ <h3 class="signature first" id="as_json-instance_method">
<pre class="lines">


18
19
20
21
22</pre>
22
23
24</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/models/data_association.rb', line 18</span>
<pre class="code"><span class="info file"># File 'app/models/data_association.rb', line 20</span>

<span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span><span class='lparen'>(</span><span class='id identifier rubyid__options'>_options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='kw'>super</span><span class='lparen'>(</span><span class='label'>include:</span> <span class='symbol'>:upload</span><span class='rparen'>)</span>
Expand Down Expand Up @@ -366,14 +366,14 @@ <h3 class="signature " id="full_object-instance_method">
<pre class="lines">


7
8
9
10
11</pre>
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/models/data_association.rb', line 7</span>
<pre class="code"><span class="info file"># File 'app/models/data_association.rb', line 9</span>

<span class='kw'>def</span> <span class='id identifier rubyid_full_object'>full_object</span>
<span class='const'>HashWithIndifferentAccess</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='comma'>,</span> <span class='label'>symbolize_names:</span> <span class='kw'>true</span><span class='rparen'>)</span><span class='rparen'>)</span>
Expand Down Expand Up @@ -409,8 +409,6 @@ <h3 class="signature " id="may_delete-instance_method">
<pre class="lines">


28
29
30
31
32
Expand All @@ -419,32 +417,20 @@ <h3 class="signature " id="may_delete-instance_method">
35
36
37
38
39
40
41
42
43</pre>
38</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/models/data_association.rb', line 28</span>
<pre class="code"><span class="info file"># File 'app/models/data_association.rb', line 30</span>

<span class='kw'>def</span> <span class='id identifier rubyid_may_delete'>may_delete</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
<span class='id identifier rubyid_parent'>parent</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="DataAssociation (class)">DataAssociation</a></span></span><span class='period'>.</span><span class='id identifier rubyid_find_parent'><span class='object_link'><a href="#find_parent-class_method" title="DataAssociation.find_parent (method)">find_parent</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_parent_class'>parent_class</span><span class='comma'>,</span> <span class='id identifier rubyid_parent_id'>parent_id</span><span class='rparen'>)</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Class = </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_parent_class'>parent_class</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>if</span> <span class='id identifier rubyid_parent_class'>parent_class</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Item</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>return</span> <span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_sample'>sample</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_sample'>sample</span><span class='period'>.</span><span class='id identifier rubyid_user_id'>user_id</span> <span class='op'>=</span> <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_parent_class'>parent_class</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Collection</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>return</span> <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_is_admin'>is_admin</span> <span class='comment'># since collections are managed by admins?
</span> <span class='kw'>elsif</span> <span class='id identifier rubyid_parent_class'>parent_class</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Operation</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>return</span> <span class='kw'>true</span> <span class='comment'># since operations don&#39;t yet have owners (actually they do now, so this should be fixed)
</span> <span class='kw'>elsif</span> <span class='id identifier rubyid_parent_class'>parent_class</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Plan</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>return</span> <span class='kw'>true</span> <span class='comment'># plans don&#39;t have owners yet either
</span> <span class='kw'>elsif</span> <span class='id identifier rubyid_parent_class'>parent_class</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>OperationType</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>return</span> <span class='kw'>true</span> <span class='comment'># operation types don&#39;t have owners yet either
</span> <span class='kw'>end</span>

<span class='kw'>end</span></pre>
<span class='kw'>return</span> <span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_sample'>sample</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_sample'>sample</span><span class='period'>.</span><span class='id identifier rubyid_user_id'>user_id</span> <span class='op'>=</span> <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='kw'>if</span> <span class='id identifier rubyid_parent_class'>parent_class</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Item</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>return</span> <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_is_admin'>is_admin</span> <span class='kw'>if</span> <span class='id identifier rubyid_parent_class'>parent_class</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Collection</span><span class='tstring_end'>&#39;</span></span> <span class='comment'># since collections are managed by admins?
</span> <span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id identifier rubyid_parent_class'>parent_class</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Operation</span><span class='tstring_end'>&#39;</span></span> <span class='comment'># since operations don&#39;t yet have owners (actually they do now, so this should be fixed)
</span> <span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id identifier rubyid_parent_class'>parent_class</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Plan</span><span class='tstring_end'>&#39;</span></span> <span class='comment'># plans don&#39;t have owners yet either
</span> <span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id identifier rubyid_parent_class'>parent_class</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>OperationType</span><span class='tstring_end'>&#39;</span></span> <span class='comment'># operation types don&#39;t have owners yet either
</span><span class='kw'>end</span></pre>
</td>
</tr>
</table>
Expand Down Expand Up @@ -474,13 +460,13 @@ <h3 class="signature " id="value-instance_method">
<pre class="lines">


13
14
15
16</pre>
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/models/data_association.rb', line 13</span>
<pre class="code"><span class="info file"># File 'app/models/data_association.rb', line 15</span>

<span class='kw'>def</span> <span class='id identifier rubyid_value'>value</span>
<span class='id identifier rubyid_h'>h</span> <span class='op'>=</span> <span class='id identifier rubyid_full_object'>full_object</span>
Expand All @@ -496,9 +482,9 @@ <h3 class="signature " id="value-instance_method">
</div>

<div id="footer">
Generated on Tue Jul 2 18:20:17 2019 by
Generated on Sun Oct 27 20:08:49 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.20 (ruby-2.6.3).
0.9.20 (ruby-2.6.4).
</div>

</div>
Expand Down
Loading

0 comments on commit ac5f402

Please sign in to comment.