bashly 1.4.0 → 2.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eca947512ada2ac873e3b6d399d75b441c97eb1ac4c56f5e1e8c1017fc9389ac
-  data.tar.gz: f340d79b2f493871f3601c3be689eaf846a4f865eabb34cb3beeaab529ddf2eb
+  metadata.gz: 65ab4d9e6acb0f638497f14958c9bebc78219cbb1c677d75b5f9f98506301e4c
+  data.tar.gz: fadcbfe0d4dcc48d6081d50f2a76bc57730ebd6e44b7c9a232350e7d072f2d3c
 SHA512:
-  metadata.gz: 1fba0f5a53ebd3f4a209a1a4a12b7e132d20b06aba4d9dac4afa199b240f0099e39be1905a4d5db95d37255cebdf62d4c7058131b3b2ee1c2ba54a09d4054de5
-  data.tar.gz: 688fb3b6a40e18a2d63a1bde4ddbeaa999d13c8f8b1b5487af3cfe4a1487d0fc0154422869138beed62b04cc1bc321902046ec1f805aa2226f3085b5d619e20d
+  metadata.gz: a775101849773351872c8f84ce312ec9d5ebc7a460bfed5858de9edf41d524c319e3dd48c424d3be30379ef79ee3e1d1e4bc4efd4b2b5164f641a3c3e47ee03e
+  data.tar.gz: 58ebb9d697a27856f7383d0ad69a5de4c06b21766347c769f241c1dcd947f2703bb932abf0733624e9a3fc7f475891076136d0038734cbe0b346a90b89d6192c

data/lib/bashly/commands/completions.rb

@@ -1,55 +1,17 @@
-require 'completely'
-
 module Bashly
   module Commands
     class Completions < Base
-      summary 'Install bash completions for bashly itself'
-      help 'Display the bash completions script or install it directly to your bash completions directory'
+      summary 'Display bash completions for bashly itself'
 
-      usage 'bashly completions [--install|--uninstall]'
+      usage 'bashly completions'
       usage 'bashly completions (-h|--help)'
 
-      option '-i --install', 'Install the completions script to your bash completions directory'
-      option '-u --uninstall', 'Uninstall the completions script from your bash completions directory'
-
       def run
-        if args['--install']
-          install_completions
-        elsif args['--uninstall']
-          uninstall_completions
-        else
-          puts script
-        end
-      end
-
-      def installer
-        @installer ||= Completely::Installer.new program: 'bashly', script_path: script_path
+        puts script
       end
 
     private
 
-      def install_completions
-        success = installer.install force: true
-        raise Error, "Failed running command:\nnb`#{installer.install_command_string}`" unless success
-
-        say 'Completions installed'
-        say "Source: m`#{installer.script_path}`"
-        say "Target: m`#{installer.target_path}`"
-        say 'Restart your session for the changes to take effect'
-      end
-
-      def uninstall_completions
-        success = installer.uninstall
-        raise Error, "Failed running command:\nnb`#{installer.uninstall_command_string}`" unless success
-
-        say 'Completions uninstalled'
-        say 'Restart your session for the changes to take effect'
-      end
-
-      def script_path
-        @script_path ||= asset('completions/bashly-completions.bash')
-      end
-
       def script
         @script ||= asset_content('completions/bashly-completions.bash')
       end

data/lib/bashly/completions/README.md

@@ -15,10 +15,6 @@ Note that for production use, only the `bashly-completions.bash` is used.
 
 ## For users
 
-Install completions in one of two ways:
-
-1. Run `bashly completions --install`. This will make a best effort to copy
-   the completions script to your completions directory.
-2. If the above fails, run `bashly completions > out.bash`, then copy the file
-   manually to your completions directory (or simply get the
-   `bashly-completions.bash` from this directory).
+Run `bashly completions > out.bash`, then copy the file manually to your
+completions directory (or simply get the `bashly-completions.bash` from this
+directory).

data/lib/bashly/completions/bashly-completions.bash

