rbcli 0.2.1 → 0.2.2

data/lib/rbcli/configuration/configurate_blocks/me.rb

@@ -0,0 +1,122 @@
+##################################################################################
+#     RBCli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2018 Andrew Khoury                                           #
+#                                                                                #
+#     This program is free software: you can redistribute it and/or modify       #
+#     it under the terms of the GNU General Public License as published by       #
+#     the Free Software Foundation, either version 3 of the License, or          #
+#     (at your option) any later version.                                        #
+#                                                                                #
+#     This program is distributed in the hope that it will be useful,            #
+#     but WITHOUT ANY WARRANTY; without even the implied warranty of             #
+#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              #
+#     GNU General Public License for more details.                               #
+#                                                                                #
+#     You should have received a copy of the GNU General Public License          #
+#     along with this program.  If not, see <https://www.gnu.org/licenses/>.     #
+#                                                                                #
+#     For questions regarding licensing, please contact andrew@blacknex.us       #
+##################################################################################
+
+
+module Rbcli::Configurate::Me
+	include Rbcli::Configurable
+
+	@data = {
+			scriptname: nil,
+			version: nil,
+			description: nil,
+			config_userfile: nil,
+			options: {},
+			remote_execution: false,
+			autoupdater: nil
+	}
+	def self.data; @data; end
+
+	def self.scriptname name
+		@data[:scriptname] = name
+	end
+
+	def self.version vsn
+		@data[:version] = vsn
+	end
+
+	def self.description desc
+		@data[:description] = desc
+	end
+
+	def self.log_level level
+		Rbcli::Logger::save_defaults level: level
+	end
+
+	def self.log_target target
+		Rbcli::Logger::save_defaults target: target
+	end
+
+	def self.config_userfile *params
+		Rbcli::Config::set_userfile *params
+		@data[:config_userfile] = params[0]
+	end
+
+	def self.config_defaults filename
+		Rbcli::Config::add_defaults filename
+	end
+
+	def self.config_default *params
+		Rbcli::Config::add_default *params
+	end
+
+	def self.option name, description, short: nil, type: :boolean, default: nil, required: false, permitted: nil
+		default ||= false if (type == :boolean || type == :bool || type == :flag)
+		@data[:options][name.to_sym] = {
+				description: description,
+				type: type,
+				default: default,
+				required: required,
+				permitted: permitted,
+				short: short
+		}
+	end
+
+	def self.default_action &block
+		Rbcli::DeprecationWarning.new 'Rbcli::Configurate.me--default_action', 'Please use `RBCli::Configurate.hooks` as the parent block instead.', '0.3.0'
+		@data[:default_action] = block
+	end
+
+	def self.pre_hook &block
+		Rbcli::DeprecationWarning.new 'Rbcli::Configurate.me--pre_hook', 'Please use `RBCli::Configurate.hooks` as the parent block instead.', '0.3.0'
+		@data[:pre_hook] = block
+	end
+
+	def self.post_hook &block
+		Rbcli::DeprecationWarning.new 'Rbcli::Configurate.me--post_hook', 'Please use `RBCli::Configurate.hooks` as the parent block instead.', '0.3.0'
+		@data[:post_hook] = block
+	end
+
+	def self.first_run halt_after_running: false, &block
+		Rbcli::DeprecationWarning.new 'Rbcli::Configurate.me--first_run', 'Please use `RBCli::Configurate.hooks` as the parent block instead.', '0.3.0'
+		@data[:halt_after_first_run] = halt_after_running
+		@data[:first_run] = block
+	end
+
+	def self.remote_execution permitted: true
+		require 'rbcli/features/remote_exec' if permitted
+		@data[:remote_execution] = permitted
+	end
+
+	def self.autoupdate gem: nil, github_repo: nil, access_token: nil, enterprise_hostname: nil, force_update: false, message: nil
+		raise StandardError.new "Autoupdater can not have both a gem and git target defined. Please pick one." if gem and github_repo
+		raise StandardError.new "Only one autoupdater can be defined." if @data[:autoupdater]
+		if gem
+			require 'rbcli/features/autoupdate/gem_updater'
+			#Rbcli::Autoupdate::GemUpdater.save_defaults
+			@data[:autoupdater] = Rbcli::Autoupdate::GemUpdater.new gem, force_update, message
+		else
+			require 'rbcli/features/autoupdate/github_updater'
+			Rbcli::Autoupdate::GithubUpdater.save_defaults
+			@data[:autoupdater] = Rbcli::Autoupdate::GithubUpdater.new github_repo, access_token, enterprise_hostname, force_update, message
+		end
+		@data[:autoupdater].show_message if @data[:autoupdater].update_available?
+	end
+
+end

