ruby_language_server 0.4.2 → 0.9.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,16 +3,15 @@
3
3
  module RubyLanguageServer
4
4
  module ScopeParserCommands
5
5
  module RailsCommands
6
- def rails_add_reference(line, args, rest)
7
- # args: [:@ident, "has_one", [2, 2]]
8
- # rest: [[:args_add_block, [[:symbol_literal, [:symbol, [:@ident, "bar", [2, 11]]]]], false]]
6
+ # has_one :bar adds the methods bar and bar=.
7
+ def rails_add_reference(node)
8
+ name = command_arguments(node).first
9
+ return if name.blank?
9
10
 
10
- # Looks like the first string is gonna be the name
11
- (_, _, (_, column)) = args
12
- name = rest.flatten.detect { |o| o.instance_of? String }
11
+ line = command_line(node)
12
+ column = command_column(node)
13
13
  [name, "#{name}="].each do |method_name|
14
- push_scope(RubyLanguageServer::ScopeData::Base::TYPE_METHOD, method_name, line, column)
15
- process(rest)
14
+ push_scope(RubyLanguageServer::ScopeData::Base::TYPE_METHOD, method_name, line, column, line)
16
15
  pop_scope
17
16
  end
18
17
  end
@@ -3,28 +3,24 @@
3
3
  module RubyLanguageServer
4
4
  module ScopeParserCommands
5
5
  module RakeCommands
6
- def on_task_command(line, args, rest)
7
- # OMG. Rake commands can have like any form.
8
- # The most reliable way I can see to name them is to grab the string
9
- # I *so* do not want to hear about it when it doesn't work.
10
- name = rest.flatten.detect { |o| o.instance_of?(String) }
11
- # add_scope(args, rest, ScopeData::Scope::TYPE_METHOD)
12
- push_scope(ScopeData::Scope::TYPE_MODULE, name, line, 0, false)
13
- process(args)
14
- process(rest)
15
- # We push a scope and don't pop it because we're called inside on_method_add_block
6
+ def on_task_command(node)
7
+ rake_block_command(node)
16
8
  end
17
9
 
18
- def on_namespace_command(line, args, rest)
19
- # OMG. Rake commands can have like any form.
20
- # The most reliable way I can see to name them is to grab the string
21
- # I *so* do not want to hear about it when it doesn't work.
22
- name = rest.flatten.detect { |o| o.instance_of?(String) }
23
- # add_scope(args, rest, ScopeData::Scope::TYPE_METHOD)
24
- push_scope(ScopeData::Scope::TYPE_MODULE, name, line, 0, false)
25
- process(args)
26
- process(rest)
27
- # We push a scope and don't pop it because we're called inside on_method_add_block
10
+ def on_namespace_command(node)
11
+ rake_block_command(node)
12
+ end
13
+
14
+ private
15
+
16
+ # OMG. Rake commands can have like any form.
17
+ # The most reliable way I can see to name them is to grab the first name-like argument.
18
+ # I *so* do not want to hear about it when it doesn't work.
19
+ # Push the named scope - the block node will create a child "block" scope.
20
+ def rake_block_command(node)
21
+ name = command_arguments(node).first
22
+ push_scope(ScopeData::Scope::TYPE_MODULE, name, command_line(node), 0, command_end_line(node), false)
23
+ @command_pushed_scope = true
28
24
  end
29
25
  end
30
26
  end
@@ -3,27 +3,38 @@
3
3
  module RubyLanguageServer
4
4
  module ScopeParserCommands
5
5
  module RspecCommands
6
- def on_describe_command(line, args, rest)
7
- rspec_block_command('describe', line, args, rest)
6
+ def on_describe_command(node)
7
+ rspec_block_command('describe', node)
8
8
  end
9
9
 
10
- def on_context_command(line, args, rest)
11
- rspec_block_command('context', line, args, rest)
10
+ def on_context_command(node)
11
+ rspec_block_command('context', node)
12
12
  end
13
13
 
14
- def on_it_command(line, args, rest)
15
- rspec_block_command('it', line, args, rest)
14
+ def on_it_command(node)
15
+ rspec_block_command('it', node)
16
16
  end
