mister_bin 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d02c3dbeffc01ef74b5352108585791cfc5abcece9071c1b28fe1ea621809f5
-  data.tar.gz: 207c687438a4c780a28b71bae3e6669db003239ed5d1eb565258f03a260638c0
+  metadata.gz: 992b34023bc6042c8e5cada1a4d33674df2fda7856e3d67ec07e3e4607253ad5
+  data.tar.gz: 1943a0338104dcbc63c14a62526d113ad2124443f694536aeec38a650dc49375
 SHA512:
-  metadata.gz: 8684082e9172f1f80e03992637f3b2248e802e7ba4f52309a615f95b3d4eca9a82005f54a91b8b073256a15358be563c4947dd4329919450591421b33eb79d2b
-  data.tar.gz: 7a28ea5141dd993b8ca3ab4b4d903f3922d555ca264c0fa24a9cbea42f4a9b84a8759c8470fe47d8ffcdd1fa4edd1275599026eedb38483ab3023539c96fd270
+  metadata.gz: 5d9454d65eef5a5f1f53ce6198011331ef772fece59fe831f1abb33d616f3e4847f2d6ff40281bb8aa6d50f40ede1616b5f012109df942460c61efb0fa7ea7e8
+  data.tar.gz: 03dfe016fe75b4baa7da4fef059396f3534168ba284033b5037afd715b4e86efbf0461d0972e498828764df9f0b44034d647a570bd01fdd21ba3feede5c86798

data/README.md

@@ -152,6 +152,7 @@ In addition, you can provide an options hash:
 ```ruby
 options = {
   header: 'My command line app'
+  version: '1.2.3',
   footer: 'Use --help for additional info',
   basedir: __dir__, 
   isolate: true
@@ -160,6 +161,10 @@ options = {
 runner = MisterBin::Runner.new 'appname', options
 ```
 
+#### `version`
+
+Version number to display when running the main executable with `--version`.
+
 #### `header`
 
 Text to display before the list of commands.
@@ -211,7 +216,7 @@ summary "A short sentence or paragraph describing the command"
 # Optional help string
 help "A longer explanation can go here"
 
-# Version string for the command
+# Optional version string for the command
 version "0.1.1"
 
 # Usage patterns. You can use either a compact docopt notation, or provide
@@ -229,6 +234,9 @@ option "-f --force", "Force delete"
 # Describe any parameters
 param "NAME", "The name of the repository"
 
+# Describe any environment variables that your app cares about
+environment "SECRET", "There is no spoon"
+
 # Provide examples
 example "app ls"
 example "app ls --all"

data/lib/mister_bin/docopt_maker.rb

@@ -7,22 +7,23 @@ module MisterBin
   class DocoptMaker
     include Colsole
 
-    attr_reader :usages, :options, :examples, :params
+    attr_reader :usages, :options, :examples, :params, :env_vars
     attr_accessor :summary, :help, :version
 
     def initialize
-      @version  = '0.0.0'
+      @version  = nil
       @help     = nil
       @summary  = nil
       @usages   = []
       @options  = []
       @params   = []
       @examples = []
+      @env_vars = []
     end
 
     def docopt
       [summary_string, help_string, usage_string, options_string, 
-        params_string, examples_string].compact.join "\n"
+        params_string, env_string, examples_string].compact.join "\n"
     end
 
     private
@@ -52,22 +53,23 @@ module MisterBin
 
       result << "  -h --help"
       result << "    Show this help\n"
-      result << "  --version"
-      result << "    Show version number\n"
+
+      if version
+        result << "  --version"
+        result << "    Show version number\n"
+      end
+      
       result.join "\n"
     end
 
     def params_string
       return nil if params.empty?
+      key_value_block 'Parameters:', params
+    end
 
-      result = ["Parameters:"]
-      params.each do |param|
-        result << "  #{param[0]}"
-        result << word_wrap("    #{param[1]}")
-        result << ""
-      end
-
-      result.join "\n"
+    def env_string
+      return nil if env_vars.empty?
+      key_value_block 'Environment Variables:', env_vars
     end
 
     def examples_string
@@ -78,5 +80,16 @@ module MisterBin
       result << ""
       result.join "\n"
     end
+
+    def key_value_block(caption, pairs)
+      result = [caption]
+      pairs.each do |key, value|
+        result << "  #{key}"
+        result << word_wrap("    #{value}")
+        result << ""
+      end
+
+      result.join "\n"
+    end
   end
 end

data/lib/mister_bin/runner.rb

@@ -4,7 +4,7 @@ module MisterBin
   class Runner
     include Colsole
 
-    attr_reader :name, :basedir, :header, :footer, :isolate
+    attr_reader :name, :basedir, :header, :footer, :isolate, :version
 
     def initialize(name, opts={})
       @name = name
@@ -12,11 +12,15 @@ module MisterBin
       @footer = opts[:footer]
       @isolate = opts[:isolate]
       @basedir = opts[:basedir]
+      @version = opts[:version]
     end
 
     def run(argv=[])
       if argv.empty?
         show_subs
+      elsif argv == ['--version'] and version
+        puts version
+        return 1
       else
         execute argv
       end

data/lib/mister_bin/script.rb

@@ -59,6 +59,10 @@ module MisterBin
       maker.examples << text
     end
 
+    def environment(name, value)
+      maker.env_vars << [name, value]
+    end
+
     def action(&block)
       @action_block = block
     end

data/lib/mister_bin/version.rb

@@ -1,3 +1,3 @@
 module MisterBin
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mister_bin
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-05 00:00:00.000000000 Z
+date: 2018-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement