rbcli 0.3.2 → 0.4.0

data/skeletons/project/application/commands/command.erb

@@ -1,28 +0,0 @@
-#########################
-## Command Declaration ##
-#########################
-# With rbcli, commands are declared by subclassing
-# from Rbcli::Command. The name of the class will be
-# the command that is available to the user.
-#########################
-class <%= @vars[:name].capitalize %> < Rbcli::Command                                 # Declare a new command by subclassing Rbcli::Command
-	description '<%= @vars[:description] %>'                                            # (Required) Short description for the global help
-	usage <<-EOF
-<%= @vars[:usage_text] %>
-EOF
-	parameter :force, 'Force testing', short: 'f', type: :boolean, default: false, required: false, prompt: 'Force testing?'  # (Optional, Multiple) Add a command-specific CLI parameter. Uses the same format as options (see application/options.rb for help)
-
-	config_default :myopt2, description: 'My Option #2', default: 'Default Value Here'  # (Optional, Multiple) Specify an individual configuration parameter and set a default value. These will also be included in generated user config.
-                                                                                      # Alternatively, you can simply create a yaml file in the `default_user_configs` directory in your project that specifies the default values of all options
-
-	action do |params, args, global_opts, config|                                       # (Required) Block to execute if the command is called.
-		Rbcli::log.info { 'These logs can go to STDERR, STDOUT, or a file' }              # Example log. Interface is identical to Ruby's logger
-		puts "\nArgs:\n#{args}"                    # Arguments that came after the command on the CLI (i.e.: `mytool test bar baz` will yield args=['bar', 'baz'])
-		puts "Params:\n#{params}"                  # Parameters, as described through the option statements above
-		puts "Global opts:\n#{global_opts}"        # Global Parameters, as descirbed in the Configurate section
-		puts "Config:\n#{config}"                  # Config file values
-		puts "LocalState:\n#{Rbcli.local_state}"   # Local persistent state storage (when available) -- if unsure use Rbcli.local_state.nil?
-		puts "RemoteState:\n#{Rbcli.remote_state}" # Remote persistent state storage (when available) -- if unsure use Rbcli.remote_state.nil?
-		puts "\nDone!!!"
-	end
-end

data/skeletons/project/application/commands/script.erb

@@ -1,30 +0,0 @@
-#########################
-## Command Declaration ##
-#########################
-# With rbcli, commands are declared by subclassing
-# from Rbcli::Command. The name of the class will be
-# the command that is available to the user.
-#########################
-class <%= @vars[:name].capitalize %> < Rbcli::Command                                 # Declare a new command by subclassing Rbcli::Command
-	description '<%= @vars[:description] %>'                                            # (Required) Short description for the global help
-	usage <<-EOF
-<%= @vars[:usage_text] %>
-EOF
-parameter :force, 'Force testing', type: :boolean, default: false, required: false    # (Optional, Multiple) Add a command-specific CLI parameter. Can be called multiple times
-
-	config_default :myopt2, description: 'Testing this again', default: true            # (Optional, Multiple) Specify an individual configuration parameter and set a default value. These will also be included in generated user config.
-	# Alternatively, you can create a yaml file in the `default_user_configs` directory in your project
-
-	#remote_permitted                                                                   # (Optional) Allow this script to be executed on remote hosts. Requires enabling remote execution in the RBCli configuration
-
-<% if @vars[:no_script] -%>
-	extern path: 'path/to/application', envvars: {MYVAR: 'some_value'}                               # (Required) Runs a given application, with optional environment variables, when the user runs the command.
-	#extern envvars: {MY_OTHER_VAR: 'another_value'} do |params, args, global_opts, config|          # Alternate usage. Supplying a block instead of a path allows us to modify the command based on the arguments and configuration supplied by the user. This allows passing config settings as command line arguments to external applications. The block must return a string, which is the command to be executed.
-	#	cmd = '/path/to/application'
-	#	cmd += ' --test-script foo --ignore-errors' if params[:force]
-	#	cmd
-	#end
-<% else -%>
-	script                                                                                           # (Required): Do not edit this line. Do delete it if you wish to manually specify a script path and set environment variables.
-<% end -%>
-end

data/skeletons/project/application/commands/scripts/script.sh

@@ -1,60 +0,0 @@
-#!/usr/bin/env bash
-#
-###
-# This is the RBCli script for the command `<%= @vars[:name] %>`
-###
-#
-# You can access RBCli's variables via the `rbcli` command, which is imported by this line:
-if [[ RBCLI_ENV -eq "development" ]]; then
-	__RBCLI_LIBSH_PATH="${RBCLI_DEVPATH}/../../lib-sh/lib-rbcli.sh"
-else
-	__RBCLI_LIBSH_PATH=$(echo $(cd "$(dirname $(gem which rbcli))/../lib-sh" && pwd)/lib-rbcli.sh)
-fi
-source "${__RBCLI_LIBSH_PATH}"
-#
-# The `rbcli` function is actually a wrapper around `jq` (https://stedolan.github.io/jq/). It can automatically
-# jq on users' machines if running Linux or OSX, and users have sudo access. If not, users will be prompted to install
-# it. RBCli passes in the variable data by populating evironment variables with JSON, and requires JQ to parse them.
-#
-# You can view the entire JSON structures with:
-#
-#    rbcli params
-#    rbcli args
-#    rbcli global_opts
-#    rbcli config
-#    rbcli myvars
-#
-# And to access specific data within that json, you can add some jq syntax as shown below. The first two examples show
-# how to get data from a nested hash, and the last example shows how to select an item from an array.
-#
-#     echo "Log Level:  $(rbcli config .logger.log_level)"
-#     echo "Log Target: $(rbcli config .logger.log_target)"
-#     echo "First Argument (if passed): $(rbcli args .[0])"
-#
-# If you wish to parse the variables manually and remove the dependency on JQ, you can comment out the line above
-# and access these variables directly:
-#
-#    __RBCLI_PARAMS
-#    __RBCLI_ARGS
-#    __RBCLI_GLOBAL
-#    __RBCLI_CONFIG
-#    __RBCLI_MYVARS
-#
-###
-#
-
-echo "------Params------"
-rbcli params
-echo "------Args------"
-rbcli args
-echo "------Global Opts------"
-rbcli global_opts
-echo "------Config------"
-rbcli config
-echo "------MyVars------"
-rbcli myvars
-echo ""
-echo "Usage Examples:"
-echo "Log Level:  $(rbcli config .logger.log_level)"
-echo "Log Target: $(rbcli config .logger.log_target)"
-echo "First Argument (if passed): $(rbcli args .[0])"

data/skeletons/project/application/options.rb

@@ -1,34 +0,0 @@
-Rbcli::Configurate.me do
-	####
-	# Command Line Options
-	###
-	# Here you can set global options for users on the command line.
-	#
-	# RBCli supports commands with syntax as follows:
-	#   toolname [options] command [parameters] [lineitem]
-	#
-	# Here you are defining the [options]. The parameters and lineitms (subcommands) are
-	# defined under their command blocks.
-	#
-	# Options are defined in the follwoing format:
-	#     option :<name>, "<description_string>", short: '<character>', type: <variable_type>, default: <default_value>, permitted: [<array_of_permitted_values]
-	#
-	#       name:               (Required) The long name of the option, as a symbol. This will be represented as `--name` on the command line
-	#       description_string: (Required) A short description of the command that will appear in the help text for the user
-	#       type:               (Required) The following types are supported: `:string`, `:boolean` or `:flag`, `:integer`, and `:float`
-	#       default:            (Optional) A default value for the option if one isn't entered (default: nil)
-	#       short:              (Optional) A letter that acts as a shortcut for the option. This will allow users to apply the command as `-n`
-	#                                       To not have a short value, set this to :none
-	#                                       (default: the first letter of the long name)
-	#       required:           (Optional) Specify whether the option is required from the user (default: false)
-	#       permitted:          (Optional) An array of whitelisted values for the option (default: nil)
-	#
-	# To specify multiple options, simply copy the line and modify as desired.
-	#
-	# Once parsed, option values will be placed in a hash where they can be accessed via their names as shown above where
-	# they are made available to your hooks and commands.
-	###
-
-	## Option -- (Optional, Multiple) -- Add a global CLI Option
-	option :name, 'Give me your name', short: 'n', type: :string, default: 'Jack', required: false, permitted: ['Jack', 'Jill']
-end

data/skeletons/project/config/autoupdate.rb