@@ -297,11 +297,11 @@ _bashly_completions() {
 
   case "$node_id:$positional_index" in
     5:0)
-      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "colors completions completions_script completions_yaml config help hooks ini lib render_markdown render_markdown_github render_mandoc settings stacktrace strings validations yaml" -- "$cur")
+      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "colors config help hooks ini lib render_markdown render_markdown_github render_mandoc settings stacktrace strings validations yaml" -- "$cur")
       return
       ;;
     6:0)
-      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "arg arg.allowed arg.completions arg.default arg.help arg.name arg.repeatable arg.required arg.validate command command.alias command.args command.catch_all command.commands command.completions command.default command.dependencies command.environment_variables command.examples command.expose command.extensible command.filename command.filters command.flags command.footer command.function command.group command.help command.help_header_override command.name command.private command.variables command.version environment_variable environment_variable.default environment_variable.help environment_variable.name environment_variable.private environment_variable.required environment_variable.validate flag flag.alias flag.allowed flag.arg flag.completions flag.conflicts flag.default flag.help flag.long flag.needs flag.negatable flag.private flag.repeatable flag.required flag.short flag.unique flag.validate variable variable.name variable.value" -- "$cur")
+      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "arg arg.allowed arg.completions arg.default arg.help arg.name arg.repeatable arg.required arg.validate command command.alias command.args command.catch_all command.commands command.default command.dependencies command.environment_variables command.examples command.expose command.extensible command.filename command.filters command.flags command.footer command.function command.group command.help command.help_header_override command.name command.private command.variables command.version environment_variable environment_variable.default environment_variable.help environment_variable.name environment_variable.private environment_variable.required environment_variable.validate flag flag.alias flag.allowed flag.arg flag.completions flag.conflicts flag.default flag.help flag.long flag.needs flag.negatable flag.private flag.repeatable flag.required flag.short flag.unique flag.validate variable variable.name variable.value" -- "$cur")
       return
       ;;
     8:0)

data/lib/bashly/completions/completely.yaml

@@ -60,9 +60,6 @@ tokens:
   path:
   library:
     - colors
-    - completions
-    - completions_script
-    - completions_yaml
     - config
     - help
     - hooks
@@ -91,7 +88,6 @@ tokens:
     - command.args
     - command.catch_all
     - command.commands
-    - command.completions
     - command.default
     - command.dependencies
     - command.environment_variables

data/lib/bashly/concerns/settings_completions.rb

@@ -0,0 +1,37 @@
+module Bashly
+  module SettingsCompletions
+    COMPLETION_SHELLS = %w[bash zsh].freeze
+
+    def completions
+      @completions ||= get :completions
+    end
+
+    def completions?
+      completions == 'minimal' || completion_shells.any?
+    end
+
+    def completion_shells
+      case completions
+      when nil, false, 'minimal' then []
+      when 'full' then COMPLETION_SHELLS
+      when String then validate_completion_shells completions
+      else invalid_completions
+      end
+    end
+
+  private
+
+    def validate_completion_shells(value)
+      shells = value.split(',', -1).map(&:strip)
+      valid = shells.any? && (shells - COMPLETION_SHELLS).empty?
+      return shells if valid && shells.uniq == shells
+
+      invalid_completions
+    end
+
+    def invalid_completions
+      raise ConfigurationError,
+        "completions must be false, minimal, full, or a comma-separated list of: #{COMPLETION_SHELLS.join ', '}"
+    end
+  end
+end

data/lib/bashly/config_validator.rb

@@ -2,6 +2,8 @@ module Bashly
   class ConfigValidator
     include ValidationHelpers
 
+    COMPLETION_OPTIONS = %w[files directories no-space].freeze
+
     attr_reader :data
 
     def initialize(data)
@@ -88,6 +90,20 @@ module Bashly
       assert [true, false, nil, 'always'].include?(value), "#{key} must be a boolean, or the string 'always'"
     end
 
