rbcli 0.2.1 → 0.2.2

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

@@ -18,6 +18,7 @@
 #     For questions regarding licensing, please contact andrew@blacknex.us       #
 ##################################################################################
 
+require 'rbcli/features/autoupdate/common/autoupdate'
 require 'net/http'
 require 'json'
 

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

@@ -18,6 +18,7 @@
 #     For questions regarding licensing, please contact andrew@blacknex.us       #
 ##################################################################################
 
+require 'rbcli/features/autoupdate/common/autoupdate'
 require 'octokit'
 
 module Rbcli::Autoupdate

data/lib/rbcli/{logging → features}/logging.rb

@@ -42,7 +42,7 @@ require 'colorize'
 module Rbcli::Logger
 
 	@default_level = 'info'
-	@default_target = 'stderr'
+	@default_target = nil
 
 	def self.save_defaults level: nil, target: nil
 		@default_level = level if level
@@ -61,27 +61,28 @@ module Rbcli::Logger
 	end
 	self.save_defaults
 
+	def self.make_logger
+		if Rbcli::config[:logger][:log_target].nil?
+			target = '/dev/null'
+		elsif Rbcli::config[:logger][:log_target].downcase == 'stdout'
+			target = STDOUT
+		elsif Rbcli::config[:logger][:log_target].downcase == 'stderr'
+			target = STDERR
+		else
+			target = Rbcli::config[:logger][:log_target]
+		end
+		@logger = Logger.new(target)
+		@logger.level = Rbcli::config[:logger][:log_level]
 
-	if Rbcli::config[:logger][:log_target].downcase == 'stdout'
-		target = STDOUT
-	elsif Rbcli::config[:logger][:log_target].downcase == 'stderr'
-		target = STDERR
-	elsif Rbcli::config[:logger][:log_target].nil?
-		target = '/dev/null'
-	else
-		target = Rbcli::config[:logger][:log_target]
-	end
-	target = '/dev/null' if Rbcli::config[:logger][:log_level].nil?
-	@logger = Logger.new(target)
-	@logger.level = Rbcli::config[:logger][:log_level]
-
-	original_formatter = Logger::Formatter.new
-	@logger.formatter = proc do |severity, datetime, progname, msg|
-		original_formatter.call(severity, datetime, progname || caller_locations[3].path.split('/')[-1], msg.dump)
+		original_formatter = Logger::Formatter.new
+		@logger.formatter = proc do |severity, datetime, progname, msg|
+			original_formatter.call(severity, datetime, progname || caller_locations[3].path.split('/')[-1], msg.dump)
+		end
+		@logger
 	end
 
 	def self.log
-		@logger
+		@logger || self.make_logger
 	end
 
 end

data/lib/rbcli/{scriptwrapping → features}/scriptwrapper.rb

@@ -18,35 +18,6 @@
 #     For questions regarding licensing, please contact andrew@blacknex.us       #
 ##################################################################################
 
-class Rbcli::Command
-	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?
-		@extern = Rbcli::Scriptwrapper.new path, envvars, block
-	end
-
-	def extern
-		@extern ||= nil
-		self.class.instance_variable_get :@extern
-	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
-		@script = Rbcli::Scriptwrapper.new path, envvars, nil, true
-	end
-
-	def script
-		@script ||= nil
-		self.class.instance_variable_get :@script
-	end
-end
-
 require 'json'
 class Rbcli::Scriptwrapper
 	def initialize path, envvars = nil, block = nil, script = false

data/lib/rbcli/{stateful_systems/storagetypes → state_storage}/localstate.rb

@@ -18,22 +18,14 @@
 #     For questions regarding licensing, please contact andrew@blacknex.us       #
 ##################################################################################
 
+require 'rbcli/state_storage/common/state_storage'
 require 'fileutils'
 require 'json'
 
-## Configuration Interface
-module Rbcli::ConfigurateStorage
-	@data[:localstate] = nil
-
-	def self.local_state path, force_creation: false, halt_on_error: false
-		@data[:localstate] = Rbcli::State::LocalStorage.new(path, force_creation: force_creation, halt_on_error: halt_on_error)
-	end
-end
-
 ## User Interface
 module Rbcli
 	def self.local_state
