tabry 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 238e670dd915a52c21ff0af689fd3885261deba3caee10dae8972f06cbf90ccb
-  data.tar.gz: ff161d2cda396309d243a8f1dd5f4a75a6b154f6bdacedb7ee7e59c4bae5d8f5
+  metadata.gz: fe7c5c94f54f4d6fb603a73a8ec6b8364c63b6247a9dc3f095d4359fe96b5018
+  data.tar.gz: 4a29c24624360099c44dfd5c8c1420ef701bb21ee6535dc1e7a3540315002811
 SHA512:
-  metadata.gz: 66d5af76b745d7cb56c1905f095c7b137acfd3d816f4e8fb070c0ccf8c76c5be123c85ebc5b1fc29480e73485a7f9dacb438d98c0f514009830afabb5ec13426
-  data.tar.gz: 30545a229fc13939596285535d84a6e69cc73c08e248f0d3a3bf18cbba18a379dbc26a1756c9f9266081503d277da15738d0608e573a219715b8d46211eb8772
+  metadata.gz: b9b58e549801135afe35686048bd3b84b76c9e41cb5ecd5dc49bff3a1c3ea3ac26f10a2187eca5775ce4aa2d02d46157c559cefc2d376267ff62ebcf630b721c
+  data.tar.gz: a21e775881c48a511363cce6690e99cd13ccb32a3b829670bf049f3de63ab6e590b351a591717bb8137f112eb0e81514f548cefb8e3a0f4a79e5339118fafb33

data/lib/tabry/cli/base.rb

@@ -14,8 +14,11 @@ module Tabry
         @internals = internals
       end
 
-      def self.sub_route(prefix, cli_class)
-        (@sub_route_clis ||= {})[prefix.to_s] = cli_class
+      def self.sub_route(*prefixes, to:, **opts)
+        prefixes.map(&:to_s).each do |prefix|
+          (@sub_route_clis ||= {})[prefix] = to
+          (@sub_route_clis_opts ||= {})[prefix] = opts
+        end
       end
 
       def self.after_action(*method_names, only: nil, except: nil, &blk)

data/lib/tabry/cli/builder.rb

@@ -72,8 +72,12 @@ module Tabry
         sub_name, rest = met.split("__", 2)
 
         if sub_route_clis&.dig(sub_name)
+          # Instantiate CLI if it hasn't already (and store instantiation)
           sub_route_clis[sub_name] = instantiate_cli(sub_route_clis[sub_name], internals)
-          get_cli_object_and_met(sub_route_clis[sub_name], rest, internals)
+          opts = cli.class.instance_variable_get(:@sub_route_clis_opts)[sub_name]
+
+          new_met_name = opts[:full_method_name] ? met : rest
+          get_cli_object_and_met(sub_route_clis[sub_name], new_met_name, internals)
         else
           [cli, met]
         end

data/lib/tabry/result.rb

@@ -35,7 +35,11 @@ module Tabry
 
     def wrong_number_of_args?
       n_args = state.args.length
-      if n_args == 0 && current_sub.subs.any?
+      # This could use some tweaking. I'm not at which point a subcommand
+      # should be considered to be invalid with no arguments... if it has a
+      # subcommand it's a good sign, but if it also has an optional argument
+      # that means it's OK. Probably need another "no_args" construct.
+      if n_args == 0 && current_sub.subs.any? && !(current_sub.args.any? && current_sub.min_args == 0)
         if current_sub.args.any?
           "missing subcommand or arg(s)"
         else

data/lib/tabry/shell_splitter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Use Shellwords.split() to split a command line + comp point (index of the
 # cursor in the command line) into the args up to the current token plus
 # current token

data/spec/fixtures/vehicles.tabry

@@ -45,6 +45,11 @@ sub sub-with-sub-or-arg {
   sub subsub
 }
 
+sub sub-with-sub-or-opt-arg{
+  sub subsub
+  opt arg
+}
+
 sub sub-with-mandatory-flag {
   opt arg { opts const (a b c) }
   reqd flagarg mandatory

data/spec/fixtures/vehicles.yaml

@@ -101,6 +101,11 @@ main:
               value: z
       subs:
         - name: subsub
+    - name: sub-with-sub-or-opt-arg
+      subs:
+        - name: subsub
+      args:
+        - optional: true
     - name: sub-with-mandatory-flag
       args:
         - optional: true

data/spec/lib/tabry/cli/util_spec.rb

@@ -1,30 +1,32 @@
+# frozen_string_literal: true
+
 require_relative "../../../../lib/tabry/cli/util"
 
 describe Tabry::CLI::Util do
   describe ".make_cmdline" do
     it "escapes a single string" do
       expect(described_class.make_cmdline(
-        "hello %s", "world;abc"
-      )).to eq(
-        "hello world\\;abc"
-      )
+               "hello %s", "world;abc"
+             )).to eq(
+               "hello world\\;abc"
+             )
     end
 
     it "escapes multiple string arguments" do
       expect(described_class.make_cmdline(
-        "hello %s hi %s", "world;abc", "def;ghi"
-      )).to eq(
-        "hello world\\;abc hi def\\;ghi"
-      )
+               "hello %s hi %s", "world;abc", "def;ghi"
+             )).to eq(
+               "hello world\\;abc hi def\\;ghi"
+             )
     end
 
     it "escapes array arguments" do
       # args is an array of strings and arrays
       expect(described_class.make_cmdline(
-        "hello %s hi %s", "world;abc", ["foo;bar", "waz;ok"]
-      )).to eq(
-        "hello world\\;abc hi foo\\;bar waz\\;ok"
-      )
+               "hello %s hi %s", "world;abc", ["foo;bar", "waz;ok"]
+             )).to eq(
+               "hello world\\;abc hi foo\\;bar waz\\;ok"
+             )
     end
 
     it "treats a single array of strings as a list of args, not as one array arg" do
