language_server 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eea2a987076e6db2c0d04467487fbe2e23af67ca
-  data.tar.gz: a171c9796c6cb96bc70175728d19f2ff093928e9
+SHA256:
+  metadata.gz: 8d1bb86816f7e13333c5e9fbc6ed4930d48dcc90b7c865fc10942ffd3e279fd2
+  data.tar.gz: 59f55973ed8a7fcba78d0172235baa6247ca755758533bd64f0516c13da491fa
 SHA512:
-  metadata.gz: 456d5911f25822d1fc2ffc270b4ea979a34aacb9fa79f283a7298f2647581032857242ce9e33afe6af2af8695fda533e2c93747c83fc378b12b1fb7bfdcf0124
-  data.tar.gz: 39a4b4ab6984d4d55d6de26d480817d3eaab800d04c06389242e61bbd574bf514da8fec3f8ef3ea53b6ecf4177cb1947cb0dceaa6565d3c08808669f5d61c95b
+  metadata.gz: 015ee3cdc9cdf83bf92fc39f892c09aa27c5cf2161cc55da7168b67f58ad59214a9c38cdd10ffa3e3aeb6757dcd4c3c89c8564a1211ead9649b205acdb9da847
+  data.tar.gz: c5360bb9e9a02a8fa326dce7ebae9e331b8556534e692f7885f919430c9928c9cb9132371b78af3742bc410e03d8cc7ea922fa8ad09f0b085938c0797512a27f

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 /vendor/bundle/
 /node_modules/
+/.rubocop-*

data/.rubocop.yml

@@ -0,0 +1,45 @@
+inherit_from:
+  - https://github.com/onk/onkcop/raw/v0.51.0.0/config/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.2
+  Exclude:
+    - 'bin/**/*'
+
+# TODO: Remove this config after droping Ruby 2.2 support
+Layout/IndentHeredoc:
+  Include:
+    - 'test/**/*'
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/Semicolon:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 50
+
+Metrics/BlockLength:
+  Max: 30
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 200

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Not released
 
+## 0.10.0
+
+- Add --experimental-features flag
+  - Currently rubocop integration and adhoc provider are very unstable...
+
 ## 0.9.0
 
 - rubocop support #27

data/Dockerfile

@@ -1,5 +1,7 @@
 FROM ruby:2.4.2-alpine
 
+RUN apk add --no-cache git
+
 WORKDIR /app
 
 COPY lib/language_server/version.rb /app/lib/language_server/

data/Dockerfile.development

@@ -11,4 +11,4 @@ ENV LANG=C.UTF-8 \
 
 USER ruby
 WORKDIR /app
-CMD ["bin/language_server-ruby"]
+CMD ["bin/language_server-ruby", "--experimental-features"]

data/Gemfile

@@ -1,4 +1,7 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in language_server.gemspec
 gemspec
+
+# TODO: Use released gem after new release includes https://github.com/bbatsov/rubocop/pull/4987
+gem "rubocop", git: "https://github.com/bbatsov/rubocop", ref: "88d9e3b"

data/Guardfile

@@ -5,5 +5,5 @@ guard :minitest, all_after_pass: true do
   watch(%r{^test/(.*)\/?test_(.*)\.rb$})
   watch(%r{^test/(.*)\/?(.*)_test\.rb$})
   watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
-  watch(%r{^test/test_helper\.rb$})      { 'test' }
+  watch(%r{^test/test_helper\.rb$})      { "test" }
 end

data/README.md

@@ -1,5 +1,7 @@
 # LanguageServer
 
+[Alpha quality]
+
 A Ruby Language Server implementation.
 
 ## Installation

data/Rakefile

@@ -4,7 +4,7 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
 task :default => :test

data/benchmark/rubocop

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "benchmark/ips"
+require "language_server"
+
+error_code = <<-EOS
+require "foo
+if a == "\\n"
+EOS
+warn_code = <<-EOS
+a = 1
+EOS
+valid_code = File.read(__FILE__)
+
+require "pry-byebug"
+
+LanguageServer::Linter::Rubocop.new(valid_code).call
+Benchmark.ips do |x|
+  x.report(`git log --pretty=oneline --abbrev-commit -n 1`) do
+    [error_code, warn_code, valid_code].each do |code|
+      LanguageServer::Linter::Rubocop.new(code).call
+    end
+  end
+end

