tabry 0.2.2 → 0.2.4

data/lib/tabry/shells/fish.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# Used to generate a tab-completion function for a Tabry CLI using absolute
+# paths to the tabry-bash script in this repo and to the Tabry JSON/YML file.
+# Using uniquely-named tab-completion functions and absolute paths means you can
+# have different Tabry-based CLIs using different versions of Tabry without any
+# conflicts.
+# See sh/bash/README.md and "Adding Tab Completion to your CLI" in main README
+
+require "shellwords"
+
+module Tabry
+  module Shells
+    module Fish
+      # NOTE! This code uses sh/fish/tabry_fish.fish and is described in
+      # sh/fish/README.md; see that README for more info
+      def self.generate(cmd_name, tabry_file_path, uniq_fn_id: nil)
+        generate_internal(
+          cmd_name: cmd_name,
+          import_path: File.expand_path(tabry_file_path),
+          tabry_fish_executable: File.expand_path("#{path_to_tabry}/bin/tabry-fish"),
+          tabry_fish_arg: nil,
+          uniq_fn_id: uniq_fn_id
+        )
+      end
+
+      # Generate fish completion code that will run the currently running
+      # command ($0) with "completion" to get completion options. "cmd_name"
+      # is used to tell fish which command to make options for
+      def self.generate_self(cmd_name: nil)
+        cmd_name ||= File.basename($0)
+        generate_internal(
+          cmd_name: cmd_name,
+          import_path: "",
+          tabry_fish_executable: File.expand_path($0),
+          tabry_fish_arg: "completion",
+        )
+      end
+
+      def self.path_to_tabry
+        File.expand_path("#{__dir__}/../../../")
+      end
+
+      def self.esc(s)
+        Shellwords.escape(s)
+      end
+
+      def self.add_uniq_id(str, pattern, uniq_id)
+        str.gsub! pattern, "#{pattern}_#{uniq_id}"
+      end
+
+      def self.generate_internal(cmd_name:, import_path:, tabry_fish_executable:, tabry_fish_arg:, uniq_fn_id: nil)
+        # uniq_fn_id is added to the bash functions to ensure they are unique
+        # -- by default this is the capitalized command name
+        uniq_fn_id ||= cmd_name
+        uniq_fn_id = uniq_fn_id.upcase.gsub(/[^A-Z0-9_]/, "_")
+        script = File.read("#{__dir__}/../../../sh/fish/tabry_fish.fish")
+
+        add_uniq_id(script, "tabry_completion_init", uniq_fn_id)
+        add_uniq_id(script, "__fish_tabry_internal_invoke", uniq_fn_id)
+        add_uniq_id(script, "__fish_tabry_check_only_args", uniq_fn_id)
+        add_uniq_id(script, "__fish_tabry_check_only_file", uniq_fn_id)
+        add_uniq_id(script, "__fish_tabry_check_args_and_file", uniq_fn_id)
+        add_uniq_id(script, "__fish_tabry_completions", uniq_fn_id)
+
+        script.gsub! "# TABRY_IMPORT_PATH_REPLACE (DO NOT REMOVE)", "set TABRY_IMPORTS_PATH #{esc import_path}"
+        script.gsub! "# TABRY_EXECUTABLE_REPLACE (DO NOT REMOVE)", "set TABRY_EXECUTABLE #{esc tabry_fish_executable}"
+        if !tabry_fish_arg.nil?
+          script.gsub! "# TABRY_ARG_REPLACE (DO NOT REMOVE)", "set TABRY_ARG #{esc tabry_fish_arg}"
+        end
+
+        <<~END_FISH_CODE_TEMPLATE
+          # The following Autocomplete is for a Tabry-powered command. It was
+          # generated by the command itself. See the documentation located in
+          # #{esc path_to_tabry}/sh/fish/README.md
+          #{script}
+          tabry_completion_init_#{uniq_fn_id} #{esc cmd_name}
+        END_FISH_CODE_TEMPLATE
+      end
+    end
+  end
+end

data/lib/tabry/version.rb

@@ -0,0 +1,3 @@
+module Tabry
+  VERSION = "0.2.4"
+end

data/sh/fish/README.md