@@ -32,27 +34,27 @@ describe Tabry::CLI::Util do
       # an improvement might be to figure out how
       # many '%s's there are in the cmdline
       expect(described_class.make_cmdline(
-        "hello %s hi %s", ["world;abc", "foo;bar"]
-      )).to eq(
-        "hello world\\;abc hi foo\\;bar"
-      )
+               "hello %s hi %s", ["world;abc", "foo;bar"]
+             )).to eq(
+               "hello world\\;abc hi foo\\;bar"
+             )
     end
 
     it "escapes arrays if given one array of mixed strings and arrays" do
       expect(described_class.make_cmdline(
-        "hello %s hi %s", [["world;abc", "foo;bar"], "waz;ok"]
-      )).to eq(
-        "hello world\\;abc foo\\;bar hi waz\\;ok"
-      )
+               "hello %s hi %s", [["world;abc", "foo;bar"], "waz;ok"]
+             )).to eq(
+               "hello world\\;abc foo\\;bar hi waz\\;ok"
+             )
     end
 
     it "can send a single array argument by wrapping in an array" do
       # args is an array with one array of one array
       expect(described_class.make_cmdline(
-        "hello %s hi", [["foo;bar", "waz;ok"]]
-      )).to eq(
-        "hello foo\\;bar waz\\;ok hi"
-      )
+               "hello %s hi", [["foo;bar", "waz;ok"]]
+             )).to eq(
+               "hello foo\\;bar waz\\;ok hi"
+             )
     end
   end
 end

data/spec/tabry/cli/builder_spec.rb

@@ -28,7 +28,33 @@ class Tabry::CLI::Builder
   end
 
   class TestCliFoo < Tabry::CLI::Base
-    sub_route :bar, TestCliFooBar
+    sub_route :bar, to: TestCliFooBar
+  end
+
+  class TestCli2 < Tabry::CLI::Base
+    class << self
+      attr_accessor :actions_run, :cli_object
+    end
+
+    after_action :my_after_action, except: :build2
+
+    def build2
+      self.class.actions_run << :build2
+    end
+
+    def sub__sub_sub
+      self.class.actions_run << :sub__sub_sub
+    end
+
+    def my_before_action
+      self.class.actions_run << :before_action
+      self.class.cli_object = self
+    end
+
+    def my_after_action
+      self.class.actions_run << :after_action
+      self.class.cli_object = self
+    end
   end
 
   class TestCli < Tabry::CLI::Base
@@ -37,9 +63,10 @@ class Tabry::CLI::Builder
     end
 
     before_action :my_before_action, only: :build
-    after_action :my_after_action, except: :build2
+    after_action :my_after_action
 
-    sub_route :foo, TestCliFoo
+    sub_route :foo, to: TestCliFoo
+    sub_route :sub, :build2, to: TestCli2, full_method_name: true
 
     def main
       self.class.actions_run << :main
@@ -49,18 +76,10 @@ class Tabry::CLI::Builder
       self.class.actions_run << :build
     end
 
-    def build2
-      self.class.actions_run << :build2
-    end
-
     def my_action
       self.class.actions_run << :my_action
     end
 
-    def sub__sub_sub
-      self.class.actions_run << :sub__sub_sub
-    end
-
     def my_before_action
       self.class.actions_run << :before_action
       self.class.cli_object = self
@@ -99,7 +118,8 @@ describe Tabry::CLI::Builder do
   let(:builder) { described_class.new("theconfigname", Tabry::CLI::Builder::TestCli) }
 
   let(:cli_class) { Tabry::CLI::Builder::TestCli }
-  let(:cli_class2) { Tabry::CLI::Builder::TestCliFooBar }
+  let(:cli_class2) { Tabry::CLI::Builder::TestCli2 }
+  let(:cli_class_foo_bar) { Tabry::CLI::Builder::TestCliFooBar }
   let(:actions_run) { cli_class.actions_run }
   let(:cli_object) { cli_class.cli_object }
 
