anchormodel 0.0.2 → 0.1.1

data/doc/Anchormodel.html

@@ -103,8 +103,8 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    <p>Inherit from this class and place your Anchormodel under <code>app/anchormodels/your_anchor_model.rb</code>. Use it like <code>Anchormodels::YourAnchorModel</code>.
-Refer to the README for usage.</p>
+    
+<p>Inherit from this class and place your Anchormodel under <code>app/anchormodels/your_anchor_model.rb</code>. Use it like <code>YourAnchorModel</code>. Refer to the README for usage.</p>
 
 
   </div>
@@ -215,7 +215,8 @@ Refer to the README for usage.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Returns all possible values this Anchormodel can take.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns all possible values this Anchormodel can take.</p>
 </div></span>
   
 </li>
@@ -238,7 +239,32 @@ Refer to the README for usage.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Retrieves a particular value given the key.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Retrieves a particular value given the key.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#setup!-class_method" title="setup! (class method)">.<strong>setup!</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>When a descendant of Anchormodel is first used, it must overwrite the class_attributes to prevent cross-class pollution.</p>
 </div></span>
   
 </li>
@@ -294,7 +320,8 @@ Refer to the README for usage.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Call this initializer directly in your Anchormodel class.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Call this initializer directly in your Anchormodel class.</p>
 </div></span>
   
 </li>
@@ -339,7 +366,8 @@ Refer to the README for usage.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Returns a Rails label that is compatible with the <a href="https://github.com/grosser/gettext_i18n_rails/">Rails FastGettext</a> gem.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns a Rails label that is compatible with the <a href="https://github.com/grosser/gettext_i18n_rails/">Rails FastGettext</a> gem.</p>
 </div></span>
   
 </li>
@@ -384,7 +412,8 @@ Refer to the README for usage.</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Call this initializer directly in your Anchormodel class. To set <code>@foo=:bar</code> for anchor <code>:ter</code>, use <code>new(:ter, foo: :bar)</code></p>
+    
+<p>Call this initializer directly in your Anchormodel class. To set <code>@foo=:bar</code> for anchor <code>:ter</code>, use <code>new(:ter, foo: :bar)</code></p>
 
 
   </div>
@@ -403,7 +432,8 @@ Refer to the README for usage.</p>
       
       
         &mdash;
-        <div class='inline'><p>The key under which the entry should be stored.</p>
+        <div class='inline'>
+<p>The key under which the entry should be stored.</p>
 </div>
       
     </li>
@@ -418,7 +448,8 @@ Refer to the README for usage.</p>
       
       
         &mdash;
-        <div class='inline'><p>All named arguments to Anchormodel are made available as instance attributes.</p>
+        <div class='inline'>
+<p>All named arguments to Anchormodel are made available as instance attributes.</p>
 </div>
       
     </li>
@@ -432,27 +463,36 @@ Refer to the README for usage.</p>
       <pre class="lines">
 
 
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
 38
 39
 40
 41
-42</pre>
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 27</span>
+      <pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 38</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_attributes'>attributes</span><span class='rparen'>)</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_setup!'>setup!</span> <span class='kw'>unless</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_setup_completed'>setup_completed</span>
+
   <span class='ivar'>@key</span> <span class='op'>=</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
   <span class='ivar'>@index</span> <span class='op'>=</span> <span class='id identifier rubyid_entries_list'>entries_list</span><span class='period'>.</span><span class='id identifier rubyid_count'>count</span>
 
@@ -467,6 +507,11 @@ Refer to the README for usage.</p>
 
   <span class='comment'># Register valid keys
 </span>  <span class='id identifier rubyid_valid_keys'>valid_keys</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_key'>key</span>
+
+  <span class='comment'># Define boolean reader
+</span>  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_define_method'>define_method</span><span class='lparen'>(</span><span class='symbol'>:&quot;#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>?</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>do</span>
+    <span class='ivar'>@key</span> <span class='op'>==</span> <span class='id identifier rubyid_key'>key</span>
+  <span class='kw'>end</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -578,7 +623,8 @@ Refer to the README for usage.</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns all possible values this Anchormodel can take.</p>
+    
+<p>Returns all possible values this Anchormodel can take.</p>
 
 
   </div>
