mister_bin 0.7.5 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 913595208325759296ef5f3d504d5980d0c2f9083f5b25ef49eccdc4679231a4
-  data.tar.gz: 147428144596b31f175e0e92495479c6eb0b49e73187e0de7b1daba2d477f2f5
+  metadata.gz: b8b37499324199dee43edefc92606a2a697ce9dd132c6ef11803a6037e259c23
+  data.tar.gz: 5bd2375c5eea1a0a936cdbde439d8864975bc068ab61ac24a79f6c52ef2987a8
 SHA512:
-  metadata.gz: 5c39bd237a0930017599d9832bdaebd7396f2727500f486bfd56b8b743d89e89990f428cf258ddf8c7330ff190e6655b02d229cfe1da5ff003470431c7744b3d
-  data.tar.gz: e1372df188c909c7e1a0d6e49513d63e64c4d07f98db07d0967eadca1c98b2f428726685d429739e1ab65ca5e3f7513bf99367e619151e395d7258967997eaed
+  metadata.gz: e31a33f9192da8ad523bc29a299bc373d39dcedbc8dc96d39e4a90e748a5e4321189eaea462a1823ee88226f2d22bcebf8fab05cfca5850219ef9d2fb094560b
+  data.tar.gz: 97c81e608bc71af98922ce740792dc0ee0d235a1dca08c18f6383fe9aa87a23d0d09cb620c564ad3066cd848d0918a0c499e1e43075205058b18051cf8bf9f4f

data/README.md

@@ -1,5 +1,4 @@
-Mister Bin
-==================================================
+# Mister Bin
 
 [![Gem Version](https://badge.fury.io/rb/mister_bin.svg)](https://badge.fury.io/rb/mister_bin)
 [![Build Status](https://github.com/DannyBen/mister_bin/workflows/Test/badge.svg)](https://github.com/DannyBen/mister_bin/actions?query=workflow%3ATest)
@@ -12,55 +11,32 @@ interfaces for your gem or other Ruby application.
 
 ---
 
-Contents
---------------------------------------------------
-
-* [Installation](#installation)
-* [Feature Highlights](#feature-highlights)
-* [Examples](#examples)
-* [Usage](#usage)
-* [Creating the Main Executable](#creating-the-main-executable)
-   * [Runner Options](#runner-options)
-   * [Runner Routes](#runner-routes)
-* [Creating Commands](#creating-commands)
-   * [Command DSL](#command-dsl)
-* [Interactive Terminal](#interactive-terminal)
-   * [Terminal features](#terminal-features)
-   * [Terminal options](#terminal-options)
-* [In the Wild](#in-the-wild)
-
-
-
-Installation
---------------------------------------------------
-
-    $ gem install mister_bin
-
+## Installation
 
+```
+$ gem install mister_bin
+```
 
-Feature Highlights
---------------------------------------------------
+## Feature Highlights
 
 - Easy to use and minimalistic DSL for describing your command line actions.
 - Each command is defined with a separate class for maximum testability and 
   scalability.
 - Commands can have subcommands.
-- Designed for gem developers.
-
+- Commands can have aliases.
+- Designed primarily for gem developers.
 
+## Examples
 
-Examples
---------------------------------------------------
+This screencast shows the command line output of several Ruby gems that were
+created with Mister Bin:
 
-![Demo](https://raw.githubusercontent.com/DannyBen/mister_bin/master/demo/demo.gif)
+![Demo](support/demo/cast.gif)
 
 - See the [examples](/examples) folder for several example use cases.
 - For real world examples, see the [In the Wild](#in-the-wild) section.
 
-
-
-Usage
---------------------------------------------------
+## Usage
 
 Creating a command line utility with Mister Bin involves at least two files:
 
@@ -75,10 +51,7 @@ input, and if it finds one and one only, it will execute it. For example,
 if you have a `server` command, you can execute it with `yourapp s` if it
 is the only command that starts with an `s`.
 
-
-
-Creating the Main Executable
---------------------------------------------------
+## Creating the Main Executable
 
 The main executable is usually simple and only serves to initialize Mister 
 Bin with options.
@@ -152,6 +125,15 @@ runner.route 'greet', to: GreetCommand
 runner.route 'config', to: ConfigCommand
 ```
 
+The first argument to the `route` method can be an array. In this case, the
+first element of the array will be considered the primary command name, and the
+other elements will be considered aliases.
+
+```ruby
+runner = MisterBin::Runner.new
+runner.route %w[dir ls list], to: DirCommand
+```
+
 If you wish to route all commands to the same class, you can use:
 
 ```ruby
@@ -166,10 +148,7 @@ runner = MisterBin::Runner.new
 runner.route_all to: GlobalCommand
 ```
 
-
-
-Creating Commands
---------------------------------------------------
+## Creating Commands
 
 Create command classes by inheriting from `MisterBin::Command`, for example:
 
@@ -182,7 +161,7 @@ class GreetCommand < MisterBin::Command
   param "NAME", "The recipient of the greeting"
 
   def run
-    # args hash is available everywhere in the calss
+    # args hash is available everywhere in the class
     name = args['NAME'] || 'Luke'
     puts "#{name}... I am your father..."
   end
@@ -240,14 +219,12 @@ example "app ls"
 example "app ls --all"
 ```
 
+## Interactive Terminal
 
-
-Interactive Terminal
---------------------------------------------------
 Mister Bin comes with an interactive terminal that allows you to set up a
 console that sends all commands to your runner.
 
-![Demo](https://raw.githubusercontent.com/DannyBen/mister_bin/master/demo/terminal.gif)
+![Demo](support/demo/terminal.gif)
 
 See the [terminal example](/examples/06-terminal) folder.
 
@@ -276,7 +253,7 @@ terminal.start
 The `MisterBin::Terminal.new` command accepts an optional second argument. If 
 provided, it should be a options hash:
 
-```
+```ruby
 terminal = MisterBin::Terminal.new runner, {
   header: "Welcome",
   autocomplete: %w[--help greet]
@@ -288,7 +265,7 @@ commands that are not handled by your runner. For example, this piece of code
 will capture the `/cd ...` command from the terminal and pass it to your 
 block:
 
-```
+```ruby
 terminal = MisterBin::Terminal.new runner
 terminal.on '/cd' do |args|
   Dir.chdir args[0] if args[0]
@@ -340,8 +317,7 @@ If true, commands that start with `/` will *not* be delegated to the stsrem.
 Default: `false`.
 
 
-In the Wild
---------------------------------------------------
+## In the Wild
 
 Several examples of real world use of Mister Bin in the wild (well, 
 "In the Back Yard" really...).
@@ -351,16 +327,18 @@ Several examples of real world use of Mister Bin in the wild (well,
 - [Jobly] - Compact job server with API, CLI and Web UI
 - [Kojo] - Command line utility for generating config files from templates and definition files
 - [Madman] - The Markdown Swiss Army Knife
+- [Madness] - Instant Markdown Server
 - [Slacktail] - Command line utility for following your Slack chat from the terminal
 - [Site Link Analyzer] - Command line utility for finding broken links in a site
 
 
-[docopt]: http://docopt.org/
-[Kojo]: https://github.com/DannyBen/kojo
-[Madman]: https://github.com/DannyBen/madman
 [AudioAddict]: https://github.com/DannyBen/audio_addict
+[Bashly]: https://github.com/DannyBen/bashly
 [Colsole]: https://github.com/dannyben/colsole
+[docopt]: http://docopt.org/
 [Jobly]: https://github.com/dannyben/jobly
-[Slacktail]: https://github.com/dannyben/slacktail
+[Kojo]: https://github.com/DannyBen/kojo
+[Madman]: https://github.com/DannyBen/madman
+[Madness]: https://github.com/DannyBen/madness
 [Site Link Analyzer]: https://github.com/dannyben/sla
-[Bashly]: https://github.com/DannyBen/bashly
+[Slacktail]: https://github.com/dannyben/slacktail

data/lib/mister_bin/command.rb

@@ -18,7 +18,7 @@ module MisterBin
       exitcode.is_a?(Numeric) ? exitcode : 0
     rescue DocoptNG::Exit => e
       puts e.message
-      1
+      e.exit_code
     end
 
     class << self

data/lib/mister_bin/runner.rb

@@ -1,4 +1,5 @@
 require 'colsole'
+require 'debug'
 
 module MisterBin
   class Runner
@@ -15,7 +16,13 @@ module MisterBin
     end
 
     def route(key, to:)
-      commands[key] = to
+      if key.is_a? Array
+        target = key.shift
+        commands[target] = to
+        key.each { |alias_name| aliases[alias_name] = target }
+      else
+        commands[key] = to
+      end
     end
 
     def route_all(to:)
@@ -30,13 +37,16 @@ module MisterBin
       elsif (argv == ['--help']) || (argv == ['-h'])
         show_help
       elsif version && ((argv == ['--version']) || (argv == ['-v']))
-        puts version
-        1
+        show_version
       else
         execute argv
       end
     end
 
+    def aliases
+      @aliases ||= {}
+    end
+
   private
 
     def execute(argv)
@@ -55,11 +65,25 @@ module MisterBin
       command = argv[0]
       return argv if commands.has_key? command
 
-      candidates = commands.keys.grep(/^#{command}/)
-      argv[0] = candidates.first if candidates.count == 1
+      argv[0] = find_target_command argv[0]
       argv
     end
 
+    def find_target_command(input)
+      candidates = commands.keys.grep(/^#{input}/)
+      return candidates.first if candidates.count == 1
+
+      candidates = aliases.keys.grep(/^#{input}/)
+      return aliases[candidates.first] if candidates.count == 1
+
+      input
+    end
+
+    def show_version
+      puts version
+      0
+    end
+
     def show_subs
       if commands.empty?
         say 'No subcommands found'
@@ -89,11 +113,11 @@ module MisterBin
     def show_help
       if commands.empty?
         say 'No subcommands found'
+        1
       else
         show_help!
+        0
       end
-
-      1
     end
 
     def show_help!

data/lib/mister_bin/version.rb

@@ -1,3 +1,3 @@
 module MisterBin
-  VERSION = '0.7.5'
+  VERSION = '0.8.0'
 end

data/lib/mister_bin.rb

@@ -1,6 +1,6 @@
-require 'mister_bin/command'
-require 'mister_bin/command_meta'
-require 'mister_bin/runner'
-require 'mister_bin/terminal'
-
-require 'byebug' if ENV['BYEBUG']
+module MisterBin
+  autoload :Command, 'mister_bin/command'
+  autoload :CommandMeta, 'mister_bin/command_meta'
+  autoload :Runner, 'mister_bin/runner'
+  autoload :Terminal, 'mister_bin/terminal'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mister_bin
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.8.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-10 00:00:00.000000000 Z
+date: 2024-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -37,6 +37,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,6 +47,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.1
 description: Easily add command line interface to your gems
 email: db@dannyben.com
 executables: []
@@ -61,8 +67,11 @@ homepage: https://github.com/dannyben/mister_bin
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/DannyBen/mister_bin/issues
+  changelog_uri: https://github.com/DannyBen/mister_bin/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/DannyBen/mister_bin
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -70,15 +79,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key: 
+rubygems_version: 3.5.23
+signing_key:
 specification_version: 4
 summary: Command line interface for your gems
 test_files: []