17
17
 
18
+ # let(:foo) { ... } adds the variable foo to the current scope.
19
+ def on_let_command(node)
20
+ var_name = command_arguments(node).first
21
+ return if var_name.nil?
22
+
23
+ add_variable(var_name, command_line(node), command_column(node))
24
+ end
25
+
26
+ # let! is an eager version of let - alias it using send to avoid syntax issues
27
+ send(:alias_method, 'on_let!_command', :on_let_command)
28
+
18
29
  private
19
30
 
20
- def rspec_block_command(prefix, line, args, rest)
21
- name = "#{prefix} "
22
- name += rest.flatten.select { |part| part.instance_of?(String) }.join('::')
23
- push_scope(ScopeData::Scope::TYPE_MODULE, name, line, 0, false)
24
- process(args)
25
- process(rest)
26
- # We push a scope and don't pop it because we're called inside on_method_add_block
31
+ # Push the named scope (e.g., "describe Something").
32
+ # The block node will create a child "block" scope automatically.
33
+ # Signal that visit_call_node should pop this scope after visiting children.
34
+ def rspec_block_command(prefix, node)
35
+ name = "#{prefix} #{command_arguments(node).join('::')}"
36
+ push_scope(ScopeData::Scope::TYPE_MODULE, name, command_line(node), 0, command_end_line(node), false)
37
+ @command_pushed_scope = true
27
38
  end
28
39
  end
29
40
  end
@@ -3,63 +3,37 @@
3
3
  module RubyLanguageServer
4
4
  module ScopeParserCommands
5
5
  module RubyCommands
6
- # when 'define_method', 'alias_method',
7
- # 'public_class_method', 'private_class_method',
8
- # # "public", "protected", "private",
9
- # /^attr_(accessor|reader|writer)$/
10
- # # on_method_add_arg([:fcall, name], args[0])
11
- # when 'attr'
12
- # # [[:args_add_block, [[:symbol_literal, [:symbol, [:@ident, "top", [3, 14]]]]], false]]
13
- # ((_, ((_, (_, (_, name, (line, column))))))) = rest
14
- # add_ivar("@#{name}", line, column)
15
- # push_scope(ScopeData::Scope::TYPE_METHOD, name, line, column)
16
- # pop_scope
17
- # push_scope(ScopeData::Scope::TYPE_METHOD, "#{name}=", line, column)
18
- # pop_scope
19
-
20
- def on_attr_command(line, args, rest)
21
- column = ruby_command_column(args)
22
- names = ruby_command_names(rest)
23
- ruby_command_add_attr(line, column, names, true, true)
6
+ # attr :foo and attr_accessor :foo add the methods foo and foo=.
7
+ def on_attr_command(node)
8
+ ruby_command_add_attr(node, reader: true, writer: true)
24
9
  end
25
10
 
26
- def on_attr_accessor_command(line, args, rest)
27
- column = ruby_command_column(args)
28
- names = ruby_command_names(rest)
29
- ruby_command_add_attr(line, column, names, true, true)
11
+ def on_attr_accessor_command(node)
12
+ ruby_command_add_attr(node, reader: true, writer: true)
30
13
  end
31
14
 
32
- def on_attr_reader_command(line, args, rest)
33
- column = ruby_command_column(args)
34
- names = ruby_command_names(rest)
35
- ruby_command_add_attr(line, column, names, true, false)
15
+ def on_attr_reader_command(node)
16
+ ruby_command_add_attr(node, reader: true, writer: false)
36
17
  end
37
18
 
38
- def on_attr_writer_command(line, args, rest)
39
- column = ruby_command_column(args)
40
- names = ruby_command_names(rest)
41
- ruby_command_add_attr(line, column, names, false, true)
19
+ def on_attr_writer_command(node)
20
+ ruby_command_add_attr(node, reader: false, writer: true)
42
21
  end
43
22
 
44
23
  private
45
24
 
