rbcli 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6ab8b75c47014a1d8fc4ebfb019fd510d6878446c0b5e21b534331518779c69
-  data.tar.gz: 76a749c4eedd63b9372abfb5cf742c418e440bf52c07cfb80e14e4890e19dad2
+  metadata.gz: eeb0aa5b07a4650d68356dabb3e0f185f7b54adaa8911902780ee66d079a1d83
+  data.tar.gz: 674ce261ee73a19d22667fbfc9906bddfcd1bda88b526939b171696089ef55d9
 SHA512:
-  metadata.gz: 841009711e6ea7507da51246fa3f116c767cee17229775dfb4524e649ed766f20c20069728d426d675d26bdbea9338f0e1a26873fc5120ba63473607815440dd
-  data.tar.gz: edeb6d1302757421d2db44b44c38e07765920a67cd1230c45689541b7a4d29b4b511fd3e3b7d2f08b8abd36b17bbb30c639f71501bfbd5248518b5e4d70cc253
+  metadata.gz: 20eee68c0d42e059fa1e767211941e4e998e7f7c8e9f6440356544a777fd5abc268215d1036b42be3170c1b090bc9d77b176c2ffc89ffa94850c31f888887b5d
+  data.tar.gz: 6272c53067831c7902f42be08532f82199cee8bbb8427bc9ca6c8e2028add6f81726cec0dd381bc056cf030ec067c7249ab406538b4b0fac81b6ba79f5cb2fa9

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    rbcli (0.1.7)
+    rbcli (0.1.8)
       aws-sdk-dynamodb (~> 1.6)
       colorize (~> 0.8)
       deep_merge (~> 1.2)
       macaddr (~> 1.7)
+      mdless (~> 0.0)
       octokit (~> 4.9)
       rufus-scheduler (~> 3.5)
 
@@ -37,6 +38,7 @@ GEM
     jmespath (1.4.0)
     macaddr (1.7.1)
       systemu (~> 2.6.2)
+    mdless (0.0.10)
     minitest (5.11.3)
     multipart-post (2.0.0)
     octokit (4.9.0)

data/README.md

@@ -26,6 +26,8 @@ Some of its key features include:
 
 * __External Script Wrapping__: High-level wrapping for Bash scripts, or any other applcication you'd like to wrap into a command.
 
+* __Project Structure and Generators__: Create a well-defined project directory structure which organizes your code and allows you to package and distribute your application as a Gem. Generators can also help speed up the process of creating new commands, scripts, and hooks!
+
 
 ## Installation
 
@@ -60,14 +62,16 @@ mytool show -l
 Note that all options and parameters will have both a short and long version of the parameter available for use.
 
 
-## Getting Started
+## Getting Started (Lightweight)
+
+For a lightweight skeleton that consists of a single file, use `rbcli init -t mini -n <projectname>`, or `rbcli init -t micro -n <projectname>` for an even more simplified one.
 
-Creating a new skeleton command is as easy as running `rbcli init <filename>`. It will have these key items:
+These lightweight skeletons allow creating single-file applications/scripts using RBCli. They consolidate all of the options in the standard project format into these sections:
 
 * The configuration
 * Storage subsystem configuration (optional)
 * A command declaration
-* The parse command
+* The parse command 
 
 ### Configuration
 
@@ -84,7 +88,7 @@ Rbcli::Configurate.me do
 
 	config_userfile '/etc/mytool/config.yml', merge_defaults: true, required: false  # (Optional) Set location of user's config file. If merge_defaults=true, user settings override default settings, and if false, defaults are not loaded at all. If required=true, application will not run if file does not exist.
 	config_defaults 'defaults.yml'                                         # (Optional, Multiple) Load a YAML file as part of the default config. This can be called multiple times, and the YAML files will be merged. User config is generated from these
-	config_default :myopt, description: 'Testing this', value: true        # (Optional, Multiple) Specify an individual configuration parameter and set a default value. These will also be included in generated user config
+	config_default :myopt, description: 'Testing this', default: true        # (Optional, Multiple) Specify an individual configuration parameter and set a default value. These will also be included in generated user config
 
 	option :name, 'Give me your name', type: :string, default: 'Foo', required: false, permitted: ['Jack', 'Jill']  # (Optional, Multiple) Add a global CLI parameter. Supported types are :string, :boolean, :integer, :float, :date, and :io. Can be called multiple times.
 
@@ -147,7 +151,7 @@ class Test < Rbcli::Command
 	parameter :force, 'Force testing', type: :boolean, default: false, required: false # (Optional, Multiple) Add a command-specific CLI parameter. Can be called multiple times
 
 	config_defaults 'defaults.yml'                                                     # (Optional, Multiple) Load a YAML file as part of the default config. This can be called multiple times, and the YAML files will be merged. User config is generated from these
