menu_commander 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75da68a2ccd79c2b07b8e61c047dd1047234cb3665c71450cc0bd09402c08cff
-  data.tar.gz: 44400006ab0b7525e94459032c0f51393aee61f2bccec3185434676441a8aa78
+  metadata.gz: ac6321af9d45e46d217819d6659c88786ad23f6946d8c7f63076ed98ad8c3ba5
+  data.tar.gz: 650c78d949042c8a3651edad05bc82491fcd7b7095fc4b638b4e52dcfe9b0b74
 SHA512:
-  metadata.gz: fea9fd9cf567cc67ce6c0bea3edb78fb5819c2ef83dcdce541f00868aba2a508711bb169bdb58bef496bdb5b15afe99863fec968b7545217c916da3a0f278e6c
-  data.tar.gz: a29a5eaf1a29b696bab6d36e17a88b57c07366993b0445750c3e03dc6c700fcdcea934bb376497d8216cd03dceb2d517a2036c2f579fad490124cec68c5dc733
+  metadata.gz: d53c7fc17bd0ee211262624b0973d49eff0c433d5b819847989b211d452514e531d3183a662a9d1b878c916086a92b57ed3359d6b624a414cef470ee8f8410c2
+  data.tar.gz: 446c8c2a2f6d99af790e1f011251a6005a83173aec102b2b6bf792bcce57bd9dd343a9d5488ce969da5a1f956203f22cf475a056234092b737786f6b32a3ef40

data/README.md

@@ -13,6 +13,7 @@ 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)
    * [Minimal menu requirements](#minimal-menu-requirements)
    * [Argument sub-menus](#argument-sub-menus)
@@ -67,9 +68,18 @@ $ menu
 $ menu some-other-file
 ```
 
-
 ![Demo](/demo/demo.gif)
 
+### Menu Navigation
+
+- When a menu or sub menu has more than 10 items, it will become paginated
+  and a search filter will be added.
+- Pressing <kbd>Home</kbd> from any nested menu will go back to the first 
+  menu.
+- Pressing <kbd>Page Up</kbd> from any nested menu will go back to the 
+  previous menu.
+
+
 
 Menu Configuration Features
 --------------------------------------------------

data/lib/menu_commander/exceptions.rb

@@ -7,11 +7,27 @@ module MenuCommander
     # :nocov: - covered by external process
     attr_reader :paths, :config
 
-    def initialize(message = nil, paths: nil, config: nil)
+    def initialize(message=nil, paths: nil, config: nil)
       message ||= "Could not find menu configuration file"
       @paths, @config = paths, config
       super message
     end
     # :nocov:
   end
+
+  class ExitMenu < Interrupt
+    # :nocov:
+    def initialize(message=nil)
+      super (message || "> Exit")
+    end
+    # :nocov:
+  end
+
+  class MenuNavigation < StandardError
+    attr_reader :menu
+
+    def initialize(menu)
+      @menu = menu
+    end
+  end
 end

data/lib/menu_commander/menu.rb

@@ -15,8 +15,13 @@ module MenuCommander
       menu ||= config['menu']
       response = select menu
       response = combine_commands response if response.is_a? Array
-      
+
+      history << menu
+
       response.is_a?(String) ? evaluate(response) : call(response)
+    rescue MenuNavigation => e
+      call e.menu
+
     end
 
     def header
@@ -25,6 +30,10 @@ module MenuCommander
 
   private
 
+    def history
+      @history ||= []
+    end
+
     def combine_commands(command_array)
       command_array.map { |cmd| "(#{cmd})" }.join ' && ' 
     end
@@ -72,26 +81,50 @@ module MenuCommander
     end
 
     def prompt
-      @prompt ||= TTY::Prompt.new
+      @prompt ||= prompt!
+    end
+
+    def prompt!
+      result = TTY::Prompt.new
+      result.on(:keypress) { |event| handle_keypress event }
+      result
     end
 
+    def handle_keypress(event)
+      case event.key.name
+      when :page_up
+        parent_menu = history.pop
+        raise MenuNavigation.new(parent_menu) if parent_menu
+
+      when :home
+        home_menu = history.first
+        if home_menu
+          @history = []
+          raise MenuNavigation.new(home_menu)
+        end
+
+      end
+    end
+
+
     def ask(title)
       prompt.ask "> #{title}:"
 
     rescue TTY::Reader::InputInterrupt
       # :nocov:
-      raise Interrupt, "Goodbye"
+      raise ExitMenu
       # :nocov:
 
     end
 
     def select(options, title=nil)
       title = title ? "> #{title}:" : ">"
-      prompt.select title, options, symbols: { marker: '>' }, per_page: 10, filter: true
+      enable_filter = options.size > 10
+      prompt.select title, options, symbols: { marker: '>' }, per_page: 10, filter: enable_filter
 
     rescue TTY::Reader::InputInterrupt
       # :nocov:
-      raise Interrupt, "Goodbye"
+      raise ExitMenu
       # :nocov:
 
     end

data/lib/menu_commander/version.rb

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

data/lib/menu_commander.rb

@@ -3,4 +3,7 @@ require 'menu_commander/menu'
 require 'menu_commander/command'
 require 'menu_commander/cli'
 
-require 'byebug' if ENV['BYEBUG']
+if ENV['BYEBUG']
+  require 'byebug'
+  require 'lp'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: menu_commander
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-18 00:00:00.000000000 Z
+date: 2019-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mister_bin
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Create menus for any CLI tool