46
- def ruby_command_names(rest)
47
- rest.flatten.select { |o| o.instance_of? String }
48
- end
49
-
50
- def ruby_command_column(args)
51
- (_, _, (_, column)) = args
52
- column
53
- end
25
+ def ruby_command_add_attr(node, reader:, writer:)
26
+ line = command_line(node)
27
+ column = command_column(node)
28
+ command_arguments(node).each do |name|
29
+ next if name.blank?
54
30
 
55
- def ruby_command_add_attr(line, column, names, reader, writer)
56
- names.each do |name|
57
31
  if reader
58
- push_scope(RubyLanguageServer::ScopeData::Base::TYPE_METHOD, name, line, column)
32
+ push_scope(RubyLanguageServer::ScopeData::Base::TYPE_METHOD, name, line, column, line)
59
33
  pop_scope
60
34
  end
61
35
  if writer
62
- push_scope(RubyLanguageServer::ScopeData::Base::TYPE_METHOD, "#{name}=", line, column)
36
+ push_scope(RubyLanguageServer::ScopeData::Base::TYPE_METHOD, "#{name}=", line, column, line)
63
37
  pop_scope
64
38
  end
65
39
  end
@@ -1,6 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  require 'json'
4
+ require 'uri'
4
5
 
5
6
  # Deal with the various languageserver calls.
6
7
  module RubyLanguageServer
@@ -8,59 +9,62 @@ module RubyLanguageServer
8
9
  Position = Struct.new('Position', :line, :character)
9
10
  attr_accessor :io
10
11
 
11
- def initialize(mutex)
12
- @mutex = mutex
13
- end
14
-
15
12
  def on_initialize(params)
16
13
  RubyLanguageServer.logger.info("on_initialize: #{params}")
17
14
  RubyLanguageServer::CodeFile.all # Just to warm up active_record.
18
- root_path = params['rootPath']
19
- root_uri = params['rootUri']
15
+ # rootPath and rootUri are deprecated in favor of workspaceFolders. Only the first
16
+ # folder is indexed.
17
+ root_uri = params['rootUri'] || params.dig('workspaceFolders', 0, 'uri')
18
+ root_path = params['rootPath'] || path_from_file_uri(root_uri)
20
19
  @project_manager = ProjectManager.new(root_path, root_uri)
21
20
  @project_manager.scan_all_project_files
21
+ @client_capabilities = params['capabilities'] || {}
22
22
  {
23
+ # Advertise only capabilities that have an on_* handler. Requests for anything
24
+ # else get a MethodNotFound error (see IO#process_request).
23
25
  capabilities: {
24
26
  textDocumentSync: 1,
25
- hoverProvider: true,
26
- signatureHelpProvider: {
27
- triggerCharacters: ['(', ',']
28
- },
29
27
  definitionProvider: true,
30
- referencesProvider: true,
31
28
  documentSymbolProvider: true,
32
- workspaceSymbolProvider: true,
33
- xworkspaceReferencesProvider: true,
34
- xdefinitionProvider: true,
35
- xdependenciesProvider: true,
29
+ hoverProvider: true,
36
30
  completionProvider: {
37
- resolveProvider: true,
38
31
  triggerCharacters: ['.', '::']
39
- },
40
- codeActionProvider: true,
41
- renameProvider: true,
42
- executeCommandProvider: {
43
- commands: []
44
- },
45
- xpackagesProvider: true
32
+ }
33
+ },
34
+ serverInfo: {
35
+ name: 'ruby_language_server',
36
+ version: RubyLanguageServer::VERSION
46
37
  }
47
38
  }
48
39
  end
49
40
 
50
41
  def on_initialized(_hash)
51
42
  RubyLanguageServer.logger.info("RubyLanguageServer::VERSION #{RubyLanguageServer::VERSION}")
43
+ register_file_watcher
44
+ end
45
+
46
+ # Ask the client to tell us when Ruby files are created, changed or deleted, so the
47
+ # index doesn't keep files that are gone. Only clients that support dynamic
48
+ # registration for workspace/didChangeWatchedFiles are asked.
49
+ def register_file_watcher
50
+ return unless @client_capabilities&.dig('workspace', 'didChangeWatchedFiles', 'dynamicRegistration')
51
+
52
+ io.send_request('client/registerCapability', registrations: [{
53
+ id: 'ruby_language_server-watched-files',
54
+ method: 'workspace/didChangeWatchedFiles',
55
+ registerOptions: { watchers: [{ globPattern: '**/*.rb' }] }
56
+ }])
52
57
  end
53
58
 
54
59
  def on_workspace_didChangeWatchedFiles(params)
55
- RubyLanguageServer.logger.debug('on_workspace_didChangeWatchedFiles')
56
- RubyLanguageServer.logger.debug(params)
57
- {}
60
+ RubyLanguageServer.logger.debug("on_workspace_didChangeWatchedFiles #{params}")
61
+ @project_manager.watched_files_changed(params['changes'] || [])
62
+ nil # A notification: there is no reply.
58
63
  end
59
64
 
60
65
  def on_textDocument_hover(params)
61
- RubyLanguageServer.logger.debug('on_textDocument_hover')
62
- RubyLanguageServer.logger.debug(params)
63
- {}
66
+ RubyLanguageServer.logger.debug("on_textDocument_hover #{params}")
67
+ @project_manager.hover_at(uri_from_params(params), postition_from_params(params))
64
68
  end
65
69
 
66
70
  def on_textDocument_documentSymbol(params)
@@ -111,12 +115,31 @@ module RubyLanguageServer
111
115
  completions
112
116
  end
113
117
 
118
+ # LSP shutdown request: stop serving, but don't exit until the exit notification.
114
119
  def on_shutdown(_params)
115
120
  RubyLanguageServer.logger.info('on_shutdown')
121
+ @shutdown_requested = true
122
+ nil
123
+ end
124
+
125
+ # LSP exit notification: exit 0 if shutdown came first, 1 otherwise.
126
+ def on_exit(_params)
127
+ RubyLanguageServer.logger.info("on_exit (shutdown requested: #{shutdown_requested?})")
128
+ exit(shutdown_requested? ? 0 : 1)
129
+ end
130
+
131
+ def shutdown_requested?
132
+ @shutdown_requested == true
116
133
  end
117
134
 
118
135
  private
119
136
 
137
+ def path_from_file_uri(uri)
138
+ return nil unless uri&.start_with?('file://')
139
+
140
+ URI.decode_uri_component(URI(uri).path)
141
+ end
142
+
120
143
  def uri_from_params(params)
121
144
  textDocument = params['textDocument']
122
145
  textDocument['uri']
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module RubyLanguageServer
4
- VERSION = '0.4.2'
4
+ VERSION = '0.9.9'
5
5
  end
@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
14
14
  spec.description = 'Provide a language server implementation for ruby in ruby. See https://microsoft.github.io/language-server-protocol/ "A Language Server is meant to provide the language-specific smarts and communicate with development tools over a protocol that enables inter-process communication."'
15
15
  spec.homepage = 'https://github.com/kwerle/ruby_language_server'
16
16
  spec.license = 'MIT'
17
- spec.required_ruby_version = '>=3.1.0'
17
+ spec.required_ruby_version = '>=4.0.0'
18
18
 
19
19
  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
20
20
  # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -35,27 +35,31 @@ Gem::Specification.new do |spec|
35
35
  spec.require_paths = ['lib']
36
36
 
37
37
  # Normally the system will have these - but not if it's a stripped down docker image
38
- spec.add_dependency 'activerecord', '~>8.0'
38
+ spec.add_dependency 'activerecord', '~>8.1'
39
39
  spec.add_dependency 'amatch' # in c
40
40
  spec.add_dependency 'bundler'
41
41
  spec.add_dependency 'etc'
42
42
  spec.add_dependency 'fuzzy_match' # completion matching
43
43
  spec.add_dependency 'json'
44
44
  spec.add_dependency 'ostruct'
45
+ spec.add_dependency 'prism', '>=1.8.0'
45
46
  spec.add_dependency 'sqlite3'
46
47
 
47
48
  spec.add_development_dependency 'debug'
