rbcli 0.3.1 → 0.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +20 -0
  3. data/Gemfile.lock +63 -63
  4. data/docs/404.html +9 -9
  5. data/docs/advanced/automatic_updates/index.html +30 -30
  6. data/docs/advanced/command_types/index.html +78 -78
  7. data/docs/advanced/distributed_state_locking/index.html +30 -30
  8. data/docs/advanced/hooks/index.html +42 -42
  9. data/docs/advanced/index.html +27 -27
  10. data/docs/advanced/index.xml +12 -50
  11. data/docs/advanced/interactive_commands/index.html +35 -35
  12. data/docs/advanced/logging/index.html +36 -36
  13. data/docs/advanced/remote_execution/index.html +51 -51
  14. data/docs/advanced/state_storage/index.html +34 -34
  15. data/docs/advanced/user_config_files/index.html +30 -30
  16. data/docs/categories/index.html +27 -27
  17. data/docs/categories/index.xml +3 -2
  18. data/docs/development/changelog/index.html +91 -60
  19. data/docs/development/code_of_conduct/index.html +27 -27
  20. data/docs/development/contributing/index.html +40 -40
  21. data/docs/development/index.html +27 -27
  22. data/docs/development/index.xml +6 -16
  23. data/docs/development/license/index.html +26 -26
  24. data/docs/index.html +26 -26
  25. data/docs/index.json +15 -15
  26. data/docs/index.xml +20 -90
  27. data/docs/quick_reference/index.html +54 -54
  28. data/docs/quick_reference/index.xml +3 -2
  29. data/docs/sitemap.xml +0 -1
  30. data/docs/tags/index.html +27 -27
  31. data/docs/tags/index.xml +3 -2
  32. data/docs/tutorial/10-getting_started/index.html +33 -33
  33. data/docs/tutorial/20-project_layout/index.html +55 -55
  34. data/docs/tutorial/30-your_first_command/index.html +90 -90
  35. data/docs/tutorial/40-options_parameters_and_arguments/index.html +167 -167
  36. data/docs/tutorial/50-publishing/index.html +30 -30
  37. data/docs/tutorial/index.html +27 -27
  38. data/docs/tutorial/index.xml +8 -28
  39. data/docs/whoami/index.html +28 -28
  40. data/docs/whoami/index.xml +3 -2
  41. data/docs-src/.hugo_build.lock +0 -0
  42. data/docs-src/content/development/changelog.md +20 -0
  43. data/docs-src/makesite.sh +4 -4
  44. data/exe/rbcli +1 -1
  45. data/lib/rbcli/configuration/configurate.rb +1 -1
  46. data/lib/rbcli/engine/command.rb +1 -1
  47. data/lib/rbcli/engine/load_project.rb +1 -1
  48. data/lib/rbcli/engine/parser.rb +9 -7
  49. data/lib/rbcli/features/userconfig.rb +3 -3
  50. data/lib/rbcli/state_storage/localstate.rb +1 -1
  51. data/lib/rbcli/util/optimist.rb +1063 -0
  52. data/lib/rbcli/version.rb +1 -1
  53. data/lib/rbcli-tool/generators.rb +3 -3
  54. data/lib/rbcli-tool/mdless_fix.rb +1 -1
  55. data/lib/rbcli-tool/project.rb +3 -3
  56. data/lib/rbcli-tool/util.rb +3 -3
  57. data/rbcli.gemspec +16 -14
  58. data/skeletons/micro/executable +6 -1
  59. data/skeletons/mini/executable +6 -1
  60. data/skeletons/project/untitled.gemspec +4 -4
  61. metadata +31 -30
  62. data/lib/rbcli/util/trollop.rb +0 -1050
data/docs/development/changelog/index.html CHANGED
@@ -3,7 +3,7 @@
3
3
  <head>
4
4
  <meta charset="utf-8">
5
5
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <meta name="generator" content="Hugo 0.88.1" />
6
+ <meta name="generator" content="Hugo 0.125.1">
7
7
  <meta name="description" content="">
8
8
 
9
9
 
@@ -12,21 +12,21 @@
12
12
  <title>Changelog :: RBCli Documentation</title>
13
13
 
14
14
 
15
- <link href="/rbcli/css/nucleus.css?1634703589" rel="stylesheet">
16
- <link href="/rbcli/css/fontawesome-all.min.css?1634703589" rel="stylesheet">
17
- <link href="/rbcli/css/hybrid.css?1634703589" rel="stylesheet">
18
- <link href="/rbcli/css/featherlight.min.css?1634703589" rel="stylesheet">
19
- <link href="/rbcli/css/perfect-scrollbar.min.css?1634703589" rel="stylesheet">
20
- <link href="/rbcli/css/auto-complete.css?1634703589" rel="stylesheet">
21
- <link href="/rbcli/css/atom-one-dark-reasonable.css?1634703589" rel="stylesheet">
22
- <link href="/rbcli/css/theme.css?1634703589" rel="stylesheet">
23
- <link href="/rbcli/css/hugo-theme.css?1634703589" rel="stylesheet">
15
+ <link href="/rbcli/css/nucleus.css?1713907739" rel="stylesheet">
16
+ <link href="/rbcli/css/fontawesome-all.min.css?1713907739" rel="stylesheet">
17
+ <link href="/rbcli/css/hybrid.css?1713907739" rel="stylesheet">
18
+ <link href="/rbcli/css/featherlight.min.css?1713907739" rel="stylesheet">
19
+ <link href="/rbcli/css/perfect-scrollbar.min.css?1713907739" rel="stylesheet">
20
+ <link href="/rbcli/css/auto-complete.css?1713907739" rel="stylesheet">
21
+ <link href="/rbcli/css/atom-one-dark-reasonable.css?1713907739" rel="stylesheet">
22
+ <link href="/rbcli/css/theme.css?1713907739" rel="stylesheet">
23
+ <link href="/rbcli/css/hugo-theme.css?1713907739" rel="stylesheet">
24
24
 
25
- <link href="/rbcli/css/theme-blue.css?1634703589" rel="stylesheet">
25
+ <link href="/rbcli/css/theme-blue.css?1713907739" rel="stylesheet">
26
26
 
27
27
 
28
28
 
29
- <script src="/rbcli/js/jquery-3.3.1.min.js?1634703589"></script>
29
+ <script src="/rbcli/js/jquery-3.3.1.min.js?1713907739"></script>
30
30
 
31
31
  <style>
32
32
  :root #header + #content > #left > #rlblock_left{
@@ -55,14 +55,14 @@
55
55
  <span data-search-clear=""><i class="fas fa-times"></i></span>
56
56
  </div>
57
57
 
58
- <script type="text/javascript" src="/rbcli/js/lunr.min.js?1634703589"></script>
59
- <script type="text/javascript" src="/rbcli/js/auto-complete.js?1634703589"></script>
58
+ <script type="text/javascript" src="/rbcli/js/lunr.min.js?1713907739"></script>
59
+ <script type="text/javascript" src="/rbcli/js/auto-complete.js?1713907739"></script>
60
60
  <script type="text/javascript">
61
61
 
62
62
  var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
63
63
 
64
64
  </script>
65
- <script type="text/javascript" src="/rbcli/js/search.js?1634703589"></script>
65
+ <script type="text/javascript" src="/rbcli/js/search.js?1713907739"></script>
66
66
 
67
67
 
68
68
  </div>
@@ -678,76 +678,87 @@
678
678
  <div class="wrapper">
679
679
  <nav id="TableOfContents">
680
680
  <ul>
681
- <li><a href="#031-october-19-2021">0.3.1 (October 19, 2021)</a>
681
+ <li><a href="#033-april-24-2024">0.3.3 (April 24, 2024)</a>
682
682
  <ul>
683
+ <li><a href="#improvements">Improvements</a></li>
683
684
  <li><a href="#bugfixes">Bugfixes</a></li>
684
685
  </ul>
685
686
  </li>
687
+ <li><a href="#032-october-28-2023">0.3.2 (October 28, 2023)</a>
688
+ <ul>
689
+ <li><a href="#bugfixes-1">Bugfixes</a></li>
690
+ </ul>
691
+ </li>
692
+ <li><a href="#031-october-19-2021">0.3.1 (October 19, 2021)</a>
693
+ <ul>
694
+ <li><a href="#bugfixes-2">Bugfixes</a></li>
695
+ </ul>
696
+ </li>
686
697
  <li><a href="#03-july-31-2020">0.3 (July 31, 2020)</a>
687
698
  <ul>
688
- <li><a href="#improvements">Improvements</a></li>
699
+ <li><a href="#improvements-1">Improvements</a></li>
689
700
  <li><a href="#features">Features</a></li>
690
701
  </ul>
691
702
  </li>
692
703
  <li><a href="#0212-july-29-2019">0.2.12 (July 29, 2019)</a>
693
704
  <ul>
694
- <li><a href="#improvements-1">Improvements</a></li>
705
+ <li><a href="#improvements-2">Improvements</a></li>
695
706
  <li><a href="#features-1">Features</a></li>
696
707
  </ul>
697
708
  </li>
698
709
  <li><a href="#0211-feb-27-2019">0.2.11 (Feb 27, 2019)</a>
699
710
  <ul>
700
- <li><a href="#improvements-2">Improvements</a></li>
701
- <li><a href="#bugfixes-1">Bugfixes</a></li>
711
+ <li><a href="#improvements-3">Improvements</a></li>
712
+ <li><a href="#bugfixes-3">Bugfixes</a></li>
702
713
  </ul>
703
714
  </li>
704
715
  <li><a href="#028-nov-7-2018">0.2.8 (Nov 7, 2018)</a>
705
716
  <ul>
706
717
  <li><a href="#features-2">Features</a></li>
707
- <li><a href="#improvements-3">Improvements</a></li>
708
- <li><a href="#bugfixes-2">Bugfixes</a></li>
718
+ <li><a href="#improvements-4">Improvements</a></li>
719
+ <li><a href="#bugfixes-4">Bugfixes</a></li>
709
720
  <li><a href="#changes">Changes</a></li>
710
721
  </ul>
711
722
  </li>
712
723
  <li><a href="#027-oct-17-2018">0.2.7 (Oct 17, 2018)</a>
713
724
  <ul>
714
- <li><a href="#improvements-4">Improvements</a></li>
715
- <li><a href="#bugfixes-3">Bugfixes</a></li>
725
+ <li><a href="#improvements-5">Improvements</a></li>
726
+ <li><a href="#bugfixes-5">Bugfixes</a></li>
716
727
  <li><a href="#changes-1">Changes</a></li>
717
728
  </ul>
718
729
  </li>
719
730
  <li><a href="#025-oct-8-2018">0.2.5 (Oct 8, 2018)</a>
720
731
  <ul>
721
- <li><a href="#improvements-5">Improvements</a></li>
722
- <li><a href="#bugfixes-4">Bugfixes</a></li>
732
+ <li><a href="#improvements-6">Improvements</a></li>
733
+ <li><a href="#bugfixes-6">Bugfixes</a></li>
723
734
  </ul>
724
735
  </li>
725
736
  <li><a href="#024-sep-4-2018">0.2.4 (Sep 4, 2018)</a></li>
726
737
  <li><a href="#023-sep-4-2018">0.2.3 (Sep 4, 2018)</a>
727
738
  <ul>
728
739
  <li><a href="#features-3">Features</a></li>
729
- <li><a href="#improvements-6">Improvements</a></li>
740
+ <li><a href="#improvements-7">Improvements</a></li>
730
741
  </ul>
731
742
  </li>
732
743
  <li><a href="#022-aug-22-2018">0.2.2 (Aug 22, 2018)</a>
733
744
  <ul>
734
745
  <li><a href="#features-4">Features</a></li>
735
- <li><a href="#bugfixes-5">Bugfixes</a></li>
736
- <li><a href="#improvements-7">Improvements</a></li>
746
+ <li><a href="#bugfixes-7">Bugfixes</a></li>
747
+ <li><a href="#improvements-8">Improvements</a></li>
737
748
  <li><a href="#deprecationschanges">Deprecations/Changes</a></li>
738
749
  </ul>
739
750
  </li>
740
751
  <li><a href="#021-aug-8-2018">0.2.1 (Aug 8, 2018)</a>
741
752
  <ul>
742
753
  <li><a href="#features-5">Features</a></li>
743
- <li><a href="#bugfixes-6">Bugfixes</a></li>
754
+ <li><a href="#bugfixes-8">Bugfixes</a></li>
744
755
  </ul>
745
756
  </li>
746
757
  <li><a href="#020-aug-5-2018">0.2.0 (Aug 5, 2018)</a>
747
758
  <ul>
748
759
  <li><a href="#features-6">Features</a></li>
749
- <li><a href="#bugfixes-7">Bugfixes</a></li>
750
- <li><a href="#improvements-8">Improvements</a></li>
760
+ <li><a href="#bugfixes-9">Bugfixes</a></li>
761
+ <li><a href="#improvements-9">Improvements</a></li>
751
762
  <li><a href="#deprecationschanges-1">Deprecations/Changes</a></li>
752
763
  </ul>
753
764
  </li>
@@ -775,16 +786,36 @@
775
786
 
776
787
 
777
788
 
778
- <h2 id="031-october-19-2021">0.3.1 (October 19, 2021)</h2>
789
+ <h2 id="033-april-24-2024">0.3.3 (April 24, 2024)</h2>
790
+ <h3 id="improvements">Improvements</h3>
791
+ <ul>
792
+ <li>Tested with Ruby 3.3.0</li>
793
+ <li>Updated dependencies for Ruby 3.3.0</li>
794
+ <li>Updated dependnecies for Sekeleton projects</li>
795
+ <li>Added a <code>bundler/inline</code> gemfile on mini and micro skeleton projects to simplify their use</li>
796
+ <li>Replaced deprecated Trollop gem with its replacement, <a href="https://github.com/ManageIQ/optimist">ManageIQ/Optimist</a></li>
797
+ </ul>
779
798
  <h3 id="bugfixes">Bugfixes</h3>
780
799
  <ul>
800
+ <li>Updated deprecated ERB call for skeleton generation to use new format</li>
801
+ </ul>
802
+ <h2 id="032-october-28-2023">0.3.2 (October 28, 2023)</h2>
803
+ <h3 id="bugfixes-1">Bugfixes</h3>
804
+ <ul>
805
+ <li>Replaced several calls to the deprecated <code>.exists?</code> method with <code>.exist?</code> for compatibility with Ruby 3.2.0</li>
806
+ <li>Updated dependencies to latest versions</li>
807
+ <li>Standardized on version locking to the latest Major version of dependencies rather than the latest Minor ones</li>
808
+ </ul>
809
+ <h2 id="031-october-19-2021">0.3.1 (October 19, 2021)</h2>
810
+ <h3 id="bugfixes-2">Bugfixes</h3>
811
+ <ul>
781
812
  <li>Fixed prompt for option value to ignore nil defaults instead of displaying an empty string</li>
782
813
  <li>Skeleton script command <code>script.sh</code> updated to function correctly when development mode is enabled</li>
783
814
  <li>Updated Github Pages links to point to <code>github.io</code> instead of <code>github.com</code> which are being deprecated</li>
784
815
  <li>Updated dependencies, closing the security hole of the gem <code>addressable &lt;= 1.7.0</code></li>
785
816
  </ul>
786
817
  <h2 id="03-july-31-2020">0.3 (July 31, 2020)</h2>
787
- <h3 id="improvements">Improvements</h3>
818
+ <h3 id="improvements-1">Improvements</h3>
788
819
  <ul>
789
820
  <li>Deprecated Ruby code has been updated to be compatible with Ruby 2.7.x</li>
790
821
  <li>All depedencies have been updated to their latest versions and tested to ensure continued compatibility</li>
@@ -798,7 +829,7 @@
798
829
  <li>The <code>$libdir</code> global variable is defined by default in the skeleton project, allwoing easy access to the project&rsquo;s <code>lib</code> folder</li>
799
830
  </ul>
800
831
  <h2 id="0212-july-29-2019">0.2.12 (July 29, 2019)</h2>
801
- <h3 id="improvements-1">Improvements</h3>
832
+ <h3 id="improvements-2">Improvements</h3>
802
833
  <ul>
803
834
  <li>The base project skeleton now includes an improved structure for the <code>lib/</code> folder</li>
804
835
  <li>Documentation now uses Hugo instead of MkDocs for site generation.</li>
@@ -809,11 +840,11 @@
809
840
  <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>
810
841
  </ul>
811
842
  <h2 id="0211-feb-27-2019">0.2.11 (Feb 27, 2019)</h2>
812
- <h3 id="improvements-2">Improvements</h3>
843
+ <h3 id="improvements-3">Improvements</h3>
813
844
  <ul>
814
845
  <li>Updated the dependent gem verions to use the latest available versions</li>
815
846
  </ul>
816
- <h3 id="bugfixes-1">Bugfixes</h3>
847
+ <h3 id="bugfixes-3">Bugfixes</h3>
817
848
  <ul>
818
849
  <li>Fixed the nested triggers of the message I/O system</li>
819
850
  </ul>
@@ -822,12 +853,12 @@
822
853
  <ul>
823
854
  <li>Added a standardized message I/O system</li>
824
855
  </ul>
825
- <h3 id="improvements-3">Improvements</h3>
856
+ <h3 id="improvements-4">Improvements</h3>
826
857
  <ul>
827
858
  <li>Enabled the safe usage of anchors in YAML config files</li>
828
859
  <li>Improved the method of determining the script name to be more portable across OS&rsquo;es</li>
829
860
  </ul>
830
- <h3 id="bugfixes-2">Bugfixes</h3>
861
+ <h3 id="bugfixes-4">Bugfixes</h3>
831
862
  <ul>
832
863
  <li>Fixed an error which caused RBCli to crash when using <code>local_state</code></li>
833
864
  <li>Fixed a bug which caused the <code>rbcli init</code> command to occassionally fail for mini and micro projects</li>
@@ -837,11 +868,11 @@
837
868
  <li>Changed the <code>rbcli init</code> helptext to match the order of complexity of projects (standard -&gt; mini -&gt; micro)</li>
838
869
  </ul>
839
870
  <h2 id="027-oct-17-2018">0.2.7 (Oct 17, 2018)</h2>
840
- <h3 id="improvements-4">Improvements</h3>
871
+ <h3 id="improvements-5">Improvements</h3>
841
872
  <ul>
842
873
  <li>Added a dev mode for scripts that allows using a local RBCli copy instead of requiring the gem to be installed</li>
843
874
  </ul>
844
- <h3 id="bugfixes-3">Bugfixes</h3>
875
+ <h3 id="bugfixes-5">Bugfixes</h3>
845
876
  <ul>
846
877
  <li>Fixed a bug that caused the rbcli tool not to detect project folders correctly.</li>
847
878
  <li>Command parameter <code>prompt:</code> now works when <code>required</code> is set to <code>true</code>.</li>
@@ -852,11 +883,11 @@
852
883
  <li>Fixed erroneous documentation about the &lsquo;merge&rsquo; setting on userspace config.</li>
853
884
  </ul>
854
885
  <h2 id="025-oct-8-2018">0.2.5 (Oct 8, 2018)</h2>
855
- <h3 id="improvements-5">Improvements</h3>
886
+ <h3 id="improvements-6">Improvements</h3>
856
887
  <ul>
857
888
  <li>Added a useful error message when local or remote state is used but not initialized.</li>
858
889
  </ul>
859
- <h3 id="bugfixes-4">Bugfixes</h3>
890
+ <h3 id="bugfixes-6">Bugfixes</h3>
860
891
  <ul>
861
892
  <li>Fixed a bug in the Github Updater where RBCli crashed when a version tag was not present in the repo.</li>
862
893
  <li>Fixed a bug where deleting a state key would crash Rbcli</li>
@@ -871,17 +902,17 @@
871
902
  <ul>
872
903
  <li>Interactive Commands &ndash; Prompt the user for parameters with a given value</li>
873
904
  </ul>
874
- <h3 id="improvements-6">Improvements</h3>
905
+ <h3 id="improvements-7">Improvements</h3>
875
906
  <ul>
876
907
  <li>Added documentation on logging</li>
877
908
  </ul>
878
909
  <h2 id="022-aug-22-2018">0.2.2 (Aug 22, 2018)</h2>
879
910
  <h3 id="features-4">Features</h3>
880
- <h3 id="bugfixes-5">Bugfixes</h3>
911
+ <h3 id="bugfixes-7">Bugfixes</h3>
881
912
  <ul>
882
913
  <li>Fixed a bug that caused the logger&rsquo;s target and level not to be configured properly via the Configurate block.</li>
883
914
  </ul>
884
- <h3 id="improvements-7">Improvements</h3>
915
+ <h3 id="improvements-8">Improvements</h3>
885
916
  <ul>
886
917
  <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>
887
918
  <li>Abstraction system created for configuration. This has significantly simplified the existing codebase and makes future development easier.</li>
@@ -900,7 +931,7 @@
900
931
  <ul>
901
932
  <li>Remote Execution added for Script and External commands</li>
902
933
  </ul>
903
- <h3 id="bugfixes-6">Bugfixes</h3>
934
+ <h3 id="bugfixes-8">Bugfixes</h3>
904
935
  <ul>
