menu_commander 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac6321af9d45e46d217819d6659c88786ad23f6946d8c7f63076ed98ad8c3ba5
-  data.tar.gz: 650c78d949042c8a3651edad05bc82491fcd7b7095fc4b638b4e52dcfe9b0b74
+  metadata.gz: fc729b17a7ba7e6fbba64302b2323cd073d9ea2a69b633f8ddbaf24890ff00a7
+  data.tar.gz: 82afd7ef1013dd8438b53da908a2841acf36a5bfe39148b7fd357e85a9548ef1
 SHA512:
-  metadata.gz: d53c7fc17bd0ee211262624b0973d49eff0c433d5b819847989b211d452514e531d3183a662a9d1b878c916086a92b57ed3359d6b624a414cef470ee8f8410c2
-  data.tar.gz: 446c8c2a2f6d99af790e1f011251a6005a83173aec102b2b6bf792bcce57bd9dd343a9d5488ce969da5a1f956203f22cf475a056234092b737786f6b32a3ef40
+  metadata.gz: 88bc9315c1c6502f1d3c40d12880a0b80e54bda56705fa00509a1b5aa6daacc398e67a4f241f0dbf45100dde6610803561842a58ed66ea440006a5cddbf27699
+  data.tar.gz: 85747cfd5579c748491c5526477b428b44c8458cb5cf6f8bbf29d0e05e06b4ed57bffc3616f21f50c286c3444c846a0e81e6bb0eb123de84d3c40339c4fb65ec

data/README.md

