yarsh 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c0badb7f9f245222eb3ff552fff43848240d14e3e8d8efddae83004a77d72ab
-  data.tar.gz: d2920f423aac65f6dec454ebf84104fb97c60923358790440463bee0ada9cd8b
+  metadata.gz: a2abe40eb2be33ef53eba4b99743447c9db93831dd1e8c00221b1934cd5bc264
+  data.tar.gz: 3f53d3e1a4a560b7c04982a7874899d8be8aaba714a3cc42dc4ecff6adae99b2
 SHA512:
-  metadata.gz: '097af7754f04c9f8ec210fcd844d745b01e5aa681f36619e47ec3ae979ac00f162e0579085acb8c7f5cbb7a6515a38fad5ee973456618bc32b8cd78f732f3f26'
-  data.tar.gz: 891cd97331a879529d3ad545fba07590c0d3ca1d09e295550d96444bda867bd69f9f10cf494ec0cf61944978813831422e9162826b0415c339434022c44db15e
+  metadata.gz: d89b9258f28f13778ad03734cd98db71e09f0b55132631fb2e054ec37286cde8ba688db5dede69835f1ca2ce51fd2cce4a9759707ef5df27cfe8218e6305f6c3
+  data.tar.gz: 7ca6c547b1eb3aac0c4c8c1582e42b71007fe2181877aa2d74379c24a175ff48d6307dc978c13a752d4ca054e69a40fc94ee0f4c661e0ca4ed571e82653926de

data/AGENTS.md

@@ -139,6 +139,19 @@ error crashes the REPL:
   `yarsh_eval` deciding. `__sh__`/`__sh_exec` still exist for potential
   re-enabling.
 
+## Bash autocomplete
+
+`Yarsh::Completion::BashAutocomplete` provides tab-completion by invoking bash
+completion functions:
+
+- For commands supporting the `__complete` subcommand (docker, kubectl, etc.),
+  it calls `<command> __complete <word>` and parses tab-separated output.
+- For all other commands, it sources the bash completion script and runs the
+  registered completion function with `COMP_WORDS`/`COMP_CWORD` set.
+- Privileged commands (`sudo`, `doas`, `pkexec`, `su`) skip the `__complete`
+  path to avoid password prompts; they always use the bash completion function.
+- Results are cached in a bounded in-memory `CACHE` (max 100 entries).
+
 ## Style
 
 - `# frozen_string_literal: true` on every `.rb` file.

data/CHANGES.md

@@ -200,4 +200,13 @@ See commits: `bcc25b4`, `ea92742`, `51c9db8`, `2218f29`, `0fceeb8`. Tests in
 transformation, heredoc handling, binding threading, integration with
 `Yarsh::Shell`).
 
+## 0.3.0
 
+A completion engine for writing shell commands complete in ruby. It comes with a Shell completion engine using bash autocomplete when available.
+
+It alos comes with completion for the gem command.
+
+## 0.3.1
+
+* Small bug fix for the REPL.
+* Added the export reserved word to define global variables in the shell.

data/README.md

@@ -107,7 +107,21 @@ Known limitations:
 
 ### Completion
 
-For the moment, there is autocompletion for exectuables in PATH and for file and dir path for shell commands
+Tab completion is powered by a multi-engine system:
+
+- **Command completion** — completes executables in PATH and shell builtins
+- **Path completion** — completes file and directory paths (including `~` expansion)
+- **Ruby completion** — completes Ruby methods and constants (can be disabled via `Config.instance.ruby_completion = false`)
+- **Bash completion** — invokes bash completion functions for commands that have them (e.g. `git`, `docker`, `systemctl`), including multi-word commands like `systemctl restart <service>`
+- **Gem completion** — provides subcommand and option completion for `gem`, plus installed gem names for subcommands that operate on installed gems (`info`, `uninstall`, `open`, `contents`, `check`, `cleanup`, `pristine`, `rdoc`, `specification`, `dependency`)
+
+Completion is suppressed when the cursor is inside a quoted string, so typing
+`git commit -m ""` won't have options inserted between the quotes.
+
+Privileged commands (`sudo`, `doas`, `pkexec`, `su`) are handled transparently:
+`sudo systemctl restart <Tab>` completes the same as `systemctl restart <Tab>`.
+
+A base completion engine is provided in order to add more completions with ease. See `lib/yarsh/completion/base.rb` for more information and `lib/yarsh/completion/gem.rb` for an example of a completion for the gem command.
 
 ### Errors
 

data/lib/yarsh/binding.rb

