rbcli 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a94207cc8d9ccc3375e64de968e15a7d350adf14ec90228695df0872e9d09623
-  data.tar.gz: f1ae271537500e57f19604cae534e50f2de19ab0c7960f42ec18370e9ff5248d
+  metadata.gz: 3c95c762e32d8b39e339da91ac4fe5955781d9ce830a470812bb43aa332544fa
+  data.tar.gz: 6798d59641964853ddc589207b314a8ea7f37aa10d56e4c5ec348619786d77be
 SHA512:
-  metadata.gz: 584dc90981c04538c1adfca2b9d722d72b5d5ddf38c81c1b5ba88fef9992d5ab4e5f2ddf43697f3fe5923d5269e5fc86d9c9eff21db44892188072de27043910
-  data.tar.gz: 9b9e99a471c271cdcf3cb532a2bbe3a14be901bffffcbd75cd3b0901ff4abc74f72a794f65741dcc7c7958f1d1495f704df99381c2e2f25ca0624f4639051c3b
+  metadata.gz: ba4a2817e0e0e5dcc737e50552edb82f818de31c035854e53f4cd4bd32c93745d6d2c7ca7af08ceabad949061e534c1cc6e8c02bc374844a20044c56b1b590c6
+  data.tar.gz: dd7e786652b140b17c7563d2f59e320d2d8355e1c58c3d1dda0ee884e168e2388d60ae97df6aa1c9c633ac17f910279222a99f0e1854f9ddaa3a9aafcd1a6aa7

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 0.2.2 (Aug 22, 2018)
+
+### Features
+
+### Bugfixes
+
+* Fixed a bug that caused the logger's target and level not to be configured properly via the Configurate block.
+
+### Improvements
+
+* 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.
+* Abstraction system created for configuration. This has significantly simplified the existing codebase and makes future development easier.
+* Deprecation warning system added. This allows for RBCli contributors to notify users of breaking changes that may impact their code.
+* Folder structure has been simplified to ease development.
+* Much of the code has been refactored.
+
+### Deprecations/Changes
+
+* The `Rbcli` module is now `RBCli` to better match the branding. The original `Rbcli` module will still work for this current release, with a warning, but future releases will require code changes. 
+* Hooks are now defined under the `RBCli.Configurate.hooks` block instead of `RBCli.Configurate.me`.
+* The logger is now silent by default. To enable it, it must be configured either via the `Configurate` block or via the user's config file.
+
+
 ## 0.2.1 (Aug 8, 2018)
 
 ### Features

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbcli (0.2.1)
+    rbcli (0.2.2)
       aws-sdk-dynamodb (~> 1.6)
       colorize (~> 0.8)
       deep_merge (~> 1.2)

data/README.md

@@ -2,20 +2,22 @@
 
 RBCli is currently in Alpha stages of development. All releases can be considered stable, though breaking changes may be made between versions.
 
-Latest Release: v0.2.1 (Aug 8, 2018) -- See the [changelog][changelog] for complete details.
+Latest Release: v0.2.2 (Aug 22, 2018) -- See the [changelog][changelog] for complete details.
 
-* Remote Execution Feature Added
+* Lazy loading for improved startup time
+* Hooks are now defined under `Rbcli.Configurate.hooks`.
+* Logger is disabled by default, cleaning up output
+* Code refactor and cleanup
+* Many more improvements
 
-Previous Release: v0.2.0 (Aug 5, 2018)
+Previous Release: v0.2.1 (Aug 8, 2018)
 
-* CLI tool Autoupdate Enabled; when an upgrade to RBCli is detected, the RBCli CLI tool will notify the developer.
-* Official documentation created and hosted with Github Pages
-* RBCli released under GPLv3
-* Copyright/License notice displayed via RBCli tool with `rbcli license` in accordance with GPLv3 guidelines
-* Many improvements and bugfixes
+* Remote Execution Feature Added
 
 [You can find the Official Documentation for RBCli Here.][documentation_home]
 
