mister_bin 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 145d72d39990c48d376b0090537d3ddd682ea2288fdea8ef96028f0745ecd60d
-  data.tar.gz: bc3bc649a79b06e746a260d7d0e0c19c973b3c29cf76bf966b4f621b261743c5
+  metadata.gz: 4855be0420ff86441a00e588e967c8b2853b421a29965fd834a565867889c9c6
+  data.tar.gz: 3091bd565021ec3e53e42b33f5a6bbde9ae204f15bc8afb30a9b1fd3bf233c2d
 SHA512:
-  metadata.gz: 0e83d1905b8bfdc7e9d1e66a402fc3eaaf87ecf8a240a535d08a4b1d67b11b76062fcd78b2df06c84cae1a738c866fa0ab5081413f83fec5b70a64fb386de7f4
-  data.tar.gz: 7e1a2a406f3245786f36d2662532e17976f4e5f0b348febf303ef65b5f13c00b35465be6e9c86aa6ba9aa3304b13440a24d244cf3fd1a75e940af16a464ba33a
+  metadata.gz: f58f8e52666cd8461f500d19165271d349871ec7d7bdb6f3b10104097ae3657d3055ce79b67bed4d30c1221ed0720b5d14a8ccd0bef0769dc57f73aafbb11632
+  data.tar.gz: 5e67542db23b0ff6d65307d702f5559259fd8f7ee645977d961d5791f023e375777553250cf470d7cc2fa10595bae165ea8e228443cccec20a94efbdac241585

data/README.md

@@ -27,6 +27,13 @@ Design Goals
 
 
 
+Example
+--------------------------------------------------
+
+See the [example](/example) folder.
+
+
+
 Usage
 --------------------------------------------------
 
@@ -105,7 +112,7 @@ require 'mister_bin'
 exit MisterBin::Runner.run __FILE__, ARGV
 ```
 
-This code will start the execution chain based on the arguments provided 
+It will start the execution chain based on the arguments provided 
 when running it.
 
 The `Runner.run` method requires two parameters:
@@ -114,6 +121,21 @@ The `Runner.run` method requires two parameters:
    need).
 2. An array of arguments (usually `ARGV` is what you need).
 
+In addition, you may provide a `header` and a `footer` that will be 
+displayed when executing without arguments:
+
+```ruby
+# git
+#!/usr/bin/env ruby
+require 'mister_bin'
+
+exitcode =  MisterBin::Runner.run __FILE__, ARGV,
+  header: "This is a sample header.",
+  footer: "This is a sample footer."
+
+exit exitcode
+```
+
 
 
 Creating Subcommands

data/lib/mister_bin/runner.rb

@@ -1,13 +1,19 @@
+require 'colsole'
+
 module MisterBin
   class Runner
-    attr_reader :basefile, :basedir, :name
+    include Colsole
+
+    attr_reader :basefile, :basedir, :name, :header, :footer
 
-    def self.run(basefile, argv=[])
-      new(basefile).run argv
+    def self.run(basefile, argv=[], header: nil, footer: nil)
+      new(basefile, header: header, footer: footer).run argv
     end
 
-    def initialize(basefile)
+    def initialize(basefile, header: nil, footer: nil)
       @basefile = basefile
+      @header = header
+      @footer = footer
       @basedir = File.dirname basefile
       @name = File.basename basefile
     end
@@ -28,8 +34,8 @@ module MisterBin
       if command
         execute_command command, argv
       else
-        puts "Unknown command: #{argv[0]}"
-        return 1
+        puts "Unknown command: #{argv[0]}\n\n"
+        show_subs
       end
     end
 
@@ -41,8 +47,10 @@ module MisterBin
       if commands.all.empty?
         puts "No subcommands found"
       else
-        puts "Usage:"
+        say "#{header}\n" if header
+        puts "Commands:"
         commands.names.each { |command| puts "  #{name} #{command}" }
+        say "\n#{footer}" if footer
       end
 
       return 1

data/lib/mister_bin/version.rb

@@ -1,3 +1,3 @@
 module MisterBin
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mister_bin
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-14 00:00:00.000000000 Z
+date: 2018-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole