tabry 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8531aa56c6c59a5d678e280ccb39fa8fd891aadac1d4fd194d73cacee20aaa47
-  data.tar.gz: ab532e18804f52824ccebf21667aa8da6416324eaa428d58140b758e22160b6a
+  metadata.gz: a813a02fd7d1076dfe3f3ee4076fa7d0b4f9fe5c7dae2722f60f7ad0b693fb35
+  data.tar.gz: 0b3631d634da37690deb4e405b856e06f7b12aa8af464a3b4a011d0e68938a57
 SHA512:
-  metadata.gz: 62d4481040a2c2e06e5f16e0c5ef559fddf4cb6330d61d9962af8295c940d56c40bce23df662dbb168c83c48ed929fe30e1f2bf7e91ddc6fda06595c9576b63c
-  data.tar.gz: 1447eb824ec57c40b4dcc4eaeaefbd1488f514bd10535c7035f3439558f03a1368c1cf1cc7674804d2976ab9dadede3d0a818ff9e87e140cd58f67e983026ffb
+  metadata.gz: cf85b3d904c1b02b868e205b654328c99ee733c97950c0182a8c5ffc48dcf281443eab28fc870945cad1eb4a34f39af9f2badc1a725506db38d58fd9d417665a
+  data.tar.gz: fdf3ba0343a7ab8b2254a4c9d49996ea18d37854e7fce2c11ccbcf0b456667f636f84d05d6811dde97276f4805372e3669f708a67ca5e4b16201da4ef524f8eb

data/bin/tabry-bash

@@ -1,6 +1,9 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+# Run by the tabry_bash_core.sh bash tab completion function to plug into Tabry
+# to get completion options.
+
 require "shellwords"
 require "yaml"
 require_relative "../lib/tabry/util"

data/bin/tabry-help

@@ -5,7 +5,7 @@ require_relative "../lib/tabry/runner"
 
 # Show usage information stored in a tabry configuration.
 #
-# For ease of use, source sh/tabry_bash_help.sh so you can just do
+# For ease of use, source sh/bash/tabry_bash_help.sh so you can just do
 # "help mycmd"
 
 raise "Usage: tabry-help config_name [arg1 [arg2]]..." unless ARGV.length >= 1

data/lib/tabry/config_loader.rb

@@ -21,9 +21,16 @@ module Tabry
     def load
       return load_from_file(name) if name =~ /\.json$/i || name =~ /\.ya?ml$/i
 
-      load_paths.each do |dir|
+      load_paths.each do |path|
         EXTENSIONS.each do |extension|
-          filename = "#{dir}/#{name}.#{extension}"
+          basename = "/#{name}.#{extension}"
+
+          # First check if the path _is_ the file "mycmd.json", "mycmd.yml" we are looking for
+          return load_from_file(path) if path.end_with?(basename) && File.exist?(path)
+
+          # Then look for a file "mycmd.json", "mycmd.yml" etc. in the
+          # directory (assuming it is a directory)
+          filename = "#{path}/#{basename}"
           return load_from_file(filename) if File.exist?(filename)
         end
       end

data/lib/tabry/shells/bash.rb

@@ -0,0 +1,28 @@
+module Tabry
+  module Shells
+    module Bash
+      # NOTE! This code uses sh/bash/tabry_bash_core.sh and is described in
+      # sh/bash/README.md; see that README for more info
+      def self.generate(cmd_name, tabry_file_path)
+        capitalized_cmd_name = cmd_name.upcase.gsub(/[^a-zA-Z0-9_]/, '_')
+        tabry_file = Shellwords.escape(File.expand_path(tabry_file_path))
+        path_to_tabry = Shellwords.escape(File.expand_path("#{__dir__}/../../../"))
+
+        core = File.read("#{__dir__}/../../../sh/bash/tabry_bash_core.sh")
+        core.gsub! "_tabry_completions_internal()", "_tabry_#{capitalized_cmd_name}_completions_internal()"
+
+        return <<~END + core
+          # The following Autocomplete is for a Tabry-powered command. It was
+          # generated by the command itself. See the documentation located in
+          # #{path_to_tabry}/sh/bash/README.md
+          _tabry_#{capitalized_cmd_name}_completions() {
+            TABRY_IMPORTS_PATH=#{tabry_file} _tabry_#{capitalized_cmd_name}_completions_internal #{path_to_tabry}/bin/tabry-bash
+          }
+          complete -F _tabry_#{capitalized_cmd_name}_completions #{Shellwords.escape cmd_name}
+        END
+      end
+    end
+  end
+end
+
+

data/sh/bash/README.md

@@ -0,0 +1,35 @@
+# Tabry Bash glue
+
+This directory contains code needed to make Tabry autocomplete work with bash.
+The code here is basically glue code needed to connect bash's autocomplete
+framework with Tabry (which does all the work of generating tab completion
+options). Additionally, `tabry_bash_help.sh` is provided to override bash's
+help command to provide help to commands that have tabry completion.
+
+# Quickstart for adding Tab completion
+* To add Tabry to non-tabry based CLIs, follow the instructions in `tabry_bash.sh`
+* For Tabry-based CLIs, run "mycmd completion bash" and add the code to your `~/.bash_profile`
+
+# Tabry Bash autocompletion technical overview
+The main bash function which calls out to tabry to provide tab completion options is in
+`tabry_bash_core.sh`. This defines a function called
+`_tabry_completions_internal`. **If editing the file, it is important you
+do not rename this function or add lines starting with this function name
+without understanding the substitution as mentioned below.**
+
+This file and bash function contained within is used in two ways:
+* For Ruby CLIs written using tabry, this is renamed to to
+  `_tabry_MYCOMMAND_completions_internal`, and a bit of extra bash code is
+  added on, to make tab completion specific for the program. This is generated
+  for each command when the user runs "mycommand completion bash", which calls
+  `Tabry::Shells::Bash.generate`. A new function for each CLI so different CLIs
+  can use different versions of tabrygq without interfering with each other.
+  The name `_tabry_completions_internal_` is replaced in
+  `lib/tabry/shells/bash.rb` in the `generate` method, so if modifying
+  `tabry_bash_core.sh`, you should if make sure the substitution still works
+  properly.
+* You can also use Tabry to add tab completion to other non-Tabry CLIs. In this
+  case, the `_tabry_completions_internal_` function is used as-is; it is
+  sourced from `tabry_bash.sh`. See `tabry_bash.sh` for details and
+  instructions on how to use it.
+

data/sh/bash/tabry_bash.sh

@@ -0,0 +1,22 @@
+# Use this file to use Tabry tab completion with non-Tabry CLIs. To do this,
+# source this file in your bash_profile and add lines like
+# `complete -F _tabry_completions somecli` for each CLI. You will also
+# need the tabry JSON/YML files in ~/.tabry/ or in a path in your
+# TABRY_IMPORTS_PATH. For instance, to add tab completion to vaulted and
+# rapture, you can add this to your ~/.bash_profile:
+#
+#   source /path/to/tabry/sh/bash/tabry_bash.sh
+#   complete -F _tabry_completions rapture
+#   complete -F _tabry_completions vaulted
+#
+# Then be sure to either copy tabry/examples/tabry/vaulted.json and rapture.json to ~/.tabry/,
+# or set TABRY_IMPORTS_PATH in ~/.bash_profile like so:
+#
+#   TABRY_IMPORTS_PATH=$TABRY_IMPORTS_PATH:/path/to/tabry/examples/tabry/
+#
+
+source "$( dirname "${BASH_SOURCE[0]:-${(%):-%x}}" )"/tabry_bash_core.sh
+_tabry_completions() {
+  _tabry_completions_internal "$( dirname "${BASH_SOURCE[0]:-${(%):-%x}}" )"/../../bin/tabry-bash
+}
+

data/sh/{tabry_bash.sh → bash/tabry_bash_core.sh}

@@ -1,19 +1,14 @@
-#/usr/bin/env bash
-
-# Bash completion
-# _tabry_completions function is same for any command you use with tabry, you just need
-# to do `complete -F _tabry_completions mycmd` for your command. This calls the tabry-bash
-# ruby script. For more info see LANGUAGE_REFERENCE.md
-
-_tabry_bash="$( dirname "${BASH_SOURCE[0]:-${(%):-%x}}" )"/../bin/tabry-bash
-
-_tabry_completions()
+# For more information, or before editing the tabry_bash_core.sh source file,
+# See sh/bash/README.md and sh/bash/tabry_bash.sh in the tabry gem
+_tabry_completions_internal()
 {
+  local tabry_bash="$1"
+
   [[ -n "$TABRY_DEBUG" ]] && echo && echo -n tabry start bash: && date +%s.%N >&2
   local saveifs="$IFS"
   IFS=$'\n'
 
-  local result=`"$_tabry_bash" "$COMP_LINE" "$COMP_POINT"`
+  local result=`ruby "$tabry_bash" "$COMP_LINE" "$COMP_POINT"`
   local specials
 
   if [[ $result == *$'\n'$'\n'* ]]; then
@@ -54,8 +49,3 @@ _tabry_completions()
   [[ -n "$TABRY_DEBUG" ]] && echo -n tabry end bash: && date +%s.%N >&2
 }
 
