chinhwajie/zsh-autosuggestions
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Lots of async changes

Browse Source
This commit is contained in:
Eric Freese
2017-02-16 19:18:03 -07:00
parent 38eb7cdafd
commit ed8056c5e8
35 changed files with 384 additions and 1133 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
spec/integrations/client_zpty_spec.rb Normal file
View File

@@ -0,0 +1,11 @@
describe 'a running zpty command' do
it 'is not affected by running zsh-autosuggestions' do
session.run_command('zmodload zsh/zpty')
session.run_command('zpty -b kitty cat')
session.run_command('zpty -w kitty cat')
sleep 1
session.run_command('zpty -r kitty')
wait_for(session.content).to end_with("\ncat")
end
end

13
spec/multi_line_spec.rb Normal file
View File

@@ -0,0 +1,13 @@
describe 'a multi-line suggestion' do
it 'should be displayed on multiple lines' do
with_history(-> {
session.send_string('echo "')
session.send_keys('enter')
session.send_string('"')
session.send_keys('enter')
}) do
session.send_keys('e')
wait_for { session.content }.to eq("echo \"\n\"")
end
end
end

15
spec/options/async_zpty_name_spec.rb Normal file
View File

@@ -0,0 +1,15 @@
describe 'the zpty for async suggestions' do
it 'is created with the default name' do
session.run_command('zpty -t zsh_autosuggest_pty &>/dev/null; echo $?')
wait_for { session.content }.to end_with("\n0")
end
context 'when ZSH_AUTOSUGGEST_ASYNC_PTY_NAME is set' do
let(:options) { ['ZSH_AUTOSUGGEST_ASYNC_PTY_NAME=foo_pty'] }
it 'is created with the specified name' do
session.run_command('zpty -t foo_pty &>/dev/null; echo $?')
wait_for { session.content }.to end_with("\n0")
end
end
end

30
spec/options/buffer_max_size_spec.rb Normal file
View File

@@ -0,0 +1,30 @@
describe 'a suggestion' do
let(:term_opts) { { width: 200 } }
let(:long_command) { "echo #{'a' * 100}" }
around do |example|
with_history(long_command) { example.run }
end
it 'is provided for any buffer length' do
session.send_string(long_command[0...-1])
wait_for { session.content }.to eq(long_command)
end
context 'when ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE is specified' do
let(:buffer_max_size) { 10 }
let(:options) { ["ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE=#{buffer_max_size}"] }
it 'is provided when the buffer is shorter than the specified length' do
session.send_string(long_command[0...(buffer_max_size - 1)])
wait_for { session.content }.to eq(long_command)
end
it 'is provided when the buffer is equal to the specified length' do
session.send_string(long_command[0...(buffer_max_size)])
wait_for { session.content }.to eq(long_command)
end
it 'is not provided when the buffer is longer than the specified length'
end
end

7
spec/options/highlight_style_spec.rb Normal file
View File

@@ -0,0 +1,7 @@
describe 'a displayed suggestion' do
it 'is shown in the default style'
describe 'when ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE is set to a zle_highlight string' do
it 'is shown in the specified style'
end
end

7
spec/options/original_widget_prefix_spec.rb Normal file
View File

@@ -0,0 +1,7 @@
describe 'an original zle widget' do
context 'is accessible with the default prefix'
context 'when ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX is set' do
it 'is accessible with the specified prefix'
end
end

20
spec/options/strategy_spec.rb Normal file
View File

@@ -0,0 +1,20 @@
describe 'a suggestion for a given prefix' do
let(:options) { ['_zsh_autosuggest_strategy_default() { suggestion="echo foo" }'] }
it 'is determined by calling the default strategy function' do
session.send_string('e')
wait_for { session.content }.to eq('echo foo')
end
context 'when ZSH_AUTOSUGGEST_STRATEGY is set' do
let(:options) { [
'_zsh_autosuggest_strategy_custom() { suggestion="echo foo" }',
'ZSH_AUTOSUGGEST_STRATEGY=custom'
] }
it 'is determined by calling the specified strategy function' do
session.send_string('e')
wait_for { session.content }.to eq('echo foo')
end
end
end

