rbcli 0.3.3 → 0.4.0

data/docs-src/themes/hugo-theme-learn/theme.toml

@@ -1,21 +0,0 @@
-# theme.toml template for a Hugo theme
-# See https://github.com/spf13/hugoThemes#themetoml for an example
-
-name = "Learn"
-license = "MIT"
-licenselink = "https://github.com/matcornic/hugo-theme-learn/blob/master/LICENSE.md"
-description = "Documentation theme for Hugo, based on Grav Learn theme"
-homepage = "https://github.com/matcornic/hugo-theme-learn/"
-repo = "https://github.com/matcornic/hugo-theme-learn"
-tags = ["documentation", "grav", "learn", "doc", "search"]
-features = ["documentation", "menu", "nested sections", "search", "mermaid"]
-min_version = 0.25
-
-[author]
-  name = "Mathieu Cornic"
-  homepage = "https://matcornic.github.io/"
-
-[original]
-  name = "Grav Learn"
-  homepage = "https://learn.getgrav.org/"
-  repo = "https://github.com/getgrav/grav-learn"

data/docs-src/themes/hugo-theme-learn/wercker.yml

@@ -1,16 +0,0 @@
-box: golang
-build:
-  steps:
-    # Gets the dependencies
-    - script:
-        name: get hugo
-        code: |
-          git clone https://github.com/gohugoio/hugo.git && cd hugo && go install
-    # Sets the go workspace and places you package
-    # at the right place in the workspace tree
-    - setup-go-workspace
-    # Build the project
-    - script:
-        name: build site
-        code: |
-          cd exampleSite && hugo

data/lib/rbcli/configuration/configurate.rb

@@ -1,85 +0,0 @@
-##################################################################################
-#     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       #
-##################################################################################
-
-#####
-#  Configurate
-###
-# This plugin class allows declaring configuration blocks dynamically
-##
-module Rbcli::Configurate
-	##
-	# If a non-existant method is called, we attempt to load the plugin.
-	# If the plugin fails to load we display a message to the developer
-	##
-	def self.method_missing(method, *args, &block)
-		filename = "#{File.dirname(__FILE__)}/configurate_blocks/#{method.to_s.downcase}.rb"
-		if File.exist? filename
-			require filename
-			self.send method, *args, &block
-		else
-			msg = "Invalid Configurate plugin called: `#{method}` in file #{File.expand_path caller[0]}"
-			Rbcli::log.fatal {msg}
-			raise Exception.new msg
-		end
-	end
-end
-
-module Rbcli::Configurable
-
-	def self.included klass
-		name = klass.name.split('::')[-1]
-
-		# We dynamically add two methods to the module: one that runs other methods dynamially, and one that
-		# displays a reasonable message if a method is missing
-		klass.singleton_class.class_eval do
-			define_method :rbcli_private_running_method do |&block|
-				@self_before_instance_eval = eval 'self', block.binding
-				instance_eval &block
-			end
-
-			define_method :method_missing do |method, *args, &block|
-				msg = "Invalid Configurate.#{self.name.split('::')[-1].downcase} method called: `#{method}` in file #{File.expand_path caller[0]}"
-				Rbcli::log.fatal {msg}
-				raise Exception.new msg
-			end
-		end
-
-		# This will dynamically create the configuate block based on the class name.
-		# For example, if the class name is 'Me', then the resulting block is `Confiugrate.me`
-		Rbcli::Configurate.singleton_class.class_eval do
-			define_method name.downcase.to_sym do |&block|
-				mod = self.const_get name
-				mod.rbcli_private_running_method &block
-			end
-		end
-	end
-
-end
-
-module Rbcli
-	def self.configuration mod, key = nil
-		begin
-			d = Rbcli::Configurate.const_get(mod.to_s.capitalize.to_sym).data
-			(key.nil?) ? d : d[key]
-		rescue
-			nil
-		end
-	end
-end

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

@@ -1,52 +0,0 @@
-##################################################################################
-#     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::Hooks
-	include Rbcli::Configurable
-
-	@data = {
-			default_action: nil,
-			pre_hook: nil,
-			post_hook: nil,
-			first_run: nil,
-			halt_after_first_run: false
-	}
-	def self.data; @data; end
-
-
-	def self.default_action &block
-		@data[:default_action] = block
-	end
-
-	def self.pre_hook &block
-		@data[:pre_hook] = block
-	end
-
-	def self.post_hook &block
-		@data[:post_hook] = block
-	end
-
-	def self.first_run halt_after_running: false, &block
-		@data[:halt_after_first_run] = halt_after_running
-		@data[:first_run] = block
-	end
-
-end

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

@@ -1,122 +0,0 @@
-##################################################################################
-#     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[0], **params[1]
-	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', self.caller
-		@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', self.caller
-		@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', self.caller
-		@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', self.caller
-		@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

@@ -1,50 +0,0 @@
-##################################################################################
-#     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

