rbcli 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33e6d713e741e80cdf48db2fbb70f3792e45df71b763d6fe80a8af946d4b2289
-  data.tar.gz: ba6204362da692fa141bf719cec73541c7a638a71236a0168a799898ed193334
+  metadata.gz: a6b4a98c7a6e1974987798099020dbb037a5966f1b463832a23caed9dcf3e3f6
+  data.tar.gz: c4dba14eeb1fc10a17022b0082b3f6a8d3679de8a4f9d292d34c4d35547ac7d9
 SHA512:
-  metadata.gz: 729410aa90d602fcd35632d2d05e5243357af944e0e0363d18fde139fc9b9713e8d94f52caad1ab270f5e709873dccebf39fb50da2519043da60748e59a5552b
-  data.tar.gz: 3a4bc66baf02efefa8f11f806281318d23ef28c860fff11cb7ee5d03c0a9bbb50b24b938e5923cd821e2c8c438784f18cf27a87e8b7cfc4d6b1111d5d7681545
+  metadata.gz: 62db4643f55cd2c8044441ca209c1ee9d1e8b6377b0c7d09e5bf6015328b0b6291fb8b57f974c2c584faa838b7325f508ddf81394f90cc0d5cc49d8a32183c32
+  data.tar.gz: d2bd43820d8f6ab88424f96f0fb5767312d9267cd06782ff060400c41759e801f7d36828919e084b16650b65749519ac581145850ee7381f007e2e2e3103d084

data/CHANGELOG.md

@@ -1,10 +1,30 @@
 # Changelog
 
+## 0.2.8 (Nov 7, 2018)
+
+### Features
+
+* Added a standardized message I/O system
+
+### Improvements
+
+* Enabled the safe usage of anchors in YAML config files
+* Improved the method of determining the script name to be more portable across OS'es
+
+### Bugfixes
+
+* Fixed an error which caused RBCli to crash when using `local_state`
+* Fixed a bug which caused the `rbcli init` command to occassionally fail for mini and micro projects
+
+### Changes
+
+* Changed the `rbcli init` helptext to match the order of complexity of projects (standard -> mini -> micro)
+
 ## 0.2.7 (Oct 17, 2018)
 
 ### Improvements
+
 * Added a dev mode for scripts that allows using a local RBCli copy instead of requiring the gem to be installed
-* Added a 
 
 ### Bugfixes
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbcli (0.2.7)
+    rbcli (0.2.8)
       aws-sdk-dynamodb (~> 1.6)
       colorize (~> 0.8)
       deep_merge (~> 1.2)
@@ -18,8 +18,8 @@ GEM
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
     aws-eventstream (1.0.1)
-    aws-partitions (1.105.0)
-    aws-sdk-core (3.31.0)
+    aws-partitions (1.106.0)
+    aws-sdk-core (3.32.0)
       aws-eventstream (~> 1.0)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)

data/README.md

@@ -2,7 +2,7 @@
 
 RBCli is currently in Alpha stages of development. All releases can be considered stable, though breaking changes may be made between versions.
 
-Latest Release: v0.2.7 (Oct 17, 2018) -- See the [changelog][changelog] for complete details.
+Latest Release: v0.2.8 (Nov 7, 2018) -- See the [changelog][changelog] for complete details.
 
 [You can find the Official Documentation for RBCli Here.][documentation_home]
 

data/exe/rbcli

@@ -80,7 +80,7 @@ Micro:    A single-file, minimal RBCli project. Similar to a mini project, but o
 EOF
 
 	parameter :name, 'Name of project to generate', type: :string, default: File.basename(Dir.pwd), required: true, prompt: 'Enter a name'
-	parameter :type, 'Specify project type', type: :string, permitted: %w(standard micro mini), default: 'standard'
+	parameter :type, 'Specify project type', type: :string, permitted: %w(standard mini micro), default: 'standard'
 	parameter :description, 'A description of the project', type: :string, default: 'TODO: Description goes here'
 
 	action do |params, args, global_opts, config|