48
- spec.add_development_dependency 'guard'
49
+ spec.add_development_dependency 'guard' # as of ruby 4: Sorry, you can't use Pry without Readline or a compatible library.
49
50
  spec.add_development_dependency 'guard-minitest'
50
51
  spec.add_development_dependency 'guard-rubocop'
51
52
  spec.add_development_dependency 'minitest'
52
53
  spec.add_development_dependency 'minitest-reporters'
53
54
  spec.add_development_dependency 'rake' # required by guard :-(
55
+ spec.add_development_dependency 'rb-readline'
54
56
  spec.add_development_dependency 'rubocop', '>1.38.0' # Something broke in 1.38.0. Move to rubocop --server?
55
57
  spec.add_development_dependency 'rubocop-ast', '>1.32.0' # Something broke in 1.38.0. Move to rubocop --server?
56
58
  spec.add_development_dependency 'rubocop-minitest'
57
59
  spec.add_development_dependency 'rubocop-performance' # Linter - no longer needed - use additional gems?
58
60
  spec.add_development_dependency 'rubocop-rake'
59
61
  spec.add_development_dependency 'rubocop-rspec' # Linter - no longer needed - use additional gems?
62
+ spec.add_development_dependency 'simplecov'
63
+ spec.add_development_dependency 'simplecov_json_formatter'
60
64
  spec.metadata['rubygems_mfa_required'] = 'true'
61
65
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ruby_language_server
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.2
4
+ version: 0.9.9
5
5
  platform: ruby
6
6
  authors:
7
7
  - Kurt Werle
@@ -15,14 +15,14 @@ dependencies:
15
15
  requirements:
16
16
  - - "~>"
17
17
  - !ruby/object:Gem::Version
18
- version: '8.0'
18
+ version: '8.1'
19
19
  type: :runtime
20
20
  prerelease: false
21
21
  version_requirements: !ruby/object:Gem::Requirement
22
22
  requirements:
23
23
  - - "~>"
24
24
  - !ruby/object:Gem::Version
25
- version: '8.0'
25
+ version: '8.1'
26
26
  - !ruby/object:Gem::Dependency
27
27
  name: amatch
28
28
  requirement: !ruby/object:Gem::Requirement
@@ -107,6 +107,20 @@ dependencies:
107
107
  - - ">="
108
108
  - !ruby/object:Gem::Version
109
109
  version: '0'
110
+ - !ruby/object:Gem::Dependency
111
+ name: prism
112
+ requirement: !ruby/object:Gem::Requirement
113
+ requirements:
114
+ - - ">="
115
+ - !ruby/object:Gem::Version
116
+ version: 1.8.0
117
+ type: :runtime
118
+ prerelease: false
119
+ version_requirements: !ruby/object:Gem::Requirement
120
+ requirements:
121
+ - - ">="
122
+ - !ruby/object:Gem::Version
123
+ version: 1.8.0
110
124
  - !ruby/object:Gem::Dependency
111
125
  name: sqlite3
112
126
  requirement: !ruby/object:Gem::Requirement
@@ -219,6 +233,20 @@ dependencies:
219
233
  - - ">="
220
234
  - !ruby/object:Gem::Version
221
235
  version: '0'
236
+ - !ruby/object:Gem::Dependency
237
+ name: rb-readline
238
+ requirement: !ruby/object:Gem::Requirement
239
+ requirements:
240
+ - - ">="
241
+ - !ruby/object:Gem::Version
242
+ version: '0'
243
+ type: :development
244
+ prerelease: false
245
+ version_requirements: !ruby/object:Gem::Requirement
246
+ requirements:
247
+ - - ">="
248
+ - !ruby/object:Gem::Version
249
+ version: '0'
222
250
  - !ruby/object:Gem::Dependency
223
251
  name: rubocop
224
252
  requirement: !ruby/object:Gem::Requirement
@@ -303,6 +331,34 @@ dependencies:
303
331
  - - ">="
304
332
  - !ruby/object:Gem::Version
305
333
  version: '0'
334
+ - !ruby/object:Gem::Dependency
335
+ name: simplecov
336
+ requirement: !ruby/object:Gem::Requirement
337
+ requirements:
338
+ - - ">="
339
+ - !ruby/object:Gem::Version
340
+ version: '0'
341
+ type: :development
342
+ prerelease: false
343
+ version_requirements: !ruby/object:Gem::Requirement
344
+ requirements:
345
+ - - ">="
346
+ - !ruby/object:Gem::Version
347
+ version: '0'
348
+ - !ruby/object:Gem::Dependency
349
+ name: simplecov_json_formatter
350
+ requirement: !ruby/object:Gem::Requirement
351
+ requirements:
352
+ - - ">="
353
+ - !ruby/object:Gem::Version
354
+ version: '0'
355
+ type: :development
356
+ prerelease: false
357
+ version_requirements: !ruby/object:Gem::Requirement
358
+ requirements:
359
+ - - ">="
360
+ - !ruby/object:Gem::Version
361
+ version: '0'
306
362
  description: Provide a language server implementation for ruby in ruby. See https://microsoft.github.io/language-server-protocol/
307
363
  "A Language Server is meant to provide the language-specific smarts and communicate
308
364
  with development tools over a protocol that enables inter-process communication."
@@ -323,6 +379,8 @@ files:
323
379
  - README.md
324
380
  - Rakefile
325
381
  - bin/console
382
+ - bin/rdbg
383
+ - bin/run_in_shell
326
384
  - bin/setup
327
385
  - exe/ruby_language_server
328
386
  - lib/config/initializers/active_record.rb
@@ -332,7 +390,7 @@ files:
332
390
  - lib/ruby_language_server/application.rb
333
391
  - lib/ruby_language_server/code_file.rb
334
392
  - lib/ruby_language_server/completion.rb
335
- - lib/ruby_language_server/gem_installer.rb
393
+ - lib/ruby_language_server/hover.rb
336
394
  - lib/ruby_language_server/io.rb
337
395
  - lib/ruby_language_server/line_context.rb
338
396
  - lib/ruby_language_server/location.rb
@@ -365,14 +423,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
365
423
  requirements:
366
424
  - - ">="
367
425
  - !ruby/object:Gem::Version
368
- version: 3.1.0
426
+ version: 4.0.0
369
427
  required_rubygems_version: !ruby/object:Gem::Requirement
370
428
  requirements:
371
429
  - - ">="
372
430
  - !ruby/object:Gem::Version
373
431
  version: '0'
374
432
  requirements: []
375
- rubygems_version: 3.6.9
433
+ rubygems_version: 4.0.20
376
434
  specification_version: 4
377
435
  summary: Provide a language server implementation for ruby in ruby.
378
436
  test_files: []
@@ -1,38 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'bundler/inline'
4
-
5
- module RubyLanguageServer
6
- # Sole purpose is to install gems
7
- module GemInstaller
8
- class << self
9
- def install_gems(additional_gem_names)
10
- additional_gem_names&.compact!
11
- additional_gem_names&.reject! { |name| name.strip == '' }
12
- return if additional_gem_names.nil? || additional_gem_names.empty?
13
-
14
- RubyLanguageServer.logger.info("Trying to install gems #{additional_gem_names}")
15
- gems_already_installed = []
16
- gemfile do
17
- source 'https://rubygems.org'
18
- # Lock all the gems we already have installed to the versions we have installed
19
- # For some reason, installing bundler makes it unhappy. Whatever.
20
- Gem::Specification.reject { |s| s.name == 'bundler' }.each do |specification|
21
- gem_name = specification.name
22
- begin
23
- gem(gem_name, specification&.version&.to_s)
24
- gems_already_installed << gem_name
25
- rescue Error => e
26
- RubyLanguageServer.logger.error("Error loading rubocop gem #{gem_name} #{e}")
27
- end
28
- end
29
- additional_gem_names.each do |gem_name|
30
- gem gem_name unless gems_already_installed.include?(gem_name)
31
- rescue Error => e
32
- RubyLanguageServer.logger.error("Error loading rubocop gem! #{gem_name} #{e}")
33
- end
34
- end
35
- end
36
- end
37
- end
38
- end