@@ -592,12 +638,12 @@ Refer to the README for usage.</p>
       <pre class="lines">
 
 
-13
-14
-15</pre>
+24
+25
+26</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 13</span>
+      <pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 24</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span>
   <span class='id identifier rubyid_entries_list'>entries_list</span>
@@ -618,7 +664,8 @@ Refer to the README for usage.</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Retrieves a particular value given the key. Fails if not found.</p>
+    
+<p>Retrieves a particular value given the key. Fails if not found.</p>
 
 
   </div>
@@ -637,7 +684,8 @@ Refer to the README for usage.</p>
       
       
         &mdash;
-        <div class='inline'><p>The key of the value that should be retrieved.</p>
+        <div class='inline'>
+<p>The key of the value that should be retrieved.</p>
 </div>
       
     </li>
@@ -651,13 +699,13 @@ Refer to the README for usage.</p>
       <pre class="lines">
 
 
-19
-20
-21
-22</pre>
+30
+31
+32
+33</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 19</span>
+      <pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 30</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
   <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
@@ -666,6 +714,55 @@ Refer to the README for usage.</p>
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="setup!-class_method">
+  
+    .<strong>setup!</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>When a descendant of Anchormodel is first used, it must overwrite the class_attributes to prevent cross-class pollution.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+15
+16
+17
+18
+19
+20
+21</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 15</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_setup!'>setup!</span>
+  <span class='id identifier rubyid_fail'>fail</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>`setup!` was called twice for Anchormodel subclass </span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='embexpr_end'>}</span><span class='tstring_content'>.</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_setup_completed'>setup_completed</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_entries_list'>entries_list</span> <span class='op'>=</span> <span class='id identifier rubyid_entries_list'>entries_list</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_entries_hash'>entries_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_entries_hash'>entries_hash</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_valid_keys'>valid_keys</span> <span class='op'>=</span> <span class='id identifier rubyid_valid_keys'>valid_keys</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_setup_completed'>setup_completed</span> <span class='op'>=</span> <span class='kw'>true</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
   </div>
@@ -698,12 +795,12 @@ Refer to the README for usage.</p>
       <pre class="lines">
 
 
-44
-45
-46</pre>
+62
+63
+64</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 44</span>
+      <pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 62</span>
 
 <span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
   <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_key'>key</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_key'>key</span>
@@ -737,12 +834,12 @@ Refer to the README for usage.</p>
       <pre class="lines">
 
 
-53
-54
-55</pre>
+71
+72
+73</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 53</span>
+      <pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 71</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span>
   <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>#&lt;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>&gt;:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_hash'>hash</span><span class='embexpr_end'>}</span><span class='tstring_content'>&gt;</span><span class='tstring_end'>&quot;</span></span>
@@ -763,7 +860,8 @@ Refer to the README for usage.</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns a Rails label that is compatible with the <a href="https://github.com/grosser/gettext_i18n_rails/">Rails FastGettext</a> gem.</p>
+    
+<p>Returns a Rails label that is compatible with the <a href="https://github.com/grosser/gettext_i18n_rails/">Rails FastGettext</a> gem.</p>
 
 
   </div>
@@ -777,12 +875,12 @@ Refer to the README for usage.</p>
       <pre class="lines">
 
 
-49
-50
-51</pre>
+67
+68
+69</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 49</span>
+      <pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 67</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_label'>label</span>
   <span class='const'>I18n</span><span class='period'>.</span><span class='id identifier rubyid_t'>t</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_demodulize'>demodulize</span><span class='embexpr_end'>}</span><span class='tstring_content'>|</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_humanize'>humanize</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
@@ -816,12 +914,12 @@ Refer to the README for usage.</p>
       <pre class="lines">
 
 
-57
-58
-59</pre>
+75
+76
+77</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 57</span>
+      <pre class="code"><span class="info file"># File 'lib/anchormodel.rb', line 75</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
   <span class='id identifier rubyid_inspect'>inspect</span>