@@ -108,6 +128,8 @@ describe Tabry::CLI::Builder do
     cli_class.cli_object = nil
     cli_class2.actions_run = []
     cli_class2.cli_object = nil
+    cli_class_foo_bar.actions_run = []
+    cli_class_foo_bar.cli_object = nil
   end
 
   describe "successful runs" do
@@ -132,7 +154,7 @@ describe Tabry::CLI::Builder do
     describe "except on actions" do
       let(:state) { { subcommand_stack: %w[build2] } }
 
-      it { expect(actions_run).to eq %i[build2] }
+      it { expect(cli_class2.actions_run).to eq %i[build2] }
     end
 
     describe "handling multiple levels of subcommand routing" do
@@ -143,14 +165,23 @@ describe Tabry::CLI::Builder do
       end
 
       it "maps to the sub-CLI" do
-        expect(cli_class2.actions_run).to eq(%i[before_action waz])
+        expect(cli_class_foo_bar.actions_run).to eq(%i[before_action waz])
+      end
+    end
+
+    describe "subcommand routing with full_method_name: true" do
+      let(:state) { { subcommand_stack: %i[sub sub_sub] } }
+
+      it "preserves the full method name" do
+        expect(cli_class.actions_run).to eq(%i[])
+        expect(cli_class2.actions_run).to eq(%i[sub__sub_sub after_action])
       end
     end
 
     describe "handling multiple levels of subcommand routing (main method)" do
       let(:state) { { subcommand_stack: %i[foo bar] } }
 
-      it { expect(cli_class2.actions_run).to eq(%i[before_action main]) }
+      it { expect(cli_class_foo_bar.actions_run).to eq(%i[before_action main]) }
     end
 
     describe "providing an ArgProxy in TestCLI#args" do

data/spec/tabry/config_loader_spec.rb

@@ -17,7 +17,7 @@ describe Tabry::ConfigLoader do
     config = described_class.load(name: "#{__dir__}/../fixtures/vehicles.yaml")
     expect(config).to be_a(Tabry::Models::Config)
     expect(config.main.subs.map(&:name)).to eq(
-      %w[build list-vehicles move sub-with-sub-or-arg sub-with-mandatory-flag]
+      %w[build list-vehicles move sub-with-sub-or-arg sub-with-sub-or-opt-arg sub-with-mandatory-flag]
     )
   end
 
@@ -27,7 +27,7 @@ describe Tabry::ConfigLoader 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]
+        %w[build list-vehicles move sub-with-sub-or-arg sub-with-sub-or-opt-arg sub-with-mandatory-flag]
       )
     end
 

data/spec/tabry/options_finder_spec.rb

@@ -12,7 +12,7 @@ describe Tabry::OptionsFinder do
 
   examples = {
     "lists possible subcommands of the main command" => [
-      %w[build list-vehicles move sub-with-sub-or-arg sub-with-mandatory-flag],
+      %w[build list-vehicles move sub-with-sub-or-arg sub-with-sub-or-opt-arg sub-with-mandatory-flag],
       {}
     ],
     "lists possible subcommands of a subcommand" => [

data/spec/tabry/result_spec.rb

@@ -70,6 +70,10 @@ describe Tabry::Result do
              )).to be_nil
     end
 
+    it "doesn't complain if given no args to a subcommand with subcommands and optional args" do
+      expect(reason(subcommand_stack: %w[sub-with-sub-or-opt-arg])).to be_nil
+    end
+
     it "complains if mandatory varargs are not given" do
       expect(reason(
                subcommand_stack: %w[build]

data/spec/tabry/shell_splitter_spec.rb

@@ -3,18 +3,18 @@
 require_relative "../../lib/tabry/shell_splitter"
 
 describe Tabry::ShellSplitter do
-  describe '.split' do
+  describe ".split" do
     it "returns the command basename, argument, and last argument" do
-      str = 'foo/bar abc def ghi'
+      str = "foo/bar abc def ghi"
       expect(described_class.split(str, 13)).to eq(["bar", ["abc"], "def"])
     end
 
-    it "it handles quotes and backslashes like a shell" do
+    it "handles quotes and backslashes like a shell" do
       expect(described_class.split('"/foo bar/waz" a\'b \'c\\ d "ef g" "hi jk" lmn', 38)).to eq([
-        "waz",
-        ["ab c d", "ef g"],
-        "hi jk"
-      ])
+                                                                                                  "waz",
+                                                                                                  ["ab c d", "ef g"],
+                                                                                                  "hi jk"
+                                                                                                ])
     end
   end
 end

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.4"
+  s.version     = "0.1.5"
   s.summary     = "Tab completion and CLIs extraordinaire"
   s.authors     = ["Evan Battaglia"]
   s.email       = "battaglia.evan@gmail.com"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tabry
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Evan Battaglia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-22 00:00:00.000000000 Z
+date: 2022-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -225,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Tab completion and CLIs extraordinaire