data/benchmark/ruby_wc

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 
-require 'bundler/setup'
-require 'benchmark/ips'
-require 'language_server'
+require "bundler/setup"
+require "benchmark/ips"
+require "language_server"
 
 error_code = <<-EOS
 require "foo

data/bin/ci

@@ -0,0 +1,7 @@
+#!/usr/bin/env sh
+
+set -ex
+
+bin/setup
+bin/rubocop
+bin/m

data/bin/rubocop

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/circle.yml

@@ -20,8 +20,7 @@ jobs:
             docker cp . project:/app
             docker start project
             docker-compose build $SERVICE_NAME
-      - run: docker-compose run $SERVICE_NAME bin/setup
-      - run: docker-compose run $SERVICE_NAME bin/m
+      - run: docker-compose run $SERVICE_NAME bin/ci
   test-2-3:
     <<: *test
     docker:
@@ -36,6 +35,14 @@ jobs:
         environment:
           COMPOSE_FILE: docker-compose.yml:docker-compose.ci.yml
           SERVICE_NAME: ruby-2-2
+  test-docker-build:
+    docker:
+      - image: docker
+    steps:
+      - checkout
+      - setup_remote_docker:
+          version: 17.05.0-ce
+      - run: docker build .
 workflows:
   version: 2
   test:
@@ -43,3 +50,4 @@ workflows:
       - test-2-4
       - test-2-3
       - test-2-2
+      - test-docker-build

data/exe/language_server-ruby

@@ -5,4 +5,26 @@ if Dir.exist?(File.join(__dir__, "..", ".git"))
 end
 
 require "language_server"
-LanguageServer.run
+require "optparse"
+
+options = { experimental_features_enabled: false }
+opt_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: language_server-ruby [options]"
+
+  opts.on("--experimental-features", "Enable experimental features") do |e|
+    options[:experimental_features_enabled] = e
+  end
+
+  opts.on("-v", "--version", "Show version") do
+    puts LanguageServer::VERSION
+    exit
+  end
+end
+begin
+  opt_parser.parse!
+rescue OptionParser::InvalidOption
+  puts opt_parser
+  exit 1
+end
+
+LanguageServer.run(options)

data/language_server.gemspec

@@ -1,7 +1,7 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'language_server/version'
+require "language_server/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "language_server"
@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Fumiaki MATSUSHIMA"]
   spec.email         = ["mtsmfm@gmail.com"]
 
-  spec.summary       = %q{A Ruby Language Server implementation}
-  spec.description   = %q{A Ruby Language Server implementation}
+  spec.summary       = "A Ruby Language Server implementation"
+  spec.description   = "A Ruby Language Server implementation"
   spec.homepage      = "https://github.com/mtsmfm/language_server-ruby"
   spec.license       = "MIT"
 
@@ -19,25 +19,24 @@ Gem::Specification.new do |spec|
       f.match(%r{^(test|spec|features)/})
     end
   rescue
-    Dir.glob("**/*").reject {|path| File.directory?(path) }
+    Dir.glob("**/*").reject { |path| File.directory?(path) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rcodetools"
   spec.add_dependency "language_server-protocol", "0.4.0"
+  spec.add_dependency "rcodetools"
 
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "benchmark-ips"
   spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "m"
+  spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "minitest-color"
-  spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "minitest-power_assert"
-  spec.add_development_dependency "m"
-  spec.add_development_dependency "awesome_print"
-  spec.add_development_dependency "benchmark-ips"
-  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 12.2"
 end

data/lib/language_server.rb

@@ -13,7 +13,11 @@ require "json"
 
 module LanguageServer
   class << self
-    def run
+    attr_accessor :options
+
+    def run(options)
+      self.options = options
+
       writer = Protocol::Transport::Stdio::Writer.new
       reader = Protocol::Transport::Stdio::Reader.new
       variables = {}
@@ -37,16 +41,14 @@ module LanguageServer
 
         method = request[:method].to_sym
 
-        _, subscriber = subscribers.find {|k, _|
-          k === method
-        }
+        subscriber = subscribers[method]
 
         if subscriber
           keys = subscriber.parameters.map(&:last)
           result = subscriber.call(
             {
               request: request, notifier: writer.method(:notify), variables: variables
-            }.merge(variables).select {|k, _| keys.include?(k) }
+            }.merge(variables).select { |k, _| keys.include?(k) },
           )
 
           if request[:id]
@@ -58,6 +60,14 @@ module LanguageServer
       end
     end
 
+    def rubocop_enabled?
+      options[:experimental_features_enabled]
+    end
+
+    def adhoc_enabled?
+      options[:experimental_features_enabled]
+    end
+
     def subscribers
       @subscribers ||= {}
     end
@@ -69,19 +79,22 @@ module LanguageServer
 
   on :initialize do |request:, variables:|
     variables[:file_store] = FileStore.new(load_paths: $LOAD_PATH, remote_root: request[:params][:rootPath], local_root: Dir.getwd)
-    variables[:project] = Project.new(variables[:file_store])
+    variables[:project] =
+      if LanguageServer.adhoc_enabled?
+        variables[:project] = Project.new(variables[:file_store])
+      end
 
     Protocol::Interface::InitializeResult.new(
       capabilities: Protocol::Interface::ServerCapabilities.new(
         text_document_sync: Protocol::Interface::TextDocumentSyncOptions.new(
-          change: Protocol::Constant::TextDocumentSyncKind::FULL
+          change: Protocol::Constant::TextDocumentSyncKind::FULL,
         ),
         completion_provider: Protocol::Interface::CompletionOptions.new(
           resolve_provider: true,
-          trigger_characters: %w(.)
+          trigger_characters: %w[.],
         ),
-        definition_provider: true
-      )
+        definition_provider: LanguageServer.adhoc_enabled?,
+      ),
     )
   end
 
@@ -93,8 +106,10 @@ module LanguageServer
     uri = request[:params][:textDocument][:uri]
     text = request[:params][:contentChanges][0][:text]
     file_store.cache(uri, text)
-    project.recalculate_result(uri)
-    diagnostics = (Linter::Rubocop.new(text).call + Linter::RubyWC.new(text).call).flatten
+    project.recalculate_result(uri) if LanguageServer.adhoc_enabled?
+
+    diagnostics = Linter::RubyWC.new(text).call
+    diagnostics += Linter::Rubocop.new(text).call if LanguageServer.rubocop_enabled?
 
     diagnostics = diagnostics.map do |error|
       Protocol::Interface::Diagnostic.new(
@@ -103,13 +118,13 @@ module LanguageServer
         range: Protocol::Interface::Range.new(
           start: Protocol::Interface::Position.new(
             line: error.line_num,
-            character: 0
+            character: error.characters.min,
           ),
           end: Protocol::Interface::Position.new(
             line: error.line_num,
-            character: 0
-          )
-        )
+            character: error.characters.max,
+          ),
+        ),
       )
     end
 
@@ -117,8 +132,8 @@ module LanguageServer
       method: :"textDocument/publishDiagnostics",
       params: Protocol::Interface::PublishDiagnosticsParams.new(
         uri: uri,
-        diagnostics: diagnostics
-      )
+        diagnostics: diagnostics,
+      ),
     )
   end
 
@@ -126,18 +141,20 @@ module LanguageServer
     uri = request[:params][:textDocument][:uri]
     line, character = request[:params][:position].fetch_values(:line, :character).map(&:to_i)
 
-    [
-      CompletionProvider::AdHoc.new(uri: uri, line: line, character: character, project: project),
-      CompletionProvider::Rcodetools.new(uri: uri, line: line, character: character, file_store: file_store)
-    ].flat_map(&:call)
+    providers = [CompletionProvider::Rcodetools.new(uri: uri, line: line, character: character, file_store: file_store)]
+    providers << CompletionProvider::AdHoc.new(uri: uri, line: line, character: character, project: project) if LanguageServer.adhoc_enabled?
+
+    providers.flat_map(&:call)
   end
 
   on :"textDocument/definition" do |request:, project:|
     uri = request[:params][:textDocument][:uri]
     line, character = request[:params][:position].fetch_values(:line, :character).map(&:to_i)
 
-    [
-      DefinitionProvider::AdHoc.new(uri: uri, line: line, character: character, project: project),
-    ].flat_map(&:call)
+    if LanguageServer.adhoc_enabled?
+      [
+        DefinitionProvider::AdHoc.new(uri: uri, line: line, character: character, project: project),
+      ].flat_map(&:call)
+    end
   end
 end