tabry 0.1.5 → 0.2.1

data/lib/tabry/shells/bash/wrapper.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "shellwords"
+require "yaml"
+require_relative "../../util"
+require_relative "../../runner"
+require_relative "../../shell_splitter"
+
+# Bash-specific entrypoint, taking COMP_WORDS and COMP_CWORDS and returning possible options
+module Tabry
+  module Bash
+    module Wrapper
+      def self.run(cmd_line, comp_point, config: nil)
+        cmd_name, args, last_arg = Tabry::ShellSplitter.split(cmd_line, comp_point)
+        opts = Tabry::Runner.new(config: config || cmd_name).options(args, last_arg)
+
+        if Tabry::Util.debug?
+          require "json"
+          $stderr.puts
+          warn "debug: got command line and comp_point: #{cmd_line.inspect}, #{comp_point}"
+          warn "using args: #{args.inspect}"
+          warn "using lastarg: #{last_arg.inspect}"
+          warn "results from Tabry#options(): #{opts.inspect}"
+          warn "--- end debug output ---"
+        end
+
+        normal_opts = opts.select { |t| t.is_a?(String) }
+        special_opts = opts.select { |t| t.is_a?(Symbol) }
+
+        puts normal_opts.map { |t| Shellwords.escape(t) }.join("\n")
+        if special_opts.any?
+          puts
+          puts special_opts.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/tabry/shells/bash.rb

@@ -7,27 +7,64 @@
 # conflicts.
 # See sh/bash/README.md and "Adding Tab Completion to your CLI" in main README
 
+require "shellwords"
+
 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__}/../../../"))
+      # ruby_path and run_tabry_bash_directly are mutually
+      # exclusive -- use run_tabry_bash_directly to use the
+      # shebang in the tabry-bash file
+      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_bash_executable: File.expand_path("#{path_to_tabry}/bin/tabry-bash"),
+          tabry_bash_arg: nil,
+          uniq_fn_id: uniq_fn_id
+        )
+      end
+
+      # Generate bash completion code that will run the currently running
+      # command ($0) with "completion" to get completion options. "cmd_name"
+      # is used to tell bash which command to make options for (and
+      # for naming of the _tabry_CMD_NAME_completions_internal bash function)
+      def self.generate_self(cmd_name: nil)
+        cmd_name ||= File.basename($0)
+        generate_internal(
+          cmd_name: cmd_name,
+          import_path: "",
+          tabry_bash_executable: File.expand_path($0),
+          tabry_bash_arg: "completion"
+        )
+      end
+
+      def self.path_to_tabry
+        File.expand_path("#{__dir__}/../../../")
+      end
+
+      def self.esc(s)
+        Shellwords.escape(s)
+      end
 
+      def self.generate_internal(cmd_name:, import_path:, tabry_bash_executable:, tabry_bash_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_]/, "_")
         core = File.read("#{__dir__}/../../../sh/bash/tabry_bash_core.sh")
-        core.gsub! "_tabry_completions_internal()", "_tabry_#{capitalized_cmd_name}_completions_internal()"
+        core.gsub! "_tabry_completions_internal()", "_tabry_#{uniq_fn_id}_completions_internal()"
 
         <<~END_BASH_CODE_TEMPLATE + 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
+          # #{esc path_to_tabry}/sh/bash/README.md
+          _tabry_#{uniq_fn_id}_completions() {
+            TABRY_IMPORTS_PATH=#{esc import_path} _tabry_#{uniq_fn_id}_completions_internal #{esc tabry_bash_executable} #{tabry_bash_arg && esc(tabry_bash_arg)}
           }
-          complete -F _tabry_#{capitalized_cmd_name}_completions #{Shellwords.escape cmd_name}
+          complete -F _tabry_#{uniq_fn_id}_completions #{esc cmd_name}
         END_BASH_CODE_TEMPLATE
       end
     end

data/sh/bash/tabry_bash.sh

@@ -17,6 +17,6 @@
 
 source "$( dirname "${BASH_SOURCE[0]:-${(%):-%x}}" )"/tabry_bash_core.sh
 _tabry_completions() {
-  _tabry_completions_internal "$( dirname "${BASH_SOURCE[0]:-${(%):-%x}}" )"/../../bin/tabry-bash
+  _tabry_completions_internal ruby "$( dirname "${BASH_SOURCE[0]:-${(%):-%x}}" )"/../../bin/tabry-bash
 }
 

data/sh/bash/tabry_bash_core.sh

@@ -2,13 +2,14 @@
 # See sh/bash/README.md and sh/bash/tabry_bash.sh in the tabry gem
 _tabry_completions_internal()
 {
-  local tabry_bash="$1"
+  local tabry_bash_executable="$1"
+  local tabry_bash_arg="$2"
 
   [[ -n "$TABRY_DEBUG" ]] && echo && echo -n tabry start bash: && date +%s.%N >&2
   local saveifs="$IFS"
   IFS=$'\n'
 
-  local result=`ruby "$tabry_bash" "$COMP_LINE" "$COMP_POINT"`
+  local result=`"$tabry_bash_executable" ${tabry_bash_arg:+"$tabry_bash_arg"} "$COMP_LINE" "$COMP_POINT"`
   local specials
 
   if [[ $result == *$'\n'$'\n'* ]]; then

data/spec/fixtures/config_builder/args.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Tabry
+  module Spec
+    module Fixtures
+      module ConfigBuilder
+        Args = Tabry::ConfigBuilder.build do
+          cmd "argstest"
+
+          arg do
+            opts const :a
+            opts shell "ls"
+            opts const %w[T F true false yes no]
+            opts file
+            opts dir
+          end
+
+          arg :foo
+          arg :foo, :@whatever
+          arg :foo, "desc", :@whatever do
+            opts const :abc
+          end
+
+          opt_arg
+          opt_arg :foo, :@whatever do
+            opts const :abc
+          end
+
+          arg do
+            include :@foo
+            opts const :abc
+          end
+
+          opt_varargs "rest-args-optional" do
+            opts const %w[foo bar waz]
+          end
+
+          arg :thing_to_search_for do
+            title "thing to search for"
+          end
+
+          varargs :files_to_load do
+            title "file to load"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/config_builder/args.tabry

@@ -0,0 +1,32 @@
+cmd argstest
+
+arg {
+  opts const a
+  opts shell "ls"
+  opts const (T F true false yes no)
+  opts file
+  opts dir
+}
+
+arg foo
+arg foo @whatever
+arg foo "desc" @whatever {
+  opts const abc
+}
+
+opt arg
+opt arg foo @whatever {
+  opts const abc
+}
+
+arg {
+  include @foo
+  opts const abc
+}
+
+opt varargs rest-args-optional { opts const (foo bar waz) }
+
+arg thing_to_search_for { title "thing to search for" }
+varargs files_to_load { title "file to load" }
+
+

data/spec/fixtures/config_builder/args.yml

@@ -0,0 +1,63 @@
+cmd: argstest
+main:
+  args:
+    - options:
+        - type: const
+          value: a
+        - type: shell
+          value: ls
+        - type: const
+          value: T
+        - type: const
+          value: F
+        - type: const
+          value: "true"
+        - type: const
+          value: "false"
+        - type: const
+          value: "yes"
+        - type: const
+          value: "no"
+        - type: file
+        - type: dir
+    - name: foo
+    - name: foo
+      options:
+        - type: include
+          value: whatever
+    - name: foo
+      options:
+        - type: include
+          value: whatever
+        - type: const
+          value: abc
+      description: desc
+    - optional: true
+    - name: foo
+      optional: true
+      options:
+        - type: include
+          value: whatever
+        - type: const
+          value: abc
+    - options:
+        - type: include
+          value: foo
+        - type: const
+          value: abc
+    - name: rest-args-optional
+      optional: true
+      varargs: true
+      options:
+        - type: const
+          value: foo
+        - type: const
+          value: bar
+        - type: const
+          value: waz
+    - name: thing_to_search_for
+      title: thing to search for
+    - name: files_to_load
+      varargs: true
+      title: file to load
+

data/spec/fixtures/config_builder/defs.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Tabry
+  module Spec
+    module Fixtures
+      module ConfigBuilder
+        Defs = Tabry::ConfigBuilder.build do
+          cmd :defstest
+
+          defopts :@bar do
+            opts const :def
+          end
+
+          defopts :@environment do
+            opts const %w[prod beta dev]
+          end
+
+          defargs :@verbose do
+            flag :verbose, "Show more info"
+          end
+
+          defargs "@project-and-environment" do
+            arg :project, "The project" do
+              opts const %w[project1 project2]
+            end
+
+            arg :environment, "The environment", :@environment
+          end
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/config_builder/defs.tabry

@@ -0,0 +1,21 @@
+cmd defstest
+
+defopts @bar {
+  opts const def
+}
+
+defopts @environment {
+  opts const (prod beta dev)
+}
+
+defargs @verbose {
+  flag verbose "Show more info"
+}
+
+defargs @project-and-environment {
+  arg project "The project" { opts const (project1 project2) }
+  arg environment "The environment" @environment
+}
+
+
+

data/spec/fixtures/config_builder/defs.yml

@@ -0,0 +1,33 @@
+cmd: defstest
+main: {}
+option_includes:
+  bar:
+    - type: const
+      value: def
+  environment:
+    - type: const
+      value: prod
+    - type: const
+      value: beta
+    - type: const
+      value: dev
+arg_includes:
+  verbose:
+    flags:
+      - name: verbose
+        description: Show more info
+  project-and-environment:
+    args:
+      - name: project
+        description: The project
+        options:
+          - type: const
+            value: project1
+          - type: const
+            value: project2
+      - name: environment
+        options:
+          - type: include
+            value: environment
+        description: The environment
+

data/spec/fixtures/config_builder/flags.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Tabry
+  module Spec
+    module Fixtures
+      module ConfigBuilder
+        Flags = Tabry::ConfigBuilder.build do
+          cmd :flagstest
+
+          flag :foo1
+          flag :foo2, "Some desc"
+          flag "dry-run2,r", "Don't act, only show what would be done"
+
+          flagarg "foo3"
+          flagarg :b do
+            opts const :a
+          end
+
+          flagarg "f,format" do
+            opts const %w[json yml]
+          end
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/config_builder/flags.tabry

@@ -0,0 +1,13 @@
+cmd flagstest
+
+flag foo1
+flag foo2 "Some desc"
+flag dry-run2,r "Don't act, only show what would be done"
+
+flagarg foo3
+flagarg b {
+  opts const a
+}
+
+flagarg f,format { opts const (json yml) }
+

data/spec/fixtures/config_builder/flags.yml

@@ -0,0 +1,27 @@
+cmd: flagstest
+main:
+  flags:
+    - name: foo1
+    - name: foo2
+      description: Some desc
+    - name: dry-run2
+      aliases:
+        - r
+      description: Don't act, only show what would be done
+    - name: foo3
+      arg: true
+    - name: b
+      arg: true
+      options:
+        - type: const
+          value: a
+    - name: f
+      aliases:
+        - format
+      arg: true
+      options:
+        - type: const
+          value: json
+        - type: const
+          value: yml
+

data/spec/fixtures/config_builder/subs.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Tabry
+  module Spec
+    module Fixtures
+      module ConfigBuilder
+        Subs = Tabry::ConfigBuilder.build do
+          cmd :substest
+
+          sub :list, "List the things"
+          sub "delete,d", :@verbose do
+            desc "Delete a thing"
+            arg
+          end
+
+          # status command acts and project-and-environment as well
+          sub :status, "foo", "@project-and-environment", :@verbose do
+            flagarg :env, :@environment
+          end
+
+          sub :mysub1 do
+            sub :mysub2 do
+              flag :someopt
+              opt_arg "mysub2-arg"
+            end
+          end
+
+          # Top-level include
+          include "@project-and-environment"
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/config_builder/subs.tabry

@@ -0,0 +1,25 @@
+cmd substest
+
+sub list "List the things"
+sub delete,d @verbose {
+  desc "Delete a thing"
+  arg
+}
+
+# status command acts and project-and-environment as well
+sub status "foo" @project-and-environment @verbose {
+  flagarg env @environment
+}
+
+sub mysub1 {
+  sub mysub2 {
+    flag someopt
+    opt arg mysub2-arg
+  }
+}
+
+# Top-level include
+include @project-and-environment
+
+
+

data/spec/fixtures/config_builder/subs.yml

@@ -0,0 +1,46 @@
+cmd: substest
+main:
+  subs:
+    - name: list
+      description: List the things
+    - name: delete
+      aliases:
+        - d
+      args:
+        - include: verbose
+        - {}
+      flags:
+        - include: verbose
+      subs:
+        - include: verbose
+      description: Delete a thing
+    - name: status
+      description: foo
+      args:
+        - include: project-and-environment
+        - include: verbose
+      flags:
+        - include: project-and-environment
+        - include: verbose
+        - name: env
+          options:
+            - type: include
+              value: environment
+          arg: true
+      subs:
+        - include: project-and-environment
+        - include: verbose
+    - name: mysub1
+      subs:
+        - name: mysub2
+          flags:
+            - name: someopt
+          args:
+            - name: mysub2-arg
+              optional: true
+    - include: project-and-environment
+  args:
+    - include: project-and-environment
+  flags:
+    - include: project-and-environment
+

data/spec/fixtures/config_builder/underscoresdashes.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Tabry
+  module Spec
+    module Fixtures
+      module ConfigBuilder
+        Underscoresdashes = Tabry::ConfigBuilder.build(names_underscores_to_dashes: true) do
+          # this is not translated, because that actually affects things
+          cmd :underscores_test
+
+          arg :foo_bar1, :@project_and_environment
+
+          flagarg :foo_bar2, :@project_and_environment do
+            include "@waz_abc"
+          end
+
+          sub "s,status_foo", "foo", :@project_and_environment do
+            flagarg :env, :@environment
+          end
+
+          include :@project_and_environment
+
+          defopts :@project_and_environment do
+            opts const :a
+          end
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/config_builder/underscoresdashes.tabry

@@ -0,0 +1,18 @@
+cmd underscores_test
+
+arg foo-bar1 @project-and-environment
+
+flagarg foo-bar2 @project-and-environment {
+  include @waz-abc
+}
+
+sub s,status-foo "foo" @project-and-environment {
+  flagarg env @environment
+}
+
+include @project-and-environment
+
+defopts @project_and_environment {
+  opts const a
+}
+

data/spec/fixtures/config_builder/underscoresdashes.yml

@@ -0,0 +1,39 @@
+cmd: underscores_test
+main:
+  args:
+    - name: foo-bar1
+      options:
+        - type: include
+          value: project-and-environment
+    - include: project-and-environment
+  flags:
+    - name: foo-bar2
+      options:
+        - type: include
+          value: project-and-environment
+        - type: include
+          value: waz-abc
+      arg: true
+    - include: project-and-environment
+  subs:
+    - name: s
+      aliases:
+        - status-foo
+      description: foo
+      args:
+        - include: project-and-environment
+      flags:
+        - include: project-and-environment
+        - name: env
+          options:
+            - type: include
+              value: environment
+          arg: true
+      subs:
+        - include: project-and-environment
+    - include: project-and-environment
+option_includes:
+  project_and_environment:
+    - type: const
+      value: a
+