905
936
  <li>Fixed a bug that caused RBCli to crash if a direct path mode script&rsquo;s environment variables were declared as symbols</li>
906
937
  </ul>
@@ -912,13 +943,13 @@
912
943
  <li>RBCli released under GPLv3</li>
913
944
  <li>Copyright/License notice displayed via RBCli tool with <code>rbcli license</code> in accordance with GPLv3 guidelines</li>
914
945
  </ul>
915
- <h3 id="bugfixes-7">Bugfixes</h3>
946
+ <h3 id="bugfixes-9">Bugfixes</h3>
916
947
  <ul>
917
948
  <li>Fixed version number loading for projects</li>
918
949
  <li>Cleaned up command usage help output</li>
919
950
  <li>Fixed script and external command generation</li>
920
951
  </ul>
921
- <h3 id="improvements-8">Improvements</h3>
952
+ <h3 id="improvements-9">Improvements</h3>
922
953
  <ul>
923
954
  <li>A quick reference guide can now be found in README.md</li>
924
955
  <li>Autoupdate feature now allows supplying a custom message</li>
@@ -1366,19 +1397,19 @@
1366
1397
  <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
1367
1398
  <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
1368
1399
  </div>
1369
- <script src="/rbcli/js/clipboard.min.js?1634703589"></script>
1370
- <script src="/rbcli/js/perfect-scrollbar.min.js?1634703589"></script>
1371
- <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1634703589"></script>
1372
- <script src="/rbcli/js/jquery.sticky.js?1634703589"></script>
1373
- <script src="/rbcli/js/featherlight.min.js?1634703589"></script>
1374
- <script src="/rbcli/js/highlight.pack.js?1634703589"></script>
1400
+ <script src="/rbcli/js/clipboard.min.js?1713907739"></script>
1401
+ <script src="/rbcli/js/perfect-scrollbar.min.js?1713907739"></script>
1402
+ <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1713907739"></script>
1403
+ <script src="/rbcli/js/jquery.sticky.js?1713907739"></script>
1404
+ <script src="/rbcli/js/featherlight.min.js?1713907739"></script>
1405
+ <script src="/rbcli/js/highlight.pack.js?1713907739"></script>
1375
1406
  <script>hljs.initHighlightingOnLoad();</script>
1376
- <script src="/rbcli/js/modernizr.custom-3.6.0.js?1634703589"></script>
1377
- <script src="/rbcli/js/learn.js?1634703589"></script>
1378
- <script src="/rbcli/js/hugo-learn.js?1634703589"></script>
1407
+ <script src="/rbcli/js/modernizr.custom-3.6.0.js?1713907739"></script>
1408
+ <script src="/rbcli/js/learn.js?1713907739"></script>
1409
+ <script src="/rbcli/js/hugo-learn.js?1713907739"></script>
1379
1410
 
1380
- <link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
1381
- <script src="/rbcli/mermaid/mermaid.js?1634703589"></script>
1411
+ <link href="/rbcli/mermaid/mermaid.css?1713907739" rel="stylesheet" />
1412
+ <script src="/rbcli/mermaid/mermaid.js?1713907739"></script>
1382
1413
  <script>
1383
1414
  mermaid.initialize({ startOnLoad: true });
1384
1415
  </script>
data/docs/development/code_of_conduct/index.html CHANGED
@@ -3,7 +3,7 @@
3
3
  <head>
4
4
  <meta charset="utf-8">
5
5
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <meta name="generator" content="Hugo 0.88.1" />
6
+ <meta name="generator" content="Hugo 0.125.1">
7
7
  <meta name="description" content="">
8
8
 
9
9
 
@@ -12,21 +12,21 @@
12
12
  <title>Code of Conduct :: RBCli Documentation</title>
13
13
 
14
14
 
15
- <link href="/rbcli/css/nucleus.css?1634703589" rel="stylesheet">
16
- <link href="/rbcli/css/fontawesome-all.min.css?1634703589" rel="stylesheet">
17
- <link href="/rbcli/css/hybrid.css?1634703589" rel="stylesheet">
18
- <link href="/rbcli/css/featherlight.min.css?1634703589" rel="stylesheet">
19
- <link href="/rbcli/css/perfect-scrollbar.min.css?1634703589" rel="stylesheet">
20
- <link href="/rbcli/css/auto-complete.css?1634703589" rel="stylesheet">
21
- <link href="/rbcli/css/atom-one-dark-reasonable.css?1634703589" rel="stylesheet">
22
- <link href="/rbcli/css/theme.css?1634703589" rel="stylesheet">
23
- <link href="/rbcli/css/hugo-theme.css?1634703589" rel="stylesheet">
15
+ <link href="/rbcli/css/nucleus.css?1713907739" rel="stylesheet">
16
+ <link href="/rbcli/css/fontawesome-all.min.css?1713907739" rel="stylesheet">
17
+ <link href="/rbcli/css/hybrid.css?1713907739" rel="stylesheet">
18
+ <link href="/rbcli/css/featherlight.min.css?1713907739" rel="stylesheet">
19
+ <link href="/rbcli/css/perfect-scrollbar.min.css?1713907739" rel="stylesheet">
20
+ <link href="/rbcli/css/auto-complete.css?1713907739" rel="stylesheet">
21
+ <link href="/rbcli/css/atom-one-dark-reasonable.css?1713907739" rel="stylesheet">
22
+ <link href="/rbcli/css/theme.css?1713907739" rel="stylesheet">
23
+ <link href="/rbcli/css/hugo-theme.css?1713907739" rel="stylesheet">
24
24
 