+[If you want to support RBCli's development, please donate and help keep it going!][documentation_whoami]
+
 ## Introduction
 
 As technologists today, we work with the command line a lot. We script a lot. We write tools to share with each other to make our lives easier. We even write applications to make up for missing features in the 3rd party software that we buy. Unfortunately, when writing CLI tools, this process has typically been very painful. We've been working with low-level frameworks for decades; frameworks like `getopt` (1980) and `curses` (1977). They fit their purpose well; they were both computationally lightweight for the computers of the day, and they gave engineers full control and flexibility when it came to how things were built. Over the years, we've used them to settle on several design patterns that we know work well. Patterns as to what a CLI command looks like, what a config file looks like, what remote execution looks like, and even how to use locks (mutexes, semaphores, etc) to control application flow and data atomicity. Yet we're stuck writing the same low-level code anytime we want to write our tooling. Not anymore.
@@ -27,6 +29,8 @@ Some of its key features include:
 
 * __Simple DSL Interface__: To cut down on the amount of code that needs to be written, RBCli has a DSL that is designed to cut to the chase. This makes the work a lot less tedious.
   
+* __Lazy Loading__: Even though RBCli is a heavyweight tool, it uses lazy loading to speed up application startup time. This means you don't have to worry about a large framework slowing your application down.
+
 * __Multiple Levels of Parameters and Arguments__: Forget about writing parsers for command-line options, or about having to differentiate between parameters and arguments. All of that work is taken care of.
 
 * __Config File Generation__: Easily piece together a default configuration even with declarations in different parts of the code. Then the user can generate their own configuration, and it gets stored in whatever location you'd like.
@@ -223,5 +227,6 @@ The gem is available as open source under the terms of the [GPLv3][license_text]
 
 [documentation_home]: https://akhoury6.github.com/rbcli
 [documentation_development]: https://akhoury6.github.com/rbcli/development/contributing/
+[documentation_whoami]: https://akhoury6.github.io/rbcli/whoami/
 [license_text]: https://github.com/akhoury6/rbcli/blob/master/LICENSE.txt
 [changelog]: https://github.com/akhoury6/rbcli/blob/master/CHANGELOG.md

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
 task :default => :test

data/bin/console

@@ -19,8 +19,8 @@
 #     For questions regarding licensing, please contact andrew@blacknex.us       #
 ##################################################################################
 
-require "bundler/setup"
-require "rbcli"
+require 'bundler/setup'
+require 'rbcli'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -29,5 +29,5 @@ require "rbcli"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/docs-src/docs/development/contributing.md

@@ -36,6 +36,30 @@ Also, don't forget to update the __Quick Reference Guide__ in the `README.md` fi
 
 Once you've completed your edits, run the `makesite.sh` command to build the actual HTML pages automatically in the `docs` folder, from where they will be served when live.
 
+## Deprecations
+
+If a feature needs to be deprecated, RBCli has a built-in deprecation message feature. You can leverage it by calling the following code when a deprecated command is called:
+
+```ruby
+Rbcli::DeprecationWarning.new deprecated_command, message, version_when_code_will_be_removed
+```
+
+So, for example:
+
+```ruby
+Rbcli::DeprecationWarning.new 'Rbcli::Configurate.me--first_run', 'Please use `RBCli::Configurate.hooks` as the parent block instead.', '0.3.0'
+```
+
+will display the following message to the user, in red, any any time the application is run:
+
+```text
+DEPRECATION WRNING: The feature `Rbcli::Configurate.me--post_hook` has been deprecated. Please use `RBCli::Configurate.hooks` as the parent block instead. This feature will be removed in version 0.3.0.
+```
+
+Additionally, it will place the same line in the logs using `Rbcli.logger.warn` if logging is enabled.
+
+If a deprecation warning has been added, please remember to mention it in the pull request so that others can update it later.
+
 # Maintainer's Notes
 
 To install this gem onto your local machine from source, run `bundle exec rake install`.

data/docs-src/docs/imported/changelog.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 0.2.2 (Aug 22, 2018)
+
+### Features
+
+### Bugfixes
+
+* Fixed a bug that caused the logger's target and level not to be configured properly via the Configurate block.
+
+### Improvements
+
+* 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.
+* Abstraction system created for configuration. This has significantly simplified the existing codebase and makes future development easier.
+* Deprecation warning system added. This allows for RBCli contributors to notify users of breaking changes that may impact their code.
+* Folder structure has been simplified to ease development.
+* Much of the code has been refactored.
+
+### Deprecations/Changes
+
+* The `Rbcli` module is now `RBCli` to better match the branding. The original `Rbcli` module will still work for this current release, with a warning, but future releases will require code changes. 
+* Hooks are now defined under the `RBCli.Configurate.hooks` block instead of `RBCli.Configurate.me`.
+* The logger is now silent by default. To enable it, it must be configured either via the `Configurate` block or via the user's config file.
+
+
 ## 0.2.1 (Aug 8, 2018)
 
 ### Features

data/docs-src/docs/imported/quick_reference.md

@@ -168,5 +168,6 @@ The gem is available as open source under the terms of the [GPLv3][license_text]
 
 [documentation_home]: https://akhoury6.github.com/rbcli
 [documentation_development]: https://akhoury6.github.com/rbcli/development/contributing/
+[documentation_whoami]: https://akhoury6.github.io/rbcli/whoami/
 [license_text]: https://github.com/akhoury6/rbcli/blob/master/LICENSE.txt
 [changelog]: https://github.com/akhoury6/rbcli/blob/master/CHANGELOG.md

data/docs/development/contributing/index.html

@@ -659,6 +659,21 @@
 
 <p>Also, don't forget to update the <strong>Quick Reference Guide</strong> in the <code>README.md</code> file (the main project one) with information about your changes.</p>
 <p>Once you've completed your edits, run the <code>makesite.sh</code> command to build the actual HTML pages automatically in the <code>docs</code> folder, from where they will be served when live.</p>
+<h2 id="deprecations">Deprecations</h2>
+<p>If a feature needs to be deprecated, RBCli has a built-in deprecation message feature. You can leverage it by calling the following code when a deprecated command is called:</p>
+<pre><code class="ruby">Rbcli::DeprecationWarning.new deprecated_command, message, version_when_code_will_be_removed
+</code></pre>
+
+<p>So, for example:</p>
+<pre><code class="ruby">Rbcli::DeprecationWarning.new 'Rbcli::Configurate.me--first_run', 'Please use `RBCli::Configurate.hooks` as the parent block instead.', '0.3.0'
+</code></pre>
+
+<p>will display the following message to the user, in red, any any time the application is run:</p>
+<pre><code class="text">DEPRECATION WRNING: The feature `Rbcli::Configurate.me--post_hook` has been deprecated. Please use `RBCli::Configurate.hooks` as the parent block instead. This feature will be removed in version 0.3.0.
+</code></pre>
+
+<p>Additionally, it will place the same line in the logs using <code>Rbcli.logger.warn</code> if logging is enabled.</p>
+<p>If a deprecation warning has been added, please remember to mention it in the pull request so that others can update it later.</p>
 <h1 id="maintainers-notes">Maintainer's Notes</h1>
 <p>To install this gem onto your local machine from source, run <code>bundle exec rake install</code>.</p>
 <p>To release a new version, follow theese steps:</p>

data/docs/imported/changelog/index.html

@@ -602,8 +602,8 @@
     <ul class="md-nav__list" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#021-aug-8-2018" title="0.2.1 (Aug 8, 2018)" class="md-nav__link">
-    0.2.1 (Aug 8, 2018)
+  <a href="#022-aug-22-2018" title="0.2.2 (Aug 22, 2018)" class="md-nav__link">
+    0.2.2 (Aug 22, 2018)
   </a>
   
     <nav class="md-nav">
@@ -621,6 +621,20 @@
     Bugfixes
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#improvements" title="Improvements" class="md-nav__link">
+    Improvements
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#deprecationschanges" title="Deprecations/Changes" class="md-nav__link">
+    Deprecations/Changes
+  </a>
+  
 </li>
         
       </ul>
@@ -629,8 +643,8 @@
 </li>
       
         <li class="md-nav__item">
-  <a href="#020-aug-5-2018" title="0.2.0 (Aug 5, 2018)" class="md-nav__link">
-    0.2.0 (Aug 5, 2018)
+  <a href="#021-aug-8-2018" title="0.2.1 (Aug 8, 2018)" class="md-nav__link">
+    0.2.1 (Aug 8, 2018)
   </a>
   
     <nav class="md-nav">
@@ -648,17 +662,44 @@
     Bugfixes
   </a>
   
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#020-aug-5-2018" title="0.2.0 (Aug 5, 2018)" class="md-nav__link">
+    0.2.0 (Aug 5, 2018)
+  </a>
+  
+    <nav class="md-nav">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#features_2" title="Features" class="md-nav__link">
+    Features
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#bugfixes_2" title="Bugfixes" class="md-nav__link">
+    Bugfixes
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
-  <a href="#improvements" title="Improvements" class="md-nav__link">
+  <a href="#improvements_1" title="Improvements" class="md-nav__link">
     Improvements
   </a>
   
 </li>
         
           <li class="md-nav__item">
-  <a href="#deprecationschanges" title="Deprecations/Changes" class="md-nav__link">
+  <a href="#deprecationschanges_1" title="Deprecations/Changes" class="md-nav__link">
     Deprecations/Changes
   </a>
   
@@ -718,8 +759,8 @@
     <ul class="md-nav__list" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#021-aug-8-2018" title="0.2.1 (Aug 8, 2018)" class="md-nav__link">
-    0.2.1 (Aug 8, 2018)
+  <a href="#022-aug-22-2018" title="0.2.2 (Aug 22, 2018)" class="md-nav__link">
+    0.2.2 (Aug 22, 2018)
   </a>
   
     <nav class="md-nav">
@@ -737,6 +778,47 @@
     Bugfixes
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#improvements" title="Improvements" class="md-nav__link">
+    Improvements
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#deprecationschanges" title="Deprecations/Changes" class="md-nav__link">
+    Deprecations/Changes
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#021-aug-8-2018" title="0.2.1 (Aug 8, 2018)" class="md-nav__link">
+    0.2.1 (Aug 8, 2018)
+  </a>
+  
+    <nav class="md-nav">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#features_1" title="Features" class="md-nav__link">
+    Features
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#bugfixes_1" title="Bugfixes" class="md-nav__link">
+    Bugfixes
+  </a>
+  
 </li>
         
       </ul>
@@ -753,28 +835,28 @@
       <ul class="md-nav__list">
         
           <li class="md-nav__item">
-  <a href="#features_1" title="Features" class="md-nav__link">
+  <a href="#features_2" title="Features" class="md-nav__link">
     Features
   </a>
   
 </li>
         
           <li class="md-nav__item">
-  <a href="#bugfixes_1" title="Bugfixes" class="md-nav__link">
+  <a href="#bugfixes_2" title="Bugfixes" class="md-nav__link">
     Bugfixes
   </a>
   
 </li>
         
           <li class="md-nav__item">
-  <a href="#improvements" title="Improvements" class="md-nav__link">
+  <a href="#improvements_1" title="Improvements" class="md-nav__link">
     Improvements
   </a>
   
 </li>
         
           <li class="md-nav__item">
-  <a href="#deprecationschanges" title="Deprecations/Changes" class="md-nav__link">
+  <a href="#deprecationschanges_1" title="Deprecations/Changes" class="md-nav__link">
     Deprecations/Changes
   </a>
   
@@ -803,30 +885,50 @@
                 
                 
                 <h1 id="changelog">Changelog</h1>
-<h2 id="021-aug-8-2018">0.2.1 (Aug 8, 2018)</h2>
+<h2 id="022-aug-22-2018">0.2.2 (Aug 22, 2018)</h2>
 <h3 id="features">Features</h3>
+<h3 id="bugfixes">Bugfixes</h3>
+<ul>
+<li>Fixed a bug that caused the logger's target and level not to be configured properly via the Configurate block.</li>
+</ul>
+<h3 id="improvements">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="deprecationschanges">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's config file.</li>
+</ul>
+<h2 id="021-aug-8-2018">0.2.1 (Aug 8, 2018)</h2>
+<h3 id="features_1">Features</h3>
 <ul>
 <li>Remote Execution added for Script and External commands</li>
 </ul>
-<h3 id="bugfixes">Bugfixes</h3>
+<h3 id="bugfixes_1">Bugfixes</h3>
 <ul>
 <li>Fixed a bug that caused RBCli to crash if a direct path mode script's environment variables were declared as symbols</li>
 </ul>
 <h2 id="020-aug-5-2018">0.2.0 (Aug 5, 2018)</h2>
-<h3 id="features_1">Features</h3>
+<h3 id="features_2">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_1">Bugfixes</h3>
+<h3 id="bugfixes_2">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">Improvements</h3>
+<h3 id="improvements_1">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>
@@ -837,7 +939,7 @@
 <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="deprecationschanges">Deprecations/Changes</h3>
+<h3 id="deprecationschanges_1">Deprecations/Changes</h3>
 <ul>
 <li>Removed deprecated and broken examples from the examples folder</li>
 </ul>