@@ -14,14 +14,14 @@ Easily create menus for any command line tool using simple YAML configuration.
 * [Installation](#installation)
 * [Usage](#usage)
    * [Menu Navigation](#menu-navigation)
-* [Menu Configuration Features](#menu-configuration-features)
+* [Menu Definition](#menu-definition)
    * [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 Options](#menu-options)
 * [Menu File Location](#menu-file-location)
 
 ---
@@ -81,7 +81,7 @@ $ menu some-other-file
 
 
 
-Menu Configuration Features
+Menu Definition
 --------------------------------------------------
 
 All features have an example configuration in the
@@ -199,20 +199,6 @@ menu:
 > 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
@@ -276,6 +262,47 @@ menu:
 > See: [examples/multiline.yml](examples/multiline.yml)
 
 
+Menu Options
+--------------------------------------------------
+
+You can tweak several aspects of the menu by adding an `options` section
+in your YAML file.
+
+```yaml
+options:
+  # Show header text
+  header: Hello
+
+  # Marker to show as the suffix of items that have submenus
+  # Use false to disable
+  submenu_marker: " ..."
+
+  # Menu selection marker
+  select_marker: ">"
+
+  # Menu title marker
+  title_marker: "-"
+
+  # When a menu has more items than page_size, add pagiation
+  # Default 10
+  page_size: 2
+
+  # When to show search filter
+  # yes      = always show
+  # no       = never show
+  # auto     = show only when there aare more items than page_size (default)
+  # <number> = show only when there are more items than <number>
+  filter: yes
+
+  # When arg lists generate one item only it is auto-selected by default.
+  # Set this to false to disable this behavior
+  auto_select: false
+```
+
+> See: [examples/optons.yml](examples/options.yml)
+
+
+
 Menu File Location
 --------------------------------------------------
 

data/bin/menu

@@ -19,7 +19,7 @@ rescue MenuCommander::Exit => e
 rescue MenuCommander::MenuNotFound => e
   say! "#{e.message}"
   if e.paths and e.config
-    message = "Looked for !txtgrn!#{e.config}.yml!txtrst! in"
+    message = "Looked for !txtgrn!#{e.config}!txtrst! in"
     if e.paths.size == 1
       message += " !txtgrn!#{e.paths.first}"
       say! message

data/lib/menu_commander/command.rb

@@ -4,24 +4,25 @@ module MenuCommander
   class Command < MisterBin::Command
     help "Menu Commander"
 
-    usage "menu [CONFIG --dry --loop]"
+    usage "menu [CONFIG --loop (--dry|--confirm)]"
     usage "menu (-h|--help|--version)"
 
     option "-d --dry", "Dry run - do not execute the command at the end, just show it"
     option "-l --loop", "Reopen the menu after executing the selected command"
+    option "-c --confirm", "Show the command before execution and ask for confirmation"
     option "--version", "Show version number"
 
-    param "CONFIG", "The name of the menu config file without the .yml extension [default: menu]"
+    param "CONFIG", "The name of the menu config file with or without the .yml extension [default: menu]"
 
     example "menu --dry"
-    example "menu production --loop"
+    example "menu production --loop --confirm"
     example "menu -ld"
 
     attr_reader :last_command
 
     def run
       verify_sanity
-      say "#{menu.header}\n" if menu.header
+      say "#{menu.options.header}\n" if menu.options.header
 
       if args['--loop']
         run_looped_menu
@@ -53,7 +54,10 @@ module MenuCommander
       command = menu.call
       @last_command = command
 
-      if args['--dry']
+      if args['--confirm']
+        say "$ !txtpur!#{command}".strip
+        system command if prompt.yes? "Execute?"
+      elsif args['--dry']
         say "$ !txtpur!#{command}".strip
       else
         system command
@@ -66,7 +70,7 @@ module MenuCommander
 
     def menu_file!
       menu_paths.each do |dir|
-        file = "#{dir}/#{config}.yml"
+        file = "#{dir}/#{config}"
         return file if File.exist? file
       end
       nil
@@ -81,7 +85,13 @@ module MenuCommander
     end
 
     def config
-      config = args['CONFIG'] || 'menu'
+      result = args['CONFIG'] || 'menu'
+      result += ".yml" unless result.end_with?('.yml')
+      result
+    end
+
+    def prompt
+      @prompt ||= TTY::Prompt.new
     end
   end
 end

data/lib/menu_commander/exceptions.rb

@@ -18,7 +18,7 @@ module MenuCommander
   class ExitMenu < Interrupt
     # :nocov:
     def initialize(message=nil)
-      super (message || "> Exit")
+      super (message || "Goodbye")
     end
     # :nocov:
   end

data/lib/menu_commander/menu.rb

@@ -24,8 +24,8 @@ module MenuCommander
 
     end
 
-    def header
-      config['header']
+    def options
+      @options ||= MenuOptions.new(config['options'])
     end
 
   private
@@ -70,9 +70,13 @@ module MenuCommander
     end
 
     def get_opts_type(opts)
-      return :free_text if !opts
-      return :static if opts.is_a? Array and opts.size == 1
-      :menu
+      if !opts
+        :free_text 
+      elsif options.auto_select and opts.is_a? Array and opts.size == 1
+        :static 
+      else
+        :menu
+      end
     end
 
     def get_opts(key)
@@ -106,7 +110,6 @@ module MenuCommander
       end
     end
 
-
     def ask(title)
       prompt.ask "> #{title}:"
 
@@ -117,10 +120,36 @@ module MenuCommander
 
     end
 
-    def select(options, title=nil)
-      title = title ? "> #{title}:" : ">"
-      enable_filter = options.size > 10
-      prompt.select title, options, symbols: { marker: '>' }, per_page: 10, filter: enable_filter
+    def apply_suffix(choices)
+      choices.map do |key, value|
+        key = "#{key}#{options.submenu_marker}" if value.is_a? Hash
+        [key, value]
+      end.to_h
+    end
+
+    def enable_filter?(choices)
+      if options.filter === true
+        true
+      elsif options.filter === false
+        false
+      elsif options.filter.is_a? Numeric
+        choices.size > options.filter
+      else
+        choices.size > options.page_size
+      end
+    end
+
+    def select(choices, title=nil)
+      title = title ? "#{options.title_marker} #{title}:" : options.title_marker
+      choices = apply_suffix choices if options.submenu_marker
+      select! choices, title
+    end
+
+    def select!(choices, title)      
+      prompt.select title, choices, 
+        symbols: { marker: options.select_marker }, 
+        per_page: options.page_size, 
+        filter: enable_filter?(choices)
 
     rescue TTY::Reader::InputInterrupt
       # :nocov:

data/lib/menu_commander/menu_options.rb

@@ -0,0 +1,31 @@
+module MenuCommander
+  class MenuOptions
+    attr_reader :options
+
+    def initialize(options)
+      options ||= {}
+      options.transform_keys! &:to_sym
+      @options = default_options.merge options
+    end    
+
+    def default_options
+      @default_options ||= {
+        auto_select: true,
+        filter: 'auto',
+        header: false,
+        page_size: 10,
+        select_marker: "⯈",
+        submenu_marker: " ⯆",
+        title_marker: "◾",
+      }
+    end
+
+    def method_missing(method, *_args, &_block)
+      respond_to?(method) ? options[method] : super
+    end
+
+    def respond_to_missing?(method_name, include_private=false)
+      options.has_key?(method_name) || super
+    end
+  end
+end

data/lib/menu_commander/polyfills/hash.rb

@@ -0,0 +1,11 @@
+# :nocov:
+
+# Required for Ruby < 2.5
+if !{}.respond_to? :transform_keys!
+  class Hash
+    def transform_keys!
+      keys.each { |key| self[yield(key)] = delete(key) }
+      self
+    end
+  end
+end

data/lib/menu_commander/version.rb

@@ -1,3 +1,3 @@
 module MenuCommander
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

data/lib/menu_commander.rb

@@ -1,4 +1,6 @@
+require 'menu_commander/polyfills/hash'
 require 'menu_commander/exceptions'
+require 'menu_commander/menu_options'
 require 'menu_commander/menu'
 require 'menu_commander/command'
 require 'menu_commander/cli'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: menu_commander
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-20 00:00:00.000000000 Z
+date: 2019-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mister_bin
@@ -80,6 +80,8 @@ files:
 - lib/menu_commander/command.rb
 - lib/menu_commander/exceptions.rb
 - lib/menu_commander/menu.rb
+- lib/menu_commander/menu_options.rb
+- lib/menu_commander/polyfills/hash.rb
 - lib/menu_commander/version.rb
 homepage: https://github.com/dannyben/menu_commander
 licenses: