mister_bin 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9ead1a61f1fa10257fdada263fe53831d50eb347cb72511b9a84380f22c1fa0
-  data.tar.gz: 98d279539bbcefe16e28a29d8106fbac79613ce6eb9a8adf80359a7204c5933c
+  metadata.gz: 7d02c3dbeffc01ef74b5352108585791cfc5abcece9071c1b28fe1ea621809f5
+  data.tar.gz: 207c687438a4c780a28b71bae3e6669db003239ed5d1eb565258f03a260638c0
 SHA512:
-  metadata.gz: c43175939978e46c952ca8d89b02111e8a5f6c001d1c973e6c18bed8da09cc81d2aa3fbb186896bf94bc0d7459d050ecac7972aefa899803f18282b9740110e0
-  data.tar.gz: 977f09d4e624c8870c0011a22d4cf6143751246b21b0dcdc19e81a225c6400abdb0e8e6fff4bb82d1c9a1c5c91cc05341c8a242d7e564017f5dbaf6661f08fa0
+  metadata.gz: 8684082e9172f1f80e03992637f3b2248e802e7ba4f52309a615f95b3d4eca9a82005f54a91b8b073256a15358be563c4947dd4329919450591421b33eb79d2b
+  data.tar.gz: 7a28ea5141dd993b8ca3ab4b4d903f3922d555ca264c0fa24a9cbea42f4a9b84a8759c8470fe47d8ffcdd1fa4edd1275599026eedb38483ab3023539c96fd270

data/README.md

@@ -205,8 +205,11 @@ The below example outlines all available DSL commands.
 
 
 ```ruby
+# Optional summary string
+summary "A short sentence or paragraph describing the command"
+
 # Optional help string
-help "A short sentence or paragraph describing the command"
+help "A longer explanation can go here"
 
 # Version string for the command
 version "0.1.1"

data/lib/mister_bin/command.rb

@@ -13,7 +13,7 @@ module MisterBin
     end
 
     def metadata
-      script.evaluate
+      script.metadata
     end
 
     private

data/lib/mister_bin/docopt_maker.rb

@@ -8,24 +8,29 @@ module MisterBin
     include Colsole
 
     attr_reader :usages, :options, :examples, :params
-    attr_accessor :help, :version
+    attr_accessor :summary, :help, :version
 
     def initialize
-      @usages = []
-      @options = []
-      @params = []
+      @version  = '0.0.0'
+      @help     = nil
+      @summary  = nil
+      @usages   = []
+      @options  = []
+      @params   = []
       @examples = []
-      @version = '0.0.0'
-      @help = nil
     end
 
     def docopt
-      [help_string, usage_string, options_string, 
+      [summary_string, help_string, usage_string, options_string, 
         params_string, examples_string].compact.join "\n"
     end
 
     private
 
+    def summary_string
+      summary ? word_wrap(summary) + "\n" : nil
+    end
+
     def help_string
       help ? word_wrap(help) + "\n" : nil
     end

data/lib/mister_bin/script.rb

@@ -15,35 +15,32 @@ module MisterBin
 
     def execute(argv=[])
       build_docopt
-      args = Docopt.docopt docopt, version: maker.version, argv: argv
-      exitcode = action_block.call args if action_block
-      exitcode.is_a?(Numeric) ? exitcode : 0
+      execute! argv
     rescue Docopt::Exit => e
       puts e.message
       1
     end
 
-    def evaluate
-      instance_eval script
-      metadata
-    end
-
     def docopt
       maker.docopt
     end
 
     def metadata
-      { summary: help, version: version }
+      @metadata ||= metadata!
     end
 
     # DSL
 
-    def help(text=nil)
-      text ? maker.help = text : maker.help
+    def summary(text)
+      maker.summary = text
+    end
+
+    def help(text)
+      maker.help = text
     end
 
-    def version(text=nil)
-      text ? maker.version = text : maker.version
+    def version(text)
+      maker.version = text
     end
 
     def usage(text)
@@ -68,6 +65,21 @@ module MisterBin
 
     private
 
+    def metadata!
+      instance_eval script
+
+      { 
+        summary: (maker.summary || maker.help), 
+        version: maker.version 
+      }
+    end
+
+    def execute!(argv)
+      args = Docopt.docopt docopt, version: maker.version, argv: argv
+      exitcode = action_block.call args if action_block
+      exitcode.is_a?(Numeric) ? exitcode : 0
+    end
+
     def build_docopt
       @maker = nil
       instance_eval script

data/lib/mister_bin/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mister_bin
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Danny Ben Shitrit