RubyGems - rbcli - Versions diffs - 0.2.11 → 0.2.12 - Mend

rbcli 0.2.11 → 0.2.12

Files changed (426) hide show

data/docs/development/changelog/index.html ADDED

@@ -0,0 +1,1368 @@
+<!DOCTYPE html>
+<html lang="en" class="js csstransforms3d">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="generator" content="Hugo 0.55.6" />
+    <meta name="description" content="">
+    <link rel="icon" href="/rbcli/images/favicon.png" type="image/png">
+    <title>Changelog :: RBCli Documentation</title>
+    <link href="/rbcli/css/nucleus.css?1561087612" rel="stylesheet">
+    <link href="/rbcli/css/fontawesome-all.min.css?1561087612" rel="stylesheet">
+    <link href="/rbcli/css/hybrid.css?1561087612" rel="stylesheet">
+    <link href="/rbcli/css/featherlight.min.css?1561087612" rel="stylesheet">
+    <link href="/rbcli/css/perfect-scrollbar.min.css?1561087612" rel="stylesheet">
+    <link href="/rbcli/css/auto-complete.css?1561087612" rel="stylesheet">
+    <link href="/rbcli/css/atom-one-dark-reasonable.css?1561087612" rel="stylesheet">
+    <link href="/rbcli/css/theme.css?1561087612" rel="stylesheet">
+    <link href="/rbcli/css/hugo-theme.css?1561087612" rel="stylesheet">
+      <link href="/rbcli/css/theme-blue.css?1561087612" rel="stylesheet">
+    <script src="/rbcli/js/jquery-3.3.1.min.js?1561087612"></script>
+    <style>
+      :root #header + #content > #left > #rlblock_left{
+          display:none !important;
+      }
+    </style>
+  </head>
+  <body class="" data-url="/rbcli/development/changelog/">
+    <nav id="sidebar" class="">
+  <div id="header-wrapper">
+    <div id="header">
+      <a id="logo" href="https://akhoury6.github.io/rbcli/" style="font-size: 40px">
+  <span class="fas fa-terminal"></span>&nbsp;𝚁𝙱𝙲𝚕𝚒
+</a>
+    </div>
+        <div class="searchbox">
+    <label for="search-by"><i class="fas fa-search"></i></label>
+    <input data-search-input id="search-by" type="search" placeholder="Search...">
+    <span data-search-clear=""><i class="fas fa-times"></i></span>
+</div>
+<script type="text/javascript" src="/rbcli/js/lunr.min.js?1561087612"></script>
+<script type="text/javascript" src="/rbcli/js/auto-complete.js?1561087612"></script>
+<script type="text/javascript">
+        var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
+</script>
+<script type="text/javascript" src="/rbcli/js/search.js?1561087612"></script>
+  </div>
+    <div class="highlightable">
+    <ul class="topics">
+    <li data-nav-id="/rbcli/quick_reference/" title="Quick Reference" class="dd-item
+        ">
+      <a href="/rbcli/quick_reference/">
+          Quick Reference
+      </a>
+    </li>
+    <li data-nav-id="/rbcli/tutorial/" title="Tutorial" class="dd-item
+        ">
+      <a href="/rbcli/tutorial/">
+          Tutorial
+      </a>
+        <ul>
+      <li data-nav-id="/rbcli/tutorial/10-getting_started/" title="Getting Started" class="dd-item ">
+        <a href="/rbcli/tutorial/10-getting_started/">
+        <b>1. </b>Getting Started
+        </a>
+    </li>
+      <li data-nav-id="/rbcli/tutorial/20-project_layout/" title="The Project Layout" class="dd-item ">
+        <a href="/rbcli/tutorial/20-project_layout/">
+        <b>2. </b>The Project Layout
+        </a>
+    </li>
+      <li data-nav-id="/rbcli/tutorial/30-your_first_command/" title="Your First Command" class="dd-item ">
+        <a href="/rbcli/tutorial/30-your_first_command/">
+        <b>3. </b>Your First Command
+        </a>
+    </li>
+      <li data-nav-id="/rbcli/tutorial/40-options_parameters_and_arguments/" title="Options, Parameters, and Arguments" class="dd-item ">
+        <a href="/rbcli/tutorial/40-options_parameters_and_arguments/">
+        <b>4. </b>Options, Parameters, and Arguments
+        </a>
+    </li>
+      <li data-nav-id="/rbcli/tutorial/50-publishing/" title="Publishing Your Application" class="dd-item ">
+        <a href="/rbcli/tutorial/50-publishing/">
+        <b>5. </b>Publishing Your Application
+        </a>
+    </li>
+        </ul>
+    </li>
+    <li data-nav-id="/rbcli/advanced/" title="Advanced" class="dd-item
+        ">
+      <a href="/rbcli/advanced/">
+          Advanced
+      </a>
+        <ul>
+      <li data-nav-id="/rbcli/advanced/automatic_updates/" title="Automatic Updates" class="dd-item ">
+        <a href="/rbcli/advanced/automatic_updates/">
+        Automatic Updates
+        </a>
+    </li>
+      <li data-nav-id="/rbcli/advanced/command_types/" title="Command Types" class="dd-item ">
+        <a href="/rbcli/advanced/command_types/">
+        Command Types
+        </a>
+    </li>
+      <li data-nav-id="/rbcli/advanced/distributed_state_locking/" title="Distributed State and Locking" class="dd-item ">
+        <a href="/rbcli/advanced/distributed_state_locking/">
+        Distributed State and Locking
+        </a>
+    </li>
+      <li data-nav-id="/rbcli/advanced/hooks/" title="Execution Hooks" class="dd-item ">
+        <a href="/rbcli/advanced/hooks/">
+        Execution Hooks
+        </a>
+    </li>
+      <li data-nav-id="/rbcli/advanced/interactive_commands/" title="Interactive Commands" class="dd-item ">
+        <a href="/rbcli/advanced/interactive_commands/">
+        Interactive Commands
+        </a>
+    </li>
+      <li data-nav-id="/rbcli/advanced/logging/" title="Logging" class="dd-item ">
+        <a href="/rbcli/advanced/logging/">
+        Logging
+        </a>
+    </li>
+      <li data-nav-id="/rbcli/advanced/remote_execution/" title="Remote Execution" class="dd-item ">
+        <a href="/rbcli/advanced/remote_execution/">
+        Remote Execution
+        </a>
+    </li>
+      <li data-nav-id="/rbcli/advanced/state_storage/" title="State Storage" class="dd-item ">
+        <a href="/rbcli/advanced/state_storage/">
+        State Storage
+        </a>
+    </li>
+      <li data-nav-id="/rbcli/advanced/user_config_files/" title="User Configuration Files" class="dd-item ">
+        <a href="/rbcli/advanced/user_config_files/">
+        User Configuration Files
+        </a>
+    </li>
+        </ul>
+    </li>
+    <li data-nav-id="/rbcli/development/" title="Development" class="dd-item
+        parent
+        ">
+      <a href="/rbcli/development/">
+          Development
+      </a>
+        <ul>
+      <li data-nav-id="/rbcli/development/contributing/" title="Contribution Guide" class="dd-item ">
+        <a href="/rbcli/development/contributing/">
+        Contribution Guide
+        </a>
+    </li>
+      <li data-nav-id="/rbcli/development/license/" title="License Info" class="dd-item ">
+        <a href="/rbcli/development/license/">
+        License Info
+        </a>
+    </li>
+      <li data-nav-id="/rbcli/development/code_of_conduct/" title="Code of Conduct" class="dd-item ">
+        <a href="/rbcli/development/code_of_conduct/">
+        Code of Conduct
+        </a>
+    </li>
+      <li data-nav-id="/rbcli/development/changelog/" title="Changelog" class="dd-item active">
+        <a href="/rbcli/development/changelog/">
+        Changelog
+        </a>
+    </li>
+        </ul>
+    </li>
+    <li data-nav-id="/rbcli/whoami/" title="My Letter To You" class="dd-item
+        ">
+      <a href="/rbcli/whoami/">
+          My Letter To You
+      </a>
+    </li>
+    </ul>
+      <section id="shortcuts">
+        <h3>More</h3>
+        <ul>
+              <li>
+                  <a class="padding" href="https://github.com/akhoury6/rbcli"><i class='fab fa-github'></i> Github repo</a>
+              </li>
+              <li>
+                  <a class="padding" href="https://rubygems.org/gems/rbcli"><i class='far fa-gem'></i> Rubygems</a>
+              </li>
+        </ul>
+      </section>
+    <section id="footer">
+      <p>Built with <a href="https://github.com/matcornic/hugo-theme-learn"><i class="fas fa-heart"></i></a> from <a href="https://getgrav.org">Grav</a> and <a href="https://gohugo.io/">Hugo</a></p>
+    </section>
+  </div>
+</nav>
+        <section id="body">
+        <div id="overlay"></div>
+        <div class="padding highlightable">
+              <div>
+                <div id="top-bar">
+                <div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
+                    <span id="sidebar-toggle-span">
+                        <a href="#" id="sidebar-toggle" data-sidebar-toggle="">
+                          <i class="fas fa-bars"></i>
+                        </a>
+                    </span>
+                  <span id="toc-menu"><i class="fas fa-list-alt"></i></span>
+                  <span class="links">
+            <a href='/rbcli/'></a> > <a href='/rbcli/development/'>Development</a> > Changelog
+                  </span>
+                </div>
+                    <div class="progress">
+    <div class="wrapper">
+<nav id="TableOfContents">
+<ul>
+<li>
+<ul>
+<li><a href="#0-2-12-unreleased">0.2.12 (Unreleased)</a>
+<ul>
+<li><a href="#improvements">Improvements</a></li>
+<li><a href="#features">Features</a></li>
+</ul></li>
+<li><a href="#0-2-11-feb-27-2019">0.2.11 (Feb 27, 2019)</a>
+<ul>
+<li><a href="#improvements-1">Improvements</a></li>
+<li><a href="#bugfixes">Bugfixes</a></li>
+</ul></li>
+<li><a href="#0-2-8-nov-7-2018">0.2.8 (Nov 7, 2018)</a>
+<ul>
+<li><a href="#features-1">Features</a></li>
+<li><a href="#improvements-2">Improvements</a></li>
+<li><a href="#bugfixes-1">Bugfixes</a></li>
+<li><a href="#changes">Changes</a></li>
+</ul></li>
+<li><a href="#0-2-7-oct-17-2018">0.2.7 (Oct 17, 2018)</a>
+<ul>
+<li><a href="#improvements-3">Improvements</a></li>
+<li><a href="#bugfixes-2">Bugfixes</a></li>
+<li><a href="#changes-1">Changes</a></li>
+</ul></li>
+<li><a href="#0-2-5-oct-8-2018">0.2.5 (Oct 8, 2018)</a>
+<ul>
+<li><a href="#improvements-4">Improvements</a></li>
+<li><a href="#bugfixes-3">Bugfixes</a></li>
+</ul></li>
+<li><a href="#0-2-4-sep-4-2018">0.2.4 (Sep 4, 2018)</a></li>
+<li><a href="#0-2-3-sep-4-2018">0.2.3 (Sep 4, 2018)</a>
+<ul>
+<li><a href="#features-2">Features</a></li>
+<li><a href="#improvements-5">Improvements</a></li>
+</ul></li>
+<li><a href="#0-2-2-aug-22-2018">0.2.2 (Aug 22, 2018)</a>
+<ul>
+<li><a href="#features-3">Features</a></li>
+<li><a href="#bugfixes-4">Bugfixes</a></li>
+<li><a href="#improvements-6">Improvements</a></li>
+<li><a href="#deprecations-changes">Deprecations/Changes</a></li>
+</ul></li>
+<li><a href="#0-2-1-aug-8-2018">0.2.1 (Aug 8, 2018)</a>
+<ul>
+<li><a href="#features-4">Features</a></li>
+<li><a href="#bugfixes-5">Bugfixes</a></li>
+</ul></li>
+<li><a href="#0-2-0-aug-5-2018">0.2.0 (Aug 5, 2018)</a>
+<ul>
+<li><a href="#features-5">Features</a></li>
+<li><a href="#bugfixes-6">Bugfixes</a></li>
+<li><a href="#improvements-7">Improvements</a></li>
+<li><a href="#deprecations-changes-1">Deprecations/Changes</a></li>
+</ul></li>
+</ul></li>
+</ul>
+</nav>
+    </div>
+</div>
+              </div>
+            </div>
+        <div id="head-tags">
+        </div>
+        <div id="body-inner">
+            <h1>
+              Changelog
+            </h1>
+<h2 id="0-2-12-unreleased">0.2.12 (Unreleased)</h2>
+<h3 id="improvements">Improvements</h3>
+<ul>
+<li>The base project skeleton now includes an improved structure for the <code>lib/</code> folder</li>
+<li>Documentation now uses Hugo instead of MkDocs for site generation.</li>
+<li>Updated dependencies in project skeleton to latest versions</li>
+</ul>
+<h3 id="features">Features</h3>
+<ul>
+<li>Development mode can be enabled by setting the environment variables: <code>RBCLI_ENV=development</code> and <code>RBCLI_DEVPATH=[path to local Rbcli folder]</code> to simplify changes to Rbcli during development. Combined with setting <code>alias rbcli='/path/to/rbcli/exe/rbcli'</code>, gem installation is not required for development work</li>
+</ul>
+<h2 id="0-2-11-feb-27-2019">0.2.11 (Feb 27, 2019)</h2>
+<h3 id="improvements-1">Improvements</h3>
+<ul>
+<li>Updated the dependent gem verions to use the latest available versions</li>
+</ul>
+<h3 id="bugfixes">Bugfixes</h3>
+<ul>
+<li>Fixed the nested triggers of the message I/O system</li>
+</ul>
+<h2 id="0-2-8-nov-7-2018">0.2.8 (Nov 7, 2018)</h2>
+<h3 id="features-1">Features</h3>
+<ul>
+<li>Added a standardized message I/O system</li>
+</ul>
+<h3 id="improvements-2">Improvements</h3>
+<ul>
+<li>Enabled the safe usage of anchors in YAML config files</li>
+<li>Improved the method of determining the script name to be more portable across OS&rsquo;es</li>
+</ul>
+<h3 id="bugfixes-1">Bugfixes</h3>
+<ul>
+<li>Fixed an error which caused RBCli to crash when using <code>local_state</code></li>
+<li>Fixed a bug which caused the <code>rbcli init</code> command to occassionally fail for mini and micro projects</li>
+</ul>
+<h3 id="changes">Changes</h3>
+<ul>
+<li>Changed the <code>rbcli init</code> helptext to match the order of complexity of projects (standard -&gt; mini -&gt; micro)</li>
+</ul>
+<h2 id="0-2-7-oct-17-2018">0.2.7 (Oct 17, 2018)</h2>
+<h3 id="improvements-3">Improvements</h3>
+<ul>
+<li>Added a dev mode for scripts that allows using a local RBCli copy instead of requiring the gem to be installed</li>
+</ul>
+<h3 id="bugfixes-2">Bugfixes</h3>
+<ul>
+<li>Fixed a bug that caused the rbcli tool not to detect project folders correctly.</li>
+<li>Command parameter <code>prompt:</code> now works when <code>required</code> is set to <code>true</code>.</li>
+</ul>
+<h3 id="changes-1">Changes</h3>
+<ul>
+<li>The <code>rbcli init</code> command now initializes into the current working directory instead of creating a new one.</li>
+<li>Fixed erroneous documentation about the &lsquo;merge&rsquo; setting on userspace config.</li>
+</ul>
+<h2 id="0-2-5-oct-8-2018">0.2.5 (Oct 8, 2018)</h2>
+<h3 id="improvements-4">Improvements</h3>
+<ul>
+<li>Added a useful error message when local or remote state is used but not initialized.</li>
+</ul>
+<h3 id="bugfixes-3">Bugfixes</h3>
+<ul>
+<li>Fixed a bug in the Github Updater where RBCli crashed when a version tag was not present in the repo.</li>
+<li>Fixed a bug where deleting a state key would crash Rbcli</li>
+<li>Fixed a bug where remote state crashed with certain configurations</li>
+</ul>
+<h2 id="0-2-4-sep-4-2018">0.2.4 (Sep 4, 2018)</h2>
+<ul>
+<li>This is a dummy release required to update the License in the Gemspec file. The license has not changed (GPLv3).</li>
+</ul>
+<h2 id="0-2-3-sep-4-2018">0.2.3 (Sep 4, 2018)</h2>
+<h3 id="features-2">Features</h3>
+<ul>
+<li>Interactive Commands &ndash; Prompt the user for parameters with a given value</li>
+</ul>
+<h3 id="improvements-5">Improvements</h3>
+<ul>
+<li>Added documentation on logging</li>
+</ul>
+<h2 id="0-2-2-aug-22-2018">0.2.2 (Aug 22, 2018)</h2>
+<h3 id="features-3">Features</h3>
+<h3 id="bugfixes-4">Bugfixes</h3>
+<ul>
+<li>Fixed a bug that caused the logger&rsquo;s target and level not to be configured properly via the Configurate block.</li>
+</ul>
+<h3 id="improvements-6">Improvements</h3>
+<ul>
+<li>Lazy-loading has been implemented in optional modules such as autoupdates, remote storage, etc. This means that if you do not enable them in the code, they will not be loaded into memory. This significantly improves loding times for applications.</li>
+<li>Abstraction system created for configuration. This has significantly simplified the existing codebase and makes future development easier.</li>
+<li>Deprecation warning system added. This allows for RBCli contributors to notify users of breaking changes that may impact their code.</li>
+<li>Folder structure has been simplified to ease development.</li>
+<li>Much of the code has been refactored.</li>
+</ul>
+<h3 id="deprecations-changes">Deprecations/Changes</h3>
+<ul>
+<li>The <code>Rbcli</code> module is now <code>RBCli</code> to better match the branding. The original <code>Rbcli</code> module will still work for this current release, with a warning, but future releases will require code changes.</li>
+<li>Hooks are now defined under the <code>RBCli.Configurate.hooks</code> block instead of <code>RBCli.Configurate.me</code>.</li>
+<li>The logger is now silent by default. To enable it, it must be configured either via the <code>Configurate</code> block or via the user&rsquo;s config file.</li>
+</ul>
+<h2 id="0-2-1-aug-8-2018">0.2.1 (Aug 8, 2018)</h2>
+<h3 id="features-4">Features</h3>
+<ul>
+<li>Remote Execution added for Script and External commands</li>
+</ul>
+<h3 id="bugfixes-5">Bugfixes</h3>
+<ul>
+<li>Fixed a bug that caused RBCli to crash if a direct path mode script&rsquo;s environment variables were declared as symbols</li>
+</ul>
+<h2 id="0-2-0-aug-5-2018">0.2.0 (Aug 5, 2018)</h2>
+<h3 id="features-5">Features</h3>
+<ul>
+<li>CLI tool Autoupdate Enabled; when an upgrade to RBCli is detected, the RBCli CLI tool will notify the developer.</li>
+<li>Official documentation created and hosted with Github Pages</li>
+<li>RBCli released under GPLv3</li>
+<li>Copyright/License notice displayed via RBCli tool with <code>rbcli license</code> in accordance with GPLv3 guidelines</li>
+</ul>
+<h3 id="bugfixes-6">Bugfixes</h3>
+<ul>
+<li>Fixed version number loading for projects</li>
+<li>Cleaned up command usage help output</li>
+<li>Fixed script and external command generation</li>
+</ul>
+<h3 id="improvements-7">Improvements</h3>
+<ul>
+<li>A quick reference guide can now be found in README.md</li>
+<li>Autoupdate feature now allows supplying a custom message</li>
+<li>Direct Path Mode for External Commands now</li>
+<li>Added support for a <code>lib</code> folder in projects, as a place for custom code, which is automatically added to <code>$LOAD_PATH</code> for developers</li>
+<li>Improved language regarding external commands: Documentation now differentiates between Standard, Scripted, and External Commands</li>
+<li>Improved language regarding user config files: Now called Userspace Config</li>
+<li>Options and Parameters now allow specifying the letter to be used for the short version, or to disable it altogether</li>
+<li>Userspace config can now be disabled by setting the path to nil or removing the declaration</li>
+</ul>
+<h3 id="deprecations-changes-1">Deprecations/Changes</h3>
+<ul>
+<li>Removed deprecated and broken examples from the examples folder</li>
+</ul>
+<footer class=" footline" >
+</footer>
+        </div>
+      </div>
+    <div id="navigation">
+			<a class="nav nav-prev" href="/rbcli/development/code_of_conduct/" title="Code of Conduct"> <i class="fa fa-chevron-left"></i></a>
+			<a class="nav nav-next" href="/rbcli/whoami/" title="My Letter To You" style="margin-right: 0px;"><i class="fa fa-chevron-right"></i></a>
+    </div>
+    </section>
+    <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
+      <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
+    </div>
+    <script src="/rbcli/js/clipboard.min.js?1561087612"></script>
+    <script src="/rbcli/js/perfect-scrollbar.min.js?1561087612"></script>
+    <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1561087612"></script>
+    <script src="/rbcli/js/jquery.sticky.js?1561087612"></script>
+    <script src="/rbcli/js/featherlight.min.js?1561087612"></script>
+    <script src="/rbcli/js/html5shiv-printshiv.min.js?1561087612"></script>
+    <script src="/rbcli/js/highlight.pack.js?1561087612"></script>
+    <script>hljs.initHighlightingOnLoad();</script>
+    <script src="/rbcli/js/modernizr.custom-3.6.0.js?1561087612"></script>
+    <script src="/rbcli/js/learn.js?1561087612"></script>
+    <script src="/rbcli/js/hugo-learn.js?1561087612"></script>
+    <link href="/rbcli/mermaid/mermaid.css?1561087612" rel="stylesheet" />
+    <script src="/rbcli/mermaid/mermaid.js?1561087612"></script>
+    <script>
+        mermaid.initialize({ startOnLoad: true });
+    </script>
+  </body>
+</html>