-	config_default :myopt2, description: 'Testing this again', value: true             # (Optional, Multiple) Specify an individual configuration parameter and set a default value. These will also be included in generated user config
+	config_default :myopt2, description: 'Testing this again', default: true             # (Optional, Multiple) Specify an individual configuration parameter and set a default value. These will also be included in generated user config
 
 	extern path: 'env | grep "^__PARAMS\|^__ARGS\|^__GLOBAL\|^__CONFIG"', envvars: {MYVAR: 'some_value'}     # (Required unless `action` defined) Runs a given application, with optional environment variables, when the user runs the command.
 	extern envvars: {MY_OTHER_VAR: 'another_value'} do |params, args, global_opts, config|                   # Alternate usage. Supplying a block instead of a path allows us to modify the command based on the arguments and configuration supplied by the user.
@@ -202,7 +206,7 @@ The defaults chain allows you to specify sane defaults for your CLI tool through
 * DSL Statements
 	* In the DSL, you can specify options individually by providing a name, description, and default value
 	* This is good for simpler configuration, as the descriptions provided are written out as comments in the generated user config
-	* `config_default :name, description: '<description_text>', value: <default_value>` in the DSL
+	* `config_default :name, description: '<description_text>', default: <default_value>` in the DSL
 	
 Users can generate configs by running `yourclitool -g`. This will generate a config file at the tool's default location specified in the DSL. A specific location can be used via the `-c` parameter. You can test how this works by running `examples/mytool -c test.yml -g`.
  
@@ -276,6 +280,8 @@ Hash native methods:
 
 Additional methods:
 
+* `commit`
+	* Every assignment to the top level of the hash will result in a write to disk (for example: `Rbcli.local_state[:yourkey] = 'foo'`). If you are manipulating nested hashes, you can trigger a save manually by calling `commit`.
 * `clear`
 	* Resets the data back to an empty hash.
 * `refresh`