+    def assert_completions(key, value)
+      return unless value
+
+      assert_hash key, value, keys: %i[static dynamic options]
+      assert_array "#{key}.static", value['static'], of: :string
+      assert_array "#{key}.dynamic", value['dynamic'], of: :string
+      assert_array "#{key}.options", value['options'], of: :string
+
+      Array(value['options']).each do |option|
+        assert COMPLETION_OPTIONS.include?(option),
+          "#{key}.options contains an unknown option: #{option}"
+      end
+    end
+
     def assert_arg(key, value)
       assert_hash key, value, keys: Script::Argument.option_keys
       refute value['allowed'] && value['completions'], "#{key} cannot have both nub`allowed` and nub`completions`"
@@ -101,7 +117,7 @@ module Bashly
       assert_boolean "#{key}.unique", value['unique']
 
       assert_array "#{key}.allowed", value['allowed'], of: :string
-      assert_array "#{key}.completions", value['completions'], of: :string
+      assert_completions "#{key}.completions", value['completions']
 
       refute value['name'].match(/^-/), "#{key}.name must not start with '-'"
 
@@ -137,7 +153,7 @@ module Bashly
       assert_boolean "#{key}.required", value['required']
       assert_array "#{key}.allowed", value['allowed'], of: :string
       assert_array "#{key}.conflicts", value['conflicts'], of: :string
-      assert_array "#{key}.completions", value['completions'], of: :string
+      assert_completions "#{key}.completions", value['completions']
 
       assert value['long'].match(/^--[a-zA-Z0-9_-]+$/), "#{key}.long must be in the form of '--name'" if value['long']
       assert value['short'].match(/^-[a-zA-Z0-9]$/), "#{key}.short must be in the form of '-n'" if value['short']
@@ -236,7 +252,6 @@ module Bashly
       assert_array "#{key}.args", value['args'], of: :arg
       assert_array "#{key}.flags", value['flags'], of: :flag
       assert_array "#{key}.commands", value['commands'], of: :command
-      assert_array "#{key}.completions", value['completions'], of: :string
       assert_array "#{key}.filters", value['filters'], of: :string
       assert_array "#{key}.environment_variables", value['environment_variables'], of: :env_var
       assert_array "#{key}.variables", value['variables'], of: :var

data/lib/bashly/docs/arg.yml

@@ -34,15 +34,21 @@ arg.allowed:
       default: development
 
 arg.completions:
-  help: Specify a list of additional completion suggestions when used in conjunction with `bashly add completions`.
+  help: |-
+    Configure additional runtime completions.
+    `static` contains literal candidates. `dynamic` contains Bash commands that
+    print one candidate per line. `options` accepts `files`, `directories`, and
+    `no-space`.
   url: https://bashly.dev/configuration/argument/#completions
   example: |-
     args:
-    - name: path
-      help: File or directory to process
+    - name: branch
+      help: Branch to process
       completions:
-      - <file>
-      - <directory>
+        static: [main, develop]
+        dynamic:
+        - git branch --format='%(refname:short)'
+        options: [no-space]
 
 arg.default:
   help: Specify the value to apply when not provided by the user.
@@ -102,4 +108,4 @@ arg.validate:
   example: |-
     args:
     - name: path
-      validate: file_exists
+      validate: file_exists

data/lib/bashly/docs/command.yml

@@ -74,18 +74,6 @@ command.commands:
       alias: a
       help: Register a local repository
 
-command.completions:
-  help: Specify a list of additional completion suggestions when used in conjunction with `bashly add completions`.
-  url: https://bashly.dev/configuration/command/#completions
-  example: |-
-    commands:
-    - name: view
-      help: View a directory, system user or a git branch
-      completions:
-      - <directory>
-      - <user>
-      - $(git branch 2> /dev/null)
-
 command.default:
   help: Specify that this sub-command will be executed implicitly.
   url: https://bashly.dev/configuration/command/#default

data/lib/bashly/docs/flag.yml

@@ -58,14 +58,18 @@ flag.arg:
       help: Specify the user name
 
 flag.completions:
