mister_bin 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96c54bf11d15090b8bdbde7d3540e768ce4b5ffab47cd30765b4f742b88a3746
-  data.tar.gz: 8915b5fa7b0222d5c09b39e9a530047277b56243b236d8af04a9f0cd36014caf
+  metadata.gz: a3079a8599aeffba78c30871ca736ab6c48dfac513400be8319c493ae24fd576
+  data.tar.gz: 8b1a58023370dffafe99362ad4cddf211d1ea8f3ee5a1a88ca282ed8c68b94ea
 SHA512:
-  metadata.gz: 7529459ac47101bfc86b56569ebf0b680e684f0b94b044db6c39f9194539d4969f5cf244eb44e6f76a75f88cd72f06177898b2c4125ea696536a11182ee392b8
-  data.tar.gz: c6a34bc12c75edabb45fcc0a9c104f1df40d38079c69cfdf5d561768340a9bd2ba05a1b0e4891fa76cee272d4fbeccc9faf75b7e8cb66dbcf9bf8feb3d5d57a5
+  metadata.gz: 8d62bc3efbe561981755ec5b90ffdfb9a3ab6efafbabc5281eb81e9aabbffbeec2c0601e658384aba05c401e5a396f9b0beabd265d36f6d9b1e5ddcdcf6423ea
+  data.tar.gz: 317ea1137fdd923f27995fe933f7a4660579f8ca1e91a301701d5eaae44b54d3f9d2e1984fcc2738d5040d322bbffcb056b8f90f958997f7b939d85e128a3c4a

data/README.md

@@ -4,7 +4,6 @@ Mister Bin
 [![Gem Version](https://badge.fury.io/rb/mister_bin.svg)](https://badge.fury.io/rb/mister_bin)
 [![Build Status](https://travis-ci.com/DannyBen/mister_bin.svg?branch=master)](https://travis-ci.com/DannyBen/mister_bin)
 [![Maintainability](https://api.codeclimate.com/v1/badges/ae82443a99c2839d8ba8/maintainability)](https://codeclimate.com/github/DannyBen/mister_bin/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/ae82443a99c2839d8ba8/test_coverage)](https://codeclimate.com/github/DannyBen/mister_bin/test_coverage)
 
 ---
 
@@ -25,6 +24,9 @@ Contents
    * [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)
 
 
@@ -74,6 +76,7 @@ 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
 --------------------------------------------------
 
@@ -164,6 +167,7 @@ runner.route_all to: GlobalCommand
 ```
 
 
+
 Creating Commands
 --------------------------------------------------
 
@@ -237,6 +241,88 @@ example "app ls --all"
 ```
 
 
+
+Interactive Terminal
+--------------------------------------------------
+Mister Bin comes with an interactive terminal thaht 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)
+
+See the [terminal example](/examples/06-terminal) folder.
+
+In order to start a terminal, you need to provide it with a 
+`MisterBin::Runner` object:
+
+```ruby
+runner = MisterBin::Runner.new 
+runner.route 'greet', to: GreetCommand
+terminal = MisterBin::Terminal.new runner
+terminal.start
+```
+
+### Terminal features
+
+- All commands will be routed to the runner.
+- Customizable autocomplete.
+- Command history (up/down arrows).
+- Start a command with a `/` in order to run a system (shell) command.
+- Type `exit` to quit (or Ctrl+D or Ctrl+C).
+- Customizable header, exit message, exit command and prompt.
+
+
+### Terminal options
+
+The `MisterBin::Terminal.new` command accepts an optional second argument. If 
+provided, it should be a options hash:
+
+```
+terminal = MisterBin::Terminal.new runner, {
+  header: "Welcome",
+  autocomplete: %w[--help greet]
+}
+```
+
+These are the available options. All string options are displayed with 
+the [Colsole][5] `say` command so they support color markers.
+
+#### `header`
+
+Message to show when starting the terminal.
+Default: blank.
+
+#### `show_usage`
+
+If true, the runner will be executed on startup to show its usage patterns.
+Default: `false`.
+
+#### `prompt`
+
+The string for the prompt. Default: `"\n> "`.
+
+#### `autocomplete`
+
+An array of words to autocomplete by pressing Tab.
+Default: none.
+
+#### `exit_message`
+
+The message to show on exit.
+Default: blank.
+
+#### `exit_commands`
+
+An array of commands that if typed, will exit the terminal.
+Default: `["exit", "q"]`.
+
+#### `system_character`
+
+The prefix character that if typed at the beginning of a command, will avoid
+executing the runner, and instead execute a system (shell) command. 
+Default: `"/"`.
+
+
+
 In the Wild
 --------------------------------------------------
 
@@ -247,9 +333,14 @@ Several examples of real world use of Mister Bin in the wild (well,
 - [Madman][3] - The Markdown Swiss Army Knife
 - [Kojo][2] - Command line utility for generating config files from templates 
   and definition files
+- [Jobly][6] - Compact job server with API, CLI and Web UI
+- [Slacktail][7] - Command line utility for following your Slack chat from the terminal
 
 
 [1]: http://docopt.org/
 [2]: https://github.com/DannyBen/kojo
 [3]: https://github.com/DannyBen/madman
 [4]: https://github.com/DannyBen/audio_addict
+[5]: https://github.com/dannyben/colsole
+[6]: https://github.com/dannyben/jobly
+[7]: https://github.com/dannyben/slacktail

data/lib/mister_bin.rb

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

data/lib/mister_bin/terminal.rb

@@ -0,0 +1,107 @@
+require 'readline'
+require 'colsole'
+require 'shellwords'
+
+module MisterBin
+  class Terminal
+    include Colsole
+
+    attr_reader :runner, :options
+
+    def initialize(runner, options=nil)
+      @runner = runner
+      @options = options || {}
+    end
+
+    def start
+      Readline.completion_append_character = " "
+      Readline.completion_proc = autocomplete_handler if autocomplete
+
+      welcome_messages
+      loop { break unless safe_input_loop }
+    end
+
+  private
+
+    def safe_input_loop
+      input_loop
+    # :nocov:
+    rescue Interrupt
+      say exit_message if exit_message
+      false
+    rescue => e
+      puts e.backtrace.reverse if ENV['DEBUG']
+      say! "!txtred!#{e.class}: #{e.message}"
+      true
+    # :nocov:
+    end
+
+    def welcome_messages
+      say header if header
+      runner.run if show_usage
+    end
+
+    def input_loop
+      while input = Readline.readline(prompt, true) do
+        break unless execute input
+      end
+    end
+
+    def execute(input)
+      if exit_commands.include? input
+        say exit_message if exit_message
+        false
+      else
+        execute_command input
+        true
+      end
+    end
+
+    def execute_command(input)
+      command = Shellwords.shellwords input
+
+      if command.first&.start_with? system_character
+        system input[1..-1]
+      else
+        runner.run command
+      end
+    end
+
+    def header
+      @header ||= options[:header]
+    end
+
+    def show_usage
+      options[:show_usage]
+    end
+
+    def prompt
+      @prompt ||= options[:prompt] || "\n> "
+    end
+
+    def autocomplete
+      @autocomplete ||= options[:autocomplete]&.sort
+    end
+
+    def exit_message
+      @exit_message ||= options[:exit_message]
+    end
+
+    def exit_commands
+      @exit_commands ||= options[:exit_commands] || ['exit', 'q']
+    end
+
+    def system_character
+      @system_character ||= options[:system_character] || '/'
+    end
+
+    def autocomplete_handler
+      @autocomplete_handler ||= proc do |s|
+        # :nocov:
+        autocomplete.grep(/#{Regexp.escape(s)}/)
+        # :nocov:
+      end
+    end
+
+  end
+end

data/lib/mister_bin/version.rb

@@ -1,3 +1,3 @@
 module MisterBin
-  VERSION = "0.6.3"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mister_bin
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-20 00:00:00.000000000 Z
+date: 2019-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -49,6 +49,7 @@ files:
 - lib/mister_bin/command.rb
 - lib/mister_bin/command_meta.rb
 - lib/mister_bin/runner.rb
+- lib/mister_bin/terminal.rb
 - lib/mister_bin/version.rb
 homepage: https://github.com/dannyben/mister_bin
 licenses:
@@ -69,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Command line interface for your gems