runfile 0.10.3 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db827cdc746062590a265cab368b2dacfbd63ab218b2d3ed64f102778d2f8154
-  data.tar.gz: 24377c69ad88447b525932d8de00b8ad59699edc40a63130338680c64cc56bf4
+  metadata.gz: 1b9025fd4b3e8a2ee35daaeb3b9c058732bfc88fc88891381761b2ee80b8d7fc
+  data.tar.gz: 7586f94445866e5819a7d29667056c7f2cca94ed4b41e448396c17e9964bc474
 SHA512:
-  metadata.gz: 86f0ed22c47f8fcd051dfff82ea0f973ce753f39ed8feefc39e75815c45ccbeb20650ac9c26445e4288435649b64c3372dfb257f8a3675305299bfd08858f3ba
-  data.tar.gz: cdecf28610bc5f0e07e8a549124e5a59820c2740b25d1045861ad8c644d97297e5f2a63e5d3271e3f17dda695f8b38b794c9e10c586bba5cd90e5c8da5b807ef
+  metadata.gz: 87af85bbce27734b356fee01ed2097d5f77fc9fdc2f44f251cf5ccb07562944bc53c9b52c30602d0b991e5c6b9eb03ddb8195b23923812d4184bd5164cec9401
+  data.tar.gz: d3ac178489ca8e8a3a99090d035e2d57cf55d5f93a8199d18a7ac9150d27d2ac48b1c4d70b1d45f9cf2b79f55327aeb1847b0f4a9ae73749cf787ea47b90bb58

data/lib/runfile/docopt_helper.rb

@@ -22,6 +22,7 @@ module Runfile
       @summary    = options.summary
       @actions    = options.actions
       @options    = options.options
+      @params     = options.params
       @examples   = options.examples
     end
 
@@ -35,6 +36,7 @@ module Runfile
       doc += docopt_usage
       doc += docopt_commands width
       doc += docopt_options width
+      doc += docopt_params width
       doc += docopt_examples width
       doc.join "\n"
     end
@@ -74,17 +76,12 @@ module Runfile
       @options['Options'] = {} unless @options['Options']
       @options['Options']['-h --help'] = 'Show this screen'
       @options['Options']['--version'] = 'Show version number' if @version
+      section_block @options, width
+    end
 
-      doc = []
-      @options.each do |scope, values|
-        doc << "#{scope}:"
-        values.each do |flag, text|
-          helpline = "      #{text}"
-          wrapped  = word_wrap helpline, width
-          doc << "  #{flag}\n#{wrapped}\n"
-        end
-      end
-      doc
+    # Return all docopt params for 'Params' section
+    def docopt_params(width)
+      section_block @params, width
     end
 
     # Return all docopt lines for the 'Examples' section
@@ -101,6 +98,21 @@ module Runfile
       doc
     end
 
+    # Return a generic block containing scope section (e.g. "Options"), 
+    # followed by key value paragraphs.
+    def section_block(definitions, width)
+      doc = []
+      definitions.each do |scope, values|
+        doc << "#{scope}:"
+        values.each do |label, text|
+          helpline = "      #{text}"
+          wrapped  = word_wrap helpline, width
+          doc << "  #{label}\n#{wrapped}\n"
+        end
+      end
+      doc
+    end
+
     # Call the docopt handler, which will either return a parsed
     # arguments list, or halt execution and show usage.
     def args(argv)

data/lib/runfile/dsl.rb

@@ -43,6 +43,12 @@ module Runfile
       Runner.instance.add_option flag, text, scope
     end
 
+    # Add a parameter (can be called multiple times)
+    #   param 'FOLDER', 'Folder to copy'
+    def param(name, text, scope=nil)
+      Runner.instance.add_param name, text, scope
+    end
+
     # Set an example command (can be called multiple times)
     #   example 'server --background'
     def example(text)

data/lib/runfile/runner.rb

@@ -13,7 +13,8 @@ module Runfile
     include SettingsMixin
 
     attr_accessor :last_usage, :last_help, :name, :version, 
-      :summary, :namespace, :superspace, :actions, :examples, :options
+      :summary, :namespace, :superspace, :actions, :examples, :options, 
+      :params
 
     # Initialize all variables to sensible defaults.
     def initialize
@@ -23,6 +24,7 @@ module Runfile
       @namespace  = nil     # dsl: command
       @actions  = {}        # dsl: action
       @options  = {}        # dsl: option
+      @params   = {}        # dsl: param
       @examples = []        # dsl: example
       @name     = "Runfile" # dsl: name
       @version  = false     # dsl: version
@@ -72,6 +74,13 @@ module Runfile
       @options[scope][flag] = text
     end
 
+    # Add a patameter and its help text.
+    def add_param(name, text, scope=nil)
+      scope or scope = 'Parameters'
+      @params[scope] ||= {}
+      @params[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.10.3"
+  VERSION = "0.11.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runfile
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.11.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-08 00:00:00.000000000 Z
+date: 2018-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole