rbcli 0.2.2 → 0.2.4

data/docs/tutorial/40-options_parameters_and_arguments/index.html

@@ -36,7 +36,7 @@
         <meta name="lang:search.tokenizer" content="[\s\-]+">
       
       <link rel="shortcut icon" href="../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-0.17.5, mkdocs-material-2.9.2">
+      <meta name="generator" content="mkdocs-1.0.3, mkdocs-material-3.0.4">
     
     
       
@@ -44,7 +44,7 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/application.ba0fd1a6.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/application.451f80e5.css">
       
       
     
@@ -52,8 +52,8 @@
       <script src="../../assets/javascripts/modernizr.1aa3b519.js"></script>
     
     
-      <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
       
+        <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
         <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
         <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
       
@@ -94,7 +94,7 @@
     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
     <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
     
-      <a href="#options-paramters-and-arguments" tabindex="1" class="md-skip">
+      <a href="../../#options-paramters-and-arguments" tabindex="1" class="md-skip">
         Skip to content
       </a>
     
@@ -264,11 +264,11 @@
                   <div class="md-sidebar__inner">
                     <nav class="md-nav md-nav--primary" data-md-level="0">
   <label class="md-nav__title md-nav__title--site" for="__drawer">
-    <span class="md-nav__button md-logo">
+    <a href="../.." title="RBCli Documentation" class="md-nav__button md-logo">
       
         <i class="md-icon">devices</i>
       
-    </span>
+    </a>
     RBCli Documentation
   </label>
   
@@ -428,6 +428,19 @@
     Parameters
   </a>
   
+    <nav class="md-nav">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#user-prompting" title="User Prompting" class="md-nav__link">
+    User Prompting
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
       
         <li class="md-nav__item">
@@ -539,6 +552,18 @@
           
 
 
+  <li class="md-nav__item">
+    <a href="../../advanced/logging/" title="Logging" class="md-nav__link">
+      Logging
+    </a>
+  </li>
+
+        
+          
+          
+          
+
+
   <li class="md-nav__item">
     <a href="../../advanced/automatic_updates/" title="Automatic Updates" class="md-nav__link">
       Automatic Updates
@@ -582,6 +607,18 @@
   </li>
 
         
+          
+          
+          
+
+
+  <li class="md-nav__item">
+    <a href="../../advanced/interactive_commands/" title="Interactive Commands" class="md-nav__link">
+      Interactive Commands
+    </a>
+  </li>
+
+        
       </ul>
     </nav>
   </li>
@@ -665,8 +702,8 @@
 
 
   <li class="md-nav__item">
-    <a href="../../whoami/" title="$ whoami" class="md-nav__link">
-      $ whoami
+    <a href="../../whoami/" title="whoami" class="md-nav__link">
+      whoami
     </a>
   </li>
 
@@ -710,6 +747,19 @@
     Parameters
   </a>
   
+    <nav class="md-nav">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#user-prompting" title="User Prompting" class="md-nav__link">
+    User Prompting
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
       
         <li class="md-nav__item">
@@ -867,6 +917,21 @@ parameter :directoriesfirst, 'Show directories on top', type: :boolean, default:
 </code></pre>
 
 <p>Note how the parameters come after the <code>list</code> command in the syntax above. As you create more commands, each will have its own unique set of parameters, while the options remain <em>before</em> the command and are available to all of them.</p>
+<h3 id="user-prompting">User Prompting</h3>
+<p>There is an additional option when declaring parameters to prompt the user for a value if not entered on the command line. This can be done with the <code>prompt:</code> keyword. Let's change one of our parameters to utilize it:</p>
+<pre><code class="ruby">parameter :sort, 'Sort output alphabetically', type: :boolean, default: false, prompt: &quot;Sort output alphabetically?&quot;
+</code></pre>
+
+<p>Now, let's run the tool while omitting the <code>--sort</code> parameter, as such:</p>
+<pre><code class="bash">mytool -c list -ad
+</code></pre>
+
+<p>This should give you the prompt:</p>
+<pre><code>Sort output alphabetically? (y/N):
+</code></pre>
+
+<p>Because we set the parameter to default to <code>false</code> the default here is <code>N</code>, which is used if the user hits enter without entering a letter. If the default was set to <code>true</code>, then the <code>Y</code> would be capitalized and be the default.</p>
+<p>For more information, see the documentation on <a href="../../advanced/interactive_commands/">Interactive Commands</a>.</p>
 <h2 id="arguments">Arguments</h2>
 <p>Lastly on the command line, there are arguments. Arguments are simply strings without the <code>-</code> character in front, and automatically get passed into an array in your applicaiton. Let's take a look at how we can use them.</p>
 <p>Unlike options and parameters, arguments require no setup. So let's assume that we want any arguments passed to the <code>list</code> command to be filenames that you want to display, and that you can pass multiple ones. Since arguments aren't listed automatically by the help function, this is a good example of what to put in your usage text. Let's take a look at what our class looks like now:</p>