-		Rbcli::ConfigurateStorage.data[:localstate]
+		Rbcli.configuration(:storage, :localstate)
 	end
 end
 

data/lib/rbcli/{stateful_systems/storagetypes → state_storage}/remotestate_dynamodb.rb

@@ -18,21 +18,7 @@
 #     For questions regarding licensing, please contact andrew@blacknex.us       #
 ##################################################################################
 
-## Configuration Interface
-module Rbcli::ConfigurateStorage
-	@data[:remotestate] = nil
-	@data[:remotestate_init_params] = nil
-
-	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?
-		@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
+require 'rbcli/state_storage/common/state_storage'
 
 ## User Interface
 module Rbcli
@@ -58,15 +44,15 @@ module Rbcli::State
 		# end
 
 		def state_subsystem_init
-			@locking = Rbcli::ConfigurateStorage::data[:remotestate_init_params][:locking]
-			dynamodb_table = Rbcli::ConfigurateStorage::data[:remotestate_init_params][:dynamodb_table]
-			region = Rbcli::ConfigurateStorage::data[:remotestate_init_params][:region]
+			@locking = Rbcli.configuration(:storage, :remotestate_init_params)[:locking]
+			dynamodb_table = Rbcli.configuration(:storage, :remotestate_init_params)[:dynamodb_table]
+			region = Rbcli.configuration(:storage, :remotestate_init_params)[:region]
 
 			# Set defaults in Rbcli's config
 			Rbcli::State::RemoteConnectors::DynamoDB.save_defaults
 
 			# Create DynamoDB Connector
-			@dynamodb = Rbcli::State::RemoteConnectors::DynamoDB.new dynamodb_table, region, Rbcli::config[:aws_access_key_id], Rbcli::config[:aws_secret_access_key], locking: Rbcli::ConfigurateStorage::data[:remotestate_init_params][:locking]
+			@dynamodb = Rbcli::State::RemoteConnectors::DynamoDB.new dynamodb_table, region, Rbcli::config[:aws_access_key_id], Rbcli::config[:aws_secret_access_key], locking: Rbcli.configuration(:storage, :remotestate_init_params)[:locking]
 		end
 
 		def state_exists?
@@ -126,4 +112,4 @@ module Rbcli::State
 end
 
 
-require 'rbcli/stateful_systems/storagetypes/remote_state_connectors/dynamodb'
+require 'rbcli/state_storage/remote_state_connectors/dynamodb'

data/lib/rbcli/util/deprecation_warning.rb

@@ -0,0 +1,43 @@
+##################################################################################
+#     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       #
+##################################################################################
+
+
+class Rbcli::DeprecationWarning
+
+	@@warnings = []
+
+	def initialize original_feature_name, message_text, change_by_version
+		#@caller = caller_locations(2,1)[0].label
+		@original_feature_name = original_feature_name
+		@message_text = message_text
+		@change_by_version = change_by_version
+		@@warnings.append self
+	end
+
+	def display
+		message = "DEPRECATION WRNING: The feature `#{@original_feature_name}` has been deprecated. #{@message_text} This feature will be removed in version #{@change_by_version}."
+		Rbcli::log.warn { message }
+		puts message.red
+	end
+
+	def self.display_warnings
+		@@warnings.each { |w| w.display }
+	end
+end

data/lib/rbcli/version.rb

@@ -19,5 +19,5 @@
 ##################################################################################
 
 module Rbcli
-	VERSION = "0.2.1"
+	VERSION = "0.2.2"
 end

data/rbcli.gemspec

@@ -20,7 +20,7 @@
 
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "rbcli/version"
+require 'rbcli/version'
 
 Gem::Specification.new do |spec|
 	spec.name          = 'rbcli'

data/skeletons/micro/executable

@@ -49,8 +49,12 @@ Rbcli::Configurate.me do
 
 	## Option -- (Optional, Multiple) -- Add a global CLI Option
 	option :name, 'Give me your name', type: :string, default: 'Foo', required: false, permitted: ['Jack', 'Jill']
+end
 