@@ -112,7 +112,7 @@ EOF
 		if success
 			puts "\nInitialization Complete!\n"
 		else
-			puts "\nAn RBCli Project already exists in the current directory tree at: #{proj.exists?}. Please delete the project or run this command from a different directory.\n"
+			puts "\nAn RBCli Project already exists in the current or specified directory tree. Please delete the project or run this command from a different directory.\n"
 		end
 	end
 end

data/lib/rbcli-tool/project.rb

@@ -79,12 +79,12 @@ module RBCliTool
 
 		def create_mini force = false
 			return false if project_exists? and not force
-			RBCliTool.cp_file @minipath, @dest, @template_vars
+			RBCliTool.cp_file @minipath, "#{@dest}/#{@template_vars[:cmdname]}", @template_vars
 		end
 
 		def create_micro force = false
 			return false if project_exists? and not force
-			RBCliTool.cp_file @micropath, @dest, @template_vars
+			RBCliTool.cp_file @micropath, "#{@dest}/#{@template_vars[:cmdname]}", @template_vars
 		end
 
 		def exists?

data/lib/rbcli-tool/util.rb

@@ -36,6 +36,7 @@ module RBCliTool
 		dest = "#{dest}#{src.split('/')[-1]}" if dest.end_with? '/'
 		if File.exists? dest
 			puts "File #{dest} already exists. Please delete it and try again."
+			false
 		else
 			print "Generating file " + dest + " ... "
 
@@ -48,6 +49,7 @@ module RBCliTool
 
 			FileUtils.rm_f "#{File.dirname(dest)}/.keep" if File.exists? "#{File.dirname(dest)}/.keep"
 			puts "Done!"
+			true
 		end
 	end
 

data/lib/rbcli.rb

@@ -37,6 +37,7 @@ require 'rbcli/version'
 # UTILS
 require 'rbcli/util/hash_deep_symbolize'
 require 'rbcli/util/deprecation_warning'
+require 'rbcli/util/msg'
 #require 'rbcli/util/string_colorize' # We are using the colorize gem instead. The code is kept here for reference.
 # END UTILS
 

data/lib/rbcli/features/userconfig.rb

@@ -111,13 +111,13 @@ module Rbcli::Config
 		@config_text << "\n\n" << text if text
 
 		@config_defaults ||= {}
-		@config_defaults.deep_merge! YAML::load(@config_text).deep_symbolize!
+		@config_defaults.deep_merge! YAML.safe_load(@config_text, [], [], true).deep_symbolize!
 		@loaded = false
 	end
 
 	def self.load
 		if (! @config_file.nil?) and File.exists? @config_file
-			@config = YAML::load(File.read(@config_file)).deep_symbolize!
+			@config = YAML.safe_load(File.read(@config_file), [], [], true).deep_symbolize!
 			@config.deep_merge! @config_defaults if @merge_defaults
 		elsif @userfile_required
 			puts "User's config file not found at #{@config_file}. Please run this tool with the `--generate-config` option to generate it."

data/lib/rbcli/util/msg.rb