@@ -2,8 +2,9 @@ This directory includes fish completions for Tabry
 
 There are two steps to add to your ~/.config/fish/config.fish to use:
 
-1. Source this file
+1. Source `tabry_fish.fish`
 2. Add a call to `tabry_completion_init`, for each command
+3. Ensure the `TABRY_IMPORTS_PATH` environment variable is defined and points to where your compiled tabry files are located.
 
 ```sh
 source tabry_fish.fish

data/sh/fish/tabry_fish.fish

@@ -12,14 +12,19 @@ end
 
 # return true if tabry only reports commands
 function __fish_tabry_internal_invoke
-  set SCRIPT (status --current-filename)
-  set SCRIPT_DIR (dirname $SCRIPT)
+  # TABRY_IMPORT_PATH_REPLACE (DO NOT REMOVE)
+  # TABRY_EXECUTABLE_REPLACE (DO NOT REMOVE)
+  # TABRY_ARG_REPLACE (DO NOT REMOVE)
+  set -x TABRY_FISH_MODE true
 
   # -C "Get cursor position"
   set cursor_position (commandline -C)
   set cmd (commandline)
-  set result ($SCRIPT_DIR/../../bin/tabry-bash "$cmd" "$cursor_position")
-  echo $result
+
+  set result ($TABRY_EXECUTABLE $TABRY_ARG "$cmd" "$cursor_position")
+  for arg in $result
+    echo $arg
+  end
 end
 
 # return true if tabry only reports file
@@ -29,7 +34,7 @@ function __fish_tabry_check_only_args
   set args      (echo "$result"|sed 's/  .*//')
   set specials  (echo "$result"|grep -o '  file')
 
-  # https://github.com/fish-shell/fish-shell/issues/5186#issuecomment-421244106
+  # https://github.com/fish-shell/fish-shell/issues/5186#issuecomment-421244106 (the random "x")
   if test "x$args" != "x" -a "$specials" != "  file"
     # echo "confirming only args:  [$result,$args,$specials]" 1>&2
     return 0;
@@ -45,7 +50,8 @@ function __fish_tabry_check_only_file
 
   set args      (echo "$result"|sed 's/  .*//')
 
-  if test "x$args" = "x" -a (string match -ra '  file' $result)
+  # The '--' arg is needed in case $result contains flag-like strings
+  if test "x$args" = "x" -a (string match -ra -- '  file' $result)
     # echo "confirming only file" 1>&2
     return 0;
   else
@@ -59,7 +65,8 @@ function __fish_tabry_check_args_and_file
 
   set args      (echo "$result"|sed 's/  .*//')
 
-  if test "x$args" != "x" -a (string match -ra '  file' $result)
+  # The '--' arg is needed in case $result contains flag-like strings
+  if test "x$args" != "x" -a (string match -ra -- '  file' $result)
     # echo "confirming args and file" 1>&2
     return 0;
   else
@@ -73,15 +80,14 @@ function __fish_tabry_completions
 
   set args      (echo "$result"|sed 's/  .*//')
 
-  set args_parsed (string split ' ' $args)
-
   if test "x$args" = "x"
     # Don't offer anything if we don't have any completions
     return 1;
   else
-    # $args_parsed will be something like: ["foo" "bar" "baz" "" "file"]
+    # $result will be something like: ["foo 'this is foo'" "bar" "baz" "" "file"]
     #   where "file" is special, since it's after the space.
-    for arg in $args_parsed
+    for arg in $result
+      set clean_arg (echo "$arg"|sed 's/  .*//')
       if test "x$arg" != "x"
         echo "$arg"
       else

data/spec/fixtures/config_builder/underscoresdashes.yml

@@ -33,7 +33,7 @@ main:
         - include: project-and-environment
     - include: project-and-environment
 option_includes:
-  project_and_environment:
+  project-and-environment:
     - type: const
       value: a
 

data/spec/fixtures/vehicles-expectations.json

@@ -0,0 +1,351 @@
+{
+  "handles subcommands": [
+    [
+      "build"
+    ],
+    {
+      "subs": [
+        "build"
+      ],
+      "mode": "subcommand"
+    }
+  ],
+  "handles bogus subcommands": [
+    [
+      "bogus"
+    ],
+    {
+      "subs": [
+
+      ],
+      "args": [
+        "bogus"
+      ]
+    }
+  ],
+  "handles bogus subcommands of subcommands are treated as args": [
+    [
+      "move",
+      "bogus",
+      "bogus2"
+    ],
+    {
+      "subs": [
+        "move"
+      ],
+      "args": [
+        "bogus",
+        "bogus2"
+      ],
+      "mode": "subcommand"
+    }
+  ],
+  "handles subcommands of subcommands": [
+    [
+      "move",
+      "go"
+    ],
+    {
+      "subs": [
+        "move",
+        "go"
+      ]
+    }
+  ],
+  "handles subcommands aliases": [
+    [
+      "move",
+      "g"
+    ],
+    {
+      "subs": [
+        "move",
+        "go"
+      ]
+    }
+  ],
+  "handles argsuments": [
+    [
+      "build",
+      "arg1",
+      "arg2"
+    ],
+    {
+      "subs": [
+        "build"
+      ],
+      "args": [
+        "arg1",
+        "arg2"
+      ]
+    }
+  ],
+  "handles flags": [
+    [
+      "build",
+      "-v"
+    ],
+    {
+      "subs": [
+        "build"
+      ],
+      "flags": {
+        "verbose": true
+      },
+      "args": [
+
+      ],
+      "mode": "subcommand"
+    }
+  ],
+  "handles long flags": [
+    [
+      "--verbose",
+      "build"
+    ],
+    {
+      "subs": [
+        "build"
+      ],
+      "flags": {
+        "verbose": true
+      },
+      "args": [
+
+      ],
+      "mode": "subcommand"
+    }
+  ],
+  "handles flags interspersed with arguments": [
+    [
+      "move",
+      "-v",
+      "crash",
+      "arg1",
+      "--dry-run",
+      "arg2",
+      "arg3"
+    ],
+    {
+      "subs": [
+        "move",
+        "crash"
+      ],
+      "args": [
+        "arg1",
+        "arg2",
+        "arg3"
+      ],
+      "flags": {
+        "dry-run": true,
+        "verbose": true
+      },
+      "mode": "subcommand"
+    }
+  ],
+  "handles flags with an argument": [
+    [
+      "move",
+      "crash",
+      "--dry-run",
+      "arg1",
+      "-f",
+      "file",
+      "arg2",
+      "arg3"
+    ],
+    {
+      "subs": [
+        "move",
+        "crash"
+      ],
+      "args": [
+        "arg1",
+        "arg2",
+        "arg3"
+      ],
+      "flags": {
+        "dry-run": true,
+        "output-to-file": "file"
+      },
+      "mode": "subcommand"
+    }
+  ],
+  "handles double-dash to stop parsing of flags": [
+    [
+      "move",
+      "crash",
+      "--",
+      "--dry-run",
+      "arg1",
+      "-f",
+      "file",
+      "arg2",
+      "arg3"
+    ],
+    {
+      "subs": [
+        "move",
+        "crash"
+      ],
+      "args": [
+        "--dry-run",
+        "arg1",
+        "-f",
+        "file",
+        "arg2",
+        "arg3"
+      ],
+      "mode": "subcommand",
+      "dashdash": true
+    }
+  ],
+  "handles unknown long flags as args": [
+    [
+      "move",
+      "crash",
+      "--notaflag",
+      "arg2"
+    ],
+    {
+      "subs": [
+        "move",
+        "crash"
+      ],
+      "args": [
+        "--notaflag",
+        "arg2"
+      ],
+      "mode": "subcommand"
+    }
+  ],
+  "handles unknown short flags as args": [
+    [
+      "move",
+      "crash",
+      "-x",
+      "arg2",
+      "--dry-run"
+    ],
+    {
+      "subs": [
+        "move",
+        "crash"
+      ],
+      "args": [
+        "-x",
+        "arg2"
+      ],
+      "flags": {
+        "dry-run": true
+      },
+      "mode": "subcommand"
+    }
+  ],
+  "handles --help": [
+    [
+      "move",
+      "--help"
+    ],
+    {
+      "subs": [
+        "move"
+      ],
+      "flags": {
+      },
+      "args": [
+
+      ],
+      "help": true,
+      "mode": "subcommand"
+    }
+  ],
+  "handles -?": [
+    [
+      "move",
+      "foo",
+      "bar",
+      "--help",
+      "waz"
+    ],
+    {
+      "subs": [
+        "move"
+      ],
+      "flags": {
+      },
+      "args": [
+        "foo",
+        "bar",
+        "waz"
+      ],
+      "help": true
+    }
+  ],
+  "ignores -?/--help after double-dash": [
+    [
+      "move",
+      "--",
+      "--help",
+      "-?",
+      "--",
+      "-"
+    ],
+    {
+      "subs": [
+        "move"
+      ],
+      "flags": {
+      },
+      "args": [
+        "--help",
+        "-?",
+        "--",
+        "-"
+      ],
+      "help": false,
+      "dashdash": true
+    }
+  ],
+  "sets mode to flagarg when waiting for a flag argument": [
+    [
+      "move",
+      "crash",
+      "--dry-run",
+      "arg1",
+      "-f"
+    ],
+    {
+      "subs": [
+        "move",
+        "crash"
+      ],
+      "args": [
+        "arg1"
+      ],
+      "flags": {
+        "dry-run": true
+      },
+      "mode": "flagarg",
+      "current_flag": "output-to-file"
+    }
+  ],
+  "most specific sub's flag takes precedence in case of multiple matching": [
+    [
+      "sub-with-mandatory-flag",
+      "--verbose",
+      "foo",
+      "--mandatory",
+      "abc"
+    ],
+    {
+      "subs": [
+        "sub-with-mandatory-flag"
+      ],
+      "flags": {
+        "verbose": "foo",
+        "mandatory": "abc"
+      }
+    }
+  ]
+}

data/spec/tabry/cli/all_in_one_spec.rb

@@ -3,6 +3,7 @@
 require_relative "../../../lib/tabry/cli/all_in_one"
 require_relative "../../../lib/tabry/shells/bash"
 require_relative "../../../lib/tabry/shells/bash/wrapper"
+require_relative "../../../lib/tabry/shells/fish"
 
 module Tabry::Spec
   module Cli
@@ -124,6 +125,17 @@ describe Tabry::CLI::AllInOne do
       end
     end
 
+    it "creates a #completion__fish method which generates completion" do
+      stub_const("ARGV", %w[completion fish])
+      expect(Tabry::Shells::Fish).to receive(:generate_self).with(cmd_name: "foo").and_return("fish completion stuff")
+      expect_any_instance_of(Kernel).to receive(:puts).with("fish completion stuff")
+
+      described_class.completion_only do
+        cmd :foo
+        sub :bar
+      end
+    end
+
     it "creates a #completion method which generates options" do
       stub_const("ARGV", ["completion", "cmd line", "6"])
       expect(Tabry::Bash::Wrapper).to receive(:run) do |cmd_line, comp_point, config:|

data/spec/tabry/machine_spec.rb

@@ -15,94 +15,17 @@ describe Tabry::Machine do
     expect(subject.args).to eq(arr)
   end
 
-  examples = {
-    "handles subcommands" => [
-      %w[build],
-      subs: %w[build], mode: :subcommand
-    ],
-    "handles bogus subcommands" => [
-      %w[bogus],
-      subs: [], args: %w[bogus]
-    ],
-    "handles bogus subcommands of subcommands are treated as args" => [
-      %w[move bogus bogus2],
-      subs: %w[move], args: %w[bogus bogus2], mode: :subcommand
-    ],
-    "handles subcommands of subcommands" => [
-      %w[move go],
-      subs: %w[move go],
-    ],
-    "handles subcommands aliases" => [
-      %w[move g],
-      subs: %w[move go],
-    ],
-    "handles argsuments" => [
-      %w[build arg1 arg2],
-      subs: %w[build], args: %w[arg1 arg2]
-    ],
-    "handles flags" => [
-      %w[build -v],
-      subs: %w[build], flags: { "verbose" => true }, args: [], mode: :subcommand
-    ],
-    "handles long flags" => [
-      %w[--verbose build],
-      subs: %w[build], flags: { "verbose" => true }, args: [], mode: :subcommand
-    ],
-    "handles flags interspersed with arguments" => [
-      %w[move -v crash arg1 --dry-run arg2 arg3],
-      subs: %w[move crash], args: %w[arg1 arg2 arg3],
-      flags: { "dry-run" => true, "verbose" => true }, mode: :subcommand
-    ],
-    "handles flags with an argument" => [
-      %w[move crash --dry-run arg1 -f file arg2 arg3],
-      subs: %w[move crash], args: %w[arg1 arg2 arg3],
-      flags: { "dry-run" => true, "output-to-file" => "file" }, mode: :subcommand
-    ],
-    "handles double-dash to stop parsing of flags" => [
-      %w[move crash -- --dry-run arg1 -f file arg2 arg3],
-      subs: %w[move crash], args: %w[--dry-run arg1 -f file arg2 arg3], mode: :subcommand
-    ],
-    "handles unknown long flags as args" => [
-      %w[move crash --notaflag arg2],
-      subs: %w[move crash], args: %w[--notaflag arg2], mode: :subcommand
-    ],
-    "handles unknown short flags as args" => [
-      %w[move crash -x arg2 --dry-run],
-      subs: %w[move crash], args: %w[-x arg2], flags: { "dry-run" => true }, mode: :subcommand
-    ],
-    "handles --help" => [
-      %w[move --help],
-      subs: %w[move], flags: {}, args: [], help: true, mode: :subcommand
-    ],
-    "handles -?" => [
-      %w[move foo bar --help waz],
-      subs: %w[move], flags: {}, args: %w[foo bar waz], help: true
-    ],
-    "ignores -?/--help after double-dash" => [
-      %w[move -- --help -? -- -],
-      subs: %w[move], flags: {}, args: %w[--help -? -- -], help: nil
-    ],
-    "sets mode to flagarg when waiting for a flag argument" => [
-      %w[move crash --dry-run arg1 -f],
-      subs: %w[move crash], args: %w[arg1], flags: { "dry-run" => true },
-      mode: :flagarg, current_flag: "output-to-file"
-    ],
-    # TODO: might want behavior to be different; currently I think if --verbose is before the
-    # subcommand it use's the main command's --verbose flag
-    "most specific sub's flag takes precedence in case of multiple matching" => [
-      %w[sub-with-mandatory-flag --verbose foo --mandatory abc],
-      subs: %w[sub-with-mandatory-flag],
-      flags: { "verbose" => "foo", "mandatory" => "abc" }
-    ]
-  }
+  examples = JSON.parse(File.read("#{__dir__}/../fixtures/vehicles-expectations.json"))
 
   examples.each do |test_name, (tokens, expectation)|
     it test_name do
       pending unless expectation
       result = described_class.run(config, tokens)
       expectation.each do |key, val|
-        key = :subcommand_stack if key == :subs
-        expect(result.send(key)).to eq(val)
+        key = 'subcommand_stack' if key == 'subs'
+        res = result.send(key.to_sym)
+        res = res.to_s if res.is_a?(Symbol)
+        expect(res).to eq(val)
       end
     end
   end

data/spec/tabry/shell_tokenizer_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "../../lib/tabry/shell_tokenizer"
+
+describe Tabry::ShellTokenizer do
+  describe ".split_with_comppoint" do
+    it "returns the command basename, argument, and last argument" do
+      str = "foo/bar abc def ghi"
+      expect(described_class.split_with_comppoint(str, 13)).to eq(["bar", ["abc"], "def"])
+    end
+
+    it "returns [] as arguments and the last argument as non-nil when there is only one arg" do
+      expect(described_class.split_with_comppoint("foo bar", 5)).to eq(["foo", [], "bar"])
+    end
+
+    it "handles quotes and backslashes like a shell" do
+      expect(described_class.split_with_comppoint('"/foo bar/waz" a\'b \'c\\ d "ef g" "hi jk" lmn', 38)).to eq(
+        [
+          "waz",
+          ["ab c d", "ef g"],
+          "hi jk"
+        ]
+      )
+    end
+
+    it "supports tokens with argument (tab on command), yielding the last arg" do
+      expect(described_class.split_with_comppoint("abc", 2)).to eq([nil, [], "abc"])
+    end
+
+    it "supports empty strings" do
+      expect(described_class.split_with_comppoint("", 0)).to eq([nil, [], ""])
+    end
+  end
+end