@@ -836,9 +934,9 @@ Refer to the README for usage.</p>
 </div>
 
       <div id="footer">
-  Generated on Sat Dec 17 12:56:00 2022 by
+  Generated on Tue Jan 24 20:27:59 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.28 (ruby-3.0.4).
+  0.9.28 (ruby-3.1.3).
 </div>
 
     </div>

data/doc/_index.html

@@ -141,9 +141,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Dec 17 12:56:00 2022 by
+  Generated on Tue Jan 24 20:27:58 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.28 (ruby-3.0.4).
+  0.9.28 (ruby-3.1.3).
 </div>
 
     </div>

data/doc/file.README.html

@@ -57,63 +57,59 @@
         <div class="clear"></div>
       </div>
 
-      <div id="content"><div id='filecontents'><h1 id="introducing-anchormodel">Introducing Anchormodel</h1>
+      <div id="content"><div id='filecontents'>
+<p>&lt;img src=“logo.svg” height=250 alt=“Anchormodel logo”/&gt;</p>
 
-<p>This gem provides a simple but powerful alternative to <a href="https://api.rubyonrails.org/v7.0/classes/ActiveRecord/Enum.html">Rails
-Enums</a>. In
-contrast to regular Enums, Anchormodels can hold application logic, making them
-ideal for tying code to database objects.</p>
+<h1 id="label-Introducing+Anchormodel">Introducing Anchormodel</h1>
 
-<h1 id="use-case">Use case</h1>
+<p>This gem provides a simple but powerful alternative to <a href="https://api.rubyonrails.org/v7.0/classes/ActiveRecord/Enum.html">Rails Enums</a>. In contrast to regular Enums, Anchormodels can hold application logic, making them ideal for tying code to database objects.</p>
+
+<h1 id="label-Use+case">Use case</h1>
 
 <p>Typically, a Rails application consists of three kinds of state:</p>
+<ul><li>
+<p>The code, which we can consider static within a given version. Code can  reference to other code, e.g. <code>node.parent = other_node</code>.</p>
+</li><li>
+<p>The database contents, which can fluctuate within the bounds of the DB schema.  Data can reference to other data, ideally via foreign keys.</p>
+</li><li>
+<p>A mix of the two, where code needs to be specifically tailored for some kind  of data. A prominent example of such a mix would for instance be user roles:  roles must be hardcoded in the code because security logic is tied to them.  However, as users are assigned to roles in the database, roles also need to be  persisted in the database. This is where Anchormodel comes into play.</p>
+</li></ul>
 
-<ul>
-<li>The code, which we can consider static within a given version. Code can
-reference to other code, e.g. <code>node.parent = other_node</code>.</li>
-<li>The database contents, which can fluctuate within the bounds of the DB schema.
-Data can reference to other data, ideally via foreign keys.</li>
-<li>A mix of the two, where code needs to be specifically tailored for some kind
-of data. A prominent example of such a mix would for instance be user roles:
-roles must be hardcoded in the code because security logic is tied to them.
-However, as users are assigned to roles in the database, roles also need to be
-persisted in the database. This is where Anchormodel comes into play.</li>
-</ul>
+<h2 id="label-Alternatives+coviering+the+same+use+case">Alternatives coviering the same use case</h2>
 
-<h2 id="alternatives-coviering-the-same-use-case">Alternatives coviering the same use case</h2>
+<h3 id="label-Enum">Enum</h3>
 
-<h3 id="enum">Enum</h3>
+<p>In Rails and other frameworks, the third point in the listing above is typically achieved via Enums. Enums map either Integers or Strings to constants and therefore provide a link between the DB and the application code.</p>
 
-<p>In Rails and other frameworks, the third point in the listing above is typically
-achieved via Enums. Enums map either Integers or Strings to constants and
-therefore provide a link between the DB and the application code.</p>
+<p>However, at least in Rails, Enums provide very limited customization options. They are basic values that can be used in if-statements. Anchormodels however are regular classes and can easily be extended.</p>
 
