rbcli 0.2.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6b4a98c7a6e1974987798099020dbb037a5966f1b463832a23caed9dcf3e3f6
-  data.tar.gz: c4dba14eeb1fc10a17022b0082b3f6a8d3679de8a4f9d292d34c4d35547ac7d9
+  metadata.gz: 558f89fc85c5ce81beadc393101cee8e2af7cefb082bb0af255a60d33a58dd3e
+  data.tar.gz: 8d19d26b6ee7612cef2d5f2e4e8f8d47b509dc759fc759091606b7d71bd56f66
 SHA512:
-  metadata.gz: 62db4643f55cd2c8044441ca209c1ee9d1e8b6377b0c7d09e5bf6015328b0b6291fb8b57f974c2c584faa838b7325f508ddf81394f90cc0d5cc49d8a32183c32
-  data.tar.gz: d2bd43820d8f6ab88424f96f0fb5767312d9267cd06782ff060400c41759e801f7d36828919e084b16650b65749519ac581145850ee7381f007e2e2e3103d084
+  metadata.gz: 4ab7a72246f3567a2661860e0e76340336cdb53842e340cd5bfd5571d6f30a5a1fad684882a7d0a53c0629c7a1c811aff6387a84d2420fa874b6e9eac8efd9e6
+  data.tar.gz: 765ada196994fe2bea223598ca9b84ef38aeee567937c29b003c5118102aaf7227f04e14b8fc2c406c037440eba1c292f284474836b02161ec776aef456bde32

data/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake" /></Settings>

data/.rbenv-gemsets

@@ -0,0 +1 @@
+rbcli

data/CHANGELOG.md

@@ -1,5 +1,42 @@
 # Changelog
 
+## 0.3 (July 31, 2020)
+
+### Improvements
+
+* Deprecated Ruby code has been updated to be compatible with Ruby 2.7.x
+* All depedencies have been updated to their latest versions and tested to ensure continued compatibility
+* Old-style execution hooks have been fully deprecated in favor of declaring them in the `Rbcli::Configurate.hooks` block. To ensure compatibility, save your current hooks and generate new ones using the command `rbcli hook`
+* Skeleton gemspec now includes `spec.required_ruby_version`, which matches Rbcli's requirement
+* Documentation updated to support latest Hugo and theme versions (Hugo 0.74.3 and hugo-theme-learn 2.5.0)
+
+### Features
+
+* Rbcli Deprecation Warnings now show the offending line of code to ease updating
+* The `$libdir` global variable is defined by default in the skeleton project, allwoing easy access to the project's `lib` folder
+
+## 0.2.12 (July 29, 2019)
+
+### Improvements
+
+* The base project skeleton now includes an improved structure for the `lib/` folder
+* Documentation now uses Hugo instead of MkDocs for site generation.
+* Updated dependencies in project skeleton to latest versions
+
+### Features
+
+* Development mode can be enabled by setting the environment variables: `RBCLI_ENV=development` and `RBCLI_DEVPATH=[path to local Rbcli folder]` to simplify changes to Rbcli during development. Combined with setting `alias rbcli='/path/to/rbcli/exe/rbcli'`, gem installation is not required for development work
+
+## 0.2.11 (Feb 27, 2019)
+
+### Improvements
+
+* Updated the dependent gem verions to use the latest available versions
+
+### Bugfixes
+
+* Fixed the nested triggers of the message I/O system
+
 ## 0.2.8 (Nov 7, 2018)
 
 ### Features

data/Gemfile.lock

@@ -1,74 +1,74 @@
 PATH
   remote: .
   specs:
-    rbcli (0.2.8)
-      aws-sdk-dynamodb (~> 1.6)
+    rbcli (0.3.0)
+      aws-sdk-dynamodb (~> 1.51)
       colorize (~> 0.8)
       deep_merge (~> 1.2)
       macaddr (~> 1.7)
