Prepare for 0.1.0 Gem release; add HISTORY.md

* One issue known to need resolution prior to 1.0.0 release (#20); * One has been moved to _The Glorious Future™_ milestone (#16); and * One has simply been labelled `wontfix` with no milestone specified (#14). 81 tests, 110 assertions, 0 failures, 0 errors, 0 skips Coverage: 918 / 918 LOC (100.0%) covered. RuboCop: 11 files inspected, no offenses detected Flay: Total score 0 Flog: Total 329.8; method average 4.6; max 9.8 (CryptIdent::SignUp#create_result) Reek: 0 total warnings Inch: Nothing to suggest
jdickey · Dec 18, 2018 · ddffc96 · ddffc96
1 parent e4568b9
commit ddffc96
Show file tree

Hide file tree

Showing 12 changed files with 106 additions and 12 deletions.
diff --git a/.yardopts b/.yardopts
@@ -12,4 +12,5 @@
 --title 'crypt_ident Module Documentation'
 -
 CODE_OF_CONDUCT.md
-LICENSE.txt
+HISTORY.md
+LICENSE.txt
diff --git a/HISTORY.md b/HISTORY.md
@@ -0,0 +1,8 @@
+# CryptIdent Version History
+
+## 0.1.0 (18 December 2018)
+
+Initial public (pre-)release.
+
+"Why isn't this 1.0.0?", you ask. Because nobody, including me, has yet put code using `CryptIdent` into production (internal or otherwise). Therefore, any problems encountered in doing so can be resolved prior to an official 1.0.0 release. After 1.0.0, [semantic-versioning](https://semver.org/) rules apply.
+
diff --git a/docs/CryptIdent.html b/docs/CryptIdent.html
@@ -1107,7 +1107,7 @@ <h3 class="signature first" id="change_password-instance_method">
       <pre class="code"><span class="info file"># File 'lib/crypt_ident.rb', line 459</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_change_password'>change_password</span><span class='lparen'>(</span><span class='id identifier rubyid_user_in'>user_in</span><span class='comma'>,</span> <span class='id identifier rubyid_current_password'>current_password</span><span class='comma'>,</span> <span class='id identifier rubyid_new_password'>new_password</span><span class='comma'>,</span> <span class='label'>repo:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_new_params'>new_params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>config:</span> <span class='const'><span class='object_link'><a href="" title="CryptIdent (module)">CryptIdent</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure_crypt_ident'><span class='object_link'><a href="#configure_crypt_ident-class_method" title="CryptIdent.configure_crypt_ident (method)">configure_crypt_ident</a></span></span><span class='comma'>,</span> <span class='label'>repo:</span> <span class='id identifier rubyid_repo'>repo</span><span class='comma'>,</span>
+  <span class='id identifier rubyid_new_params'>new_params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>config:</span> <span class='const'><span class='object_link'><a href="" title="CryptIdent (module)">CryptIdent</a></span></span><span class='period'>.</span><span class='id identifier rubyid_cryptid_config'><span class='object_link'><a href="#cryptid_config-instance_method" title="CryptIdent#cryptid_config (method)">cryptid_config</a></span></span><span class='comma'>,</span> <span class='label'>repo:</span> <span class='id identifier rubyid_repo'>repo</span><span class='comma'>,</span>
                  <span class='label'>user:</span> <span class='id identifier rubyid_user_in'>user_in</span> <span class='rbrace'>}</span>
   <span class='id identifier rubyid_call_params'>call_params</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_current_password'>current_password</span><span class='comma'>,</span> <span class='id identifier rubyid_new_password'>new_password</span><span class='rbracket'>]</span>
   <span class='const'>ChangePassword</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_new_params'>new_params</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_call_params'>call_params</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_result'>result</span><span class='op'>|</span> <span class='kw'>yield</span> <span class='id identifier rubyid_result'>result</span> <span class='rbrace'>}</span>
@@ -2783,7 +2783,7 @@ <h3 class="signature " id="update_session_expiry-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 16 15:42:48 2018 by
+  Generated on Tue Dec 18 23:22:16 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.16 (ruby-2.5.3).
 </div>

diff --git a/docs/CryptIdent/Config.html b/docs/CryptIdent/Config.html
@@ -246,7 +246,7 @@ <h2>
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 16 15:42:48 2018 by
+  Generated on Tue Dec 18 23:22:16 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.16 (ruby-2.5.3).
 </div>

diff --git a/docs/_index.html b/docs/_index.html
@@ -66,7 +66,10 @@ <h2>File Listing</h2>
     <li class="r2"><a href="file.CODE_OF_CONDUCT.html" title="CODE_OF_CONDUCT">CODE_OF_CONDUCT</a></li>
 
 
-    <li class="r1"><a href="file.LICENSE.html" title="LICENSE">LICENSE</a></li>
+    <li class="r1"><a href="file.HISTORY.html" title="HISTORY">HISTORY</a></li>
+
+
+    <li class="r2"><a href="file.LICENSE.html" title="LICENSE">LICENSE</a></li>
 
 
   </ul>
@@ -110,7 +113,7 @@ <h2>Namespace Listing A-Z</h2>
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 16 15:42:48 2018 by
+  Generated on Tue Dec 18 23:22:15 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.16 (ruby-2.5.3).
 </div>

diff --git a/docs/file.CODE_OF_CONDUCT.html b/docs/file.CODE_OF_CONDUCT.html
@@ -135,7 +135,7 @@ <h2>Attribution</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Sun Dec 16 15:42:48 2018 by
+  Generated on Tue Dec 18 23:22:15 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.16 (ruby-2.5.3).
 </div>

diff --git a/docs/file.HISTORY.html b/docs/file.HISTORY.html
@@ -0,0 +1,77 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  File: HISTORY
+
+    &mdash; crypt_ident Module Documentation
+
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  pathId = "HISTORY";
+  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="file_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</a> &raquo; 
+    <span class="title">File: HISTORY</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"><div id='filecontents'><h1>CryptIdent Version History</h1>
+
+<h2>0.1.0 (18 December 2018)</h2>
+
+<p>Initial public (pre-)release.</p>
+
+<p>&quot;Why isn&#39;t this 1.0.0?&quot;, you ask. Because nobody, including me, has yet put code using <code>CryptIdent</code> into production (internal or otherwise). Therefore, any problems encountered in doing so can be resolved prior to an official 1.0.0 release. After 1.0.0, <a href="https://semver.org/">semantic-versioning</a> rules apply.</p>
+</div></div>
+
+      <div id="footer">
+  Generated on Tue Dec 18 23:22:15 2018 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.16 (ruby-2.5.3).
+</div>
+
+    </div>
+  </body>
+</html>
diff --git a/docs/file.LICENSE.html b/docs/file.LICENSE.html
@@ -60,7 +60,7 @@
       <div id="content"><div id='filecontents'>The MIT License (MIT)<br/><br/>Copyright (c) 2018 Jeff Dickey<br/><br/>Permission is hereby granted, free of charge, to any person obtaining a copy<br/>of this software and associated documentation files (the &quot;Software&quot;), to deal<br/>in the Software without restriction, including without limitation the rights<br/>to use, copy, modify, merge, publish, distribute, sublicense, and/or sell<br/>copies of the Software, and to permit persons to whom the Software is<br/>furnished to do so, subject to the following conditions:<br/><br/>The above copyright notice and this permission notice shall be included in<br/>all copies or substantial portions of the Software.<br/><br/>THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR<br/>IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,<br/>FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE<br/>AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER<br/>LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,<br/>OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN<br/>THE SOFTWARE.</div></div>
 
       <div id="footer">
-  Generated on Sun Dec 16 15:42:48 2018 by
+  Generated on Tue Dec 18 23:22:15 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.16 (ruby-2.5.3).
 </div>

diff --git a/docs/file.README.html b/docs/file.README.html
@@ -635,7 +635,7 @@ <h1>Code of Conduct</h1>
 </div></div>
 
       <div id="footer">
-  Generated on Sun Dec 16 15:42:48 2018 by
+  Generated on Tue Dec 18 23:22:15 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.16 (ruby-2.5.3).
 </div>

diff --git a/docs/file_list.html b/docs/file_list.html
@@ -54,7 +54,12 @@ <h1 id="full_list_header">File List</h1>
   </li>
 
 
-  <li id="object_LICENSE" class="odd">
+  <li id="object_HISTORY" class="odd">
+    <div class="item"><span class="object_link"><a href="file.HISTORY.html" title="HISTORY">HISTORY</a></span></div>
+  </li>
+
+
+  <li id="object_LICENSE" class="even">
     <div class="item"><span class="object_link"><a href="file.LICENSE.html" title="LICENSE">LICENSE</a></span></div>
   </li>
 

diff --git a/docs/index.html b/docs/index.html
@@ -635,7 +635,7 @@ <h1>Code of Conduct</h1>
 </div></div>
 
       <div id="footer">
-  Generated on Sun Dec 16 15:42:48 2018 by
+  Generated on Tue Dec 18 23:22:15 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.16 (ruby-2.5.3).
 </div>

diff --git a/docs/top-level-namespace.html b/docs/top-level-namespace.html
@@ -100,7 +100,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 16 15:42:48 2018 by
+  Generated on Tue Dec 18 23:22:15 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.16 (ruby-2.5.3).
 </div>