-<p>However, at least in Rails, Enums provide very limited customization options.
-They are basic values that can be used in if-statements. Anchormodels however
-are regular classes and can easily be extended.</p>
+<h3 id="label-ActiveEnum">ActiveEnum</h3>
 
-<h3 id="activeenum">ActiveEnum</h3>
+<p>The gem (<a href="https://github.com/adzap/active_enum">ActiveEnum)</a> allows to create Enum-like classes that can be extended. However it only supports Integer keys. I find this unsatisfactory, as debugging with tools like <code>psql</code> or <code>mysql</code> is made unnecessarily hard when you only see numbers. Keys for enums should be meaningful, making you immediately understand what they stand for.</p>
 
-<p>The gem (ActiveEnum)[<a href="https://github.com/adzap/active_enum">https://github.com/adzap/active_enum</a>] allows to create
-Enum-like classes that can be extended. However it only supports Integer keys. I
-find this unsatisfactory, as debugging with tools like <code>psql</code> or <code>mysql</code> is made
-unnecessarily hard when you only see numbers. Keys for enums should be
-meaningful, making you immediately understand what they stand for.</p>
+<p>This is why Anchormodel is strictly relying on String keys corresponding to the entries of an Anchormodel.</p>
 
-<p>This is why Anchormodel is strictly relying on String keys corresponding to the
-entries of an Anchormodel.</p>
+<h1 id="label-Installation">Installation</h1>
+<ol><li>
+<p>Add gem to Gemfile: <code>gem &#39;anchormodel&#39;</code></p>
+</li><li>
+<p>In <code>application_record.rb</code>, add in the class body: <code>include Anchormodel::ModelMixin</code></p>
+</li></ol>
 
-<h1 id="example">Example</h1>
+<h1 id="label-Basic+example">Basic example</h1>
 
 <p><code>app/anchormodels/role.rb</code>:</p>
 
-<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>Anchormodels</span><span class='op'>::</span><span class='const'>Role</span> <span class='op'>&lt;</span> <span class='const'><span class='object_link'><a href="Anchormodel.html" title="Anchormodel (class)">Anchormodel</a></span></span>
+<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>Role</span> <span class='op'>&lt;</span> <span class='const'><span class='object_link'><a href="Anchormodel.html" title="Anchormodel (class)">Anchormodel</a></span></span>
+  <span class='comment'># Make &lt;, &gt; etc. based on &lt;=&gt; operator whic hwe will define below
+</span>  <span class='id identifier rubyid_include'>include</span> <span class='const'>Comparable</span>
+
   <span class='comment'># Expose the attribute privilege_level
 </span>  <span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:privilege_level</span>
 
-  <span class='comment'># Overload &lt;=&gt; to make user roles comparable based on the privilege level
+  <span class='comment'># Define &lt;=&gt; to make user roles comparable based on the privilege level
 </span>  <span class='kw'>def</span> <span class='op'>&lt;=&gt;</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
-    <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_privilege_level'>privilege_level</span> <span class='op'>&lt;=&gt;</span> <span class='ivar'>@privilege_level</span>
+    <span class='ivar'>@privilege_level</span> <span class='op'>&lt;=&gt;</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_privilege_level'>privilege_level</span>
   <span class='kw'>end</span>
 
   <span class='comment'># Declare all available roles
@@ -127,17 +123,21 @@ entries of an Anchormodel.</p>
 
 <pre class="code ruby"><code class="ruby"><span class='comment'># The DB table `users` must have a String column `users.role`
 </span><span class='kw'>class</span> <span class='const'>User</span> <span class='op'>&lt;</span> <span class='const'>ApplicationRecord</span>
-  <span class='id identifier rubyid_belongs_to_anchormodel'>belongs_to_anchormodel</span> <span class='symbol'>:role</span>
+  <span class='comment'># If `users.role` has an `NOT NULL` constraint, use:
+</span>  <span class='id identifier rubyid_belongs_to_anchormodel'>belongs_to_anchormodel</span> <span class='symbol'>:role</span>
+
+  <span class='comment'># If `users.role` can be `NULL`, use the following instead:
+</span>  <span class='id identifier rubyid_belongs_to_anchormodel'>belongs_to_anchormodel</span> <span class='symbol'>:role</span><span class='comma'>,</span> <span class='label'>optional:</span> <span class='kw'>true</span>
 <span class='kw'>end</span>
 </code></pre>
 
 <p>You may now use the following methods:</p>
 
 <pre class="code ruby"><code class="ruby"><span class='comment'># Retrieve all user roles:
-</span><span class='const'>Anchormodels</span><span class='op'>::</span><span class='const'>Role</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span>
+</span><span class='const'>Role</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span>
 
 <span class='comment'># Retrieve a specific role from the String and find its privilege level
-</span><span class='const'>Anchormodels</span><span class='op'>::</span><span class='const'>Role</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='symbol'>:guest</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_privilege_level'>privilege_level</span>
+</span><span class='const'>Role</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='symbol'>:guest</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_privilege_level'>privilege_level</span>
 
 <span class='comment'># Implement a Rails helper that makes sure users can only edit other users that have a lower privilege level than themselves
 </span><span class='kw'>def</span> <span class='id identifier rubyid_user_can_edit?'>user_can_edit?</span><span class='lparen'>(</span><span class='id identifier rubyid_this_user'>this_user</span><span class='comma'>,</span> <span class='id identifier rubyid_other_user'>other_user</span><span class='rparen'>)</span>
@@ -146,20 +146,91 @@ entries of an Anchormodel.</p>
 
 <span class='comment'># Pretty print a user&#39;s role, e.g. using the Rails FastGettext gem:
 </span><span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>User </span><span class='embexpr_beg'>#{</span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'> has role </span><span class='embexpr_beg'>#{</span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_role'>role</span><span class='period'>.</span><span class='id identifier rubyid_label'>label</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+
+<span class='comment'># Check whether @user has role admin
+</span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_role'>role</span><span class='period'>.</span><span class='id identifier rubyid_admin?'>admin?</span> <span class='comment'># true if and only if the role is admin (false otherwise)
+</span></code></pre>
+
+<h1 id="label-Rails+Enum+style+model+methods">Rails Enum style model methods</h1>
+
+<p>By default, Anchormodel adds three kinds of methods for each key to the model:</p>
+<ul><li>
+<p>a reader (getter)</p>
+</li><li>
+<p>a writer (setter)</p>
+</li><li>
+<p>a Rails scope</p>
+</li></ul>
+
+<p>For instance:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>User</span> <span class='op'>&lt;</span> <span class='const'>ApplicationRecord</span>
+  <span class='id identifier rubyid_belongs_to_anchormodel'>belongs_to_anchormodel</span> <span class='symbol'>:role</span> <span class='comment'># where Role has keys :guest, :manager and :admin
+</span>  <span class='id identifier rubyid_belongs_to_anchormodel'>belongs_to_anchormodel</span> <span class='symbol'>:shape</span> <span class='comment'># where Shape has keys :circle and :rectangle
+</span><span class='kw'>end</span>
+
+<span class='comment'># User now implements the following methods, given that @user is retrieved as follows:
+</span><span class='ivar'>@user</span> <span class='op'>=</span> <span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span> <span class='comment'># for example
+</span>
+<span class='comment'># Readers
+</span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_guest?'>guest?</span> <span class='comment'># same as @user.role.guest?
+</span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_manager?'>manager?</span>
+<span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_admin?'>admin?</span>
+<span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_rectangle?'>rectangle?</span> <span class='comment'># same as @user.shape.rectangle?
+</span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_circle?'>circle?</span>
+<span class='comment'># Writers
+</span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_guest!'>guest!</span> <span class='comment'># same as @user.role = Role.find(:guest)
+</span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_manager!'>manager!</span>
+<span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_admin!'>admin!</span>
+<span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_rectangle!'>rectangle!</span> <span class='comment'># same as @user.shape = Shape.find(:rectangle)
+</span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_circle!'>circle!</span>
+<span class='comment'># Scopes
+</span><span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_guest'>guest</span> <span class='comment'># same as User.where(role: &#39;guest&#39;)
+</span><span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_manager'>manager</span>
+<span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_admin'>admin</span>
+<span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_rectangle'>rectangle</span> <span class='comment'># same as User.where(shape: &#39;rectangle&#39;)
+</span><span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_circle'>circle</span>
+</code></pre>
+
+<p>This behavior is similar as the one from Rails Enums. If you want to disable it, use:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>User</span> <span class='op'>&lt;</span> <span class='const'>ApplicationRecord</span>
+  <span class='id identifier rubyid_belongs_to_anchormodel'>belongs_to_anchormodel</span> <span class='symbol'>:role</span><span class='comma'>,</span> <span class='label'>model_readers:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>model_writers:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>model_scopes:</span> <span class='kw'>false</span>
+  <span class='comment'># or, equivalent, to disable all at once:
+</span>  <span class='id identifier rubyid_belongs_to_anchormodel'>belongs_to_anchormodel</span> <span class='symbol'>:role</span><span class='comma'>,</span> <span class='label'>model_methods:</span> <span class='kw'>false</span>
+<span class='kw'>end</span>
+</code></pre>
+
+<h1 id="label-Calling+a+column+differently+than+the+Anchormodel">Calling a column differently than the Anchormodel</h1>
+
+<p>If your column name (and the model’s attribute) is called differently than the Anchormodel, you may give the Anchormodel’s class as the second argument. For example:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='comment'># app/anchormodels/color.rb
+</span><span class='kw'>class</span> <span class='const'>Color</span> <span class='op'>&lt;</span> <span class='const'><span class='object_link'><a href="Anchormodel.html" title="Anchormodel (class)">Anchormodel</a></span></span>
+  <span class='id identifier rubyid_new'>new</span> <span class='symbol'>:green</span>
+  <span class='id identifier rubyid_new'>new</span> <span class='symbol'>:red</span>
+<span class='kw'>end</span>
+
+<span class='comment'># app/models/user.rb
+</span><span class='kw'>class</span> <span class='const'>User</span> <span class='op'>&lt;</span> <span class='const'>ApplicationRecord</span>
+  <span class='id identifier rubyid_belongs_to_anchormodel'>belongs_to_anchormodel</span> <span class='symbol'>:favorite_color</span><span class='comma'>,</span> <span class='const'>Color</span>
+<span class='kw'>end</span>
 </code></pre>
 
-<h1 id="installation">Installation</h1>
+<h2 id="label-Having+multiple+attributes+to+the+same+Anchormodel">Having multiple attributes to the same Anchormodel</h2>
 
-<ol>
-<li>Add gem to Gemfile: <code>gem &#39;anchormodel&#39;</code></li>
-<li>In <code>application_record.rb</code>, add in the class body: <code>include Anchormodel::ModelMixin</code></li>
-</ol>
+<p>If you want to have multiple attributes in the same model pointing to the same Anchormodel, you need to disable <code>model_methods</code> for at least one of them (otherwise the model methods will clash in your model class):</p>
+
+<pre class="code ruby"><code class="ruby"><span class='comment'># app/models/user.rb
+</span>  <span class='id identifier rubyid_belongs_to_anchormodel'>belongs_to_anchormodel</span> <span class='symbol'>:role</span>
+  <span class='id identifier rubyid_belongs_to_anchormodel'>belongs_to_anchormodel</span> <span class='symbol'>:secondary_role</span><span class='comma'>,</span> <span class='const'>Role</span><span class='comma'>,</span> <span class='label'>model_methods:</span> <span class='kw'>false</span>
+</code></pre>
 </div></div>
 
       <div id="footer">
-  Generated on Sat Dec 17 12:56:00 2022 by
+  Generated on Tue Jan 24 20:27:59 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.28 (ruby-3.0.4).
+  0.9.28 (ruby-3.1.3).
 </div>
 
     </div>