@@ -481,6 +487,44 @@ class Test < Rbcli::Command
 end
 ```
 
+## Project Structure and Generators
+
+RBCli supports using predefined project structure, helping to organize all of the options and commands that you may use. It also 
+
+Creating a new project skeleton is as easy as running `rbcli init -n <projectname>`. It will create a folder under the currect directory using the name specified, allowing you to create a command that can be easily packaged and distributed as a gem.
+
+The folder structure is as follows:
+
+```
+<projectname>
+|
+|--- application
+|   |
+|   |--- commands
+|      |
+|      |---scripts
+|
+|--- config
+|--- default_user_configs
+|--- exe
+|--- hooks
+|--- spec
+```
+
+It is highly recommended to __not__ create files in these folders manually, and to use the RBCli generators instead:
+
+```shell
+rbcli command -n <name>
+rbcli script -n <name>
+rbcli userconf -n <name>
+rbcli hook -t pre
+rbcli hook -t post
+rbcli hook -t default
+rbcli hook -t runonce
+```
+
+That said, this readme will provide you with the information required to do things manually if you so desire. More details on generators later.
+
 
 ## Development
 

data/exe/rbcli

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'rbcli'
+require '../lib/rbcli'
 
 Rbcli::Configurate.me do
 	scriptname __FILE__.split('/')[-1]
@@ -8,46 +8,95 @@ Rbcli::Configurate.me do
 	description 'RBCli initialization tool'
 end
 
-class Init < Rbcli::Command
-	description 'Initialize a skeleton RBCli executable.'
-	usage 'This will generate a new file in the current folder'
-	parameter :filename, 'Name of file to generate', type: :string, required: true
+require '../lib/rbcli-tool'
 
-	action do |params, args, global_opts, config|
-		src = "#{File.dirname(__FILE__)}/../examples/mytool"
-		dest = "#{Dir.pwd}/#{params[:filename]}"
-		cp_file src, dest
+class Docs < Rbcli::Command
+	description 'Show Documentation (Beta)'
+
+	action do
+		readme = "#{File.dirname(__FILE__)}/../README.md"
+		begin
+			CLIMarkdown::Converter.new([readme])
+		rescue Errno::EPIPE
+			# Empty
+		end
 	end
 end
 
-class Script < Rbcli::Command
-	description 'Initialize a skeleton bash script to use as an RBCli command.'
-	usage 'This will generate a new file in the current folder.'
-	parameter :filename, 'Name of file to generate', type: :string, required: true
+class Init < Rbcli::Command
+	description 'Initialize a skeleton RBCli project.'
+	usage <<-EOF
+This will generate a new project structure under the current directory. Use -t to specify the type:
+
+
+Standard: A complete RBCli project structure. Recommended for most applications, it provides
+          a framework for organizing code and creating a gem to be installed/distributed.
+
+Mini:     A single-file RBCli project. All features are supported, but project structure is left to the developer.
+          Recommended for smaller applications, or for integrating RBCli into an existing application.
+
+Micro:    A single-file, minimal RBCli project. Similar to a mini project, but only the minimal required code is
+          generated. Recommended for rapid prototyping of scripts, for advanced users only.
+	EOF
+
+	parameter :name, 'Name of project to generate', type: :string, required: true
+	parameter :type, 'Specify project type', type: :string, permitted: %w(standard micro mini), default: 'standard'
+	parameter :description, 'A description of the project', type: :string, default: 'TODO: Description goes here'
 
 	action do |params, args, global_opts, config|
-		src = "#{File.dirname(__FILE__)}/../examples/myscript.sh"
-		dest = "#{Dir.pwd}/#{params[:filename]}"
-		cp_file src, dest, template_vars: {'CMDNAME' => params[:filename].chomp('.sh')}
-	end
-end
+		dest = "#{Dir.pwd}/#{params[:name]}"
+
+		# Prepare template vars
+		template_vars = {
+				cmdname: params[:name],
+				description: params[:description],
+				rbcli_version: Rbcli::VERSION
+		}
+
+		proj = RBCliTool::Project.new(dest, template_vars)
 
-def cp_file src, dest, template_vars: nil
-	if File.exists? dest
-		puts "File #{dest} already exists. Please delete it and try again."
-	elsif template_vars
-		print "Generating file #{dest}..."
-		text = File.read src
-		template_vars.each do |k, v|
-			text.gsub! /{{\*\*#{k}\*\*}}/, v
+		if proj.exists?
+			RBCliTool.continue_confirmation "The project or file #{params[:name]} already exists; contents will be overwritten."
+			FileUtils.rm_rf dest
 		end
-		File.open(dest, 'w') { |file| file.write text }
-		puts "Done!"
-	else
-		print "Generating file #{dest}..."
-		FileUtils.cp src, dest
-		puts "Done!"
+
+		case params[:type]
+		when 'micro' # Micro: Single File, simplified
+			puts "\nInitialization Complete!\n" if proj.create_micro
+
+		when 'mini' # Mini: Single File
+			puts "\nInitialization Complete!\n" if proj.create_mini
+
+		else # Standard; full project structure
+			if proj.create
+				puts "\nInitialization Complete!\n"
+			else
+				puts "\nAn RBCli Project already exists in the current directory tree at: #{proj.exists?}. Aborting.\n"
+			end
+
+		end # END case params[:type]
+
 	end
 end
 
+class Command < Rbcli::Command
+	description 'Generate an Rbcli Command under the current project'
+	usage <<-EOF
+This will generate a new project structure under the current directory. Use -t to specify the type:
+
+
+Standard: A complete RBCli project structure. Recommended for most applications, it provides
+          a framework for organizing code and creating a gem to be installed/distributed.
+
+Mini:     A single-file RBCli project. All features are supported, but project structure is left to the developer.
+          Recommended for smaller applications, or for integrating RBCli into an existing application.
+
+Micro:    A single-file, minimal RBCli project. Similar to a mini project, but only the minimal required code is
+          generated. Recommended for rapid prototyping of scripts, for advanced users only.
+	EOF
+
+	parameter :name, 'Name of command to generate', type: :string, required: true
+end
+
+
 Rbcli.parse

data/lib/rbcli/configuration/config.rb

@@ -45,7 +45,7 @@ module Rbcli::Config
 	@categorized_defaults = nil
 	@loaded = false
 
-	def self.set_userfile filename, merge_defaults: false, required: false
+	def self.set_userfile filename, merge_defaults: true, required: false
 		@config_file = File.expand_path filename
 		@merge_defaults = merge_defaults
 		@userfile_required = required
@@ -67,11 +67,11 @@ module Rbcli::Config
 		@loaded = false
 	end
 
-	def self.add_default name, description: nil, value: nil
+	def self.add_default name, description: nil, default: nil
 		@config_individual_lines ||= []
-		text = "#{name.to_s}: #{value}".ljust(30) + " # #{description}"
+		text = "#{name.to_s}: #{default}".ljust(30) + " # #{description}"
 		@config_individual_lines.push text unless @config_individual_lines.include? text
-		@config_defaults[name.to_sym] = value
+		@config_defaults[name.to_sym] = default
 		@loaded = false
 	end
 
@@ -81,8 +81,8 @@ module Rbcli::Config
 		@config_text ||= ''
 		@config_text += "\n" unless @config_text.empty?
 		File.readlines(filename).each do |line|
-			if (line.start_with? '---' or line.start_with? '...')
-				@config_text << "\n\n"
+			if line.start_with? '---' or line.start_with? '...'
+				@config_text << "\n" unless @config_text.empty?
 			else
 				@config_text << line unless @config_text.include? line
 			end

data/lib/rbcli/configuration/configurate.rb

@@ -4,7 +4,7 @@ module Rbcli::Configurate
 			scriptname: nil,
 			version: nil,
 			description: nil,
-			config_userfile: 'config.yml',
+			config_userfile: nil,
 			allow_json: false,
 			options: {},
 			default_action: nil,

data/lib/rbcli/engine/load_project.rb

@@ -0,0 +1,19 @@
+module Rbcli
+	def self.load_project
+		project_root = File.expand_path "#{File.dirname(caller[0].split(':')[0])}/../"
+
+		# 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.exists? dirpath
+		end
+
+		# We automatically pull in default user configs
+		configspath = "#{project_root}/default_user_configs"
+		Dir.glob "#{configspath}/*.{yml,yaml}" do |file|
+			Rbcli::Configurate.me {config_defaults file}
+		end
+	end
+end

data/lib/rbcli/engine/parser.rb

@@ -28,8 +28,8 @@ Commands:
 				opt name.to_sym, opts[:description], type: opts[:type], default: opts[:default], required: opts[:required], permitted: opts[:permitted]
 			end
 			opt :json_output, 'Output result in machine-friendly JSON format', :type => :boolean, :default => false if data[:allow_json]
-			opt :config_file, 'Specify a config file manually', :type => :string, :default => data[:config_userfile]
-			opt :generate_config, 'Generate a new config file' #defaults to false
+			opt :config_file, 'Specify a config file manually', :type => :string, :default => data[:config_userfile] unless data[:config_userfile].nil?
+			opt :generate_config, 'Generate a new config file' unless data[:config_userfile].nil? #defaults to false
 			stop_on Rbcli::Command.commands.keys
 		end
 

data/lib/rbcli/logging/logging.rb

@@ -29,12 +29,12 @@ module Rbcli::Logger
 
 		Rbcli::Config::add_categorized_defaults :logger, 'Log Settings', {
 				log_level: {
-						description: '0-5, or DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN',
-						value: @default_level || 'info'
+						description: '0-5, or DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN. Set to null (~) to disable logging.',
+						value: @default_level || nil
 				},
 				log_target: {
-						description: 'STDOUT, STDERR, or a file path',
-						value: @default_target || 'stderr'
+						description: 'STDOUT, STDERR, or a file path. Set to null (~) to disable logging.',
+						value: @default_target || nil
 				}
 		}
 	end
@@ -45,9 +45,12 @@ module Rbcli::Logger
 		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]
 

data/lib/rbcli/stateful_systems/state_storage.rb

@@ -46,6 +46,10 @@ module Rbcli::State
 			end
 		end
 
+		def commit
+			save_state if @loaded
+		end
+
 		def clear
 			state_create unless @loaded
 			@data[:data] = {}

data/lib/rbcli/version.rb

@@ -1,3 +1,3 @@
 module Rbcli
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/lib/rbcli-tool/erb_renderer.rb

@@ -0,0 +1,43 @@
+require 'erb'
+
+module RBCliTool
+	class ERBRenderer
+		def initialize filename, varlist
+			@filename = filename
+			@vars = varlist
+		end
+
+		def render
+			ERB.new(File.read(@filename)).result(binding)
+		end
+	end
+
+	def self.cp_file src, dest, template_vars = nil
+		dest = "#{dest}#{src.split('/')[-1]}" if dest.end_with? '/'
+		if File.exists? dest
+			puts "File #{dest} already exists. Please delete it and try again."
+		else
+			print "Generating file " + dest + " ... "
+
+			if template_vars
+				renderer = ERBRenderer.new src, template_vars
+				File.open(dest, 'w') {|file| file.write renderer.render}
+			else
+				FileUtils.cp src, dest
+			end
+
+			FileUtils.rm_f "#{File.dirname(dest)}/.keep" if File.exists? "#{File.dirname(dest)}/.keep"
+			puts "Done!"
+		end
+	end
+
+	def self.continue_confirmation text
+		puts text
+		print "Continue? (Y/n):  "
+		input = gets
+		unless input[0].downcase == 'y'
+			puts "\n Aborting..."
+			exit 0
+		end
+	end
+end