mister_bin 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a2ff2144e3c182ac75eee0201e1fb2c709d070174b3f1d6d3474b4fc2996f2d
-  data.tar.gz: 342666c56d570caa2c791ebf9e3fb259b35c6a94f5c348c6cec168ef381d8c86
+  metadata.gz: dda05692e69025b3954d900c2a4165182edfdbce33d57966c69ad5ad41a207b7
+  data.tar.gz: 75b901c5d0d99755caf324270e77a5dee2b20aa1e0dc6740434622ad514c9d52
 SHA512:
-  metadata.gz: 276954e4955705da9a9eed20b1fe803cf702603b35141ebc096cee16537b3adf39b6aec29abeaa36ac0b10e084b7cf998ccd067bc9aca90cb50bef21edf91484
-  data.tar.gz: b9ee0f5d12e13da32eef957066071b6bafaba92a9edc59ddd7d6f73a83c1b9e9be9406ae7d9664958ee6037d77710480a46daf923c4be6fb76563bce64363551
+  metadata.gz: 1ae92daf8a5617295a8a68f423e7f2c4b84aa1a6014e524b6a9b0fc922a7f13621d6f42e408e0dc5e34871690a51a80514b2ff400efa2517aebda748d6ee402a
+  data.tar.gz: feb0cd9a946998acd8bc5255330e037712a1c58ca500648127860a28bff6a0682d3326fa3bf9f603b03b9d541c0fa76434c5284c5b14fad82502752bc59a8af9

data/lib/mister_bin/command.rb

@@ -7,17 +7,13 @@ module MisterBin
 
     attr_reader :args
 
-    def initialize(args)
+    def initialize(args = nil)
       @args = args
     end
 
     class << self
-      def description
-        maker.summary || maker.help || ''
-      end
-
       def execute(argv=[])
-        args = Docopt.docopt docopt, version: maker.version, argv: argv
+        args = Docopt.docopt docopt, version: meta.version, argv: argv
         instance = new args
         target = find_target_command instance, args
         exitcode = instance.send target
@@ -31,50 +27,50 @@ module MisterBin
       # DSL
 
       def summary(text)
-        maker.summary = text
+        meta.summary = text
       end
 
       def help(text)
-        maker.help = text
+        meta.help = text
       end
 
       def version(text)
-        maker.version = text
+        meta.version = text
       end
 
       def usage(text)
-        maker.usages << text
+        meta.usages << text
       end
 
       def option(flags, text)
-        maker.options << [flags, text]
+        meta.options << [flags, text]
       end
 
       def command(name, text)
         target_commands << name.to_sym
-        maker.commands << [name, text]
+        meta.commands << [name, text]
       end
 
       def param(param, text)
-        maker.params << [param, text]
+        meta.params << [param, text]
       end
 
       def example(text)
-        maker.examples << text
+        meta.examples << text
       end
 
       def environment(name, value)
-        maker.env_vars << [name, value]
+        meta.env_vars << [name, value]
       end
 
-    protected
-
-      def maker
-        @maker ||= DocoptMaker.new
+      def meta
+        @meta ||= CommandMeta.new
       end
 
+    protected
+
       def docopt
-        maker.docopt
+        meta.docopt
       end
 
     private
@@ -92,6 +88,5 @@ module MisterBin
       end
 
     end
-
   end
 end

data/lib/mister_bin/{docopt_maker.rb → command_meta.rb}

@@ -2,9 +2,9 @@ require 'colsole'
 
 module MisterBin
 
-  # This singleton class is responsible for generating a text string ready to be used
-  # by Docopt. 
-  class DocoptMaker
+  # This class is responsible for holding all the meta data for a command and
+  # for generating a text string ready to be used by Docopt. 
+  class CommandMeta
     include Colsole
 
     attr_reader :usages, :options, :examples, :params, :commands, :env_vars
@@ -27,7 +27,15 @@ module MisterBin
         options_string, params_string, env_string, examples_string].compact.join "\n"
     end
 
-    private
+    def description
+      summary || help || ''
+    end
+
+    def long_description
+      summary && help ? "#{summary}\n\n#{help}" : description
+    end
+
+  private
 
     def summary_string
       summary ? word_wrap(summary) + "\n" : nil
@@ -97,5 +105,6 @@ module MisterBin
 
       result.join "\n"
     end
+
   end
-end
+end

data/lib/mister_bin/runner.rb

@@ -27,7 +27,9 @@ module MisterBin
         handler.execute argv
       elsif argv.empty?
         show_subs
-      elsif argv == ['--version'] and version
+      elsif argv == ['--help'] or argv == ['-h']
+        show_help
+      elsif version and (argv == ['--version'] or argv == ['-v'])
         puts version
         return 1
       else
@@ -75,7 +77,7 @@ module MisterBin
       
       say "Commands:"
       commands.each do |key, command|
-        summary = command.description
+        summary = command.meta.description
         summary = summary[0..max_summary_size].strip
         say "  !bldgrn!#{key.ljust longest_key}  !txtrst!#{summary}"
       end
@@ -83,5 +85,28 @@ module MisterBin
       say "\n#{footer}" if footer
     end
 
+    def show_help
+      if commands.empty?
+        say "No subcommands found"
+      else
+        show_help!
+      end
+
+      return 1
+    end
+
+    def show_help!
+      say "#{header}\n" if header
+
+      commands.each do |key, command|
+        say "!bldgrn!#{key}"
+        say word_wrap "  #{command.meta.long_description}"
+        say ""
+      end
+
+      say "#{footer}" if footer
+    end
+
+
   end
 end

data/lib/mister_bin/version.rb

@@ -1,3 +1,3 @@
 module MisterBin
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/lib/mister_bin.rb

@@ -1,5 +1,5 @@
 require 'mister_bin/command'
-require 'mister_bin/docopt_maker'
+require 'mister_bin/command_meta'
 require 'mister_bin/runner'
 
 require 'byebug' if ENV['BYEBUG']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mister_bin
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-13 00:00:00.000000000 Z
+date: 2018-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -47,7 +47,7 @@ files:
 - README.md
 - lib/mister_bin.rb
 - lib/mister_bin/command.rb
-- lib/mister_bin/docopt_maker.rb
+- lib/mister_bin/command_meta.rb
 - lib/mister_bin/runner.rb
 - lib/mister_bin/version.rb
 homepage: https://github.com/dannyben/mister_bin