25
- <link href="/rbcli/css/theme-blue.css?1634703589" rel="stylesheet">
25
+ <link href="/rbcli/css/theme-blue.css?1713907739" rel="stylesheet">
26
26
 
27
27
 
28
28
 
29
- <script src="/rbcli/js/jquery-3.3.1.min.js?1634703589"></script>
29
+ <script src="/rbcli/js/jquery-3.3.1.min.js?1713907739"></script>
30
30
 
31
31
  <style>
32
32
  :root #header + #content > #left > #rlblock_left{
@@ -55,14 +55,14 @@
55
55
  <span data-search-clear=""><i class="fas fa-times"></i></span>
56
56
  </div>
57
57
 
58
- <script type="text/javascript" src="/rbcli/js/lunr.min.js?1634703589"></script>
59
- <script type="text/javascript" src="/rbcli/js/auto-complete.js?1634703589"></script>
58
+ <script type="text/javascript" src="/rbcli/js/lunr.min.js?1713907739"></script>
59
+ <script type="text/javascript" src="/rbcli/js/auto-complete.js?1713907739"></script>
60
60
  <script type="text/javascript">
61
61
 
62
62
  var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
63
63
 
64
64
  </script>
65
- <script type="text/javascript" src="/rbcli/js/search.js?1634703589"></script>
65
+ <script type="text/javascript" src="/rbcli/js/search.js?1713907739"></script>
66
66
 
67
67
 
68
68
  </div>
@@ -732,7 +732,7 @@ include:</p>
732
732
  advances</li>
733
733
  <li>Trolling, insulting/derogatory comments, and personal or political attacks</li>
734
734
  <li>Public or private harassment</li>
735
- <li>Publishing others' private information, such as a physical or electronic
735
+ <li>Publishing others&rsquo; private information, such as a physical or electronic
736
736
  address, without explicit permission</li>
737
737
  <li>Other conduct which could reasonably be considered inappropriate in a
738
738
  professional setting</li>
@@ -1199,19 +1199,19 @@ available at <a href="http://contributor-covenant.org/version/1/4/">http://contr
1199
1199
  <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
1200
1200
  <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
1201
1201
  </div>
1202
- <script src="/rbcli/js/clipboard.min.js?1634703589"></script>
1203
- <script src="/rbcli/js/perfect-scrollbar.min.js?1634703589"></script>
1204
- <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1634703589"></script>
1205
- <script src="/rbcli/js/jquery.sticky.js?1634703589"></script>
1206
- <script src="/rbcli/js/featherlight.min.js?1634703589"></script>
1207
- <script src="/rbcli/js/highlight.pack.js?1634703589"></script>
1202
+ <script src="/rbcli/js/clipboard.min.js?1713907739"></script>
1203
+ <script src="/rbcli/js/perfect-scrollbar.min.js?1713907739"></script>
1204
+ <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1713907739"></script>
1205
+ <script src="/rbcli/js/jquery.sticky.js?1713907739"></script>
1206
+ <script src="/rbcli/js/featherlight.min.js?1713907739"></script>
1207
+ <script src="/rbcli/js/highlight.pack.js?1713907739"></script>
1208
1208
  <script>hljs.initHighlightingOnLoad();</script>
1209
- <script src="/rbcli/js/modernizr.custom-3.6.0.js?1634703589"></script>
1210
- <script src="/rbcli/js/learn.js?1634703589"></script>
1211
- <script src="/rbcli/js/hugo-learn.js?1634703589"></script>
1209
+ <script src="/rbcli/js/modernizr.custom-3.6.0.js?1713907739"></script>
1210
+ <script src="/rbcli/js/learn.js?1713907739"></script>
1211
+ <script src="/rbcli/js/hugo-learn.js?1713907739"></script>
1212
1212
 
1213
- <link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
1214
- <script src="/rbcli/mermaid/mermaid.js?1634703589"></script>
1213
+ <link href="/rbcli/mermaid/mermaid.css?1713907739" rel="stylesheet" />
1214
+ <script src="/rbcli/mermaid/mermaid.js?1713907739"></script>
1215
1215
  <script>
1216
1216
  mermaid.initialize({ startOnLoad: true });
1217
1217
  </script>
data/docs/development/contributing/index.html CHANGED
@@ -3,7 +3,7 @@
3
3
  <head>
4
4
  <meta charset="utf-8">
5
5
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <meta name="generator" content="Hugo 0.88.1" />
6
+ <meta name="generator" content="Hugo 0.125.1">
7
7
  <meta name="description" content="">
8
8
 
9
9
 
@@ -12,21 +12,21 @@
12
12
  <title>Contribution Guide :: RBCli Documentation</title>
13
13
 
14
14
 
15
- <link href="/rbcli/css/nucleus.css?1634703589" rel="stylesheet">
16
- <link href="/rbcli/css/fontawesome-all.min.css?1634703589" rel="stylesheet">
17
- <link href="/rbcli/css/hybrid.css?1634703589" rel="stylesheet">
18
- <link href="/rbcli/css/featherlight.min.css?1634703589" rel="stylesheet">
19
- <link href="/rbcli/css/perfect-scrollbar.min.css?1634703589" rel="stylesheet">
20
- <link href="/rbcli/css/auto-complete.css?1634703589" rel="stylesheet">
21
- <link href="/rbcli/css/atom-one-dark-reasonable.css?1634703589" rel="stylesheet">
22
- <link href="/rbcli/css/theme.css?1634703589" rel="stylesheet">
23
- <link href="/rbcli/css/hugo-theme.css?1634703589" rel="stylesheet">
15
+ <link href="/rbcli/css/nucleus.css?1713907739" rel="stylesheet">
16
+ <link href="/rbcli/css/fontawesome-all.min.css?1713907739" rel="stylesheet">
17
+ <link href="/rbcli/css/hybrid.css?1713907739" rel="stylesheet">
18
+ <link href="/rbcli/css/featherlight.min.css?1713907739" rel="stylesheet">
19
+ <link href="/rbcli/css/perfect-scrollbar.min.css?1713907739" rel="stylesheet">
20
+ <link href="/rbcli/css/auto-complete.css?1713907739" rel="stylesheet">
21
+ <link href="/rbcli/css/atom-one-dark-reasonable.css?1713907739" rel="stylesheet">
22
+ <link href="/rbcli/css/theme.css?1713907739" rel="stylesheet">
23
+ <link href="/rbcli/css/hugo-theme.css?1713907739" rel="stylesheet">
24
24
 
25
- <link href="/rbcli/css/theme-blue.css?1634703589" rel="stylesheet">
25
+ <link href="/rbcli/css/theme-blue.css?1713907739" rel="stylesheet">
26
26
 
27
27
 
28
28
 
29
- <script src="/rbcli/js/jquery-3.3.1.min.js?1634703589"></script>
29
+ <script src="/rbcli/js/jquery-3.3.1.min.js?1713907739"></script>
30
30
 
31
31
  <style>
32
32
  :root #header + #content > #left > #rlblock_left{
@@ -55,14 +55,14 @@
55
55
  <span data-search-clear=""><i class="fas fa-times"></i></span>
56
56
  </div>
57
57
 
58
- <script type="text/javascript" src="/rbcli/js/lunr.min.js?1634703589"></script>
59
- <script type="text/javascript" src="/rbcli/js/auto-complete.js?1634703589"></script>
58
+ <script type="text/javascript" src="/rbcli/js/lunr.min.js?1713907739"></script>
59
+ <script type="text/javascript" src="/rbcli/js/auto-complete.js?1713907739"></script>
60
60
  <script type="text/javascript">
61
61
 
62
62
  var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
63
63
 
64
64
  </script>
65
- <script type="text/javascript" src="/rbcli/js/search.js?1634703589"></script>
65
+ <script type="text/javascript" src="/rbcli/js/search.js?1713907739"></script>
66
66
 
67
67
 
68
68
  </div>
@@ -714,29 +714,29 @@
714
714
  <p>That&rsquo;s all there is to it! We&rsquo;ve also kept our acceptance criteria pretty simple, as you&rsquo;ll see below. Feel free to submit a pull request even if you don&rsquo;t meet it if you would like your code or feature to be reviewed first; we do want to be mindful of your time and will review submissions before they are polished.</p>
715
715
  <h1 id="develpment-mode">Develpment Mode</h1>
716
716
  <p>To allow for easy deveopment, Rbcli has a development mode which allows a project to include rbcli from a local folder instead of the default gem path. To use it, add the following to your shell&rsquo;s profile (typically <code>~/.bash_profile</code> or <code>~/.profile</code>):</p>
717
- <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">export RBCLI_ENV<span style="color:#f92672">=</span><span style="color:#e6db74">&#39;development&#39;</span>
718
- export RBCLI_DEVPATH<span style="color:#f92672">=</span><span style="color:#e6db74">&#39;/path/to/rbcli/lib/rbcli&#39;</span>
719
- alias rbcli<span style="color:#f92672">=</span><span style="color:#e6db74">&#39;/path/to/rbcli/exe/rbcli&#39;</span>
720
- </code></pre></div><h1 id="code-acceptance-criteria">Code Acceptance Criteria</h1>
717
+ <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>export RBCLI_ENV<span style="color:#f92672">=</span><span style="color:#e6db74">&#39;development&#39;</span>
718
+ </span></span><span style="display:flex;"><span>export RBCLI_DEVPATH<span style="color:#f92672">=</span><span style="color:#e6db74">&#39;/path/to/rbcli/lib/rbcli&#39;</span>
719
+ </span></span><span style="display:flex;"><span>alias rbcli<span style="color:#f92672">=</span><span style="color:#e6db74">&#39;/path/to/rbcli/exe/rbcli&#39;</span>
720
+ </span></span></code></pre></div><h1 id="code-acceptance-criteria">Code Acceptance Criteria</h1>
721
721
  <h2 id="tabs-not-spaces">Tabs, Not Spaces</h2>
722
722
  <p>Please, and thanks. We all like to use different indentation levels and styles, and this will keep us consistent between editors.</p>
723
723
  <p>For filetypes where tabs are not supported (such as YAML), please stick to using two (2) spaces.</p>
724
724
  <h2 id="documentation-for-user-features">Documentation for User Features</h2>
725
725
  <p>For any modification that alters the way RBCli is used &ndash; we&rsquo;re talking additional features, options, keyword changes, major behavioral changes, and the like &ndash; the documentation will need to be updated as well. You&rsquo;ll be happy to know we designed it to make the process relatively painless.</p>
726
726
  <p>RBCli&rsquo;s documentation is essentially a collection of markdown files that have been compiled into a static site using <a href="https://www.mkdocs.org">MkDocs</a>. If you already have python and pip on your system, you can install it by running:</p>