@@ -1,251 +0,0 @@
-##################################################################################
-#     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::CmdLibrary
-	def self.extended klass
-		klass.instance_variable_set :@commands, {}
-	end
-
-	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 data; self.instance_variable_get :@data; end
-
-	def commands
-		@commands
-	end
-
-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 &block;                   @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, prompt: nil
-		default ||= false if (type == :boolean || type == :bool || type == :flag)
-		@data[:paramlist][name.to_sym] = {
-				description: description,
-				type: type,
-				default: default,
-				required: required,
-				permitted: permitted,
-				short: short,
-				prompt: prompt
-		}
-	end
-
-	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 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
-	##
-
-	##
-	# Run a given command
-	##
-	def self.runcmd cmd, local_params, cliopts
-		args = local_params.delete :args
-		params = local_params
-		global_opts = cliopts
-		config = Rbcli::config
-
-		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
-			#remote_exec @commands[cmd], params, args, global_opts, config
-			return
-		end
-
-		@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
-
-	##
-	# Returns all descriptions for display in CLI help
-	##
-	def self.descriptions indent_size, justification
-		#descmap = @commands.map { |name, klass| [name, klass.description] }.to_h
-		@commands.map do |name, cmdobj|
-			desc = ''
-			if Rbcli.configuration(:me, :remote_execution) and cmdobj.remote_permitted?
-				indent_size -= 3
-				indent_size.times { desc << ' ' }
-				desc << '*  '
-			else
-				indent_size.times { desc << ' ' }
-			end
-			desc << name.ljust(justification)
-			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 self.parseopts *args
-		params = @data[:paramlist]
-		command_name = self.name.split('::')[-1].downcase
-		command_desc = @data[:description]
-		command_usage = @data[:usage]
-		optx = Optimist::options do
-			data = Rbcli.configuration(:me)
-			banner <<-EOS
-#{data[:description]}
-Selected Command:
-      #{command_name.ljust(21)}#{command_desc}
-
-Usage:
-      #{data[:scriptname]} [options] #{command_name} [parameters]
-#{if command_usage then "\n" + command_usage + "\n" end}
-Command-specific Parameters:
-			EOS
-			params.each do |name, opts|
-				opt name, opts[:description], type: opts[:type], default: opts[:default], required: (opts[:prompt].nil? and opts[:required]), permitted: opts[:permitted], short: opts[:short]
-			end if params.is_a? Hash
-		end
-		optx[:args] = ARGV
-		params.each do |name, data|
-			given_symbol = (name.to_s + '_given').to_sym
-			if data[:prompt] and not (optx.key?(given_symbol) and optx[given_symbol])
-				if data[:type] == :bool or data[:type] == :boolean or data[:type] == :flag
-					answer = 'INVALID_STRING'
-					while answer.downcase != 'y' and answer.downcase != 'n' and answer.downcase != ''
-						print 'Invalid entry. '.red unless answer == 'INVALID_STRING'
-						print data[:prompt] + " (#{(data[:default]) ? 'Y/n' : 'y/N'}): "
-						answer = gets.chomp
-						if answer.downcase == 'y'
-							optx[name] = true
-						elsif answer.downcase == 'n'
-							optx[name] = false
-						elsif answer.downcase == ''
-							optx[name] = data[:default]
-						end
-					end
-				elsif data[:type] == :string
-					print data[:prompt]
-					print " (default: \"#{data[:default]}\"): " unless data[:default].nil?
-					answer = gets.chomp
-					answer = data[:default] if answer.empty?
-					optx[name] = answer
-				end
-			end
-		end
-		optx
-	end
-
-	####
-	### DEPRECATED
-	####
-	# Now we automatically pull in the plugins and register them as commands.
-	# Note that filenames must be the same as the class name and are case
-	# sensitive. Only one class per file.
-	##
-	# This is commented out as this functionality is deprecated. Instead we rely on subclassing to
-	# add the commands.
-	###
-	# Dir.glob("#{File.dirname(__FILE__)}/commands/*.rb") do |f|
-	# 	Rbcli::log.debug {"Loading CLI command #{f.split('commands/')[1].split('.')[0]}"}
-	# 	require f
-	# 	klassname = "Rbcli::Command::#{f.match(/.*\/([^\/]+)\.rb$/i)[1].capitalize}"
-	# 	klass = Object.const_get(klassname)
-	# 	klass.send :include, Rbcli::Command
-	# 	self.add_command klassname.split('::')[-1], klass
-	# end
-
-end
-
-
-# module InheritableTraits
-#
-# 	def self.included(base)
-# 		base.extend ClassMethods
-# 	end
-#
-# 	module ClassMethods
-# 		def traits(*attrs)
-# 			@traits ||= []
-# 			@traits += attrs
-# 			attrs.each do |attr|
-# 				class_eval %{
-#           def self.#{attr}(string = nil)
-#             @#{attr} = string || @#{attr}
-#           end
-#           def self.#{attr}=(string = nil)
-#             #{attr}(string)
-#           end
-#         }
-# 			end
-# 			@traits
-# 		end
-#
-# 		def inherited(subclass)
-# 			(["traits"] + traits).each do |t|
-# 				ivar = "@#{t}"
-# 				subclass.instance_variable_set(
-# 						ivar,
-# 						instance_variable_get(ivar)
-# 				)
-# 			end
-# 		end
-# 	end
-#
-# end

data/lib/rbcli/engine/load_project.rb

@@ -1,45 +0,0 @@
-##################################################################################
-#     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
-	def self.load_project
-		project_root = File.expand_path("#{File.dirname(caller[0].split(':')[0])}/../")
-
-		# Add lib to the load path for the user's convenience
-		lib = "#{project_root}/lib"
-		$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-		# We require all ruby files as-is
-		%w(config hooks application application/commands).each do |dir|
-			dirpath = "#{project_root}/#{dir}"
-			Dir.glob "#{dirpath}/*.rb" do |file|
-				require file
-			end if Dir.exist? dirpath
-		end
-
-		# We automatically pull in default user configs
-		configspath = "#{project_root}/userconf"
-		Dir.glob "#{configspath}/*.{yml,yaml,json}" do |file|
-			Rbcli::Configurate.me {config_defaults file}
-		end
-
-	end
-end