-  help: Specify a list of additional completion suggestions when used in conjunction with `bashly add completions`. Must be accompanied by `arg`.
+  help: |-
+    Configure additional runtime completions. Must be accompanied by `arg`.
+    `static` contains literal candidates. `dynamic` contains Bash commands that
+    print one candidate per line. `options` accepts `files`, `directories`, and
+    `no-space`.
   url: https://bashly.dev/configuration/flag/#completions
   example: |-
     flags:
-    - long: --user
-      arg: username
+    - long: --config
+      arg: file
       completions:
-      - <user>
+        options: [files]
     
     # Anything in the 'allowed' option is automatically added as a completion.
     - long: --protocol

data/lib/bashly/libraries/libraries.yml

@@ -12,21 +12,6 @@ colors:
 
       m`$ bashly add hooks`
 
-completions: 
-  help: Generate a bash completions function.
-  usage: '[PATH]'
-  handler: Bashly::Libraries::CompletionsFunction
-
-completions_script:
-  help: Generate a standalone bash completions script.
-  usage: '[PATH]'
-  handler: Bashly::Libraries::CompletionsScript
-
-completions_yaml:
-  help: Generate a completions YAML configuration for Completely.
-  usage: '[PATH]'
-  handler: Bashly::Libraries::CompletionsYAML
-
 config:
   help: Add functions for handling INI configuration files to the lib directory.
   files:

data/lib/bashly/libraries/settings/settings.yml

@@ -157,23 +157,28 @@ env: development
 # - always          # render this feature in any environment
 # - never           # do not render this feature
 enable_header_comment: always
-enable_bash3_bouncer: always
+enable_bash_version_bouncer: always
 enable_view_markers: development
 enable_inspect_args: development
 enable_deps_array: always
 enable_env_var_names_array: always
 enable_sourcing: development
 
+# Generate native runtime completions. Supported values:
+# - ~ or false     # disable completions (default)
+# - minimal        # generate the runtime completion engine without shell adapters
+# - bash or zsh    # generate the runtime engine and one shell adapter
+# - bash,zsh       # generate the runtime engine and selected shell adapters
+# - full           # generate the runtime engine and all available shell adapters
+completions: ~
+
 
 #-------------------------------------------------------------------------------
 # DEVELOPER OPTIONS
 #-------------------------------------------------------------------------------
 
-# When true, use filesystem evented watching instead of polling
-watch_evented: false
-
-# File change detection latency (seconds)
-watch_latency: 1.0
+# File change detection polling interval (seconds)
+watch_latency: 2.0
 
 
 #-------------------------------------------------------------------------------
@@ -192,5 +197,6 @@ var_aliases:
 
 # Choose different names for some of the internal functions.
 function_names:
+  start: ~
   run: ~
   initialize: ~

data/lib/bashly/script/argument.rb

@@ -23,6 +23,23 @@ module Bashly
         end
       end
 
+      def completion_static
+        completions&.fetch('static', []) || []
+      end
+
+      def completion_dynamic
+        completions&.fetch('dynamic', []) || []
+      end
+
+      def completion_options
+        completions&.fetch('options', []) || []
+      end
+
+      def completion?
+        allowed&.any? || completion_static.any? ||
+          completion_dynamic.any? || completion_options.any?
+      end
+
       def label
         repeatable ? "#{name.upcase}..." : name.upcase
       end

data/lib/bashly/script/command.rb

@@ -1,7 +1,6 @@
 module Bashly
   module Script
     class Command < Base
-      include Completions::Command
       include Introspection::Arguments
       include Introspection::Commands
       include Introspection::Dependencies
@@ -14,7 +13,7 @@ module Bashly
       class << self
         def option_keys
           @option_keys ||= %i[
-            alias argfile args catch_all commands completions
+            alias argfile args catch_all commands
             default dependencies environment_variables examples
             extensible expose filename filters flags
             footer function group help help_header_override name

data/lib/bashly/script/flag.rb

@@ -3,7 +3,6 @@ require 'shellwords'
 module Bashly
   module Script
     class Flag < Base
-      include Completions::Flag
       include Introspection::Visibility
       include Introspection::Validate
 
@@ -44,6 +43,18 @@ module Bashly
         end
       end
 
+      def completion_static
+        completions&.fetch('static', []) || []
+      end
+
+      def completion_dynamic
+        completions&.fetch('dynamic', []) || []
+      end
+
+      def completion_options
+        completions&.fetch('options', []) || []
+      end
+
       def name
         long || short
       end

data/lib/bashly/script/introspection/commands.rb

@@ -41,6 +41,11 @@ module Bashly
           commands.map(&:name)
         end
 
+        # Returns command names and aliases that can be offered as completions
+        def completion_aliases
+          public_commands.flat_map(&:aliases).reject { |name| name.end_with? '*' }
+        end
+
         # Returns an array of the Commands
         def commands
           return [] unless options['commands']

data/lib/bashly/script/wrapper.rb

@@ -46,7 +46,7 @@ module Bashly
 
       def default_header
         result = render 'header'
-        result += render('bash3_bouncer') unless function_name || !Settings.enabled?(:bash3_bouncer)
+        result += render('bash_version_bouncer') unless function_name || !Settings.enabled?(:bash_version_bouncer)
         result
       end
 

data/lib/bashly/settings.rb

@@ -1,15 +1,19 @@
 module Bashly
   class Settings
+    COMPLETION_SHELLS = SettingsCompletions::COMPLETION_SHELLS
+
     class << self
       include AssetHelper
+      include SettingsCompletions
 
       attr_writer(
         :argfile_var,
         :commands_dir,
         :compact_short_flags,
+        :completions,
         :conjoined_flag_args,
         :config_path,
-        :enable_bash3_bouncer,
+        :enable_bash_version_bouncer,
         :enable_deps_array,
         :enable_env_var_names_array,
         :enable_header_comment,
@@ -29,7 +33,6 @@ module Bashly
         :target_dir,
         :usage_colors,
         :var_aliases,
-        :watch_evented,
         :watch_latency,
         :word_wrap
       )
@@ -64,8 +67,8 @@ module Bashly
           (send(:"enable_#{feature}") == 'development' && !production?)
       end
 
-      def enable_bash3_bouncer
-        @enable_bash3_bouncer ||= get :enable_bash3_bouncer
+      def enable_bash_version_bouncer
+        @enable_bash_version_bouncer ||= get :enable_bash_version_bouncer
       end
 
       def enable_deps_array
@@ -181,10 +184,6 @@ module Bashly
         @var_aliases ||= get :var_aliases
       end
 
-      def watch_evented
-        @watch_evented ||= get :watch_evented
-      end
-
       def watch_latency
         @watch_latency ||= get :watch_latency
       end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.4.0'
+  VERSION = '2.0.0.rc2'
 end

data/lib/bashly/views/argument/completion.gtx

@@ -0,0 +1,31 @@
+if allowed
+  > local -a completion_values=(
+  allowed.each do |value|
+    >   "{{ value }}"
+  end
+  > )
+  if unique
+    > local completion_value
+    > for completion_value in "${completion_values[@]}"; do
+    >   if [[ -z "${completion_used_arguments["{{ name }}:$completion_value"]:-}" ]]; then
+    >     completion_candidates "$completion_current" "$completion_value"
+    >   fi
+    > done
+  else
+    > completion_candidates "$completion_current" "${completion_values[@]}"
+  end
+end
+
+if completion_static.any?
+  > completion_candidates "$completion_current" {{ completion_static.map { |value| Shellwords.shellescape value }.join ' ' }}
+end
+
+completion_dynamic.each do |command|
+  > if completion_output="$({ {{ command }}; } 2>/dev/null)"; then
+  >   completion_dynamic_candidates "$completion_current" "$completion_output"
+  > fi
+end
+
+if completion_options.any?
+  > completion_add_options {{ completion_options.join ' ' }}
+end

data/lib/bashly/views/argument/completion_filter.gtx

@@ -0,0 +1 @@
+> completion_used_arguments["{{ name }}:$1"]=1

data/lib/bashly/views/command/completion_argument_candidates.gtx

@@ -0,0 +1,12 @@
+completion_args = args.each_with_index.select { |arg, _index| arg.completion? }
+if completion_args.any?
+  > if [[ $completion_current != -* ]]; then
+  >   case "$completion_arg_index" in
+  completion_args.each do |arg, index|
+    >     {{ index }})
+    = arg.render(:completion).strip.indent 6
+    >       ;;
+  end
+  >   esac
+  > fi
+end

data/lib/bashly/views/command/completion_argument_filter.gtx

@@ -0,0 +1,25 @@
+if args.any?(&:unique)
+  > case "$completion_arg_index" in
+  args.each_with_index do |arg, index|
+    next unless arg.unique
+
+    >   {{ index }})
+    = arg.render(:completion_filter).indent 4
+    >     ;;
+  end
+  > esac
+end
+
+if args.last.repeatable
+  last_arg_index = args.length - 1
+  > if [[ $completion_arg_index -lt {{ last_arg_index }} ]]; then
+  >   completion_arg_index=$((completion_arg_index + 1))
+  > fi
+  > shift
+else
+  > if [[ $completion_arg_index -ge {{ args.length }} ]]; then
+  >   return
+  > fi
+  > completion_arg_index=$((completion_arg_index + 1))
+  > shift
+end

data/lib/bashly/views/command/completion_command_candidates.gtx

@@ -0,0 +1,3 @@
+if completion_aliases.any?
+  > completion_candidates "$completion_current" {{ completion_aliases.join ' ' }}
+end

data/lib/bashly/views/command/completion_flag_candidates.gtx

@@ -0,0 +1,21 @@
+if fixed_flags? || public_flags.any?
+  > if [[ $completion_current == -* ]]; then
+  if fixed_flags?
+    if short_flag_exist? '-h'
+      >   completion_flag_candidates --help "$completion_current" --help
+    else
+      >   completion_flag_candidates --help "$completion_current" --help -h
+    end
+    if root_command?
+      if short_flag_exist? '-v'
+        >   completion_flag_candidates --version "$completion_current" --version
+      else
+        >   completion_flag_candidates --version "$completion_current" --version -v
+      end
+    end
+  end
+  public_flags.each do |flag|
+    = flag.render(:completion).indent 2
+  end
+  > fi
+end

data/lib/bashly/views/command/completion_function.gtx

@@ -0,0 +1,24 @@
+= view_marker
+
+> {{ function_name }}_completion() {
+>   local completion_current="$1"
+if args.any?
+  >   local completion_arg_index=0
+end
+if args.any?(&:unique)
+  >   local -A completion_used_arguments=()
+end
+if flags.any?(&:unique)
+  >   local -A completion_used_flag_values=()
+end
+>   shift
+>
+= render(:completion_word_filter).indent 2
+= render(:completion_command_candidates).indent 2
+if default_command
+  >   {{ default_command.function_name }}_completion "$completion_current"
+end
+= render(:completion_flag_candidates).indent 2
+= render(:completion_argument_candidates).indent 2
+> }
+>

data/lib/bashly/views/command/completion_script.gtx

@@ -0,0 +1,21 @@
+= view_marker
+
+completion_shells = Settings.completion_shells
+
+> send_completions() {
+>   local completion_shell="${1:-{{ completion_shells.first }}}"
+>
+>   case "$completion_shell" in
+completion_shells.each do |shell|
+  >     {{ shell }}) send_completions_{{ shell }} ;;
+end
+>     *)
+>       printf 'unsupported shell: %s\n' "$completion_shell" >&2
+>       return 1
+>       ;;
+>   esac
+> }
+>
+completion_shells.each do |shell|
+  = render :"completion_script_#{shell}"
+end