-# To use: put a .json/.yml tabry config file in ~/.tabry (e.g. ~/.aws.json)
-# Then, run this script in your shell startup scripts, plus (e.g.)
-#
-# complete -F _tabry_completions aws
-

data/sh/{tabry_bash_help.sh → bash/tabry_bash_help.sh}

@@ -1,7 +1,7 @@
 # 'help mycommand' -> show tabry help for a tabry-CLI or command you have a
 # tabry tab completion config for
 
-_tabry_help="$( dirname "${BASH_SOURCE[0]}" )"/../bin/tabry-help
+_tabry_help="$( dirname "${BASH_SOURCE[0]}" )"/../../bin/tabry-help
 help() {
   tabry-help "$@" 2>/dev/null || command help "$@"
 }

data/spec/tabry/config_loader_spec.rb

@@ -24,22 +24,28 @@ describe Tabry::ConfigLoader do
   describe "use of $TABRY_IMPORTS_PATH" do
     before { ENV["TABRY_IMPORTS_PATH"] = "#{__dir__}/../fixtures/" }
 
-    it "looks for yaml files in TABRY_IMPORTS_PATH" do
+    it "looks for yaml files in directories in TABRY_IMPORTS_PATH" do
       config = described_class.load(name: "vehicles")
       expect(config.main.subs.map(&:name)).to eq(
         %w[build list-vehicles move sub-with-sub-or-arg sub-with-mandatory-flag]
       )
     end
 
-    it "looks for json files in TABRY_IMPORTS_PATH" do
+    it "looks for json files in directories in TABRY_IMPORTS_PATH" do
       config = described_class.load(name: "basiccli")
       expect(config.main.subs.map(&:name)).to eq(%w[foo])
     end
 
-    it "looks for yml files in TABRY_IMPORTS_PATH" do
+    it "looks for yml files in directories in TABRY_IMPORTS_PATH" do
       config = described_class.load(name: "basiccli2")
       expect(config.main.subs.map(&:name)).to eq(%w[waz])
     end
+
+    it "looks for json files in TABRY_IMPORTS_PATH" do
+      ENV["TABRY_IMPORTS_PATH"] = "#{__dir__}/../fixtures/basiccli.json"
+      config = described_class.load(name: "basiccli")
+      expect(config.main.subs.map(&:name)).to eq(%w[foo])
+    end
   end
 
   describe "use of $HOME" do

data/tabry.gemspec

@@ -6,7 +6,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = "tabry"
-  s.version     = "0.1.0"
+  s.version     = "0.1.1"
   s.summary     = "Tab completion and CLIs extraordinaire"
   s.authors     = ["Evan Battaglia"]
   s.email       = "battaglia.evan@gmail.com"
@@ -18,6 +18,9 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  # Currently, to get tab completions, we run tabry without bundler. This makes
+  # it much faster, but requires it have no dependencies.
+
   s.add_development_dependency "pry-byebug", "~> 3.10"
   s.add_development_dependency "rspec", "~> 3.10"
   s.add_development_dependency "rubocop", "~> 1.22"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tabry
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Evan Battaglia
@@ -133,11 +133,14 @@ files:
 - lib/tabry/options_finder.rb
 - lib/tabry/result.rb
 - lib/tabry/runner.rb
+- lib/tabry/shells/bash.rb
 - lib/tabry/state.rb
 - lib/tabry/usage_generator.rb
 - lib/tabry/util.rb
-- sh/tabry_bash.sh
-- sh/tabry_bash_help.sh
+- sh/bash/README.md
+- sh/bash/tabry_bash.sh
+- sh/bash/tabry_bash_core.sh
+- sh/bash/tabry_bash_help.sh
 - spec/fixtures/basiccli.json
 - spec/fixtures/basiccli.tabry
 - spec/fixtures/basiccli2.tabry