docs yard

gastonmorixe · Aug 27, 2023 · 82cd468 · 82cd468
1 parent 49e390b
commit 82cd468
Show file tree

Hide file tree

Showing 24 changed files with 4,612 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -12,3 +12,4 @@ pkg/*
 spec/dummy/tmp/*
 spec/dummy/log/*.log
 .idea
+.yardoc
diff --git a/.yardopts b/.yardopts
@@ -4,5 +4,6 @@
 --debug
 --markup=markdown
 --readme=README.md
+--output-dir=./docs/yard
 --title='Rails Fields - Ruby API Documentation'
-'lib/**/*.rb' - '*.md'
+'lib/**/*.rb' - '*.md'.yardoc/
diff --git a/docs/yard/RailsFields.html b/docs/yard/RailsFields.html
@@ -0,0 +1,303 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: RailsFields
+
+    &mdash; Rails Fields - Ruby API Documentation
+
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "RailsFields";
+  relpath = '';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+
+    <a href="_index.html">Index (R)</a> &raquo;
+
+
+    <span class="title">RailsFields</span>
+
+</div>
+
+        <div id="search">
+
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: RailsFields
+
+
+
+</h1>
+<div class="box_info">
+
+
+
+
+
+
+
+
+
+
+
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/rails_fields.rb<span class="defines">,<br />
+  lib/rails_fields/version.rb,<br /> lib/rails_fields/class_methods.rb,<br /> lib/rails_fields/utils/helpers.rb,<br /> lib/rails_fields/utils/logging.rb,<br /> lib/rails_fields/utils/mappings.rb,<br /> lib/rails_fields/instance_methods.rb,<br /> lib/rails_fields/errors/rails_fields_error.rb,<br /> lib/rails_fields/errors/rails_fields_mismatch_error.rb,<br /> lib/rails_fields/errors/rails_fields_unknown_type_error.rb</span>
+</dd>
+  </dl>
+
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Provides enforcement of declared field for ActiveRecord models.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+
+
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="RailsFields/ClassMethods.html" title="RailsFields::ClassMethods (module)">ClassMethods</a></span>, <span class='object_link'><a href="RailsFields/Errors.html" title="RailsFields::Errors (module)">Errors</a></span>, <span class='object_link'><a href="RailsFields/InstanceMethods.html" title="RailsFields::InstanceMethods (module)">InstanceMethods</a></span>, <span class='object_link'><a href="RailsFields/Utils.html" title="RailsFields::Utils (module)">Utils</a></span>
+
+
+
+
+</p>
+
+
+    <h2>
+      Constant Summary
+      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+    </h2>
+
+    <dl class="constants">
+
+        <dt id="VERSION-constant" class="">VERSION =
+
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.2.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+
+    </dl>
+
+
+
+
+
+
+
+
+
+    <h2>
+      Class Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+
+        <li class="public ">
+  <span class="summary_signature">
+
+      <a href="#included-class_method" title="included (class method)">.<strong>included</strong>(base)  &#x21d2; Object </a>
+
+
+
+  </span>
+
+
+
+
+
+
+
+
+
+    <span class="summary_desc"><div class='inline'>
+</div></span>
+
+</li>
+
+
+        <li class="public ">
+  <span class="summary_signature">
+
+      <a href="#processed_classes-class_method" title="processed_classes (class method)">.<strong>processed_classes</strong>  &#x21d2; Object </a>
+
+
+
+  </span>
+
+
+
+
+
+
+
+
+
+    <span class="summary_desc"><div class='inline'>
+</div></span>
+
+</li>
+
+
+    </ul>
+
+
+
+
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+
+
+      <div class="method_details first">
+  <h3 class="signature first" id="included-class_method">
+
+    .<strong>included</strong>(base)  &#x21d2; <tt>Object</tt> 
+
+
+
+
+
+</h3><div class="docstring">
+  <div class="discussion">
+
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+
+    <li>
+
+        <span class='name'>base</span>
+
+
+        <span class='type'>(<tt>ActiveRecord::Base</tt>)</span>
+
+
+
+        &mdash;
+        <div class='inline'><p>the model to include the module in</p>
+</div>
+
+    </li>
+
+</ul>
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+19
+20
+21
+22
+23
+24
+25</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rails_fields.rb', line 19</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span><span class='rparen'>)</span>
+  <span class='comment'># base.extend(ClassMethods)
+</span>  <span class='comment'># todo: raise if class methods not found
+</span>  <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_after_initialize'>after_initialize</span> <span class='kw'>do</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_enforce_declared_fields'>enforce_declared_fields</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+
+      <div class="method_details ">
+  <h3 class="signature " id="processed_classes-class_method">
+
+    .<strong>processed_classes</strong>  &#x21d2; <tt>Object</tt> 
+
+
+
+
+
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+14
+15
+16</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rails_fields.rb', line 14</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_processed_classes'>processed_classes</span>
+  <span class='ivar'>@processed_classes</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+
+  </div>
+
+</div>
+
+      <div id="footer">
+  Generated on Sun Aug 27 17:34:57 2023 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.34 (ruby-3.2.2).
+</div>
+
+    </div>
+  </body>
+</html>