@@ -1,35 +0,0 @@
-Rbcli::Configurate.me do
-	####
-	# AUTOUPDATE
-	###
-	# RBCli can notify users when you have an update to your application.
-	# This requires your application to be published either on Rubygems.org, Github, or Github Enterprise.
-	# Note that only one can be enabled at a time.
-	# For more details on each integration, see below.
-	###
-
-	## Autoupdate, Github -- (Optional) --  Check for updates to this application at a GitHub repo.
-	# The repo should use version number tags in accordance to Github's best practices: https://help.github.com/articles/creating-releases/
-	#
-	# Note that the `access_token` can be overridden by the user via their configuration file, so it can be left as `nil`,
-	# which will require your users to enter their github tokens to use this feature.
-	# For instructions on generating a new access token, see: https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/
-	# The token is not needed if using a public repo.
-	#
-	# The `enterprise_hostname` setting allows you to point RBCli at a local GitHub Enterprise server.
-	#
-	# Setting `force_update: true` will halt execution if an update is available, forcing the user to update.
-	#
-	# The `message` parameter allows setiting a custom message. Leave as nil to use the default message provided by RBCli.
-	#
-	# Uncomment the line below to enable
-
-	#autoupdate github_repo: '<your_user>/<your_repo>', access_token: nil, enterprise_hostname: nil, force_update: false, message: nil
-
-
-	## Autoupdate, Rubygems.org -- (Optional) -- Check for updates to this application on Rubygems.org
-	# Uncomment the line below to enable
-
-	#autoupdate gem: '<your_gem>', force_update: false, message: nil
-
-end

data/skeletons/project/config/general.rb

@@ -1,17 +0,0 @@
-Rbcli::Configurate.me do
-	####
-	# General Configuration
-	###
-	# Here you will find the general configuration options for RBCli.
-	###
-
-	## Description -- (Required) -- A description that will appear when the user looks at the help with -h.
-	# This should describe what the application does, and if applicable, give some common usage examples.
-	# It can be as long as needed. Use a heredoc if desired: <<-EOF TextGoesHere EOF
-	description %q{<%= @vars[:description] %>}
-
-	## Remote Exection -- (Optional) -- Enables executing commands on remote machines via SSH
-	# For any command that you would like to enable remote_execution for, you shoud also
-	# put the 'remote_permitted' directive in its declaration.
-	remote_execution permitted: false
-end

data/skeletons/project/config/logging.rb

@@ -1,19 +0,0 @@
-Rbcli::Configurate.me do
-	####
-	# LOGGING
-	###
-	# These parameters set the default logging parameters for your applicaiton. Note that a user
-	# can override these settings by modifying their local configuration.
-	# If either option is set to nil, or they are not provided, logging is disabled.
-	###
-
-	## Log Target -- (Optional) -- Set the target for logs.
-	# Valid values are nil, 'STDOUT', 'STDERR', or a file path (as strings).
-	# Default is disabled (nil).
-	log_target nil
-
-	## Log Level -- (Optional) -- Set the default log_level for users.
-	# Valid values are nil, 0-5, or DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN.
-	# Default is disabled (nil).
-	log_level nil
-end

data/skeletons/project/config/storage.rb

@@ -1,35 +0,0 @@
-###############################
-## State Configuration Block ##
-###############################
-# The state-related componets
-# are configured here.
-###############################
-Rbcli::Configurate.storage do
-	###
-	# Local State Storage -- (Optional)
-	###
-	# Local state storage creates a hash that is automatically saved to a file locally for state persistance.
-	# It is accessible to all commands at:    Rbcli.local_state[:yourkeyhere]
-	#
-	# Note that every update to the top level of this hash will trigger a save, and updating nested hashes will not.
-	# If you need to update nested hashes, you can trigger a save manually by calling `Rbcli.local_state.commit`.
-	# It is accessible to all commands at: Rbcli.local_state[:yourkeyhere]
-	# Please see the documentation for full usage details.
-	###
-
-	#local_state '/var/mytool/localstate', force_creation: true, halt_on_error: true
-
-
-	###
-	# Remote State Storage -- (Optional)
-	###
-	# Remote state storage creates a hash that is automatically saved to a remote database for state persistence.
-	# This state can be made unique to each user, or can be shared across different users of the tool.
-	#
-	# When sharing, locking should be set to `true` to prevent data corruption. Note that RBCli uses lazy-loaded,
-	# meaning the lock will only be acquired when absolutely needed. This behavior can be overridden manually if desired.
-	# For full usage details, see the documentation.
-	###
-
-	#remote_state_dynamodb table_name: 'mytable', region: 'us-east-1', force_creation: true, halt_on_error: true, locking: false
-end

data/skeletons/project/config/userspace.rb

@@ -1,33 +0,0 @@
-Rbcli::Configurate.me do
-	####
-	# USER CONFIGURATION MANAGEMENT
-	###
-	# RBCli allows you to create a configuration file that your users can modify.
-	# Users will be able to generate their own file by running your tool with the `-g` option.
-	# To disable this feature, comment out the `config_userfile` line below.
-	###
-
-	## Config Userfile -- (Optional) -- Set location of user's config file.
-	#
-	#   config_userfile <path>, merge_defaults: <optional: (true|false), default: true>, required: <optional: (true|false, default: false)
-	#
-	# If merge_defaults=true, default settings override user settings.
-	# If false, defaults set here are not loaded at all, and the user is required to set them.
-	# If required=true, application will not run if file does not exist.
-	#
-	# If the path is set to nil, the config file is disabled
-
-	#config_userfile '~/.<%= @vars[:cmdname] %>', merge_defaults: true, required: false
-	config_userfile nil
-
-	## Config Defaults -- (Optional, Multiple) -- Load a YAML file as part of the default config.
-	# This can be called multiple times, and the YAML files will be merged. User config is generated from these files.
-	# RBCli's best practice is to leave this line commented, and instead, place all YAML files in
-	# the `default_user_configs` directory where they are loaded automatically.
-	#config_defaults 'defaults.yml'
-
-	## Config Default -- (Optional, Multiple) -- Specify an individual configuration parameter and set a default value.
-	# These will be included in generated user config.
-
-	config_default :myopt, description: 'Testing this', default: true
-end

data/skeletons/project/config/version.rb

@@ -1,3 +0,0 @@
-module Project
-	VERSION = '0.1.0'
-end

data/skeletons/project/exe/executable

@@ -1,53 +0,0 @@
-#!/usr/bin/env ruby
-
-#########################################################
-### <%= @vars[:cmdname] %>
-#######
-## This is the main executable for <%= @vars[:cmdname] %>.
-## It's job is to load and execute the application.
-##
-## You should not need to edit this file.
-#########################################################
-
-require_relative '../lib/<%= @vars[:cmdname] %>'
-
-#########################
-## Configuration Block ##
-#########################
-# This block is where rbcli is configured.
-# Any options marked as Optional can be commented out.
-# Options marked as Multiple can be declared multiple times.
-#########################
-
-Rbcli::Configurate.me do
-	####
-	# GENERAL
-	###
-	# These parameters are for genreal information about your application.
-	###
-
-	## Script Name -- (Required) -- This line identifies the tool's executable on the command line.
-	# To change it, rename this file to the command you want and this will pick up that name automatically.
-	# You can change it manually if needed, but this should work for most cases.
-	scriptname File.basename(__FILE__)
-
-	## Version Number -- (Required)
-	# Here we reference the same constant that we set for our Gem. If not using Rubygems you can change this to
-	# a version in the standard 'major.minor.patch' format (i.e.: 1.4.0)
-	version Project::VERSION
-end
-
-##################
-## Load Project ##
-##################
-# Here we load the project into Rbcli
-##################
-Rbcli.load_project
-
-#####################
-## Parse Statement ##
-#####################
-# When this statement is called, the CLI will be
-# parsed and code executed.
-#####################
-Rbcli.parse

data/skeletons/project/hooks/default_action.rb

@@ -1,16 +0,0 @@
-Rbcli::Configurate.hooks do
-	####
-	# HOOKS
-	###
-	# Here you can set hooks that will be run at specified points in the execution chain.
-	# Global CLI options are made available to many of the hooks, but command parameters and lineitems are not.
-	###
-
-	## Default Action -- (Optional) -- The default code to execute when no subcommand is given.
-	# If not present, the help is shown (same as -h)
-
-	default_action do |opts|
-		puts "Hello, sir."
-		puts "To see the help, use -h"
-	end
-end

data/skeletons/project/hooks/first_run.rb

@@ -1,16 +0,0 @@
-Rbcli::Configurate.hooks do
-	####
-	# HOOKS
-	###
-	# Here you can set hooks that will be run at specified points in the execution chain.
-	# Global CLI options are made available to many of the hooks, but command parameters and lineitems are not.
-	###
-
-	## First-Run Hook -- (Optional) -- Allows providing a block of code that executes the first time that the application is run on a given system.
-	# If `halt_after_running` is set to `true` then parsing will not continue after this code is executed. All subsequent runs will not execute this code.
-	# This feature is dependent on the Local State Storage system, and will not run without it.
-
-	first_run halt_after_running: false do
-		puts "This is the first time the mytool command is run! Don't forget to generate a config file with the `-g` option before continuing."
-	end
-end

data/skeletons/project/hooks/post_execution.rb

@@ -1,14 +0,0 @@
-Rbcli::Configurate.hooks do
-	####
-	# HOOKS
-	###
-	# Here you can set hooks that will be run at specified points in the execution chain.
-	# Global CLI options are made available to many of the hooks, but command parameters and lineitems are not.
-	###
-
-	## Post-Execution Hook -- (Optional) -- Allows providing a block of code that runs _after_ all commands
-
-	post_hook do |opts|
-		puts 'This is a post-command hook. It executes after the command.'
-	end
-end

data/skeletons/project/hooks/pre_execution.rb

@@ -1,14 +0,0 @@
-Rbcli::Configurate.hooks do
-	####
-	# HOOKS
-	###
-	# Here you can set hooks that will be run at specified points in the execution chain.
-	# Global CLI options are made available to many of the hooks, but command parameters and lineitems are not.
-	###
-
-	## Pre-Execution Hook -- (Optional) -- Allows providing a block of code that runs _before_ all commands
-
-	pre_hook do |opts|
-		puts 'This is a pre-command hook. It executes before the command.'
-	end
-end

data/skeletons/project/lib/lib.erb

@@ -1,9 +0,0 @@
-$projectdir = File.expand_path('..', __dir__)
-$libdir = File.expand_path('.', __dir__)
-
-module <%= @vars[:modulename] %>
-  # This is a stub
-end
-
-require ENV['RBCLI_ENV'] == 'development' ? ENV['RBCLI_DEVPATH'] || 'rbcli' : 'rbcli'
-require "#{$projectdir}/config/version"

data/skeletons/project/spec/spec_helper.rb

@@ -1,14 +0,0 @@
-require 'bundler/setup'
-require 'untitled'
-
-RSpec.configure do |config|
-	# Enable flags like --only-failures and --next-failure
-	config.example_status_persistence_file_path = ".rspec_status"
-
-	# Disable RSpec exposing methods globally on `Module` and `main`
-	config.disable_monkey_patching!
-
-	config.expect_with :rspec do |c|
-		c.syntax = :expect
-	end
-end

data/skeletons/project/spec/untitled_spec.rb

@@ -1,9 +0,0 @@
-RSpec.describe Project do
-	it "has a version number" do
-		expect(Project::VERSION).not_to be nil
-	end
-
-	it "does something useful" do
-		expect(false).to eq(true)
-	end
-end

data/skeletons/project/untitled.gemspec

@@ -1,40 +0,0 @@
-config = File.expand_path('../config', __FILE__)
-$LOAD_PATH.unshift(config) unless $LOAD_PATH.include?(config)
-require 'version.rb'
-
-Gem::Specification.new do |spec|
-	spec.name    = '<%= @vars[:cmdname] %>'
-	spec.version = Project::VERSION
-	spec.authors = ['TODO: Your Name Here']
-	spec.email   = ['TODO: Your Email Here']
-
-	spec.summary     = %q{<%= @vars[:description] %>}
-	spec.description = %q{TODO: Write a longer description or delete this line.}
-	spec.homepage    = "TODO: Put your gem's website or public repo URL here."
-	spec.license     = 'None'
-
-	spec.required_ruby_version = '>= 2.3'
-
-	# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-	# to allow pushing to a single host or delete this section to allow pushing to any host.
-	if spec.respond_to?(:metadata)
-		spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-	else
-		raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
-	end
-
-	# Specify which files should be added to the gem when it is released.
-	# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-	spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-		`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-	end
-	spec.bindir        = 'exe'
-	spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-	spec.require_paths = ['application', 'config', 'default_user_configs', 'hooks', 'lib']
-
-	spec.add_development_dependency 'bundler', '~> 2.2'
-	spec.add_development_dependency 'rake', '~> 13.0'
-	spec.add_development_dependency 'rspec', '~> 3.10'
-
-	spec.add_dependency 'rbcli', '>= <%= @vars[:rbcli_version] %>'
-end

data/skeletons/project/userconf/user_defaults.yml

@@ -1,6 +0,0 @@
----
-# Mytool custom settings
-optionA: value     # We are setting this value just because
-optionB: value2    # Same here
-optionC: value3    # You get the picture
-...