menu_commander 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09d63d573439372dd5e017940ded720734eef31f0eea6cc290ff0605328a0118'
-  data.tar.gz: 3b6e7e0a01a17463289c8390581cf899498281c98ccb1eb6fcd88535462db953
+  metadata.gz: 4cf72e4a3375daaa4a0693a693d24cd8bdd2b16ddaff9d5696c8b84cba683ca7
+  data.tar.gz: 1238ecd337b8c51511b008ceda05160867b57dc9a64adcdaef57eb84c937d69c
 SHA512:
-  metadata.gz: b496ffd6d0b7734a906091ce1c90e685ba691f3415108bca93c6766caeaca7153c39251ebe4c9ca690b6b51d845242d42b4ce9794d0cd4d84b23d5d024c5a671
-  data.tar.gz: 47c792e570005e6e47746d7495ee138b80a5d8d9330f92d1a22399772cd1687d78f1a45ce2f92a628861b8064b2f97b0276bdad5495ed689a76752e0303e9ac0
+  metadata.gz: 46e4e917ce083cde286e75e1673bfb412ca315716d924a0401787bfa04c1cc0de729ddbdebd6a5d8468ce5573848d61ef0e127029fb91891d3d84b079ac91795
+  data.tar.gz: 58c9e748ea7e34baa187bb26213fa169f8adba2c022fa1c88ffd102c0e89135c7b4d278173cef28b5a2eb6ebc08e2561ff4df4b46cc3db7ce6272413e85dc5ef

data/README.md

@@ -3,7 +3,7 @@ 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)
+[![Maintainability](https://api.codeclimate.com/v1/badges/aa048e0f2cf1655261ac/maintainability)](https://codeclimate.com/github/DannyBen/menu_commander/maintainability)
 
 ---
 
@@ -47,7 +47,7 @@ Running it, looks like this:
 ![Demo](/demo/demo.gif)
 
 
-Features
+Menu Configuration Features
 --------------------------------------------------
 
 All features have an example configuration in the
@@ -145,3 +145,21 @@ menu:
     branch: git branch
 ```
 
+Menu File Location
+--------------------------------------------------
+
+By default, menu files are looked for in the current working directory. 
+
+You may instruct Menu Commander to look in additional locations by setting
+the `MENU_PATH` environment variable to one or more paths. Note that when
+using this method, Menu Commander will *not* look in the current directory, 
+unless you include it in `MENU_PATH`, like this:
+
+```shell
+$ export MENU_PATH=.:$HOME/menus:/etc/menus
+```
+
+If you wish this setting to be permanent, add it to your `.bashrc` or your 
+preferred initialization script.
+
+

data/bin/menu

@@ -7,11 +7,30 @@ router = MenuCommander::CLI.router
 
 begin
   exit router.run ARGV
+
+rescue MenuCommander::Interrupt => e
+  say! "\n#{e.message}"
+  exit 0
+
 rescue MenuCommander::MenuNotFound => e
-  say! "!txtred!#{e.message}"
-  exit 1  
+  say! "#{e.message}"
+  if e.paths and e.config
+    message = "Looked for !txtgrn!#{e.config}.yml!txtrst! in"
+    if e.paths.size == 1
+      message += " !txtgrn!#{e.paths.first}"
+      say! message
+    else
+      say! message
+      e.paths.each do |path|
+        say! "- !txtgrn!#{path}"
+      end
+    end
+  end
+  exit 1
+
 rescue => e
   puts e.backtrace.reverse if ENV['DEBUG']
   say! "!txtred!#{e.class}: #{e.message}"
   exit 1
+
 end

data/lib/menu_commander/command.rb

@@ -12,7 +12,7 @@ module MenuCommander
     param "CONFIG", "The name of the menu config file without the .yml extension [default: menu]"
 
     def run
-      raise MenuNotFound unless File.exist? menu_file
+      raise MenuNotFound.new(paths: menu_paths, config: config) unless menu_file
 
       if args['--dry']
         say "$ !txtpur!#{command}"
@@ -32,12 +32,27 @@ module MenuCommander
   private
 
     def menu_file
-      "#{config}.yml"
+      @menu_file ||= menu_file!
+    end
+
+    def menu_file!
+      menu_paths.each do |dir|
+        file = "#{dir}/#{config}.yml"
+        return file if File.exist? file
+      end
+      nil
+    end
+
+    def menu_paths
+      menu_env_path.split File::PATH_SEPARATOR
+    end
+
+    def menu_env_path
+      ENV['MENU_PATH'] || '.'
     end
 
     def config
       config = args['CONFIG'] || 'menu'
     end
-
   end
-end
+end

data/lib/menu_commander/exceptions.rb

@@ -1,10 +1,15 @@
 module MenuCommander
   class Error < StandardError; end
+  class Interrupt < Interrupt; end
   
   class MenuNotFound < Error
     # :nocov: - covered by external process
-    def initialize(message="Could not find menu configuration file")
-      super
+    attr_reader :paths, :config
+
+    def initialize(message = nil, paths: nil, config: nil)
+      message ||= "Could not find menu configuration file"
+      @paths, @config = paths, config
+      super message
     end
     # :nocov:
   end

data/lib/menu_commander/menu.rb

@@ -36,14 +36,13 @@ module MenuCommander
     end
 
     def get_user_response(key)
-      opts = args ? args[key] : nil
-      opts = opts.is_a?(String) ? `#{opts}`.split("\n") : opts
+      opts = get_opts key
+      opts ? select(opts, key) : ask(key)
+    end
 
-      if opts
-        opts.size == 1 ? opts[0] : select(opts, key)
-      else
-        ask(key)
-      end    
+    def get_opts(key)
+      opts = args ? args[key] : nil
+      opts.is_a?(String) ? `#{opts}`.split("\n") : opts
     end
 
     def prompt
@@ -52,11 +51,12 @@ module MenuCommander
 
     def ask(title)
       prompt.ask "> #{title}:"
+
     rescue TTY::Reader::InputInterrupt
       # :nocov:
-      puts "\nGoodbye"
-      exit
+      raise Interrupt, "Goodbye"
       # :nocov:
+
     end
 
     def select(options, title = nil)
@@ -64,11 +64,12 @@ module MenuCommander
       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
+      raise Interrupt, "Goodbye"
       # :nocov:
+
     end
   end
 end

data/lib/menu_commander/version.rb

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

metadata

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