@@ -0,0 +1,55 @@
+module Rbcli::Msg
+	def self.print message, log: false, color: nil
+		Rbcli::log.info {message} if log
+		STDOUT.print message
+	end
+
+	def self.puts message, log: false, color: nil
+		Rbcli::log.info {message} if log
+		message = message.colorize(color) if Rbcli::config[:colorize_output]
+		STDOUT.puts message
+	end
+
+	def self.err message, log: false, color: :yellow
+		Rbcli::log.warn {message} if log
+		message = message.colorize(color) if Rbcli::config[:colorize_output]
+		STDERR.puts message
+	end
+
+	def self.fatal message, log: true, color: :red, exitcode: 1
+		Rbcli::log.fatal {"Exited with the message: " + message} if log
+		message = "Error: #{message}"
+		message = message.colorize(color) if Rbcli::config[:colorize_output]
+		STDERR.puts message
+		exit exitcode
+	end
+
+	@triggernests = 0
+
+	def self.triggered msg, msg_success, msg_fail = nil, fatality_msg = nil, log: false, success_color: :green, fail_color: :red, newline: false, &block
+		@triggernests.times {msg = '  ' + msg}
+		@triggernests += 1
+
+		Rbcli::Msg.send ((newline) ? :puts : :print), msg
+		result = yield
+		tmsg = (result or msg_fail.nil?) ? msg_success : msg_fail
+		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
+
+		@triggernests -= 1
+	end
+
+	def self.yesno question, default_to_yes: false
+		yes_display = (default_to_yes) ? 'Y' : 'y'
+		no_display = (default_to_yes) ? 'n' : 'N'
+		Rbcli::Msg.print "#{question} (#{yes_display}/#{no_display}): ", log: false
+		if default_to_yes
+			answer = !gets.chomp.casecmp('n').zero?
+		else
+			answer = gets.chomp.casecmp('y').zero?
+		end
+		Rbcli::log.info {"Question: #{question}. Answer: #{answer}"}
+		answer
+	end
+end

data/lib/rbcli/version.rb

@@ -19,5 +19,5 @@
 ##################################################################################
 
 module Rbcli
-	VERSION = '0.2.7'
+	VERSION = '0.2.8'
 end

data/skeletons/micro/executable

@@ -14,7 +14,7 @@ require (ENV['RBCLI_ENV'] == 'development') ? ENV['RBCLI_DEVPATH'] || 'rbcli' :
 #########################
 Rbcli::Configurate.me do
 	## Script Name -- (Required) -- This line identifies the tool's executable on the command line.
-	scriptname __FILE__.split('/')[-1]
+	scriptname File.basename(__FILE__)
 
 	## Version Number -- (Required)
 	version '0.1.0'
@@ -85,7 +85,7 @@ Rbcli::Configurate.storage do
 	# Local State Storage
 	###
 
-	## Local State -- (Optional) -- Creates a hash that is automatically saved to a file locally for state persistance. It is accessible to all commands at  Rbcli.localstate[:yourkeyhere]
+	## Local State -- (Optional) -- 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]
 	#local_state '/var/mytool/localstate', force_creation: true, halt_on_error: true
 
 

data/skeletons/mini/executable

@@ -28,7 +28,7 @@ Rbcli::Configurate.me do
 	## 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__.split('/')[-1]
+	scriptname File.basename(__FILE__)
 
 	## Version Number -- (Required)
 	version '0.1.0'
@@ -173,13 +173,14 @@ end
 ###############################
 Rbcli::Configurate.storage do
 	###
-	# Local State Storage
+	# 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.localstate[:yourkeyhere]
+	# 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.localstate.commit`.
+	# 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.
 	###
 

data/skeletons/project/config/storage.rb

@@ -9,11 +9,11 @@ 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.localstate[:yourkeyhere]
+	# 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.localstate.commit`.
-	# It is accessible to all commands at: Rbcli.localstate[:yourkeyhere]
+	# 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.
 	###
 

data/skeletons/project/exe/executable

@@ -31,7 +31,7 @@ Rbcli::Configurate.me do
 	## 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__.split('/')[-1]
+	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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbcli
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Andrew Khoury
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-18 00:00:00.000000000 Z
+date: 2018-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -309,6 +309,7 @@ files:
 - lib/rbcli/state_storage/remotestate_dynamodb.rb
 - lib/rbcli/util/deprecation_warning.rb
 - lib/rbcli/util/hash_deep_symbolize.rb
+- lib/rbcli/util/msg.rb
 - lib/rbcli/util/string_colorize.rb
 - lib/rbcli/util/trollop.rb
 - lib/rbcli/version.rb