-
+###############################
+## Hooks Configuration Block ##
+###############################
+Rbcli::Configurate.hooks do
 	## Default Action -- (Optional) -- The default code to execute when no subcommand is given.
 	default_action do |opts|
 		puts "Hello, #{opts[:name]}."

data/skeletons/mini/executable

@@ -131,15 +131,15 @@ Rbcli::Configurate.me do
 
 	## Option -- (Optional, Multiple) -- Add a global CLI Option
 	option :name, 'Give me your name', type: :string, default: 'Foo', required: false, permitted: ['Jack', 'Jill']
+end
 
-
-	####
-	# 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.
-	###
-
+###############################
+## Hooks Configuration Block ##
+###############################
+# 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.
+###############################
+Rbcli::Configurate.hooks do
 	## 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|

data/skeletons/project/Rakefile

@@ -1,5 +1,5 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/skeletons/project/hooks/default_action.rb

@@ -1,4 +1,4 @@
-Rbcli::Configurate.me do
+Rbcli::Configurate.hooks do
 	####
 	# HOOKS
 	###

data/skeletons/project/hooks/first_run.rb

@@ -1,4 +1,4 @@
-Rbcli::Configurate.me do
+Rbcli::Configurate.hooks do
 	####
 	# HOOKS
 	###

data/skeletons/project/hooks/post_execution.rb

@@ -1,4 +1,4 @@
-Rbcli::Configurate.me do
+Rbcli::Configurate.hooks do
 	####
 	# HOOKS
 	###

data/skeletons/project/hooks/pre_execution.rb

@@ -1,4 +1,4 @@
-Rbcli::Configurate.me do
+Rbcli::Configurate.hooks do
 	####
 	# HOOKS
 	###

data/skeletons/project/spec/spec_helper.rb

@@ -1,5 +1,5 @@
-require "bundler/setup"
-require "untitled"
+require 'bundler/setup'
+require 'untitled'
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbcli
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Andrew Khoury
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-08 00:00:00.000000000 Z
+date: 2018-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -284,22 +284,25 @@ files:
 - lib/rbcli-tool/project.rb
 - lib/rbcli-tool/util.rb
 - lib/rbcli.rb
-- lib/rbcli/autoupdate/autoupdate.rb
-- lib/rbcli/autoupdate/gem_updater.rb
-- lib/rbcli/autoupdate/github_updater.rb
-- lib/rbcli/configuration/config.rb
 - lib/rbcli/configuration/configurate.rb
+- lib/rbcli/configuration/configurate_blocks/hooks.rb
+- lib/rbcli/configuration/configurate_blocks/me.rb
+- lib/rbcli/configuration/configurate_blocks/storage.rb
 - lib/rbcli/engine/command.rb
 - lib/rbcli/engine/load_project.rb
 - lib/rbcli/engine/parser.rb
-- lib/rbcli/logging/logging.rb
-- lib/rbcli/remote_exec/remote_exec.rb
-- lib/rbcli/scriptwrapping/scriptwrapper.rb
-- lib/rbcli/stateful_systems/configuratestorage.rb
-- lib/rbcli/stateful_systems/state_storage.rb
-- lib/rbcli/stateful_systems/storagetypes/localstate.rb
-- lib/rbcli/stateful_systems/storagetypes/remote_state_connectors/dynamodb.rb
-- lib/rbcli/stateful_systems/storagetypes/remotestate_dynamodb.rb
+- lib/rbcli/features/autoupdate/common/autoupdate.rb
+- lib/rbcli/features/autoupdate/gem_updater.rb
+- lib/rbcli/features/autoupdate/github_updater.rb
+- lib/rbcli/features/logging.rb
+- lib/rbcli/features/remote_exec.rb
+- lib/rbcli/features/scriptwrapper.rb
+- lib/rbcli/features/userconfig.rb
+- lib/rbcli/state_storage/common/state_storage.rb
+- lib/rbcli/state_storage/localstate.rb
+- lib/rbcli/state_storage/remote_state_connectors/dynamodb.rb
+- lib/rbcli/state_storage/remotestate_dynamodb.rb
+- lib/rbcli/util/deprecation_warning.rb
 - lib/rbcli/util/hash_deep_symbolize.rb
 - lib/rbcli/util/string_colorize.rb
 - lib/rbcli/util/trollop.rb