-      mdless (~> 0.0)
-      net-scp (~> 1.2)
-      net-ssh (~> 5.0)
-      octokit (~> 4.9)
-      rufus-scheduler (~> 3.5)
+      mdless (~> 1.0)
+      net-scp (~> 3.0)
+      net-ssh (~> 6.1)
+      octokit (~> 4.18)
+      rufus-scheduler (~> 3.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    aws-eventstream (1.0.1)
-    aws-partitions (1.106.0)
-    aws-sdk-core (3.32.0)
-      aws-eventstream (~> 1.0)
-      aws-partitions (~> 1.0)
-      aws-sigv4 (~> 1.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    aws-eventstream (1.1.0)
+    aws-partitions (1.348.0)
+    aws-sdk-core (3.104.3)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-dynamodb (1.13.0)
-      aws-sdk-core (~> 3, >= 3.26.0)
-      aws-sigv4 (~> 1.0)
-    aws-sigv4 (1.0.3)
+    aws-sdk-dynamodb (1.51.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.2.1)
+      aws-eventstream (~> 1, >= 1.0.2)
     colorize (0.8.1)
     deep_merge (1.2.1)
-    et-orbi (1.1.6)
+    et-orbi (1.2.4)
       tzinfo
-    faraday (0.15.3)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    fugit (1.1.6)
-      et-orbi (~> 1.1, >= 1.1.6)
-      raabro (~> 1.1)
+    fugit (1.3.6)
+      et-orbi (~> 1.1, >= 1.1.8)
+      raabro (~> 1.3)
     jmespath (1.4.0)
-    macaddr (1.7.1)
-      systemu (~> 2.6.2)
-    mdless (0.0.10)
-    minitest (5.11.3)
-    multipart-post (2.0.0)
-    net-scp (1.2.1)
-      net-ssh (>= 2.6.5)
-    net-ssh (5.0.2)
-    octokit (4.13.0)
+    macaddr (1.7.2)
+      systemu (~> 2.6.5)
+    mdless (1.0.14)
+    multipart-post (2.1.1)
+    net-scp (3.0.0)
+      net-ssh (>= 2.6.5, < 7.0.0)
+    net-ssh (6.1.0)
+    octokit (4.18.0)
+      faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
-    public_suffix (3.0.3)
-    raabro (1.1.6)
-    rake (10.5.0)
-    rufus-scheduler (3.5.2)
-      fugit (~> 1.1, >= 1.1.5)
-    sawyer (0.8.1)
-      addressable (>= 2.3.5, < 2.6)
-      faraday (~> 0.8, < 1.0)
+    public_suffix (4.0.5)
+    raabro (1.3.1)
+    rake (13.0.1)
+    rufus-scheduler (3.6.0)
+      fugit (~> 1.1, >= 1.1.6)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
     systemu (2.6.5)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
-  minitest (~> 5.0)
-  rake (~> 10.0)
+  bundler (~> 2.1)
+  rake (~> 13.0)
   rbcli!
 
 BUNDLED WITH
-   1.16.4
+   2.1.4

data/README.md

@@ -1,8 +1,8 @@
 # RBCli
 
-RBCli is currently in Alpha stages of development. All releases can be considered stable, though breaking changes may be made between versions.
+RBCli is currently in Beta stages of development. All releases can be considered stable, though breaking changes may be made between versions.
 
-Latest Release: v0.2.8 (Nov 7, 2018) -- See the [changelog][changelog] for complete details.
+Latest Release: [![Gem Version](https://badge.fury.io/rb/rbcli.svg)](https://badge.fury.io/rb/rbcli) -- See the [changelog][changelog] for complete details.
 
 [You can find the Official Documentation for RBCli Here.][documentation_home]
 

data/docs-src/archetypes/default.md

@@ -0,0 +1,6 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date }}
+draft: true
+---
+

data/docs-src/config.toml

@@ -0,0 +1,37 @@
+## Theme Documentation: https://learn.netlify.com/en/
+
+baseURL = "https://akhoury6.github.io/rbcli/"
+languageCode = "en-us"
+title = "RBCli Documentation"
+theme = "hugo-theme-learn"
+
+[params]
+# Can be "red", "blue", or "green", or comment out for purple
+themeVariant = "blue"
+
+[[menu.shortcuts]]
+name = "<i class='fab fa-github'></i> Github repo"
+identifier = "github"
+url = "https://github.com/akhoury6/rbcli"
+weight = 10
+
+#[[menu.shortcuts]]
+#name = "<i class='fas fa-camera'></i> Showcases"
+#url = "/showcase"
+#weight = 11
+
+[[menu.shortcuts]]
+name = "<i class='far fa-gem'></i> Rubygems"
+identifier = "rubygems"
+url = "https://rubygems.org/gems/rbcli"
+weight = 20
+
+#[[menu.shortcuts]]
+#name = "<i class='fas fa-bullhorn'></i> Credits"
+#url = "/credits"
+#weight = 30
+
+
+# For search functionality
+[outputs]
+home = [ "HTML", "RSS", "JSON"]

data/docs-src/{docs/index.md → content/_index.md}

@@ -32,9 +32,9 @@ Some of its key features include:
 
 * __Remote Execution__: Automatically execute commands on remote machines via SSH
 
+* __Interactive Commands__: Automatically prompt users for paramter values if not given on the command line. This pattern allows for easy user interaction while still allowing scripting without the use of _expect_.
 
-If you're just getting started with RBCli, take a look at the [Tutorial][tutorial]. Or take a look at the [Advanced] menu above to look through RBCli's additional featureset.
+If you're just getting started with RBCli, take a look at the [Tutorial][tutorial]. Or take a look at the [Advanced] menu to look through RBCli's additional featureset.
 
-
-[tutorial]: ./tutorial/10-getting_started.md
-[advanced]: ./advanced/user_config_files.md
+[tutorial]: {{< ref "tutorial" >}}
+[advanced]: {{< ref "advanced" >}}

data/docs-src/content/advanced/_index.md

@@ -0,0 +1,11 @@
++++
+title = "Advanced"
+date = 2019-06-20T15:08:08-04:00
+weight = 20
+chapter = true
+#pre = "<b>X. </b>"
++++
+
+# Advanced Features
+
+This section describes the more advanced feature of RBCli. Mastering them will make you a CLI tool Ninja.

data/docs-src/{docs → content}/advanced/automatic_updates.md

@@ -1,4 +1,8 @@
-# Automatic Updates
+---
+title: "Automatic Updates"
+date: 2019-06-20T15:07:21-04:00
+draft: false
+---
 
 RBCli can automatically notify users when an update is available. If `force_update` is set (see below), RBCli can halt execution until the user updates their application.
 
@@ -38,5 +42,5 @@ Setting `force_update: true` will halt execution if an update is available, forc
 The `message` parameter allows setting a custom message that will be displayed when an update is available. Leaving it as `nil` will use the default message provided by RBCli.
 
 [github_release_documentation]: https://help.github.com/articles/creating-releases/
-[userspace_configuration]: user_config_files.md
+[userspace_configuration]: {{< ref "advanced/user_config_files" >}}
 [github_generate_token]: https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/

data/docs-src/{docs → content}/advanced/command_types.md

@@ -1,4 +1,8 @@
-# Advanced Command Types
+---
+title: "Command Types"
+date: 2019-06-20T15:07:21-04:00
+draft: false
+---
 
 RBCli has three different command types:
 
@@ -138,7 +142,7 @@ end
 __NOTE__: Passing user-supplied data as part of the command string may be a security risk (example: `/path/to/application --name #{params[:name]}`). It is highly recommended to provide the fixed strings yourself, and only select which strings are used based on the variables provided. This is demonstrated in the example above.
 
 
-[your_first_command]: ../tutorial/30-your_first_command.md
-[parameters_documentation]: ../tutorial/40-options_parameters_and_arguments.md
-[user_config_documentation]: ../advanced/user_config_files.md
+[your_first_command]: {{< ref "tutorial/30-your_first_command" >}}
+[parameters_documentation]: {{< ref "tutorial/40-options_parameters_and_arguments" >}}
+[user_config_documentation]: {{< ref "advanced/user_config_files" >}}
 [jq_documentation]: https://stedolan.github.io/jq/manual/

data/docs-src/{docs → content}/advanced/distributed_state_locking.md

@@ -1,4 +1,8 @@
-# Distributed Locking and State Sharing
+---
+title: "Distributed State and Locking"
+date: 2019-06-20T15:07:21-04:00
+draft: false
+---
 
 Distributed Locking allows a [Remote State][state_storage] to be shared among multiple users of the application to make writes appear atomic between sessions. To use it, simply set the  `locking:` parameter to `true` when enabling remote state.
 
@@ -30,4 +34,4 @@ Rbcli.remote_state.disconnect
 Even if you do not want to store any data, you can leverage manual locking to control access to a different shared resource, such as a stateful API. For example, if you write a cloud deployment toolkit, you can ensure that only one user is attempting to modify a deployment at any given time.
 
 
-[state_storage]: state_storage.md
+[state_storage]: {{< ref "advanced/state_storage" >}}

data/docs-src/{docs → content}/advanced/hooks.md

@@ -1,4 +1,8 @@
-# Execution Hooks
+---
+title: "Execution Hooks"
+date: 2019-06-20T15:07:21-04:00
+draft: false
+---
 
 RBCli provides you with hooks that can be used to have code execute at certain places in the execution chain. These hooks are optional, and do not have to be defined for your application to run.
 
@@ -62,4 +66,4 @@ rbcli hook -f
 You will then find the hook under `hooks/first_run.rb`.
 
 
-[state_storage]: state_storage.md
+[state_storage]: {{< ref "advanced/state_storage" >}}

data/docs-src/{docs → content}/advanced/interactive_commands.md

@@ -1,4 +1,8 @@
-# Interactive Commands
+---
+title: "Interactive Commands"
+date: 2019-06-20T15:07:21-04:00
+draft: false
+---
 
 ## Why interactive commands?
 

data/docs-src/{docs → content}/advanced/logging.md

@@ -1,4 +1,8 @@
-# Logging
+---
+title: "Logging"
+date: 2019-06-20T15:07:21-04:00
+draft: false
+---
 
 Logging with RBCli is straightforward - it looks at the config file for logging settings, and instantiates a single, globally accessible [Logger][ruby_logger] object. You can access it within a standard command like this:
 
@@ -32,4 +36,4 @@ logger:
 ```
 
 [ruby_logger]: https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html
-[userspace_configuration]: user_config_files.md
+[userspace_configuration]: {{< ref "advanced/user_config_files" >}}

data/docs-src/{docs → content}/advanced/remote_execution.md

@@ -1,4 +1,8 @@
-# Remote Execution
+---
+title: "Remote Execution"
+date: 2019-06-20T15:07:21-04:00
+draft: false
+---
 
 RBCli can be configured to execute commands on a remote machine via SSH instead of locally.
 

data/docs-src/{docs → content}/advanced/state_storage.md

@@ -1,4 +1,8 @@
-# State Storage
+---
+title: "State Storage"
+date: 2019-06-20T15:07:21-04:00
+draft: false
+---
 
 RBCli supports both local and remote state storage. This is done by synchronizing a Hash with either the local disk or a remote database.
 
@@ -113,5 +117,4 @@ For more information on the available commands, see the documentation on [Local
 
 
 [aws_sdk_credentials]: https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html
-[distributed_state_locking]: distributed_state_locking.md
-
+[distributed_state_locking]: {{< ref "advanced/distributed_state_locking" >}}

data/docs-src/{docs → content}/advanced/user_config_files.md

@@ -1,4 +1,8 @@
-# Configuration Files
+---
+title: "User Configuration Files"
+date: 2019-06-20T15:07:21-04:00
+draft: false
+---
 
 RBCli provides built-in support for creating and managing userspace configuration files. It does this through two chains: the __defaults chain__ and the __user chain__.
 

data/docs-src/content/development/_index.md

@@ -0,0 +1,11 @@
++++
+title = "Development"
+date = 2019-06-20T15:27:12-04:00
+weight = 30
+chapter = true
+#pre = "<b>X. </b>"
++++
+
+# Development
+
+Want to make RBCli even better? On behalf of all RBCli users everywhere, it's much appreciated. Of course, even if you keep your changes to yourself and don't contribute back, now that you're a ninja you'll likely want to pave your own road forward. This section will guide you how.

data/docs-src/{docs/imported → content/development}/changelog.md

@@ -1,16 +1,83 @@
-# Changelog
+---
+title: "Changelog"
+date: 2019-06-20T15:07:21-04:00
+draft: false
+weight: 100
+---
 
-## 0.2.6 (UNRELEASED)
+
+## 0.3 (July 31, 2020)
+
+### Improvements
+
+* Deprecated Ruby code has been updated to be compatible with Ruby 2.7.x
+* All depedencies have been updated to their latest versions and tested to ensure continued compatibility
+* Old-style execution hooks have been fully deprecated in favor of declaring them in the `Rbcli::Configurate.hooks` block. To ensure compatibility, save your current hooks and generate new ones using the command `rbcli hook`
+* Skeleton gemspec now includes `spec.required_ruby_version`, which matches Rbcli's requirement
+* Documentation updated to support latest Hugo and theme versions (Hugo 0.74.3 and hugo-theme-learn 2.5.0)
+
+### Features
+
+* Rbcli Deprecation Warnings now show the offending line of code to ease updating
+* The `$libdir` global variable is defined by default in the skeleton project, allwoing easy access to the project's `lib` folder
+
+## 0.2.12 (July 29, 2019)
+
+### Improvements
+
+* The base project skeleton now includes an improved structure for the `lib/` folder
+* Documentation now uses Hugo instead of MkDocs for site generation.
+* Updated dependencies in project skeleton to latest versions
+
+### Features
+
+* Development mode can be enabled by setting the environment variables: `RBCLI_ENV=development` and `RBCLI_DEVPATH=[path to local Rbcli folder]` to simplify changes to Rbcli during development. Combined with setting `alias rbcli='/path/to/rbcli/exe/rbcli'`, gem installation is not required for development work
+
+## 0.2.11 (Feb 27, 2019)
+
+### Improvements
+
+* Updated the dependent gem verions to use the latest available versions
+
+### Bugfixes
+
+* Fixed the nested triggers of the message I/O system
+
+## 0.2.8 (Nov 7, 2018)
+
+### Features
+
+* Added a standardized message I/O system
+
+### Improvements
+
+* Enabled the safe usage of anchors in YAML config files
+* Improved the method of determining the script name to be more portable across OS'es
+
+### Bugfixes
+
+* Fixed an error which caused RBCli to crash when using `local_state`
+* Fixed a bug which caused the `rbcli init` command to occassionally fail for mini and micro projects
+
+### Changes
+
+* Changed the `rbcli init` helptext to match the order of complexity of projects (standard -> mini -> micro)
+
+## 0.2.7 (Oct 17, 2018)
+
+### Improvements
+
+* Added a dev mode for scripts that allows using a local RBCli copy instead of requiring the gem to be installed
 
 ### Bugfixes
 
-Fixed a bug that caused the rbcli tool not to detect project folders correctly.
-Command parameter `prompt:` now works when `required` is set to `true`.
+* Fixed a bug that caused the rbcli tool not to detect project folders correctly.
+* Command parameter `prompt:` now works when `required` is set to `true`.
 
 ### Changes
 
-The `rbcli init` command now initializes into the current working directory instead of creating a new one. 
-Fixed erroneous documentation about the 'merge' setting on userspace config.
+* The `rbcli init` command now initializes into the current working directory instead of creating a new one. 
+* Fixed erroneous documentation about the 'merge' setting on userspace config.
 
 ## 0.2.5 (Oct 8, 2018)