@@ -1049,9 +1114,9 @@ parameter :&lt;name&gt;, &quot;&lt;description_string&gt;&quot;, short: '&lt;cha
       
     </div>
     
-      <script src="../../assets/javascripts/application.a59e2a89.js"></script>
+      <script src="../../assets/javascripts/application.583bbe55.js"></script>
       
-      <script>app.initialize({version:"0.17.5",url:{base:"../.."}})</script>
+      <script>app.initialize({version:"1.0.3",url:{base:"../.."}})</script>
       
     
     

data/docs/tutorial/50-publishing/index.html

@@ -36,7 +36,7 @@
         <meta name="lang:search.tokenizer" content="[\s\-]+">
       
       <link rel="shortcut icon" href="../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-0.17.5, mkdocs-material-2.9.2">
+      <meta name="generator" content="mkdocs-1.0.3, mkdocs-material-3.0.4">
     
     
       
@@ -44,7 +44,7 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/application.ba0fd1a6.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/application.451f80e5.css">
       
       
     
@@ -52,8 +52,8 @@
       <script src="../../assets/javascripts/modernizr.1aa3b519.js"></script>
     
     
-      <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
       
+        <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
         <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
         <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
       
@@ -94,7 +94,7 @@
     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
     <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
     
-      <a href="#publishing-your-application" tabindex="1" class="md-skip">
+      <a href="../../#publishing-your-application" tabindex="1" class="md-skip">
         Skip to content
       </a>
     
@@ -264,11 +264,11 @@
                   <div class="md-sidebar__inner">
                     <nav class="md-nav md-nav--primary" data-md-level="0">
   <label class="md-nav__title md-nav__title--site" for="__drawer">
-    <span class="md-nav__button md-logo">
+    <a href="../.." title="RBCli Documentation" class="md-nav__button md-logo">
       
         <i class="md-icon">devices</i>
       
-    </span>
+    </a>
     RBCli Documentation
   </label>
   
@@ -532,6 +532,18 @@
           
 
 
+  <li class="md-nav__item">
+    <a href="../../advanced/logging/" title="Logging" class="md-nav__link">
+      Logging
+    </a>
+  </li>
+
+        
+          
+          
+          
+
+
   <li class="md-nav__item">
     <a href="../../advanced/automatic_updates/" title="Automatic Updates" class="md-nav__link">
       Automatic Updates
@@ -575,6 +587,18 @@
   </li>
 
         
+          
+          
+          
+
+
+  <li class="md-nav__item">
+    <a href="../../advanced/interactive_commands/" title="Interactive Commands" class="md-nav__link">
+      Interactive Commands
+    </a>
+  </li>
+
+        
       </ul>
     </nav>
   </li>
@@ -658,8 +682,8 @@
 
 
   <li class="md-nav__item">
-    <a href="../../whoami/" title="$ whoami" class="md-nav__link">
-      $ whoami
+    <a href="../../whoami/" title="whoami" class="md-nav__link">
+      whoami
     </a>
   </li>
 
@@ -838,9 +862,9 @@ gem install mytool-*.gem
       
     </div>
     
-      <script src="../../assets/javascripts/application.a59e2a89.js"></script>
+      <script src="../../assets/javascripts/application.583bbe55.js"></script>
       
-      <script>app.initialize({version:"0.17.5",url:{base:"../.."}})</script>
+      <script>app.initialize({version:"1.0.3",url:{base:"../.."}})</script>
       
     
     

data/docs/whoami/index.html

@@ -36,15 +36,15 @@
         <meta name="lang:search.tokenizer" content="[\s\-]+">
       
       <link rel="shortcut icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-0.17.5, mkdocs-material-2.9.2">
+      <meta name="generator" content="mkdocs-1.0.3, mkdocs-material-3.0.4">
     
     
       
-        <title>$ whoami - RBCli Documentation</title>
+        <title>whoami - RBCli Documentation</title>
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/application.ba0fd1a6.css">
+      <link rel="stylesheet" href="../assets/stylesheets/application.451f80e5.css">
       
       
     
@@ -52,8 +52,8 @@
       <script src="../assets/javascripts/modernizr.1aa3b519.js"></script>
     
     
-      <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
       
+        <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
         <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
         <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
       
@@ -94,7 +94,7 @@
     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
     <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
     
-      <a href="#my-letter-to-you" tabindex="1" class="md-skip">
+      <a href="../#my-letter-to-you" tabindex="1" class="md-skip">
         Skip to content
       </a>
     
@@ -120,7 +120,7 @@
                 RBCli Documentation
               </span>
               <span class="md-header-nav__topic">
-                $ whoami
+                whoami
               </span>
             
           
@@ -262,11 +262,11 @@
                   <div class="md-sidebar__inner">
                     <nav class="md-nav md-nav--primary" data-md-level="0">
   <label class="md-nav__title md-nav__title--site" for="__drawer">
-    <span class="md-nav__button md-logo">
+    <a href=".." title="RBCli Documentation" class="md-nav__button md-logo">
       
         <i class="md-icon">devices</i>
       
-    </span>
+    </a>
     RBCli Documentation
   </label>
   
@@ -462,6 +462,18 @@
           
 
 
+  <li class="md-nav__item">
+    <a href="../advanced/logging/" title="Logging" class="md-nav__link">
+      Logging
+    </a>
+  </li>
+
+        
+          
+          
+          
+
+
   <li class="md-nav__item">
     <a href="../advanced/automatic_updates/" title="Automatic Updates" class="md-nav__link">
       Automatic Updates
@@ -505,6 +517,18 @@
   </li>
 
         
+          
+          
+          
+
+
+  <li class="md-nav__item">
+    <a href="../advanced/interactive_commands/" title="Interactive Commands" class="md-nav__link">
+      Interactive Commands
+    </a>
+  </li>
+
+        
       </ul>
     </nav>
   </li>
@@ -596,8 +620,8 @@
       
     
     
-    <a href="./" title="$ whoami" class="md-nav__link md-nav__link--active">
-      $ whoami
+    <a href="./" title="whoami" class="md-nav__link md-nav__link--active">
+      whoami
     </a>
     
   </li>
@@ -709,9 +733,9 @@
       
     </div>
     
-      <script src="../assets/javascripts/application.a59e2a89.js"></script>
+      <script src="../assets/javascripts/application.583bbe55.js"></script>
       
-      <script>app.initialize({version:"0.17.5",url:{base:".."}})</script>
+      <script>app.initialize({version:"1.0.3",url:{base:".."}})</script>
       
     
     

data/exe/rbcli

@@ -58,8 +58,8 @@ This is free software, and you are welcome to redistribute it
 under certain conditions.
 If you wish to release this library as part of commercial software,
 please contact andrew@blacknex.us.
-Type `rbcli license --full' to show the license text.
 EOF
+		puts "Type `rbcli license --full' to show the license text." unless params[:full]
 	end
 end
 

data/lib/rbcli/engine/command.rb

@@ -62,7 +62,7 @@ class Rbcli::Command
 	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
+	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,
@@ -70,7 +70,8 @@ class Rbcli::Command
 				default: default,
 				required: required,
 				permitted: permitted,
-				short: short
+				short: short,
+				prompt: prompt
 		}
 	end
 
@@ -162,6 +163,31 @@ Command-specific Parameters:
 			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] + " (default: \"#{data[:default]}\"): "
+					answer = gets.chomp
+					answer = data[:default] if answer.empty?
+					optx[name] = answer
+				end
+			end
+		end
 		optx
 	end