runfile 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0980ca227f78853f3dcf034253d57a0ac61f5cc0
-  data.tar.gz: c5548ead96c34f0dbcfa59a48d64153463b5b75e
+  metadata.gz: 7b0ef66864e2ac38cb60c3c8f78b0641143ebe67
+  data.tar.gz: 73af9361c6dee752c2d819b4215326e890782cb5
 SHA512:
-  metadata.gz: 1a960d00b7663752bb7e6f7264323c2d5e654fac533f391dc54c1dcced5e1aa9e171e7cd55f199855fe908e64660b2680d5aa63c646aeffd2c252ae2c119d223
-  data.tar.gz: 367511ebf703bb821a5acec2742e8371d0459e0f7adbb4998871cf40044792aa5646be49b06993ab82588aa060c3d42c7ebcde59e97d57a4bec56198a09ca5fe
+  metadata.gz: 0b59e0ae90280031242a8b10f5705538a45a644d239c200429867aa9d1f717c6f992abad6e3fd249aca8fb4d65408268b46d2147fbed60071012535afeda48bd
+  data.tar.gz: 78e11e620be2aace4511e0402b2fe2c228374de9f11601716fd18cfcf0d075942b834bbdb2cdd8627351c5f2360a164a80bcbca844db3adb286fde2232d0737a

data/lib/runfile/docopt_helper.rb

@@ -16,13 +16,14 @@ module Runfile
     # The superspace argument will be the name of runfile, in case we
     # are running a named.runfile. It is only needed to generate the 
     # proper `run superspace (-h|--help|--version)` line
-    def initialize(superspace, name, version, summary, actions, options)
+    def initialize(superspace, name, version, summary, actions, options, examples)
       @superspace = superspace
       @name       = name
       @version    = version
       @summary    = summary
       @actions    = actions
       @options    = options
+      @examples   = examples
     end
 
     # Generate a document based on all the actions, help messages
@@ -35,6 +36,7 @@ module Runfile
       doc += docopt_usage
       doc += docopt_commands width
       doc += docopt_options width
+      doc += docopt_examples width
       doc.join "\n"
     end
 
@@ -86,6 +88,21 @@ module Runfile
       doc
     end
 
+    # Return all docopt lines for the 'Examples' section
+    def docopt_examples(width)
+      return [] if @examples.empty?
+
+      doc = ["Examples:"]
+      base_command = @superspace ? "run #{@superspace}" : "run"
+      @examples.each do |command|
+        helpline = "  #{base_command} #{command}"
+        wrapped  = word_wrap helpline, width
+        doc << "#{wrapped}"
+      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

@@ -35,6 +35,11 @@ module Runfile
     Runner.instance.add_option flag, text, scope
   end
 
+  # Set an example command (can be called multiple times)
+  def example(text)
+    Runner.instance.add_example text
+  end
+
   # Define the action
   def action(name, altname=nil, &block) 
     Runner.instance.add_action name, altname, &block

data/lib/runfile/runner.rb

@@ -16,15 +16,16 @@ module Runfile
 
     # Initialize all variables to sensible defaults.
     def initialize
-      @superspace = nil    # used when filename != Runfile
-      @last_usage = nil    # dsl: usage
-      @last_help  = nil    # dsl: help
-      @namespace  = nil    # dsl: command
-      @actions = {}        # dsl: action
-      @options = {}        # dsl: option
-      @name    = "Runfile" # dsl: name
-      @version = false     # dsl: version
-      @summary = false     # dsl: summary
+      @superspace = nil     # used when filename != Runfile
+      @last_usage = nil     # dsl: usage
+      @last_help  = nil     # dsl: help
+      @namespace  = nil     # dsl: command
+      @actions  = {}        # dsl: action
+      @options  = {}        # dsl: option
+      @examples = []        # dsl: example
+      @name     = "Runfile" # dsl: name
+      @version  = false     # dsl: version
+      @summary  = false     # dsl: summary
     end
 
     # Return a singleton Runner instance.
@@ -72,6 +73,11 @@ module Runfile
       @options[scope][flag] = text
     end
 
+    # Add example command.
+    def add_example(command)
+      @examples << command
+    end
+
     # Run the command. This is a wrapper around docopt. It will 
     # generate the docopt document on the fly, using all the 
     # information collected so far.
@@ -103,7 +109,7 @@ module Runfile
     # This should always be called in a begin...rescue block and
     # you should handle the Docopt::Exit exception.
     def docopt_exec(argv)
-      helper = DocoptHelper.new(@superspace, @name, @version, @summary, @actions, @options)
+      helper = DocoptHelper.new(@superspace, @name, @version, @summary, @actions, @options, @examples)
       args   = helper.args argv
       action = find_action argv
       action or abort "Runfile error: Action not found"

data/lib/runfile/version.rb

@@ -1,3 +1,3 @@
 module Runfile
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runfile
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-01 00:00:00.000000000 Z
+date: 2015-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole