rbcli 0.2.10 → 0.3.1

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

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

@@ -0,0 +1,16 @@
+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/exe/rbcli

@@ -89,6 +89,7 @@ EOF
 		# Prepare template vars
 		template_vars = {
 				cmdname: params[:name],
+				modulename: params[:name].split('-').each(&:capitalize!).join,
 				description: params[:description],
 				rbcli_version: Rbcli::VERSION
 		}

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

@@ -63,7 +63,7 @@ module Rbcli::Configurate::Me
 	end
 
 	def self.config_default *params
-		Rbcli::Config::add_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
@@ -79,22 +79,22 @@ module Rbcli::Configurate::Me
 	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'
+		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'
+		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'
+		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'
+		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

data/lib/rbcli/engine/command.rb

@@ -143,7 +143,7 @@ class Rbcli::Command
 	##
 	def self.parseopts *args
 		params = @data[:paramlist]
-		command_name = self.class.name.split('::')[-1].downcase
+		command_name = self.name.split('::')[-1].downcase
 		command_desc = @data[:description]
 		command_usage = @data[:usage]
 		optx = Trollop::options do
@@ -181,7 +181,8 @@ Command-specific Parameters:
 						end
 					end
 				elsif data[:type] == :string
-					print data[:prompt] + " (default: \"#{data[:default]}\"): "
+					print data[:prompt]
+					print " (default: \"#{data[:default]}\"): " unless data[:default].nil?
 					answer = gets.chomp
 					answer = data[:default] if answer.empty?
 					optx[name] = answer

data/lib/rbcli/util/deprecation_warning.rb

@@ -22,22 +22,39 @@
 class Rbcli::DeprecationWarning
 
 	@@warnings = []
+	@@errors_exist = false
 
-	def initialize original_feature_name, message_text, change_by_version
+	def initialize original_feature_name, message_text, change_by_version, caller
 		#@caller = caller_locations(2,1)[0].label
 		@original_feature_name = original_feature_name
 		@message_text = message_text
 		@change_by_version = change_by_version
+		@caller = caller
 		@@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
+		deprecated_version_parts = @change_by_version.split('.').map { |i| i.to_i }
+		current_version_parts = Rbcli::VERSION.split('.').map { |i| i.to_i }
+
+		if deprecated_version_parts[0] > current_version_parts[0] or
+				deprecated_version_parts[1] > current_version_parts[1] or
+				deprecated_version_parts[2] >= current_version_parts[2]
+
+			message = "DEPRECATION ERROR: The feature `#{@original_feature_name}` has been deprecated as of Rbcli version #{@change_by_version}. #{@message_text} Please update the relevant code to continue using Rbcli."
+			Rbcli::log.error { message }
+			puts message.red
+			@@errors_exist = true
+		else
+			message = "DEPRECATION WARNING: 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.yellow
+		end
+		puts @caller[0], ""
 	end
 
 	def self.display_warnings
 		@@warnings.each { |w| w.display }
+		exit(1) if @@errors_exist
 	end
 end

data/lib/rbcli/util/msg.rb

@@ -38,7 +38,6 @@ module Rbcli::Msg
 		tcol = (result or msg_fail.nil?) ? success_color : fail_color
 		Rbcli::Msg.puts tmsg, log: log, color: tcol
 		Rbcli::Msg.fatal fatality_msg, log: log if fatality_msg
-
 	end
 
 	def self.yesno question, default_to_yes: false

data/lib/rbcli/version.rb

@@ -19,5 +19,5 @@
 ##################################################################################
 
 module Rbcli
-	VERSION = '0.2.10'
+	VERSION = '0.3.1'
 end

data/lib/rbcli-tool/project.rb

@@ -38,7 +38,7 @@ module RBCliTool
 			FileUtils.mkdir_p @dest
 
 			# Create project structure
-			%w(
+			%W(
 				application/commands
 				application/commands/scripts
 				config
@@ -46,7 +46,7 @@ module RBCliTool
 				exe
 				hooks
 				spec
-				lib
+				lib/#{@template_vars[:cmdname]}
 			).each do |folder|
 				FileUtils.mkdir_p "#{@dest}/#{folder}"
 				FileUtils.touch "#{@dest}/#{folder}/.keep"
@@ -74,6 +74,10 @@ module RBCliTool
 			# Create application options
 			RBCliTool.cp_file "#{src}/application/options.rb", "#{@dest}/application/options.rb", @template_vars
 
+			# Create lib file
+			RBCliTool.cp_file "#{src}/lib/lib.erb", "#{@dest}/lib/#{@template_vars[:cmdname]}.rb", @template_vars
+			FileUtils.rm_f "#{@dest}/lib/.keep"
+
 			true
 		end
 

data/rbcli.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
 	spec.name          = 'rbcli'
 	spec.version       = Rbcli::VERSION
 	spec.authors       = ['Andrew Khoury']
-	spec.email         = ['andrew@blacknex.us']
+	spec.email         = ['akhoury@live.com']
 
 	spec.summary       = %q{A CLI Application/Tooling Framework for Ruby}
 	spec.description   = %q{RBCli is a framework to quickly develop command-line tools and applications.}
@@ -53,20 +53,19 @@ Gem::Specification.new do |spec|
 	spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
 	spec.require_paths = ['lib']
 
-	spec.add_development_dependency 'bundler', '~> 1.16'
-	spec.add_development_dependency 'rake', '~> 10.0'
-	spec.add_development_dependency 'minitest', '~> 5.0'
+	spec.add_development_dependency 'bundler', '~> 2.2'
+	spec.add_development_dependency 'rake', '~> 13.0'
+	# spec.add_development_dependency 'rspec', '~> 3.8'
+	# spec.add_development_dependency 'minitest', '~> 5.0'
 
 	spec.add_dependency 'colorize', '~> 0.8'
 	spec.add_dependency 'deep_merge', '~> 1.2'
-	spec.add_dependency 'aws-sdk-dynamodb', '~> 1.6'
+	spec.add_dependency 'aws-sdk-dynamodb', '~> 1.64'
 	spec.add_dependency 'macaddr', '~> 1.7'
-	spec.add_dependency 'rufus-scheduler', '~> 3.5'
-	spec.add_dependency 'octokit', '~> 4.9'
-	spec.add_dependency 'mdless', '~> 0.0'
-	spec.add_dependency 'net-ssh', '~> 5.0'
-	spec.add_dependency 'net-scp', '~> 1.2'
-
-
-	#spec.add_dependency 'trollop', '~> 2.1'
+	spec.add_dependency 'rufus-scheduler', '~> 3.8'
+	spec.add_dependency 'octokit', '~> 4.21'
+	spec.add_dependency 'mdless', '~> 1.0'
+	spec.add_dependency 'net-ssh', '~> 6.1'
+	spec.add_dependency 'net-scp', '~> 3.0'
+	# spec.add_dependency 'trollop', '~> 2.1'
 end

data/skeletons/project/.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/skeletons/project/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in untitled.gemspec
 gemspec

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

@@ -5,7 +5,12 @@
 ###
 #
 # You can access RBCli's variables via the `rbcli` command, which is imported by this line:
-source $(echo $(cd "$(dirname $(gem which rbcli))/../lib-sh" && pwd)/lib-rbcli.sh)
+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

data/skeletons/project/config/general.rb

@@ -8,7 +8,7 @@ Rbcli::Configurate.me do
 	## 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] %>}
+	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

data/skeletons/project/exe/executable

@@ -9,9 +9,7 @@
 ## You should not need to edit this file.
 #########################################################
 
-require (ENV['RBCLI_ENV'] == 'development') ? ENV['RBCLI_DEVPATH'] || 'rbcli' : 'rbcli'
-require "#{File.dirname(__FILE__)}/../config/version"
-$projectdir = "#{File.dirname __FILE__}/.."
+require_relative '../lib/<%= @vars[:cmdname] %>'
 
 #########################
 ## Configuration Block ##

data/skeletons/project/lib/lib.erb

@@ -0,0 +1,9 @@
+$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

@@ -2,13 +2,13 @@ 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"
+	# 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!
+	# Disable RSpec exposing methods globally on `Module` and `main`
+	config.disable_monkey_patching!
 
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
+	config.expect_with :rspec do |c|
+		c.syntax = :expect
+	end
 end

data/skeletons/project/spec/untitled_spec.rb

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

data/skeletons/project/untitled.gemspec

@@ -1,40 +1,40 @@
-
-config = File.expand_path("../config", __FILE__)
+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.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.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
+	# 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"]
+	# 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", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+	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] %>"
+	spec.add_dependency 'rbcli', '>= <%= @vars[:rbcli_version] %>'
 end