runfile 0.11.1 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74c9de556322b0b955c4f7e2130253d3201f726c30d111fd04ebbac04552463d
-  data.tar.gz: 8aace481e65512a3dd9b8be468d8dd02adfb4811597d50ec9b57c1f296088da7
+  metadata.gz: f1e4e930d902a8bb8db9d283e1cf7c33fb26c5e1dfdf77b03d5be0a3acc01609
+  data.tar.gz: cf2bf1976c2dee358a8bbd2b9465b871bc6c9630c0ca7f091000b2464615370c
 SHA512:
-  metadata.gz: 3f17e81d22aa4916c9d83490b9cc8e45a7f81f60308ab166683e0929e051f17d2f546a5d3188e2a41877c94798c4f533b0813b6e0f1de16d40b6efec97e3f557
-  data.tar.gz: 281b1656caf9f2abaf49fcc03ac831fd8e6f4af41dde1c2b1fd641729cc97c08390fdf686535ec208e717bdf05abe5a8e614d26d178ed04da56fc81db9873ba1
+  metadata.gz: 9eaadbedb085b6a8ef13078327b2260c82fc86baebf2292868eb7d37c166206e8b529a82a67e39fbe3a1087271308d5f750ff07bea8c515e9b065d7e413cdf65
+  data.tar.gz: f837dd093b39741dabc2e67813bcd21f9ff7bdac3b52cb90990fe9b568f90801e5c344e697224ddce095af478fc7e92ace4d5be8867c97827b4627f93dd7535e

data/lib/runfile/docopt_helper.rb

@@ -23,6 +23,7 @@ module Runfile
       @actions    = options.actions
       @options    = options.options
       @params     = options.params
+      @env_vars   = options.env_vars
       @examples   = options.examples
     end
 
@@ -37,6 +38,7 @@ module Runfile
       doc += docopt_commands width
       doc += docopt_options width
       doc += docopt_params width
+      doc += docopt_env_vars width
       doc += docopt_examples width
       doc.join "\n"
     end
@@ -84,6 +86,11 @@ module Runfile
       section_block @params, width
     end
 
+    # Return all docopt params for 'Environment Variables' section
+    def docopt_env_vars(width)
+      section_block @env_vars, width
+    end
+
     # Return all docopt lines for the 'Examples' section
     def docopt_examples(width)
       return [] if @examples.empty?

data/lib/runfile/dsl.rb

@@ -49,6 +49,12 @@ module Runfile
       Runner.instance.add_param name, text, scope
     end
 
+    # Set an environment variable (can be called multiple times)
+    #   env_var 'USER', 'Set the user (same as --user)'
+    def env_var(name, text, scope = nil)
+      Runner.instance.add_env_var name, text, scope
+    end
+
     # Set an example command (can be called multiple times)
     #   example 'server --background'
     def example(text)

data/lib/runfile/runner.rb

@@ -14,7 +14,7 @@ module Runfile
 
     attr_accessor :last_usage, :last_help, :name, :version, 
       :summary, :namespace, :superspace, :actions, :examples, :options, 
-      :params
+      :params, :env_vars
 
     # Initialize all variables to sensible defaults.
     def initialize
@@ -26,6 +26,7 @@ module Runfile
       @options  = {}        # dsl: option
       @params   = {}        # dsl: param
       @examples = []        # dsl: example
+      @env_vars = {}        # dsl: env_var
       @name     = "Runfile" # dsl: name
       @version  = false     # dsl: version
       @summary  = false     # dsl: summary
@@ -48,7 +49,7 @@ module Runfile
 
     # Add an action to the @actions array, and use the last known
     # usage and help messages sent by the DSL.
-    def add_action(name, altname=nil, &block)
+    def add_action(name, altname = nil, &block)
       if @last_usage.nil?
         @last_usage = altname ? "(#{name}|#{altname})" : name 
       end
@@ -68,19 +69,26 @@ module Runfile
     end
 
     # Add an option flag and its help text.
-    def add_option(flag, text, scope=nil)
-      scope or scope = 'Options'
+    def add_option(flag, text, scope = nil)
+      scope ||= 'Options'
       @options[scope] ||= {}
       @options[scope][flag] = text
     end
 
     # Add a patameter and its help text.
-    def add_param(name, text, scope=nil)
-      scope or scope = 'Parameters'
+    def add_param(name, text, scope = nil)
+      scope ||= 'Parameters'
       @params[scope] ||= {}
       @params[scope][name] = text
     end
 
+    # Add env_var command.
+    def add_env_var(name, text, scope = nil)
+      scope ||= 'Environment Variables'
+      @env_vars[scope] ||= {}
+      @env_vars[scope][name] = text
+    end
+
     # Add example command.
     def add_example(command)
       @examples << (@namespace ? "#{@namespace} #{command}" : command)

data/lib/runfile/version.rb

@@ -1,3 +1,3 @@
 module Runfile
-  VERSION = "0.11.1"
+  VERSION = "0.11.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runfile
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.11.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-07 00:00:00.000000000 Z
+date: 2020-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: If Rake and Docopt had a baby