mister_bin 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df7d632c9b2d36ebd6cd52b961d4f690868575234528fa77c563e2766d4449b2
-  data.tar.gz: 8fef21a944ed08a965139c21ce96bf2560f1acfd0016b076345cd113d70933df
+  metadata.gz: 544ea89862e3731beab20f7a6e180109377fbf4ee428dc87577f4315d9d4656e
+  data.tar.gz: b911335298d0939f37fd7c515c573f15f5b4a84b07935fa04bdce34427cb3bd3
 SHA512:
-  metadata.gz: 48f0fc73b3731e339e4d131df19519c203b2ce8f1e9030323867eac715fe21793d9be8193675376a6538783a1bbbadfb1c4af40fce5076377f81a5ba1a3f82cd
-  data.tar.gz: 49f22c1ec956275a8c3c8a0681d9fc324e147db4595dea3681b5bc85212933a78738833b57dfa8eaa7221219f4dad172578c9726ea52d96cd38df0d9ca2dc2b1
+  metadata.gz: 9ada4970fd1a7a1de6ad509e537e97fe8a2544d6c1594205d0921e18988ce6a536d9c3e6833fd2817b1951efeb1808b4bd5484734860a8dcf3807bfd259df050
+  data.tar.gz: 4df60533f5e1935911e9827f742978583256841be72667da39b79586e58ba1ad8cdc87adce4e529ea0f626b70f44bef04d1b9fb3f82f40d0fe8a7691a0193f17

data/README.md

@@ -15,15 +15,17 @@ A command line framework for adding command line utilities to your gems.
 Contents
 --------------------------------------------------
 
-* [Contents](#contents)
 * [Installation](#installation)
 * [Design Goals](#design-goals)
-* [Example](#example)
+* [Examples](#examples)
 * [Usage](#usage)
 * [Creating the Main Executable](#creating-the-main-executable)
-    * [Runner Options](#runner-options)
+   * [Runner Options](#runner-options)
+   * [Runner Routes](#runner-routes)
 * [Creating Commands](#creating-commands)
-    * [Command DSL](#command-dsl)
+   * [Command DSL](#command-dsl)
+* [In the Wild](#in-the-wild)
+
 
 
 Installation
@@ -37,8 +39,6 @@ Design Goals
 --------------------------------------------------
 
 - Provide an easy and minimalistic DSL for building command line utilities.
-- Drastically reduce the need for boilerplate code and unnecessary wrappers 
-  involved in building command line utilities.
 - Provide a mechanism for separating each command and subcommand to its 
   own file.
 - Allow gem developers to easily add command line interface to their gems.
@@ -46,10 +46,10 @@ Design Goals
 
 
 
-Example
+Examples
 --------------------------------------------------
 
-See the [example](/example) folder.
+See the [example](/example) folder for several example use cases.
 
 
 
@@ -105,6 +105,19 @@ Text to display before the list of commands.
 
 Text to display after the list of commands.
 
+#### `commands`
+
+A hash of `{ 'regex' => ClassName }` to serve as command routes.
+This is equivalent to adding routes later with 
+`runner.route 'regex', to: ClassName`.
+
+
+#### `handler`
+
+Provide a single handler to all commands. When this is provided, `commands`
+are ignored.
+This is equivalent to using `runner.route_all to: ClassName`.
+
 
 ### Runner Routes
 
@@ -128,6 +141,20 @@ runner.route 'config init', to: ConfigInitializerCommand
 runner.route 'config show', to: ConfigDisplayerCommand
 ```
 
+If you wish to route all commands to the same class, you can use:
+
+```ruby
+runner = MisterBin::Runner.new
+runner.route_all to: <Class Name>
+```
+
+for example:
+
+```ruby
+runner = MisterBin::Runner.new
+runner.route_all to: GlobalCommand
+```
+
 
 Creating Commands
 --------------------------------------------------
@@ -192,13 +219,19 @@ environment "SECRET", "There is no spoon"
 # Provide examples
 example "app ls"
 example "app ls --all"
-
-# Define the actual action to execute when the command is called
-# All arguments will be provided to your block.
-action do |args|
-  puts args['--all'] ? "success --all" : "success"
-end
 ```
 
 
+In the Wild
+--------------------------------------------------
+
+Several examples of real world use of Mister Bin in the wild (well, 
+"In the Back Yard" really...).
+
+- [Kojo][2] - Command line utility for generating config files from templates and definition files
+- [Madman][3] - The Markdown Swiss Army Knife
+
+
 [1]: http://docopt.org/
+[2]: https://github.com/DannyBen/kojo
+[3]: https://github.com/DannyBen/madman

data/lib/mister_bin/command.rb

@@ -1,7 +1,10 @@
 require 'docopt'
+require 'colsole'
 
 module MisterBin
   class Command
+    include Colsole
+
     class << self
       def description
         maker.summary || maker.help || ''

data/lib/mister_bin/runner.rb

@@ -4,21 +4,28 @@ module MisterBin
   class Runner
     include Colsole
 
-    attr_reader :header, :footer, :version, :commands
+    attr_reader :header, :footer, :version, :commands, :handler
 
     def initialize(opts={})
       @header = opts[:header]
       @footer = opts[:footer]
       @version = opts[:version]
       @commands = opts[:commands] || {}
+      @handler = opts[:handler]
     end
 
-    def route(key, to: )
+    def route(key, to:)
       commands[key] = to
     end
 
+    def route_all(to:)
+      @handler = to
+    end
+
     def run(argv=[])
-      if argv.empty?
+      if handler
+        handler.execute argv
+      elsif argv.empty?
         show_subs
       elsif argv == ['--version'] and version
         puts version

data/lib/mister_bin/version.rb

@@ -1,3 +1,3 @@
 module MisterBin
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

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