data/lib/rbcli/configuration/configurate_blocks/storage.rb

@@ -0,0 +1,50 @@
+##################################################################################
+#     RBCli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2018 Andrew Khoury                                           #
+#                                                                                #
+#     This program is free software: you can redistribute it and/or modify       #
+#     it under the terms of the GNU General Public License as published by       #
+#     the Free Software Foundation, either version 3 of the License, or          #
+#     (at your option) any later version.                                        #
+#                                                                                #
+#     This program is distributed in the hope that it will be useful,            #
+#     but WITHOUT ANY WARRANTY; without even the implied warranty of             #
+#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              #
+#     GNU General Public License for more details.                               #
+#                                                                                #
+#     You should have received a copy of the GNU General Public License          #
+#     along with this program.  If not, see <https://www.gnu.org/licenses/>.     #
+#                                                                                #
+#     For questions regarding licensing, please contact andrew@blacknex.us       #
+##################################################################################
+
+module Rbcli::Configurate::Storage
+	include Rbcli::Configurable
+
+	@data = {
+			localstate: nil,
+			remotestate: nil,
+			remotestate_init_params: nil
+	}
+
+	def self.data; @data; end
+
+	def self.local_state path, force_creation: false, halt_on_error: false
+		require 'rbcli/state_storage/localstate'
+
+		@data[:localstate] = Rbcli::State::LocalStorage.new(path, force_creation: force_creation, halt_on_error: halt_on_error)
+	end
+
+	def self.remote_state_dynamodb table_name: nil, region: nil, force_creation: false, halt_on_error: true, locking: false
+		raise StandardError "Must decalre `table_name` and `region` to use remote_state_dynamodb" if table_name.nil? or region.nil?
+
+		require 'rbcli/state_storage/remotestate_dynamodb'
+
+		@data[:remotestate_init_params] = {
+				dynamodb_table: table_name,
+				region: region,
+				locking: locking
+		}
+		@data[:remotestate] = Rbcli::State::DynamoDBStorage.new(table_name, force_creation: force_creation, halt_on_error: halt_on_error)
+	end
+end

data/lib/rbcli/engine/command.rb

@@ -19,41 +19,52 @@
 ##################################################################################
 
 
-class Rbcli::Command
-
-	#include InheritableTraits
-	#traits :description
-
-	@commands = {}
+module Rbcli::CmdLibrary
+	def self.extended klass
+		klass.instance_variable_set :@commands, {}
+	end
 
-	def self.inherited subklass
+	def inherited subklass
+		subklass.instance_variable_set :@data, {
+				description: nil,
+				usage: nil,
+				action: nil,
+				paramlist: {},
+				remote_permitted: false
+		}
 		@commands[subklass.name.downcase] = subklass.new
 	end
 
-	def self.add_command name, klass
-		@commands[name.downcase] = klass.new
-	end
+	def data; self.instance_variable_get :@data; end
 
-	def self.commands
+	def commands
 		@commands
 	end
 
-	##
-	# Interface Functions
-	##
-	def self.description desc;     @desc = desc end
-	def      description;          self.class.instance_variable_get :@desc end
+end
 
-	def self.usage usage;          @usage = usage end
-	def      usage;                self.class.instance_variable_get :@usage end
 
-	def self.action █        @action = block end
-	def      action;               self.class.instance_variable_get :@action end
+class Rbcli::Command
+
+	#include InheritableTraits
+	#traits :description
+	extend Rbcli::CmdLibrary
 
+	def data; self.class.data; end
+
+	##
+	# Interface Functions
+	##
+	def self.description desc;                @data[:description] = desc; end
+	def self.usage usage;                     @data[:usage] = usage; end
+	def self.action █                   @data[:action] = block; end
+	def self.remote_permitted;                @data[:remote_permitted] = true; end
+	def self.remote_permitted?;               @data[:remote_permitted]; end
+	def self.config_defaults filename;        Rbcli::Config::add_defaults(filename); end
+	def self.config_default *params;          Rbcli::Config::add_default *params; end
 	def self.parameter name, description, short: nil, type: :boolean, default: nil, required: false, permitted: nil
 		default ||= false if (type == :boolean || type == :bool || type == :flag)
-		@paramlist ||= {}
-		@paramlist[name.to_sym] = {
+		@data[:paramlist][name.to_sym] = {
 				description: description,
 				type: type,
 				default: default,
@@ -62,24 +73,25 @@ class Rbcli::Command
 				short: short
 		}
 	end
-	def      paramlist;               self.class.instance_variable_get :@paramlist end
-
-	def self.config_defaults filename
-		Rbcli::Config::add_defaults filename
-	end
-
-	def self.config_default *params
-		Rbcli::Config::add_default *params
-	end
 
-	def self.remote_permitted
-		@remote_permitted = true
+	def self.extern path: nil, envvars: nil, &block
+		if path == :default
+			callerscript = caller_locations.first.absolute_path
+			path = "#{File.dirname(callerscript)}/scripts/#{File.basename(callerscript, ".*")}.sh"
+		end
+		block = nil unless block_given?
+		require 'rbcli/features/scriptwrapper'
+		@data[:extern] = Rbcli::Scriptwrapper.new path, envvars, block
 	end
 
-	def remote_permitted?
-		self.class.instance_variable_get :@remote_permitted
+	def self.script path: nil, envvars: nil
+		if path == :default or path.nil?
+			callerscript = caller_locations.first.absolute_path
+			path = "#{File.dirname(callerscript)}/scripts/#{File.basename(callerscript, ".*")}.sh"
+		end
+		require 'rbcli/features/scriptwrapper'
+		@data[:script] = Rbcli::Scriptwrapper.new path, envvars, nil, true
 	end
-
 	##
 	# END Interface Functions
 	##
@@ -93,7 +105,7 @@ class Rbcli::Command
 		global_opts = cliopts
 		config = Rbcli::config
 
-		raise Exception.new("Command #{cmd} can only have one of `action`, `script`, or `extern` defined.") if (@commands[cmd].extern or @commands[cmd].script) and @commands[cmd].action
+		raise Exception.new("Command #{cmd} can only have one of `action`, `script`, or `extern` defined.") if (@commands[cmd].data[:extern] or @commands[cmd].data[:script]) and @commands[cmd].data[:action]
 
 		if cliopts[:remote_exec]
 			Rbcli::RemoteExec.new(@commands[cmd], cliopts[:remote_exec], cliopts[:identity], params, args, global_opts, config).run
@@ -101,9 +113,9 @@ class Rbcli::Command
 			return
 		end
 
-		@commands[cmd].extern.execute params, args, global_opts, config unless @commands[cmd].extern.nil?
-		@commands[cmd].script.execute params, args, global_opts, config unless @commands[cmd].script.nil?
-		@commands[cmd].action.call params, args, global_opts, config unless @commands[cmd].action.nil?
+		@commands[cmd].data[:extern].execute params, args, global_opts, config unless @commands[cmd].data[:extern].nil?
+		@commands[cmd].data[:script].execute params, args, global_opts, config unless @commands[cmd].data[:script].nil?
+		@commands[cmd].data[:action].call params, args, global_opts, config unless @commands[cmd].data[:action].nil?
 	end
 
 	##
@@ -113,7 +125,7 @@ class Rbcli::Command
 		#descmap = @commands.map { |name, klass| [name, klass.description] }.to_h
 		@commands.map do |name, cmdobj|
 			desc = ''
-			if Rbcli.configuration[:remote_execution] and cmdobj.remote_permitted?
+			if Rbcli.configuration(:me, :remote_execution) and cmdobj.remote_permitted?
 				indent_size -= 3
 				indent_size.times { desc << ' ' }
 				desc << '*  '
@@ -121,20 +133,20 @@ class Rbcli::Command
 				indent_size.times { desc << ' ' }
 			end
 			desc << name.ljust(justification)
-			desc << cmdobj.description
+			desc << cmdobj.class.data[:description]
 		end.join("\n")
 	end
 
 	##
 	# This method reads the parameters provided by the class and parses them from the CLI
 	##
-	def parseopts *args
-		params = paramlist
+	def self.parseopts *args
+		params = @data[:paramlist]
 		command_name = self.class.name.split('::')[-1].downcase
-		command_desc = description
-		command_usage = usage
+		command_desc = @data[:description]
+		command_usage = @data[:usage]
 		optx = Trollop::options do
-			data = Rbcli.configuration
+			data = Rbcli.configuration(:me)
 			banner <<-EOS
 #{data[:description]}
 Selected Command:
@@ -153,19 +165,6 @@ Command-specific Parameters:
 		optx
 	end
 
-	##
-	# Inject metadata into response
-	##
-	# def self.wrap_metadata resp
-	# 	{
-	# 			meta: {
-	# 					status: 'ok',
-	# 					timestamp: (Time.now.to_f * 1000).floor
-	# 			},
-	# 			response: resp
-	# 	}.deep_stringify!
-	# end
-
 	####
 	### DEPRECATED
 	####

data/lib/rbcli/engine/parser.rb

@@ -20,15 +20,18 @@
 
 
 #TODO: Change this once the changes have been merged into trollop gem proper
-require "rbcli/util/trollop"
+require 'rbcli/util/trollop'
 
 module Rbcli::Parser
 
 	@cliopts = nil
 
 	def self.parse
+		# We show deprecation warnings before anything else, encouraging the developer to update their code.
+		Rbcli::DeprecationWarning.display_warnings
+
 		@cliopts = Trollop::options do
-			data = Rbcli.configuration
+			data = Rbcli.configuration(:me)
 			version "#{data[:scriptname]} version: #{data[:version]}"
 			banner <<-EOS
 #{data[:description]}
@@ -63,21 +66,24 @@ Commands:
 			Rbcli::Config::generate_userconf @cliopts[:config_file]
 			puts "User config generated at #{@cliopts[:config_file]} using default values."
 		elsif @cmd[0].nil?
-			if Rbcli.configuration[:default_action].nil?
+			default_action = Rbcli.configuration(:me, :default_action) || Rbcli.configuration(:hooks, :default_action)
+			if default_action.nil?
 				Trollop::educate
 			else
-				Rbcli.configuration[:default_action].call @cliopts
+				default_action.call @cliopts
 			end
 		elsif Rbcli::Command.commands.key? @cmd[0]
-			@cmd << Rbcli::Command.commands[@cmd[0]].parseopts
+			@cmd << Rbcli::Command.commands[@cmd[0]].class.parseopts
 
 			if (@cliopts[:remote_exec_given] and not @cliopts[:identity_given]) or (not @cliopts[:remote_exec_given] and @cliopts[:identity_given])
 				Trollop::die 'Must use `--remote-exec` and `--identity` together.'
 			end
 
-			Rbcli.configuration[:pre_hook].call @cliopts unless Rbcli.configuration[:pre_hook].nil?
+			Rbcli.configuration(:me, :pre_hook).call @cliopts unless Rbcli.configuration(:me, :pre_hook).nil?
+			Rbcli.configuration(:hooks, :pre_hook).call @cliopts unless Rbcli.configuration(:hooks, :pre_hook).nil?
 			Rbcli::Command.runcmd(@cmd.shift, @cmd[0], @cliopts)
-			Rbcli.configuration[:post_hook].call @cliopts unless Rbcli.configuration[:post_hook].nil?
+			Rbcli.configuration(:me, :post_hook).call @cliopts unless Rbcli.configuration(:me, :post_hook).nil?
+			Rbcli.configuration(:hooks, :post_hook).call @cliopts unless Rbcli.configuration(:hooks, :post_hook).nil?
 		else
 			Trollop::die "Unknown subcommand #{@cmd[0].inspect}"
 		end
@@ -88,14 +94,15 @@ end
 
 module Rbcli
 	def self.parse
-		if Rbcli.configuration[:first_run]
+		first_run_hook = Rbcli.configuration(:me, :first_run) || Rbcli.configuration(:hooks, :first_run)
+		if first_run_hook
 			if Rbcli.local_state
 				if Rbcli.local_state.rbclidata.key? :first_run
 					Rbcli::Parser::parse
 				else
-					Rbcli.configuration[:first_run].call
+					first_run_hook.call
 					Rbcli.local_state.set_rbclidata :first_run, true
-					Rbcli::Parser::parse unless Rbcli.configuration[:halt_after_first_run]
+					Rbcli::Parser::parse unless Rbcli.configuration(:me, :halt_after_first_run) or Rbcli.configuration(:hooks, :halt_after_first_run)
 				end
 			else
 				raise StandardError.new "Error: Can not use `first_run` without also configuring `local_state`."

data/lib/rbcli/{autoupdate → features/autoupdate/common}/autoupdate.rb

@@ -18,21 +18,6 @@
 #     For questions regarding licensing, please contact andrew@blacknex.us       #
 ##################################################################################
 
-module Rbcli::Configurate
-	def self.autoupdate gem: nil, github_repo: nil, access_token: nil, enterprise_hostname: nil, force_update: false, message: nil
-		raise StandardError.new "Autoupdater can not have both a gem and git target defined. Please pick one." if gem and github_repo
-		raise StandardError.new "Only one autoupdater can be defined." if @data[:autoupdater]
-		if gem
-			#Rbcli::Autoupdate::GemUpdater.save_defaults
-			@data[:autoupdater] = Rbcli::Autoupdate::GemUpdater.new gem, force_update, message
-		else
-			Rbcli::Autoupdate::GithubUpdater.save_defaults
-			@data[:autoupdater] = Rbcli::Autoupdate::GithubUpdater.new github_repo, access_token, enterprise_hostname, force_update, message
-		end
-		@data[:autoupdater].show_message if @data[:autoupdater].update_available?
-	end
-end
-
 
 require 'rubygems'
 module Rbcli::Autoupdate
@@ -47,11 +32,11 @@ module Rbcli::Autoupdate
 
 		def update_available?
 			@latest_version = get_latest_version
-			Gem::Version.new(@latest_version) > Gem::Version.new(Rbcli.configuration[:version])
+			Gem::Version.new(@latest_version) > Gem::Version.new(Rbcli.configuration(:me, :version))
 		end
 
 		def show_message
-			puts "WARNING: An update is available to #{Rbcli::Configurate::configuration[:scriptname]}. You are currently running version #{Rbcli.configuration[:version]}; the latest is #{@latest_version || get_latest_version}."
+			puts "WARNING: An update is available to #{Rbcli.configuration(:me, :scriptname)}. You are currently running version #{Rbcli.configuration(:me, :version)}; the latest is #{@latest_version || get_latest_version}."
 			puts @message || update_message
 			puts "\n"
 			if @force_update
@@ -61,6 +46,3 @@ module Rbcli::Autoupdate
 		end
 	end
 end
-
-require "rbcli/autoupdate/gem_updater"
-require "rbcli/autoupdate/github_updater"