7
spec/options/use_async_spec.rb Normal file
View File

@@ -0,0 +1,7 @@
describe 'suggestion fetching' do
it 'is performed asynchronously'
context 'when ZSH_AUTOSUGGEST_USE_ASYNC is unset' do
it 'is performed synchronously'
end
end

72
spec/options/widget_lists_spec.rb Normal file
View File

@@ -0,0 +1,72 @@
describe 'a zle widget' do
let(:before_sourcing) { -> { session.run_command('my-widget() {}; zle -N my-widget; bindkey ^B my-widget') } }
context 'when added to ZSH_AUTOSUGGEST_ACCEPT_WIDGETS' do
let(:options) { ['ZSH_AUTOSUGGEST_ACCEPT_WIDGETS=(my-widget)'] }
it 'accepts the suggestion when invoked' do
with_history('echo hello') do
session.send_string('e')
wait_for { session.content }.to eq('echo hello')
session.send_keys('C-b')
wait_for { session.content(esc_seqs: true) }.to eq('echo hello')
end
end
end
context 'when added to ZSH_AUTOSUGGEST_CLEAR_WIDGETS' do
let(:options) { ['ZSH_AUTOSUGGEST_CLEAR_WIDGETS=(my-widget)'] }
it 'clears the suggestion when invoked' do
with_history('echo hello') do
session.send_string('e')
wait_for { session.content }.to eq('echo hello')
session.send_keys('C-b')
wait_for { session.content }.to eq('e')
end
end
end
context 'when added to ZSH_AUTOSUGGEST_EXECUTE_WIDGETS' do
let(:options) { ['ZSH_AUTOSUGGEST_EXECUTE_WIDGETS=(my-widget)'] }
it 'executes the suggestion when invoked' do
with_history('echo hello') do
session.send_string('e')
wait_for { session.content }.to eq('echo hello')
session.send_keys('C-b')
wait_for { session.content }.to end_with("\nhello")
end
end
end
end
describe 'a zle widget that moves the cursor forward' do
let(:before_sourcing) { -> { session.run_command('my-widget() { zle forward-char }; zle -N my-widget; bindkey ^B my-widget') } }
context 'when added to ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS' do
let(:options) { ['ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS=(my-widget)'] }
it 'accepts the suggestion as far as the cursor is moved when invoked' do
with_history('echo hello') do
session.send_string('e')
wait_for { session.content }.to start_with('echo hello')
session.send_keys('C-b')
wait_for { session.content(esc_seqs: true) }.to match(/\Aec\e\[[0-9]+mho hello/)
end
end
end
end
describe 'a builtin zle widget' do
let(:widget) { 'beep' }
context 'when added to ZSH_AUTOSUGGEST_IGNORE_WIDGETS' do
let(:options) { ["ZSH_AUTOSUGGEST_IGNORE_WIDGETS=(#{widget})"] }
it 'should not be wrapped with an autosuggest widget' do
session.run_command("echo $widgets[#{widget}]")
wait_for { session.content }.to end_with("\nbuiltin")
end
end
end

35
spec/spec_helper.rb
View File

@@ -2,6 +2,39 @@ require 'pry'
require 'rspec/wait'
require 'terminal_session'
RSpec.shared_context 'terminal session' do
let(:term_opts) { {} }
let(:session) { TerminalSession.new(term_opts) }
let(:before_sourcing) { -> {} }
let(:options) { [] }
around do |example|
before_sourcing.call
session.run_command((['source zsh-autosuggestions.zsh'] + options).join('; '))
session.clear_screen
example.run
session.destroy
end
def with_history(*commands, &block)
session.run_command('fc -p')
commands.each do |c|
c.respond_to?(:call) ? c.call : session.run_command(c)
end
session.clear_screen
yield block
session.send_keys('C-c')
session.run_command('fc -P')
end
end
RSpec.configure do |config|
config.expect_with :rspec do |expectations|
expectations.include_chain_clauses_in_custom_matcher_descriptions = true
@@ -12,4 +45,6 @@ RSpec.configure do |config|
end
config.wait_timeout = 2
config.include_context 'terminal session'
end

55
spec/special_characters_spec.rb Normal file
View File

@@ -0,0 +1,55 @@
describe 'a special character in the buffer' do
it 'should be treated like any other character' do
with_history('echo "hello*"', 'echo "hello."') do
session.send_string('echo "hello*')
wait_for { session.content }.to eq('echo "hello*"')
end
with_history('echo "hello?"', 'echo "hello."') do
session.send_string('echo "hello?')
wait_for { session.content }.to eq('echo "hello?"')
end
with_history('echo "hello\nworld"') do
session.send_string('echo "hello\\')
wait_for { session.content }.to eq('echo "hello\nworld"')
end
with_history('echo "\\\\"') do
session.send_string('echo "\\\\')
wait_for { session.content }.to eq('echo "\\\\"')
end
with_history('echo ~/foo') do
session.send_string('echo ~')
wait_for { session.content }.to eq('echo ~/foo')
end
with_history('echo "$(ls foo)"') do
session.send_string('echo "$(')
wait_for { session.content }.to eq('echo "$(ls foo)"')
end
with_history('echo "$history[123]"') do
session.send_string('echo "$history[')
wait_for { session.content }.to eq('echo "$history[123]"')
session.send_string('123]')
wait_for { session.content }.to eq('echo "$history[123]"')
end
with_history('echo "#yolo"') do
session.send_string('echo "#')
wait_for { session.content }.to eq('echo "#yolo"')
end
with_history('echo "#foo"', 'echo $#abc') do
session.send_string('echo "#')
wait_for { session.content }.to eq('echo "#foo"')
end
with_history('echo "^A"', 'echo "^B"') do
session.send_string('echo "^A')
wait_for { session.content }.to eq('echo "^A"')
end
end
end

146
spec/strategies/default_spec.rb
View File

@@ -1,148 +1,8 @@
describe 'default strategy' do
let(:session) { TerminalSession.new }
before do
session.run_command('source zsh-autosuggestions.zsh')
session.run_command('fc -p')
session.clear
wait_for { session.content }.to eq('')
end
after do
session.destroy
end
context 'with some simple history entries' do
before do
session.run_command('ls foo')
session.run_command('ls bar')
session.clear
end
it 'suggests nothing if there is no match' do
session.send_string('ls q')
wait_for { session.content }.to eq('ls q')
end
it 'suggests the most recent matching history item' do
describe 'the default suggestion strategy' do
it 'suggests the last matching history entry' do
with_history('ls foo', 'ls bar', 'echo baz') do
session.send_string('ls')
wait_for { session.content }.to eq('ls bar')
end
end
context 'with a multiline hist entry' do
before do
session.send_string('echo "')
session.send_keys('enter')
session.send_string('"')
session.send_keys('enter')
session.clear
end
it do
session.send_keys('e')
wait_for { session.content }.to eq "echo \"\n\""
end
end
context 'with a newline hist entry' do
before do
session.send_string('echo "\n"')
session.send_keys('enter')
session.clear
end
it do
session.send_keys('e')
wait_for { session.content }.to eq 'echo "\n"'
end
end
context 'with a hist entry with a backslash' do
before do
session.run_command('echo "hello\nworld"')
session.clear
end
it do
session.send_string('echo "hello\\')
wait_for { session.content }.to eq('echo "hello\nworld"')
end
end
context 'with a hist entry with double backslashes' do
before do
session.run_command('echo "\\\\"')
session.clear
end
it do
session.send_string('echo "\\\\')
wait_for { session.content }.to eq('echo "\\\\"')
end
end
context 'with a hist entry with a tilde' do
before do
session.run_command('ls ~/foo')
session.clear
end
it do
session.send_string('ls ~')
wait_for { session.content }.to eq('ls ~/foo')
end
context 'with extended_glob set' do
before do
session.run_command('setopt local_options extended_glob')
session.clear
end
it do
session.send_string('ls ~')
wait_for { session.content }.to eq('ls ~/foo')
end
end
end
context 'with a hist entry with parentheses' do
before do
session.run_command('echo "$(ls foo)"')
session.clear
end
it do
session.send_string('echo "$(')
wait_for { session.content }.to eq('echo "$(ls foo)"')
end
end
context 'with a hist entry with square brackets' do
before do
session.run_command('echo "$history[123]"')
session.clear
end
it do
session.send_string('echo "$history[')
wait_for { session.content }.to eq('echo "$history[123]"')
end
end
context 'with a hist entry with pound sign' do
before do
session.run_command('echo "#yolo"')
session.clear
end
it do
session.send_string('echo "#')
wait_for { session.content }.to eq('echo "#yolo"')
end
end
end

65
spec/strategies/match_prev_cmd_spec.rb
View File

@@ -1,60 +1,17 @@
describe 'match_prev_cmd strategy' do
let(:session) { TerminalSession.new }
before do
session.run_command('source zsh-autosuggestions.zsh')
session.run_command('ZSH_AUTOSUGGEST_STRATEGY=match_prev_cmd')
session.run_command('fc -p')
session.clear
end
after do
session.destroy
end
context 'with some history entries' do
before do
session.run_command('echo what')
session.run_command('ls foo')
session.run_command('echo what')
session.run_command('ls bar')
session.run_command('ls baz')
session.clear
end
it 'suggests nothing if prefix does not match' do
session.send_string('ls q')
wait_for { session.content }.to eq('ls q')
end
it 'suggests the most recent matching history item' do
session.send_string('ls')
wait_for { session.content }.to eq('ls baz')
end
it 'suggests the most recent after the previous command' do
session.run_command('echo what')
session.clear
describe 'the match_prev_cmd strategy' do
let(:options) { ['ZSH_AUTOSUGGEST_STRATEGY=match_prev_cmd'] }
it 'suggests the last matching history entry after the previous command' do
with_history(
'echo what',
'ls foo',
'echo what',
'ls bar',
'ls baz',
'echo what'
) do
session.send_string('ls')
wait_for { session.content }.to eq('ls bar')
end
end
context 'with a multiline hist entry' do
before do
session.send_string('echo "')
session.send_keys('enter')
session.send_string('"')
session.send_keys('enter')
session.clear
end
it do
session.send_keys('e')
wait_for { session.content }.to eq "echo \"\n\""
end
end
end

4
spec/terminal_session.rb
View File

@@ -41,7 +41,7 @@ class TerminalSession
tmux_command(cmd).strip
end
def clear
def clear_screen
send_keys('C-l')
sleep(0.1) until content == ''
@@ -68,7 +68,7 @@ class TerminalSession
def tmux_command(cmd)
out = `tmux -u -L #{tmux_socket_name} #{cmd}`
raise('tmux error') unless $?.success?
raise("tmux error running: '#{cmd}'") unless $?.success?
out
end

162
spec/widgets/accept_spec.rb
View File

@@ -1,162 +0,0 @@
describe 'accept widget' do
let(:session) { TerminalSession.new }
before do
session.run_command('source zsh-autosuggestions.zsh')
session.run_command(select_keymap)
session.run_command('fc -p')
session.run_command('echo hello world')
session.clear
session.send_string('echo')
wait_for { session.content }.to start_with('echo')
end
after do
session.destroy
end
describe 'emacs keymap' do
let(:select_keymap) { 'bindkey -e' }
context 'forward-char' do
subject { session.send_keys('right') }
context 'when the cursor is at the end of the buffer' do
it 'accepts the suggestion' do
expect { subject }.to change { session.content(esc_seqs: true) }.to('echo hello world')
end
it 'moves the cursor to the end of the buffer' do
expect { subject }.to change { session.cursor }.from([4, 0]).to([16, 0])
end
end
context 'when the cursor is not at the end of the buffer' do
before { 2.times { session.send_keys('left') } }
it 'does not accept the suggestion' do
expect { subject }.not_to change { session.content(esc_seqs: true) }
end
it 'moves the cursor forward one character' do
expect { subject }.to change { session.cursor }.from([2, 0]).to([3, 0])
end
end
end
context 'end-of-line' do
subject { session.send_keys('C-e') }
context 'when the cursor is at the end of the buffer' do
it 'accepts the suggestion' do
expect { subject }.to change { session.content(esc_seqs: true) }.to('echo hello world')
end
it 'moves the cursor to the end of the buffer' do
expect { subject }.to change { session.cursor }.from([4, 0]).to([16, 0])
end
end
context 'when the cursor is not at the end of the buffer' do
before { 2.times { session.send_keys('left') } }
it 'does not accept the suggestion' do
expect { subject }.not_to change { session.content(esc_seqs: true) }
end
it 'moves the cursor to the end of the line' do
expect { subject }.to change { session.cursor }.from([2, 0]).to([4, 0])
end
end
end
end
describe 'vi keymap' do
let(:select_keymap) { 'bindkey -v' }
before { session.send_keys('escape') }
context 'vi-forward-char' do
subject { session.send_keys('l') }
context 'when the cursor is at the end of the buffer' do
it 'accepts the suggestion' do
expect { subject }.to change { session.content(esc_seqs: true) }.to('echo hello world')
end
it 'moves the cursor to the end of the buffer' do
wait_for { session.cursor }.to eq([3, 0])
expect { subject }.to change { session.cursor }.from([3, 0]).to([15, 0])
end
end
context 'when the cursor is not at the end of the buffer' do
before { 2.times { session.send_keys('h') } }
it 'does not accept the suggestion' do
expect { subject }.not_to change { session.content(esc_seqs: true) }
end
it 'moves the cursor forward one character' do
expect { subject }.to change { session.cursor }.from([1, 0]).to([2, 0])
end
end
end
context 'vi-end-of-line' do
subject { session.send_keys('$') }
context 'when the cursor is at the end of the buffer' do
it 'accepts the suggestion' do
expect { subject }.to change { session.content(esc_seqs: true) }.to('echo hello world')
end
it 'moves the cursor to the end of the buffer' do
wait_for { session.cursor }.to eq([3, 0])
expect { subject }.to change { session.cursor }.from([3, 0]).to([15, 0])
end
end
context 'when the cursor is not at the end of the buffer' do
before { 2.times { session.send_keys('h') } }
it 'does not accept the suggestion' do
expect { subject }.not_to change { session.content(esc_seqs: true) }
end
it 'moves the cursor to the end of the line' do
expect { subject }.to change { session.cursor }.from([1, 0]).to([3, 0])
end
end
end
context 'vi-add-eol' do
subject { session.send_keys('A') }
context 'when the cursor is at the end of the buffer' do
it 'accepts the suggestion' do
expect { subject }.to change { session.content(esc_seqs: true) }.to('echo hello world')
end
it 'moves the cursor to the end of the buffer' do
wait_for { session.cursor }.to eq([3, 0])
expect { subject }.to change { session.cursor }.from([3, 0]).to([16, 0])
end
end
context 'when the cursor is not at the end of the buffer' do
before { 2.times { session.send_keys('h') } }
it 'does not accept the suggestion' do
expect { subject }.not_to change { session.content(esc_seqs: true) }
end
it 'moves the cursor to the end of the line' do
expect { subject }.to change { session.cursor }.from([1, 0]).to([4, 0])
end
end
end
end
end