727
- <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">pip install mkdocs mkdocs-material
728
- </code></pre></div><p>You can find the source markdown files in the <code>docs-src/docs</code> folder, and the menu organization in <code>docs-src/mkdocs.yml</code>. To preview your changes on a live site, run:</p>
729
- <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">mkdocs serve
730
- </code></pre></div><p>Also, don&rsquo;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>
727
+ <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>pip install mkdocs mkdocs-material
728
+ </span></span></code></pre></div><p>You can find the source markdown files in the <code>docs-src/docs</code> folder, and the menu organization in <code>docs-src/mkdocs.yml</code>. To preview your changes on a live site, run:</p>
729
+ <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>mkdocs serve
730
+ </span></span></code></pre></div><p>Also, don&rsquo;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>
731
731
  <p>Once you&rsquo;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>
732
732
  <h2 id="deprecations">Deprecations</h2>
733
733
  <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>
734
- <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ruby" data-lang="ruby"><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">DeprecationWarning</span><span style="color:#f92672">.</span>new deprecated_command, message, version_when_code_will_be_removed
735
- </code></pre></div><p>So, for example:</p>
736
- <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ruby" data-lang="ruby"><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">DeprecationWarning</span><span style="color:#f92672">.</span>new <span style="color:#e6db74">&#39;Rbcli::Configurate.me--first_run&#39;</span>, <span style="color:#e6db74">&#39;Please use `RBCli::Configurate.hooks` as the parent block instead.&#39;</span>, <span style="color:#e6db74">&#39;0.3.0&#39;</span>
737
- </code></pre></div><p>will display the following message to the user, in red, any any time the application is run:</p>
738
- <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-text" data-lang="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.
739
- </code></pre></div><p>Additionally, it will place the same line in the logs using <code>Rbcli.logger.warn</code> if logging is enabled.</p>
734
+ <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-ruby" data-lang="ruby"><span style="display:flex;"><span><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">DeprecationWarning</span><span style="color:#f92672">.</span>new deprecated_command, message, version_when_code_will_be_removed
735
+ </span></span></code></pre></div><p>So, for example:</p>
736
+ <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-ruby" data-lang="ruby"><span style="display:flex;"><span><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">DeprecationWarning</span><span style="color:#f92672">.</span>new <span style="color:#e6db74">&#39;Rbcli::Configurate.me--first_run&#39;</span>, <span style="color:#e6db74">&#39;Please use `RBCli::Configurate.hooks` as the parent block instead.&#39;</span>, <span style="color:#e6db74">&#39;0.3.0&#39;</span>
737
+ </span></span></code></pre></div><p>will display the following message to the user, in red, any any time the application is run:</p>
738
+ <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-text" data-lang="text"><span style="display:flex;"><span>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.
739
+ </span></span></code></pre></div><p>Additionally, it will place the same line in the logs using <code>Rbcli.logger.warn</code> if logging is enabled.</p>
740
740
  <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>
741
741
  <h1 id="maintainers-notes">Maintainer&rsquo;s Notes</h1>
742
742
  <p>To install this gem onto your local machine from source, run <code>bundle exec rake install</code>.</p>
@@ -1178,19 +1178,19 @@ alias rbcli<span style="color:#f92672">=</span><span style="color:#e6db74">&#39;
1178
1178
  <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
1179
1179
  <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
1180
1180
  </div>
1181
- <script src="/rbcli/js/clipboard.min.js?1634703589"></script>
1182
- <script src="/rbcli/js/perfect-scrollbar.min.js?1634703589"></script>
1183
- <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1634703589"></script>
1184
- <script src="/rbcli/js/jquery.sticky.js?1634703589"></script>
1185
- <script src="/rbcli/js/featherlight.min.js?1634703589"></script>
1186
- <script src="/rbcli/js/highlight.pack.js?1634703589"></script>
1181
+ <script src="/rbcli/js/clipboard.min.js?1713907739"></script>
1182
+ <script src="/rbcli/js/perfect-scrollbar.min.js?1713907739"></script>
1183
+ <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1713907739"></script>
1184
+ <script src="/rbcli/js/jquery.sticky.js?1713907739"></script>
1185
+ <script src="/rbcli/js/featherlight.min.js?1713907739"></script>
1186
+ <script src="/rbcli/js/highlight.pack.js?1713907739"></script>
1187
1187
  <script>hljs.initHighlightingOnLoad();</script>
1188
- <script src="/rbcli/js/modernizr.custom-3.6.0.js?1634703589"></script>
1189
- <script src="/rbcli/js/learn.js?1634703589"></script>
1190
- <script src="/rbcli/js/hugo-learn.js?1634703589"></script>
1188
+ <script src="/rbcli/js/modernizr.custom-3.6.0.js?1713907739"></script>
1189
+ <script src="/rbcli/js/learn.js?1713907739"></script>
1190
+ <script src="/rbcli/js/hugo-learn.js?1713907739"></script>
1191
1191
 
1192
- <link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
1193
- <script src="/rbcli/mermaid/mermaid.js?1634703589"></script>
1192
+ <link href="/rbcli/mermaid/mermaid.css?1713907739" rel="stylesheet" />
1193
+ <script src="/rbcli/mermaid/mermaid.js?1713907739"></script>
1194
1194
  <script>
1195
1195
  mermaid.initialize({ startOnLoad: true });
1196
1196
  </script>