menu_commander 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74444d9eb64f53f5fbdc75a27ac41014acf0604136d72a5f0966200ba018751c
-  data.tar.gz: 21f972e2af7b56540837fcb07efb58cbe062e9779a872e45861691a4daee853e
+  metadata.gz: 75da68a2ccd79c2b07b8e61c047dd1047234cb3665c71450cc0bd09402c08cff
+  data.tar.gz: 44400006ab0b7525e94459032c0f51393aee61f2bccec3185434676441a8aa78
 SHA512:
-  metadata.gz: de5b7bda43aa8b918cfdd978acc9b8e5d315365e5430cf2a1a1227fa680a445d327c6843a6da09800e10594d2863099ba9e42f444c401515d3ce05175cc8bcdc
-  data.tar.gz: 602592a70232ef56c6125ff97f701b2877195e94bc14877e98759933e245dec517826285c4009a4fb01dccafdfc366000de8c81d7cbbf2da6dccb64c55279a5f
+  metadata.gz: fea9fd9cf567cc67ce6c0bea3edb78fb5819c2ef83dcdce541f00868aba2a508711bb169bdb58bef496bdb5b15afe99863fec968b7545217c916da3a0f278e6c
+  data.tar.gz: a29a5eaf1a29b696bab6d36e17a88b57c07366993b0445750c3e03dc6c700fcdcea934bb376497d8216cd03dceb2d517a2036c2f579fad490124cec68c5dc733

data/README.md

@@ -11,6 +11,20 @@ Easily create menus for any command line tool using simple YAML configuration.
 
 ---
 
+* [Installation](#installation)
+* [Usage](#usage)
+* [Menu Configuration Features](#menu-configuration-features)
+   * [Minimal menu requirements](#minimal-menu-requirements)
+   * [Argument sub-menus](#argument-sub-menus)
+   * [Free text input](#free-text-input)
+   * [Nested menus](#nested-menus)
+   * [Header text](#header-text)
+   * [Split menu into several files](#split-menu-into-several-files)
+   * [Multi-line commands](#multi-line-commands)
+* [Menu File Location](#menu-file-location)
+
+---
+
 Installation
 --------------------------------------------------
 
@@ -71,19 +85,19 @@ 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
 ```
 
+> See: [examples/minimal.yml](examples/minimal.yml)
+
 ### 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
@@ -94,6 +108,8 @@ args:
     - production
 ```
 
+> See: [examples/args-array.yml](examples/args-array.yml)
+
 In case the argument array contains only one array element for a given 
 variable, it will be automatically used without prompting the user.
 
@@ -101,24 +117,16 @@ This is useful when you need to define variables that repeat multiple times
 in your menu.
 
 ```yaml
-# examples/args-static.yml
-
-menu:
-  "Show Files": ssh %{server} ls
-  "Reboot": ssh %{server} reboot
-
-# Using an array with exactly one argument will NOT prompt the user for input
-# and instead, use the only possible value.
 args:
-  server:
-  - localhost
+  server: [localhost]
 ```
 
+> See: [examples/args-static.yml](examples/args-static.yml)
+
 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
@@ -129,12 +137,13 @@ args:
     Production Environment: production
 ```
 
+> See: [examples/args-hash.yml](examples/args-hash.yml)
+
 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}
@@ -143,25 +152,27 @@ args:
   file: ls 
 ```
 
+> See: [examples/args-shell.yml](examples/args-shell.yml)
+
 ### 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}
 ```
 
+> See: [examples/args-free-text.yml](examples/args-free-text.yml)
+
 ### 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
@@ -175,6 +186,64 @@ menu:
     branch: git branch
 ```
 
+> See: [examples/args-nested.yml](examples/args-nested.yml)
+
+
+### Header text
+
+Use the `header` option to display a sentence or a multi-line paragraph when
+the menu is started. The header string supports [colsole color markers][1]:
+
+```yaml
+header: |-
+  Welcome to this !txtgrn!basic menu
+  !bldred!Multiline!txtrst! headers are allowed
+```
+
+> See: [examples/header.yml](examples/header.yml)
+
+
+### Split menu into several files
+
+Each menu configuration file can include any number of additional YAML
+files inside it. This is useful when:
+
+- Your menu configuration file becomes too long, and you wish to split it
+  to separate logical units.
+- You have multiple menu files, and you want to include common configuration
+  in each of them.
+
+This is done by using the `extends` option:
+
+```yaml
+# examples/extend.yml
+extends: extend-parent.yml
+
+menu:
+  hello: echo hello
+  hi: echo hi %{name}
+
+args:
+  name: [Harry, Lloyd]
+  server: [example.com]
+```
+
+> See: [examples/extend.yml](examples/extend.yml)
+
+The below configuration will be merged into the above menu:
+
+```yaml
+# examples/extend-parent.yml
+menu:
+  ping: ping %{server}
+
+args:
+  server: [localhost, google.com]
+```
+
+> See: [examples/extend-parent.yml](examples/extend-parent.yml)
+
+
 ### Multi-line commands
 
 Providing an array to a menu, will join the array with '&&' to a single
@@ -182,7 +251,6 @@ command. Alternatively, you can use a simple YAML multi-line string.
 
 
 ```yaml
-# examples/multiline.yml
 menu:
   deploy:
     - run tests
@@ -195,6 +263,8 @@ menu:
     git push
 ```
 
+> See: [examples/multiline.yml](examples/multiline.yml)
+
 
 Menu File Location
 --------------------------------------------------
@@ -214,3 +284,4 @@ If you wish this setting to be permanent, add it to your `.bashrc` or your
 preferred initialization script.
 
 
+[1]: https://github.com/dannyben/colsole#color-codes

data/lib/menu_commander/command.rb

@@ -20,8 +20,8 @@ module MenuCommander
     attr_reader :last_command
 
     def run
-      raise Exit, VERSION if args['--version'] 
-      raise MenuNotFound.new(paths: menu_paths, config: config) unless menu_file
+      verify_sanity
+      say "#{menu.header}\n" if menu.header
 
       if args['--loop']
         run_looped_menu
@@ -36,6 +36,11 @@ module MenuCommander
 
   private
 
+    def verify_sanity
+      raise Exit, VERSION if args['--version'] 
+      raise MenuNotFound.new(paths: menu_paths, config: config) unless menu_file
+    end
+
     def run_looped_menu
       loop do
         run_menu

data/lib/menu_commander/menu.rb

@@ -19,6 +19,10 @@ module MenuCommander
       response.is_a?(String) ? evaluate(response) : call(response)
     end
 
+    def header
+      config['header']
+    end
+
   private
 
     def combine_commands(command_array)

data/lib/menu_commander/version.rb

@@ -1,3 +1,3 @@
 module MenuCommander
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: menu_commander
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Danny Ben Shitrit