@@ -7,4 +7,8 @@ class Binding
     end
     self
   end
+
+  def inspect
+    "#<Binding:>\n  local_vars: #{local_variables.inspect}"
+  end
 end

data/lib/yarsh/completion/bash_autocomplete.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require 'shellwords'
+require 'tempfile'
+require_relative 'engine'
+
+module Yarsh
+  module Completion
+    class BashAutocomplete < Engine
+      BASH_COMPLETION_MAIN = '/usr/share/bash-completion/bash_completion'
+      COMPLETION_DIR = '/usr/share/bash-completion/completions'
+      CACHE = {}
+
+      def supports?(command)
+        return false if command.nil? || command.empty?
+        command = command.strip.split(/\s+/).first
+        File.exist?("#{COMPLETION_DIR}/#{command}") ||
+          File.exist?("#{COMPLETION_DIR}/#{command}.bash") ||
+          bash_completion_defined?(command)
+      end
+
+      def complete(command, word, args = [])
+        command = command.strip.split(/\s+/).first
+        return [] unless supports?(command)
+        return [] unless find_script(command)
+
+        # Try __complete subcommand first (works for docker and others)
+        sub_output = bash_invoke_complete_subcommand(command, word)
+        return sub_output unless sub_output.nil? || sub_output.empty?
+
+        # Fall back to bash completion function
+        func = completion_function(command)
+        return [] if func.nil? || func.empty?
+
+        output = bash_invoke_completion(func, command, word)
+        return [] if output.nil? || output.empty?
+
+        has_trailing_space = word.end_with?(' ')
+        prefix = has_trailing_space ? '' : word.strip.split(/\s+/).last
+        return output.split if prefix == command
+
+        output.split.select { |r| r.start_with?(prefix) }
+      rescue
+        []
+      end
+
+      private
+
+      def find_script(command)
+        return "#{COMPLETION_DIR}/#{command}" if File.exist?("#{COMPLETION_DIR}/#{command}")
+        return "#{COMPLETION_DIR}/#{command}.bash" if File.exist?("#{COMPLETION_DIR}/#{command}.bash")
+        nil
+      end
+
+      def bash_completion_defined?(command)
+        func = completion_function(command)
+        !func.nil? && !func.empty?
+      rescue
+        false
+      end
+
+      def completion_function(command)
+        return '' unless File.exist?(BASH_COMPLETION_MAIN)
+        script = find_script(command)
+        return '' unless script
+
+        `bash -c 'source #{Shellwords.shellescape(BASH_COMPLETION_MAIN)} 2>/dev/null; source #{Shellwords.shellescape(script)} 2>/dev/null; complete -p #{Shellwords.shellescape(command)} 2>/dev/null | grep -oP "(?<= -F )\\S+"' 2>/dev/null`.strip
+      rescue
+        ''
+      end
+
+      def bash_invoke_completion(func, command, partial)
+        has_trailing_space = partial.end_with?(' ')
+        words = if has_trailing_space
+                  partial.strip.split(/\s+/) << ''
+                else
+                  partial.strip.split(/\s+/)
+                end
+        cword = [words.size - 1, 0].max
+        comp_words = words.map { |w| Shellwords.shellescape(w) }.join(' ')
+        comp_words += ' ""' unless has_trailing_space
+        script = Shellwords.shellescape(find_script(command))
+        cmd = "source #{Shellwords.shellescape(BASH_COMPLETION_MAIN)} 2>/dev/null; source #{script} 2>/dev/null; COMP_WORDS=(#{comp_words}); COMP_CWORD=#{cword}; COMPREPLY=(); #{Shellwords.shellescape(func)} 2>/dev/null; IFS=; printf '%s\\n' \"\${COMPREPLY[@]}\""
+        return CACHE[cmd] if CACHE.key?(cmd)
+        raw = nil
+        Tempfile.create('yarsh_completion') do |f|
+          f.write(cmd)
+          f.close
+          raw = `timeout 4 bash #{f.path} 2>/dev/null`.strip
+        end
+        CACHE[cmd] = raw
+        CACHE.delete_if { |_, v| v.nil? || v.empty? } if CACHE.size > 100
+        raw
+      rescue
+        nil
+      end
+
+      def bash_invoke_complete_subcommand(command, partial)
+        has_trailing_space = partial.end_with?(' ')
+        words = partial.strip.split(/\s+/)
+        return nil if words.size > 2
+
+        # Don't invoke __complete for privileged commands (prompts for password)
+        return nil if PRIVILEGED_COMMANDS.include?(command)
+
+        # Don't invoke __complete when only the command + space is typed (no arg yet)
+        return nil if has_trailing_space && words.size == 1
+
+        last_word = has_trailing_space ? '' : (words.last || '')
+        raw = `timeout 4 #{Shellwords.shellescape(command)} __complete #{Shellwords.shellescape(last_word)} 2>/dev/null`.strip
+        return nil if raw.empty?
+
+        # Filter to only lines that contain tab-separated data
+        tab_lines = raw.each_line.select { |line| line.include?("\t") }
+        return nil if tab_lines.empty?
+
+        results = tab_lines.map { |line| line.split("\t").first }.reject(&:empty?)
+        return nil if results.empty?
+
+        # If the only result is the last_word itself, try subcommand completion
+        if results.size == 1 && results.first == last_word
+          sub_cmd = words[1..-1].join(' ')
+          if sub_cmd && !sub_cmd.empty?
+            sub_raw = `timeout 4 #{Shellwords.shellescape(command)} #{Shellwords.shellescape(sub_cmd)} __complete 2>/dev/null`.strip
+            return nil if sub_raw.empty? || !sub_raw.include?("\t")
+            sub_tab_lines = sub_raw.each_line.select { |line| line.include?("\t") }
+            return nil if sub_tab_lines.empty?
+            sub_results = sub_tab_lines.map { |line| line.split("\t").first }.reject(&:empty?)
+            return nil if sub_results.empty?
+            results = sub_results
+          end
+        end
+        results
+      rescue
+        nil
+      end
+    end
+  end
+end

data/lib/yarsh/completion/engine.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Yarsh
+  module Completion
+    class Engine
+      PRIVILEGED_COMMANDS = %w[sudo doas pkexec su].freeze
+
+      def complete(command, word, args = [])
+        raise NotImplementedError, "Subclasses must implement #complete"
+      end
+
+      def supports?(command)
+        false
+      end
+    end
+  end
+end

data/lib/yarsh/completion/gem_completion.rb

@@ -0,0 +1,281 @@
+# frozen_string_literal: true
+
+require_relative 'engine'
+
+module Yarsh
+  module Completion
+    class GemCompletion < Engine
+      SUBCOMMANDS = %w[
+        build cert check cleanup contents dependency environment exec fetch
+        generate_index help info install list lock mirror open outdated owner
+        pristine push rdoc rebuild search server signin signout sources
+        specification stale uninstall unpack update which yank
+      ].freeze
+
+      OPTIONS = {
+        'build' => %w[
+          --platform --force --strict -o --output
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'cert' => %w[
+          -a --add -l --list -r --remove -b --build -C --certificate
+          -K --private-key -A --key-algorithm -s --sign -d --days -R --re-sign
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'check' => %w[
+          -a --alien --doctor --dry-run --gems -v --version
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'cleanup' => %w[
+          -n -d --dry-run -D --check-development --user-install --dryrun
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'contents' => %w[
+          -v --version --all -s --spec-dir -l --lib-only --prefix --show-install-dir
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'dependency' => %w[
+          -v --version --platform --prerelease -R --reverse-dependencies --pipe
+          -u --update-sources
+          -l --local -r --remote -b --both -B --bulk-threshold --clear-sources
+          -s --source -p --http-proxy
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'environment' => %w[
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'exec' => %w[
+          -v --version --prerelease -g --gem --conservative
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'fetch' => %w[
+          -v --version --platform --prerelease --suggestions
+          -B --bulk-threshold -p --http-proxy -s --source --clear-sources
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'generate_index' => %w[
+          -d --directory --modern --compact --update
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'help' => %w[
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'info' => %w[
+          -i --installed -I -v --version --versions -a --all -e --exact --prerelease
+          -u --update-sources
+          -l --local -r --remote -b --both -B --bulk-threshold --clear-sources
+          -s --source -p --http-proxy
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'install' => %w[
+          --platform -v --version --prerelease
+          --default -u --update-sources
+          -i --install-dir -n --bindir -j --build-jobs --document --build-root
+          --vendor -N --no-document -E --env-shebang -f --force -w --wrappers
+          -P --trust-policy --ignore-dependencies --format-executable --user-install
+          --development --development-all --conservative --minimal-deps
+          --post-install-message -g --file --without --explain --lock
+          --suggestions --target-rbconfig
+          -l --local -r --remote -b --both -B --bulk-threshold --clear-sources
+          -s --source -p --http-proxy
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'list' => %w[
+          -i --installed -I -v --version -d --details --versions -a --all -e --exact --prerelease
+          -u --update-sources
+          -l --local -r --remote -b --both -B --bulk-threshold --clear-sources
+          -s --source -p --http-proxy
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'lock' => %w[
+          -s --strict
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'mirror' => %w[
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'open' => %w[
+          -e --editor -v --version
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'outdated' => %w[
+          --platform
+          -u --update-sources
+          -l --local -r --remote -b --both -B --bulk-threshold --clear-sources
+          -s --source -p --http-proxy
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'owner' => %w[
+          -k --key --otp -a --add -r --remove --host
+          -p --http-proxy
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'pristine' => %w[
+          --all --skip --extensions --only-missing-extensions --only-executables
+          --only-plugins -E --env-shebang -i --install-dir -n --bindir -v --version
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'push' => %w[
+          -k --key --otp --host --attestation
+          -p --http-proxy
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'rdoc' => %w[
+          --all --rdoc --ri --overwrite -v --version
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'rebuild' => %w[
+          --diff --force --strict --source --original --gemspec -C
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'search' => %w[
+          -i --installed -I -v --version -d --details --versions -a --all -e --exact --prerelease
+          -u --update-sources
+          -l --local -r --remote -b --both -B --bulk-threshold --clear-sources
+          -s --source -p --http-proxy
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'server' => %w[
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'signin' => %w[
+          --host --otp
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'signout' => %w[
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'sources' => %w[
+          -a --add --append --prepend -l --list -r --remove -c --clear-all
+          -u --update -f --force
+          -p --http-proxy
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'specification' => %w[
+          -v --version --platform --prerelease --all --ruby --yaml --marshal
+          -u --update-sources
+          -l --local -r --remote -b --both -B --bulk-threshold --clear-sources
+          -s --source -p --http-proxy
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'stale' => %w[
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'uninstall' => %w[
+          -a --all -I --ignore-dependencies -D --check-development -x --executables
+          -i --install-dir -n --bindir --user-install --format-executable --force
+          --abort-on-dependent -v --version --platform --vendor
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'unpack' => %w[
+          --target --spec -v --version
+          -P --trust-policy
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'update' => %w[
+          --system --platform --prerelease
+          --default -u --update-sources
+          -i --install-dir -n --bindir -j --build-jobs --document --build-root
+          --vendor -N --no-document -E --env-shebang -f --force -w --wrappers
+          -P --trust-policy --ignore-dependencies --format-executable --user-install
+          --development --development-all --conservative --minimal-deps
+          --post-install-message -g --file --without --explain --lock
+          --suggestions --target-rbconfig
+          -l --local -r --remote -b --both -B --bulk-threshold --clear-sources
+          -s --source -p --http-proxy
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'which' => %w[
+          -a --all -g --gems-first
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze,
+        'yank' => %w[
+          -v --version --platform --otp --host -k --key
+          -h --help -V --verbose -q --quiet --silent --config-file
+          --backtrace --debug --norc
+        ].freeze
+      }.freeze
+
+      GEM_NAME_SUBCOMMANDS = %w[
+        info uninstall open contents check cleanup pristine rdoc specification dependency
+      ].freeze
+
+      def supports?(command)
+        command.to_s.strip.split(/\s+/).first == 'gem'
+      end
+
+      def complete(command, word, args = [])
+        return [] unless supports?(command)
+
+        words = word.strip.split(/\s+/)
+        words.shift if words.first == 'gem'
+
+        has_trailing_space = word.end_with?(' ')
+
+        if words.empty?
+          return SUBCOMMANDS.dup
+        end
+
+        if words.size == 1 && !has_trailing_space
+          prefix = words.first
+          return SUBCOMMANDS.select { |s| s.start_with?(prefix) }
+        end
+
+        subcommand = words.first
+        return [] unless OPTIONS.key?(subcommand)
+
+        prefix = has_trailing_space ? '' : words.last
+
+        if prefix.start_with?('-')
+          OPTIONS[subcommand].select { |o| o.start_with?(prefix) }
+        elsif GEM_NAME_SUBCOMMANDS.include?(subcommand)
+          installed_gems.select { |g| g.start_with?(prefix) }
+        else
+          OPTIONS[subcommand].select { |o| o.start_with?(prefix) }
+        end
+      end
+
+      private
+
+      def installed_gems
+        Gem::Specification.map(&:name).uniq.sort
+      rescue
+        []
+      end
+    end
+  end
+end

data/lib/yarsh/completion/help_completion.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'shellwords'
+require_relative 'engine'
+
+module Yarsh
+  module Completion
+    class HelpCompletion < Engine
+      attr_reader :cache
+
+      def initialize
+        @cache = {}
+      end
+
+      def complete(command, word, args = [])
+        command = command.strip
+        return [] if command.nil? || command.empty?
+        cmd = command.split(/\s+/).first
+        return [] if cmd.nil? || cmd.empty?
+        return [] unless command_exists?(cmd)
+
+        # Skip privileged commands — running --help would prompt for password
+        return [] if PRIVILEGED_COMMANDS.include?(cmd)
+
+        # Use full word for parse_help only if it starts with the command
+        # (e.g., word="docker compose u" starts with command="docker")
+        help_cmd = if word.strip.start_with?(cmd)
+                     word.strip
+                   else
+                     command
+                   end
+        options = parse_help(help_cmd)
+        return [] if options.nil? || options.empty?
+
+        prefix = word.strip.split(/\s+/).last
+        return options if prefix == help_cmd || prefix == cmd
+
+        options.select { |opt| opt.start_with?(prefix) }
+      end
+
+      def supports?(command)
+        return false if command.nil? || command.empty?
+        cmd = command.strip.split(/\s+/).first
+        command_exists?(cmd)
+      end
+
+      def parse_help(command)
+        return @cache[command][:options] if @cache.key?(command) && !expired?(@cache[command])
+
+        options = do_parse_help(command)
+        @cache[command] = { options: options, fetched_at: Time.now.to_i }
+        options
+      rescue
+        []
+      end
+
+      def cache_info(command)
+        @cache[command]
+      end
+
+      def clear_cache
+        @cache.clear
+      end
+
+      private
+
+      def command_exists?(command)
+        cmd = command.split(/\s+/).first
+        !`which #{Shellwords.shellescape(cmd)} 2>/dev/null`.strip.empty?
+      rescue
+        false
+      end
+
+      def expired?(entry)
+        return true unless entry[:fetched_at]
+        (Time.now.to_i - entry[:fetched_at]) > CACHE_TTL
+      end
+
+      def do_parse_help(command)
+        escaped = command.split(/\s+/).map { |w| Shellwords.shellescape(w) }.join(' ')
+        output = `#{escaped} --help 2>&1`.strip
+        return [] if output.empty? || output.include?("command not found") || output.include?("No such file")
+
+        options = []
+        output.each_line do |line|
+          cmd_match = line.match(/^\s{2}([a-zA-Z][a-zA-Z0-9-]*)/)
+          options << cmd_match[1] if cmd_match && !options.include?(cmd_match[1])
+
+          line.strip!
+          next if line.empty?
+
+          matches = line.scan(/(?:^|[\s|\]\[])(-{1,2}[a-zA-Z][a-zA-Z0-9-]*)/)
+          matches.each do |m|
+            opt = m.first
+            next if opt.empty?
+            options << opt unless options.include?(opt)
+          end
+        end
+        options.uniq.sort
+      rescue
+        []
+      end
+    end
+  end
+end

data/lib/yarsh/completion/registry.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'engine'
+
+module Yarsh
+  module Completion
+    class Registry
+      def initialize
+        @engines = []
+      end
+
+      def register(engine)
+        @engines << engine
+      end
+
+      def complete(command, word, args = [])
+        return [] if command.nil? || command.empty?
+        return [] if word.nil?
+
+        @engines.each do |engine|
+          next unless engine.supports?(command)
+          result = engine.complete(command, word, args)
+          return result unless result.nil? || result.empty?
+        end
+
+        []
+      rescue
+        []
+      end
+
+      def find_engine(command)
+        @engines.each do |engine|
+          return engine if engine.supports?(command)
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/yarsh/completion.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module Yarsh
+  module Completion
+    BASE_DIR = '/usr/share/bash-completion/completions'
+    CACHE_DIR = File.expand_path('~/.yarsh/completion_cache')
+    CACHE_TTL = 3600
+
+    def self.cache_dir
+      FileUtils.mkdir_p(CACHE_DIR) unless File.exist?(CACHE_DIR)
+      CACHE_DIR
+    end
+  end
+end

data/lib/yarsh/config.rb

@@ -13,12 +13,14 @@ module Yarsh
     include Singleton
 
     attr_reader :aliases, :log_level
-    attr_accessor :logger
+    attr_accessor :logger, :autocompletion, :ruby_completion
 
     def initialize
       @aliases = {}
       @prompt = nil
       @logger = Logger.new($stdout, level: Logger::UNKNOWN)
+      @autocompletion = true
+      @ruby_completion = true
     end
 
     def log_level=(level)

data/lib/yarsh/help.rb

@@ -0,0 +1,72 @@
+module Yarsh
+  module Help
+    class Command
+      MINIMAL_WIDTH = 5
+
+      def initialize(screen_width, cursor_pos_to_render, autocomplete_dialog)
+        @x = cursor_pos_to_render.x + autocomplete_dialog.width + 1
+        @y = cursor_pos_to_render.y
+        @width = screen_width - @x
+        @whatis = nil
+      end
+
+      def info(command)
+        @info = `whatis #{command} 2>&1`
+        return false unless $?.success?
+
+        @info = @info.split('- ', 2).last.strip
+      rescue StandardError => e
+        debug("Error during whatis: #{e.message}")
+        false
+      end
+
+      def render_dialog
+        return nil unless info_and_width?
+
+        Reline::DialogRenderInfo.new(
+          contents: format_output,
+          pos: Reline::CursorPos.new(@x, @y - 1),
+          width: @width,
+          height: height + 1,
+          face: :completion_dialog
+        )
+      end
+
+      private
+
+      def format_output
+        return nil unless info_and_width?
+
+        dialog_line = []
+        line_size = 0
+        dialog_content = []
+        words = @info.split(' ')
+        words.each_with_index do |word, i|
+          dialog_line << word
+          line_size += word.size + 1
+          if i + 1 == words.size
+            if line_size >= @width
+              dialog_content << dialog_line[0..-2].join(' ').strip << dialog_line.last
+              next
+            end
+            dialog_content << dialog_line.join(' ').strip && next
+          end
+          next unless line_size >= @width
+
+          dialog_content << dialog_line[0..-2].join(' ').strip
+          line_size = dialog_line.last.size
+          dialog_line = [dialog_line.last]
+        end
+        dialog_content
+      end
+
+      def height
+        @height ||= !info_and_width? ? nil : @info.size / @width
+      end
+
+      def info_and_width?
+        @info && @width && @width > MINIMAL_WIDTH
+      end
+    end
+  end
+end

data/lib/yarsh/shell.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'shellwords'
+
 module Yarsh
   class Shell
     include Yarsh
@@ -12,6 +14,8 @@ module Yarsh
                         local logout mapfile popd printf pushd pwd read readonly
                         return set shift shopt source suspend test times trap true
                         type typeset ulimit umask unalias unset wait].freeze
+    EXPORT = 'export'
+    DO_NOT_PRINT_RETURN_VALUE = :do_not_print_return_value80y0327y47123
 
     def initialize(bind)
       @bind = bind
@@ -19,10 +23,14 @@ module Yarsh
       @history_file = File.expand_path(HISTORY_FILE)
       @config_file = File.expand_path(CONFIG_FILE)
       @cf = Yarsh::AnsiColorFormatter.new
+      @typing = false
       Yarsh.current_shell = self
+      setup_completion_registry
       setup_reline_history
       setup_reline_completion
       setup_reline_prompt
+      setup_output_modifier_proc
+      setup_completion_dialog
     end
 
     def shell
@@ -52,26 +60,49 @@ module Yarsh
           puts @cf.fg_red("Error: #{e.class}: #{e.message}\n#{e.backtrace.join("\n")}")
         end
       end
+    ensure
+      Config.instance.logger.close
     end
 
     private
 
     def format_output(object)
-      pp object
+      pp object unless object == DO_NOT_PRINT_RETURN_VALUE
     end
     alias fp format_output
 
     def read_input
-      @core.readmultiline(Config.instance.prompt, true) do |buffer|
+      @typing = true
+      input = @core.readmultiline(Config.instance.prompt, true) do |buffer|
         !incomplete_line?(buffer) || buffer.match?(/\n[ \t]*\n\z/)
       end
+      @typing = false
+      input
     end
 
     # A line is "incomplete" (multiline continues) only when it is not a
     # shell command: `cd /tmp`, `grep foo /etc/passwd` etc. fail to compile
     # as Ruby (unterminated regexp) but must stay single-line.
     def incomplete_line?(line)
-      Yarsh::Multiline.incomplete?(line) && !shell_command?(line)
+      return true if shell_command?(line) && unclosed_quote?(line)
+
+      Yarsh::Multiline.incomplete?(line) && !shell_command?(line) && !line&.start_with?('cd')
+    end
+
+    def unclosed_quote?(line)
+      return false if line.nil?
+
+      double_quotes = line.scan(/(?<!\\)"/).size
+      single_quotes = line.scan(/(?<!\\)'/).size
+      double_quotes.odd? || single_quotes.odd?
+    end
+
+    def inside_quote?(pre)
+      return false if pre.nil? || pre.empty?
+
+      double_quotes = pre.scan(/(?<!\\)"/).size
+      single_quotes = pre.scan(/(?<!\\)'/).size
+      double_quotes.odd? || single_quotes.odd?
     end
 
     def execute_multiline(input)
@@ -89,7 +120,17 @@ module Yarsh
 
       if input == 'cd' || input.start_with?('cd ')
         cd(input.split(' ', 2)[1])
-        return nil
+        return DO_NOT_PRINT_RETURN_VALUE
+      end
+
+      if input.start_with?("#{EXPORT} ")
+        assignment = input[EXPORT.length + 1..].strip.split('=', 2)
+        if assignment.size == 2
+          ENV[assignment[0]] = assignment[1].gsub(/\A['"]|['"]\z/, '') # Remove surrounding quotes if present
+          return DO_NOT_PRINT_RETURN_VALUE
+        end
+        puts @cf.fg_red("Error: Invalid export syntax. Use 'export VAR=value'")
+        return DO_NOT_PRINT_RETURN_VALUE
       end
 
       begin
@@ -104,11 +145,13 @@ module Yarsh
         begin
           input = Yarsh.expand_aliases(input, Config.instance.aliases)
           execute(input)
+          DO_NOT_PRINT_RETURN_VALUE
         rescue Exception => e
           $sher = e
           info("#{e.class}: #{e.message}")
           puts "#{@cf.bold.underline.fg_blue('Shell:')} '#{input}': #{e.message}"
           puts "#{@cf.bold.underline.fg_red('Ruby:')} '#{input}': #{rb_error.message}"
+          DO_NOT_PRINT_RETURN_VALUE
         end
       end
     end
@@ -137,6 +180,7 @@ module Yarsh
       system(cmd, exception: true)
     end
 
+    # TODO: Use exec_in_path?
     def shell_command?(input)
       first_token = input.strip.split(/\s+/, 2).first
       return true if shell_path?(first_token)
@@ -147,7 +191,39 @@ module Yarsh
       end
     end
 
+    def exec_in_path?(input)
+      ENV['PATH'].split(File::PATH_SEPARATOR).any? do |dir|
+        File.executable?(File.join(dir, input))
+      end
+    end
+
     def complete_command(word)
+      registry = @completion_registry
+      return [] if word.nil?
+
+      if word.empty?
+        return ENV['PATH'].split(File::PATH_SEPARATOR)
+                          .flat_map { |dir| Dir["#{dir}/*"] }
+                          .map { |f| File.basename(f) }
+                          .uniq
+                          .sort
+      end
+
+      cmd = word.strip.split(/\s+/).first
+      return [] if cmd.nil? || cmd.empty?
+
+      # Strip privileged prefix (sudo, doas, etc.) — complete the real command
+      if Yarsh::Completion::Engine::PRIVILEGED_COMMANDS.include?(cmd) && cmd != word
+        remaining = word.sub(/\A#{Regexp.escape(cmd)}\s+/, '')
+        return complete_command(remaining)
+      end
+
+      completions = registry.complete(cmd, word)
+      return completions unless completions.empty?
+
+      builtins = SHELL_BUILTINS.select { |b| b.start_with?(word) }
+      return builtins unless builtins.empty?
+
       ENV['PATH'].split(File::PATH_SEPARATOR)
                  .flat_map { |dir| Dir["#{dir}/#{word}*"] }
                  .map { |f| File.basename(f) }
@@ -155,6 +231,62 @@ module Yarsh
                  .sort
     end
 
+    def setup_completion_registry
+      @completion_registry = Yarsh::Completion::Registry.new
+      @completion_registry.register(Yarsh::Completion::BashAutocomplete.new)
+      @completion_registry.register(Yarsh::Completion::GemCompletion.new)
+      @completion_registry.register(Yarsh::Completion::HelpCompletion.new)
+    end
+
+    def complete_ruby(word)
+      IRB::InputCompletor.retrieve_completion_data(word, bind: @bind)
+    rescue StandardError
+      []
+    end
+
+    def setup_output_modifier_proc
+      @core.output_modifier_proc = proc do |data|
+        if @typing
+          IRB::Color.colorize_code(data)
+        else
+          data
+        end
+      end
+    end
+
+    def setup_completion_dialog
+      Reline.add_dialog_proc(:docs, proc {
+        begin
+          dialog.trap_key = nil
+
+          next nil if just_cursor_moving && completion_journey_data.nil?
+
+          cursor_pos_to_render, result, pointer, autocomplete_dialog = context.pop(4)
+          next nil if result.nil? || pointer.nil? || pointer.negative?
+
+          selection = result[pointer]
+          help_command = Help::Command.new(screen_width, cursor_pos_to_render, autocomplete_dialog)
+          next nil unless help_command.info(result[pointer])
+
+          dialog.trap_key = Yarsh::ALT_D_SEQUENCES
+
+          if key.match?(dialog.name)
+            begin
+              print "\e[?1049h"
+              system(*Shellwords.shellsplit("man #{selection}"))
+            ensure
+              print "\e[?1049l"
+            end
+          end
+          help_command.render_dialog
+        rescue StandardError => e
+          extend Yarsh::InstanceMethods
+          debug("Error occurend for add help dialog: #{e.message}")
+          nil
+        end
+      }, Reline::DEFAULT_DIALOG_CONTEXT)
+    end
+
     def complete_path(word)
       word = './' if word.empty?
       glob_word = word.start_with?('~') ? File.expand_path(word) : word
@@ -199,17 +331,30 @@ module Yarsh
     end
 
     def setup_reline_completion
-      Reline.completion_proc = proc { |target, pre|
-        # puts "target='#{target}' pre='#{pre}'"
-        if target.match?(%r{\A\.\.?(/|\z)}) || target.start_with?('/', '~') || target.include?('/')
-          complete_path(target)
-        elsif target.empty? && pre.empty?
-          complete_command(target)
-        elsif pre.end_with?(' ')
-          complete_path(target)
-        else
-          complete_command(target)
-        end
+      Reline.autocompletion = Config.instance.autocompletion
+      Reline.completion_append_character = ' '
+      Reline.core.config.keyseq_timeout = 0.5
+      Reline.completion_proc = proc { |target, pre, _post|
+        next [] if inside_quote?(pre) || pre =~ /'|"\z/
+
+        full = pre.empty? ? target : pre.rstrip + ' ' + target
+        first_word = full.strip.split(/\s+/).first.to_s
+        ruby_completions = if !Config.instance.ruby_completion ||
+                              Yarsh::Completion::Engine::PRIVILEGED_COMMANDS.include?(first_word)
+                             []
+                           else
+                             complete_ruby(target).compact
+                           end
+        ruby_completions +
+          if target.match?(%r{\A\.\.?(/|\z)}) || target.start_with?('/', '~') || target.include?('/')
+            complete_path(target)
+          elsif target.empty? && pre.empty?
+            complete_command(target)
+          elsif pre.end_with?(' ')
+            complete_command(full)
+          else
+            complete_command(full)
+          end
       }
     end
 

data/lib/yarsh/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Yarsh
-  VERSION = '0.2.0'
+  VERSION = '0.3.1'
 end

data/lib/yarsh.rb

@@ -4,6 +4,9 @@ require 'reline'
 require 'open3'
 require 'singleton'
 require 'logger'
+require 'irb/completion'
+require_relative 'yarsh/completion/gem_completion'
+require 'irb/color'
 require 'ripper'
 require 'prism'
 
@@ -19,6 +22,13 @@ module Yarsh
   YARSH_DIR = '~/.yarsh'
   HISTORY_FILE = File.join Yarsh::YARSH_DIR, 'history'
   CONFIG_FILE = File.join Yarsh::YARSH_DIR, 'config'
+  ALT_D_SEQUENCES = [
+      [27, 100], # Normal Alt+d when convert-meta isn't used.
+      # When option/alt is not configured as a meta key in terminal emulator,
+      # option/alt + d will send a unicode character depend on OS keyboard setting.
+      [195, 164], # "ä" in somewhere (FIXME: environment information is unknown).
+      [226, 136, 130] # "∂" Alt+d on Mac keyboard.
+    ].freeze
 
   class ExecOutput < String
     def initialize(string)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yarsh
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - yarsh4all
@@ -45,7 +45,14 @@ files:
 - lib/yarsh.rb
 - lib/yarsh/ansi_color_formatter.rb
 - lib/yarsh/binding.rb
+- lib/yarsh/completion.rb
+- lib/yarsh/completion/bash_autocomplete.rb
+- lib/yarsh/completion/engine.rb
+- lib/yarsh/completion/gem_completion.rb
+- lib/yarsh/completion/help_completion.rb
+- lib/yarsh/completion/registry.rb
 - lib/yarsh/config.rb
+- lib/yarsh/help.rb
 - lib/yarsh/instance_methods.rb
 - lib/yarsh/multiline.rb
 - lib/yarsh/prompt.rb