yarsh 0.1.1 → 0.3.0

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/instance_methods.rb

@@ -8,6 +8,29 @@ module Yarsh
       Config.instance.add_alias(new_name, command)
     end
 
+    # Executes a shell line from inside a multiline Ruby buffer. Shell lines
+    # are rewritten to __sh__(...) by Yarsh::Multiline.transform.
+    def __sh__(command)
+      shell = Yarsh.current_shell
+      raise Error, 'No active Yarsh shell' if shell.nil?
+
+      shell.send(:__sh_exec, command)
+    end
+
+    def __yarsh__(exp, binding = nil)
+      shell = Yarsh.current_shell
+      raise Error, 'No active Yarsh shell' if shell.nil?
+
+      current_bind = nil
+      if binding
+        current_bind = shell.bind
+        shell.bind = binding
+      end
+      result = shell.send(:yarsh_eval, exp)
+      shell.bind = current_bind if binding
+      result
+    end
+
     def source(filename)
       load(filename, Yarsh::InstanceMethods)
     end