menu_commander 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '09d63d573439372dd5e017940ded720734eef31f0eea6cc290ff0605328a0118'
+  data.tar.gz: 3b6e7e0a01a17463289c8390581cf899498281c98ccb1eb6fcd88535462db953
+SHA512:
+  metadata.gz: b496ffd6d0b7734a906091ce1c90e685ba691f3415108bca93c6766caeaca7153c39251ebe4c9ca690b6b51d845242d42b4ce9794d0cd4d84b23d5d024c5a671
+  data.tar.gz: 47c792e570005e6e47746d7495ee138b80a5d8d9330f92d1a22399772cd1687d78f1a45ce2f92a628861b8064b2f97b0276bdad5495ed689a76752e0303e9ac0

data/README.md

@@ -0,0 +1,147 @@
+Menu Commander
+==================================================
+
+[![Gem Version](https://badge.fury.io/rb/menu_commander.svg)](https://badge.fury.io/rb/menu_commander)
+[![Build Status](https://travis-ci.com/DannyBen/menu_commander.svg?branch=master)](https://travis-ci.com/DannyBen/menu_commander)
+[![Maintainability](https://api.codeclimate.com/v1/badges/.../maintainability)](https://codeclimate.com/github/DannyBen/menu_commander/maintainability)
+
+---
+
+Easily create menus for any command line tool using simple YAML configuration.
+
+---
+
+Installation
+--------------------------------------------------
+
+    $ gem install menu_commander
+
+
+
+Usage
+--------------------------------------------------
+
+Menu Commander adds the `menu` command line tool to your path. When running 
+it without arguments, it will look for a `menu.yml` file in the current 
+directory, and will provide you with a menu to execute any shell command.
+
+A basic menu configuration file looks like this:
+
+```yaml
+# menu.yml
+
+# Using %{variables} in a command will prompt for an input when executed
+menu:
+  hello: echo hello
+  hi: echo hi %{name}
+
+# Define sub menus for any %{variable} that was defined in the command
+args:
+  name:
+  - Harry
+  - Lloyd
+```
+
+Running it, looks like this:
+
+![Demo](/demo/demo.gif)
+
+
+Features
+--------------------------------------------------
+
+All features have an example configuration in the
+[examples folder](examples). To run an example, simply execute 
+`menu EAXMPLE_NAME` form within the examples folder, where `EXAMPLE_NAME` 
+is the name of the YAML file without the extension.
+
+### Minimal menu requirements
+
+The only requirement for a minimal menu is to have a `menu` definition
+with `key: command` to run.
+
+```yaml
+# examples/minimal.yml
+menu:
+  hello: echo hello
+  whoami: whoami
+```
+
+### Argument sub-menus
+
+Using `%{variables}` in a command will prompt for an input when executed. The 
+sub-menu for that input is specified in the `args` definition.
+
+```yaml
+# examples/args-array.yml
+menu:
+  server: rails server --env %{environment}
+  test: RAILS_ENV=%{environment} rspec
+
+args:
+  environment:
+    - staging
+    - production
+```
+
+Using `key: value` pairs in the `args` menu will create a sub-menu with 
+labels that are different from their substituted value:
+
+```yaml
+# examples/args-hash.yml
+menu: 
+  server: rails server --env %{environment}
+  test: RAILS_ENV=%{environment} rspec
+
+args:
+  environment:
+    Staging Environment: staging
+    Production Environment: production
+```
+
+In order to obtain the sub-menu items from a shell command, simply provide
+the command to run, instead of providing the menu options. The command is
+expected to provide newline-delimited output.
+
+```yaml
+# examples/args-shell.yml
+menu:
+  show: cat %{file}
+  edit: vi %{file}
+
+args:
+  file: ls 
+```
+
+### Free text input
+
+When using a `%{variable}` that does not have a corresponding definition in
+the `args` section, you will simply be prompted for a free text input:
+
+```yaml
+# examples/args-free-text.yml
+menu:
+  release: 
+    echo %{version} > version.txt &&
+    git tag v%{version}
+```
+
+### Nested menus
+
+You can nest as many menu levels as you wish under the menu definition.
+
+```yaml
+# examples/nested.yml
+menu:
+  docker:
+    images: docker images ls
+    containers: docker ps -a
+    stack:
+      deploy: docker stack deploy -c docker-compose.yml mystack
+      list: docker stack ls
+
+  git:
+    status: git status
+    branch: git branch
+```
+

data/bin/menu

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require 'menu_commander'
+require 'colsole'
+include Colsole
+
+router = MenuCommander::CLI.router
+
+begin
+  exit router.run ARGV
+rescue MenuCommander::MenuNotFound => e
+  say! "!txtred!#{e.message}"
+  exit 1  
+rescue => e
+  puts e.backtrace.reverse if ENV['DEBUG']
+  say! "!txtred!#{e.class}: #{e.message}"
+  exit 1
+end

data/lib/menu_commander/cli.rb

@@ -0,0 +1,13 @@
+require 'mister_bin'
+
+module MenuCommander
+  class CLI
+    def self.router
+      router = MisterBin::Runner.new version: VERSION,
+        header: "CLI Menu Generator"
+
+      router.route_all to: Command
+      router
+    end
+  end
+end

data/lib/menu_commander/command.rb

@@ -0,0 +1,43 @@
+require 'mister_bin'
+require 'colsole'
+
+module MenuCommander
+  class Command < MisterBin::Command
+    include Colsole
+
+    help "Execute the menu"
+    usage "menu [CONFIG --dry]"
+    usage "menu (-h|--help)"
+    option "-d --dry", "Dry run. Do not execute the command at the end, just show it."
+    param "CONFIG", "The name of the menu config file without the .yml extension [default: menu]"
+
+    def run
+      raise MenuNotFound unless File.exist? menu_file
+
+      if args['--dry']
+        say "$ !txtpur!#{command}"
+      else
+        exec command
+      end
+    end
+
+    def menu
+      @menu ||= Menu.new menu_file
+    end
+
+    def command
+      @command ||= menu.call
+    end
+
+  private
+
+    def menu_file
+      "#{config}.yml"
+    end
+
+    def config
+      config = args['CONFIG'] || 'menu'
+    end
+
+  end
+end

data/lib/menu_commander/exceptions.rb

@@ -0,0 +1,11 @@
+module MenuCommander
+  class Error < StandardError; end
+  
+  class MenuNotFound < Error
+    # :nocov: - covered by external process
+    def initialize(message="Could not find menu configuration file")
+      super
+    end
+    # :nocov:
+  end
+end

data/lib/menu_commander/menu.rb

@@ -0,0 +1,74 @@
+require 'yaml'
+require 'tty/prompt'
+
+module MenuCommander
+  class Menu
+    attr_reader :config
+
+    def initialize(config)
+      config = YAML.load_file config if config.is_a? String
+      @config = config
+    end
+
+    def call(menu = nil)
+      menu ||= config['menu']
+      response = select menu
+      if response.is_a? String
+        params = {}
+        placeholders(response).each do |key|
+          params[key.to_sym] = get_user_response key
+        end
+
+        response % params
+      else
+        call response
+      end
+    end
+
+  private
+
+    def placeholders(template)
+      template.scan(/%{([^}]+)}/).flatten.uniq
+    end
+
+    def args
+      config['args']
+    end
+
+    def get_user_response(key)
+      opts = args ? args[key] : nil
+      opts = opts.is_a?(String) ? `#{opts}`.split("\n") : opts
+
+      if opts
+        opts.size == 1 ? opts[0] : select(opts, key)
+      else
+        ask(key)
+      end    
+    end
+
+    def prompt
+      @prompt ||= TTY::Prompt.new
+    end
+
+    def ask(title)
+      prompt.ask "> #{title}:"
+    rescue TTY::Reader::InputInterrupt
+      # :nocov:
+      puts "\nGoodbye"
+      exit
+      # :nocov:
+    end
+
+    def select(options, title = nil)
+      title = title ? "> #{title}:" : ">"
+      menu_config = { marker: '>', per_page: 10 }
+      menu_config['filter'] = true if options.size > 10
+      prompt.select title, options, menu_config
+    rescue TTY::Reader::InputInterrupt
+      # :nocov:
+      puts "\nGoodbye"
+      exit
+      # :nocov:
+    end
+  end
+end

data/lib/menu_commander/version.rb

@@ -0,0 +1,3 @@
+module MenuCommander
+  VERSION = "0.0.1"
+end

data/lib/menu_commander.rb

@@ -0,0 +1,6 @@
+require 'menu_commander/exceptions'
+require 'menu_commander/menu'
+require 'menu_commander/command'
+require 'menu_commander/cli'
+
+require 'byebug' if ENV['BYEBUG']

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: menu_commander
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mister_bin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: colsole
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+description: Easily create menus for any command line tool using simple YAML configuration
+email: db@dannyben.com
+executables:
+- menu
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/menu
+- lib/menu_commander.rb
+- lib/menu_commander/cli.rb
+- lib/menu_commander/command.rb
+- lib/menu_commander/exceptions.rb
+- lib/menu_commander/menu.rb
+- lib/menu_commander/version.rb
+homepage: https://github.com/dannyben/menu_commander
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Create menus for any CLI tool
+test_files: []