Class: Vimrunner::Client

Inherits:

Object

• Object
• Vimrunner::Client

show all

Defined in:

lib/vimrunner/client.rb

Instance Attribute Summary (collapse)

• - (Object) server readonly

  Returns the value of attribute server.

Instance Method Summary (collapse)

• - (Object) add_plugin(dir, entry_script = nil)

  Public: Adds a plugin to Vim's runtime.

• - (Object) append_runtimepath(dir)

  Public: Appends a directory to Vim's runtimepath.

• - (Object) command(commands)

  Public: Executes the given command in the Vim instance and returns its output, stripping all surrounding whitespace.

• - (Object) echo(*expressions)

  Public: Echo each expression with a space in between.

• - (Object) edit(filename)

  Public: Edits the file filename with Vim.

• - (Object) edit!(filename)

  Public: Edits the file filename with Vim using edit!.

• - (Client) initialize(server) constructor

  A new instance of Client.

• - (Object) insert(text)

  Public: Switches Vim to insert mode and types in the given text.

• - (Object) kill

  Kills the server it's connected to.

• - (Object) normal(keys = "")

  Public: Switches Vim to normal mode and types in the given keys.

• - (Object) prepend_runtimepath(dir)

  Public: Prepends a directory to Vim's runtimepath.

• - (Object) search(text)

  Public: Starts a search in Vim for the given text.

• - (Object) set(setting, value = nil)

  Public: Sets a setting in Vim.

• - (Object) type(keys)

  Public: Invokes one of the basic actions the Vim server supports, sending a key sequence.

• - (Object) write

  Public: Writes the file being edited to disk.

5
6
7

# File 'lib/vimrunner/client.rb', line 5

def initialize(server)
  @server = server
end

3
4
5

# File 'lib/vimrunner/client.rb', line 3

def server
  @server
end

its autoload, plugin, ftplugin, etc. directories.

(optional).

vim.add_plugin 'rails', 'plugin/rails.vim'

23
24
25
26

# File 'lib/vimrunner/client.rb', line 23

def add_plugin(dir, entry_script = nil)
  append_runtimepath(dir)
  command("runtime #{entry_script}") if entry_script
end

33
34
35

# File 'lib/vimrunner/client.rb', line 33

def append_runtimepath(dir)
  command("set runtimepath+=#{dir}")
end

144
145
146
147
148
149
150

# File 'lib/vimrunner/client.rb', line 144

def command(commands)
  expression = "VimrunnerEvaluateCommandOutput('#{escape(commands)}')"

  server.remote_expr(expression).tap do |output|
    raise InvalidCommandError.new(output) if output =~ /^Vim:E\d+:/
  end
end

95
96
97

# File 'lib/vimrunner/client.rb', line 95

def echo(*expressions)
  command "echo #{expressions.join(' ')}"
end

124
125
126
127

# File 'lib/vimrunner/client.rb', line 124

def edit(filename)
  command "edit #{filename}"
  self
end

134
135
136
137

# File 'lib/vimrunner/client.rb', line 134

def edit!(filename)
  command "edit! #{filename}"
  self
end

79
80
81

# File 'lib/vimrunner/client.rb', line 79

def insert(text)
  normal "i#{text}"
end

153
154
155

# File 'lib/vimrunner/client.rb', line 153

def kill
  server.kill
end

52
53
54
55

# File 'lib/vimrunner/client.rb', line 52

def normal(keys = "")
  server.remote_send("<C-\\><C-n>#{keys}")
  self
end

44
45
46
47

# File 'lib/vimrunner/client.rb', line 44

def prepend_runtimepath(dir)
  runtimepath = echo '&runtimepath'
  command("set runtimepath=#{dir},#{runtimepath}")
end

71
72
73
74

# File 'lib/vimrunner/client.rb', line 71

def search(text)
  normal
  type "/#{text}<CR>"
end

vim.set 'expandtab'  # invokes ":set expandtab"
vim.set 'tabstop', 3 # invokes ":set tabstop=3"

108
109
110
111
112
113
114
115

# File 'lib/vimrunner/client.rb', line 108

def set(setting, value = nil)
  if value
    command "set #{setting}=#{value}"
  else
    command "set #{setting}"
  end
  self
end

62
63
64
65

# File 'lib/vimrunner/client.rb', line 62

def type(keys)
  server.remote_send(keys)
  self
end

87
88
89
90

# File 'lib/vimrunner/client.rb', line 87

def write
  command :write
  self
end